| blob | f4cffdcd34a53ed32113dd9e0e60b1145fddff38 |
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.21
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 `C-a' and `C-e' behave specially in headlines and items.
511 When t, `C-a' will bring back the cursor to the beginning of the
512 headline text, i.e. after the stars and after a possible TODO keyword.
513 In an item, this will be the position after the bullet.
514 When the cursor is already at that position, another `C-a' will bring
515 it to the beginning of the line.
516 `C-e' will jump to the end of the headline, ignoring the presence of tags
517 in the headline. A second `C-e' will then jump to the true end of the
518 line, after any tags.
519 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
520 and only a directly following, identical keypress will bring the cursor
521 to the special positions."
532 "Non-nil means `C-k' will behave specially in headlines.
533 When nil, `C-k' will call the default `kill-line' command.
534 When t, the following will happen while the cursor is in the headline:
536 - When the cursor is at the beginning of a headline, kill the entire
537 line and possible the folded subtree below the line.
538 - When in the middle of the headline text, kill the headline up to the tags.
539 - When after the headline text, kill the tags."
544 "Non-nil means, skip even levels and only use odd levels for the outline.
545 This has the effect that two stars are being added/taken away in
546 promotion/demotion commands. It also influences how levels are
547 handled by the exporters.
548 Changing it requires restart of `font-lock-mode' to become effective
549 for fontification also in regions already fontified.
550 You may also set this on a per-file basis by adding one of the following
551 lines to the buffer:
553 #+STARTUP: odd
554 #+STARTUP: oddeven"
560 "Non-nil means, adapt indentation when promoting and demoting.
561 When this is set and the *entire* text in an entry is indented, the
562 indentation is increased by one space in a demotion command, and
563 decreased by one in a promotion command. If any line in the entry
564 body starts at column 0, indentation is not changed at all."
570 "Should `org-insert-heading' leave a blank line before new heading/item?
571 The value is an alist, with `heading' and `plain-list-item' as car,
572 and a boolean flag as cdr."
579 "Hook being run after inserting a new heading."
585 This currently only means, they are never auto-wrapped.
586 When nil, such lines will be treated like ordinary lines.
587 See also the QUOTE keyword."
592 "Non-nil means, typing characters in org-goto starts incremental search."
597 "Options concerning sparse trees in Org-mode."
602 "Non-nil means, highlight all matches that define a sparse tree.
603 The highlights will automatically disappear the next time the buffer is
604 changed by an edit command."
609 "Non-nil means, any change to the buffer will remove temporary highlights.
610 Such highlights are created by `org-occur' and `org-clock-display'.
611 When nil, `C-c C-c needs to be used to get rid of the highlights.
612 The highlights created by `org-preview-latex-fragment' always need
613 `C-c C-c' to be removed."
620 "Hook that is run after `org-occur' has constructed a sparse tree.
621 This can be used to recenter the window to show as much of the structure
622 as possible."
627 "Options concerning plain lists in Org-mode."
632 "Non-nil means, include plain lists into visibility cycling.
633 This means that during cycling, plain list items will *temporarily* be
634 interpreted as outline headlines with a level given by 1000+i where i is the
635 indentation of the bullet. In all other operations, plain list items are
636 not seen as headlines. For example, you cannot assign a TODO keyword to
637 such an item."
642 "The character that makes a line with leading number an ordered list item.
643 Valid values are ?. and ?\). To get both terminators, use t. While
644 ?. may look nicer, it creates the danger that a line with leading
645 number may be incorrectly interpreted as an item. ?\) therefore is
646 the safe choice."
653 "Non-nil means, automatically renumber ordered plain lists.
654 Renumbering happens when the sequence have been changed with
661 "Non-nil means, update checkbox statistics after insert and toggle.
662 When this is set, checkbox statistics is updated each time you either insert
669 "Options concerning archiving in Org-mode."
674 "The tag that marks a subtree as archived.
675 An archived subtree does not open during visibility cycling, and does
676 not contribute to the agenda listings.
677 After changing this, font-lock must be restarted in the relevant buffers to
678 get the proper fontification."
684 "Non-nil means, the agenda will skip any items located in archived trees.
685 An archived tree is a tree marked with the tag ARCHIVE."
691 "Non-nil means, `org-cycle' will open archived trees.
692 An archived tree is a tree marked with the tag ARCHIVE.
693 When nil, archived trees will stay folded. You can still open them with
694 normal outline commands like `show-all', but not with the cycling commands."
700 "Non-nil means sparse tree construction shows matches in archived trees.
701 When nil, matches in these trees are highlighted, but the trees are kept in
702 collapsed state."
708 "The location where subtrees should be archived.
709 This string consists of two parts, separated by a double-colon.
711 The first part is a file name - when omitted, archiving happens in the same
712 file. %s will be replaced by the current file name (without directory part).
713 Archiving to a different file is useful to keep archived entries from
714 contributing to the Org-mode Agenda.
716 The part after the double colon is a headline. The archived entries will be
717 filed under that headline. When omitted, the subtrees are simply filed away
718 at the end of the file, as top-level entries.
720 Here are a few examples:
722 If the current file is Projects.org, archive in file
723 Projects.org_archive, as top-level trees. This is the default.
726 Archive in the current file, under the top-level headline
730 Archive in file ~/org/archive.org (absolute path), as top-level trees.
733 Archive in file ./basement (relative path), as level 3 trees
736 You may set this option on a per-file basis by adding to the buffer a
737 line like
739 #+ARCHIVE: basement::** Finished Tasks"
744 "Non-nil means, mark entries as DONE when they are moved to the archive file.
745 This can be a string to set the keyword to use. When t, Org-mode will
746 use the first keyword in its list that means done."
754 "Non-nil means, add a time stamp to entries moved to an archive file.
755 This variable is obsolete and has no effect anymore, instead add ot remove
756 `time' from the variablle `org-archive-save-context-info'."
761 "Parts of context info that should be stored as properties when archiving.
762 When a subtree is moved to an archive file, it looses information given by
763 context, like inherited tags, the category, and possibly also the TODO
764 state (depending on the variable `org-archive-mark-done').
765 This variable can be a list of any of the following symbols:
767 time The time of archiving.
768 file The file where the entry originates.
769 itags The local tags, in the headline of the subtree.
770 ltags The tags the subtree inherits from further up the hierarchy.
771 todo The pre-archive TODO state.
772 category The category, taken from file name or #+CATEGORY lines.
773 olpath The outline path to the item. These are all headlines above
774 the current item, separated by /, like a file path.
776 For each symbol present in the list, a property will be created in
778 information."
791 "Options concerning imenu and speedbar in Org-mode."
796 "The maximum level for Imenu access to Org-mode headlines.
797 This also applied for speedbar access."
802 "Options concerning tables in Org-mode."
808 When nil, such lines will be treated like ordinary lines.
810 When equal to the symbol `optimized', the table editor will be optimized to
811 do the following:
812 - Automatic overwrite mode in front of whitespace in table fields.
813 This makes the structure of the table stay in tact as long as the edited
814 field does not exceed the column width.
815 - Minimize the number of realigns. Normally, the table is aligned each time
816 TAB or RET are pressed to move to another field. With optimization this
817 happens only if changes to a field might have changed the column width.
818 Optimization requires replacing the functions `self-insert-command',
819 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
820 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
821 very good at guessing when a re-align will be necessary, but you can always
824 If you would like to use the optimized version in Org-mode, but the
825 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
827 This variable can be used to turn on and off the table editor during a session,
828 but in order to toggle optimization, a restart is required.
830 See also the variable `org-table-auto-blank-field'."
838 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
839 In the optimized version, the table editor takes over all simple keys that
840 normally just insert a character. In tables, the characters are inserted
841 in a way to minimize disturbing the table structure (i.e. in overwrite mode
842 for empty fields). Outside tables, the correct binding of the keys is
843 restored.
845 The default for this option is t if the optimized version is also used in
846 Org-mode. See the variable `org-enable-table-editor' for details. Changing
847 this variable requires a restart of Emacs to become effective."
853 % END RECEIVE ORGTBL %n
855 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
856 | | |
859 @c END RECEIVE ORGTBL %n
860 @ignore
861 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
862 | | |
865 <!-- END RECEIVE ORGTBL %n -->
866 <!--
867 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
868 | | |
870 "Templates for radio tables in different major modes.
871 All occurrences of %n in a template will be replaced with the name of the
872 table, obtained by prompting the user."
879 "Settings for tables in Org-mode."
884 "The default size for newly created tables, Columns x Rows."
890 "Regular expression for recognizing numbers in table columns.
891 If a table column contains mostly numbers, it will be aligned to the
892 right. If not, it will be aligned to the left.
894 The default value of this option is a regular expression which allows
895 anything which looks remotely like a number as used in scientific
896 context. For example, all of the following will be considered a
897 number:
898 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
900 Other options offered by the customize interface are more restrictive."
918 "Fraction of numbers in a column required to make the column align right.
919 In a column all non-white fields are considered. If at least this
920 fraction of fields is matched by `org-table-number-fraction',
921 alignment to the right border applies."
926 "Behavior of tables during editing in Org-mode."
931 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
933 removal/insertion."
938 "Non-nil means, automatically blank table field when starting to type into it.
939 This only happens when typing immediately after a field motion
940 command (TAB, S-TAB or RET).
941 Only relevant when `org-enable-table-editor' is equal to `optimized'."
946 "Non-nil means, tab in the last column of a table with jump over a hline.
947 If a horizontal separator line is following the current line,
948 `org-table-next-field' can either create a new row before that line, or jump
949 over the line. When this option is nil, a new line will be created before
950 this line."
955 "Non-nil means, TAB will automatically notice a table.el table.
956 When it sees such a table, it moves point into it and - if necessary -
957 calls `table-recognize-table'."
962 "Options concerning tables in Org-mode."
967 "Should org-mode work with table refrences like B3 instead of @3$2?
968 Possible values are:
969 nil never use them
970 from accept as input, do not present for editing
971 t: accept as input and present for editing"
986 calc-angle-mode deg
987 calc-prefer-frac nil
988 calc-symbolic-mode nil
990 calc-display-working-message t
991 )
992 "List with Calc mode settings for use in calc-eval for table formulas.
993 The list must contain alternating symbols (Calc modes variables and values).
994 Don't remove any of the default settings, just change the values. Org-mode
995 relies on the variables to be present in the list."
1000 "Non-nil means, TAB and RET evaluate a formula in current table field.
1001 If the current field starts with an equal sign, it is assumed to be a formula
1002 which should be evaluated as described in the manual and in the documentation
1003 string of the command `org-table-eval-formula'. This feature requires the
1004 Emacs calc package.
1005 When this variable is nil, formula calculation is only available through
1011 "Non-nil means, interpret constants in formulas in tables.
1012 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1013 by the value given in `org-table-formula-constants', or by a value obtained
1014 from the `constants.el' package."
1019 "Alist with constant names and values, for use in table formulas.
1020 The car of each element is a name of a constant, without the `$' before it.
1021 The cdr is the value as a string. For example, if you'd like to use the
1022 speed of light in a formula, you would configure
1026 and then use it in an equation like `$1*$c'.
1028 Constants can also be defined on a per-file basis using a line like
1030 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1041 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1042 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1047 "Options concerning links in Org-mode."
1052 "Buffer-local version of `org-link-abbrev-alist', which see.
1057 "Alist of link abbreviations.
1058 The car of each element is a string, to be replaced at the start of a link.
1060 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1062 [[linkkey:tag][description]]
1064 If REPLACE is a string, the tag will simply be appended to create the link.
1067 REPLACE may also be a function that will be called with the tag as the
1068 only argument to create the link, which should be returned as a string.
1070 See the manual for examples."
1075 "Non-nil means, hide link part and only show description of bracket links.
1076 Bracket links are like [[link][descritpion]]. This variable sets the initial
1077 state in new org-mode buffers. The setting can then be toggled on a
1078 per-buffer basis from the Org->Hyperlinks menu."
1083 "How the path name in file links should be stored.
1084 Valid values are:
1086 relative Relative to the current directory, i.e. the directory of the file
1087 into which the link is being inserted.
1088 absolute Absolute path, if possible with ~ for home directory.
1089 noabbrev Absolute path, no abbreviation of home directory.
1090 adaptive Use relative path for files in the current directory and sub-
1091 directories of it. For other files, use an absolute path."
1100 "Types of links that should be activated in Org-mode files.
1101 This is a list of symbols, each leading to the activation of a certain link
1102 type. In principle, it does not hurt to turn on most link types - there may
1103 be a small gain when turning off unused link types. The types are:
1105 bracket The recommended [[link][description]] or [[link]] links with hiding.
1106 angular Links in angular brackes that may contain whitespace like
1107 <bbdb:Carsten Dominik>.
1108 plain Plain links in normal text, no whitespace, like http://google.com.
1109 radio Text that is matched by a radio target, see manual for details.
1110 tag Tag settings in a headline (link to tag search).
1111 date Time stamps (link to calendar).
1113 Changing this variable requires a restart of Emacs to become effective."
1124 "Options concerning storing links in Org-mode"
1129 "Format of the description part of a link to an email or usenet message.
1130 The following %-excapes will be replaced by corresponding information:
1138 %s subject
1139 %m message-id.
1141 You may use normal field width specification between the % and the letter.
1142 This is for example useful to limit the length of the subject.
1156 It should match if the message is from the user him/herself."
1161 "Non-nil means, file links from `org-store-link' contain context.
1162 A search string will be added to the file name with :: as separator and
1163 used to find the context when the link is activated by the command
1164 `org-open-at-point'.
1166 negates this setting for the duration of the command."
1171 "Non-nil means, keep link in list for entire session.
1173 The command `org-store-link' adds a link pointing to the current
1174 location to an internal list. These links accumulate during a session.
1175 The command `org-insert-link' can be used to insert links into any
1176 Org-mode file (offering completion for all stored links). When this
1178 will be removed from the list, to make completing the unused links
1179 more efficient."
1184 "Non-nil means, `org-store-link' will create web links to Google groups.
1185 When nil, Gnus will be used for such links.
1187 negates this setting for the duration of the command."
1192 "Options concerning following links in Org-mode"
1197 "Non-nil means, on links TAB will follow the link.
1198 Needs to be set before org.el is loaded."
1203 "Non-nil means, on links RET will follow the link.
1204 Needs to be set before org.el is loaded."
1209 "Non-nil means, mouse-1 on a link will follow the link.
1210 A longer mouse click will still set point. Does not wortk on XEmacs.
1211 Needs to be set before org.el is loaded."
1216 "Number of different positions to be recorded in the ring
1217 Changing this requires a restart of Emacs to work correctly."
1225 "Setup the frame configuration for following links.
1226 When following a link with Emacs, it may often be useful to display
1227 this link in another window or frame. This variable can be used to
1228 set this up for the different types of links.
1229 For VM, use any of
1230 `vm-visit-folder'
1231 `vm-visit-folder-other-frame'
1232 For Gnus, use any of
1233 `gnus'
1234 `gnus-other-frame'
1235 For FILE, use any of
1236 `find-file'
1237 `find-file-other-window'
1238 `find-file-other-frame'
1239 For the calendar, use the variable `calendar-setup'.
1240 For BBDB, it is currently only possible to display the matches in
1241 another window."
1260 "Non-nil means, use indirect buffer to display infile links.
1261 Activating internal links (from one location in a file to another location
1262 in the same file) normally just jumps to the location. When the link is
1263 activated with a C-u prefix (or with mouse-3), the link is displayed in
1264 another window. When this option is set, the other window actually displays
1265 an indirect buffer clone of the current buffer, to avoid any visibility
1266 changes to the current buffer."
1271 "Non-nil means, `org-open-file' will open non-existing files.
1272 When nil, an error will be generated."
1277 "Function and arguments to call for following mailto links.
1278 This is a list with the first element being a lisp function, and the
1279 remaining elements being arguments to the function. In string arguments,
1280 %a will be replaced by the address, and %s will be replaced by the subject
1281 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1290 "Non-nil means, ask for confirmation before executing shell links.
1291 Shell links can be dangerous: just think about a link
1293 [[shell:rm -rf ~/*][Google Search]]
1296 but really it would remove your entire home directory.
1297 Therefore we advise against setting this variable to nil.
1298 Just change it to `y-or-n-p' of you want to confirm with a
1307 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1308 Elisp links can be dangerous: just think about a link
1313 but really it would remove your entire home directory.
1314 Therefore we advise against setting this variable to nil.
1315 Just change it to `y-or-n-p' of you want to confirm with a
1326 "Default file applications on a UNIX or GNU/Linux system.
1338 "Default file applications on a MacOS X system.
1340 for some files for which the OS does not have a good default.
1348 'mswindows-shell-execute
1351 "Default file applications on a Windows NT system.
1356 '(
1363 )
1364 "External applications for opening `file:path' items in a document.
1365 Org-mode uses system defaults for different file types, but
1366 you can use this variable to set the application for a given file
1367 extension. The entries in this list are cons cells where the car identifies
1368 files and the cdr the corresponding command. Possible values for the
1369 file identifier are
1371 `directory' Matches a directory
1372 `remote' Matches a remote file, accessible through tramp or efs.
1373 Remote files most likely should be visited through Emacs
1374 because external applications cannot handle such paths.
1375 t Default for all remaining files
1377 Possible values for the command are:
1378 `emacs' The file will be visited by the current Emacs process.
1379 `default' Use the default application for this file type.
1380 string A command to be executed by a shell; %s will be replaced
1381 by the path to the file.
1382 sexp A Lisp form which will be evaluated. The file path will
1383 be available in the Lisp variable `file'.
1384 For more examples, see the system specific constants
1385 `org-file-apps-defaults-macosx'
1386 `org-file-apps-defaults-windowsnt'
1387 `org-file-apps-defaults-gnu'."
1402 "Non-nil means, that the search for the mh-message will be extended to
1403 all folders if the message cannot be found in the folder given in the link.
1404 Searching all folders is very efficient with one of the search engines
1405 supported by MH-E, but will be slow with pick."
1410 "Options concerning interaction with remember.el."
1415 "Directory with org files.
1416 This directory will be used as default to prompt for org files.
1417 Used by the hooks for remember.el."
1422 "Default target for storing notes.
1423 Used by the hooks for remember.el. This can be a string, or nil to mean
1424 the value of `remember-data-file'.
1425 You can set this on a per-template basis with the variable
1426 `org-remember-templates'."
1430 file))
1433 "Non-nil means, `C-c C-c' stores remember note without further promts.
1434 In this case, you need `C-u C-c C-c' to get the prompts for
1435 note file and headline.
1436 When this variable is nil, `C-c C-c' give you the prompts, and
1437 `C-u C-c C-c' trigger the fasttrack."
1442 "The interface to be used for interactive filing of remember notes.
1443 This is only used when the interactive mode for selecting a filing
1444 location is used (see the variable `org-remember-store-without-prompt').
1445 Allowed vaues are:
1446 outline The interface shows an outline of the relevant file
1447 and the correct heading is found by moving through
1448 the outline or by searching with incremental search.
1449 outline-path-completion Headlines in the current buffer are offered via
1450 completion.
1451 refile Use the refile interface, and offer headlines,
1452 possibly from different buffers."
1460 "The default interface to be used for `org-goto'.
1461 Allowed vaues are:
1462 outline The interface shows an outline of the relevant file
1463 and the correct heading is found by moving through
1464 the outline or by searching with incremental search.
1465 outline-path-completion Headlines in the current buffer are offered via
1466 completion."
1473 "The headline that should be the default location in the notes file.
1474 When filing remember notes, the cursor will start at that position.
1475 You can set this on a per-template basis with the variable
1476 `org-remember-templates'."
1481 "Templates for the creation of remember buffers.
1482 When nil, just let remember make the buffer.
1483 When not nil, this is a list of 5-element lists. In each entry, the first
1484 element is the name of the template, which should be a single short word.
1485 The second element is a character, a unique key to select this template.
1486 The third element is the template. The fourth element is optional and can
1487 specify a destination file for remember items created with this template.
1488 The default file is given by `org-default-notes-file'. An optional fifth
1489 element can specify the headline in that file that should be offered
1490 first when the user is asked to file the entry. The default headline is
1491 given in the variable `org-remember-default-headline'.
1493 The template specifies the structure of the remember buffer. It should have
1494 a first line starting with a star, to act as the org-mode headline.
1495 Furthermore, the following %-escapes will be replaced with content:
1497 %^{prompt} Prompt the user for a string and replace this sequence with it.
1498 A default value and a completion table ca be specified like this:
1499 %^{prompt|default|completion2|completion3|...}
1500 %t time stamp, date only
1501 %T time stamp with date and time
1502 %u, %U like the above, but inactive time stamps
1503 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1504 You may define a prompt like %^{Please specify birthday}t
1505 %n user name (taken from `user-full-name')
1506 %a annotation, normally the link created with org-store-link
1507 %i initial content, the region active. If %i is indented,
1508 the entire inserted text will be indented as well.
1509 %c content of the clipboard, or current kill ring head
1510 %^g prompt for tags, with completion on tags in target file
1511 %^G prompt for tags, with completion all tags in all agenda files
1512 %:keyword specific information for certain link types, see below
1513 %[pathname] insert the contents of the file given by `pathname'
1514 %(sexp) evaluate elisp `(sexp)' and replace with the result
1515 %! Store this note immediately after filling the template
1517 %? After completing the template, position cursor here.
1519 Apart from these general escapes, you can access information specific to the
1520 link type that is created. For example, calling `remember' in emails or gnus
1521 will record the author and the subject of the message, which you can access
1522 with %:author and %:subject, respectively. Here is a complete list of what
1523 is recorded for each link type.
1525 Link type | Available information
1526 -------------------+------------------------------------------------------
1527 bbdb | %:type %:name %:company
1528 vm, wl, mh, rmail | %:type %:subject %:message-id
1529 | %:from %:fromname %:fromaddress
1530 | %:to %:toname %:toaddress
1532 gnus | %:group, for messages also all email fields
1533 w3, w3m | %:type %:url
1534 info | %:type %:file %:node
1535 calendar | %:type %:date"
1558 "Non-nil means, store new notes at the beginning of a file or entry.
1559 When nil, new notes will be filed to the end of a file or entry.
1560 This can also be a list with cons cells of regular expressions that
1561 are matched against file names, and values."
1571 This is list of cons cells. Each cell contains:
1572 - a specification of the files to be considered, either a list of files,
1573 or a symbol whose function or value fields will be used to retrieve
1574 a file name or a list of file names. Nil means, refile to a different
1575 heading in the current buffer.
1576 - A specification of how to find candidate refile targets. This may be
1577 any of
1579 This tag has to be present in all target headlines, inheritance will
1580 not be considered.
1582 todo keyword.
1584 headlines that are refiling targets.
1585 - a cons cell (:level . N). Any headline of level N is considered a target.
1586 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1587 ;; FIXME: what if there are a var and func with same name???
1603 "Non-nil means, provide refile targets as paths.
1604 So a level 3 headline will be available as level1/level2/level3.
1605 When the value is `file', also include the file name (without directory)
1606 into the path. When `full-file-path', include the full file path."
1615 "Options concerning TODO items in Org-mode."
1620 "Options concerning Progress logging in Org-mode."
1625 "List of TODO entry keyword sequences and their interpretation.
1628 Each sequence starts with a symbol, either `sequence' or `type',
1629 indicating if the keywords should be interpreted as a sequence of
1630 action steps, or as different types of TODO items. The first
1631 keywords are states requiring action - these states will select a headline
1632 for inclusion into the global TODO list Org-mode produces. If one of
1635 the last keyword is treated as the only DONE state of the sequence.
1638 additional state where no keyword is present. For details about this
1639 cycling, see the manual.
1641 TODO keywords and interpretation can also be set on a per-file basis with
1642 the special #+SEQ_TODO and #+TYP_TODO lines.
1644 For backward compatibility, this variable may also be just a list
1645 of keywords - in this case the interptetation (sequence or type) will be
1646 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1683 "Controls how TODO keywords are interpreted.
1684 This variable is in principle obsolete and is only used for
1685 backward compatibility, if the interpretation of todo keywords is
1686 not given already in `org-todo-keywords'. See that variable for
1687 more information."
1694 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1695 This variable describes if and under what circumstances the cycling
1696 mechanism for TODO keywords will be replaced by a single-key, direct
1697 selection scheme.
1699 When nil, fast selection is never used.
1701 When the symbol `prefix', it will be used when `org-todo' is called with
1702 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1703 in an agenda buffer.
1705 When t, fast selection is used by default. In this case, the prefix
1706 argument forces cycling instead.
1708 In all cases, the special interface is only used if access keys have actually
1709 been assigned by the user, i.e. if keywords in the configuration are followed
1710 by a letter in parenthesis, like TODO(t)."
1718 "Hook which is run after the state of a TODO item was changed.
1719 The new state (a string with a TODO keyword, or nil) is available in the
1720 Lisp variable `state'."
1725 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1726 When the state of an entry is changed from nothing or a DONE state to
1727 a not-done TODO state, remove a previous closing date.
1729 This can also be a list of symbols indicating under which conditions
1730 the time stamp recording the action should be annotated with a short note.
1731 Valid members of this list are
1733 done Offer to record a note when marking entries done
1734 state Offer to record a note whenever changing the TODO state
1735 of an item. This is only relevant if TODO keywords are
1736 interpreted as sequence, see variable `org-todo-interpretation'.
1737 When `state' is set, this includes tracking `done'.
1738 clock-out Offer to record a note when clocking out of an item.
1740 A separate window will then pop up and allow you to type a note.
1741 After finishing with C-c C-c, the note will be added directly after the
1742 timestamp, as a plain list item. See also the variable
1743 `org-log-note-headings'.
1745 Logging can also be configured on a per-file basis by adding one of
1746 the following lines anywhere in the buffer:
1748 #+STARTUP: logdone
1749 #+STARTUP: nologging
1750 #+STARTUP: lognotedone
1751 #+STARTUP: lognotestate
1752 #+STARTUP: lognoteclock-out
1754 You can have local logging settings for a subtree by setting the LOGGING
1755 property to one or more of these keywords."
1767 "Non-nil means, the CLOSED time stamp will contain date and time.
1768 When nil, only the date will be recorded."
1776 "Headings for notes added when clocking out or closing TODO items.
1777 The value is an alist, with the car being a symbol indicating the note
1778 context, and the cdr is the heading to be used. The heading may also be the
1779 empty string.
1780 %t in the heading will be replaced by a time stamp.
1781 %s will be replaced by the new TODO state, in double quotes.
1782 %u will be replaced by the user name.
1783 %U will be replaced by the full user name."
1789 "Heading when changing todo state (todo sequence only)"
1794 "Non-nil means, the latest state change note will be directly after heading.
1795 When nil, the notes will be orderer according to time."
1801 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1802 When nil, no note will be taken.
1803 This option can also be set with on a per-file-basis with
1805 #+STARTUP: logrepeat
1806 #+STARTUP: nologrepeat
1808 You can have local logging settings for a subtree by setting the LOGGING
1809 property to one or more of these keywords."
1815 "Should clocking info be wrapped into a drawer?
1816 When t, clocking info will always be inserted into a :CLOCK: drawer.
1817 If necessary, the drawer will be created.
1818 When nil, the drawer will not be created, but used when present.
1819 When an integer and the number of clocking entries in an item
1820 reaches or exceeds this number, a drawer will be created."
1829 "When t, the clock will be stopped when the relevant entry is marked DONE.
1830 Nil means, clock will keep running until stopped explicitly with
1831 `C-c C-x C-o', or until the clock is started in a different item."
1836 "Set task to a special todo state while clocking it.
1837 The value should be the state to which the entry should be switched."
1845 "Priorities in Org-mode."
1850 "The highest priority of TODO items. A character like ?A, ?B etc.
1851 Must have a smaller ASCII number than `org-lowest-priority'."
1856 "The lowest priority of TODO items. A character like ?A, ?B etc.
1857 Must have a larger ASCII number than `org-highest-priority'."
1862 "The default priority of TODO items.
1863 This is the priority an item get if no explicit priority is given."
1868 "Non-nil means, start with default priority when starting to cycle.
1869 When this is nil, the first step in the cycle will be (depending on the
1870 command used) one higher or lower that the default priority."
1875 "Options concerning time stamps and deadlines in Org-mode."
1880 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1881 When nil, these labeled time stamps are forces into the second line of an
1882 entry, just after the headline. When scheduling from the global TODO list,
1883 the time stamp will always be forced into the second line."
1888 "Formats for `format-time-string' which are used for time stamps.
1892 "Number of minutes to round time stamps to upon insertion.
1893 When zero, insert the time unmodified. Useful rounding numbers
1894 should be factors of 60, so for example 5, 10, 15.
1895 When this is not zero, you can still force an exact time-stamp by using
1896 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1901 "Non-nil means, overlay custom formats over all time stamps.
1902 The formats are defined through the variable `org-time-stamp-custom-formats'.
1903 To turn this on on a per-file basis, insert anywhere in the file:
1904 #+STARTUP: customtime"
1912 "Custom formats for time stamps. See `format-time-string' for the syntax.
1913 These are overlayed over the default ISO format if the variable
1914 `org-display-custom-times' is set. Time like %H:%M should be at the
1915 end of the second format."
1920 "Get the right format for a time string."
1925 f)))
1928 "Non-nil means, assume future for incomplete date input from user.
1929 This affects the following situations:
1930 1. The user gives a day, but no month.
1933 it will be considered as *this* month.
1934 2. The user gives a month but not a year.
1938 When this option is nil, the current month and year will always be used
1939 as defaults."
1944 "Non-nil means, display current interpretation of date prompt live.
1945 This display will be in an overlay, in the minibuffer."
1950 "Non-nil means, pop up a calendar when prompting for a date.
1951 In the calendar, the date can be selected with mouse-1. However, the
1952 minibuffer will also be active, and you can simply enter the date as well.
1953 When nil, only the minibuffer will be available."
1961 "The hour when your day really ends.
1962 This has influence for the following applications:
1964 the time given here, the day recognized as TODAY is actually yesterday.
1965 - When a date is read from the user and it is still before the time given
1966 here, the current date and time will be assumed to be yesterday, 23:59.
1968 FIXME:
1969 IMPORTANT: This is still a very experimental feature, it may disappear
1970 again or it may be extended to mean more things."
1975 "Non-nil means, S-down will increase the time in a time stamp.
1976 When nil, S-up will increase."
1981 "Non-nil means, make the calendar window follow timestamp changes.
1982 When a timestamp is modified and the calendar window is visible, it will be
1983 moved to the new date."
1988 "When non-nil, should be a function to create `org-clock-heading'.
1989 This is the string shown in the mode line when a clock is running.
1990 The function is called with point at the beginning of the headline."
1995 "Options concerning tags in Org-mode."
2000 "List of tags allowed in Org-mode files.
2001 When this list is nil, Org-mode will base TAG input on what is already in the
2002 buffer.
2003 The value of this variable is an alist, the car of each entry must be a
2004 keyword as a string, the cdr may be a character that is used to select
2005 that tag through the fast-tag-selection interface.
2006 See the manual for details."
2016 "Non-nil means, use fast tag selection scheme.
2017 This is a special interface to select and deselect tags with single keys.
2018 When nil, fast selection is never used.
2019 When the symbol `auto', fast selection is used if and only if selection
2020 characters for tags have been configured, either through the variable
2021 `org-tag-alist' or through a #+TAGS line in the buffer.
2022 When t, fast selection is always used and selection keys are assigned
2023 automatically if necessary."
2031 "Non-nil means, fast tag selection exits after first change.
2032 When nil, you have to press RET to exit it.
2033 During fast tag selection, you can toggle this flag with `C-c'.
2034 This variable can also have the value `expert'. In this case, the window
2035 displaying the tags menu is not even shown, until you press C-c again."
2043 "Non-nil means, fast tags selection interface will also offer TODO states.
2047 "The column to which tags should be indented in a headline.
2048 If this number is positive, it specifies the column. If it is negative,
2049 it means that the tags should be flushright to that column. For example,
2050 -80 works well for a normal 80 character screen."
2055 "Non-nil means, realign tags after pro/demotion of TODO state change.
2056 These operations change the length of a headline and therefore shift
2057 the tags around. With this options turned on, after each such operation
2058 the tags are again aligned to `org-tags-column'."
2063 "Non-nil means, tags in levels apply also for sublevels.
2064 When nil, only the tags directly given in a specific line apply there.
2065 If you turn off this option, you very likely want to turn on the
2066 companion option `org-tags-match-list-sublevels'."
2071 "Non-nil means list also sublevels of headlines matching tag search.
2072 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2073 the sublevels of a headline matching a tag search often also match
2074 the same search. Listing all of them can create very long lists.
2075 Setting this variable to nil causes subtrees of a match to be skipped.
2076 This option is off by default, because inheritance in on. If you turn
2077 inheritance off, you very likely want to turn this option on.
2079 As a special case, if the tag search is restricted to TODO items, the
2080 value of this variable is ignored and sublevels are always checked, to
2081 make sure all corresponding TODO items find their way into the list."
2093 "Options concerning properties in Org-mode."
2098 "How property key/value pairs should be formatted by `indent-line'.
2099 When `indent-line' hits a property definition, it will format the line
2100 according to this format, mainly to make sure that the values are
2101 lined-up with respect to each other."
2106 "Non-nil means, properties apply also for sublevels.
2107 This setting is only relevant during property searches, not when querying
2108 an entry with `org-entry-get'. To retrieve a property with inheritance,
2109 you need to call `org-entry-get' with the inheritance flag.
2110 Turning this on can cause significant overhead when doing a search, so
2111 this is turned off by default.
2112 When nil, only the properties directly given in the current entry count.
2113 The value may also be a list of properties that shouldhave inheritance.
2115 However, note that some special properties use inheritance under special
2116 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2118 for valid values of a property."
2126 "The default column format, if no other format has been defined.
2127 This variable can be set on the per-file basis by inserting a line
2129 #+COLUMNS: %25ITEM ....."
2134 "List of property/value pairs that can be inherited by any entry.
2135 You can set buffer-local values for this by adding lines like
2137 #+PROPERTY: NAME VALUE"
2144 "List of property/value pairs that can be inherited by any entry.
2145 Valid for the current buffer.
2149 "Options concerning agenda views in Org-mode."
2154 "Variable used by org files to set a category for agenda display.
2155 Such files should use a file variable to set it, for example
2159 or contain a special line
2161 #+CATEGORY: ELisp
2163 If the file does not specify a category, then file's base name
2168 "The files to be used for agenda display.
2172 If an entry is a directory, all files in that directory that are matched by
2173 `org-agenda-file-regexp' will be part of the file list.
2175 If the value of the variable is not a list but a single file name, then
2176 the list of agenda files is actually stored and maintained in that file, one
2177 agenda file per line."
2184 "Regular expression to match files for `org-agenda-files'.
2185 If any element in the list in that variable contains a directory instead
2186 of a normal file, all files in that directory that are matched by this
2187 regular expression will be included."
2192 "t means to just skip non-reachable files in `org-agenda-files'.
2193 Nil means to remove them, after a query, from the list."
2198 "List of extra files to be searched by `org-occur-in-agenda-files'.
2199 The files in `org-agenda-files' are always searched."
2204 "When set, remote killing from the agenda buffer needs confirmation.
2205 When t, a confirmation is always needed. When a number N, confirmation is
2206 only needed when the text to be killed contains more than N non-white lines."
2214 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2215 The command `org-calendar-goto-agenda' will be bound to this key. The
2216 default is the character `c' because then `c' can be used to switch back and
2217 forth between agenda and calendar."
2222 "Non-nil means, make the block agenda more compact.
2223 This is done by leaving out unnecessary lines."
2228 "Options concerning exporting agenda views in Org-mode."
2233 "Non-nil means, use colors in agenda views."
2238 "Alist of variable/value pairs that should be active during agenda export.
2239 This is a good place to set uptions for ps-print and for htmlize."
2247 "The style specification for exported HTML Agenda files.
2248 If this variable contains a string, it will replace the default <style>
2249 section as produced by `htmlize'.
2250 Since there are different ways of setting style information, this variable
2251 needs to contain the full HTML structure to provide a style, including the
2252 surrounding HTML tags. The style specifications should include definitions
2253 the fonts used by the agenda, here is an example:
2256 p { font-weight: normal; color: gray; }
2257 .org-agenda-structure {
2258 font-size: 110%;
2259 color: #003399;
2260 font-weight: 600;
2261 }
2262 .org-todo {
2263 color: #cc6666;Week-agenda:
2264 font-weight: bold;
2265 }
2266 .org-done {
2267 color: #339933;
2268 }
2269 .title { text-align: center; }
2270 .todo, .deadline { color: red; }
2271 .done { color: green; }
2272 </style>
2274 or, if you want to keep the style in a file,
2278 As the value of this option simply gets inserted into the HTML <head> header,
2280 <style>...</style> is required, if not present the variable will be ignored."
2286 "Options concerning agenda views in Org-mode."
2291 "Custom commands for the agenda.
2292 These commands will be offered on the splash screen displayed by the
2295 (key desc type match options files)
2297 key The key (one or more characters as a string) to be associated
2298 with the command.
2299 desc A description of the commend, when omitted or nil, a default
2300 description is built using MATCH.
2301 type The command type, any of the following symbols:
2302 todo Entries with a specific TODO keyword, in all agenda files.
2303 tags Tags match in all agenda files.
2304 tags-todo Tags match in all agenda files, TODO entries only.
2305 todo-tree Sparse tree of specific TODO keyword in *current* file.
2306 tags-tree Sparse tree with all tags matches in *current* file.
2307 occur-tree Occur sparse tree for *current* file.
2308 ... A user-defined function.
2309 match What to search for:
2310 - a single keyword for TODO keyword searches
2311 - a tags match expression for tags searches
2312 - a regular expression for occur searches
2313 options A list of option settings, similar to that in a let form, so like
2314 this: ((opt1 val1) (opt2 val2) ...)
2315 files A list of files file to write the produced agenda buffer to
2316 with the command `org-store-agenda-views'.
2319 produced. Otherwide, only the plain text is written to the file.
2321 You can also define a set of commands, to create a composite agenda buffer.
2322 In this case, an entry looks like this:
2324 (key desc (cmd1 cmd2 ...) general-options file)
2326 where
2328 desc A description string to be displayed in the dispatcher menu.
2329 cmd An agenda command, similar to the above. However, tree commands
2330 are no allowed, but instead you can get agenda and global todo list.
2331 So valid commands for a set are:
2332 (agenda)
2333 (alltodo)
2334 (stuck)
2339 Each command can carry a list of options, and another set of options can be
2340 given for the whole set of commands. Individual command options take
2341 precedence over the general options.
2343 When using several characters as key to a command, the first characters
2344 are prefix commands. For the dispatcher to display useful information, you
2345 should provide a description for the prefix, like
2347 (setq org-agenda-custom-commands
2419 "How to identify stuck projects.
2420 This is a list of four items:
2421 1. A tags/todo matcher string that is used to identify a project.
2422 The entire tree below a headline matched by this is considered one project.
2423 2. A list of TODO keywords identifying non-stuck projects.
2424 If the project subtree contains any headline with one of these todo
2425 keywords, the project is considered to be not stuck. If you specify
2427 3. A list of tags identifying non-stuck projects.
2428 If the project subtree contains any headline with one of these tags,
2430 a tag, any tag will mark the project unstuck.
2431 4. An arbitrary regular expression matching non-stuck projects.
2434 or `C-c a #' to produce the list."
2438 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2444 "Options concerning skipping parts of agenda files."
2449 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2450 When nil, the sublevels of a TODO entry are not checked, resulting in
2451 potentially much shorter TODO lists."
2457 "Non-nil means, don't show entries with a date in the global todo list.
2458 You can use this if you prefer to mark mere appointments with a TODO keyword,
2459 but don't want them to show up in the TODO list.
2460 When this is set, it also covers deadlines and scheduled items, the settings
2461 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2462 will be ignored."
2468 "Non-nil means, don't show scheduled entries in the global todo list.
2469 The idea behind this is that by scheduling it, you have already taken care
2470 of this item.
2471 See also `org-agenda-todo-ignore-with-date'."
2477 "Non-nil means, don't show near deadline entries in the global todo list.
2478 Near means closer than `org-deadline-warning-days' days.
2479 The idea behind this is that such items will appear in the agenda anyway.
2480 See also `org-agenda-todo-ignore-with-date'."
2486 "Non-nil means don't show scheduled items in agenda when they are done.
2487 This is relevant for the daily/weekly agenda, not for the TODO list. And
2488 it applies only to the actual date of the scheduling. Warnings about
2489 an item with a past scheduling dates are always turned off when the item
2490 is DONE."
2495 "Non-nil means don't show deadines when the corresponding item is done.
2496 When nil, the deadline is still shown and should give you a happy feeling.
2497 This is relevant for the daily/weekly agenda. And it applied only to the
2498 actualy date of the deadline. Warnings about approching and past-due
2499 deadlines are always turned off when the item is DONE."
2504 "Non-nil means don't select item by timestamp or -range if it is DONE."
2509 "Non-nil means, `org-timeline' also shows dates without an entry.
2510 When nil, only the days which actually have entries are shown.
2511 When t, all days between the first and the last date are shown.
2512 When an integer, show also empty dates, but if there is a gap of more than
2513 N days, just insert a special line indicating the size of the gap."
2522 "Options concerning initial settings in the Agenda in Org Mode."
2527 "Hook run just before displaying an agenda buffer."
2532 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2533 A longer mouse click will still set point. Does not wortk on XEmacs.
2534 Needs to be set before org.el is loaded."
2539 "The initial value of follow-mode in a newly created agenda window."
2544 "Options concerning the windows used by the Agenda in Org Mode."
2549 "How the agenda buffer should be displayed.
2550 Possible values for this option are:
2552 current-window Show agenda in the current window, keeping all other windows.
2553 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2554 other-window Use `switch-to-buffer-other-window' to display agenda.
2555 reorganize-frame Show only two windows on the current frame, the current
2556 window and the agenda.
2557 See also the variable `org-agenda-restore-windows-after-quit'."
2566 "The min and max height of the agenda window as a fraction of frame height.
2567 The value of the variable is a cons cell with two numbers between 0 and 1.
2568 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2573 "Non-nil means, restore window configuration open exiting agenda.
2574 Before the window configuration is changed for displaying the agenda,
2575 the current status is recorded. When the agenda is exited with
2576 `q' or `x' and this option is set, the old state is restored. If
2577 `org-agenda-window-setup' is `other-frame', the value of this
2578 option will be ignored.."
2583 "How should indirect tree buffers be displayed?
2584 This applies to indirect buffers created with the commands
2586 Valid values are:
2587 current-window Display in the current window
2588 other-window Just display in another window.
2589 dedicated-frame Create one new frame, and re-use it each time.
2590 new-frame Make a new frame each time. Note that in this case
2591 previously-made indirect buffers are kept, and you need to
2592 kill these buffers yourself."
2602 "Options concerning the daily/weekly agenda."
2607 "Number of days to include in overview display.
2608 Should be 1 or 7."
2613 "Non-nil means, start the overview always on the specified weekday.
2614 0 denotes Sunday, 1 denotes Monday etc.
2615 When nil, always start on the current day."
2621 "Non-nil means, `org-agenda' shows every day in the selected range.
2622 When nil, only the days which actually have entries are shown."
2627 "Format string for displaying dates in the agenda.
2628 Used by the daily/weekly agenda and by the timeline. This should be
2629 a format string understood by `format-time-string', or a function returning
2630 the formatted date as a string. The function must take a single argument,
2631 a calendar-style date list like (month day year)."
2638 "Format a date string for display in the daily/weekly agenda, or timeline.
2639 This function makes sure that dates are aligned for easy reading."
2647 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2652 "Set means weekly/daily agenda will always contain all TODO entries.
2653 The TODO entries will be listed at the top of the agenda, before
2654 the entries for specific days."
2659 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2660 When nil, only one occurence is shown, either today or the
2661 nearest into the future."
2666 "No. of days before expiration during which a deadline becomes active.
2667 This variable governs the display in sparse trees and in the agenda.
2668 When negative, it means use this number (the absolute value of it)
2669 even if a deadline has a different individual lead time specified."
2675 "No. of days to continue listing scheduled items that are not marked DONE.
2676 When an item is scheduled on a date, it shows up in the agenda on this
2677 day and will be listed until it is marked done for the number of days
2678 given here."
2683 "Options concerning the time grid in the Org-mode Agenda."
2688 "Non-nil means, show a time grid in the agenda schedule.
2689 A time grid is a set of lines for specific times (like every two hours between
2690 8:00 and 20:00). The items scheduled for a day at specific times are
2691 sorted in between these lines.
2692 For details about when the grid will be shown, and what it will look like, see
2693 the variable `org-agenda-time-grid'."
2699 "----------------"
2702 "The settings for time grid for agenda display.
2703 This is a list of three items. The first item is again a list. It contains
2704 symbols specifying conditions when the grid should be displayed:
2706 daily if the agenda shows a single day
2707 weekly if the agenda shows an entire week
2708 today show grid on current date, independent of daily/weekly display
2709 require-timed show grid only if at least one item has a time specification
2711 The second item is a string which will be places behing the grid time.
2713 The third item is a list of integers, indicating the times that should have
2714 a grid line."
2716 :type
2723 require-timed)
2725 remove-match))
2730 "Options concerning sorting in the Org-mode Agenda."
2746 "Sorting structure for the agenda items of a single day.
2747 This is a list of symbols which will be used in sequence to determine
2748 if an entry should be listed before another entry. The following
2749 symbols are recognized:
2751 time-up Put entries with time-of-day indications first, early first
2752 time-down Put entries with time-of-day indications first, late first
2753 category-keep Keep the default order of categories, corresponding to the
2754 sequence in `org-agenda-files'.
2755 category-up Sort alphabetically by category, A-Z.
2756 category-down Sort alphabetically by category, Z-A.
2757 tag-up Sort alphabetically by last tag, A-Z.
2758 tag-down Sort alphabetically by last tag, Z-A.
2759 priority-up Sort numerically by priority, high priority last.
2760 priority-down Sort numerically by priority, high priority first.
2762 The different possibilities will be tried in sequence, and testing stops
2764 '(time-up category-keep priority-down)
2765 means: Pull out all entries having a specified time of day and sort them,
2766 in order to make a time schedule for the current day the first thing in the
2767 agenda listing for the day. Of the entries without a time indication, keep
2768 the grouped in categories, don't sort the categories, but keep them in
2769 the sequence given in `org-agenda-files'. Within each category sort by
2770 priority.
2772 Leaving out `category-keep' would mean that items will be sorted across
2773 categories by priority.
2775 Instead of a single list, this can also be a set of list for specific
2776 contents, with a context symbol in the car of the list, any of
2777 `agenda', `todo', `tags' for the corresponding agenda views."
2790 "Non-nil means, items without time are considered late.
2791 This is only relevant for sorting. When t, items which have no explicit
2792 time like 15:30 will be considered as 99:01, i.e. later than any items which
2793 do have a time. When nil, the default time is before 0:00. You can use this
2794 option to decide if the schedule for today should come before or after timeless
2795 agenda entries."
2800 "Options concerning the entry prefix in the Org-mode agenda display."
2809 "Format specifications for the prefix of items in the agenda views.
2810 An alist with four entries, for the different agenda types. The keys to the
2811 sublists are `agenda', `timeline', `todo', and `tags'. The values
2812 are format strings.
2813 This format works similar to a printf format, with the following meaning:
2816 as given by the CATEGORY keyword or derived from the file name.
2817 %T the *last* tag of the item. Last because inherited tags come
2818 first in the list.
2819 %t the time-of-day specification if one applies to the entry, in the
2820 format HH:MM
2821 %s Scheduling/Deadline information, a short string
2823 All specifiers work basically like the standard `%s' of printf, but may
2824 contain two additional characters: A question mark just after the `%' and
2825 a whitespace/punctuation character just before the final letter.
2827 If the first character after `%' is a question mark, the entire field
2828 will only be included if the corresponding value applies to the
2829 current entry. This is useful for fields which should have fixed
2830 width when present, but zero width when absent. For example,
2832 day is specified, but will completely disappear in entries which do
2833 not contain a time.
2835 If there is punctuation or whitespace character just before the final
2836 format letter, this character will be appended to the field value if
2839 empty, no additional colon would be interted.
2842 - Indent the line with two space characters
2843 - Give the category in a 12 chars wide field, padded with whitespace on
2844 the right (because of `-'). Append a colon if there is a category
2845 (because of `:').
2846 - If there is a time-of-day, put it into a 12 chars wide field. If no
2847 time, don't put in an empty field, just skip it (because of '?').
2848 - Finally, put the scheduling information and append a whitespace.
2850 As another example, if you don't want the time-of-day of entries in
2851 the prefix, you could use:
2855 See also the variables `org-agenda-remove-times-when-in-prefix' and
2856 `org-agenda-remove-tags'."
2867 "The compiled version of the most recently used prefix format.
2871 "Format for the TODO keyword in agenda lines.
2873 to occupy a fixed space in the agenda display."
2878 "Text preceeding scheduled items in the agenda view.
2879 This is a list with two strings. The first applies when the item is
2880 scheduled on the current day. The second applies when it has been scheduled
2881 previously, it may contain a %d to capture how many days ago the item was
2882 scheduled."
2889 "Text preceeding deadline items in the agenda view.
2890 This is a list with two strings. The first applies when the item has its
2891 deadline on the current day. The second applies when it is in the past or
2892 in the future, it may contain %d to capture how many days away the deadline
2893 is (was)."
2900 "Non-nil means, remove duplicate time specifications in agenda items.
2901 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2902 time-of-day specification in a headline or diary entry is extracted and
2903 placed into the prefix. If this option is non-nil, the original specification
2904 \(a timestamp or -range, or just a plain time(range) specification like
2905 11:30-4pm) will be removed for agenda display. This makes the agenda less
2906 cluttered.
2907 The option can be t or nil. It may also be the symbol `beg', indicating
2908 that the time should only be removed what it is located at the beginning of
2909 the headline/diary entry."
2918 "Default duration for appointments that only have a starting time.
2919 When nil, no duration is specified in such cases.
2920 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2928 "Non-nil means, remove the tags from the headline copy in the agenda.
2929 When this is the symbol `prefix', only remove tags when
2930 `org-agenda-prefix-format' contains a `%T' specifier."
2942 "Shift tags in agenda items to this column.
2943 If this number is positive, it specifies the column. If it is negative,
2944 it means that the tags should be flushright to that column. For example,
2945 -80 works well for a normal 80 character screen."
2953 "Non-nil means, highlight low and high priorities in agenda.
2954 When t, the highest priority entries are bold, lowest priority italic.
2955 This may also be an association list of priority faces. The face may be
2966 "Options for embedding LaTeX code into Org-mode"
2974 "Options for creating images from LaTeX fragments.
2975 This is a property list with the following properties:
2977 `default' means use the forground of the default face.
2979 `default' means use the background of the default face.
2980 :scale a scaling factor for the size of the images
2981 :html-foreground, :html-background, :html-scale
2982 The same numbers for HTML export.
2983 :matchers a list indicating which matchers should be used to
2984 find LaTeX fragments. Valid members of this list are:
3001 "The document header used for processing LaTeX fragments."
3006 "Options for exporting org-listings."
3011 "General options for exporting Org-mode files."
3015 ;; FIXME
3020 When this option is turned on, these strings will be exported as:
3022 Org HTML LaTeX
3023 -----+----------+--------
3025 -- – --
3026 --- — ---
3027 ... … \ldots
3044 "Terms used in export text, translated to different languages.
3045 Use the variable `org-export-default-language' to set the language,
3046 or use the +OPTION lines for a per-file setting."
3056 "The default language of HTML export, as a string.
3057 This should have an association in `org-export-language-setup'."
3062 "Non-nil means, skip all text before the first headline when exporting.
3063 When nil, that text is exported as well."
3068 "The last level which is still exported as a headline.
3069 Inferior levels will produce itemize lists when exported.
3070 Note that a numeric prefix argument to an exporter function overrides
3071 this setting.
3078 "Non-nil means, add section numbers to headlines when exporting.
3085 "Non-nil means, create a table of contents in exported files.
3086 The TOC contains headlines with levels up to`org-export-headline-levels'.
3087 When an integer, include levels up to N in the toc, this may then be
3088 different from `org-export-headline-levels', but it will not be allowed
3089 to be larger than the number of headline levels.
3090 When nil, no table of contents is made.
3093 ASCII export, and with red color in HTML output, if the option
3094 `org-export-mark-todo-in-toc' is set.
3096 In HTML output, the TOC will be clickable.
3107 "Non-nil means, mark TOC lines that contain any open TODO items."
3112 "Non-nil means, preserve all line breaks when exporting.
3113 Normally, in HTML output paragraphs will be reformatted. In ASCII
3114 export, line breaks will always be preserved, regardless of this variable.
3121 "Whether subtrees with the ARCHIVE tag should be exported.
3122 This can have three different values
3123 nil Do not export, pretend this tree is not present
3124 t Do export the entire tree
3125 headline Only export the headline, but skip the tree below it."
3134 "Non-nil means, insert author name and email into the exported file.
3136 This option can also be set with the +OPTIONS line,
3142 "Non-nil means, insert a time stamp into the exported file.
3143 The time stamp shows when the file was created.
3145 This option can also be set with the +OPTIONS line,
3151 "If nil, do not export time stamps and associated keywords."
3156 "If nil, remove timestamps from the table of contents entries."
3161 "If nil, do not export tags, just remove them from headlines.
3162 If this is the symbol `not-in-toc', tags will be removed from table of
3163 contents entries, but still be shown in the headlines of the document.
3173 "Non-nil means, export with drawers like the property drawer.
3174 When t, all drawers are exported. This may also be a list of
3175 drawer names to export."
3184 "Options for translating special ascii sequences for the export backends."
3189 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3190 If the export target supports emphasizing text, the word will be
3191 typeset in bold, italic, or underlined, respectively. Works only for
3192 single words, but you can say: I *really* *mean* *this*.
3193 Not all export backends support this.
3200 "If nil, export [1] as a footnote marker.
3201 Lines starting with [1] will be formatted as footnotes.
3209 When this option is turned on, you can use TeX-like syntax for sub- and
3211 considered as a single item - so grouping with {} is normally not
3212 needed. For example, the following things will be parsed as single
3213 sub- or superscripts.
3215 10^24 or 10^tau several digits will be considered 1 item.
3216 10^-12 or 10^-tau a leading sign with digits or a word
3217 x^2-y^3 will be read as x^2 - y^3, because items are
3218 terminated by almost any nonword/nondigit char.
3219 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3221 Still, ambiguity is possible - so when in doubt use {} to enclose the
3222 sub/superscript. If you set this variable to the symbol `{}',
3223 the braces are *required* in order to trigger interpretations as
3225 frequently in plain text.
3227 Not all export backends support this, but HTML does.
3238 When this option is turned on, these strings will be exported as:
3241 -- : –
3242 --- : —
3244 Not all export backends support this, but HTML does.
3251 "Non-nil means, interpret simple TeX-like macros when exporting.
3253 No only real TeX macros will work here, but the standard HTML entities
3254 for math can be used as macro names as well. For a list of supported
3255 names in HTML export, see the constant `org-html-entities'.
3256 Not all export backends support this.
3264 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3266 the first non-white thing on a line. It will also find the math delimiters
3268 display math.
3277 This can be used to have pre-formatted text, fragments of code etc. For
3278 example:
3279 : ;; Some Lisp examples
3280 : (while (defc cnt)
3281 : (ding))
3282 will be looking just like this in also HTML. See also the QUOTE keyword.
3283 Not all export backends support this.
3290 "Number of stacked braces for sub/superscript matching.
3291 This has to be set before loading org.el to be effective."
3296 "Options for exporting tables in Org-mode."
3302 For example:
3304 | Name | Address | Birthday |
3305 |-------------+----------+-----------|
3306 | Arthur Dent | England | 29.2.2100 |
3308 Not all export backends support this.
3315 "Non-nil means, highlight the first table line.
3316 In HTML export, this means use <th> instead of <td>.
3317 In tables created with table.el, this applies to the first table line.
3318 In Org-mode tables, all lines before the first horizontal separator
3319 line will be formatted with <th> tags."
3324 "Remove special lines and marking characters in calculating tables.
3325 This removes the special marking character column from tables that are set
3326 up for spreadsheet calculations. It also removes the entire lines
3327 marked with `!', `_', or `^'. The lines with `$' are kept, because
3328 the values of constants may be useful to have."
3333 "Non-nil means, always export tables created with table.el natively.
3334 Natively means, use the HTML code generator in table.el.
3335 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3336 the table does not use row- or column-spanning). This has the
3337 advantage, that the automatic HTML conversions for math symbols and
3338 sub/superscripts can be applied. Org-mode's HTML generator is also
3339 much faster."
3344 "Options specific for ASCII export of Org-mode files."
3349 "Characters for underlining headings in ASCII export.
3350 In the given sequence, these characters will be used for level 1, 2, ..."
3355 "Bullet characters for headlines converted to lists in ASCII export.
3356 The first character is used for the first lest level generated in this
3357 way, and so on. If there are more levels than characters given here,
3358 the list will be repeated.
3359 Note that plain lists will keep the same bullets as the have in the
3360 Org-mode file."
3365 "Options specific for XML export of Org-mode files."
3370 "Options specific for HTML export of Org-mode files."
3375 ""
3380 "The extension for exported HTML files."
3386 html {
3387 font-family: Times, serif;
3388 font-size: 12pt;
3389 }
3390 .title { text-align: center; }
3391 .todo { color: red; }
3392 .done { color: green; }
3393 .timestamp { color: grey }
3394 .timestamp-kwd { color: CadetBlue }
3395 .tag { background-color:lightblue; font-weight:normal }
3396 .target { background-color: lavender; }
3397 pre {
3398 border: 1pt solid #AEBDCC;
3399 background-color: #F3F5F7;
3400 padding: 5pt;
3401 font-family: courier, monospace;
3402 }
3403 table { border-collapse: collapse; }
3404 td, th {
3405 vertical-align: top;
3406 <!--border: 1pt solid #ADB9CC;-->
3407 }
3408 </style>"
3409 "The default style specification for exported HTML files.
3410 Since there are different ways of setting style information, this variable
3411 needs to contain the full HTML structure to provide a style, including the
3412 surrounding HTML tags. The style specifications should include definitions
3413 for new classes todo, done, title, and deadline. For example, legal values
3414 would be:
3417 p { font-weight: normal; color: gray; }
3418 h1 { color: black; }
3419 .title { text-align: center; }
3420 .todo, .deadline { color: red; }
3421 .done { color: green; }
3422 </style>
3424 or, if you want to keep the style in a file,
3428 As the value of this option simply gets inserted into the HTML <head> header,
3435 "Format for typesetting the document title in HTML export."
3440 "The <H> level for level 1 headings in HTML export."
3445 "Non-nil means, make file links to `file.org' point to `file.html'.
3446 When org-mode is exporting an org-mode file to HTML, links to
3447 non-html files are directly put into a href tag in HTML.
3448 However, links to other Org-mode files (recognized by the
3449 extension `.org.) should become links to the corresponding html
3450 file, assuming that the linked org-mode file will also be
3451 converted to HTML.
3452 When nil, the links still point to the plain `.org' file."
3457 "Non-nil means, inline images into exported HTML pages.
3458 This is done using an <img> tag. When nil, an anchor with href is used to
3459 link to the image. If this option is `maybe', then images in links with
3460 an empty description will be inlined, while images with a description will
3461 be linked only."
3467 ;; FIXME: rename
3469 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3470 When nil, these tags will be exported as plain text and therefore
3471 not be interpreted by a browser.
3479 "The HTML tag that is used to start a table.
3480 This must be a <table> tag, but you may change the options like
3481 borders and spacing."
3486 "The opening tag for table header fields.
3487 This is customizable so that alignment options can be specified."
3492 "The opening tag for table data fields.
3493 This is customizable so that alignment options can be specified."
3498 "If non-nil, write `org-export-html-html-helper-timestamp'
3499 into the exported HTML text. Otherwise, the buffer will just be saved
3500 to a file."
3506 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3511 "Options specific for iCalendar export of Org-mode files."
3516 "The file name for the iCalendar file covering all agenda files.
3518 The file name should be absolute, the file will be overwritten without warning."
3523 "Non-nil means, export to iCalendar files should also cover TODO items."
3531 "Non-nil means, export to iCalendar files should also cover sexp entries.
3532 These are entries like in the diary, but directly in an Org-mode file."
3537 "Amount of text below headline to be included in iCalendar export.
3538 This is a number of characters that should maximally be included.
3539 Properties, scheduling and clocking lines will always be removed.
3540 The text will be inserted into the DESCRIPTION field."
3548 "Calendar name for the combined iCalendar representing all agenda files."
3553 "Font-lock settings for highlighting in Org-mode."
3558 "Non-nil means fontify only the stars in each headline.
3559 When nil, the entire headline is fontified.
3560 Changing it requires restart of `font-lock-mode' to become effective
3561 also in regions already fontified."
3566 "Non-nil means, hide the first N-1 stars in a headline.
3567 This works by using the face `org-hide' for these stars. This
3568 face is white for a light background, and black for a dark
3569 background. You may have to customize the face `org-hide' to
3570 make this work.
3571 Changing it requires restart of `font-lock-mode' to become effective
3572 also in regions already fontified.
3573 You may also set this on a per-file basis by adding one of the following
3574 lines to the buffer:
3576 #+STARTUP: hidestars
3577 #+STARTUP: showstars"
3582 "Non-nil means, change the face of a headline if it is marked DONE.
3583 Normally, only the TODO/DONE keyword indicates the state of a headline.
3584 When this is non-nil, the headline after the keyword is set to the
3585 `org-headline-done' as an additional indication."
3590 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3591 Changing this variable requires a restart of Emacs to take effect."
3596 "Non-nil means, fontify what is treated specially by the exporters."
3601 "Non-nil mean font-lock should hide the emphasis marker characters."
3612 "Set variable and compute the emphasis regular expression."
3616 org-emphasis-alist org-emphasis-regexp-components)
3629 ;; make sure special characters appear at the right position in the class
3641 ;; Make the regexp
3649 body1
3661 body1
3669 "Components used to build the regular expression for emphasis.
3670 This is a list with 6 entries. Terminology: In an emphasis string
3674 specify what is allowed/forbidden in each part:
3676 pre Chars allowed as prematch. Beginning of line will be allowed too.
3677 post Chars allowed as postmatch. End of line will be allowed too.
3678 border The chars *forbidden* as border characters.
3680 non-shy groups here, and don't allow newline here.
3681 newline The maximum number of newlines allowed in an emphasis exp.
3683 Use customize to modify this, or restart Emacs after changing it."
3701 )
3702 "Special syntax for emphasized text.
3703 Text starting and ending with a special character will be emphasized, for
3704 example *bold*, _underlined_ and /italic/. This variable sets the marker
3705 characters, the face to be used by font-lock for highlighting in Org-mode
3706 Emacs buffers, and the HTML tags to be used for this.
3707 Use customize to modify this, or restart Emacs after changing it."
3720 ;;; The faces
3723 "Faces in Org-mode."
3728 "Make a compatible face specification.
3729 If INHERITS is an existing face and if the Emacs version supports it,
3730 just inherit the face. If not, use SPECS to define the face.
3731 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3732 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3733 to the top of the list. The `min-colors' attribute will be removed from
3734 any other entries, and any resulting duplicates will be removed entirely."
3738 ;; In Emacs 23, we use inheritance where possible.
3739 ;; We only do this in Emacs 23, because only there the outline
3740 ;; faces have been changed to the original org-mode-level-faces.
3743 ;; These do not understand the `min-colors' attribute.
3762 "Face used to hide leading stars in headlines.
3763 The forground color of this face should be equal to the background
3764 color of the frame."
3775 "Face used for level 1 headlines."
3785 "Face used for level 2 headlines."
3797 "Face used for level 3 headlines."
3809 "Face used for level 4 headlines."
3817 "Face used for level 5 headlines."
3825 "Face used for level 6 headlines."
3833 "Face used for level 7 headlines."
3841 "Face used for level 8 headlines."
3849 "Face used for special keywords."
3860 "Face used for drawers."
3864 "Face used for the value of a property."
3876 "Face for column display of entry properties."
3880 ;; Make sure that a fixed-width face is used when we have a column table.
3892 "Face for deadlines and TODO keywords."
3905 "Face for headline with the ARCHIVE tag."
3912 "Face for links."
3919 "Face for the ellipsis in folded text."
3926 "Face for links."
3933 "Face for links."
3940 "Face for links."
3945 "Face for tags."
3955 "Face for TODO keywords."
3964 "Face used for todo keywords that indicate DONE items."
3972 "Face used to indicate that a headline is DONE.
3973 This face is only used if `org-fontify-done-headline' is set. If applies
3974 to the part of the headline after the DONE keyword."
3978 "Faces for specific TODO keywords.
3979 This is a list of cons cells, with TODO keywords in the car
3980 and faces in the cdr. The face can be a symbol, or a property
3997 "Face used for tables."
4007 "Face for formulas."
4020 "Face for fixed-with text like code snippets."
4034 "Face for fixed-with text like code snippets."
4046 "Face used in agenda for captions and dates."
4055 "Face for items scheduled for a certain day."
4065 "Face for items scheduled previously, and not yet done."
4075 "Face for items scheduled previously, and not yet done."
4082 "Faces for showing deadlines in the agenda.
4083 This is a list of cons cells. The cdr of each cell is a face to be used,
4085 Each car is a fraction of the head-warning time that must have passed for
4086 this the face in the cdr to be used for display. The numbers must be
4087 given in descending order. The head-warning time is normally taken
4088 from `org-deadline-warning-days', but can also be specified in the deadline
4089 timestamp itself, like this:
4091 DEADLINE: <2007-08-13 Mon -8d>
4093 You may use d for days, w for weeks, m for months and y for years. Months
4094 and years will only be treated in an approximate fashion (30.4 days for a
4095 month and 365.24 days for a year)."
4103 ;; FIXME: this is not a good face yet.
4112 "Face for showing the agenda restriction lock."
4120 "Face used for time grids."
4125 org-level-5 org-level-6 org-level-7 org-level-8
4126 ))
4129 "The number different faces to be used for headlines.
4130 Org-mode defines 8 different headline faces, so this can be at most 8.
4131 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4135 ;;; Functions and variables from ther packages
4136 ;; Declared here to avoid compiler warnings
4142 ;; XEmacs only
4148 ;; Emacs only
4151 ;; Various packages
4152 ;; FIXME: get the argument lists for the UNKNOWN stuff
4208 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4209 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4239 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4250 ;; backward compatibility to old version of wl
4253 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4266 ;;; Variables for pre-computed regular expressions, all buffer local
4281 "Matches a headline and puts everything into groups:
4282 group 1: the stars
4283 group 2: The todo keyword, maybe
4284 group 3: Priority cookie
4285 group 4: True headline
4289 "Matches a headline and puts TODO state into group 2 if present.
4334 rear-nonsticky t mouse-map t fontified t)
4341 s)
4348 s)
4357 "Modified `buffer-invisibility-spec' for Emacs 21.
4358 Some ops with invisible text do not work correctly on Emacs 21. For these
4359 we turn off invisibility temporarily. Use this in a `let' form."
4363 "Make VAR local in current buffer and set it to VALUE."
4367 "Check if the current buffer is in Org-mode."
4371 "Return the last element of LIST."
4404 "Variable associated with STARTUP options for org-mode.
4405 Each element is a list of three items: The startup options as written
4406 in the #+STARTUP line, the corresponding variable, and the value to
4407 set this variable to if the option is found. An optional forth element PUSH
4411 "Precompute regular expressions for current buffer."
4426 kwds kws0 kwsa key value cat arch tags const links hw dws
4427 tail sep kws1 prio props drawers
4428 ex log)
4452 links)))
4458 props)))
4465 l var val)
4480 )))
4494 ;; Process the TODO keywords
4496 ;; Use the global values as if they had been given locally.
4507 kwsa nil
4519 kw)
4521 kws0)
4538 ;; Process the constants
4546 ;; Process the tags.
4556 tgs))
4564 ;; Compute the regular expressions and other local variables
4569 org-drawer-regexp
4573 org-not-done-keywords
4575 org-todo-regexp
4578 org-not-done-regexp
4582 org-todo-line-regexp
4586 org-complex-heading-regexp
4591 org-nl-done-regexp
4595 org-todo-line-tags-regexp
4600 org-looking-at-done-regexp
4605 org-deadline-time-regexp
4607 org-deadline-line-regexp
4609 org-scheduled-regexp
4611 org-scheduled-time-regexp
4613 org-closed-time-regexp
4615 org-keyword-time-regexp
4621 org-keyword-time-not-clock-regexp
4627 org-maybe-keyword-time-regexp
4633 org-planning-or-clock-line-re
4638 )
4646 x))
4647 list))
4649 ;; FIXME: this could be done much better, using second characters etc.
4651 "Assign fast keys to a keyword-key alist.
4652 Respect keys that are already there."
4662 ;; automatically assign a character.
4674 ;;; Some variables ujsed in various places
4679 "Function to be called when `C-c C-c' is used.
4683 ;; FIXME: Occasionally check by commenting these, to make sure
4684 ;; no other functions uses these, forgetting to let-bind them.
4691 ;; Defined somewhere in this file, but used before definition.
4704 ;;;; Emacs/XEmacs compatibility
4706 ;; Overlay compatibility functions
4724 "Make overlay OVL display TEXT with face FACE."
4734 "Make overlay OVL display TEXT with face FACE."
4757 "Find all overlays specifying PROP at POS or point.
4758 If DELETE is non-nil, delete all those overlays."
4760 ov found)
4764 found))
4766 ;; Region compatibility
4769 "Add-hook, compatible with both Emacsen."
4778 "Is `transient-mark-mode' on and the region active?
4779 Works on both Emacs and XEmacs."
4781 nil
4788 ;; Invisibility compatibility
4791 "Add elements to `buffer-invisibility-spec'.
4792 See documentation for `buffer-invisibility-spec' for the kind of elements
4793 that can be added."
4804 "Remove elements from `buffer-invisibility-spec'."
4812 "Is ARG a member of `buffer-invisibility-spec'?"
4815 nil))
4817 ;;;; Define the Org-mode
4820 (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."))
4823 ;; We use a before-change function to check if a table might need
4824 ;; an update.
4826 "Indicates that a table might need an update.
4827 This variable is set by `org-before-change-function'.
4836 ;;;###autoload
4838 "Outline-based notes management and organizer, alias
4841 Org-mode develops organizational tasks around a NOTES file which
4842 contains information about projects as plain text. Org-mode is
4843 implemented on top of outline-mode, which is ideal to keep the content
4844 of large files well structured. It supports ToDo items, deadlines and
4845 time stamps, which magically appear in the diary listing of the Emacs
4846 calendar. Tables are easily created with a built-in table editor.
4847 Plain text URL-like links connect to websites, emails (VM), Usenet
4848 messages (Gnus), BBDB entries, and any files related to the project.
4849 For printing and sharing of notes, an Org-mode file (or a part of it)
4850 can be exported as a structured ASCII or HTML file.
4852 The following commands are available:
4856 ;; Get rid of Outline menus, they are not needed
4857 ;; Need to do this here because define-derived-mode sets up
4858 ;; the keymap so late. Still, it is a waste to call this each time
4859 ;; we switch another buffer into org-mode.
4862 ;; Assume this is Greg's port, it used easymenu
4885 org-display-table 4
4888 org-ellipsis)))
4892 ;; Calc embedded
4899 ;; Activate before-change-function
4903 ;; Check for running clock before killing a buffer
4905 ;; Paragraphs and auto-filling
4910 ;; Comment characters
4911 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4914 ;; Align options lines
4916 'align-mode-rules-list
4921 ;; Imenu
4925 ;; Make isearch reveal context
4928 ;; Emacs 21 and XEmacs make use of the hook
4930 ;; Emacs 22 deals with this through a special variable
4934 ;; If empty file that did not turn on org-mode automatically, make it to.
4956 "Call COMMAND interactively, but pretend prefix are was ARG."
4962 ;; works also in narrowed buffer, because we start at 1, not point-min
4966 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4976 "Add text properties to entire string, from beginning to end.
4977 PLIST may be a list of properties, PROPS are individual properties and values
4978 that will be added to PLIST. Returns the string that was modified."
4981 string)
4985 ;;;; Font-Lock stuff, including the activators
4990 (org-defkey org-mouse-map
4991 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4992 (when org-mouse-1-follows-link
4993 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4994 (when org-tab-follows-link
4995 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4996 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4997 (when org-return-follows-link
4998 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4999 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5001 (require 'font-lock)
5004 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5005 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5006 (defvar org-link-re-with-space nil
5007 "Matches a link with spaces, optional angular brackets around it.")
5008 (defvar org-link-re-with-space2 nil
5009 "Matches a link with spaces, optional angular brackets around it.")
5010 (defvar org-angle-link-re nil
5011 "Matches link with angular brackets, spaces are allowed.")
5012 (defvar org-plain-link-re nil
5013 "Matches plain link, without spaces.")
5014 (defvar org-bracket-link-regexp nil
5015 "Matches a link in double brackets.")
5016 (defvar org-bracket-link-analytic-regexp nil
5017 "Regular expression used to analyze links.
5018 Here is what the match groups contain after a match:
5019 1: http:
5020 2: http
5021 3: path
5022 4: [desc]
5023 5: desc")
5024 (defvar org-any-link-re nil
5025 "Regular expression matching any link.")
5027 (defun org-make-link-regexps ()
5028 "Update the link regular expressions.
5029 This should be called after the variable `org-link-types' has changed."
5030 (setq org-link-re-with-space
5031 (concat
5034 "[^" org-non-link-chars "]*"
5036 org-link-re-with-space2
5037 (concat
5042 org-angle-link-re
5043 (concat
5046 "[^" org-non-link-chars "]*"
5048 org-plain-link-re
5049 (concat
5052 org-bracket-link-regexp
5054 org-bracket-link-analytic-regexp
5055 (concat
5062 org-any-link-re
5067 (org-make-link-regexps)
5070 "Regular expression for fast time stamp matching.")
5072 "Regular expression for fast time stamp matching.")
5073 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5074 "Regular expression matching time strings for analysis.
5075 This one does not require the space after the date.")
5076 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5077 "Regular expression matching time strings for analysis.")
5079 "Regular expression matching time stamps, with groups.")
5081 "Regular expression matching time stamps (also [..]), with groups.")
5082 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5083 "Regular expression matching a time stamp range.")
5084 (defconst org-tr-regexp-both
5085 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5086 "Regular expression matching a time stamp range.")
5089 "Regular expression matching a time stamp or time stamp range.")
5092 "Regular expression matching a time stamp or time stamp range.
5093 The time stamps may be either active or inactive.")
5095 (defvar org-emph-face nil)
5097 (defun org-do-emphasis-faces (limit)
5098 "Run through the buffer and add overlays to links."
5099 (let (rtn)
5100 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5101 (if (not (= (char-after (match-beginning 3))
5102 (char-after (match-beginning 4))))
5103 (progn
5104 (setq rtn t)
5105 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5106 'face
5107 (nth 1 (assoc (match-string 3)
5108 org-emphasis-alist)))
5109 (add-text-properties (match-beginning 2) (match-end 2)
5110 '(font-lock-multiline t))
5111 (when org-hide-emphasis-markers
5112 (add-text-properties (match-end 4) (match-beginning 5)
5113 '(invisible org-link))
5114 (add-text-properties (match-beginning 3) (match-end 3)
5115 '(invisible org-link)))))
5116 (backward-char 1))
5117 rtn))
5119 (defun org-emphasize (&optional char)
5120 "Insert or change an emphasis, i.e. a font like bold or italic.
5121 If there is an active region, change that region to a new emphasis.
5122 If there is no region, just insert the marker characters and position
5123 the cursor between them.
5124 CHAR should be either the marker character, or the first character of the
5125 HTML tag associated with that emphasis. If CHAR is a space, the means
5126 to remove the emphasis of the selected region.
5127 If char is not given (for example in an interactive call) it
5128 will be prompted for."
5129 (interactive)
5130 (let ((eal org-emphasis-alist) e det
5131 (erc org-emphasis-regexp-components)
5132 (prompt "")
5133 (string "") beg end move tag c s)
5134 (if (org-region-active-p)
5135 (setq beg (region-beginning) end (region-end)
5136 string (buffer-substring beg end))
5137 (setq move t))
5139 (while (setq e (pop eal))
5140 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5141 c (aref tag 0))
5142 (push (cons c (string-to-char (car e))) det)
5143 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5144 (substring tag 1)))))
5145 (unless char
5146 (message "%s" (concat "Emphasis marker or tag:" prompt))
5147 (setq char (read-char-exclusive)))
5148 (setq char (or (cdr (assoc char det)) char))
5149 (if (equal char ?\ )
5150 (setq s "" move nil)
5151 (unless (assoc (char-to-string char) org-emphasis-alist)
5153 (setq s (char-to-string char)))
5154 (while (and (> (length string) 1)
5155 (equal (substring string 0 1) (substring string -1))
5156 (assoc (substring string 0 1) org-emphasis-alist))
5157 (setq string (substring string 1 -1)))
5158 (setq string (concat s string s))
5159 (if beg (delete-region beg end))
5160 (unless (or (bolp)
5162 (char-to-string (char-before (point)))))
5163 (insert " "))
5165 (char-to-string (char-after (point))))
5166 (insert " ") (backward-char 1))
5167 (insert string)
5168 (and move (backward-char 1))))
5170 (defconst org-nonsticky-props
5171 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5174 (defun org-activate-plain-links (limit)
5175 "Run through the buffer and add overlays to links."
5176 (catch 'exit
5177 (let (f)
5178 (while (re-search-forward org-plain-link-re limit t)
5179 (setq f (get-text-property (match-beginning 0) 'face))
5180 (if (or (eq f 'org-tag)
5181 (and (listp f) (memq 'org-tag f)))
5182 nil
5183 (add-text-properties (match-beginning 0) (match-end 0)
5184 (list 'mouse-face 'highlight
5185 'rear-nonsticky org-nonsticky-props
5186 'keymap org-mouse-map
5187 ))
5188 (throw 'exit t))))))
5190 (defun org-activate-code (limit)
5192 (unless (get-text-property (match-beginning 1) 'face)
5193 (remove-text-properties (match-beginning 0) (match-end 0)
5194 '(display t invisible t intangible t))
5195 t)))
5197 (defun org-activate-angle-links (limit)
5198 "Run through the buffer and add overlays to links."
5199 (if (re-search-forward org-angle-link-re limit t)
5200 (progn
5201 (add-text-properties (match-beginning 0) (match-end 0)
5202 (list 'mouse-face 'highlight
5203 'rear-nonsticky org-nonsticky-props
5204 'keymap org-mouse-map
5205 ))
5206 t)))
5208 (defmacro org-maybe-intangible (props)
5209 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5210 In emacs 21, invisible text is not avoided by the command loop, so the
5211 intangible property is needed to make sure point skips this text.
5212 In Emacs 22, this is not necessary. The intangible text property has
5213 led to problems with flyspell. These problems are fixed in flyspell.el,
5214 but we still avoid setting the property in Emacs 22 and later.
5215 We use a macro so that the test can happen at compilation time."
5216 (if (< emacs-major-version 22)
5217 `(append '(intangible t) ,props)
5218 props))
5220 (defun org-activate-bracket-links (limit)
5221 "Run through the buffer and add overlays to bracketed links."
5222 (if (re-search-forward org-bracket-link-regexp limit t)
5223 (let* ((help (concat "LINK: "
5224 (org-match-string-no-properties 1)))
5225 ;; FIXME: above we should remove the escapes.
5226 ;; but that requires another match, protecting match data,
5227 ;; a lot of overhead for font-lock.
5228 (ip (org-maybe-intangible
5229 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5230 'keymap org-mouse-map 'mouse-face 'highlight
5231 'font-lock-multiline t 'help-echo help)))
5232 (vp (list 'rear-nonsticky org-nonsticky-props
5233 'keymap org-mouse-map 'mouse-face 'highlight
5234 ' font-lock-multiline t 'help-echo help)))
5235 ;; We need to remove the invisible property here. Table narrowing
5236 ;; may have made some of this invisible.
5237 (remove-text-properties (match-beginning 0) (match-end 0)
5238 '(invisible nil))
5239 (if (match-end 3)
5240 (progn
5241 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5242 (add-text-properties (match-beginning 3) (match-end 3) vp)
5243 (add-text-properties (match-end 3) (match-end 0) ip))
5244 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5245 (add-text-properties (match-beginning 1) (match-end 1) vp)
5246 (add-text-properties (match-end 1) (match-end 0) ip))
5247 t)))
5249 (defun org-activate-dates (limit)
5250 "Run through the buffer and add overlays to dates."
5251 (if (re-search-forward org-tsr-regexp-both limit t)
5252 (progn
5253 (add-text-properties (match-beginning 0) (match-end 0)
5254 (list 'mouse-face 'highlight
5255 'rear-nonsticky org-nonsticky-props
5256 'keymap org-mouse-map))
5257 (when org-display-custom-times
5258 (if (match-end 3)
5259 (org-display-custom-time (match-beginning 3) (match-end 3)))
5260 (org-display-custom-time (match-beginning 1) (match-end 1)))
5261 t)))
5263 (defvar org-target-link-regexp nil
5264 "Regular expression matching radio targets in plain text.")
5266 "Regular expression matching a link target.")
5268 "Regular expression matching a radio target.")
5269 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5270 "Regular expression matching any target.")
5272 (defun org-activate-target-links (limit)
5273 "Run through the buffer and add overlays to target matches."
5274 (when org-target-link-regexp
5275 (let ((case-fold-search t))
5276 (if (re-search-forward org-target-link-regexp limit t)
5277 (progn
5278 (add-text-properties (match-beginning 0) (match-end 0)
5279 (list 'mouse-face 'highlight
5280 'rear-nonsticky org-nonsticky-props
5281 'keymap org-mouse-map
5282 'help-echo "Radio target link"
5283 'org-linked-text t))
5284 t)))))
5286 (defun org-update-radio-target-regexp ()
5287 "Find all radio targets in this file and update the regular expression."
5288 (interactive)
5289 (when (memq 'radio org-activate-links)
5290 (setq org-target-link-regexp
5291 (org-make-target-link-regexp (org-all-targets 'radio)))
5292 (org-restart-font-lock)))
5294 (defun org-hide-wide-columns (limit)
5295 (let (s e)
5296 (setq s (text-property-any (point) (or limit (point-max))
5297 'org-cwidth t))
5298 (when s
5299 (setq e (next-single-property-change s 'org-cwidth))
5300 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5301 (goto-char e)
5302 t)))
5304 (defvar org-latex-and-specials-regexp nil
5305 "Regular expression for highlighting export special stuff.")
5306 (defvar org-match-substring-regexp)
5307 (defvar org-match-substring-with-braces-regexp)
5308 (defvar org-export-html-special-string-regexps)
5310 (defun org-compute-latex-and-specials-regexp ()
5311 "Compute regular expression for stuff treated specially by exporters."
5312 (if (not org-highlight-latex-fragments-and-specials)
5313 (org-set-local 'org-latex-and-specials-regexp nil)
5314 (let*
5315 ((matchers (plist-get org-format-latex-options :matchers))
5316 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5317 org-latex-regexps)))
5318 (options (org-combine-plists (org-default-export-plist)
5319 (org-infile-export-plist)))
5320 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5321 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5322 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5323 (org-export-html-expand (plist-get options :expand-quoted-html))
5324 (org-export-with-special-strings (plist-get options :special-strings))
5325 (re-sub
5326 (cond
5327 ((equal org-export-with-sub-superscripts '{})
5328 (list org-match-substring-with-braces-regexp))
5329 (org-export-with-sub-superscripts
5330 (list org-match-substring-regexp))
5331 (t nil)))
5332 (re-latex
5333 (if org-export-with-LaTeX-fragments
5334 (mapcar (lambda (x) (nth 1 x)) latexs)))
5335 (re-macros
5336 (if org-export-with-TeX-macros
5338 (regexp-opt
5339 (append (mapcar 'car org-html-entities)
5340 (if (boundp 'org-latex-entities)
5341 org-latex-entities nil))
5342 'words))) ; FIXME
5343 ))
5345 (re-special (if org-export-with-special-strings
5346 (mapcar (lambda (x) (car x))
5347 org-export-html-special-string-regexps)))
5348 (re-rest
5349 (delq nil
5350 (list
5352 ))))
5353 (org-set-local
5354 'org-latex-and-specials-regexp
5355 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5358 (defface org-latex-and-export-specials
5359 (let ((font (cond ((assq :inherit custom-face-attributes)
5360 '(:inherit underline))
5361 (t '(:underline t)))))
5362 `((((class grayscale) (background light))
5363 (:foreground "DimGray" ,@font))
5364 (((class grayscale) (background dark))
5365 (:foreground "LightGray" ,@font))
5366 (((class color) (background light))
5367 (:foreground "SaddleBrown"))
5368 (((class color) (background dark))
5369 (:foreground "burlywood"))
5370 (t (,@font))))
5371 "Face used to highlight math latex and other special exporter stuff."
5372 :group 'org-faces)
5374 (defun org-do-latex-and-special-faces (limit)
5375 "Run through the buffer and add overlays to links."
5376 (when org-latex-and-specials-regexp
5377 (let (rtn d)
5378 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5379 limit t))
5380 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5381 'face))
5382 '(org-code org-verbatim underline)))
5383 (progn
5384 (setq rtn t
5385 d (cond ((member (char-after (1+ (match-beginning 0)))
5386 '(?_ ?^)) 1)
5387 (t 0)))
5388 (font-lock-prepend-text-property
5389 (+ d (match-beginning 0)) (match-end 0)
5390 'face 'org-latex-and-export-specials)
5391 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5392 '(font-lock-multiline t)))))
5393 rtn)))
5395 (defun org-restart-font-lock ()
5396 "Restart font-lock-mode, to force refontification."
5397 (when (and (boundp 'font-lock-mode) font-lock-mode)
5398 (font-lock-mode -1)
5399 (font-lock-mode 1)))
5401 (defun org-all-targets (&optional radio)
5402 "Return a list of all targets in this file.
5403 With optional argument RADIO, only find radio targets."
5404 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5405 rtn)
5406 (save-excursion
5407 (goto-char (point-min))
5408 (while (re-search-forward re nil t)
5409 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5410 rtn)))
5412 (defun org-make-target-link-regexp (targets)
5413 "Make regular expression matching all strings in TARGETS.
5414 The regular expression finds the targets also if there is a line break
5415 between words."
5416 (and targets
5417 (concat
5419 (mapconcat
5420 (lambda (x)
5421 (while (string-match " +" x)
5423 x)
5424 targets
5428 (defun org-activate-tags (limit)
5430 (progn
5431 (add-text-properties (match-beginning 1) (match-end 1)
5432 (list 'mouse-face 'highlight
5433 'rear-nonsticky org-nonsticky-props
5434 'keymap org-mouse-map))
5435 t)))
5437 (defun org-outline-level ()
5438 (save-excursion
5439 (looking-at outline-regexp)
5440 (if (match-beginning 1)
5441 (+ (org-get-string-indentation (match-string 1)) 1000)
5442 (1- (- (match-end 0) (match-beginning 0))))))
5444 (defvar org-font-lock-keywords nil)
5447 "Regular expression matching a property line.")
5449 (defun org-set-font-lock-defaults ()
5450 (let* ((em org-fontify-emphasized-text)
5451 (lk org-activate-links)
5452 (org-font-lock-extra-keywords
5453 (list
5454 ;; Headlines
5456 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5457 ;; Table lines
5459 (1 'org-table t))
5460 ;; Table internals
5464 ;; Drawers
5465 (list org-drawer-regexp '(0 'org-special-keyword t))
5467 ;; Properties
5468 (list org-property-re
5469 '(1 'org-special-keyword t)
5470 '(3 'org-property-value t))
5471 (if org-format-transports-properties-p
5473 ;; Links
5474 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5475 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5476 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5477 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5478 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5479 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5481 '(org-hide-wide-columns (0 nil append))
5482 ;; TODO lines
5484 '(1 (org-get-todo-face 1) t))
5485 ;; DONE
5486 (if org-fontify-done-headline
5490 '(2 'org-headline-done t))
5491 nil)
5492 ;; Priorities
5494 ;; Special keywords
5499 ;; Emphasis
5500 (if em
5501 (if (featurep 'xemacs)
5502 '(org-do-emphasis-faces (0 nil append))
5503 '(org-do-emphasis-faces)))
5504 ;; Checkboxes
5506 2 'bold prepend)
5507 (if org-provide-checkbox-statistics
5509 (0 (org-get-checkbox-statistics-face) t)))
5511 '(1 'org-archived prepend))
5512 ;; Specials
5513 '(org-do-latex-and-special-faces)
5514 ;; Code
5515 '(org-activate-code (1 'org-code t))
5516 ;; COMMENT
5519 '(1 'org-special-keyword t))
5520 '("^#.*" (0 'font-lock-comment-face t))
5521 )))
5522 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5523 ;; Now set the full font-lock-keywords
5524 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5525 (org-set-local 'font-lock-defaults
5526 '(org-font-lock-keywords t nil nil backward-paragraph))
5527 (kill-local-variable 'font-lock-keywords) nil))
5529 (defvar org-m nil)
5530 (defvar org-l nil)
5531 (defvar org-f nil)
5532 (defun org-get-level-face (n)
5533 "Get the right face for match N in font-lock matching of healdines."
5534 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5535 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5536 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5537 (cond
5538 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5539 ((eq n 2) org-f)
5540 (t (if org-level-color-stars-only nil org-f))))
5542 (defun org-get-todo-face (kwd)
5543 "Get the right face for a TODO keyword KWD.
5544 If KWD is a number, get the corresponding match group."
5545 (if (numberp kwd) (setq kwd (match-string kwd)))
5546 (or (cdr (assoc kwd org-todo-keyword-faces))
5547 (and (member kwd org-done-keywords) 'org-done)
5548 'org-todo))
5550 (defun org-unfontify-region (beg end &optional maybe_loudly)
5551 "Remove fontification and activation overlays from links."
5552 (font-lock-default-unfontify-region beg end)
5553 (let* ((buffer-undo-list t)
5554 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5555 (inhibit-modification-hooks t)
5556 deactivate-mark buffer-file-name buffer-file-truename)
5557 (remove-text-properties beg end
5558 '(mouse-face t keymap t org-linked-text t
5559 invisible t intangible t))))
5561 ;;;; Visibility cycling, including org-goto and indirect buffer
5563 ;;; Cycling
5565 (defvar org-cycle-global-status nil)
5566 (make-variable-buffer-local 'org-cycle-global-status)
5567 (defvar org-cycle-subtree-status nil)
5568 (make-variable-buffer-local 'org-cycle-subtree-status)
5570 ;;;###autoload
5571 (defun org-cycle (&optional arg)
5572 "Visibility cycling for Org-mode.
5574 - When this function is called with a prefix argument, rotate the entire
5575 buffer through 3 states (global cycling)
5576 1. OVERVIEW: Show only top-level headlines.
5577 2. CONTENTS: Show all headlines of all levels, but no body text.
5578 3. SHOW ALL: Show everything.
5580 - When point is at the beginning of a headline, rotate the subtree started
5581 by this line through 3 different states (local cycling)
5582 1. FOLDED: Only the main headline is shown.
5583 2. CHILDREN: The main headline and the direct children are shown.
5584 From this state, you can move to one of the children
5585 and zoom in further.
5586 3. SUBTREE: Show the entire subtree, including body text.
5588 - When there is a numeric prefix, go up to a heading with level ARG, do
5589 a `show-subtree' and return to the previous cursor position. If ARG
5590 is negative, go up that many levels.
5592 - When point is not at the beginning of a headline, execute
5593 `indent-relative', like TAB normally does. See the option
5594 `org-cycle-emulate-tab' for details.
5596 - Special case: if point is at the beginning of the buffer and there is
5597 no headline in line 1, this function will act as if called with prefix arg.
5598 But only if also the variable `org-cycle-global-at-bob' is t."
5599 (interactive "P")
5600 (let* ((outline-regexp
5601 (if (and (org-mode-p) org-cycle-include-plain-lists)
5603 outline-regexp))
5604 (bob-special (and org-cycle-global-at-bob (bobp)
5605 (not (looking-at outline-regexp))))
5606 (org-cycle-hook
5607 (if bob-special
5608 (delq 'org-optimize-window-after-visibility-change
5609 (copy-sequence org-cycle-hook))
5610 org-cycle-hook))
5611 (pos (point)))
5613 (if (or bob-special (equal arg '(4)))
5614 ;; special case: use global cycling
5615 (setq arg t))
5617 (cond
5619 ((org-at-table-p 'any)
5620 ;; Enter the table or move to the next field in the table
5621 (or (org-table-recognize-table.el)
5622 (progn
5623 (if arg (org-table-edit-field t)
5624 (org-table-justify-field-maybe)
5625 (call-interactively 'org-table-next-field)))))
5627 ((eq arg t) ;; Global cycling
5629 (cond
5630 ((and (eq last-command this-command)
5631 (eq org-cycle-global-status 'overview))
5632 ;; We just created the overview - now do table of contents
5633 ;; This can be slow in very large buffers, so indicate action
5634 (message "CONTENTS...")
5635 (org-content)
5636 (message "CONTENTS...done")
5637 (setq org-cycle-global-status 'contents)
5638 (run-hook-with-args 'org-cycle-hook 'contents))
5640 ((and (eq last-command this-command)
5641 (eq org-cycle-global-status 'contents))
5642 ;; We just showed the table of contents - now show everything
5643 (show-all)
5644 (message "SHOW ALL")
5645 (setq org-cycle-global-status 'all)
5646 (run-hook-with-args 'org-cycle-hook 'all))
5648 (t
5649 ;; Default action: go to overview
5650 (org-overview)
5651 (message "OVERVIEW")
5652 (setq org-cycle-global-status 'overview)
5653 (run-hook-with-args 'org-cycle-hook 'overview))))
5655 ((and org-drawers org-drawer-regexp
5656 (save-excursion
5657 (beginning-of-line 1)
5658 (looking-at org-drawer-regexp)))
5659 ;; Toggle block visibility
5660 (org-flag-drawer
5661 (not (get-char-property (match-end 0) 'invisible))))
5663 ((integerp arg)
5664 ;; Show-subtree, ARG levels up from here.
5665 (save-excursion
5666 (org-back-to-heading)
5667 (outline-up-heading (if (< arg 0) (- arg)
5668 (- (funcall outline-level) arg)))
5669 (org-show-subtree)))
5671 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5672 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5673 ;; At a heading: rotate between three different views
5674 (org-back-to-heading)
5675 (let ((goal-column 0) eoh eol eos)
5676 ;; First, some boundaries
5677 (save-excursion
5678 (org-back-to-heading)
5679 (save-excursion
5680 (beginning-of-line 2)
5681 (while (and (not (eobp)) ;; this is like `next-line'
5682 (get-char-property (1- (point)) 'invisible))
5683 (beginning-of-line 2)) (setq eol (point)))
5684 (outline-end-of-heading) (setq eoh (point))
5685 (org-end-of-subtree t)
5686 (unless (eobp)
5688 (beginning-of-line 1) ; in case this is an item
5689 )
5690 (setq eos (1- (point))))
5691 ;; Find out what to do next and set `this-command'
5692 (cond
5693 ((= eos eoh)
5694 ;; Nothing is hidden behind this heading
5695 (message "EMPTY ENTRY")
5696 (setq org-cycle-subtree-status nil)
5697 (save-excursion
5698 (goto-char eos)
5699 (outline-next-heading)
5700 (if (org-invisible-p) (org-flag-heading nil))))
5701 ((or (>= eol eos)
5703 ;; Entire subtree is hidden in one line: open it
5704 (org-show-entry)
5705 (show-children)
5706 (message "CHILDREN")
5707 (save-excursion
5708 (goto-char eos)
5709 (outline-next-heading)
5710 (if (org-invisible-p) (org-flag-heading nil)))
5711 (setq org-cycle-subtree-status 'children)
5712 (run-hook-with-args 'org-cycle-hook 'children))
5713 ((and (eq last-command this-command)
5714 (eq org-cycle-subtree-status 'children))
5715 ;; We just showed the children, now show everything.
5716 (org-show-subtree)
5717 (message "SUBTREE")
5718 (setq org-cycle-subtree-status 'subtree)
5719 (run-hook-with-args 'org-cycle-hook 'subtree))
5720 (t
5721 ;; Default action: hide the subtree.
5722 (hide-subtree)
5723 (message "FOLDED")
5724 (setq org-cycle-subtree-status 'folded)
5725 (run-hook-with-args 'org-cycle-hook 'folded)))))
5727 ;; TAB emulation
5728 (buffer-read-only (org-back-to-heading))
5730 ((org-try-cdlatex-tab))
5732 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5733 (or (not (bolp))
5734 (not (looking-at outline-regexp))))
5737 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5739 (or (and (eq org-cycle-emulate-tab 'white)
5740 (= (match-end 0) (point-at-eol)))
5741 (and (eq org-cycle-emulate-tab 'whitestart)
5742 (>= (match-end 0) pos))))
5743 t
5744 (eq org-cycle-emulate-tab t))
5747 ; (point-at-bol) (point))))
5748 ; (progn
5749 ; (beginning-of-line 1)
5753 (t (save-excursion
5754 (org-back-to-heading)
5755 (org-cycle))))))
5757 ;;;###autoload
5758 (defun org-global-cycle (&optional arg)
5759 "Cycle the global visibility. For details see `org-cycle'."
5760 (interactive "P")
5761 (let ((org-cycle-include-plain-lists
5762 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5763 (if (integerp arg)
5764 (progn
5765 (show-all)
5766 (hide-sublevels arg)
5767 (setq org-cycle-global-status 'contents))
5768 (org-cycle '(4)))))
5770 (defun org-overview ()
5771 "Switch to overview mode, shoing only top-level headlines.
5772 Really, this shows all headlines with level equal or greater than the level
5773 of the first headline in the buffer. This is important, because if the
5774 first headline is not level one, then (hide-sublevels 1) gives confusing
5775 results."
5776 (interactive)
5777 (let ((level (save-excursion
5778 (goto-char (point-min))
5779 (if (re-search-forward (concat "^" outline-regexp) nil t)
5780 (progn
5781 (goto-char (match-beginning 0))
5782 (funcall outline-level))))))
5783 (and level (hide-sublevels level))))
5785 (defun org-content (&optional arg)
5786 "Show all headlines in the buffer, like a table of contents.
5787 With numerical argument N, show content up to level N."
5788 (interactive "P")
5789 (save-excursion
5790 ;; Visit all headings and show their offspring
5791 (and (integerp arg) (org-overview))
5792 (goto-char (point-max))
5793 (catch 'exit
5794 (while (and (progn (condition-case nil
5795 (outline-previous-visible-heading 1)
5796 (error (goto-char (point-min))))
5797 t)
5798 (looking-at outline-regexp))
5799 (if (integerp arg)
5800 (show-children (1- arg))
5801 (show-branches))
5802 (if (bobp) (throw 'exit nil))))))
5805 (defun org-optimize-window-after-visibility-change (state)
5806 "Adjust the window after a change in outline visibility.
5807 This function is the default value of the hook `org-cycle-hook'."
5808 (when (get-buffer-window (current-buffer))
5809 (cond
5810 ; ((eq state 'overview) (org-first-headline-recenter 1))
5811 ; ((eq state 'overview) (org-beginning-of-line))
5812 ((eq state 'content) nil)
5813 ((eq state 'all) nil)
5814 ((eq state 'folded) nil)
5815 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5816 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5818 (defun org-compact-display-after-subtree-move ()
5819 (let (beg end)
5820 (save-excursion
5821 (if (org-up-heading-safe)
5822 (progn
5823 (hide-subtree)
5824 (show-entry)
5825 (show-children)
5826 (org-cycle-show-empty-lines 'children)
5827 (org-cycle-hide-drawers 'children))
5828 (org-overview)))))
5830 (defun org-cycle-show-empty-lines (state)
5831 "Show empty lines above all visible headlines.
5832 The region to be covered depends on STATE when called through
5833 `org-cycle-hook'. Lisp program can use t for STATE to get the
5834 entire buffer covered. Note that an empty line is only shown if there
5835 are at least `org-cycle-separator-lines' empty lines before the headeline."
5836 (when (> org-cycle-separator-lines 0)
5837 (save-excursion
5838 (let* ((n org-cycle-separator-lines)
5839 (re (cond
5842 (t (let ((ns (number-to-string (- n 2))))
5845 beg end)
5846 (cond
5847 ((memq state '(overview contents t))
5848 (setq beg (point-min) end (point-max)))
5849 ((memq state '(children folded))
5850 (setq beg (point) end (progn (org-end-of-subtree t t)
5851 (beginning-of-line 2)
5852 (point)))))
5853 (when beg
5854 (goto-char beg)
5855 (while (re-search-forward re end t)
5856 (if (not (get-char-property (match-end 1) 'invisible))
5857 (outline-flag-region
5858 (match-beginning 1) (match-end 1) nil)))))))
5859 ;; Never hide empty lines at the end of the file.
5860 (save-excursion
5861 (goto-char (point-max))
5862 (outline-previous-heading)
5863 (outline-end-of-heading)
5865 (= (match-end 0) (point-max)))
5866 (outline-flag-region (point) (match-end 0) nil))))
5868 (defun org-subtree-end-visible-p ()
5869 "Is the end of the current subtree visible?"
5870 (pos-visible-in-window-p
5871 (save-excursion (org-end-of-subtree t) (point))))
5873 (defun org-first-headline-recenter (&optional N)
5874 "Move cursor to the first headline and recenter the headline.
5875 Optional argument N means, put the headline into the Nth line of the window."
5876 (goto-char (point-min))
5878 (beginning-of-line)
5879 (recenter (prefix-numeric-value N))))
5881 ;;; Org-goto
5883 (defvar org-goto-window-configuration nil)
5884 (defvar org-goto-marker nil)
5885 (defvar org-goto-map
5886 (let ((map (make-sparse-keymap)))
5887 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5888 (while (setq cmd (pop cmds))
5889 (substitute-key-definition cmd cmd map global-map)))
5890 (suppress-keymap map)
5891 (org-defkey map "\C-m" 'org-goto-ret)
5892 (org-defkey map [(return)] 'org-goto-ret)
5893 (org-defkey map [(left)] 'org-goto-left)
5894 (org-defkey map [(right)] 'org-goto-right)
5895 (org-defkey map [(control ?g)] 'org-goto-quit)
5896 (org-defkey map "\C-i" 'org-cycle)
5897 (org-defkey map [(tab)] 'org-cycle)
5898 (org-defkey map [(down)] 'outline-next-visible-heading)
5899 (org-defkey map [(up)] 'outline-previous-visible-heading)
5900 (if org-goto-auto-isearch
5901 (if (fboundp 'define-key-after)
5902 (define-key-after map [t] 'org-goto-local-auto-isearch)
5903 nil)
5904 (org-defkey map "q" 'org-goto-quit)
5905 (org-defkey map "n" 'outline-next-visible-heading)
5906 (org-defkey map "p" 'outline-previous-visible-heading)
5907 (org-defkey map "f" 'outline-forward-same-level)
5908 (org-defkey map "b" 'outline-backward-same-level)
5909 (org-defkey map "u" 'outline-up-heading))
5910 (org-defkey map "/" 'org-occur)
5911 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5912 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5913 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5914 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5915 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5916 map))
5918 (defconst org-goto-help
5919 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5920 RET=jump to location [Q]uit and return to previous location
5921 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5923 (defvar org-goto-start-pos) ; dynamically scoped parameter
5925 (defun org-goto (&optional alternative-interface)
5926 "Look up a different location in the current file, keeping current visibility.
5928 When you want look-up or go to a different location in a document, the
5929 fastest way is often to fold the entire buffer and then dive into the tree.
5930 This method has the disadvantage, that the previous location will be folded,
5931 which may not be what you want.
5933 This command works around this by showing a copy of the current buffer
5934 in an indirect buffer, in overview mode. You can dive into the tree in
5935 that copy, use org-occur and incremental search to find a location.
5936 When pressing RET or `Q', the command returns to the original buffer in
5937 which the visibility is still unchanged. After RET is will also jump to
5938 the location selected in the indirect buffer and expose the
5939 the headline hierarchy above."
5940 (interactive "P")
5941 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
5942 (org-refile-use-outline-path t)
5943 (interface
5944 (if (not alternative-interface)
5945 org-goto-interface
5946 (if (eq org-goto-interface 'outline)
5947 'outline-path-completion
5948 'outline)))
5949 (org-goto-start-pos (point))
5950 (selected-point
5951 (if (eq interface 'outline)
5952 (car (org-get-location (current-buffer) org-goto-help))
5953 (nth 3 (org-refile-get-location "Goto: ")))))
5954 (if selected-point
5955 (progn
5956 (org-mark-ring-push org-goto-start-pos)
5957 (goto-char selected-point)
5958 (if (or (org-invisible-p) (org-invisible-p2))
5959 (org-show-context 'org-goto)))
5960 (message "Quit"))))
5962 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5963 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5964 (defvar org-goto-local-auto-isearch-map) ; defined below
5966 (defun org-get-location (buf help)
5967 "Let the user select a location in the Org-mode buffer BUF.
5968 This function uses a recursive edit. It returns the selected position
5969 or nil."
5970 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5971 (isearch-hide-immediately nil)
5972 (isearch-search-fun-function
5973 (lambda () 'org-goto-local-search-forward-headings))
5974 (org-goto-selected-point org-goto-exit-command))
5975 (save-excursion
5976 (save-window-excursion
5977 (delete-other-windows)
5978 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5979 (switch-to-buffer
5980 (condition-case nil
5981 (make-indirect-buffer (current-buffer) "*org-goto*")
5982 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5983 (with-output-to-temp-buffer "*Help*"
5984 (princ help))
5985 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5986 (setq buffer-read-only nil)
5987 (let ((org-startup-truncated t)
5988 (org-startup-folded nil)
5989 (org-startup-align-all-tables nil))
5990 (org-mode)
5991 (org-overview))
5992 (setq buffer-read-only t)
5993 (if (and (boundp 'org-goto-start-pos)
5994 (integer-or-marker-p org-goto-start-pos))
5995 (let ((org-show-hierarchy-above t)
5996 (org-show-siblings t)
5997 (org-show-following-heading t))
5998 (goto-char org-goto-start-pos)
5999 (and (org-invisible-p) (org-show-context)))
6000 (goto-char (point-min)))
6001 (org-beginning-of-line)
6002 (message "Select location and press RET")
6003 (use-local-map org-goto-map)
6004 (recursive-edit)
6005 ))
6006 (kill-buffer "*org-goto*")
6007 (cons org-goto-selected-point org-goto-exit-command)))
6009 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6010 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6011 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6012 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6014 (defun org-goto-local-search-forward-headings (string bound noerror)
6015 "Search and make sure that anu matches are in headlines."
6016 (catch 'return
6017 (while (search-forward string bound noerror)
6018 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6019 (and (member :headline context)
6020 (not (member :tags context))))
6021 (throw 'return (point))))))
6023 (defun org-goto-local-auto-isearch ()
6024 "Start isearch."
6025 (interactive)
6026 (goto-char (point-min))
6027 (let ((keys (this-command-keys)))
6028 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6029 (isearch-mode t)
6030 (isearch-process-search-char (string-to-char keys)))))
6032 (defun org-goto-ret (&optional arg)
6033 "Finish `org-goto' by going to the new location."
6034 (interactive "P")
6035 (setq org-goto-selected-point (point)
6036 org-goto-exit-command 'return)
6037 (throw 'exit nil))
6039 (defun org-goto-left ()
6040 "Finish `org-goto' by going to the new location."
6041 (interactive)
6042 (if (org-on-heading-p)
6043 (progn
6044 (beginning-of-line 1)
6045 (setq org-goto-selected-point (point)
6046 org-goto-exit-command 'left)
6047 (throw 'exit nil))
6048 (error "Not on a heading")))
6050 (defun org-goto-right ()
6051 "Finish `org-goto' by going to the new location."
6052 (interactive)
6053 (if (org-on-heading-p)
6054 (progn
6055 (setq org-goto-selected-point (point)
6056 org-goto-exit-command 'right)
6057 (throw 'exit nil))
6058 (error "Not on a heading")))
6060 (defun org-goto-quit ()
6061 "Finish `org-goto' without cursor motion."
6062 (interactive)
6063 (setq org-goto-selected-point nil)
6064 (setq org-goto-exit-command 'quit)
6065 (throw 'exit nil))
6067 ;;; Indirect buffer display of subtrees
6069 (defvar org-indirect-dedicated-frame nil
6070 "This is the frame being used for indirect tree display.")
6071 (defvar org-last-indirect-buffer nil)
6073 (defun org-tree-to-indirect-buffer (&optional arg)
6074 "Create indirect buffer and narrow it to current subtree.
6075 With numerical prefix ARG, go up to this level and then take that tree.
6076 If ARG is negative, go up that many levels.
6077 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6078 indirect buffer previously made with this command, to avoid proliferation of
6079 indirect buffers. However, when you call the command with a `C-u' prefix, or
6080 when `org-indirect-buffer-display' is `new-frame', the last buffer
6081 is kept so that you can work with several indirect buffers at the same time.
6082 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6083 requests that a new frame be made for the new buffer, so that the dedicated
6084 frame is not changed."
6085 (interactive "P")
6086 (let ((cbuf (current-buffer))
6087 (cwin (selected-window))
6088 (pos (point))
6089 beg end level heading ibuf)
6090 (save-excursion
6091 (org-back-to-heading t)
6092 (when (numberp arg)
6093 (setq level (org-outline-level))
6094 (if (< arg 0) (setq arg (+ level arg)))
6095 (while (> (setq level (org-outline-level)) arg)
6096 (outline-up-heading 1 t)))
6097 (setq beg (point)
6098 heading (org-get-heading))
6099 (org-end-of-subtree t) (setq end (point)))
6100 (if (and (buffer-live-p org-last-indirect-buffer)
6101 (not (eq org-indirect-buffer-display 'new-frame))
6102 (not arg))
6103 (kill-buffer org-last-indirect-buffer))
6104 (setq ibuf (org-get-indirect-buffer cbuf)
6105 org-last-indirect-buffer ibuf)
6106 (cond
6107 ((or (eq org-indirect-buffer-display 'new-frame)
6108 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6109 (select-frame (make-frame))
6110 (delete-other-windows)
6111 (switch-to-buffer ibuf)
6112 (org-set-frame-title heading))
6113 ((eq org-indirect-buffer-display 'dedicated-frame)
6114 (raise-frame
6115 (select-frame (or (and org-indirect-dedicated-frame
6116 (frame-live-p org-indirect-dedicated-frame)
6117 org-indirect-dedicated-frame)
6118 (setq org-indirect-dedicated-frame (make-frame)))))
6119 (delete-other-windows)
6120 (switch-to-buffer ibuf)
6121 (org-set-frame-title (concat "Indirect: " heading)))
6122 ((eq org-indirect-buffer-display 'current-window)
6123 (switch-to-buffer ibuf))
6124 ((eq org-indirect-buffer-display 'other-window)
6125 (pop-to-buffer ibuf))
6126 (t (error "Invalid value.")))
6127 (if (featurep 'xemacs)
6128 (save-excursion (org-mode) (turn-on-font-lock)))
6129 (narrow-to-region beg end)
6130 (show-all)
6131 (goto-char pos)
6132 (and (window-live-p cwin) (select-window cwin))))
6134 (defun org-get-indirect-buffer (&optional buffer)
6135 (setq buffer (or buffer (current-buffer)))
6136 (let ((n 1) (base (buffer-name buffer)) bname)
6137 (while (buffer-live-p
6138 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6139 (setq n (1+ n)))
6140 (condition-case nil
6141 (make-indirect-buffer buffer bname 'clone)
6142 (error (make-indirect-buffer buffer bname)))))
6144 (defun org-set-frame-title (title)
6145 "Set the title of the current frame to the string TITLE."
6146 ;; FIXME: how to name a single frame in XEmacs???
6147 (unless (featurep 'xemacs)
6148 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6150 ;;;; Structure editing
6152 ;;; Inserting headlines
6154 (defun org-insert-heading (&optional force-heading)
6155 "Insert a new heading or item with same depth at point.
6156 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6157 If point is at the beginning of a headline, insert a sibling before the
6158 current headline. If point is not at the beginning, do not split the line,
6159 but create the new hedline after the current line."
6160 (interactive "P")
6161 (if (= (buffer-size) 0)
6163 (when (or force-heading (not (org-insert-item)))
6164 (let* ((head (save-excursion
6165 (condition-case nil
6166 (progn
6167 (org-back-to-heading)
6168 (match-string 0))
6169 (error "*"))))
6170 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6171 pos)
6172 (cond
6173 ((and (org-on-heading-p) (bolp)
6174 (or (bobp)
6175 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6176 ;; insert before the current line
6177 (open-line (if blank 2 1)))
6178 ((and (bolp)
6179 (or (bobp)
6180 (save-excursion
6181 (backward-char 1) (not (org-invisible-p)))))
6182 ;; insert right here
6183 nil)
6184 (t
6185 ;; in the middle of the line
6186 (org-show-entry)
6187 (end-of-line 1)
6188 (newline (if blank 2 1))))
6189 (insert head) (just-one-space)
6190 (setq pos (point))
6191 (end-of-line 1)
6192 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6193 (run-hooks 'org-insert-heading-hook)))))
6195 (defun org-insert-heading-after-current ()
6196 "Insert a new heading with same level as current, after current subtree."
6197 (interactive)
6198 (org-back-to-heading)
6199 (org-insert-heading)
6200 (org-move-subtree-down)
6201 (end-of-line 1))
6203 (defun org-insert-todo-heading (arg)
6204 "Insert a new heading with the same level and TODO state as current heading.
6205 If the heading has no TODO state, or if the state is DONE, use the first
6206 state (TODO by default). Also with prefix arg, force first state."
6207 (interactive "P")
6208 (when (not (org-insert-item 'checkbox))
6209 (org-insert-heading)
6210 (save-excursion
6211 (org-back-to-heading)
6212 (outline-previous-heading)
6213 (looking-at org-todo-line-regexp))
6214 (if (or arg
6215 (not (match-beginning 2))
6216 (member (match-string 2) org-done-keywords))
6217 (insert (car org-todo-keywords-1) " ")
6218 (insert (match-string 2) " "))))
6220 (defun org-insert-subheading (arg)
6221 "Insert a new subheading and demote it.
6222 Works for outline headings and for plain lists alike."
6223 (interactive "P")
6224 (org-insert-heading arg)
6225 (cond
6226 ((org-on-heading-p) (org-do-demote))
6227 ((org-at-item-p) (org-indent-item 1))))
6229 (defun org-insert-todo-subheading (arg)
6230 "Insert a new subheading with TODO keyword or checkbox and demote it.
6231 Works for outline headings and for plain lists alike."
6232 (interactive "P")
6233 (org-insert-todo-heading arg)
6234 (cond
6235 ((org-on-heading-p) (org-do-demote))
6236 ((org-at-item-p) (org-indent-item 1))))
6238 ;;; Promotion and Demotion
6240 (defun org-promote-subtree ()
6241 "Promote the entire subtree.
6242 See also `org-promote'."
6243 (interactive)
6244 (save-excursion
6245 (org-map-tree 'org-promote))
6246 (org-fix-position-after-promote))
6248 (defun org-demote-subtree ()
6249 "Demote the entire subtree. See `org-demote'.
6250 See also `org-promote'."
6251 (interactive)
6252 (save-excursion
6253 (org-map-tree 'org-demote))
6254 (org-fix-position-after-promote))
6257 (defun org-do-promote ()
6258 "Promote the current heading higher up the tree.
6259 If the region is active in `transient-mark-mode', promote all headings
6260 in the region."
6261 (interactive)
6262 (save-excursion
6263 (if (org-region-active-p)
6264 (org-map-region 'org-promote (region-beginning) (region-end))
6265 (org-promote)))
6266 (org-fix-position-after-promote))
6268 (defun org-do-demote ()
6269 "Demote the current heading lower down the tree.
6270 If the region is active in `transient-mark-mode', demote all headings
6271 in the region."
6272 (interactive)
6273 (save-excursion
6274 (if (org-region-active-p)
6275 (org-map-region 'org-demote (region-beginning) (region-end))
6276 (org-demote)))
6277 (org-fix-position-after-promote))
6279 (defun org-fix-position-after-promote ()
6280 "Make sure that after pro/demotion cursor position is right."
6281 (let ((pos (point)))
6282 (when (save-excursion
6283 (beginning-of-line 1)
6284 (looking-at org-todo-line-regexp)
6285 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6286 (cond ((eobp) (insert " "))
6287 ((eolp) (insert " "))
6288 ((equal (char-after) ?\ ) (forward-char 1))))))
6290 (defun org-reduced-level (l)
6291 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6293 (defun org-get-legal-level (level &optional change)
6294 "Rectify a level change under the influence of `org-odd-levels-only'
6295 LEVEL is a current level, CHANGE is by how much the level should be
6296 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6297 even level numbers will become the next higher odd number."
6298 (if org-odd-levels-only
6299 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6300 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6301 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6302 (max 1 (+ level change))))
6304 (defun org-promote ()
6305 "Promote the current heading higher up the tree.
6306 If the region is active in `transient-mark-mode', promote all headings
6307 in the region."
6308 (org-back-to-heading t)
6309 (let* ((level (save-match-data (funcall outline-level)))
6310 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6311 (diff (abs (- level (length up-head) -1))))
6312 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6313 (replace-match up-head nil t)
6314 ;; Fixup tag positioning
6315 (and org-auto-align-tags (org-set-tags nil t))
6316 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6318 (defun org-demote ()
6319 "Demote the current heading lower down the tree.
6320 If the region is active in `transient-mark-mode', demote all headings
6321 in the region."
6322 (org-back-to-heading t)
6323 (let* ((level (save-match-data (funcall outline-level)))
6324 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6325 (diff (abs (- level (length down-head) -1))))
6326 (replace-match down-head nil t)
6327 ;; Fixup tag positioning
6328 (and org-auto-align-tags (org-set-tags nil t))
6329 (if org-adapt-indentation (org-fixup-indentation diff))))
6331 (defun org-map-tree (fun)
6332 "Call FUN for every heading underneath the current one."
6333 (org-back-to-heading)
6334 (let ((level (funcall outline-level)))
6335 (save-excursion
6336 (funcall fun)
6337 (while (and (progn
6338 (outline-next-heading)
6339 (> (funcall outline-level) level))
6340 (not (eobp)))
6341 (funcall fun)))))
6343 (defun org-map-region (fun beg end)
6344 "Call FUN for every heading between BEG and END."
6345 (let ((org-ignore-region t))
6346 (save-excursion
6347 (setq end (copy-marker end))
6348 (goto-char beg)
6349 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6350 (< (point) end))
6351 (funcall fun))
6352 (while (and (progn
6353 (outline-next-heading)
6354 (< (point) end))
6355 (not (eobp)))
6356 (funcall fun)))))
6358 (defun org-fixup-indentation (diff)
6359 "Change the indentation in the current entry by DIFF
6360 However, if any line in the current entry has no indentation, or if it
6361 would end up with no indentation after the change, nothing at all is done."
6362 (save-excursion
6363 (let ((end (save-excursion (outline-next-heading)
6364 (point-marker)))
6365 (prohibit (if (> diff 0)
6368 col)
6369 (unless (save-excursion (end-of-line 1)
6370 (re-search-forward prohibit end t))
6371 (while (and (< (point) end)
6373 (goto-char (match-end 0))
6374 (setq col (current-column))
6375 (if (< diff 0) (replace-match ""))
6376 (indent-to (+ diff col))))
6377 (move-marker end nil))))
6379 (defun org-convert-to-odd-levels ()
6380 "Convert an org-mode file with all levels allowed to one with odd levels.
6381 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6382 level 5 etc."
6383 (interactive)
6384 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6385 (let ((org-odd-levels-only nil) n)
6386 (save-excursion
6387 (goto-char (point-min))
6389 (setq n (- (length (match-string 0)) 2))
6390 (while (>= (setq n (1- n)) 0)
6391 (org-demote))
6392 (end-of-line 1))))))
6395 (defun org-convert-to-oddeven-levels ()
6396 "Convert an org-mode file with only odd levels to one with odd and even levels.
6397 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6398 section with an even level, conversion would destroy the structure of the file. An error
6399 is signaled in this case."
6400 (interactive)
6401 (goto-char (point-min))
6402 ;; First check if there are no even levels
6404 (org-show-context t)
6405 (error "Not all levels are odd in this file. Conversion not possible."))
6406 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6407 (let ((org-odd-levels-only nil) n)
6408 (save-excursion
6409 (goto-char (point-min))
6411 (setq n (/ (1- (length (match-string 0))) 2))
6412 (while (>= (setq n (1- n)) 0)
6413 (org-promote))
6414 (end-of-line 1))))))
6416 (defun org-tr-level (n)
6417 "Make N odd if required."
6418 (if org-odd-levels-only (1+ (/ n 2)) n))
6420 ;;; Vertical tree motion, cutting and pasting of subtrees
6422 (defun org-move-subtree-up (&optional arg)
6423 "Move the current subtree up past ARG headlines of the same level."
6424 (interactive "p")
6425 (org-move-subtree-down (- (prefix-numeric-value arg))))
6427 (defun org-move-subtree-down (&optional arg)
6428 "Move the current subtree down past ARG headlines of the same level."
6429 (interactive "p")
6430 (setq arg (prefix-numeric-value arg))
6431 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6432 'outline-get-last-sibling))
6433 (ins-point (make-marker))
6434 (cnt (abs arg))
6435 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6436 ;; Select the tree
6437 (org-back-to-heading)
6438 (setq beg0 (point))
6439 (save-excursion
6440 (setq ne-beg (org-back-over-empty-lines))
6441 (setq beg (point)))
6442 (save-match-data
6443 (save-excursion (outline-end-of-heading)
6444 (setq folded (org-invisible-p)))
6445 (outline-end-of-subtree))
6446 (outline-next-heading)
6447 (setq ne-end (org-back-over-empty-lines))
6448 (setq end (point))
6449 (goto-char beg0)
6450 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6451 ;; include less whitespace
6452 (save-excursion
6453 (goto-char beg)
6454 (forward-line (- ne-beg ne-end))
6455 (setq beg (point))))
6456 ;; Find insertion point, with error handling
6457 (while (> cnt 0)
6458 (or (and (funcall movfunc) (looking-at outline-regexp))
6459 (progn (goto-char beg0)
6460 (error "Cannot move past superior level or buffer limit")))
6461 (setq cnt (1- cnt)))
6462 (if (> arg 0)
6463 ;; Moving forward - still need to move over subtree
6464 (progn (org-end-of-subtree t t)
6465 (save-excursion
6466 (org-back-over-empty-lines)
6467 (or (bolp) (newline)))))
6468 (setq ne-ins (org-back-over-empty-lines))
6469 (move-marker ins-point (point))
6470 (setq txt (buffer-substring beg end))
6471 (delete-region beg end)
6472 (outline-flag-region (1- beg) beg nil)
6473 (outline-flag-region (1- (point)) (point) nil)
6474 (insert txt)
6476 (setq ins-end (point))
6477 (goto-char ins-point)
6478 (org-skip-whitespace)
6479 (when (and (< arg 0)
6480 (org-first-sibling-p)
6481 (> ne-ins ne-beg))
6482 ;; Move whitespace back to beginning
6483 (save-excursion
6484 (goto-char ins-end)
6485 (let ((kill-whole-line t))
6486 (kill-line (- ne-ins ne-beg)) (point)))
6488 (move-marker ins-point nil)
6489 (org-compact-display-after-subtree-move)
6490 (unless folded
6491 (org-show-entry)
6492 (show-children)
6493 (org-cycle-hide-drawers 'children))))
6495 (defvar org-subtree-clip ""
6496 "Clipboard for cut and paste of subtrees.
6497 This is actually only a copy of the kill, because we use the normal kill
6498 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6500 (defvar org-subtree-clip-folded nil
6501 "Was the last copied subtree folded?
6502 This is used to fold the tree back after pasting.")
6504 (defun org-cut-subtree (&optional n)
6505 "Cut the current subtree into the clipboard.
6506 With prefix arg N, cut this many sequential subtrees.
6507 This is a short-hand for marking the subtree and then cutting it."
6508 (interactive "p")
6509 (org-copy-subtree n 'cut))
6511 (defun org-copy-subtree (&optional n cut)
6512 "Cut the current subtree into the clipboard.
6513 With prefix arg N, cut this many sequential subtrees.
6514 This is a short-hand for marking the subtree and then copying it.
6515 If CUT is non-nil, actually cut the subtree."
6516 (interactive "p")
6517 (let (beg end folded (beg0 (point)))
6518 (if (interactive-p)
6519 (org-back-to-heading nil) ; take what looks like a subtree
6520 (org-back-to-heading t)) ; take what is really there
6521 (org-back-over-empty-lines)
6522 (setq beg (point))
6524 (save-match-data
6525 (save-excursion (outline-end-of-heading)
6526 (setq folded (org-invisible-p)))
6527 (condition-case nil
6528 (outline-forward-same-level (1- n))
6529 (error nil))
6530 (org-end-of-subtree t t))
6531 (org-back-over-empty-lines)
6532 (setq end (point))
6533 (goto-char beg0)
6534 (when (> end beg)
6535 (setq org-subtree-clip-folded folded)
6536 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6537 (setq org-subtree-clip (current-kill 0))
6538 (message "%s: Subtree(s) with %d characters"
6539 (if cut "Cut" "Copied")
6540 (length org-subtree-clip)))))
6542 (defun org-paste-subtree (&optional level tree)
6543 "Paste the clipboard as a subtree, with modification of headline level.
6544 The entire subtree is promoted or demoted in order to match a new headline
6545 level. By default, the new level is derived from the visible headings
6546 before and after the insertion point, and taken to be the inferior headline
6547 level of the two. So if the previous visible heading is level 3 and the
6548 next is level 4 (or vice versa), level 4 will be used for insertion.
6549 This makes sure that the subtree remains an independent subtree and does
6550 not swallow low level entries.
6552 You can also force a different level, either by using a numeric prefix
6553 argument, or by inserting the heading marker by hand. For example, if the
6558 If optional TREE is given, use this text instead of the kill ring."
6559 (interactive "P")
6560 (unless (org-kill-is-subtree-p tree)
6561 (error "%s"
6562 (substitute-command-keys
6564 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6569 (old-level (if (string-match ^re txt)
6570 (- (match-end 0) (match-beginning 0) 1)
6571 -1))
6572 (force-level (cond (level (prefix-numeric-value level))
6573 ((string-match
6574 ^re_ (buffer-substring (point-at-bol) (point)))
6575 (- (match-end 1) (match-beginning 1)))
6576 (t nil)))
6577 (previous-level (save-excursion
6578 (condition-case nil
6579 (progn
6580 (outline-previous-visible-heading 1)
6581 (if (looking-at re)
6582 (- (match-end 0) (match-beginning 0) 1)
6583 1))
6584 (error 1))))
6585 (next-level (save-excursion
6586 (condition-case nil
6587 (progn
6588 (or (looking-at outline-regexp)
6589 (outline-next-visible-heading 1))
6590 (if (looking-at re)
6591 (- (match-end 0) (match-beginning 0) 1)
6592 1))
6593 (error 1))))
6594 (new-level (or force-level (max previous-level next-level)))
6595 (shift (if (or (= old-level -1)
6596 (= new-level -1)
6597 (= old-level new-level))
6598 0
6599 (- new-level old-level)))
6600 (delta (if (> shift 0) -1 1))
6601 (func (if (> shift 0) 'org-demote 'org-promote))
6602 (org-odd-levels-only nil)
6603 beg end)
6604 ;; Remove the forced level indicator
6605 (if force-level
6606 (delete-region (point-at-bol) (point)))
6607 ;; Paste
6608 (beginning-of-line 1)
6609 (org-back-over-empty-lines) ;; FIXME: correct fix????
6610 (setq beg (point))
6611 (insert-before-markers txt) ;; FIXME: correct fix????
6613 (setq end (point))
6614 (goto-char beg)
6616 (setq beg (point))
6617 ;; Shift if necessary
6618 (unless (= shift 0)
6619 (save-restriction
6620 (narrow-to-region beg end)
6621 (while (not (= shift 0))
6622 (org-map-region func (point-min) (point-max))
6623 (setq shift (+ delta shift)))
6624 (goto-char (point-min))))
6625 (when (interactive-p)
6626 (message "Clipboard pasted as level %d subtree" new-level))
6627 (if (and kill-ring
6628 (eq org-subtree-clip (current-kill 0))
6629 org-subtree-clip-folded)
6630 ;; The tree was folded before it was killed/copied
6631 (hide-subtree))))
6633 (defun org-kill-is-subtree-p (&optional txt)
6634 "Check if the current kill is an outline subtree, or a set of trees.
6635 Returns nil if kill does not start with a headline, or if the first
6636 headline level is not the largest headline level in the tree.
6637 So this will actually accept several entries of equal levels as well,
6638 which is OK for `org-paste-subtree'.
6639 If optional TXT is given, check this string instead of the current kill."
6640 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6641 (start-level (and kill
6644 kill)
6645 (- (match-end 2) (match-beginning 2) 1)))
6646 (re (concat "^" org-outline-regexp))
6647 (start (1+ (match-beginning 2))))
6648 (if (not start-level)
6649 (progn
6650 nil) ;; does not even start with a heading
6651 (catch 'exit
6652 (while (setq start (string-match re kill (1+ start)))
6653 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6654 (throw 'exit nil)))
6655 t))))
6657 (defun org-narrow-to-subtree ()
6658 "Narrow buffer to the current subtree."
6659 (interactive)
6660 (save-excursion
6661 (narrow-to-region
6662 (progn (org-back-to-heading) (point))
6663 (progn (org-end-of-subtree t t) (point)))))
6666 ;;; Outline Sorting
6668 (defun org-sort (with-case)
6669 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6670 Optional argument WITH-CASE means sort case-sensitively."
6671 (interactive "P")
6672 (if (org-at-table-p)
6673 (org-call-with-arg 'org-table-sort-lines with-case)
6674 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6676 (defvar org-priority-regexp) ; defined later in the file
6678 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6679 "Sort entries on a certain level of an outline tree.
6680 If there is an active region, the entries in the region are sorted.
6681 Else, if the cursor is before the first entry, sort the top-level items.
6682 Else, the children of the entry at point are sorted.
6684 Sorting can be alphabetically, numerically, and by date/time as given by
6685 the first time stamp in the entry. The command prompts for the sorting
6686 type unless it has been given to the function through the SORTING-TYPE
6687 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6688 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6689 called with point at the beginning of the record. It must return either
6690 a string or a number that should serve as the sorting key for that record.
6692 Comparing entries ignores case by default. However, with an optional argument
6693 WITH-CASE, the sorting considers case as well."
6694 (interactive "P")
6695 (let ((case-func (if with-case 'identity 'downcase))
6696 start beg end stars re re2
6697 txt what tmp plain-list-p)
6698 ;; Find beginning and end of region to sort
6699 (cond
6700 ((org-region-active-p)
6701 ;; we will sort the region
6702 (setq end (region-end)
6703 what "region")
6704 (goto-char (region-beginning))
6705 (if (not (org-on-heading-p)) (outline-next-heading))
6706 (setq start (point)))
6707 ((org-at-item-p)
6708 ;; we will sort this plain list
6709 (org-beginning-of-item-list) (setq start (point))
6710 (org-end-of-item-list) (setq end (point))
6711 (goto-char start)
6712 (setq plain-list-p t
6713 what "plain list"))
6714 ((or (org-on-heading-p)
6715 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6716 ;; we will sort the children of the current headline
6717 (org-back-to-heading)
6718 (setq start (point)
6719 end (progn (org-end-of-subtree t t)
6720 (org-back-over-empty-lines)
6721 (point))
6722 what "children")
6723 (goto-char start)
6724 (show-subtree)
6725 (outline-next-heading))
6726 (t
6727 ;; we will sort the top-level entries in this file
6728 (goto-char (point-min))
6729 (or (org-on-heading-p) (outline-next-heading))
6730 (setq start (point) end (point-max) what "top-level")
6731 (goto-char start)
6732 (show-all)))
6734 (setq beg (point))
6735 (if (>= beg end) (error "Nothing to sort"))
6737 (unless plain-list-p
6739 (setq stars (match-string 1)
6740 re (concat "^" (regexp-quote stars) " +")
6741 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6742 txt (buffer-substring beg end))
6744 (if (and (not (equal stars "*")) (string-match re2 txt))
6745 (error "Region to sort contains a level above the first entry")))
6747 (unless sorting-type
6748 (message
6749 (if plain-list-p
6750 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6751 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6752 what)
6753 (setq sorting-type (read-char-exclusive))
6755 (and (= (downcase sorting-type) ?f)
6756 (setq getkey-func
6757 (completing-read "Sort using function: "
6758 obarray 'fboundp t nil nil))
6759 (setq getkey-func (intern getkey-func)))
6761 (and (= (downcase sorting-type) ?r)
6762 (setq property
6763 (completing-read "Property: "
6764 (mapcar 'list (org-buffer-property-keys t))
6765 nil t))))
6767 (message "Sorting entries...")
6769 (save-restriction
6770 (narrow-to-region start end)
6772 (let ((dcst (downcase sorting-type))
6773 (now (current-time)))
6774 (sort-subr
6775 (/= dcst sorting-type)
6776 ;; This function moves to the beginning character of the "record" to
6777 ;; be sorted.
6778 (if plain-list-p
6779 (lambda nil
6780 (if (org-at-item-p) t (goto-char (point-max))))
6781 (lambda nil
6782 (if (re-search-forward re nil t)
6783 (goto-char (match-beginning 0))
6784 (goto-char (point-max)))))
6785 ;; This function moves to the last character of the "record" being
6786 ;; sorted.
6787 (if plain-list-p
6788 'org-end-of-item
6789 (lambda nil
6790 (save-match-data
6791 (condition-case nil
6792 (outline-forward-same-level 1)
6793 (error
6794 (goto-char (point-max)))))))
6796 ;; This function returns the value that gets sorted against.
6797 (if plain-list-p
6798 (lambda nil
6800 (cond
6801 ((= dcst ?n)
6802 (string-to-number (buffer-substring (match-end 0)
6803 (point-at-eol))))
6804 ((= dcst ?a)
6805 (buffer-substring (match-end 0) (point-at-eol)))
6806 ((= dcst ?t)
6807 (if (re-search-forward org-ts-regexp
6808 (point-at-eol) t)
6809 (org-time-string-to-time (match-string 0))
6810 now))
6811 ((= dcst ?f)
6812 (if getkey-func
6813 (progn
6814 (setq tmp (funcall getkey-func))
6815 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6816 tmp)
6817 (error "Invalid key function `%s'" getkey-func)))
6818 (t (error "Invalid sorting type `%c'" sorting-type)))))
6819 (lambda nil
6820 (cond
6821 ((= dcst ?n)
6822 (if (looking-at outline-regexp)
6823 (string-to-number (buffer-substring (match-end 0)
6824 (point-at-eol)))
6825 nil))
6826 ((= dcst ?a)
6827 (funcall case-func (buffer-substring (point-at-bol)
6828 (point-at-eol))))
6829 ((= dcst ?t)
6830 (if (re-search-forward org-ts-regexp
6831 (save-excursion
6832 (forward-line 2)
6833 (point)) t)
6834 (org-time-string-to-time (match-string 0))
6835 now))
6836 ((= dcst ?p)
6837 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6838 (string-to-char (match-string 2))
6839 org-default-priority))
6840 ((= dcst ?r)
6841 (or (org-entry-get nil property) ""))
6842 ((= dcst ?f)
6843 (if getkey-func
6844 (progn
6845 (setq tmp (funcall getkey-func))
6846 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6847 tmp)
6848 (error "Invalid key function `%s'" getkey-func)))
6849 (t (error "Invalid sorting type `%c'" sorting-type)))))
6850 nil
6851 (cond
6852 ((= dcst ?a) 'string<)
6853 ((= dcst ?t) 'time-less-p)
6854 (t nil)))))
6855 (message "Sorting entries...done")))
6857 (defun org-do-sort (table what &optional with-case sorting-type)
6858 "Sort TABLE of WHAT according to SORTING-TYPE.
6859 The user will be prompted for the SORTING-TYPE if the call to this
6860 function does not specify it. WHAT is only for the prompt, to indicate
6861 what is being sorted. The sorting key will be extracted from
6862 the car of the elements of the table.
6863 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6864 (unless sorting-type
6865 (message
6866 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6867 what)
6868 (setq sorting-type (read-char-exclusive)))
6869 (let ((dcst (downcase sorting-type))
6870 extractfun comparefun)
6871 ;; Define the appropriate functions
6872 (cond
6873 ((= dcst ?n)
6874 (setq extractfun 'string-to-number
6875 comparefun (if (= dcst sorting-type) '< '>)))
6876 ((= dcst ?a)
6877 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6878 (lambda(x) (downcase (org-sort-remove-invisible x))))
6879 comparefun (if (= dcst sorting-type)
6880 'string<
6881 (lambda (a b) (and (not (string< a b))
6882 (not (string= a b)))))))
6883 ((= dcst ?t)
6884 (setq extractfun
6885 (lambda (x)
6886 (if (string-match org-ts-regexp x)
6887 (time-to-seconds
6888 (org-time-string-to-time (match-string 0 x)))
6889 0))
6890 comparefun (if (= dcst sorting-type) '< '>)))
6891 (t (error "Invalid sorting type `%c'" sorting-type)))
6893 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6894 table)
6895 (lambda (a b) (funcall comparefun (car a) (car b))))))
6897 ;;;; Plain list items, including checkboxes
6899 ;;; Plain list items
6901 (defun org-at-item-p ()
6902 "Is point in a line starting a hand-formatted item?"
6903 (let ((llt org-plain-list-ordered-item-terminator))
6904 (save-excursion
6905 (goto-char (point-at-bol))
6906 (looking-at
6907 (cond
6911 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6913 (defun org-in-item-p ()
6914 "It the cursor inside a plain list item.
6915 Does not have to be the first line."
6916 (save-excursion
6917 (condition-case nil
6918 (progn
6919 (org-beginning-of-item)
6920 (org-at-item-p)
6921 t)
6922 (error nil))))
6924 (defun org-insert-item (&optional checkbox)
6925 "Insert a new item at the current level.
6926 Return t when things worked, nil when we are not in an item."
6927 (when (save-excursion
6928 (condition-case nil
6929 (progn
6930 (org-beginning-of-item)
6931 (org-at-item-p)
6932 (if (org-invisible-p) (error "Invisible item"))
6933 t)
6934 (error nil)))
6935 (let* ((bul (match-string 0))
6937 (match-end 0)))
6938 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6939 pos)
6940 (cond
6941 ((and (org-at-item-p) (<= (point) eow))
6942 ;; before the bullet
6943 (beginning-of-line 1)
6944 (open-line (if blank 2 1)))
6945 ((<= (point) eow)
6946 (beginning-of-line 1))
6947 (t (newline (if blank 2 1))))
6948 (insert bul (if checkbox "[ ]" ""))
6949 (just-one-space)
6950 (setq pos (point))
6951 (end-of-line 1)
6952 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6953 (org-maybe-renumber-ordered-list)
6954 (and checkbox (org-update-checkbox-count-maybe))
6955 t))
6957 ;;; Checkboxes
6959 (defun org-at-item-checkbox-p ()
6960 "Is point at a line starting a plain-list item with a checklet?"
6961 (and (org-at-item-p)
6962 (save-excursion
6963 (goto-char (match-end 0))
6967 (defun org-toggle-checkbox (&optional arg)
6968 "Toggle the checkbox in the current line."
6969 (interactive "P")
6970 (catch 'exit
6971 (let (beg end status (firstnew 'unknown))
6972 (cond
6973 ((org-region-active-p)
6974 (setq beg (region-beginning) end (region-end)))
6975 ((org-on-heading-p)
6976 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6977 ((org-at-item-checkbox-p)
6978 (let ((pos (point)))
6979 (replace-match
6980 (cond (arg "[-]")
6981 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6982 (t "[ ]"))
6983 t t)
6984 (goto-char pos))
6985 (throw 'exit t))
6986 (t (error "Not at a checkbox or heading, and no active region")))
6987 (save-excursion
6988 (goto-char beg)
6989 (while (< (point) end)
6990 (when (org-at-item-checkbox-p)
6991 (setq status (equal (match-string 0) "[X]"))
6992 (when (eq firstnew 'unknown)
6993 (setq firstnew (not status)))
6994 (replace-match
6995 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6996 (beginning-of-line 2)))))
6997 (org-update-checkbox-count-maybe))
6999 (defun org-update-checkbox-count-maybe ()
7000 "Update checkbox statistics unless turned off by user."
7001 (when org-provide-checkbox-statistics
7002 (org-update-checkbox-count)))
7004 (defun org-update-checkbox-count (&optional all)
7005 "Update the checkbox statistics in the current section.
7006 This will find all statistic cookies like [57%] and [6/12] and update them
7007 with the current numbers. With optional prefix argument ALL, do this for
7008 the whole buffer."
7009 (interactive "P")
7010 (save-excursion
7011 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7012 (beg (condition-case nil
7013 (progn (outline-back-to-heading) (point))
7014 (error (point-min))))
7015 (end (move-marker (make-marker)
7016 (progn (outline-next-heading) (point))))
7020 beg-cookie end-cookie is-percent c-on c-off lim
7021 eline curr-ind next-ind continue-from startsearch
7022 (cstat 0)
7023 )
7024 (when all
7025 (goto-char (point-min))
7026 (outline-next-heading)
7027 (setq beg (point) end (point-max)))
7028 (goto-char end)
7029 ;; find each statistic cookie
7030 (while (re-search-backward re-find beg t)
7031 (setq beg-cookie (match-beginning 1)
7032 end-cookie (match-end 1)
7033 cstat (+ cstat (if end-cookie 1 0))
7034 startsearch (point-at-eol)
7035 continue-from (point-at-bol)
7036 is-percent (match-beginning 2)
7037 lim (cond
7038 ((org-on-heading-p) (outline-next-heading) (point))
7039 ((org-at-item-p) (org-end-of-item) (point))
7040 (t nil))
7041 c-on 0
7042 c-off 0)
7043 (when lim
7044 ;; find first checkbox for this cookie and gather
7045 ;; statistics from all that are at this indentation level
7046 (goto-char startsearch)
7047 (if (re-search-forward re-box lim t)
7048 (progn
7049 (org-beginning-of-item)
7050 (setq curr-ind (org-get-indentation))
7051 (setq next-ind curr-ind)
7052 (while (= curr-ind next-ind)
7053 (save-excursion (end-of-line) (setq eline (point)))
7054 (if (re-search-forward re-box eline t)
7055 (if (member (match-string 2) '("[ ]" "[-]"))
7056 (setq c-off (1+ c-off))
7057 (setq c-on (1+ c-on))
7058 )
7059 )
7060 (org-end-of-item)
7061 (setq next-ind (org-get-indentation))
7062 )))
7063 (goto-char continue-from)
7064 ;; update cookie
7065 (when end-cookie
7066 (delete-region beg-cookie end-cookie)
7067 (goto-char beg-cookie)
7068 (insert
7069 (if is-percent
7070 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7071 (format "[%d/%d]" c-on (+ c-on c-off)))))
7072 ;; update items checkbox if it has one
7073 (when (org-at-item-p)
7074 (org-beginning-of-item)
7075 (when (and (> (+ c-on c-off) 0)
7076 (re-search-forward re-box (point-at-eol) t))
7077 (setq beg-cookie (match-beginning 2)
7078 end-cookie (match-end 2))
7079 (delete-region beg-cookie end-cookie)
7080 (goto-char beg-cookie)
7081 (cond ((= c-off 0) (insert "[X]"))
7082 ((= c-on 0) (insert "[ ]"))
7083 (t (insert "[-]")))
7084 )))
7085 (goto-char continue-from))
7086 (when (interactive-p)
7087 (message "Checkbox satistics updated %s (%d places)"
7088 (if all "in entire file" "in current outline entry") cstat)))))
7090 (defun org-get-checkbox-statistics-face ()
7091 "Select the face for checkbox statistics.
7092 The face will be `org-done' when all relevant boxes are checked. Otherwise
7093 it will be `org-todo'."
7094 (if (match-end 1)
7095 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7096 (if (and (> (match-end 2) (match-beginning 2))
7097 (equal (match-string 2) (match-string 3)))
7098 'org-done
7099 'org-todo)))
7101 (defun org-get-indentation (&optional line)
7102 "Get the indentation of the current line, interpreting tabs.
7103 When LINE is given, assume it represents a line and compute its indentation."
7104 (if line
7105 (if (string-match "^ *" (org-remove-tabs line))
7106 (match-end 0))
7107 (save-excursion
7108 (beginning-of-line 1)
7110 (current-column))))
7112 (defun org-remove-tabs (s &optional width)
7113 "Replace tabulators in S with spaces.
7114 Assumes that s is a single line, starting in column 0."
7115 (setq width (or width tab-width))
7117 (setq s (replace-match
7118 (make-string
7119 (- (* width (/ (+ (match-beginning 0) width) width))
7120 (match-beginning 0)) ?\ )
7121 t t s)))
7122 s)
7124 (defun org-fix-indentation (line ind)
7125 "Fix indentation in LINE.
7126 IND is a cons cell with target and minimum indentation.
7127 If the current indenation in LINE is smaller than the minimum,
7128 leave it alone. If it is larger than ind, set it to the target."
7129 (let* ((l (org-remove-tabs line))
7130 (i (org-get-indentation l))
7131 (i1 (car ind)) (i2 (cdr ind)))
7132 (if (>= i i2) (setq l (substring line i2)))
7133 (if (> i1 0)
7134 (concat (make-string i1 ?\ ) l)
7135 l)))
7137 (defcustom org-empty-line-terminates-plain-lists nil
7138 "Non-nil means, an empty line ends all plain list levels.
7139 When nil, empty lines are part of the preceeding item."
7140 :group 'org-plain-lists
7141 :type 'boolean)
7143 (defun org-beginning-of-item ()
7144 "Go to the beginning of the current hand-formatted item.
7145 If the cursor is not in an item, throw an error."
7146 (interactive)
7147 (let ((pos (point))
7148 (limit (save-excursion
7149 (condition-case nil
7150 (progn
7151 (org-back-to-heading)
7152 (beginning-of-line 2) (point))
7153 (error (point-min)))))
7154 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7155 ind ind1)
7156 (if (org-at-item-p)
7157 (beginning-of-line 1)
7158 (beginning-of-line 1)
7160 (setq ind (current-column))
7161 (if (catch 'exit
7162 (while t
7163 (beginning-of-line 0)
7164 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7167 (setq ind1 ind-empty)
7169 (setq ind1 (current-column)))
7170 (if (< ind1 ind)
7171 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7172 nil
7173 (goto-char pos)
7174 (error "Not in an item")))))
7176 (defun org-end-of-item ()
7177 "Go to the end of the current hand-formatted item.
7178 If the cursor is not in an item, throw an error."
7179 (interactive)
7180 (let* ((pos (point))
7181 ind1
7182 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7183 (limit (save-excursion (outline-next-heading) (point)))
7184 (ind (save-excursion
7185 (org-beginning-of-item)
7187 (current-column)))
7188 (end (catch 'exit
7189 (while t
7190 (beginning-of-line 2)
7191 (if (eobp) (throw 'exit (point)))
7192 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7194 (setq ind1 ind-empty)
7196 (setq ind1 (current-column)))
7197 (if (<= ind1 ind)
7198 (throw 'exit (point-at-bol)))))))
7199 (if end
7200 (goto-char end)
7201 (goto-char pos)
7202 (error "Not in an item"))))
7204 (defun org-next-item ()
7205 "Move to the beginning of the next item in the current plain list.
7206 Error if not at a plain list, or if this is the last item in the list."
7207 (interactive)
7208 (let (ind ind1 (pos (point)))
7209 (org-beginning-of-item)
7210 (setq ind (org-get-indentation))
7211 (org-end-of-item)
7212 (setq ind1 (org-get-indentation))
7213 (unless (and (org-at-item-p) (= ind ind1))
7214 (goto-char pos)
7215 (error "On last item"))))
7217 (defun org-previous-item ()
7218 "Move to the beginning of the previous item in the current plain list.
7219 Error if not at a plain list, or if this is the first item in the list."
7220 (interactive)
7221 (let (beg ind ind1 (pos (point)))
7222 (org-beginning-of-item)
7223 (setq beg (point))
7224 (setq ind (org-get-indentation))
7225 (goto-char beg)
7226 (catch 'exit
7227 (while t
7228 (beginning-of-line 0)
7230 nil
7231 (if (<= (setq ind1 (org-get-indentation)) ind)
7232 (throw 'exit t)))))
7233 (condition-case nil
7234 (if (or (not (org-at-item-p))
7235 (< ind1 (1- ind)))
7236 (error "")
7237 (org-beginning-of-item))
7238 (error (goto-char pos)
7239 (error "On first item")))))
7241 (defun org-first-list-item-p ()
7242 "Is this heading the item in a plain list?"
7243 (unless (org-at-item-p)
7244 (error "Not at a plain list item"))
7245 (org-beginning-of-item)
7246 (= (point) (save-excursion (org-beginning-of-item-list))))
7248 (defun org-move-item-down ()
7249 "Move the plain list item at point down, i.e. swap with following item.
7250 Subitems (items with larger indentation) are considered part of the item,
7251 so this really moves item trees."
7252 (interactive)
7253 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7254 (org-beginning-of-item)
7255 (setq beg0 (point))
7256 (save-excursion
7257 (setq ne-beg (org-back-over-empty-lines))
7258 (setq beg (point)))
7259 (goto-char beg0)
7260 (setq ind (org-get-indentation))
7261 (org-end-of-item)
7262 (setq end0 (point))
7263 (setq ind1 (org-get-indentation))
7264 (setq ne-end (org-back-over-empty-lines))
7265 (setq end (point))
7266 (goto-char beg0)
7267 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7268 ;; include less whitespace
7269 (save-excursion
7270 (goto-char beg)
7271 (forward-line (- ne-beg ne-end))
7272 (setq beg (point))))
7273 (goto-char end0)
7274 (if (and (org-at-item-p) (= ind ind1))
7275 (progn
7276 (org-end-of-item)
7277 (org-back-over-empty-lines)
7278 (setq txt (buffer-substring beg end))
7279 (save-excursion
7280 (delete-region beg end))
7281 (setq pos (point))
7282 (insert txt)
7283 (goto-char pos) (org-skip-whitespace)
7284 (org-maybe-renumber-ordered-list))
7285 (goto-char pos)
7286 (error "Cannot move this item further down"))))
7288 (defun org-move-item-up (arg)
7289 "Move the plain list item at point up, i.e. swap with previous item.
7290 Subitems (items with larger indentation) are considered part of the item,
7291 so this really moves item trees."
7292 (interactive "p")
7293 (let (beg beg0 end end0 ind ind1 (pos (point)) txt
7294 ne-beg ne-end ne-ins ins-end)
7295 (org-beginning-of-item)
7296 (setq beg0 (point))
7297 (setq ind (org-get-indentation))
7298 (save-excursion
7299 (setq ne-beg (org-back-over-empty-lines))
7300 (setq beg (point)))
7301 (goto-char beg0)
7302 (org-end-of-item)
7303 (setq ne-end (org-back-over-empty-lines))
7304 (setq end (point))
7305 (goto-char beg0)
7306 (catch 'exit
7307 (while t
7308 (beginning-of-line 0)
7310 (if org-empty-line-terminates-plain-lists
7311 (progn
7312 (goto-char pos)
7313 (error "Cannot move this item further up"))
7314 nil)
7315 (if (<= (setq ind1 (org-get-indentation)) ind)
7316 (throw 'exit t)))))
7317 (condition-case nil
7318 (org-beginning-of-item)
7319 (error (goto-char beg)
7320 (error "Cannot move this item further up")))
7321 (setq ind1 (org-get-indentation))
7322 (if (and (org-at-item-p) (= ind ind1))
7323 (progn
7324 (setq ne-ins (org-back-over-empty-lines))
7325 (setq txt (buffer-substring beg end))
7326 (save-excursion
7327 (delete-region beg end))
7328 (setq pos (point))
7329 (insert txt)
7330 (setq ins-end (point))
7331 (goto-char pos) (org-skip-whitespace)
7333 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7334 ;; Move whitespace back to beginning
7335 (save-excursion
7336 (goto-char ins-end)
7337 (let ((kill-whole-line t))
7338 (kill-line (- ne-ins ne-beg)) (point)))
7341 (org-maybe-renumber-ordered-list))
7342 (goto-char pos)
7343 (error "Cannot move this item further up"))))
7345 (defun org-maybe-renumber-ordered-list ()
7346 "Renumber the ordered list at point if setup allows it.
7347 This tests the user option `org-auto-renumber-ordered-lists' before
7348 doing the renumbering."
7349 (interactive)
7350 (when (and org-auto-renumber-ordered-lists
7351 (org-at-item-p))
7352 (if (match-beginning 3)
7353 (org-renumber-ordered-list 1)
7354 (org-fix-bullet-type))))
7356 (defun org-maybe-renumber-ordered-list-safe ()
7357 (condition-case nil
7358 (save-excursion
7359 (org-maybe-renumber-ordered-list))
7360 (error nil)))
7362 (defun org-cycle-list-bullet (&optional which)
7363 "Cycle through the different itemize/enumerate bullets.
7364 This cycle the entire list level through the sequence:
7366 `-' -> `+' -> `*' -> `1.' -> `1)'
7368 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7369 0 meand `-', 1 means `+' etc."
7370 (interactive "P")
7371 (org-preserve-lc
7372 (org-beginning-of-item-list)
7373 (org-at-item-p)
7374 (beginning-of-line 1)
7375 (let ((current (match-string 0))
7376 (prevp (eq which 'previous))
7377 new)
7378 (setq new (cond
7379 ((and (numberp which)
7380 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7381 ((string-match "-" current) (if prevp "1)" "+"))
7386 ((string-match ")" current) (if prevp "1." "-"))
7387 (t (error "This should not happen"))))
7389 (org-fix-bullet-type)
7390 (org-maybe-renumber-ordered-list))))
7392 (defun org-get-string-indentation (s)
7393 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7394 (let ((n -1) (i 0) (w tab-width) c)
7395 (catch 'exit
7396 (while (< (setq n (1+ n)) (length s))
7397 (setq c (aref s n))
7398 (cond ((= c ?\ ) (setq i (1+ i)))
7400 (t (throw 'exit t)))))
7401 i))
7403 (defun org-renumber-ordered-list (arg)
7404 "Renumber an ordered plain list.
7405 Cursor needs to be in the first line of an item, the line that starts
7407 (interactive "p")
7408 (unless (and (org-at-item-p)
7409 (match-beginning 3))
7410 (error "This is not an ordered list"))
7411 (let ((line (org-current-line))
7412 (col (current-column))
7413 (ind (org-get-string-indentation
7414 (buffer-substring (point-at-bol) (match-beginning 3))))
7415 ;; (term (substring (match-string 3) -1))
7416 ind1 (n (1- arg))
7417 fmt)
7418 ;; find where this list begins
7419 (org-beginning-of-item-list)
7421 (setq fmt (concat "%d" (match-string 1)))
7422 (beginning-of-line 0)
7423 ;; walk forward and replace these numbers
7424 (catch 'exit
7425 (while t
7426 (catch 'next
7427 (beginning-of-line 2)
7428 (if (eobp) (throw 'exit nil))
7431 (if (> ind1 ind) (throw 'next t))
7432 (if (< ind1 ind) (throw 'exit t))
7433 (if (not (org-at-item-p)) (throw 'exit nil))
7434 (delete-region (match-beginning 2) (match-end 2))
7435 (goto-char (match-beginning 2))
7436 (insert (format fmt (setq n (1+ n)))))))
7437 (goto-line line)
7438 (move-to-column col)))
7440 (defun org-fix-bullet-type ()
7441 "Make sure all items in this list have the same bullet as the firsst item."
7442 (interactive)
7443 (unless (org-at-item-p) (error "This is not a list"))
7444 (let ((line (org-current-line))
7445 (col (current-column))
7446 (ind (current-indentation))
7447 ind1 bullet)
7448 ;; find where this list begins
7449 (org-beginning-of-item-list)
7450 (beginning-of-line 1)
7451 ;; find out what the bullet type is
7453 (setq bullet (match-string 1))
7454 ;; walk forward and replace these numbers
7455 (beginning-of-line 0)
7456 (catch 'exit
7457 (while t
7458 (catch 'next
7459 (beginning-of-line 2)
7460 (if (eobp) (throw 'exit nil))
7463 (if (> ind1 ind) (throw 'next t))
7464 (if (< ind1 ind) (throw 'exit t))
7465 (if (not (org-at-item-p)) (throw 'exit nil))
7468 (replace-match bullet))))
7469 (goto-line line)
7470 (move-to-column col)
7471 (if (string-match "[0-9]" bullet)
7472 (org-renumber-ordered-list 1))))
7474 (defun org-beginning-of-item-list ()
7475 "Go to the beginning of the current item list.
7476 I.e. to the first item in this list."
7477 (interactive)
7478 (org-beginning-of-item)
7479 (let ((pos (point-at-bol))
7480 (ind (org-get-indentation))
7481 ind1)
7482 ;; find where this list begins
7483 (catch 'exit
7484 (while t
7485 (catch 'next
7486 (beginning-of-line 0)
7488 (throw (if (bobp) 'exit 'next) t))
7490 (if (or (< ind1 ind)
7491 (and (= ind1 ind)
7492 (not (org-at-item-p)))
7493 (bobp))
7494 (throw 'exit t)
7495 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7496 (goto-char pos)))
7499 (defun org-end-of-item-list ()
7500 "Go to the end of the current item list.
7501 I.e. to the text after the last item."
7502 (interactive)
7503 (org-beginning-of-item)
7504 (let ((pos (point-at-bol))
7505 (ind (org-get-indentation))
7506 ind1)
7507 ;; find where this list begins
7508 (catch 'exit
7509 (while t
7510 (catch 'next
7511 (beginning-of-line 2)
7513 (throw (if (eobp) 'exit 'next) t))
7515 (if (or (< ind1 ind)
7516 (and (= ind1 ind)
7517 (not (org-at-item-p)))
7518 (eobp))
7519 (progn
7520 (setq pos (point-at-bol))
7521 (throw 'exit t))))))
7522 (goto-char pos)))
7525 (defvar org-last-indent-begin-marker (make-marker))
7526 (defvar org-last-indent-end-marker (make-marker))
7528 (defun org-outdent-item (arg)
7529 "Outdent a local list item."
7530 (interactive "p")
7531 (org-indent-item (- arg)))
7533 (defun org-indent-item (arg)
7534 "Indent a local list item."
7535 (interactive "p")
7536 (unless (org-at-item-p)
7537 (error "Not on an item"))
7538 (save-excursion
7539 (let (beg end ind ind1 tmp delta ind-down ind-up)
7540 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7541 (setq beg org-last-indent-begin-marker
7542 end org-last-indent-end-marker)
7543 (org-beginning-of-item)
7544 (setq beg (move-marker org-last-indent-begin-marker (point)))
7545 (org-end-of-item)
7546 (setq end (move-marker org-last-indent-end-marker (point))))
7547 (goto-char beg)
7548 (setq tmp (org-item-indent-positions)
7549 ind (car tmp)
7550 ind-down (nth 2 tmp)
7551 ind-up (nth 1 tmp)
7552 delta (if (> arg 0)
7553 (if ind-down (- ind-down ind) 2)
7554 (if ind-up (- ind-up ind) -2)))
7555 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7556 (while (< (point) end)
7557 (beginning-of-line 1)
7559 (delete-region (point-at-bol) (point))
7560 (or (eolp) (indent-to-column (+ ind1 delta)))
7561 (beginning-of-line 2))))
7562 (org-fix-bullet-type)
7563 (org-maybe-renumber-ordered-list-safe)
7564 (save-excursion
7565 (beginning-of-line 0)
7566 (condition-case nil (org-beginning-of-item) (error nil))
7567 (org-maybe-renumber-ordered-list-safe)))
7569 (defun org-item-indent-positions ()
7570 "Return indentation for plain list items.
7571 This returns a list with three values: The current indentation, the
7572 parent indentation and the indentation a child should habe.
7573 Assumes cursor in item line."
7574 (let* ((bolpos (point-at-bol))
7575 (ind (org-get-indentation))
7576 ind-down ind-up pos)
7577 (save-excursion
7578 (org-beginning-of-item-list)
7580 (when (org-in-item-p)
7581 (org-beginning-of-item)
7582 (setq ind-up (org-get-indentation))))
7583 (setq pos (point))
7584 (save-excursion
7585 (cond
7586 ((and (condition-case nil (progn (org-previous-item) t)
7587 (error nil))
7588 (or (forward-char 1) t)
7589 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7590 (setq ind-down (org-get-indentation)))
7591 ((and (goto-char pos)
7592 (org-at-item-p))
7593 (goto-char (match-end 0))
7595 (setq ind-down (current-column)))))
7596 (list ind ind-up ind-down)))
7598 ;;; The orgstruct minor mode
7600 ;; Define a minor mode which can be used in other modes in order to
7601 ;; integrate the org-mode structure editing commands.
7603 ;; This is really a hack, because the org-mode structure commands use
7604 ;; keys which normally belong to the major mode. Here is how it
7605 ;; works: The minor mode defines all the keys necessary to operate the
7606 ;; structure commands, but wraps the commands into a function which
7607 ;; tests if the cursor is currently at a headline or a plain list
7608 ;; item. If that is the case, the structure command is used,
7609 ;; temporarily setting many Org-mode variables like regular
7610 ;; expressions for filling etc. However, when any of those keys is
7611 ;; used at a different location, function uses `key-binding' to look
7612 ;; up if the key has an associated command in another currently active
7613 ;; keymap (minor modes, major mode, global), and executes that
7614 ;; command. There might be problems if any of the keys is otherwise
7615 ;; used as a prefix key.
7617 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7618 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7619 ;; addresses this by checking explicitly for both bindings.
7621 (defvar orgstruct-mode-map (make-sparse-keymap)
7622 "Keymap for the minor `orgstruct-mode'.")
7624 (defvar org-local-vars nil
7625 "List of local variables, for use by `orgstruct-mode'")
7627 ;;;###autoload
7628 (define-minor-mode orgstruct-mode
7629 "Toggle the minor more `orgstruct-mode'.
7630 This mode is for using Org-mode structure commands in other modes.
7631 The following key behave as if Org-mode was active, if the cursor
7632 is on a headline, or on a plain list item (both in the definition
7633 of Org-mode).
7635 M-up Move entry/item up
7636 M-down Move entry/item down
7637 M-left Promote
7638 M-right Demote
7639 M-S-up Move entry/item up
7640 M-S-down Move entry/item down
7641 M-S-left Promote subtree
7642 M-S-right Demote subtree
7643 M-q Fill paragraph and items like in Org-mode
7644 C-c ^ Sort entries
7645 C-c - Cycle list bullet
7646 TAB Cycle item visibility
7647 M-RET Insert new heading/item
7648 S-M-RET Insert new TODO heading / Chekbox item
7649 C-c C-c Set tags / toggle checkbox"
7650 nil " OrgStruct" nil
7651 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7653 ;;;###autoload
7654 (defun turn-on-orgstruct ()
7655 "Unconditionally turn on `orgstruct-mode'."
7656 (orgstruct-mode 1))
7658 ;;;###autoload
7659 (defun turn-on-orgstruct++ ()
7660 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7661 In addition to setting orgstruct-mode, this also exports all indentation and
7662 autofilling variables from org-mode into the buffer. Note that turning
7663 off orgstruct-mode will *not* remove these additional settings."
7664 (orgstruct-mode 1)
7665 (let (var val)
7666 (mapc
7667 (lambda (x)
7668 (when (string-match
7670 (symbol-name (car x)))
7671 (setq var (car x) val (nth 1 x))
7672 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7673 org-local-vars)))
7675 (defun orgstruct-error ()
7676 "Error when there is no default binding for a structure key."
7677 (interactive)
7678 (error "This key has no function outside structure elements"))
7680 (defun orgstruct-setup ()
7681 "Setup orgstruct keymaps."
7682 (let ((nfunc 0)
7683 (bindings
7684 (list
7685 '([(meta up)] org-metaup)
7686 '([(meta down)] org-metadown)
7687 '([(meta left)] org-metaleft)
7688 '([(meta right)] org-metaright)
7689 '([(meta shift up)] org-shiftmetaup)
7690 '([(meta shift down)] org-shiftmetadown)
7691 '([(meta shift left)] org-shiftmetaleft)
7692 '([(meta shift right)] org-shiftmetaright)
7693 '([(shift up)] org-shiftup)
7694 '([(shift down)] org-shiftdown)
7695 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7696 '("\M-q" fill-paragraph)
7697 '("\C-c^" org-sort)
7698 '("\C-c-" org-cycle-list-bullet)))
7699 elt key fun cmd)
7700 (while (setq elt (pop bindings))
7701 (setq nfunc (1+ nfunc))
7702 (setq key (org-key (car elt))
7703 fun (nth 1 elt)
7704 cmd (orgstruct-make-binding fun nfunc key))
7705 (org-defkey orgstruct-mode-map key cmd))
7707 ;; Special treatment needed for TAB and RET
7708 (org-defkey orgstruct-mode-map [(tab)]
7709 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7710 (org-defkey orgstruct-mode-map "\C-i"
7711 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7713 (org-defkey orgstruct-mode-map "\M-\C-m"
7714 (orgstruct-make-binding 'org-insert-heading 105
7715 "\M-\C-m" [(meta return)]))
7716 (org-defkey orgstruct-mode-map [(meta return)]
7717 (orgstruct-make-binding 'org-insert-heading 106
7718 [(meta return)] "\M-\C-m"))
7720 (org-defkey orgstruct-mode-map [(shift meta return)]
7721 (orgstruct-make-binding 'org-insert-todo-heading 107
7722 [(meta return)] "\M-\C-m"))
7724 (unless org-local-vars
7725 (setq org-local-vars (org-get-local-variables)))
7727 t))
7729 (defun orgstruct-make-binding (fun n &rest keys)
7730 "Create a function for binding in the structure minor mode.
7731 FUN is the command to call inside a table. N is used to create a unique
7732 command name. KEYS are keys that should be checked in for a command
7733 to execute outside of tables."
7734 (eval
7735 (list 'defun
7736 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7737 '(arg)
7739 "Outside of structure, run the binding of `"
7740 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7741 "'.")
7742 '(interactive "p")
7743 (list 'if
7744 '(org-context-p 'headline 'item)
7745 (list 'org-run-like-in-org-mode (list 'quote fun))
7746 (list 'let '(orgstruct-mode)
7747 (list 'call-interactively
7748 (append '(or)
7749 (mapcar (lambda (k)
7750 (list 'key-binding k))
7751 keys)
7752 '('orgstruct-error))))))))
7754 (defun org-context-p (&rest contexts)
7755 "Check if local context is and of CONTEXTS.
7756 Possible values in the list of contexts are `table', `headline', and `item'."
7757 (let ((pos (point)))
7758 (goto-char (point-at-bol))
7759 (prog1 (or (and (memq 'table contexts)
7761 (and (memq 'headline contexts)
7763 (and (memq 'item contexts)
7765 (goto-char pos))))
7767 (defun org-get-local-variables ()
7768 "Return a list of all local variables in an org-mode buffer."
7769 (let (varlist)
7770 (with-current-buffer (get-buffer-create "*Org tmp*")
7771 (erase-buffer)
7772 (org-mode)
7773 (setq varlist (buffer-local-variables)))
7774 (kill-buffer "*Org tmp*")
7775 (delq nil
7776 (mapcar
7777 (lambda (x)
7778 (setq x
7779 (if (symbolp x)
7780 (list x)
7781 (list (car x) (list 'quote (cdr x)))))
7782 (if (string-match
7783 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7784 (symbol-name (car x)))
7785 x nil))
7786 varlist))))
7788 ;;;###autoload
7789 (defun org-run-like-in-org-mode (cmd)
7790 (unless org-local-vars
7791 (setq org-local-vars (org-get-local-variables)))
7792 (eval (list 'let org-local-vars
7793 (list 'call-interactively (list 'quote cmd)))))
7795 ;;;; Archiving
7797 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7799 (defun org-archive-subtree (&optional find-done)
7800 "Move the current subtree to the archive.
7801 The archive can be a certain top-level heading in the current file, or in
7802 a different file. The tree will be moved to that location, the subtree
7803 heading be marked DONE, and the current time will be added.
7805 When called with prefix argument FIND-DONE, find whole trees without any
7806 open TODO items and archive them (after getting confirmation from the user).
7807 If the cursor is not at a headline when this comand is called, try all level
7808 1 trees. If the cursor is on a headline, only try the direct children of
7809 this heading."
7810 (interactive "P")
7811 (if find-done
7812 (org-archive-all-done)
7813 ;; Save all relevant TODO keyword-relatex variables
7815 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7816 (tr-org-todo-keywords-1 org-todo-keywords-1)
7817 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7818 (tr-org-done-keywords org-done-keywords)
7819 (tr-org-todo-regexp org-todo-regexp)
7820 (tr-org-todo-line-regexp org-todo-line-regexp)
7821 (tr-org-odd-levels-only org-odd-levels-only)
7822 (this-buffer (current-buffer))
7823 (org-archive-location org-archive-location)
7825 ;; start of variables that will be used for saving context
7826 ;; The compiler complains about them - keep them anyway!
7827 (file (abbreviate-file-name (buffer-file-name)))
7828 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7829 (time (format-time-string
7830 (substring (cdr org-time-stamp-formats) 1 -1)
7831 (current-time)))
7832 afile heading buffer level newfile-p
7833 category todo priority
7834 ;; start of variables that will be used for savind context
7835 ltags itags prop)
7837 ;; Try to find a local archive location
7838 (save-excursion
7839 (save-restriction
7840 (widen)
7841 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7843 (setq org-archive-location prop)
7844 (if (or (re-search-backward re nil t)
7845 (re-search-forward re nil t))
7846 (setq org-archive-location (match-string 1))))))
7849 (progn
7850 (setq afile (format (match-string 1 org-archive-location)
7851 (file-name-nondirectory buffer-file-name))
7852 heading (match-string 2 org-archive-location)))
7853 (error "Invalid `org-archive-location'"))
7854 (if (> (length afile) 0)
7855 (setq newfile-p (not (file-exists-p afile))
7856 buffer (find-file-noselect afile))
7857 (setq buffer (current-buffer)))
7858 (unless buffer
7860 (if (and (> (length heading) 0)
7862 (setq level (match-end 0))
7863 (setq heading nil level 0))
7864 (save-excursion
7865 (org-back-to-heading t)
7866 ;; Get context information that will be lost by moving the tree
7867 (org-refresh-category-properties)
7868 (setq category (org-get-category)
7869 todo (and (looking-at org-todo-line-regexp)
7870 (match-string 2))
7871 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7872 ltags (org-get-tags)
7873 itags (org-delete-all ltags (org-get-tags-at)))
7874 (setq ltags (mapconcat 'identity ltags " ")
7875 itags (mapconcat 'identity itags " "))
7876 ;; We first only copy, in case something goes wrong
7877 ;; we need to protect this-command, to avoid kill-region sets it,
7878 ;; which would lead to duplication of subtrees
7879 (let (this-command) (org-copy-subtree))
7880 (set-buffer buffer)
7881 ;; Enforce org-mode for the archive buffer
7882 (if (not (org-mode-p))
7883 ;; Force the mode for future visits.
7884 (let ((org-insert-mode-line-in-empty-file t)
7885 (org-inhibit-startup t))
7886 (call-interactively 'org-mode)))
7887 (when newfile-p
7888 (goto-char (point-max))
7890 (buffer-file-name this-buffer))))
7891 ;; Force the TODO keywords of the original buffer
7892 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7893 (org-todo-keywords-1 tr-org-todo-keywords-1)
7894 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7895 (org-done-keywords tr-org-done-keywords)
7896 (org-todo-regexp tr-org-todo-regexp)
7897 (org-todo-line-regexp tr-org-todo-line-regexp)
7898 (org-odd-levels-only
7899 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7900 org-odd-levels-only
7901 tr-org-odd-levels-only)))
7902 (goto-char (point-min))
7903 (if heading
7904 (progn
7905 (if (re-search-forward
7906 (concat "^" (regexp-quote heading)
7908 nil t)
7909 (goto-char (match-end 0))
7910 ;; Heading not found, just insert it at the end
7911 (goto-char (point-max))
7914 (end-of-line 0))
7915 ;; Make the subtree visible
7916 (show-subtree)
7917 (org-end-of-subtree t)
7921 ;; No specific heading, just go to end of file.
7923 ;; Paste
7924 (org-paste-subtree (org-get-legal-level level 1))
7926 ;; Mark the entry as done
7927 (when (and org-archive-mark-done
7928 (looking-at org-todo-line-regexp)
7929 (or (not (match-end 2))
7930 (not (member (match-string 2) org-done-keywords))))
7931 (let (org-log-done)
7932 (org-todo
7933 (car (or (member org-archive-mark-done org-done-keywords)
7934 org-done-keywords)))))
7936 ;; Add the context info
7937 (when org-archive-save-context-info
7938 (let ((l org-archive-save-context-info) e n v)
7939 (while (setq e (pop l))
7940 (when (and (setq v (symbol-value e))
7942 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7943 (org-entry-put (point) n v)))))
7945 ;; Save the buffer, if it is not the same buffer.
7946 (if (not (eq this-buffer buffer)) (save-buffer))))
7947 ;; Here we are back in the original buffer. Everything seems to have
7948 ;; worked. So now cut the tree and finish up.
7949 (let (this-command) (org-cut-subtree))
7951 (message "Subtree archived %s"
7952 (if (eq this-buffer buffer)
7953 (concat "under heading: " heading)
7954 (concat "in file: " (abbreviate-file-name afile)))))))
7956 (defun org-refresh-category-properties ()
7957 "Refresh category text properties in teh buffer."
7958 (let ((def-cat (cond
7959 ((null org-category)
7960 (if buffer-file-name
7961 (file-name-sans-extension
7962 (file-name-nondirectory buffer-file-name))
7963 "???"))
7964 ((symbolp org-category) (symbol-name org-category))
7965 (t org-category)))
7966 beg end cat pos optionp)
7967 (org-unmodified
7968 (save-excursion
7969 (save-restriction
7970 (widen)
7971 (goto-char (point-min))
7972 (put-text-property (point) (point-max) 'org-category def-cat)
7973 (while (re-search-forward
7975 (setq pos (match-end 0)
7976 optionp (equal (char-after (match-beginning 0)) ?#)
7977 cat (org-trim (match-string 2)))
7978 (if optionp
7979 (setq beg (point-at-bol) end (point-max))
7980 (org-back-to-heading t)
7981 (setq beg (point) end (org-end-of-subtree t t)))
7982 (put-text-property beg end 'org-category cat)
7983 (goto-char pos)))))))
7985 (defun org-archive-all-done (&optional tag)
7986 "Archive sublevels of the current tree without open TODO items.
7987 If the cursor is not on a headline, try all level 1 trees. If
7988 it is on a headline, try all direct children.
7989 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7991 (rea (concat ".*:" org-archive-tag ":"))
7992 (begm (make-marker))
7993 (endm (make-marker))
7994 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7995 "Move subtree to archive (no open TODO items)? "))
7996 beg end (cntarch 0))
7997 (if (org-on-heading-p)
7998 (progn
7999 (setq re1 (concat "^" (regexp-quote
8000 (make-string
8001 (1+ (- (match-end 0) (match-beginning 0) 1))
8002 ?*))
8003 " "))
8004 (move-marker begm (point))
8005 (move-marker endm (org-end-of-subtree t)))
8006 (setq re1 "^* ")
8007 (move-marker begm (point-min))
8008 (move-marker endm (point-max)))
8009 (save-excursion
8010 (goto-char begm)
8011 (while (re-search-forward re1 endm t)
8012 (setq beg (match-beginning 0)
8013 end (save-excursion (org-end-of-subtree t) (point)))
8014 (goto-char beg)
8015 (if (re-search-forward re end t)
8016 (goto-char end)
8017 (goto-char beg)
8018 (if (and (or (not tag) (not (looking-at rea)))
8019 (y-or-n-p question))
8020 (progn
8021 (if tag
8022 (org-toggle-tag org-archive-tag 'on)
8023 (org-archive-subtree))
8024 (setq cntarch (1+ cntarch)))
8025 (goto-char end)))))
8026 (message "%d trees archived" cntarch)))
8028 (defun org-cycle-hide-drawers (state)
8029 "Re-hide all drawers after a visibility state change."
8030 (when (and (org-mode-p)
8031 (not (memq state '(overview folded))))
8032 (save-excursion
8033 (let* ((globalp (memq state '(contents all)))
8034 (beg (if globalp (point-min) (point)))
8035 (end (if globalp (point-max) (org-end-of-subtree t))))
8036 (goto-char beg)
8037 (while (re-search-forward org-drawer-regexp end t)
8038 (org-flag-drawer t))))))
8040 (defun org-flag-drawer (flag)
8041 (save-excursion
8042 (beginning-of-line 1)
8044 (let ((b (match-end 0))
8045 (outline-regexp org-outline-regexp))
8046 (if (re-search-forward
8048 (save-excursion (outline-next-heading) (point)) t)
8049 (outline-flag-region b (point-at-eol) flag)
8050 (error ":END: line missing"))))))
8052 (defun org-cycle-hide-archived-subtrees (state)
8053 "Re-hide all archived subtrees after a visibility state change."
8054 (when (and (not org-cycle-open-archived-trees)
8055 (not (memq state '(overview folded))))
8056 (save-excursion
8057 (let* ((globalp (memq state '(contents all)))
8058 (beg (if globalp (point-min) (point)))
8059 (end (if globalp (point-max) (org-end-of-subtree t))))
8060 (org-hide-archived-subtrees beg end)
8061 (goto-char beg)
8062 (if (looking-at (concat ".*:" org-archive-tag ":"))
8063 (message "%s" (substitute-command-keys
8064 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8066 (defun org-force-cycle-archived ()
8067 "Cycle subtree even if it is archived."
8068 (interactive)
8069 (setq this-command 'org-cycle)
8070 (let ((org-cycle-open-archived-trees t))
8071 (call-interactively 'org-cycle)))
8073 (defun org-hide-archived-subtrees (beg end)
8074 "Re-hide all archived subtrees after a visibility state change."
8075 (save-excursion
8076 (let* ((re (concat ":" org-archive-tag ":")))
8077 (goto-char beg)
8078 (while (re-search-forward re end t)
8079 (and (org-on-heading-p) (hide-subtree))
8080 (org-end-of-subtree t)))))
8082 (defun org-toggle-tag (tag &optional onoff)
8083 "Toggle the tag TAG for the current line.
8084 If ONOFF is `on' or `off', don't toggle but set to this state."
8085 (unless (org-on-heading-p t) (error "Not on headling"))
8086 (let (res current)
8087 (save-excursion
8088 (beginning-of-line)
8090 (point-at-eol) t)
8091 (progn
8092 (setq current (match-string 1))
8093 (replace-match ""))
8094 (setq current ""))
8095 (setq current (nreverse (org-split-string current ":")))
8096 (cond
8097 ((eq onoff 'on)
8098 (setq res t)
8099 (or (member tag current) (push tag current)))
8100 ((eq onoff 'off)
8101 (or (not (member tag current)) (setq current (delete tag current))))
8102 (t (if (member tag current)
8103 (setq current (delete tag current))
8104 (setq res t)
8105 (push tag current))))
8106 (end-of-line 1)
8107 (if current
8108 (progn
8109 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8110 (org-set-tags nil t))
8111 (delete-horizontal-space))
8112 (run-hooks 'org-after-tags-change-hook))
8113 res))
8115 (defun org-toggle-archive-tag (&optional arg)
8116 "Toggle the archive tag for the current headline.
8117 With prefix ARG, check all children of current headline and offer tagging
8118 the children that do not contain any open TODO items."
8119 (interactive "P")
8120 (if arg
8121 (org-archive-all-done 'tag)
8122 (let (set)
8123 (save-excursion
8124 (org-back-to-heading t)
8125 (setq set (org-toggle-tag org-archive-tag))
8126 (when set (hide-subtree)))
8127 (and set (beginning-of-line 1))
8128 (message "Subtree %s" (if set "archived" "unarchived")))))
8131 ;;;; Tables
8133 ;;; The table editor
8135 ;; Watch out: Here we are talking about two different kind of tables.
8136 ;; Most of the code is for the tables created with the Org-mode table editor.
8137 ;; Sometimes, we talk about tables created and edited with the table.el
8138 ;; Emacs package. We call the former org-type tables, and the latter
8139 ;; table.el-type tables.
8141 (defun org-before-change-function (beg end)
8142 "Every change indicates that a table might need an update."
8143 (setq org-table-may-need-update t))
8146 "Detects an org-type table line.")
8148 "Detects an org-type table line.")
8150 "Detects a table line marked for automatic recalculation.")
8152 "Detects a table line marked for automatic recalculation.")
8154 "Detects a table line marked for automatic recalculation.")
8156 "Detects an org-type table hline.")
8158 "Detects a table-type table hline.")
8160 "Detects an org-type or table-type table.")
8162 "Searching from within a table (any type) this finds the first line
8163 outside the table.")
8165 "Searching from within a table (any type) this finds the first line
8166 outside the table.")
8168 (defvar org-table-last-highlighted-reference nil)
8169 (defvar org-table-formula-history nil)
8171 (defvar org-table-column-names nil
8172 "Alist with column names, derived from the `!' line.")
8173 (defvar org-table-column-name-regexp nil
8174 "Regular expression matching the current column names.")
8175 (defvar org-table-local-parameters nil
8176 "Alist with parameter names, derived from the `$' line.")
8177 (defvar org-table-named-field-locations nil
8178 "Alist with locations of named fields.")
8180 (defvar org-table-current-line-types nil
8181 "Table row types, non-nil only for the duration of a comand.")
8182 (defvar org-table-current-begin-line nil
8183 "Table begin line, non-nil only for the duration of a comand.")
8184 (defvar org-table-current-begin-pos nil
8185 "Table begin position, non-nil only for the duration of a comand.")
8186 (defvar org-table-dlines nil
8187 "Vector of data line line numbers in the current table.")
8188 (defvar org-table-hlines nil
8189 "Vector of hline line numbers in the current table.")
8191 (defconst org-table-range-regexp
8192 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8193 ;; 1 2 3 4 5
8194 "Regular expression for matching ranges in formulas.")
8196 (defconst org-table-range-regexp2
8197 (concat
8201 "Match a range for reference display.")
8203 (defconst org-table-translate-regexp
8205 "Match a reference that needs translation, for reference display.")
8207 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8209 (defun org-table-create-with-table.el ()
8210 "Use the table.el package to insert a new table.
8211 If there is already a table at point, convert between Org-mode tables
8212 and table.el tables."
8213 (interactive)
8214 (require 'table)
8215 (cond
8216 ((org-at-table.el-p)
8217 (if (y-or-n-p "Convert table to Org-mode table? ")
8218 (org-table-convert)))
8219 ((org-at-table-p)
8220 (if (y-or-n-p "Convert table to table.el table? ")
8221 (org-table-convert)))
8222 (t (call-interactively 'table-insert))))
8224 (defun org-table-create-or-convert-from-region (arg)
8225 "Convert region to table, or create an empty table.
8226 If there is an active region, convert it to a table, using the function
8227 `org-table-convert-region'. See the documentation of that function
8228 to learn how the prefix argument is interpreted to determine the field
8229 separator.
8230 If there is no such region, create an empty table with `org-table-create'."
8231 (interactive "P")
8232 (if (org-region-active-p)
8233 (org-table-convert-region (region-beginning) (region-end) arg)
8234 (org-table-create arg)))
8236 (defun org-table-create (&optional size)
8237 "Query for a size and insert a table skeleton.
8239 (interactive "P")
8240 (unless size
8241 (setq size (read-string
8242 (concat "Table size Columns x Rows [e.g. "
8243 org-table-default-size "]: ")
8244 "" nil org-table-default-size)))
8246 (let* ((pos (point))
8247 (indent (make-string (current-column) ?\ ))
8248 (split (org-split-string size " *x *"))
8249 (rows (string-to-number (nth 1 split)))
8250 (columns (string-to-number (car split)))
8251 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8254 (point-at-bol) (point)))
8255 (beginning-of-line 1)
8256 (newline))
8257 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8258 (dotimes (i rows) (insert line))
8259 (goto-char pos)
8260 (if (> rows 1)
8261 ;; Insert a hline after the first row.
8262 (progn
8263 (end-of-line 1)
8265 (goto-char pos)))
8266 (org-table-align)))
8268 (defun org-table-convert-region (beg0 end0 &optional separator)
8269 "Convert region to a table.
8270 The region goes from BEG0 to END0, but these borders will be moved
8271 slightly, to make sure a beginning of line in the first line is included.
8273 SEPARATOR specifies the field separator in the lines. It can have the
8274 following values:
8276 '(4) Use the comma as a field separator
8277 '(16) Use a TAB as field separator
8278 integer When a number, use that many spaces as field separator
8279 nil When nil, the command tries to be smart and figure out the
8280 separator in the following way:
8281 - when each line contains a TAB, assume TAB-separated material
8282 - when each line contains a comme, assume CSV material
8283 - else, assume one or more SPACE charcters as separator."
8284 (interactive "rP")
8285 (let* ((beg (min beg0 end0))
8286 (end (max beg0 end0))
8287 re)
8288 (goto-char beg)
8289 (beginning-of-line 1)
8290 (setq beg (move-marker (make-marker) (point)))
8291 (goto-char end)
8292 (if (bolp) (backward-char 1) (end-of-line 1))
8293 (setq end (move-marker (make-marker) (point)))
8294 ;; Get the right field separator
8295 (unless separator
8296 (goto-char beg)
8297 (setq separator
8298 (cond
8301 (t 1))))
8302 (setq re (cond
8305 ((integerp separator)
8307 (t (error "This should not happen"))))
8308 (goto-char beg)
8309 (while (re-search-forward re end t)
8310 (replace-match "| " t t))
8311 (goto-char beg)
8312 (insert " ")
8313 (org-table-align)))
8315 (defun org-table-import (file arg)
8316 "Import FILE as a table.
8317 The file is assumed to be tab-separated. Such files can be produced by most
8318 spreadsheet and database applications. If no tabs (at least one per line)
8319 are found, lines will be split on whitespace into fields."
8321 (or (bolp) (newline))
8322 (let ((beg (point))
8323 (pm (point-max)))
8324 (insert-file-contents file)
8325 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8327 (defun org-table-export ()
8328 "Export table as a tab-separated file.
8329 Such a file can be imported into a spreadsheet program like Excel."
8330 (interactive)
8331 (let* ((beg (org-table-begin))
8332 (end (org-table-end))
8333 (table (buffer-substring beg end))
8334 (file (read-file-name "Export table to: "))
8335 buf)
8336 (unless (or (not (file-exists-p file))
8337 (y-or-n-p (format "Overwrite file %s? " file)))
8338 (error "Abort"))
8339 (with-current-buffer (find-file-noselect file)
8340 (setq buf (current-buffer))
8341 (erase-buffer)
8342 (fundamental-mode)
8343 (insert table)
8344 (goto-char (point-min))
8346 (replace-match "" t t)
8347 (end-of-line 1))
8348 (goto-char (point-min))
8350 (replace-match "" t t)
8351 (goto-char (min (1+ (point)) (point-max))))
8352 (goto-char (point-min))
8353 (while (re-search-forward "^-[-+]*$" nil t)
8354 (replace-match "")
8356 (delete-char 1)))
8357 (goto-char (point-min))
8360 (save-buffer))
8361 (kill-buffer buf)))
8363 (defvar org-table-aligned-begin-marker (make-marker)
8364 "Marker at the beginning of the table last aligned.
8365 Used to check if cursor still is in that table, to minimize realignment.")
8366 (defvar org-table-aligned-end-marker (make-marker)
8367 "Marker at the end of the table last aligned.
8368 Used to check if cursor still is in that table, to minimize realignment.")
8369 (defvar org-table-last-alignment nil
8370 "List of flags for flushright alignment, from the last re-alignment.
8371 This is being used to correctly align a single field after TAB or RET.")
8372 (defvar org-table-last-column-widths nil
8373 "List of max width of fields in each column.
8374 This is being used to correctly align a single field after TAB or RET.")
8375 (defvar org-table-overlay-coordinates nil
8376 "Overlay coordinates after each align of a table.")
8377 (make-variable-buffer-local 'org-table-overlay-coordinates)
8379 (defvar org-last-recalc-line nil)
8380 (defconst org-narrow-column-arrow "=>"
8381 "Used as display property in narrowed table columns.")
8383 (defun org-table-align ()
8384 "Align the table at point by aligning all vertical bars."
8385 (interactive)
8386 (let* (
8387 ;; Limits of table
8388 (beg (org-table-begin))
8389 (end (org-table-end))
8390 ;; Current cursor position
8391 (linepos (org-current-line))
8392 (colpos (org-table-current-column))
8393 (winstart (window-start))
8394 (winstartline (org-current-line (min winstart (1- (point-max)))))
8395 lines (new "") lengths l typenums ty fields maxfields i
8396 column
8397 (indent "") cnt frac
8398 rfmt hfmt
8399 (spaces '(1 . 1))
8400 (sp1 (car spaces))
8401 (sp2 (cdr spaces))
8402 (rfmt1 (concat
8403 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8404 (hfmt1 (concat
8405 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8406 emptystrings links dates emph narrow fmax f1 len c e)
8407 (untabify beg end)
8408 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8409 ;; Check if we have links or dates
8410 (goto-char beg)
8411 (setq links (re-search-forward org-bracket-link-regexp end t))
8412 (goto-char beg)
8413 (setq emph (and org-hide-emphasis-markers
8414 (re-search-forward org-emph-re end t)))
8415 (goto-char beg)
8416 (setq dates (and org-display-custom-times
8417 (re-search-forward org-ts-regexp-both end t)))
8418 ;; Make sure the link properties are right
8419 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8420 ;; Make sure the date properties are right
8421 (when dates (goto-char beg) (while (org-activate-dates end)))
8422 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8424 ;; Check if we are narrowing any columns
8425 (goto-char beg)
8426 (setq narrow (and org-format-transports-properties-p
8427 (re-search-forward "<[0-9]+>" end t)))
8428 ;; Get the rows
8429 (setq lines (org-split-string
8431 ;; Store the indentation of the first line
8432 (if (string-match "^ *" (car lines))
8433 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8434 ;; Mark the hlines by setting the corresponding element to nil
8435 ;; At the same time, we remove trailing space.
8436 (setq lines (mapcar (lambda (l)
8437 (if (string-match "^ *|-" l)
8438 nil
8440 (substring l 0 (match-beginning 0))
8441 l)))
8442 lines))
8443 ;; Get the data fields by splitting the lines.
8444 (setq fields (mapcar
8445 (lambda (l)
8446 (org-split-string l " *| *"))
8447 (delq nil (copy-sequence lines))))
8448 ;; How many fields in the longest line?
8449 (condition-case nil
8450 (setq maxfields (apply 'max (mapcar 'length fields)))
8451 (error
8452 (kill-region beg end)
8453 (org-table-create org-table-default-size)
8454 (error "Empty table - created default table")))
8455 ;; A list of empty strings to fill any short rows on output
8456 (setq emptystrings (make-list maxfields ""))
8457 ;; Check for special formatting.
8458 (setq i -1)
8459 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8460 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8461 ;; Check if there is an explicit width specified
8462 (when narrow
8463 (setq c column fmax nil)
8464 (while c
8465 (setq e (pop c))
8467 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8468 ;; Find fields that are wider than fmax, and shorten them
8469 (when fmax
8470 (loop for xx in column do
8471 (when (and (stringp xx)
8472 (> (org-string-width xx) fmax))
8473 (org-add-props xx nil
8474 'help-echo
8475 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8476 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8477 (unless (> f1 1)
8479 (match-string 0 xx)))
8480 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8481 (add-text-properties (- f1 2) f1
8482 (list 'display org-narrow-column-arrow)
8483 xx)))))
8484 ;; Get the maximum width for each column
8485 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8486 ;; Get the fraction of numbers, to decide about alignment of the column
8487 (setq cnt 0 frac 0.0)
8488 (loop for x in column do
8489 (if (equal x "")
8490 nil
8491 (setq frac ( / (+ (* frac cnt)
8492 (if (string-match org-table-number-regexp x) 1 0))
8493 (setq cnt (1+ cnt))))))
8494 (push (>= frac org-table-number-fraction) typenums))
8495 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8497 ;; Store the alignment of this table, for later editing of single fields
8498 (setq org-table-last-alignment typenums
8499 org-table-last-column-widths lengths)
8501 ;; With invisible characters, `format' does not get the field width right
8502 ;; So we need to make these fields wide by hand.
8503 (when (or links emph)
8504 (loop for i from 0 upto (1- maxfields) do
8505 (setq len (nth i lengths))
8506 (loop for j from 0 upto (1- (length fields)) do
8507 (setq c (nthcdr i (car (nthcdr j fields))))
8508 (if (and (stringp (car c))
8509 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8510 ; (string-match org-bracket-link-regexp (car c))
8511 (< (org-string-width (car c)) len))
8512 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8514 ;; Compute the formats needed for output of the table
8515 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8516 (while (setq l (pop lengths))
8517 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8518 (setq rfmt (concat rfmt (format rfmt1 ty l))
8519 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8523 (setq new (mapconcat
8524 (lambda (l)
8525 (if l (apply 'format rfmt
8526 (append (pop fields) emptystrings))
8527 hfmt))
8528 lines ""))
8529 ;; Replace the old one
8530 (delete-region beg end)
8531 (move-marker end nil)
8532 (move-marker org-table-aligned-begin-marker (point))
8533 (insert new)
8534 (move-marker org-table-aligned-end-marker (point))
8535 (when (and orgtbl-mode (not (org-mode-p)))
8536 (goto-char org-table-aligned-begin-marker)
8537 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8538 ;; Try to move to the old location
8539 (goto-line winstartline)
8540 (setq winstart (point-at-bol))
8541 (goto-line linepos)
8542 (set-window-start (selected-window) winstart 'noforce)
8543 (org-table-goto-column colpos)
8544 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8545 (setq org-table-may-need-update nil)
8546 ))
8548 (defun org-string-width (s)
8549 "Compute width of string, ignoring invisible characters.
8550 This ignores character with invisibility property `org-link', and also
8551 characters with property `org-cwidth', because these will become invisible
8552 upon the next fontification round."
8553 (let (b l)
8554 (when (or (eq t buffer-invisibility-spec)
8555 (assq 'org-link buffer-invisibility-spec))
8556 (while (setq b (text-property-any 0 (length s)
8557 'invisible 'org-link s))
8558 (setq s (concat (substring s 0 b)
8559 (substring s (or (next-single-property-change
8560 b 'invisible s) (length s)))))))
8561 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8562 (setq s (concat (substring s 0 b)
8563 (substring s (or (next-single-property-change
8564 b 'org-cwidth s) (length s))))))
8565 (setq l (string-width s) b -1)
8566 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8567 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8568 l))
8570 (defun org-table-begin (&optional table-type)
8571 "Find the beginning of the table and return its position.
8572 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8573 (save-excursion
8574 (if (not (re-search-backward
8575 (if table-type org-table-any-border-regexp
8576 org-table-border-regexp)
8577 nil t))
8578 (progn (goto-char (point-min)) (point))
8579 (goto-char (match-beginning 0))
8580 (beginning-of-line 2)
8581 (point))))
8583 (defun org-table-end (&optional table-type)
8584 "Find the end of the table and return its position.
8585 With argument TABLE-TYPE, go to the end of a table.el-type table."
8586 (save-excursion
8587 (if (not (re-search-forward
8588 (if table-type org-table-any-border-regexp
8589 org-table-border-regexp)
8590 nil t))
8591 (goto-char (point-max))
8592 (goto-char (match-beginning 0)))
8593 (point-marker)))
8595 (defun org-table-justify-field-maybe (&optional new)
8596 "Justify the current field, text to left, number to right.
8597 Optional argument NEW may specify text to replace the current field content."
8598 (cond
8599 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8600 ((org-at-table-hline-p))
8601 ((and (not new)
8602 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8603 (current-buffer)))
8604 (< (point) org-table-aligned-begin-marker)
8605 (>= (point) org-table-aligned-end-marker)))
8606 ;; This is not the same table, force a full re-align
8607 (setq org-table-may-need-update t))
8608 (t ;; realign the current field, based on previous full realign
8609 (let* ((pos (point)) s
8610 (col (org-table-current-column))
8611 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8612 l f n o e)
8613 (when (> col 0)
8616 (progn
8617 (setq s (match-string 1)
8618 o (match-string 0)
8619 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8620 e (not (= (match-beginning 2) (match-end 2))))
8621 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8622 l (if e "|" (setq org-table-may-need-update t) ""))
8623 n (format f s))
8624 (if new
8625 (if (<= (length new) l) ;; FIXME: length -> str-width?
8626 (setq n (format f new))
8627 (setq n (concat new "|") org-table-may-need-update t)))
8628 (or (equal n o)
8629 (let (org-table-may-need-update)
8630 (replace-match n t t))))
8631 (setq org-table-may-need-update t))
8632 (goto-char pos))))))
8634 (defun org-table-next-field ()
8635 "Go to the next field in the current table, creating new lines as needed.
8636 Before doing so, re-align the table if necessary."
8637 (interactive)
8638 (org-table-maybe-eval-formula)
8639 (org-table-maybe-recalculate-line)
8640 (if (and org-table-automatic-realign
8641 org-table-may-need-update)
8642 (org-table-align))
8643 (let ((end (org-table-end)))
8644 (if (org-at-table-hline-p)
8645 (end-of-line 1))
8646 (condition-case nil
8647 (progn
8648 (re-search-forward "|" end)
8650 (re-search-forward "|" end))
8651 (if (and (looking-at "-")
8652 org-table-tab-jumps-over-hlines
8654 (goto-char (match-beginning 1)))
8655 (if (looking-at "-")
8656 (progn
8657 (beginning-of-line 0)
8658 (org-table-insert-row 'below))
8659 (if (looking-at " ") (forward-char 1))))
8660 (error
8661 (org-table-insert-row 'below)))))
8663 (defun org-table-previous-field ()
8664 "Go to the previous field in the table.
8665 Before doing so, re-align the table if necessary."
8666 (interactive)
8667 (org-table-justify-field-maybe)
8668 (org-table-maybe-recalculate-line)
8669 (if (and org-table-automatic-realign
8670 org-table-may-need-update)
8671 (org-table-align))
8672 (if (org-at-table-hline-p)
8673 (end-of-line 1))
8674 (re-search-backward "|" (org-table-begin))
8675 (re-search-backward "|" (org-table-begin))
8677 (re-search-backward "|" (org-table-begin)))
8678 (if (looking-at "| ?")
8679 (goto-char (match-end 0))))
8681 (defun org-table-next-row ()
8682 "Go to the next row (same column) in the current table.
8683 Before doing so, re-align the table if necessary."
8684 (interactive)
8685 (org-table-maybe-eval-formula)
8686 (org-table-maybe-recalculate-line)
8689 (newline)
8690 (if (and org-table-automatic-realign
8691 org-table-may-need-update)
8692 (org-table-align))
8693 (let ((col (org-table-current-column)))
8694 (beginning-of-line 2)
8695 (if (or (not (org-at-table-p))
8696 (org-at-table-hline-p))
8697 (progn
8698 (beginning-of-line 0)
8699 (org-table-insert-row 'below)))
8700 (org-table-goto-column col)
8702 (if (looking-at " ") (forward-char 1)))))
8704 (defun org-table-copy-down (n)
8705 "Copy a field down in the current column.
8706 If the field at the cursor is empty, copy into it the content of the nearest
8707 non-empty field above. With argument N, use the Nth non-empty field.
8708 If the current field is not empty, it is copied down to the next row, and
8709 the cursor is moved with it. Therefore, repeating this command causes the
8710 column to be filled row-by-row.
8711 If the variable `org-table-copy-increment' is non-nil and the field is an
8712 integer or a timestamp, it will be incremented while copying. In the case of
8713 a timestamp, if the cursor is on the year, change the year. If it is on the
8714 month or the day, change that. Point will stay on the current date field
8715 in order to easily repeat the interval."
8716 (interactive "p")
8717 (let* ((colpos (org-table-current-column))
8718 (col (current-column))
8719 (field (org-table-get-field))
8721 (beg (org-table-begin))
8722 txt)
8723 (org-table-check-inside-data-field)
8724 (if non-empty
8725 (progn
8726 (setq txt (org-trim field))
8727 (org-table-next-row)
8728 (org-table-blank-field))
8729 (save-excursion
8730 (setq txt
8731 (catch 'exit
8732 (while (progn (beginning-of-line 1)
8733 (re-search-backward org-table-dataline-regexp
8734 beg t))
8735 (org-table-goto-column colpos t)
8736 (if (and (looking-at
8738 (= (setq n (1- n)) 0))
8739 (throw 'exit (match-string 1))))))))
8740 (if txt
8741 (progn
8742 (if (and org-table-copy-increment
8743 (string-match "^[0-9]+$" txt))
8744 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8745 (insert txt)
8746 (move-to-column col)
8747 (if (and org-table-copy-increment (org-at-timestamp-p t))
8748 (org-timestamp-up 1)
8749 (org-table-maybe-recalculate-line))
8750 (org-table-align)
8751 (move-to-column col))
8752 (error "No non-empty field found"))))
8754 (defun org-table-check-inside-data-field ()
8755 "Is point inside a table data field?
8756 I.e. not on a hline or before the first or after the last column?
8757 This actually throws an error, so it aborts the current command."
8758 (if (or (not (org-at-table-p))
8759 (= (org-table-current-column) 0)
8760 (org-at-table-hline-p)
8762 (error "Not in table data field")))
8764 (defvar org-table-clip nil
8765 "Clipboard for table regions.")
8767 (defun org-table-blank-field ()
8768 "Blank the current table field or active region."
8769 (interactive)
8770 (org-table-check-inside-data-field)
8771 (if (and (interactive-p) (org-region-active-p))
8772 (let (org-table-clip)
8773 (org-table-cut-region (region-beginning) (region-end)))
8774 (skip-chars-backward "^|")
8775 (backward-char 1)
8777 (let* ((pos (match-beginning 0))
8778 (match (match-string 0))
8779 (len (org-string-width match)))
8780 (replace-match (concat "|" (make-string (1- len) ?\ )))
8781 (goto-char (+ 2 pos))
8782 (substring match 1)))))
8784 (defun org-table-get-field (&optional n replace)
8785 "Return the value of the field in column N of current row.
8786 N defaults to current field.
8787 If REPLACE is a string, replace field with this value. The return value
8788 is always the old value."
8789 (and n (org-table-goto-column n))
8791 (backward-char 1)
8793 (let* ((pos (match-beginning 0))
8794 (val (buffer-substring (1+ pos) (match-end 0))))
8795 (if replace
8796 (replace-match (concat "|" replace) t t))
8797 (goto-char (min (point-at-eol) (+ 2 pos)))
8798 val)
8799 (forward-char 1) ""))
8801 (defun org-table-field-info (arg)
8802 "Show info about the current field, and highlight any reference at point."
8803 (interactive "P")
8804 (org-table-get-specials)
8805 (save-excursion
8806 (let* ((pos (point))
8807 (col (org-table-current-column))
8808 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8809 (name (car (rassoc (list (org-current-line) col)
8810 org-table-named-field-locations)))
8811 (eql (org-table-get-stored-formulas))
8812 (dline (org-table-current-dline))
8813 (ref (format "@%d$%d" dline col))
8814 (ref1 (org-table-convert-refs-to-an ref))
8815 (fequation (or (assoc name eql) (assoc ref eql)))
8816 (cequation (assoc (int-to-string col) eql))
8817 (eqn (or fequation cequation)))
8818 (goto-char pos)
8819 (condition-case nil
8820 (org-table-show-reference 'local)
8821 (error nil))
8822 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8823 dline col
8824 (if cname (concat " or $" cname) "")
8825 dline col ref1
8826 (if name (concat " or $" name) "")
8827 ;; FIXME: formula info not correct if special table line
8828 (if eqn
8829 (concat ", formula: "
8830 (org-table-formula-to-user
8831 (concat
8832 (if (string-match "^[$@]"(car eqn)) "" "$")
8833 (car eqn) "=" (cdr eqn))))
8834 "")))))
8836 (defun org-table-current-column ()
8837 "Find out which column we are in.
8838 When called interactively, column is also displayed in echo area."
8839 (interactive)
8840 (if (interactive-p) (org-table-check-inside-data-field))
8841 (save-excursion
8842 (let ((cnt 0) (pos (point)))
8843 (beginning-of-line 1)
8844 (while (search-forward "|" pos t)
8845 (setq cnt (1+ cnt)))
8846 (if (interactive-p) (message "This is table column %d" cnt))
8847 cnt)))
8849 (defun org-table-current-dline ()
8850 "Find out what table data line we are in.
8851 Only datalins count for this."
8852 (interactive)
8853 (if (interactive-p) (org-table-check-inside-data-field))
8854 (save-excursion
8855 (let ((cnt 0) (pos (point)))
8856 (goto-char (org-table-begin))
8857 (while (<= (point) pos)
8858 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8859 (beginning-of-line 2))
8860 (if (interactive-p) (message "This is table line %d" cnt))
8861 cnt)))
8863 (defun org-table-goto-column (n &optional on-delim force)
8864 "Move the cursor to the Nth column in the current table line.
8865 With optional argument ON-DELIM, stop with point before the left delimiter
8866 of the field.
8867 If there are less than N fields, just go to after the last delimiter.
8868 However, when FORCE is non-nil, create new columns if necessary."
8869 (interactive "p")
8870 (let ((pos (point-at-eol)))
8871 (beginning-of-line 1)
8872 (when (> n 0)
8873 (while (and (> (setq n (1- n)) -1)
8874 (or (search-forward "|" pos t)
8875 (and force
8876 (progn (end-of-line 1)
8877 (skip-chars-backward "^|")
8878 (insert " | "))))))
8879 ; (backward-char 2) t)))))
8880 (when (and force (not (looking-at ".*|")))
8881 (save-excursion (end-of-line 1) (insert " | ")))
8882 (if on-delim
8883 (backward-char 1)
8884 (if (looking-at " ") (forward-char 1))))))
8886 (defun org-at-table-p (&optional table-type)
8887 "Return t if the cursor is inside an org-type table.
8888 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8889 (if org-enable-table-editor
8890 (save-excursion
8891 (beginning-of-line 1)
8892 (looking-at (if table-type org-table-any-line-regexp
8893 org-table-line-regexp)))
8894 nil))
8896 (defun org-at-table.el-p ()
8897 "Return t if and only if we are at a table.el table."
8898 (and (org-at-table-p 'any)
8899 (save-excursion
8900 (goto-char (org-table-begin 'any))
8901 (looking-at org-table1-hline-regexp))))
8903 (defun org-table-recognize-table.el ()
8904 "If there is a table.el table nearby, recognize it and move into it."
8905 (if org-table-tab-recognizes-table.el
8906 (if (org-at-table.el-p)
8907 (progn
8908 (beginning-of-line 1)
8909 (if (looking-at org-table-dataline-regexp)
8910 nil
8911 (if (looking-at org-table1-hline-regexp)
8912 (progn
8913 (beginning-of-line 2)
8914 (if (looking-at org-table-any-border-regexp)
8915 (beginning-of-line -1)))))
8916 (if (re-search-forward "|" (org-table-end t) t)
8917 (progn
8918 (require 'table)
8919 (if (table--at-cell-p (point))
8920 t
8921 (message "recognizing table.el table...")
8922 (table-recognize-table)
8923 (message "recognizing table.el table...done")))
8924 (error "This should not happen..."))
8925 t)
8926 nil)
8927 nil))
8929 (defun org-at-table-hline-p ()
8930 "Return t if the cursor is inside a hline in a table."
8931 (if org-enable-table-editor
8932 (save-excursion
8933 (beginning-of-line 1)
8934 (looking-at org-table-hline-regexp))
8935 nil))
8937 (defun org-table-insert-column ()
8938 "Insert a new column into the table."
8939 (interactive)
8940 (if (not (org-at-table-p))
8941 (error "Not at a table"))
8942 (org-table-find-dataline)
8943 (let* ((col (max 1 (org-table-current-column)))
8944 (beg (org-table-begin))
8945 (end (org-table-end))
8946 ;; Current cursor position
8947 (linepos (org-current-line))
8948 (colpos col))
8949 (goto-char beg)
8950 (while (< (point) end)
8951 (if (org-at-table-hline-p)
8952 nil
8953 (org-table-goto-column col t)
8954 (insert "| "))
8955 (beginning-of-line 2))
8956 (move-marker end nil)
8957 (goto-line linepos)
8958 (org-table-goto-column colpos)
8959 (org-table-align)
8960 (org-table-fix-formulas "$" nil (1- col) 1)))
8962 (defun org-table-find-dataline ()
8963 "Find a dataline in the current table, which is needed for column commands."
8964 (if (and (org-at-table-p)
8965 (not (org-at-table-hline-p)))
8966 t
8967 (let ((col (current-column))
8968 (end (org-table-end)))
8969 (move-to-column col)
8970 (while (and (< (point) end)
8971 (or (not (= (current-column) col))
8972 (org-at-table-hline-p)))
8973 (beginning-of-line 2)
8974 (move-to-column col))
8975 (if (and (org-at-table-p)
8976 (not (org-at-table-hline-p)))
8977 t
8978 (error
8979 "Please position cursor in a data line for column operations")))))
8981 (defun org-table-delete-column ()
8982 "Delete a column from the table."
8983 (interactive)
8984 (if (not (org-at-table-p))
8985 (error "Not at a table"))
8986 (org-table-find-dataline)
8987 (org-table-check-inside-data-field)
8988 (let* ((col (org-table-current-column))
8989 (beg (org-table-begin))
8990 (end (org-table-end))
8991 ;; Current cursor position
8992 (linepos (org-current-line))
8993 (colpos col))
8994 (goto-char beg)
8995 (while (< (point) end)
8996 (if (org-at-table-hline-p)
8997 nil
8998 (org-table-goto-column col t)
9000 (replace-match "|")))
9001 (beginning-of-line 2))
9002 (move-marker end nil)
9003 (goto-line linepos)
9004 (org-table-goto-column colpos)
9005 (org-table-align)
9006 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9007 col -1 col)))
9009 (defun org-table-move-column-right ()
9010 "Move column to the right."
9011 (interactive)
9012 (org-table-move-column nil))
9013 (defun org-table-move-column-left ()
9014 "Move column to the left."
9015 (interactive)
9016 (org-table-move-column 'left))
9018 (defun org-table-move-column (&optional left)
9019 "Move the current column to the right. With arg LEFT, move to the left."
9020 (interactive "P")
9021 (if (not (org-at-table-p))
9022 (error "Not at a table"))
9023 (org-table-find-dataline)
9024 (org-table-check-inside-data-field)
9025 (let* ((col (org-table-current-column))
9026 (col1 (if left (1- col) col))
9027 (beg (org-table-begin))
9028 (end (org-table-end))
9029 ;; Current cursor position
9030 (linepos (org-current-line))
9031 (colpos (if left (1- col) (1+ col))))
9032 (if (and left (= col 1))
9033 (error "Cannot move column further left"))
9035 (error "Cannot move column further right"))
9036 (goto-char beg)
9037 (while (< (point) end)
9038 (if (org-at-table-hline-p)
9039 nil
9040 (org-table-goto-column col1 t)
9043 (beginning-of-line 2))
9044 (move-marker end nil)
9045 (goto-line linepos)
9046 (org-table-goto-column colpos)
9047 (org-table-align)
9048 (org-table-fix-formulas
9049 "$" (list (cons (number-to-string col) (number-to-string colpos))
9050 (cons (number-to-string colpos) (number-to-string col))))))
9052 (defun org-table-move-row-down ()
9053 "Move table row down."
9054 (interactive)
9055 (org-table-move-row nil))
9056 (defun org-table-move-row-up ()
9057 "Move table row up."
9058 (interactive)
9059 (org-table-move-row 'up))
9061 (defun org-table-move-row (&optional up)
9062 "Move the current table line down. With arg UP, move it up."
9063 (interactive "P")
9064 (let* ((col (current-column))
9065 (pos (point))
9066 (hline1p (save-excursion (beginning-of-line 1)
9067 (looking-at org-table-hline-regexp)))
9068 (dline1 (org-table-current-dline))
9069 (dline2 (+ dline1 (if up -1 1)))
9070 (tonew (if up 0 2))
9071 txt hline2p)
9072 (beginning-of-line tonew)
9073 (unless (org-at-table-p)
9074 (goto-char pos)
9075 (error "Cannot move row further"))
9076 (setq hline2p (looking-at org-table-hline-regexp))
9077 (goto-char pos)
9078 (beginning-of-line 1)
9079 (setq pos (point))
9080 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9081 (delete-region (point) (1+ (point-at-eol)))
9082 (beginning-of-line tonew)
9083 (insert txt)
9084 (beginning-of-line 0)
9085 (move-to-column col)
9086 (unless (or hline1p hline2p)
9087 (org-table-fix-formulas
9088 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9089 (cons (number-to-string dline2) (number-to-string dline1)))))))
9091 (defun org-table-insert-row (&optional arg)
9092 "Insert a new row above the current line into the table.
9093 With prefix ARG, insert below the current line."
9094 (interactive "P")
9095 (if (not (org-at-table-p))
9096 (error "Not at a table"))
9097 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9098 (new (org-table-clean-line line)))
9099 ;; Fix the first field if necessary
9101 (setq new (replace-match (match-string 0 line) t t new)))
9102 (beginning-of-line (if arg 2 1))
9104 (beginning-of-line 0)
9105 (re-search-forward "| ?" (point-at-eol) t)
9106 (and (or org-table-may-need-update org-table-overlay-coordinates)
9107 (org-table-align))
9108 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9110 (defun org-table-insert-hline (&optional above)
9111 "Insert a horizontal-line below the current line into the table.
9112 With prefix ABOVE, insert above the current line."
9113 (interactive "P")
9114 (if (not (org-at-table-p))
9115 (error "Not at a table"))
9116 (let ((line (org-table-clean-line
9117 (buffer-substring (point-at-bol) (point-at-eol))))
9118 (col (current-column)))
9120 (setq line (replace-match
9121 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9122 ?-) "|") t t line)))
9124 (beginning-of-line (if above 1 2))
9126 (beginning-of-line (if above 1 -1))
9127 (move-to-column col)
9128 (and org-table-overlay-coordinates (org-table-align))))
9130 (defun org-table-hline-and-move (&optional same-column)
9131 "Insert a hline and move to the row below that line."
9132 (interactive "P")
9133 (let ((col (org-table-current-column)))
9134 (org-table-maybe-eval-formula)
9135 (org-table-maybe-recalculate-line)
9136 (org-table-insert-hline)
9137 (end-of-line 2)
9140 (org-table-next-field))
9141 (if same-column (org-table-goto-column col))))
9143 (defun org-table-clean-line (s)
9145 In particular, this does handle wide and invisible characters."
9147 ;; It's a hline, just map the characters
9148 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9150 (setq s (replace-match
9151 (concat "|" (make-string (org-string-width (match-string 1 s))
9152 ?\ ) "|")
9153 t t s)))
9154 s))
9156 (defun org-table-kill-row ()
9157 "Delete the current row or horizontal line from the table."
9158 (interactive)
9159 (if (not (org-at-table-p))
9160 (error "Not at a table"))
9161 (let ((col (current-column))
9162 (dline (org-table-current-dline)))
9163 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9164 (if (not (org-at-table-p)) (beginning-of-line 0))
9165 (move-to-column col)
9166 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9167 dline -1 dline)))
9169 (defun org-table-sort-lines (with-case &optional sorting-type)
9170 "Sort table lines according to the column at point.
9172 The position of point indicates the column to be used for
9173 sorting, and the range of lines is the range between the nearest
9174 horizontal separator lines, or the entire table of no such lines
9175 exist. If point is before the first column, you will be prompted
9176 for the sorting column. If there is an active region, the mark
9177 specifies the first line and the sorting column, while point
9178 should be in the last line to be included into the sorting.
9180 The command then prompts for the sorting type which can be
9181 alphabetically, numerically, or by time (as given in a time stamp
9182 in the field). Sorting in reverse order is also possible.
9184 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9186 If SORTING-TYPE is specified when this function is called from a Lisp
9187 program, no prompting will take place. SORTING-TYPE must be a character,
9188 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9189 should be done in reverse order."
9190 (interactive "P")
9191 (let* ((thisline (org-current-line))
9192 (thiscol (org-table-current-column))
9193 beg end bcol ecol tend tbeg column lns pos)
9194 (when (equal thiscol 0)
9195 (if (interactive-p)
9196 (setq thiscol
9197 (string-to-number
9198 (read-string "Use column N for sorting: ")))
9199 (setq thiscol 1))
9200 (org-table-goto-column thiscol))
9201 (org-table-check-inside-data-field)
9202 (if (org-region-active-p)
9203 (progn
9204 (setq beg (region-beginning) end (region-end))
9205 (goto-char beg)
9206 (setq column (org-table-current-column)
9207 beg (point-at-bol))
9208 (goto-char end)
9209 (setq end (point-at-bol 2)))
9210 (setq column (org-table-current-column)
9211 pos (point)
9212 tbeg (org-table-begin)
9213 tend (org-table-end))
9214 (if (re-search-backward org-table-hline-regexp tbeg t)
9215 (setq beg (point-at-bol 2))
9216 (goto-char tbeg)
9217 (setq beg (point-at-bol 1)))
9218 (goto-char pos)
9219 (if (re-search-forward org-table-hline-regexp tend t)
9220 (setq end (point-at-bol 1))
9221 (goto-char tend)
9222 (setq end (point-at-bol))))
9223 (setq beg (move-marker (make-marker) beg)
9224 end (move-marker (make-marker) end))
9225 (untabify beg end)
9226 (goto-char beg)
9227 (org-table-goto-column column)
9228 (skip-chars-backward "^|")
9229 (setq bcol (current-column))
9230 (org-table-goto-column (1+ column))
9231 (skip-chars-backward "^|")
9232 (setq ecol (1- (current-column)))
9233 (org-table-goto-column column)
9234 (setq lns (mapcar (lambda(x) (cons
9235 (org-sort-remove-invisible
9236 (nth (1- column)
9238 x))
9240 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9241 (delete-region beg end)
9242 (move-marker beg nil)
9243 (move-marker end nil)
9245 (goto-line thisline)
9246 (org-table-goto-column thiscol)
9247 (message "%d lines sorted, based on column %d" (length lns) column)))
9249 ;; FIXME: maybe we will not need this? Table sorting is broken....
9250 (defun org-sort-remove-invisible (s)
9251 (remove-text-properties 0 (length s) org-rm-props s)
9252 (while (string-match org-bracket-link-regexp s)
9253 (setq s (replace-match (if (match-end 2)
9254 (match-string 3 s)
9255 (match-string 1 s)) t t s)))
9256 s)
9258 (defun org-table-cut-region (beg end)
9259 "Copy region in table to the clipboard and blank all relevant fields."
9260 (interactive "r")
9261 (org-table-copy-region beg end 'cut))
9263 (defun org-table-copy-region (beg end &optional cut)
9264 "Copy rectangular region in table to clipboard.
9265 A special clipboard is used which can only be accessed
9266 with `org-table-paste-rectangle'."
9267 (interactive "rP")
9268 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9269 region cols
9270 (rpl (if cut " " nil)))
9271 (goto-char beg)
9272 (org-table-check-inside-data-field)
9273 (setq l01 (org-current-line)
9274 c01 (org-table-current-column))
9275 (goto-char end)
9276 (org-table-check-inside-data-field)
9277 (setq l02 (org-current-line)
9278 c02 (org-table-current-column))
9279 (setq l1 (min l01 l02) l2 (max l01 l02)
9280 c1 (min c01 c02) c2 (max c01 c02))
9281 (catch 'exit
9282 (while t
9283 (catch 'nextline
9284 (if (> l1 l2) (throw 'exit t))
9285 (goto-line l1)
9286 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9287 (setq cols nil ic1 c1 ic2 c2)
9288 (while (< ic1 (1+ ic2))
9289 (push (org-table-get-field ic1 rpl) cols)
9290 (setq ic1 (1+ ic1)))
9291 (push (nreverse cols) region)
9292 (setq l1 (1+ l1)))))
9293 (setq org-table-clip (nreverse region))
9294 (if cut (org-table-align))
9295 org-table-clip))
9297 (defun org-table-paste-rectangle ()
9298 "Paste a rectangular region into a table.
9299 The upper right corner ends up in the current field. All involved fields
9300 will be overwritten. If the rectangle does not fit into the present table,
9301 the table is enlarged as needed. The process ignores horizontal separator
9302 lines."
9303 (interactive)
9304 (unless (and org-table-clip (listp org-table-clip))
9305 (error "First cut/copy a region to paste!"))
9306 (org-table-check-inside-data-field)
9307 (let* ((clip org-table-clip)
9308 (line (org-current-line))
9309 (col (org-table-current-column))
9310 (org-enable-table-editor t)
9311 (org-table-automatic-realign nil)
9312 c cols field)
9313 (while (setq cols (pop clip))
9314 (while (org-at-table-hline-p) (beginning-of-line 2))
9315 (if (not (org-at-table-p))
9316 (progn (end-of-line 0) (org-table-next-field)))
9317 (setq c col)
9318 (while (setq field (pop cols))
9319 (org-table-goto-column c nil 'force)
9320 (org-table-get-field nil field)
9321 (setq c (1+ c)))
9322 (beginning-of-line 2))
9323 (goto-line line)
9324 (org-table-goto-column col)
9325 (org-table-align)))
9327 (defun org-table-convert ()
9328 "Convert from `org-mode' table to table.el and back.
9329 Obviously, this only works within limits. When an Org-mode table is
9330 converted to table.el, all horizontal separator lines get lost, because
9331 table.el uses these as cell boundaries and has no notion of horizontal lines.
9332 A table.el table can be converted to an Org-mode table only if it does not
9333 do row or column spanning. Multiline cells will become multiple cells.
9334 Beware, Org-mode does not test if the table can be successfully converted - it
9335 blindly applies a recipe that works for simple tables."
9336 (interactive)
9337 (require 'table)
9338 (if (org-at-table.el-p)
9339 ;; convert to Org-mode table
9340 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9341 (end (move-marker (make-marker) (org-table-end t))))
9342 (table-unrecognize-region beg end)
9343 (goto-char beg)
9345 (replace-match ""))
9346 (goto-char beg))
9347 (if (org-at-table-p)
9348 ;; convert to table.el table
9349 (let ((beg (move-marker (make-marker) (org-table-begin)))
9350 (end (move-marker (make-marker) (org-table-end))))
9351 ;; first, get rid of all horizontal lines
9352 (goto-char beg)
9354 (replace-match ""))
9355 ;; insert a hline before first
9356 (goto-char beg)
9357 (org-table-insert-hline 'above)
9358 (beginning-of-line -1)
9359 ;; insert a hline after each line
9360 (while (progn (beginning-of-line 3) (< (point) end))
9361 (org-table-insert-hline))
9362 (goto-char beg)
9363 (setq end (move-marker end (org-table-end)))
9364 ;; replace "+" at beginning and ending of hlines
9367 (goto-char beg)
9369 (replace-match "-+"))
9370 (goto-char beg)))))
9372 (defun org-table-wrap-region (arg)
9373 "Wrap several fields in a column like a paragraph.
9374 This is useful if you'd like to spread the contents of a field over several
9375 lines, in order to keep the table compact.
9377 If there is an active region, and both point and mark are in the same column,
9378 the text in the column is wrapped to minimum width for the given number of
9379 lines. Generally, this makes the table more compact. A prefix ARG may be
9381 formats the selected text to two lines. If the region was longer than two
9382 lines, the remaining lines remain empty. A negative prefix argument reduces
9383 the current number of lines by that amount. The wrapped text is pasted back
9384 into the table. If you formatted it to more lines than it was before, fields
9385 further down in the table get overwritten - so you might need to make space in
9386 the table first.
9388 If there is no region, the current field is split at the cursor position and
9389 the text fragment to the right of the cursor is prepended to the field one
9390 line down.
9392 If there is no region, but you specify a prefix ARG, the current field gets
9393 blank, and the content is appended to the field above."
9394 (interactive "P")
9395 (org-table-check-inside-data-field)
9396 (if (org-region-active-p)
9397 ;; There is a region: fill as a paragraph
9398 (let* ((beg (region-beginning))
9399 (cline (save-excursion (goto-char beg) (org-current-line)))
9400 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9401 nlines)
9402 (org-table-cut-region (region-beginning) (region-end))
9403 (if (> (length (car org-table-clip)) 1)
9404 (error "Region must be limited to single column"))
9405 (setq nlines (if arg
9406 (if (< arg 1)
9407 (+ (length org-table-clip) arg)
9408 arg)
9409 (length org-table-clip)))
9410 (setq org-table-clip
9411 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9412 nil nlines)))
9413 (goto-line cline)
9414 (org-table-goto-column ccol)
9415 (org-table-paste-rectangle))
9416 ;; No region, split the current field at point
9417 (if arg
9418 ;; combine with field above
9419 (let ((s (org-table-blank-field))
9420 (col (org-table-current-column)))
9421 (beginning-of-line 0)
9422 (while (org-at-table-hline-p) (beginning-of-line 0))
9423 (org-table-goto-column col)
9424 (skip-chars-forward "^|")
9425 (skip-chars-backward " ")
9426 (insert " " (org-trim s))
9427 (org-table-align))
9428 ;; split field
9430 (let ((s (match-string 1)))
9431 (replace-match " |")
9432 (goto-char (match-beginning 0))
9433 (org-table-next-row)
9434 (insert (org-trim s) " ")
9435 (org-table-align))))))
9437 (defvar org-field-marker nil)
9439 (defun org-table-edit-field (arg)
9440 "Edit table field in a different window.
9441 This is mainly useful for fields that contain hidden parts.
9443 it can be edited in place."
9444 (interactive "P")
9445 (if arg
9446 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9448 (remove-text-properties b e '(org-cwidth t invisible t
9449 display t intangible t))
9450 (if (and (boundp 'font-lock-mode) font-lock-mode)
9451 (font-lock-fontify-block)))
9452 (let ((pos (move-marker (make-marker) (point)))
9453 (field (org-table-get-field))
9454 (cw (current-window-configuration))
9455 p)
9456 (org-switch-to-buffer-other-window "*Org tmp*")
9457 (erase-buffer)
9459 (let ((org-inhibit-startup t)) (org-mode))
9460 (goto-char (setq p (point-max)))
9461 (insert (org-trim field))
9462 (remove-text-properties p (point-max)
9463 '(invisible t org-cwidth t display t
9464 intangible t))
9465 (goto-char p)
9466 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9467 (org-set-local 'org-window-configuration cw)
9468 (org-set-local 'org-field-marker pos)
9469 (message "Edit and finish with C-c C-c"))))
9471 (defun org-table-finish-edit-field ()
9472 "Finish editing a table data field.
9473 Remove all newline characters, insert the result into the table, realign
9474 the table and kill the editing buffer."
9475 (let ((pos org-field-marker)
9476 (cw org-window-configuration)
9477 (cb (current-buffer))
9478 text)
9479 (goto-char (point-min))
9482 (replace-match " "))
9483 (setq text (org-trim (buffer-string)))
9484 (set-window-configuration cw)
9485 (kill-buffer cb)
9486 (select-window (get-buffer-window (marker-buffer pos)))
9487 (goto-char pos)
9488 (move-marker pos nil)
9489 (org-table-check-inside-data-field)
9490 (org-table-get-field nil text)
9491 (org-table-align)
9492 (message "New field value inserted")))
9494 (defun org-trim (s)
9495 "Remove whitespace at beginning and end of string."
9498 s)
9500 (defun org-wrap (string &optional width lines)
9501 "Wrap string to either a number of lines, or a width in characters.
9502 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9503 that costs. If there is a word longer than WIDTH, the text is actually
9504 wrapped to the length of that word.
9505 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9506 many lines, whatever width that takes.
9507 The return value is a list of lines, without newlines at the end."
9509 (maxword (apply 'max (mapcar 'org-string-width words)))
9510 w ll)
9511 (cond (width
9512 (org-do-wrap words (max maxword width)))
9513 (lines
9514 (setq w maxword)
9515 (setq ll (org-do-wrap words maxword))
9516 (if (<= (length ll) lines)
9517 ll
9518 (setq ll words)
9519 (while (> (length ll) lines)
9520 (setq w (1+ w))
9521 (setq ll (org-do-wrap words w)))
9522 ll))
9523 (t (error "Cannot wrap this")))))
9526 (defun org-do-wrap (words width)
9527 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9528 (let (lines line)
9529 (while words
9530 (setq line (pop words))
9531 (while (and words (< (+ (length line) (length (car words))) width))
9532 (setq line (concat line " " (pop words))))
9533 (setq lines (push line lines)))
9534 (nreverse lines)))
9536 (defun org-split-string (string &optional separators)
9537 "Splits STRING into substrings at SEPARATORS.
9538 No empty strings are returned if there are matches at the beginning
9539 and end of string."
9541 (start 0)
9542 notfirst
9543 (list nil))
9544 (while (and (string-match rexp string
9545 (if (and notfirst
9546 (= start (match-beginning 0))
9547 (< start (length string)))
9548 (1+ start) start))
9549 (< (match-beginning 0) (length string)))
9550 (setq notfirst t)
9551 (or (eq (match-beginning 0) 0)
9552 (and (eq (match-beginning 0) (match-end 0))
9553 (eq (match-beginning 0) start))
9554 (setq list
9555 (cons (substring string start (match-beginning 0))
9556 list)))
9557 (setq start (match-end 0)))
9558 (or (eq start (length string))
9559 (setq list
9560 (cons (substring string start)
9561 list)))
9562 (nreverse list)))
9564 (defun org-table-map-tables (function)
9565 "Apply FUNCTION to the start of all tables in the buffer."
9566 (save-excursion
9567 (save-restriction
9568 (widen)
9569 (goto-char (point-min))
9570 (while (re-search-forward org-table-any-line-regexp nil t)
9571 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9572 (beginning-of-line 1)
9573 (if (looking-at org-table-line-regexp)
9574 (save-excursion (funcall function)))
9575 (re-search-forward org-table-any-border-regexp nil 1))))
9576 (message "Mapping tables: done"))
9578 (defvar org-timecnt) ; dynamically scoped parameter
9580 (defun org-table-sum (&optional beg end nlast)
9581 "Sum numbers in region of current table column.
9582 The result will be displayed in the echo area, and will be available
9585 If there is an active region, it is interpreted as a rectangle and all
9586 numbers in that rectangle will be summed. If there is no active
9587 region and point is located in a table column, sum all numbers in that
9588 column.
9590 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9591 numbers are assumed to be times as well (in decimal hours) and the
9592 numbers are added as such.
9594 If NLAST is a number, only the NLAST fields will actually be summed."
9595 (interactive)
9596 (save-excursion
9597 (let (col (org-timecnt 0) diff h m s org-table-clip)
9598 (cond
9599 ((and beg end)) ; beg and end given explicitly
9600 ((org-region-active-p)
9601 (setq beg (region-beginning) end (region-end)))
9602 (t
9603 (setq col (org-table-current-column))
9604 (goto-char (org-table-begin))
9606 (error "No table data"))
9607 (org-table-goto-column col)
9608 (setq beg (point))
9609 (goto-char (org-table-end))
9611 (error "No table data"))
9612 (org-table-goto-column col)
9613 (setq end (point))))
9614 (let* ((items (apply 'append (org-table-copy-region beg end)))
9615 (items1 (cond ((not nlast) items)
9616 ((>= nlast (length items)) items)
9617 (t (setq items (reverse items))
9618 (setcdr (nthcdr (1- nlast) items) nil)
9619 (nreverse items))))
9620 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9621 items1)))
9622 (res (apply '+ numbers))
9623 (sres (if (= org-timecnt 0)
9624 (format "%g" res)
9625 (setq diff (* 3600 res)
9626 h (floor (/ diff 3600)) diff (mod diff 3600)
9627 m (floor (/ diff 60)) diff (mod diff 60)
9628 s diff)
9629 (format "%d:%02d:%02d" h m s))))
9630 (kill-new sres)
9631 (if (interactive-p)
9632 (message "%s"
9633 (substitute-command-keys
9635 (length numbers) sres))))
9636 sres))))
9638 (defun org-table-get-number-for-summing (s)
9639 (let (n)
9640 (if (string-match "^ *|? *" s)
9641 (setq s (replace-match "" nil nil s)))
9642 (if (string-match " *|? *$" s)
9643 (setq s (replace-match "" nil nil s)))
9644 (setq n (string-to-number s))
9645 (cond
9646 ((and (string-match "0" s)
9650 (let ((h (string-to-number (or (match-string 1 s) "0")))
9651 (m (string-to-number (or (match-string 2 s) "0")))
9652 (s (string-to-number (or (match-string 4 s) "0"))))
9653 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9654 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9655 ((equal n 0) nil)
9656 (t n))))
9658 (defun org-table-current-field-formula (&optional key noerror)
9659 "Return the formula active for the current field.
9660 Assumes that specials are in place.
9661 If KEY is given, return the key to this formula.
9663 (let* ((name (car (rassoc (list (org-current-line)
9664 (org-table-current-column))
9665 org-table-named-field-locations)))
9666 (col (org-table-current-column))
9667 (scol (int-to-string col))
9668 (ref (format "@%d$%d" (org-table-current-dline) col))
9669 (stored-list (org-table-get-stored-formulas noerror))
9670 (ass (or (assoc name stored-list)
9671 (assoc ref stored-list)
9672 (assoc scol stored-list))))
9673 (if key
9674 (car ass)
9675 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9676 (cdr ass))))))
9678 (defun org-table-get-formula (&optional equation named)
9679 "Read a formula from the minibuffer, offer stored formula as default.
9680 When NAMED is non-nil, look for a named equation."
9681 (let* ((stored-list (org-table-get-stored-formulas))
9682 (name (car (rassoc (list (org-current-line)
9683 (org-table-current-column))
9684 org-table-named-field-locations)))
9685 (ref (format "@%d$%d" (org-table-current-dline)
9686 (org-table-current-column)))
9687 (refass (assoc ref stored-list))
9688 (scol (if named
9689 (if name name ref)
9690 (int-to-string (org-table-current-column))))
9691 (dummy (and (or name refass) (not named)
9692 (not (y-or-n-p "Replace field formula with column formula? " ))
9693 (error "Abort")))
9694 (name (or name ref))
9695 (org-table-may-need-update nil)
9696 (stored (cdr (assoc scol stored-list)))
9697 (eq (cond
9698 ((and stored equation (string-match "^ *=? *$" equation))
9699 stored)
9700 ((stringp equation)
9701 equation)
9702 (t (org-table-formula-from-user
9703 (read-string
9704 (org-table-formula-to-user
9705 (format "%s formula %s%s="
9706 (if named "Field" "Column")
9707 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9708 scol))
9709 (if stored (org-table-formula-to-user stored) "")
9710 'org-table-formula-history
9711 )))))
9712 mustsave)
9714 ;; remove formula
9715 (setq stored-list (delq (assoc scol stored-list) stored-list))
9716 (org-table-store-formulas stored-list)
9717 (error "Formula removed"))
9718 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9719 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9720 (if (and name (not named))
9721 ;; We set the column equation, delete the named one.
9722 (setq stored-list (delq (assoc name stored-list) stored-list)
9723 mustsave t))
9724 (if stored
9725 (setcdr (assoc scol stored-list) eq)
9726 (setq stored-list (cons (cons scol eq) stored-list)))
9727 (if (or mustsave (not (equal stored eq)))
9728 (org-table-store-formulas stored-list))
9729 eq))
9731 (defun org-table-store-formulas (alist)
9732 "Store the list of formulas below the current table."
9733 (setq alist (sort alist 'org-table-formula-less-p))
9734 (save-excursion
9735 (goto-char (org-table-end))
9737 (progn
9738 ;; don't overwrite TBLFM, we might use text properties to store stuff
9739 (goto-char (match-beginning 2))
9740 (delete-region (match-beginning 2) (match-end 0)))
9741 (insert "#+TBLFM:"))
9742 (insert " "
9743 (mapconcat (lambda (x)
9744 (concat
9745 (if (equal (string-to-char (car x)) ?@) "" "$")
9746 (car x) "=" (cdr x)))
9747 alist "::")
9750 (defsubst org-table-formula-make-cmp-string (a)
9752 (concat
9753 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9754 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9755 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9757 (defun org-table-formula-less-p (a b)
9758 "Compare two formulas for sorting."
9759 (let ((as (org-table-formula-make-cmp-string (car a)))
9760 (bs (org-table-formula-make-cmp-string (car b))))
9761 (and as bs (string< as bs))))
9763 (defun org-table-get-stored-formulas (&optional noerror)
9764 "Return an alist with the stored formulas directly after current table."
9765 (interactive)
9766 (let (scol eq eq-alist strings string seen)
9767 (save-excursion
9768 (goto-char (org-table-end))
9770 (setq strings (org-split-string (match-string 2) " *:: *"))
9771 (while (setq string (pop strings))
9772 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9773 (setq scol (if (match-end 2)
9774 (match-string 2 string)
9775 (match-string 1 string))
9776 eq (match-string 3 string)
9777 eq-alist (cons (cons scol eq) eq-alist))
9778 (if (member scol seen)
9779 (if noerror
9780 (progn
9781 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9782 (ding)
9783 (sit-for 2))
9784 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9785 (push scol seen))))))
9786 (nreverse eq-alist)))
9788 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9789 "Modify the equations after the table structure has been edited.
9791 For all numbers larger than LIMIT, shift them by DELTA."
9792 (save-excursion
9793 (goto-char (org-table-end))
9796 (re2
9797 (when remove
9798 (if (equal key "$")
9801 s n a)
9802 (when remove
9803 (while (re-search-forward re2 (point-at-eol) t)
9804 (replace-match "")))
9805 (while (re-search-forward re (point-at-eol) t)
9806 (setq s (match-string 1) n (string-to-number s))
9807 (cond
9808 ((setq a (assoc s replace))
9809 (replace-match (concat key (cdr a)) t t))
9810 ((and limit (> n limit))
9811 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9813 (defun org-table-get-specials ()
9814 "Get the column names and local parameters for this table."
9815 (save-excursion
9816 (let ((beg (org-table-begin)) (end (org-table-end))
9817 names name fields fields1 field cnt
9818 c v l line col types dlines hlines)
9819 (setq org-table-column-names nil
9820 org-table-local-parameters nil
9821 org-table-named-field-locations nil
9822 org-table-current-begin-line nil
9823 org-table-current-begin-pos nil
9824 org-table-current-line-types nil)
9825 (goto-char beg)
9827 (setq names (org-split-string (match-string 1) " *| *")
9828 cnt 1)
9829 (while (setq name (pop names))
9830 (setq cnt (1+ cnt))
9831 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9832 (push (cons name (int-to-string cnt)) org-table-column-names))))
9833 (setq org-table-column-names (nreverse org-table-column-names))
9834 (setq org-table-column-name-regexp
9836 (goto-char beg)
9838 (setq fields (org-split-string (match-string 1) " *| *"))
9839 (while (setq field (pop fields))
9841 (push (cons (match-string 1 field) (match-string 2 field))
9842 org-table-local-parameters))))
9843 (goto-char beg)
9845 (setq c (match-string 1)
9846 fields (org-split-string (match-string 2) " *| *"))
9847 (save-excursion
9848 (beginning-of-line (if (equal c "_") 2 0))
9849 (setq line (org-current-line) col 1)
9851 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9852 (while (and fields1 (setq field (pop fields)))
9853 (setq v (pop fields1) col (1+ col))
9854 (when (and (stringp field) (stringp v)
9855 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9856 (push (cons field v) org-table-local-parameters)
9857 (push (list field line col) org-table-named-field-locations))))
9858 ;; Analyse the line types
9859 (goto-char beg)
9860 (setq org-table-current-begin-line (org-current-line)
9861 org-table-current-begin-pos (point)
9862 l org-table-current-begin-line)
9864 (push (if (match-end 1) 'hline 'dline) types)
9865 (if (match-end 1) (push l hlines) (push l dlines))
9866 (beginning-of-line 2)
9867 (setq l (1+ l)))
9868 (setq org-table-current-line-types (apply 'vector (nreverse types))
9869 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9870 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9872 (defun org-table-maybe-eval-formula ()
9874 If yes, store the formula and apply it."
9875 ;; We already know we are in a table. Get field will only return a formula
9876 ;; when appropriate. It might return a separator line, but no problem.
9877 (when org-table-formula-evaluate-inline
9878 (let* ((field (org-trim (or (org-table-get-field) "")))
9879 named eq)
9881 (setq named (equal (string-to-char field) ?:)
9882 eq (match-string 1 field))
9883 (if (or (fboundp 'calc-eval)
9884 (equal (substring eq 0 (min 2 (length eq))) "'("))
9885 (org-table-eval-formula (if named '(4) nil)
9886 (org-table-formula-from-user eq))
9887 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9889 (defvar org-recalc-commands nil
9890 "List of commands triggering the recalculation of a line.
9891 Will be filled automatically during use.")
9893 (defvar org-recalc-marks
9894 '((" " . "Unmarked: no special line, no automatic recalculation")
9895 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9896 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9897 ("!" . "Column name definition line. Reference in formula as $name.")
9898 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9899 ("_" . "Names for values in row below this one.")
9900 ("^" . "Names for values in row above this one.")))
9902 (defun org-table-rotate-recalc-marks (&optional newchar)
9903 "Rotate the recalculation mark in the first column.
9904 If in any row, the first field is not consistent with a mark,
9905 insert a new column for the markers.
9906 When there is an active region, change all the lines in the region,
9907 after prompting for the marking character.
9908 After each change, a message will be displayed indicating the meaning
9909 of the new mark."
9910 (interactive)
9911 (unless (org-at-table-p) (error "Not at a table"))
9912 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9913 (beg (org-table-begin))
9914 (end (org-table-end))
9915 (l (org-current-line))
9916 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9917 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9918 (have-col
9919 (save-excursion
9920 (goto-char beg)
9922 (col (org-table-current-column))
9923 (forcenew (car (assoc newchar org-recalc-marks)))
9924 epos new)
9925 (when l1
9926 (message "Change region to what mark? Type # * ! $ or SPC: ")
9927 (setq newchar (char-to-string (read-char-exclusive))
9928 forcenew (car (assoc newchar org-recalc-marks))))
9929 (if (and newchar (not forcenew))
9930 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9931 newchar))
9932 (if l1 (goto-line l1))
9933 (save-excursion
9934 (beginning-of-line 1)
9935 (unless (looking-at org-table-dataline-regexp)
9936 (error "Not at a table data line")))
9937 (unless have-col
9938 (org-table-goto-column 1)
9939 (org-table-insert-column)
9940 (org-table-goto-column (1+ col)))
9941 (setq epos (point-at-eol))
9942 (save-excursion
9943 (beginning-of-line 1)
9944 (org-table-get-field
9946 (concat " "
9947 (setq new (or forcenew
9948 (cadr (member (match-string 1) marks))))
9949 " ")
9950 " # ")))
9951 (if (and l1 l2)
9952 (progn
9953 (goto-line l1)
9954 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9955 (and (looking-at org-table-dataline-regexp)
9956 (org-table-get-field 1 (concat " " new " "))))
9957 (goto-line l1)))
9958 (if (not (= epos (point-at-eol))) (org-table-align))
9959 (goto-line l)
9960 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
9962 (defun org-table-maybe-recalculate-line ()
9963 "Recompute the current line if marked for it, and if we haven't just done it."
9964 (interactive)
9965 (and org-table-allow-automatic-line-recalculation
9966 (not (and (memq last-command org-recalc-commands)
9967 (equal org-last-recalc-line (org-current-line))))
9968 (save-excursion (beginning-of-line 1)
9969 (looking-at org-table-auto-recalculate-regexp))
9970 (org-table-recalculate) t))
9972 (defvar org-table-formula-debug nil
9973 "Non-nil means, debug table formulas.
9975 (make-variable-buffer-local 'org-table-formula-debug)
9977 (defvar modes)
9978 (defsubst org-set-calc-mode (var &optional value)
9979 (if (stringp var)
9980 (setq var (assoc var '(("D" calc-angle-mode deg)
9981 ("R" calc-angle-mode rad)
9982 ("F" calc-prefer-frac t)
9983 ("S" calc-symbolic-mode t)))
9984 value (nth 2 var) var (nth 1 var)))
9985 (if (memq var modes)
9986 (setcar (cdr (memq var modes)) value)
9987 (cons var (cons value modes)))
9988 modes)
9990 (defun org-table-eval-formula (&optional arg equation
9991 suppress-align suppress-const
9992 suppress-store suppress-analysis)
9993 "Replace the table field value at the cursor by the result of a calculation.
9995 This function makes use of Dave Gillespie's Calc package, in my view the
9996 most exciting program ever written for GNU Emacs. So you need to have Calc
9997 installed in order to use this function.
9999 In a table, this command replaces the value in the current field with the
10001 formula, by storing it in a special line below the table. When called
10002 with a `C-u' prefix, the current field must ba a named field, and the
10003 formula is installed as valid in only this specific field.
10005 When called with two `C-u' prefixes, insert the active equation
10006 for the field back into the current field, so that it can be
10008 to check the referenced fields.
10010 When called, the command first prompts for a formula, which is read in
10011 the minibuffer. Previously entered formulas are available through the
10012 history list, and the last used formula is offered as a default.
10013 These stored formulas are adapted correctly when moving, inserting, or
10014 deleting columns with the corresponding commands.
10016 The formula can be any algebraic expression understood by the Calc package.
10017 For details, see the Org-mode manual.
10019 This function can also be called from Lisp programs and offers
10020 additional arguments: EQUATION can be the formula to apply. If this
10021 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10022 used to speed-up recursive calls by by-passing unnecessary aligns.
10023 SUPPRESS-CONST suppresses the interpretation of constants in the
10024 formula, assuming that this has been done already outside the function.
10025 SUPPRESS-STORE means the formula should not be stored, either because
10026 it is already stored, or because it is a modified equation that should
10027 not overwrite the stored one."
10028 (interactive "P")
10029 (org-table-check-inside-data-field)
10030 (or suppress-analysis (org-table-get-specials))
10031 (if (equal arg '(16))
10032 (let ((eq (org-table-current-field-formula)))
10033 (or eq (error "No equation active for current field"))
10034 (org-table-get-field nil eq)
10035 (org-table-align)
10036 (setq org-table-may-need-update t))
10037 (let* (fields
10038 (ndown (if (integerp arg) arg 1))
10039 (org-table-automatic-realign nil)
10040 (case-fold-search nil)
10041 (down (> ndown 1))
10042 (formula (if (and equation suppress-store)
10043 equation
10044 (org-table-get-formula equation (equal arg '(4)))))
10045 (n0 (org-table-current-column))
10046 (modes (copy-sequence org-calc-default-modes))
10047 (numbers nil) ; was a variable, now fixed default
10048 (keep-empty nil)
10049 n form form0 bw fmt x ev orig c lispp literal)
10050 ;; Parse the format string. Since we have a lot of modes, this is
10051 ;; a lot of work. However, I think calc still uses most of the time.
10052 (if (string-match ";" formula)
10053 (let ((tmp (org-split-string formula ";")))
10054 (setq formula (car tmp)
10055 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10056 (nth 1 tmp)))
10058 (setq c (string-to-char (match-string 1 fmt))
10059 n (string-to-number (match-string 2 fmt)))
10060 (if (= c ?p)
10061 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10062 (setq modes (org-set-calc-mode
10063 'calc-float-format
10064 (list (cdr (assoc c '((?n . float) (?f . fix)
10065 (?s . sci) (?e . eng))))
10066 n))))
10067 (setq fmt (replace-match "" t t fmt)))
10068 (if (string-match "[NT]" fmt)
10069 (setq numbers (equal (match-string 0 fmt) "N")
10070 fmt (replace-match "" t t fmt)))
10071 (if (string-match "L" fmt)
10072 (setq literal t
10073 fmt (replace-match "" t t fmt)))
10074 (if (string-match "E" fmt)
10075 (setq keep-empty t
10076 fmt (replace-match "" t t fmt)))
10077 (while (string-match "[DRFS]" fmt)
10078 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10079 (setq fmt (replace-match "" t t fmt)))
10081 (setq fmt nil))))
10082 (if (and (not suppress-const) org-table-formula-use-constants)
10083 (setq formula (org-table-formula-substitute-names formula)))
10084 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10085 (while (> ndown 0)
10086 (setq fields (org-split-string
10087 (org-no-properties
10088 (buffer-substring (point-at-bol) (point-at-eol)))
10089 " *| *"))
10090 (if (eq numbers t)
10091 (setq fields (mapcar
10092 (lambda (x) (number-to-string (string-to-number x)))
10093 fields)))
10094 (setq ndown (1- ndown))
10095 (setq form (copy-sequence formula)
10096 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10097 (if (and lispp literal) (setq lispp 'literal))
10098 ;; Check for old vertical references
10099 (setq form (org-rewrite-old-row-references form))
10100 ;; Insert complex ranges
10101 (while (string-match org-table-range-regexp form)
10102 (setq form
10103 (replace-match
10104 (save-match-data
10105 (org-table-make-reference
10106 (org-table-get-range (match-string 0 form) nil n0)
10107 keep-empty numbers lispp))
10108 t t form)))
10109 ;; Insert simple ranges
10111 (setq form
10112 (replace-match
10113 (save-match-data
10114 (org-table-make-reference
10115 (org-sublist
10116 fields (string-to-number (match-string 1 form))
10117 (string-to-number (match-string 2 form)))
10118 keep-empty numbers lispp))
10119 t t form)))
10120 (setq form0 form)
10121 ;; Insert the references to fields in same row
10123 (setq n (string-to-number (match-string 1 form))
10124 x (nth (1- (if (= n 0) n0 n)) fields))
10126 (match-string 0 form)))
10127 (setq form (replace-match
10128 (save-match-data
10129 (org-table-make-reference x nil numbers lispp))
10130 t t form)))
10132 (if lispp
10133 (setq ev (condition-case nil
10134 (eval (eval (read form)))
10135 (error "#ERROR"))
10136 ev (if (numberp ev) (number-to-string ev) ev))
10137 (or (fboundp 'calc-eval)
10138 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10139 (setq ev (calc-eval (cons form modes)
10140 (if numbers 'num))))
10142 (when org-table-formula-debug
10143 (with-output-to-temp-buffer "*Substitution History*"
10144 (princ (format "Substitution history of formula
10145 Orig: %s
10146 $xyz-> %s
10147 @r$c-> %s
10149 (if (listp ev)
10151 (make-string (car ev) ?\-) (nth 1 ev)))
10153 ev (or fmt "NONE")
10154 (if fmt (format fmt (string-to-number ev)) ev)))))
10155 (setq bw (get-buffer-window "*Substitution History*"))
10156 (shrink-window-if-larger-than-buffer bw)
10157 (unless (and (interactive-p) (not ndown))
10158 (unless (let (inhibit-redisplay)
10159 (y-or-n-p "Debugging Formula. Continue to next? "))
10160 (org-table-align)
10161 (error "Abort"))
10162 (delete-window bw)
10163 (message "")))
10164 (if (listp ev) (setq fmt nil ev "#ERROR"))
10165 (org-table-justify-field-maybe
10166 (if fmt (format fmt (string-to-number ev)) ev))
10168 (call-interactively 'org-return)
10169 (setq ndown 0)))
10170 (and down (org-table-maybe-recalculate-line))
10171 (or suppress-align (and org-table-may-need-update
10172 (org-table-align))))))
10174 (defun org-table-put-field-property (prop value)
10175 (save-excursion
10176 (put-text-property (progn (skip-chars-backward "^|") (point))
10177 (progn (skip-chars-forward "^|") (point))
10178 prop value)))
10180 (defun org-table-get-range (desc &optional tbeg col highlight)
10181 "Get a calc vector from a column, accorting to descriptor DESC.
10182 Optional arguments TBEG and COL can give the beginning of the table and
10183 the current column, to avoid unnecessary parsing.
10184 HIGHLIGHT means, just highlight the range."
10185 (if (not (equal (string-to-char desc) ?@))
10186 (setq desc (concat "@" desc)))
10187 (save-excursion
10188 (or tbeg (setq tbeg (org-table-begin)))
10189 (or col (setq col (org-table-current-column)))
10190 (let ((thisline (org-current-line))
10191 beg end c1 c2 r1 r2 rangep tmp)
10192 (unless (string-match org-table-range-regexp desc)
10193 (error "Invalid table range specifier `%s'" desc))
10194 (setq rangep (match-end 3)
10195 r1 (and (match-end 1) (match-string 1 desc))
10196 r2 (and (match-end 4) (match-string 4 desc))
10197 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10198 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10200 (and c1 (setq c1 (+ (string-to-number c1)
10201 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10202 (and c2 (setq c2 (+ (string-to-number c2)
10203 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10204 (if (equal r1 "") (setq r1 nil))
10205 (if (equal r2 "") (setq r2 nil))
10206 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10207 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10208 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10209 (if (not r1) (setq r1 thisline))
10210 (if (not r2) (setq r2 thisline))
10211 (if (not c1) (setq c1 col))
10212 (if (not c2) (setq c2 col))
10213 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10214 ;; just one field
10215 (progn
10216 (goto-line r1)
10217 (while (not (looking-at org-table-dataline-regexp))
10218 (beginning-of-line 2))
10219 (prog1 (org-trim (org-table-get-field c1))
10220 (if highlight (org-table-highlight-rectangle (point) (point)))))
10221 ;; A range, return a vector
10222 ;; First sort the numbers to get a regular ractangle
10223 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10224 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10225 (goto-line r1)
10226 (while (not (looking-at org-table-dataline-regexp))
10227 (beginning-of-line 2))
10228 (org-table-goto-column c1)
10229 (setq beg (point))
10230 (goto-line r2)
10231 (while (not (looking-at org-table-dataline-regexp))
10232 (beginning-of-line 0))
10233 (org-table-goto-column c2)
10234 (setq end (point))
10235 (if highlight
10236 (org-table-highlight-rectangle
10238 ;; return string representation of calc vector
10239 (mapcar 'org-trim
10240 (apply 'append (org-table-copy-region beg end)))))))
10242 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10243 "Analyze descriptor DESC and retrieve the corresponding line number.
10244 The cursor is currently in line CLINE, the table begins in line BLINE,
10245 and TABLE is a vector with line types."
10246 (if (string-match "^[0-9]+$" desc)
10247 (aref org-table-dlines (string-to-number desc))
10248 (setq cline (or cline (org-current-line))
10249 bline (or bline org-table-current-begin-line)
10250 table (or table org-table-current-line-types))
10251 (if (or
10253 ;; 1 2 3 4 5 6
10254 (and (not (match-end 3)) (not (match-end 6)))
10255 (and (match-end 3) (match-end 6) (not (match-end 5))))
10256 (error "invalid row descriptor `%s'" desc))
10257 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10258 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10259 (odir (and (match-end 5) (match-string 5 desc)))
10260 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10261 (i (- cline bline))
10262 (rel (and (match-end 6)
10263 (or (and (match-end 1) (not (match-end 3)))
10264 (match-end 5)))))
10265 (if (and hn (not hdir))
10266 (progn
10267 (setq i 0 hdir "+")
10268 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10269 (if (and (not hn) on (not odir))
10270 (error "should never happen");;(aref org-table-dlines on)
10271 (if (and hn (> hn 0))
10272 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10273 (if on
10274 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10275 (+ bline i)))))
10277 (defun org-find-row-type (table i type backwards relative n)
10278 (let ((l (length table)))
10279 (while (> n 0)
10280 (while (and (setq i (+ i (if backwards -1 1)))
10281 (>= i 0) (< i l)
10282 (not (eq (aref table i) type))
10283 (if (and relative (eq (aref table i) 'hline))
10284 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10285 t)))
10286 (setq n (1- n)))
10287 (if (or (< i 0) (>= i l))
10288 (error "Row descriptior leads outside table")
10289 i)))
10291 (defun org-rewrite-old-row-references (s)
10292 (if (string-match "&[-+0-9I]" s)
10293 (error "Formula contains old &row reference, please rewrite using @-syntax")
10294 s))
10296 (defun org-table-make-reference (elements keep-empty numbers lispp)
10297 "Convert list ELEMENTS to something appropriate to insert into formula.
10298 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10299 NUMBERS indicates that everything should be converted to numbers.
10300 LISPP means to return something appropriate for a Lisp list."
10301 (if (stringp elements) ; just a single val
10302 (if lispp
10303 (if (eq lispp 'literal)
10304 elements
10305 (prin1-to-string (if numbers (string-to-number elements) elements)))
10306 (if (equal elements "") (setq elements "0"))
10307 (if numbers (number-to-string (string-to-number elements)) elements))
10308 (unless keep-empty
10309 (setq elements
10310 (delq nil
10312 elements))))
10313 (setq elements (or elements '("0")))
10314 (if lispp
10315 (mapconcat
10316 (lambda (x)
10317 (if (eq lispp 'literal)
10318 x
10319 (prin1-to-string (if numbers (string-to-number x) x))))
10320 elements " ")
10321 (concat "[" (mapconcat
10322 (lambda (x)
10323 (if numbers (number-to-string (string-to-number x)) x))
10324 elements
10325 ",") "]"))))
10327 (defun org-table-recalculate (&optional all noalign)
10328 "Recalculate the current table line by applying all stored formulas.
10329 With prefix arg ALL, do this for all lines in the table."
10330 (interactive "P")
10331 (or (memq this-command org-recalc-commands)
10332 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10333 (unless (org-at-table-p) (error "Not at a table"))
10334 (if (equal all '(16))
10335 (org-table-iterate)
10336 (org-table-get-specials)
10337 (let* ((eqlist (sort (org-table-get-stored-formulas)
10338 (lambda (a b) (string< (car a) (car b)))))
10339 (inhibit-redisplay (not debug-on-error))
10340 (line-re org-table-dataline-regexp)
10341 (thisline (org-current-line))
10342 (thiscol (org-table-current-column))
10343 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10344 ;; Insert constants in all formulas
10345 (setq eqlist
10346 (mapcar (lambda (x)
10347 (setcdr x (org-table-formula-substitute-names (cdr x)))
10348 x)
10349 eqlist))
10350 ;; Split the equation list
10351 (while (setq eq (pop eqlist))
10352 (if (<= (string-to-char (car eq)) ?9)
10353 (push eq eqlnum)
10354 (push eq eqlname)))
10355 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10356 (if all
10357 (progn
10358 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10359 (goto-char (setq beg (org-table-begin)))
10360 (if (re-search-forward org-table-calculate-mark-regexp end t)
10361 ;; This is a table with marked lines, compute selected lines
10362 (setq line-re org-table-recalculate-regexp)
10363 ;; Move forward to the first non-header line
10364 (if (and (re-search-forward org-table-dataline-regexp end t)
10365 (re-search-forward org-table-hline-regexp end t)
10366 (re-search-forward org-table-dataline-regexp end t))
10367 (setq beg (match-beginning 0))
10368 nil))) ;; just leave beg where it is
10369 (setq beg (point-at-bol)
10370 end (move-marker (make-marker) (1+ (point-at-eol)))))
10371 (goto-char beg)
10372 (and all (message "Re-applying formulas to full table..."))
10374 ;; First find the named fields, and mark them untouchanble
10375 (remove-text-properties beg end '(org-untouchable t))
10376 (while (setq eq (pop eqlname))
10377 (setq name (car eq)
10378 a (assoc name org-table-named-field-locations))
10379 (and (not a)
10381 (setq a (list name
10382 (aref org-table-dlines
10383 (string-to-number (match-string 1 name)))
10384 (string-to-number (match-string 2 name)))))
10385 (when (and a (or all (equal (nth 1 a) thisline)))
10386 (message "Re-applying formula to field: %s" name)
10387 (goto-line (nth 1 a))
10388 (org-table-goto-column (nth 2 a))
10389 (push (append a (list (cdr eq))) eqlname1)
10390 (org-table-put-field-property :org-untouchable t)))
10392 ;; Now evauluate the column formulas, but skip fields covered by
10393 ;; field formulas
10394 (goto-char beg)
10395 (while (re-search-forward line-re end t)
10396 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10397 ;; Unprotected line, recalculate
10398 (and all (message "Re-applying formulas to full table...(line %d)"
10399 (setq cnt (1+ cnt))))
10400 (setq org-last-recalc-line (org-current-line))
10401 (setq eql eqlnum)
10402 (while (setq entry (pop eql))
10403 (goto-line org-last-recalc-line)
10404 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10405 (unless (get-text-property (point) :org-untouchable)
10406 (org-table-eval-formula nil (cdr entry)
10407 'noalign 'nocst 'nostore 'noanalysis)))))
10409 ;; Now evaluate the field formulas
10410 (while (setq eq (pop eqlname1))
10411 (message "Re-applying formula to field: %s" (car eq))
10412 (goto-line (nth 1 eq))
10413 (org-table-goto-column (nth 2 eq))
10414 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10415 'nostore 'noanalysis))
10417 (goto-line thisline)
10418 (org-table-goto-column thiscol)
10419 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10420 (or noalign (and org-table-may-need-update (org-table-align))
10421 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10423 ;; back to initial position
10424 (message "Re-applying formulas...done")
10425 (goto-line thisline)
10426 (org-table-goto-column thiscol)
10427 (or noalign (and org-table-may-need-update (org-table-align))
10428 (and all (message "Re-applying formulas...done"))))))
10430 (defun org-table-iterate (&optional arg)
10431 "Recalculate the table until it does not change anymore."
10432 (interactive "P")
10433 (let ((imax (if arg (prefix-numeric-value arg) 10))
10434 (i 0)
10435 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10436 thistbl)
10437 (catch 'exit
10438 (while (< i imax)
10439 (setq i (1+ i))
10440 (org-table-recalculate 'all)
10441 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10442 (if (not (string= lasttbl thistbl))
10443 (setq lasttbl thistbl)
10444 (if (> i 1)
10445 (message "Convergence after %d iterations" i)
10446 (message "Table was already stable"))
10447 (throw 'exit t)))
10448 (error "No convergence after %d iterations" i))))
10450 (defun org-table-formula-substitute-names (f)
10451 "Replace $const with values in string F."
10452 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10453 ;; First, check for column names
10454 (while (setq start (string-match org-table-column-name-regexp f start))
10455 (setq start (1+ start))
10456 (setq a (assoc (match-string 1 f) org-table-column-names))
10457 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10458 ;; Parameters and constants
10459 (setq start 0)
10461 (setq start (1+ start))
10462 (if (setq a (save-match-data
10463 (org-table-get-constant (match-string 1 f))))
10464 (setq f (replace-match
10465 (concat (if pp "(") a (if pp ")")) t t f))))
10466 (if org-table-formula-debug
10467 (put-text-property 0 (length f) :orig-formula f1 f))
10468 f))
10470 (defun org-table-get-constant (const)
10471 "Find the value for a parameter or constant in a formula.
10472 Parameters get priority."
10473 (or (cdr (assoc const org-table-local-parameters))
10474 (cdr (assoc const org-table-formula-constants-local))
10475 (cdr (assoc const org-table-formula-constants))
10476 (and (fboundp 'constants-get) (constants-get const))
10477 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10478 (org-entry-get nil (substring const 5) 'inherit))
10479 "#UNDEFINED_NAME"))
10481 (defvar org-table-fedit-map
10482 (let ((map (make-sparse-keymap)))
10483 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10484 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10485 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10486 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10487 (org-defkey map "\C-c?" 'org-table-show-reference)
10488 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10489 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10490 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10491 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10492 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10493 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10494 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10495 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10496 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10497 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10498 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10499 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10500 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10501 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10502 map))
10504 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10505 '("Edit-Formulas"
10506 ["Finish and Install" org-table-fedit-finish t]
10507 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10508 ["Abort" org-table-fedit-abort t]
10509 "--"
10510 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10511 ["Complete Lisp Symbol" lisp-complete-symbol t]
10512 "--"
10513 "Shift Reference at Point"
10514 ["Up" org-table-fedit-ref-up t]
10515 ["Down" org-table-fedit-ref-down t]
10516 ["Left" org-table-fedit-ref-left t]
10517 ["Right" org-table-fedit-ref-right t]
10518 "-"
10519 "Change Test Row for Column Formulas"
10520 ["Up" org-table-fedit-line-up t]
10521 ["Down" org-table-fedit-line-down t]
10522 "--"
10523 ["Scroll Table Window" org-table-fedit-scroll t]
10524 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10525 ["Show Table Grid" org-table-fedit-toggle-coordinates
10526 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10527 org-table-overlay-coordinates)]
10528 "--"
10529 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10530 :style toggle :selected org-table-buffer-is-an]))
10532 (defvar org-pos)
10534 (defun org-table-edit-formulas ()
10535 "Edit the formulas of the current table in a separate buffer."
10536 (interactive)
10538 (beginning-of-line 0))
10539 (unless (org-at-table-p) (error "Not at a table"))
10540 (org-table-get-specials)
10541 (let ((key (org-table-current-field-formula 'key 'noerror))
10542 (eql (sort (org-table-get-stored-formulas 'noerror)
10543 'org-table-formula-less-p))
10544 (pos (move-marker (make-marker) (point)))
10545 (startline 1)
10546 (wc (current-window-configuration))
10550 entry s type title)
10551 (org-switch-to-buffer-other-window "*Edit Formulas*")
10552 (erase-buffer)
10553 ;; Keep global-font-lock-mode from turning on font-lock-mode
10554 (let ((font-lock-global-modes '(not fundamental-mode)))
10555 (fundamental-mode))
10556 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10557 (org-set-local 'org-pos pos)
10558 (org-set-local 'org-window-configuration wc)
10559 (use-local-map org-table-fedit-map)
10560 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10561 (easy-menu-add org-table-fedit-menu)
10562 (setq startline (org-current-line))
10563 (while (setq entry (pop eql))
10564 (setq type (cond
10565 ((equal (string-to-char (car entry)) ?@) 'field)
10566 ((string-match "^[0-9]" (car entry)) 'column)
10567 (t 'named)))
10568 (when (setq title (assq type titles))
10570 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10571 (setq titles (delq title titles)))
10572 (if (equal key (car entry)) (setq startline (org-current-line)))
10573 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10575 (remove-text-properties 0 (length s) '(face nil) s)
10576 (insert s))
10577 (if (eq org-table-use-standard-references t)
10578 (org-table-fedit-toggle-ref-type))
10579 (goto-line startline)
10580 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10582 (defun org-table-fedit-post-command ()
10583 (when (not (memq this-command '(lisp-complete-symbol)))
10584 (let ((win (selected-window)))
10585 (save-excursion
10586 (condition-case nil
10587 (org-table-show-reference)
10588 (error nil))
10589 (select-window win)))))
10591 (defun org-table-formula-to-user (s)
10592 "Convert a formula from internal to user representation."
10593 (if (eq org-table-use-standard-references t)
10594 (org-table-convert-refs-to-an s)
10595 s))
10597 (defun org-table-formula-from-user (s)
10598 "Convert a formula from user to internal representation."
10599 (if org-table-use-standard-references
10600 (org-table-convert-refs-to-rc s)
10601 s))
10603 (defun org-table-convert-refs-to-rc (s)
10604 "Convert spreadsheet references from AB7 to @7$28.
10605 Works for single references, but also for entire formulas and even the
10606 full TBLFM line."
10607 (let ((start 0))
10609 (cond
10610 ((match-end 3)
10611 ;; format match, just advance
10612 (setq start (match-end 0)))
10613 ((and (> (match-beginning 0) 0)
10614 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10615 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10616 ;; 3.e5 or something like this.
10617 (setq start (match-end 0)))
10618 (t
10619 (setq start (match-beginning 0)
10620 s (replace-match
10621 (if (equal (match-string 2 s) "&")
10622 (format "$%d" (org-letters-to-number (match-string 1 s)))
10623 (format "@%d$%d"
10624 (string-to-number (match-string 2 s))
10625 (org-letters-to-number (match-string 1 s))))
10626 t t s)))))
10627 s))
10629 (defun org-table-convert-refs-to-an (s)
10630 "Convert spreadsheet references from to @7$28 to AB7.
10631 Works for single references, but also for entire formulas and even the
10632 full TBLFM line."
10634 (setq s (replace-match
10635 (format "%s%d"
10636 (org-number-to-letters
10637 (string-to-number (match-string 2 s)))
10638 (string-to-number (match-string 1 s)))
10639 t t s)))
10642 (org-number-to-letters
10643 (string-to-number (match-string 2 s))) "&")
10644 t nil s)))
10645 s)
10647 (defun org-letters-to-number (s)
10648 "Convert a base 26 number represented by letters into an integer.
10649 For example: AB -> 28."
10650 (let ((n 0))
10651 (setq s (upcase s))
10652 (while (> (length s) 0)
10653 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10654 s (substring s 1)))
10655 n))
10657 (defun org-number-to-letters (n)
10658 "Convert an integer into a base 26 number represented by letters.
10659 For example: 28 -> AB."
10660 (let ((s ""))
10661 (while (> n 0)
10662 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10663 n (/ (1- n) 26)))
10664 s))
10666 (defun org-table-fedit-convert-buffer (function)
10667 "Convert all references in this buffer, using FUNTION."
10668 (let ((line (org-current-line)))
10669 (goto-char (point-min))
10670 (while (not (eobp))
10671 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10672 (delete-region (point) (point-at-eol))
10673 (or (eobp) (forward-char 1)))
10674 (goto-line line)))
10676 (defun org-table-fedit-toggle-ref-type ()
10677 "Convert all references in the buffer from B3 to @3$2 and back."
10678 (interactive)
10679 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10680 (org-table-fedit-convert-buffer
10681 (if org-table-buffer-is-an
10682 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10683 (message "Reference type switched to %s"
10684 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10686 (defun org-table-fedit-ref-up ()
10687 "Shift the reference at point one row/hline up."
10688 (interactive)
10689 (org-table-fedit-shift-reference 'up))
10690 (defun org-table-fedit-ref-down ()
10691 "Shift the reference at point one row/hline down."
10692 (interactive)
10693 (org-table-fedit-shift-reference 'down))
10694 (defun org-table-fedit-ref-left ()
10695 "Shift the reference at point one field to the left."
10696 (interactive)
10697 (org-table-fedit-shift-reference 'left))
10698 (defun org-table-fedit-ref-right ()
10699 "Shift the reference at point one field to the right."
10700 (interactive)
10701 (org-table-fedit-shift-reference 'right))
10703 (defun org-table-fedit-shift-reference (dir)
10704 (cond
10706 (if (memq dir '(left right))
10707 (org-rematch-and-replace 1 (eq dir 'left))
10708 (error "Cannot shift reference in this direction")))
10710 ;; A B3-like reference
10711 (if (memq dir '(up down))
10712 (org-rematch-and-replace 2 (eq dir 'up))
10713 (org-rematch-and-replace 1 (eq dir 'left))))
10714 ((org-at-regexp-p
10716 ;; An internal reference
10717 (if (memq dir '(up down))
10718 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10719 (org-rematch-and-replace 5 (eq dir 'left))))))
10721 (defun org-rematch-and-replace (n &optional decr hline)
10722 "Re-match the group N, and replace it with the shifted refrence."
10723 (or (match-end n) (error "Cannot shift reference in this direction"))
10724 (goto-char (match-beginning n))
10725 (and (looking-at (regexp-quote (match-string n)))
10726 (replace-match (org-shift-refpart (match-string 0) decr hline)
10727 t t)))
10729 (defun org-shift-refpart (ref &optional decr hline)
10730 "Shift a refrence part REF.
10731 If DECR is set, decrease the references row/column, else increase.
10732 If HLINE is set, this may be a hline reference, it certainly is not
10733 a translation reference."
10734 (save-match-data
10735 (let* ((sign (string-match "^[-+]" ref)) n)
10737 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10738 (cond
10739 ((and hline (string-match "^I+" ref))
10740 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10741 (setq n (+ n (if decr -1 1)))
10742 (if (= n 0) (setq n (+ n (if decr -1 1))))
10743 (if sign
10744 (setq sign (if (< n 0) "-" "+") n (abs n))
10745 (setq n (max 1 n)))
10746 (concat sign (make-string n ?I)))
10748 ((string-match "^[0-9]+" ref)
10749 (setq n (string-to-number (concat sign ref)))
10750 (setq n (+ n (if decr -1 1)))
10751 (if sign
10752 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10753 (number-to-string (max 1 n))))
10755 ((string-match "^[a-zA-Z]+" ref)
10756 (org-number-to-letters
10757 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10759 (t (error "Cannot shift reference"))))))
10761 (defun org-table-fedit-toggle-coordinates ()
10762 "Toggle the display of coordinates in the refrenced table."
10763 (interactive)
10764 (let ((pos (marker-position org-pos)))
10765 (with-current-buffer (marker-buffer org-pos)
10766 (save-excursion
10767 (goto-char pos)
10768 (org-table-toggle-coordinate-overlays)))))
10770 (defun org-table-fedit-finish (&optional arg)
10771 "Parse the buffer for formula definitions and install them.
10772 With prefix ARG, apply the new formulas to the table."
10773 (interactive "P")
10774 (org-table-remove-rectangle-highlight)
10775 (if org-table-use-standard-references
10776 (progn
10777 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10778 (setq org-table-buffer-is-an nil)))
10779 (let ((pos org-pos) eql var form)
10780 (goto-char (point-min))
10781 (while (re-search-forward
10783 nil t)
10784 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10785 form (match-string 3))
10786 (setq form (org-trim form))
10787 (when (not (equal form ""))
10789 (setq form (replace-match " " t t form)))
10790 (when (assoc var eql)
10791 (error "Double formulas for %s" var))
10792 (push (cons var form) eql)))
10793 (setq org-pos nil)
10794 (set-window-configuration org-window-configuration)
10795 (select-window (get-buffer-window (marker-buffer pos)))
10796 (goto-char pos)
10797 (unless (org-at-table-p)
10798 (error "Lost table position - cannot install formulae"))
10799 (org-table-store-formulas eql)
10800 (move-marker pos nil)
10801 (kill-buffer "*Edit Formulas*")
10802 (if arg
10803 (org-table-recalculate 'all)
10804 (message "New formulas installed - press C-u C-c C-c to apply."))))
10806 (defun org-table-fedit-abort ()
10807 "Abort editing formulas, without installing the changes."
10808 (interactive)
10809 (org-table-remove-rectangle-highlight)
10810 (let ((pos org-pos))
10811 (set-window-configuration org-window-configuration)
10812 (select-window (get-buffer-window (marker-buffer pos)))
10813 (goto-char pos)
10814 (move-marker pos nil)
10815 (message "Formula editing aborted without installing changes")))
10817 (defun org-table-fedit-lisp-indent ()
10818 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10819 (interactive)
10820 (let ((pos (point)) beg end ind)
10821 (beginning-of-line 1)
10822 (cond
10824 (goto-char pos)
10825 (call-interactively 'lisp-indent-line))
10827 ((not (fboundp 'pp-buffer))
10828 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10829 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10830 (goto-char (- (match-end 0) 2))
10831 (setq beg (point))
10832 (setq ind (make-string (current-column) ?\ ))
10833 (condition-case nil (forward-sexp 1)
10834 (error
10835 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10836 (setq end (point))
10837 (save-restriction
10838 (narrow-to-region beg end)
10839 (if (eq last-command this-command)
10840 (progn
10841 (goto-char (point-min))
10842 (setq this-command nil)
10844 (replace-match " ")))
10845 (pp-buffer)
10846 (untabify (point-min) (point-max))
10847 (goto-char (1+ (point-min)))
10848 (while (re-search-forward "^." nil t)
10849 (beginning-of-line 1)
10850 (insert ind))
10851 (goto-char (point-max))
10852 (backward-delete-char 1)))
10853 (goto-char beg))
10854 (t nil))))
10856 (defvar org-show-positions nil)
10858 (defun org-table-show-reference (&optional local)
10859 "Show the location/value of the $ expression at point."
10860 (interactive)
10861 (org-table-remove-rectangle-highlight)
10862 (catch 'exit
10863 (let ((pos (if local (point) org-pos))
10864 (face2 'highlight)
10865 (org-inhibit-highlight-removal t)
10866 (win (selected-window))
10867 (org-show-positions nil)
10868 var name e what match dest)
10869 (if local (org-table-get-specials))
10870 (setq what (cond
10871 ((or (org-at-regexp-p org-table-range-regexp2)
10872 (org-at-regexp-p org-table-translate-regexp)
10873 (org-at-regexp-p org-table-range-regexp))
10874 (setq match
10875 (save-match-data
10876 (org-table-convert-refs-to-rc (match-string 0))))
10877 'range)
10880 ((not local) nil)
10881 (t (error "No reference at point")))
10882 match (and what (or match (match-string 0))))
10883 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10884 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10885 'secondary-selection))
10886 (org-add-hook 'before-change-functions
10887 'org-table-remove-rectangle-highlight)
10888 (if (eq what 'name) (setq var (substring match 1)))
10889 (when (eq what 'range)
10890 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10891 (setq match (org-table-formula-substitute-names match)))
10892 (unless local
10893 (save-excursion
10894 (end-of-line 1)
10896 (beginning-of-line 1)
10898 (setq dest
10899 (save-match-data
10900 (org-table-convert-refs-to-rc (match-string 1))))
10901 (org-table-add-rectangle-overlay
10902 (match-beginning 1) (match-end 1) face2))))
10903 (if (and (markerp pos) (marker-buffer pos))
10904 (if (get-buffer-window (marker-buffer pos))
10905 (select-window (get-buffer-window (marker-buffer pos)))
10906 (org-switch-to-buffer-other-window (get-buffer-window
10907 (marker-buffer pos)))))
10908 (goto-char pos)
10909 (org-table-force-dataline)
10910 (when dest
10911 (setq name (substring dest 1))
10912 (cond
10914 (setq e (assoc name org-table-named-field-locations))
10915 (goto-line (nth 1 e))
10916 (org-table-goto-column (nth 2 e)))
10918 (let ((l (string-to-number (match-string 1 dest)))
10919 (c (string-to-number (match-string 2 dest))))
10920 (goto-line (aref org-table-dlines l))
10921 (org-table-goto-column c)))
10922 (t (org-table-goto-column (string-to-number name))))
10923 (move-marker pos (point))
10924 (org-table-highlight-rectangle nil nil face2))
10925 (cond
10926 ((equal dest match))
10927 ((not match))
10928 ((eq what 'range)
10929 (condition-case nil
10930 (save-excursion
10931 (org-table-get-range match nil nil 'highlight))
10932 (error nil)))
10933 ((setq e (assoc var org-table-named-field-locations))
10934 (goto-line (nth 1 e))
10935 (org-table-goto-column (nth 2 e))
10936 (org-table-highlight-rectangle (point) (point))
10937 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10938 ((setq e (assoc var org-table-column-names))
10939 (org-table-goto-column (string-to-number (cdr e)))
10940 (org-table-highlight-rectangle (point) (point))
10941 (goto-char (org-table-begin))
10943 (org-table-end) t)
10944 (progn
10945 (goto-char (match-beginning 1))
10946 (org-table-highlight-rectangle)
10947 (message "Named column (column %s)" (cdr e)))
10948 (error "Column name not found")))
10949 ((eq what 'column)
10950 ;; column number
10951 (org-table-goto-column (string-to-number (substring match 1)))
10952 (org-table-highlight-rectangle (point) (point))
10953 (message "Column %s" (substring match 1)))
10954 ((setq e (assoc var org-table-local-parameters))
10955 (goto-char (org-table-begin))
10957 (progn
10958 (goto-char (match-beginning 1))
10959 (org-table-highlight-rectangle)
10960 (message "Local parameter."))
10961 (error "Parameter not found")))
10962 (t
10963 (cond
10964 ((not var) (error "No reference at point"))
10965 ((setq e (assoc var org-table-formula-constants-local))
10966 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10967 var (cdr e)))
10968 ((setq e (assoc var org-table-formula-constants))
10969 (message "Constant: $%s=%s in `org-table-formula-constants'."
10970 var (cdr e)))
10971 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10972 (message "Constant: $%s=%s, from `constants.el'%s."
10973 var e (format " (%s units)" constants-unit-system)))
10974 (t (error "Undefined name $%s" var)))))
10975 (goto-char pos)
10976 (when (and org-show-positions
10977 (not (memq this-command '(org-table-fedit-scroll
10978 org-table-fedit-scroll-down))))
10979 (push pos org-show-positions)
10980 (push org-table-current-begin-pos org-show-positions)
10981 (let ((min (apply 'min org-show-positions))
10982 (max (apply 'max org-show-positions)))
10983 (goto-char min) (recenter 0)
10984 (goto-char max)
10985 (or (pos-visible-in-window-p max) (recenter -1))))
10986 (select-window win))))
10988 (defun org-table-force-dataline ()
10989 "Make sure the cursor is in a dataline in a table."
10990 (unless (save-excursion
10991 (beginning-of-line 1)
10992 (looking-at org-table-dataline-regexp))
10993 (let* ((re org-table-dataline-regexp)
10994 (p1 (save-excursion (re-search-forward re nil 'move)))
10995 (p2 (save-excursion (re-search-backward re nil 'move))))
10996 (cond ((and p1 p2)
10997 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10998 p1 p2)))
10999 ((or p1 p2) (goto-char (or p1 p2)))
11000 (t (error "No table dataline around here"))))))
11002 (defun org-table-fedit-line-up ()
11003 "Move cursor one line up in the window showing the table."
11004 (interactive)
11005 (org-table-fedit-move 'previous-line))
11007 (defun org-table-fedit-line-down ()
11008 "Move cursor one line down in the window showing the table."
11009 (interactive)
11010 (org-table-fedit-move 'next-line))
11012 (defun org-table-fedit-move (command)
11013 "Move the cursor in the window shoinw the table.
11014 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11015 (let ((org-table-allow-automatic-line-recalculation nil)
11016 (pos org-pos) (win (selected-window)) p)
11017 (select-window (get-buffer-window (marker-buffer org-pos)))
11018 (setq p (point))
11019 (call-interactively command)
11020 (while (and (org-at-table-p)
11021 (org-at-table-hline-p))
11022 (call-interactively command))
11023 (or (org-at-table-p) (goto-char p))
11024 (move-marker pos (point))
11025 (select-window win)))
11027 (defun org-table-fedit-scroll (N)
11028 (interactive "p")
11029 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11030 (scroll-other-window N)))
11032 (defun org-table-fedit-scroll-down (N)
11033 (interactive "p")
11034 (org-table-fedit-scroll (- N)))
11036 (defvar org-table-rectangle-overlays nil)
11038 (defun org-table-add-rectangle-overlay (beg end &optional face)
11039 "Add a new overlay."
11040 (let ((ov (org-make-overlay beg end)))
11041 (org-overlay-put ov 'face (or face 'secondary-selection))
11042 (push ov org-table-rectangle-overlays)))
11044 (defun org-table-highlight-rectangle (&optional beg end face)
11045 "Highlight rectangular region in a table."
11046 (setq beg (or beg (point)) end (or end (point)))
11047 (let ((b (min beg end))
11048 (e (max beg end))
11049 l1 c1 l2 c2 tmp)
11050 (and (boundp 'org-show-positions)
11051 (setq org-show-positions (cons b (cons e org-show-positions))))
11052 (goto-char (min beg end))
11053 (setq l1 (org-current-line)
11054 c1 (org-table-current-column))
11055 (goto-char (max beg end))
11056 (setq l2 (org-current-line)
11057 c2 (org-table-current-column))
11058 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11059 (goto-line l1)
11060 (beginning-of-line 1)
11061 (loop for line from l1 to l2 do
11062 (when (looking-at org-table-dataline-regexp)
11063 (org-table-goto-column c1)
11065 (org-table-goto-column c2)
11067 (org-table-add-rectangle-overlay beg end face))
11068 (beginning-of-line 2))
11069 (goto-char b))
11070 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11072 (defun org-table-remove-rectangle-highlight (&rest ignore)
11073 "Remove the rectangle overlays."
11074 (unless org-inhibit-highlight-removal
11075 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11076 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11077 (setq org-table-rectangle-overlays nil)))
11079 (defvar org-table-coordinate-overlays nil
11080 "Collects the cooordinate grid overlays, so that they can be removed.")
11081 (make-variable-buffer-local 'org-table-coordinate-overlays)
11083 (defun org-table-overlay-coordinates ()
11084 "Add overlays to the table at point, to show row/column coordinates."
11085 (interactive)
11086 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11087 (setq org-table-coordinate-overlays nil)
11088 (save-excursion
11089 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11090 (goto-char (org-table-begin))
11091 (while (org-at-table-p)
11092 (setq eol (point-at-eol))
11093 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11094 (push ov org-table-coordinate-overlays)
11095 (setq hline (looking-at org-table-hline-regexp))
11096 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11097 (format "%4d" (setq id (1+ id)))))
11098 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11099 (when hline
11100 (setq ic 0)
11102 (setq beg (1+ (match-beginning 0))
11103 ic (1+ ic)
11104 s1 (concat "$" (int-to-string ic))
11105 s2 (org-number-to-letters ic)
11106 str (if (eq org-table-use-standard-references t) s2 s1))
11107 (setq ov (org-make-overlay beg (+ beg (length str))))
11108 (push ov org-table-coordinate-overlays)
11109 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11110 (beginning-of-line 2)))))
11112 (defun org-table-toggle-coordinate-overlays ()
11113 "Toggle the display of Row/Column numbers in tables."
11114 (interactive)
11115 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11116 (message "Row/Column number display turned %s"
11117 (if org-table-overlay-coordinates "on" "off"))
11118 (if (and (org-at-table-p) org-table-overlay-coordinates)
11119 (org-table-align))
11120 (unless org-table-overlay-coordinates
11121 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11122 (setq org-table-coordinate-overlays nil)))
11124 (defun org-table-toggle-formula-debugger ()
11125 "Toggle the formula debugger in tables."
11126 (interactive)
11127 (setq org-table-formula-debug (not org-table-formula-debug))
11128 (message "Formula debugging has been turned %s"
11129 (if org-table-formula-debug "on" "off")))
11131 ;;; The orgtbl minor mode
11133 ;; Define a minor mode which can be used in other modes in order to
11134 ;; integrate the org-mode table editor.
11136 ;; This is really a hack, because the org-mode table editor uses several
11137 ;; keys which normally belong to the major mode, for example the TAB and
11138 ;; RET keys. Here is how it works: The minor mode defines all the keys
11139 ;; necessary to operate the table editor, but wraps the commands into a
11140 ;; function which tests if the cursor is currently inside a table. If that
11141 ;; is the case, the table editor command is executed. However, when any of
11142 ;; those keys is used outside a table, the function uses `key-binding' to
11143 ;; look up if the key has an associated command in another currently active
11144 ;; keymap (minor modes, major mode, global), and executes that command.
11145 ;; There might be problems if any of the keys used by the table editor is
11146 ;; otherwise used as a prefix key.
11148 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11149 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11150 ;; addresses this by checking explicitly for both bindings.
11152 ;; The optimized version (see variable `orgtbl-optimized') takes over
11153 ;; all keys which are bound to `self-insert-command' in the *global map*.
11154 ;; Some modes bind other commands to simple characters, for example
11155 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11156 ;; active, this binding is ignored inside tables and replaced with a
11157 ;; modified self-insert.
11159 (defvar orgtbl-mode nil
11160 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11161 table editor in arbitrary modes.")
11162 (make-variable-buffer-local 'orgtbl-mode)
11164 (defvar orgtbl-mode-map (make-keymap)
11165 "Keymap for `orgtbl-mode'.")
11167 ;;;###autoload
11168 (defun turn-on-orgtbl ()
11169 "Unconditionally turn on `orgtbl-mode'."
11170 (orgtbl-mode 1))
11172 (defvar org-old-auto-fill-inhibit-regexp nil
11173 "Local variable used by `orgtbl-mode'")
11176 "Matches a line belonging to an orgtbl.")
11178 (defconst orgtbl-extra-font-lock-keywords
11179 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11180 0 (quote 'org-table) 'prepend))
11181 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11183 ;;;###autoload
11184 (defun orgtbl-mode (&optional arg)
11185 "The `org-mode' table editor as a minor mode for use in other modes."
11186 (interactive)
11187 (if (org-mode-p)
11188 ;; Exit without error, in case some hook functions calls this
11189 ;; by accident in org-mode.
11190 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11191 (setq orgtbl-mode
11192 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11193 (if orgtbl-mode
11194 (progn
11195 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11196 ;; Make sure we are first in minor-mode-map-alist
11197 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11198 (and c (setq minor-mode-map-alist
11199 (cons c (delq c minor-mode-map-alist)))))
11200 (org-set-local (quote org-table-may-need-update) t)
11201 (org-add-hook 'before-change-functions 'org-before-change-function
11202 nil 'local)
11203 (org-set-local 'org-old-auto-fill-inhibit-regexp
11204 auto-fill-inhibit-regexp)
11205 (org-set-local 'auto-fill-inhibit-regexp
11206 (if auto-fill-inhibit-regexp
11208 auto-fill-inhibit-regexp)
11209 orgtbl-line-start-regexp))
11210 (org-add-to-invisibility-spec '(org-cwidth))
11211 (when (fboundp 'font-lock-add-keywords)
11212 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11213 (org-restart-font-lock))
11214 (easy-menu-add orgtbl-mode-menu)
11215 (run-hooks 'orgtbl-mode-hook))
11216 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11217 (org-cleanup-narrow-column-properties)
11218 (org-remove-from-invisibility-spec '(org-cwidth))
11219 (remove-hook 'before-change-functions 'org-before-change-function t)
11220 (when (fboundp 'font-lock-remove-keywords)
11221 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11222 (org-restart-font-lock))
11223 (easy-menu-remove orgtbl-mode-menu)
11224 (force-mode-line-update 'all))))
11226 (defun org-cleanup-narrow-column-properties ()
11227 "Remove all properties related to narrow-column invisibility."
11228 (let ((s 1))
11229 (while (setq s (text-property-any s (point-max)
11230 'display org-narrow-column-arrow))
11231 (remove-text-properties s (1+ s) '(display t)))
11232 (setq s 1)
11233 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11234 (remove-text-properties s (1+ s) '(org-cwidth t)))
11235 (setq s 1)
11236 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11237 (remove-text-properties s (1+ s) '(invisible t)))))
11239 ;; Install it as a minor mode.
11240 (put 'orgtbl-mode :included t)
11241 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11242 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11244 (defun orgtbl-make-binding (fun n &rest keys)
11245 "Create a function for binding in the table minor mode.
11246 FUN is the command to call inside a table. N is used to create a unique
11247 command name. KEYS are keys that should be checked in for a command
11248 to execute outside of tables."
11249 (eval
11250 (list 'defun
11251 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11252 '(arg)
11254 "Outside of tables, run the binding of `"
11255 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11256 "'.")
11257 '(interactive "p")
11258 (list 'if
11259 '(org-at-table-p)
11260 (list 'call-interactively (list 'quote fun))
11261 (list 'let '(orgtbl-mode)
11262 (list 'call-interactively
11263 (append '(or)
11264 (mapcar (lambda (k)
11265 (list 'key-binding k))
11266 keys)
11267 '('orgtbl-error))))))))
11269 (defun orgtbl-error ()
11270 "Error when there is no default binding for a table key."
11271 (interactive)
11272 (error "This key has no function outside tables"))
11274 (defun orgtbl-setup ()
11275 "Setup orgtbl keymaps."
11276 (let ((nfunc 0)
11277 (bindings
11278 (list
11279 '([(meta shift left)] org-table-delete-column)
11280 '([(meta left)] org-table-move-column-left)
11281 '([(meta right)] org-table-move-column-right)
11282 '([(meta shift right)] org-table-insert-column)
11283 '([(meta shift up)] org-table-kill-row)
11284 '([(meta shift down)] org-table-insert-row)
11285 '([(meta up)] org-table-move-row-up)
11286 '([(meta down)] org-table-move-row-down)
11287 '("\C-c\C-w" org-table-cut-region)
11288 '("\C-c\M-w" org-table-copy-region)
11289 '("\C-c\C-y" org-table-paste-rectangle)
11290 '("\C-c-" org-table-insert-hline)
11291 '("\C-c}" org-table-toggle-coordinate-overlays)
11292 '("\C-c{" org-table-toggle-formula-debugger)
11293 '("\C-m" org-table-next-row)
11294 '([(shift return)] org-table-copy-down)
11295 '("\C-c\C-q" org-table-wrap-region)
11296 '("\C-c?" org-table-field-info)
11297 '("\C-c " org-table-blank-field)
11298 '("\C-c+" org-table-sum)
11299 '("\C-c=" org-table-eval-formula)
11300 '("\C-c'" org-table-edit-formulas)
11301 '("\C-c`" org-table-edit-field)
11302 '("\C-c*" org-table-recalculate)
11303 '("\C-c|" org-table-create-or-convert-from-region)
11304 '("\C-c^" org-table-sort-lines)
11305 '([(control ?#)] org-table-rotate-recalc-marks)))
11306 elt key fun cmd)
11307 (while (setq elt (pop bindings))
11308 (setq nfunc (1+ nfunc))
11309 (setq key (org-key (car elt))
11310 fun (nth 1 elt)
11311 cmd (orgtbl-make-binding fun nfunc key))
11312 (org-defkey orgtbl-mode-map key cmd))
11314 ;; Special treatment needed for TAB and RET
11315 (org-defkey orgtbl-mode-map [(return)]
11316 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11317 (org-defkey orgtbl-mode-map "\C-m"
11318 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11320 (org-defkey orgtbl-mode-map [(tab)]
11321 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11322 (org-defkey orgtbl-mode-map "\C-i"
11323 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11325 (org-defkey orgtbl-mode-map [(shift tab)]
11326 (orgtbl-make-binding 'org-table-previous-field 104
11327 [(shift tab)] [(tab)] "\C-i"))
11329 (org-defkey orgtbl-mode-map "\M-\C-m"
11330 (orgtbl-make-binding 'org-table-wrap-region 105
11331 "\M-\C-m" [(meta return)]))
11332 (org-defkey orgtbl-mode-map [(meta return)]
11333 (orgtbl-make-binding 'org-table-wrap-region 106
11334 [(meta return)] "\M-\C-m"))
11336 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11337 (when orgtbl-optimized
11338 ;; If the user wants maximum table support, we need to hijack
11339 ;; some standard editing functions
11340 (org-remap orgtbl-mode-map
11341 'self-insert-command 'orgtbl-self-insert-command
11342 'delete-char 'org-delete-char
11343 'delete-backward-char 'org-delete-backward-char)
11344 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11345 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11346 '("OrgTbl"
11347 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11348 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11349 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11350 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11351 "--"
11352 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11353 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11354 ["Copy Field from Above"
11355 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11356 "--"
11357 ("Column"
11358 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11359 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11360 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11361 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11362 ("Row"
11363 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11364 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11365 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11366 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11367 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11368 "--"
11369 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11370 ("Rectangle"
11371 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11372 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11373 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11374 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11375 "--"
11376 ("Radio tables"
11377 ["Insert table template" orgtbl-insert-radio-table
11378 (assq major-mode orgtbl-radio-table-templates)]
11379 ["Comment/uncomment table" orgtbl-toggle-comment t])
11380 "--"
11381 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11382 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11383 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11384 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11385 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11386 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11387 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11388 ["Sum Column/Rectangle" org-table-sum
11389 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11390 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11391 ["Debug Formulas"
11392 org-table-toggle-formula-debugger :active (org-at-table-p)
11393 :keys "C-c {"
11394 :style toggle :selected org-table-formula-debug]
11395 ["Show Col/Row Numbers"
11396 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11397 :keys "C-c }"
11398 :style toggle :selected org-table-overlay-coordinates]
11399 ))
11400 t))
11402 (defun orgtbl-ctrl-c-ctrl-c (arg)
11403 "If the cursor is inside a table, realign the table.
11404 It it is a table to be sent away to a receiver, do it.
11405 With prefix arg, also recompute table."
11406 (interactive "P")
11407 (let ((pos (point)) action)
11408 (save-excursion
11409 (beginning-of-line 1)
11413 (cond
11414 ((integerp action)
11415 (goto-char action)
11416 (org-table-maybe-eval-formula)
11417 (if arg
11418 (call-interactively 'org-table-recalculate)
11419 (org-table-maybe-recalculate-line))
11420 (call-interactively 'org-table-align)
11421 (orgtbl-send-table 'maybe))
11422 ((eq action 'recalc)
11423 (save-excursion
11424 (beginning-of-line 1)
11426 (if (org-at-table-p)
11427 (org-call-with-arg 'org-table-recalculate t))))
11428 (t (let (orgtbl-mode)
11429 (call-interactively (key-binding "\C-c\C-c")))))))
11431 (defun orgtbl-tab (arg)
11432 "Justification and field motion for `orgtbl-mode'."
11433 (interactive "P")
11434 (if arg (org-table-edit-field t)
11435 (org-table-justify-field-maybe)
11436 (org-table-next-field)))
11438 (defun orgtbl-ret ()
11439 "Justification and field motion for `orgtbl-mode'."
11440 (interactive)
11441 (org-table-justify-field-maybe)
11442 (org-table-next-row))
11444 (defun orgtbl-self-insert-command (N)
11445 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11446 If the cursor is in a table looking at whitespace, the whitespace is
11447 overwritten, and the table is not marked as requiring realignment."
11448 (interactive "p")
11449 (if (and (org-at-table-p)
11450 (or
11451 (and org-table-auto-blank-field
11452 (member last-command
11453 '(orgtbl-hijacker-command-100
11454 orgtbl-hijacker-command-101
11455 orgtbl-hijacker-command-102
11456 orgtbl-hijacker-command-103
11457 orgtbl-hijacker-command-104
11458 orgtbl-hijacker-command-105))
11459 (org-table-blank-field))
11460 t)
11461 (eq N 1)
11463 (let (org-table-may-need-update)
11464 (goto-char (1- (match-end 0)))
11465 (delete-backward-char 1)
11466 (goto-char (match-beginning 0))
11467 (self-insert-command N))
11468 (setq org-table-may-need-update t)
11469 (let (orgtbl-mode)
11470 (call-interactively (key-binding (vector last-input-event))))))
11472 (defun org-force-self-insert (N)
11473 "Needed to enforce self-insert under remapping."
11474 (interactive "p")
11475 (self-insert-command N))
11478 "Regula expression matching exponentials as produced by calc.")
11480 (defvar org-table-clean-did-remove-column nil)
11482 (defun orgtbl-export (table target)
11483 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11485 org-table-last-alignment org-table-last-column-widths
11486 maxcol column)
11487 (if (not (fboundp func))
11488 (error "Cannot export orgtbl table to %s" target))
11489 (setq lines (org-table-clean-before-export lines))
11490 (setq table
11491 (mapcar
11492 (lambda (x)
11493 (if (string-match org-table-hline-regexp x)
11494 'hline
11496 lines))
11497 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11498 table)))
11499 (loop for i from (1- maxcol) downto 0 do
11500 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11501 (setq column (delq nil column))
11502 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11503 (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))
11504 (funcall func table nil)))
11506 (defun orgtbl-send-table (&optional maybe)
11507 "Send a tranformed version of this table to the receiver position.
11508 With argument MAYBE, fail quietly if no transformation is defined for
11509 this table."
11510 (interactive)
11511 (catch 'exit
11512 (unless (org-at-table-p) (error "Not at a table"))
11513 ;; when non-interactive, we assume align has just happened.
11514 (when (interactive-p) (org-table-align))
11515 (save-excursion
11516 (goto-char (org-table-begin))
11517 (beginning-of-line 0)
11519 (if maybe
11520 (throw 'exit nil)
11521 (error "Don't know how to transform this table."))))
11522 (let* ((name (match-string 1))
11523 beg
11524 (transform (intern (match-string 2)))
11525 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11526 (skip (plist-get params :skip))
11527 (skipcols (plist-get params :skipcols))
11528 (txt (buffer-substring-no-properties
11529 (org-table-begin) (org-table-end)))
11531 (lines (org-table-clean-before-export lines))
11532 (i0 (if org-table-clean-did-remove-column 2 1))
11533 (table (mapcar
11534 (lambda (x)
11535 (if (string-match org-table-hline-regexp x)
11536 'hline
11537 (org-remove-by-index
11539 skipcols i0)))
11540 lines))
11541 (fun (if (= i0 2) 'cdr 'identity))
11542 (org-table-last-alignment
11543 (org-remove-by-index (funcall fun org-table-last-alignment)
11544 skipcols i0))
11545 (org-table-last-column-widths
11546 (org-remove-by-index (funcall fun org-table-last-column-widths)
11547 skipcols i0)))
11549 (unless (fboundp transform)
11550 (error "No such transformation function %s" transform))
11551 (setq txt (funcall transform table params))
11552 ;; Find the insertion place
11553 (save-excursion
11554 (goto-char (point-min))
11555 (unless (re-search-forward
11557 (error "Don't know where to insert translated table"))
11558 (goto-char (match-beginning 0))
11559 (beginning-of-line 2)
11560 (setq beg (point))
11561 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11562 (error "Cannot find end of insertion region"))
11563 (beginning-of-line 1)
11564 (delete-region beg (point))
11565 (goto-char beg)
11567 (message "Table converted and installed at receiver location"))))
11569 (defun org-remove-by-index (list indices &optional i0)
11570 "Remove the elements in LIST with indices in INDICES.
11571 First element has index 0, or I0 if given."
11572 (if (not indices)
11573 list
11574 (if (integerp indices) (setq indices (list indices)))
11575 (setq i0 (1- (or i0 0)))
11576 (delq :rm (mapcar (lambda (x)
11577 (setq i0 (1+ i0))
11578 (if (memq i0 indices) :rm x))
11579 list))))
11581 (defun orgtbl-toggle-comment ()
11582 "Comment or uncomment the orgtbl at point."
11583 (interactive)
11584 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11585 (re2 (concat "^" orgtbl-line-start-regexp))
11586 (commented (save-excursion (beginning-of-line 1)
11587 (cond ((looking-at re1) t)
11588 ((looking-at re2) nil)
11589 (t (error "Not at an org table")))))
11590 (re (if commented re1 re2))
11591 beg end)
11592 (save-excursion
11593 (beginning-of-line 1)
11594 (while (looking-at re) (beginning-of-line 0))
11595 (beginning-of-line 2)
11596 (setq beg (point))
11597 (while (looking-at re) (beginning-of-line 2))
11598 (setq end (point)))
11599 (comment-region beg end (if commented '(4) nil))))
11601 (defun orgtbl-insert-radio-table ()
11602 "Insert a radio table template appropriate for this major mode."
11603 (interactive)
11604 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11605 (txt (nth 1 e))
11606 name pos)
11607 (unless e (error "No radio table setup defined for %s" major-mode))
11608 (setq name (read-string "Table name: "))
11609 (while (string-match "%n" txt)
11610 (setq txt (replace-match name t t txt)))
11612 (setq pos (point))
11613 (insert txt)
11614 (goto-char pos)))
11616 (defun org-get-param (params header i sym &optional hsym)
11617 "Get parameter value for symbol SYM.
11618 If this is a header line, actually get the value for the symbol with an
11620 If the value is a protperty list, get the element for the current column.
11621 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11622 (let ((val (plist-get params sym)))
11623 (and hsym header (setq val (or (plist-get params hsym) val)))
11624 (if (consp val) (plist-get val i) val)))
11626 (defun orgtbl-to-generic (table params)
11627 "Convert the orgtbl-mode TABLE to some other format.
11628 This generic routine can be used for many standard cases.
11629 TABLE is a list, each entry either the symbol `hline' for a horizontal
11630 separator line, or a list of fields for that line.
11631 PARAMS is a property list of parameters that can influence the conversion.
11632 For the generic converter, some parameters are obligatory: You need to
11633 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11634 :splice, you must have :tstart and :tend.
11636 Valid parameters are
11638 :tstart String to start the table. Ignored when :splice is t.
11639 :tend String to end the table. Ignored when :splice is t.
11641 :splice When set to t, return only table body lines, don't wrap
11642 them into :tstart and :tend. Default is nil.
11644 :hline String to be inserted on horizontal separation lines.
11645 May be nil to ignore hlines.
11647 :lstart String to start a new table line.
11648 :lend String to end a table line
11649 :sep Separator between two fields
11650 :lfmt Format for entire line, with enough %s to capture all fields.
11651 If this is present, :lstart, :lend, and :sep are ignored.
11652 :fmt A format to be used to wrap the field, should contain
11653 %s for the original field value. For example, to wrap
11655 This may also be a property list with column numbers and
11658 :hlstart :hlend :hlsep :hlfmt :hfmt
11659 Same as above, specific for the header lines in the table.
11660 All lines before the first hline are treated as header.
11661 If any of these is not present, the data line value is used.
11663 :efmt Use this format to print numbers with exponentials.
11664 The format should have %s twice for inserting mantissa
11666 may also be a property list with column numbers and
11667 formats. :fmt will still be applied after :efmt.
11669 In addition to this, the parameters :skip and :skipcols are always handled
11670 directly by `orgtbl-send-table'. See manual."
11671 (interactive)
11672 (let* ((p params)
11673 (splicep (plist-get p :splice))
11674 (hline (plist-get p :hline))
11675 rtn line i fm efm lfmt h)
11677 ;; Do we have a header?
11678 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11679 (setq h t))
11681 ;; Put header
11682 (unless splicep
11683 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11685 ;; Now loop over all lines
11686 (while (setq line (pop table))
11687 (if (eq line 'hline)
11688 ;; A horizontal separator line
11689 (progn (if hline (push hline rtn))
11690 (setq h nil)) ; no longer in header
11691 ;; A normal line. Convert the fields, push line onto the result list
11692 (setq i 0)
11693 (setq line
11694 (mapcar
11695 (lambda (f)
11696 (setq i (1+ i)
11697 fm (org-get-param p h i :fmt :hfmt)
11698 efm (org-get-param p h i :efmt))
11699 (if (and efm (string-match orgtbl-exp-regexp f))
11700 (setq f (format
11701 efm (match-string 1 f) (match-string 2 f))))
11702 (if fm (setq f (format fm f)))
11703 f)
11704 line))
11705 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11706 (push (apply 'format lfmt line) rtn)
11707 (push (concat
11708 (org-get-param p h i :lstart :hlstart)
11709 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11710 (org-get-param p h i :lend :hlend))
11711 rtn))))
11713 (unless splicep
11714 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11718 (defun orgtbl-to-latex (table params)
11719 "Convert the orgtbl-mode TABLE to LaTeX.
11720 TABLE is a list, each entry either the symbol `hline' for a horizontal
11721 separator line, or a list of fields for that line.
11722 PARAMS is a property list of parameters that can influence the conversion.
11723 Supports all parameters from `orgtbl-to-generic'. Most important for
11724 LaTeX are:
11726 :splice When set to t, return only table body lines, don't wrap
11727 them into a tabular environment. Default is nil.
11729 :fmt A format to be used to wrap the field, should contain %s for the
11730 original field value. For example, to wrap everything in dollars,
11734 :efmt Format for transforming numbers with exponentials. The format
11735 should have %s twice for inserting mantissa and exponent, for
11737 This may also be a property list with column numbers and formats.
11739 The general parameters :skip and :skipcols have already been applied when
11740 this function is called."
11741 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11742 org-table-last-alignment ""))
11743 (params2
11744 (list
11749 (orgtbl-to-generic table (org-combine-plists params2 params))))
11751 (defun orgtbl-to-html (table params)
11752 "Convert the orgtbl-mode TABLE to LaTeX.
11753 TABLE is a list, each entry either the symbol `hline' for a horizontal
11754 separator line, or a list of fields for that line.
11755 PARAMS is a property list of parameters that can influence the conversion.
11756 Currently this function recognizes the following parameters:
11758 :splice When set to t, return only table body lines, don't wrap
11759 them into a <table> environment. Default is nil.
11761 The general parameters :skip and :skipcols have already been applied when
11762 this function is called. The function does *not* use `orgtbl-to-generic',
11763 so you cannot specify parameters for it."
11764 (let* ((splicep (plist-get params :splice))
11765 html)
11766 ;; Just call the formatter we already have
11767 ;; We need to make text lines for it, so put the fields back together.
11768 (setq html (org-format-org-table-html
11769 (mapcar
11770 (lambda (x)
11771 (if (eq x 'hline)
11772 "|----+----|"
11773 (concat "| " (mapconcat 'identity x " | ") " |")))
11774 table)
11775 splicep))
11777 (setq html (replace-match "" t t html)))
11778 html))
11780 (defun orgtbl-to-texinfo (table params)
11781 "Convert the orgtbl-mode TABLE to TeXInfo.
11782 TABLE is a list, each entry either the symbol `hline' for a horizontal
11783 separator line, or a list of fields for that line.
11784 PARAMS is a property list of parameters that can influence the conversion.
11785 Supports all parameters from `orgtbl-to-generic'. Most important for
11786 TeXInfo are:
11788 :splice nil/t When set to t, return only table body lines, don't wrap
11789 them into a multitable environment. Default is nil.
11791 :fmt fmt A format to be used to wrap the field, should contain
11792 %s for the original field value. For example, to wrap
11794 This may also be a property list with column numbers and
11798 are computed automatically from the width of the columns
11799 under org-mode.
11801 The general parameters :skip and :skipcols have already been applied when
11802 this function is called."
11803 (let* ((total (float (apply '+ org-table-last-column-widths)))
11804 (colfrac (or (plist-get params :cf)
11805 (mapconcat
11806 (lambda (x) (format "%.3f" (/ (float x) total)))
11807 org-table-last-column-widths " ")))
11808 (params2
11809 (list
11810 :tstart (concat "@multitable @columnfractions " colfrac)
11811 :tend "@end multitable"
11812 :lstart "@item " :lend "" :sep " @tab "
11813 :hlstart "@headitem ")))
11814 (orgtbl-to-generic table (org-combine-plists params2 params))))
11816 ;;;; Link Stuff
11818 ;;; Link abbreviations
11820 (defun org-link-expand-abbrev (link)
11821 "Apply replacements as defined in `org-link-abbrev-alist."
11823 (let* ((key (match-string 1 link))
11824 (as (or (assoc key org-link-abbrev-alist-local)
11825 (assoc key org-link-abbrev-alist)))
11826 (tag (and (match-end 2) (match-string 3 link)))
11827 rpl)
11828 (if (not as)
11829 link
11830 (setq rpl (cdr as))
11831 (cond
11832 ((symbolp rpl) (funcall rpl tag))
11833 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11834 (t (concat rpl tag)))))
11835 link))
11837 ;;; Storing and inserting links
11839 (defvar org-insert-link-history nil
11840 "Minibuffer history for links inserted with `org-insert-link'.")
11842 (defvar org-stored-links nil
11843 "Contains the links stored with `org-store-link'.")
11845 (defvar org-store-link-plist nil
11846 "Plist with info about the most recently link created with `org-store-link'.")
11848 (defvar org-link-protocols nil
11849 "Link protocols added to Org-mode using `org-add-link-type'.")
11851 (defvar org-store-link-functions nil
11852 "List of functions that are called to create and store a link.
11853 Each function will be called in turn until one returns a non-nil
11854 value. Each function should check if it is responsible for creating
11855 this link (for example by looking at the major mode).
11856 If not, it must exit and return nil.
11857 If yes, it should return a non-nil value after a calling
11858 `org-store-link-props' with a list of properties and values.
11859 Special properties are:
11863 This is obligatory as well.
11864 :description Optional default description for the second pair
11865 of brackets in an Org-mode link. The user can still change
11866 this when inserting this link into an Org-mode buffer.
11868 In addition to these, any additional properties can be specified
11869 and then used in remember templates.")
11871 (defun org-add-link-type (type &optional follow publish)
11872 "Add TYPE to the list of `org-link-types'.
11873 Re-compute all regular expressions depending on `org-link-types'
11874 FOLLOW and PUBLISH are two functions. Both take the link path as
11875 an argument.
11876 FOLLOW should do whatever is necessary to follow the link, for example
11877 to find a file or display a mail message.
11879 PUBLISH takes the path and retuns the string that should be used when
11880 this document is published. FIMXE: This is actually not yet implemented."
11881 (add-to-list 'org-link-types type t)
11882 (org-make-link-regexps)
11883 (add-to-list 'org-link-protocols
11884 (list type follow publish)))
11886 (defun org-add-agenda-custom-command (entry)
11887 "Replace or add a command in `org-agenda-custom-commands'.
11888 This is mostly for hacking and trying a new command - once the command
11889 works you probably want to add it to `org-agenda-custom-commands' for good."
11890 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11891 (if ass
11892 (setcdr ass (cdr entry))
11893 (push entry org-agenda-custom-commands))))
11895 ;;;###autoload
11896 (defun org-store-link (arg)
11898 This link can later be inserted into an org-buffer with
11900 For some link types, a prefix arg is interpreted:
11901 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11902 For file links, arg negates `org-context-in-file-links'."
11903 (interactive "P")
11904 (setq org-store-link-plist nil) ; reset
11905 (let (link cpltxt desc description search txt)
11906 (cond
11908 ((run-hook-with-args-until-success 'org-store-link-functions)
11909 (setq link (plist-get org-store-link-plist :link)
11910 desc (or (plist-get org-store-link-plist :description) link)))
11912 ((eq major-mode 'bbdb-mode)
11913 (let ((name (bbdb-record-name (bbdb-current-record)))
11914 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11915 (setq cpltxt (concat "bbdb:" (or name company))
11916 link (org-make-link cpltxt))
11917 (org-store-link-props :type "bbdb" :name name :company company)))
11919 ((eq major-mode 'Info-mode)
11920 (setq link (org-make-link "info:"
11921 (file-name-nondirectory Info-current-file)
11922 ":" Info-current-node))
11923 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11924 ":" Info-current-node))
11925 (org-store-link-props :type "info" :file Info-current-file
11926 :node Info-current-node))
11928 ((eq major-mode 'calendar-mode)
11929 (let ((cd (calendar-cursor-to-date)))
11930 (setq link
11931 (format-time-string
11932 (car org-time-stamp-formats)
11933 (apply 'encode-time
11934 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11935 nil nil nil))))
11936 (org-store-link-props :type "calendar" :date cd)))
11938 ((or (eq major-mode 'vm-summary-mode)
11939 (eq major-mode 'vm-presentation-mode))
11940 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11941 (vm-follow-summary-cursor)
11942 (save-excursion
11943 (vm-select-folder-buffer)
11944 (let* ((message (car vm-message-pointer))
11945 (folder buffer-file-name)
11946 (subject (vm-su-subject message))
11947 (to (vm-get-header-contents message "To"))
11948 (from (vm-get-header-contents message "From"))
11949 (message-id (vm-su-message-id message)))
11950 (org-store-link-props :type "vm" :from from :to to :subject subject
11951 :message-id message-id)
11952 (setq message-id (org-remove-angle-brackets message-id))
11953 (setq folder (abbreviate-file-name folder))
11954 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11955 folder)
11956 (setq folder (replace-match "" t t folder)))
11957 (setq cpltxt (org-email-link-description))
11958 (setq link (org-make-link "vm:" folder "#" message-id)))))
11960 ((eq major-mode 'wl-summary-mode)
11961 (let* ((msgnum (wl-summary-message-number))
11962 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11963 msgnum 'message-id))
11964 (wl-message-entity
11965 (if (fboundp 'elmo-message-entity)
11966 (elmo-message-entity
11967 wl-summary-buffer-elmo-folder msgnum)
11968 (elmo-msgdb-overview-get-entity
11969 msgnum (wl-summary-buffer-msgdb))))
11970 (from (wl-summary-line-from))
11971 (to (car (elmo-message-entity-field wl-message-entity 'to)))
11972 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11973 (wl-summary-line-subject))))
11974 (org-store-link-props :type "wl" :from from :to to
11975 :subject subject :message-id message-id)
11976 (setq message-id (org-remove-angle-brackets message-id))
11977 (setq cpltxt (org-email-link-description))
11978 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11979 "#" message-id))))
11981 ((or (equal major-mode 'mh-folder-mode)
11982 (equal major-mode 'mh-show-mode))
11983 (let ((from (org-mhe-get-header "From:"))
11984 (to (org-mhe-get-header "To:"))
11985 (message-id (org-mhe-get-header "Message-Id:"))
11986 (subject (org-mhe-get-header "Subject:")))
11987 (org-store-link-props :type "mh" :from from :to to
11988 :subject subject :message-id message-id)
11989 (setq cpltxt (org-email-link-description))
11990 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11991 (org-remove-angle-brackets message-id)))))
11993 ((eq major-mode 'rmail-mode)
11994 (save-excursion
11995 (save-restriction
11996 (rmail-narrow-to-non-pruned-header)
11997 (let ((folder buffer-file-name)
11998 (message-id (mail-fetch-field "message-id"))
11999 (from (mail-fetch-field "from"))
12000 (to (mail-fetch-field "to"))
12001 (subject (mail-fetch-field "subject")))
12002 (org-store-link-props
12003 :type "rmail" :from from :to to
12004 :subject subject :message-id message-id)
12005 (setq message-id (org-remove-angle-brackets message-id))
12006 (setq cpltxt (org-email-link-description))
12007 (setq link (org-make-link "rmail:" folder "#" message-id))))))
12009 ((eq major-mode 'gnus-group-mode)
12010 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12011 (gnus-group-group-name)) ; version
12012 ((fboundp 'gnus-group-name)
12013 (gnus-group-name))
12014 (t "???"))))
12015 (unless group (error "Not on a group"))
12016 (org-store-link-props :type "gnus" :group group)
12017 (setq cpltxt (concat
12018 (if (org-xor arg org-usenet-links-prefer-google)
12019 "http://groups.google.com/groups?group="
12020 "gnus:")
12021 group)
12022 link (org-make-link cpltxt))))
12024 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12025 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12026 (let* ((group gnus-newsgroup-name)
12027 (article (gnus-summary-article-number))
12028 (header (gnus-summary-article-header article))
12029 (from (mail-header-from header))
12030 (message-id (mail-header-id header))
12031 (date (mail-header-date header))
12032 (subject (gnus-summary-subject-string)))
12033 (org-store-link-props :type "gnus" :from from :subject subject
12034 :message-id message-id :group group)
12035 (setq cpltxt (org-email-link-description))
12036 (if (org-xor arg org-usenet-links-prefer-google)
12037 (setq link
12038 (concat
12040 (format "http://groups.google.com/groups?as_umsgid=%s"
12041 (org-fixup-message-id-for-http message-id))))
12042 (setq link (org-make-link "gnus:" group
12043 "#" (number-to-string article))))))
12045 ((eq major-mode 'w3-mode)
12046 (setq cpltxt (url-view-url t)
12047 link (org-make-link cpltxt))
12048 (org-store-link-props :type "w3" :url (url-view-url t)))
12050 ((eq major-mode 'w3m-mode)
12051 (setq cpltxt (or w3m-current-title w3m-current-url)
12052 link (org-make-link w3m-current-url))
12053 (org-store-link-props :type "w3m" :url (url-view-url t)))
12055 ((setq search (run-hook-with-args-until-success
12056 'org-create-file-search-functions))
12057 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12058 "::" search))
12059 (setq cpltxt (or description link)))
12061 ((eq major-mode 'image-mode)
12062 (setq cpltxt (concat "file:"
12063 (abbreviate-file-name buffer-file-name))
12064 link (org-make-link cpltxt))
12065 (org-store-link-props :type "image" :file buffer-file-name))
12067 ((eq major-mode 'dired-mode)
12068 ;; link to the file in the current line
12069 (setq cpltxt (concat "file:"
12070 (abbreviate-file-name
12071 (expand-file-name
12072 (dired-get-filename nil t))))
12073 link (org-make-link cpltxt)))
12075 ((and buffer-file-name (org-mode-p))
12076 ;; Just link to current headline
12077 (setq cpltxt (concat "file:"
12078 (abbreviate-file-name buffer-file-name)))
12079 ;; Add a context search string
12080 (when (org-xor org-context-in-file-links arg)
12081 ;; Check if we are on a target
12083 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12084 (setq txt (cond
12085 ((org-on-heading-p) nil)
12086 ((org-region-active-p)
12087 (buffer-substring (region-beginning) (region-end)))
12088 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12090 (setq cpltxt
12091 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12092 desc "NONE"))))
12094 (setq cpltxt (substring cpltxt 0 -2)))
12095 (setq link (org-make-link cpltxt)))
12097 ((buffer-file-name (buffer-base-buffer))
12098 ;; Just link to this file here.
12099 (setq cpltxt (concat "file:"
12100 (abbreviate-file-name
12101 (buffer-file-name (buffer-base-buffer)))))
12102 ;; Add a context string
12103 (when (org-xor org-context-in-file-links arg)
12104 (setq txt (if (org-region-active-p)
12105 (buffer-substring (region-beginning) (region-end))
12106 (buffer-substring (point-at-bol) (point-at-eol))))
12107 ;; Only use search option if there is some text.
12109 (setq cpltxt
12110 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12111 desc "NONE")))
12112 (setq link (org-make-link cpltxt)))
12114 ((interactive-p)
12115 (error "Cannot link to a buffer which is not visiting a file"))
12117 (t (setq link nil)))
12119 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12120 (setq link (or link cpltxt)
12121 desc (or desc cpltxt))
12122 (if (equal desc "NONE") (setq desc nil))
12124 (if (and (interactive-p) link)
12125 (progn
12126 (setq org-stored-links
12127 (cons (list link desc) org-stored-links))
12128 (message "Stored: %s" (or desc link)))
12129 (and link (org-make-link-string link desc)))))
12131 (defun org-store-link-props (&rest plist)
12132 "Store link properties, extract names and addresses."
12133 (let (x adr)
12134 (when (setq x (plist-get plist :from))
12135 (setq adr (mail-extract-address-components x))
12136 (plist-put plist :fromname (car adr))
12137 (plist-put plist :fromaddress (nth 1 adr)))
12138 (when (setq x (plist-get plist :to))
12139 (setq adr (mail-extract-address-components x))
12140 (plist-put plist :toname (car adr))
12141 (plist-put plist :toaddress (nth 1 adr))))
12142 (let ((from (plist-get plist :from))
12143 (to (plist-get plist :to)))
12144 (when (and from to org-from-is-user-regexp)
12145 (plist-put plist :fromto
12146 (if (string-match org-from-is-user-regexp from)
12147 (concat "to %t")
12148 (concat "from %f")))))
12149 (setq org-store-link-plist plist))
12151 (defun org-email-link-description (&optional fmt)
12152 "Return the description part of an email link.
12153 This takes information from `org-store-link-plist' and formats it
12154 according to FMT (default from `org-email-link-description-format')."
12155 (setq fmt (or fmt org-email-link-description-format))
12156 (let* ((p org-store-link-plist)
12157 (to (plist-get p :toaddress))
12158 (from (plist-get p :fromaddress))
12159 (table
12160 (list
12161 (cons "%c" (plist-get p :fromto))
12162 (cons "%F" (plist-get p :from))
12163 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12164 (cons "%T" (plist-get p :to))
12165 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12166 (cons "%s" (plist-get p :subject))
12167 (cons "%m" (plist-get p :message-id)))))
12168 (when (string-match "%c" fmt)
12169 ;; Check if the user wrote this message
12170 (if (and org-from-is-user-regexp from to
12171 (save-match-data (string-match org-from-is-user-regexp from)))
12172 (setq fmt (replace-match "to %t" t t fmt))
12173 (setq fmt (replace-match "from %f" t t fmt))))
12174 (org-replace-escapes fmt table)))
12176 (defun org-make-org-heading-search-string (&optional string heading)
12177 "Make search string for STRING or current headline."
12178 (interactive)
12179 (let ((s (or string (org-get-heading))))
12180 (unless (and string (not heading))
12181 ;; We are using a headline, clean up garbage in there.
12182 (if (string-match org-todo-regexp s)
12183 (setq s (replace-match "" t t s)))
12185 (setq s (replace-match "" t t s)))
12186 (setq s (org-trim s))
12189 (setq s (replace-match "" t t s)))
12190 (while (string-match org-ts-regexp s)
12191 (setq s (replace-match "" t t s))))
12193 (setq s (replace-match " " t t s)))
12194 (or string (setq s (concat "*" s))) ; Add * for headlines
12197 (defun org-make-link (&rest strings)
12198 "Concatenate STRINGS."
12199 (apply 'concat strings))
12201 (defun org-make-link-string (link &optional description)
12202 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12204 (error "Empty link"))
12205 (when (stringp description)
12206 ;; Remove brackets from the description, they are fatal.
12208 (setq description (replace-match "{" t t description)))
12210 (setq description (replace-match "}" t t description))))
12211 (when (equal (org-link-escape link) description)
12212 ;; No description needed, it is identical
12213 (setq description nil))
12214 (when (and (not description)
12215 (not (equal link (org-link-escape link))))
12216 (setq description link))
12217 (concat "[[" (org-link-escape link) "]"
12218 (if description (concat "[" description "]") "")
12219 "]"))
12221 (defconst org-link-escape-chars
12222 '((?\ . "%20")
12223 (?\[ . "%5B")
12224 (?\] . "%5D")
12235 (?\; . "%3B")
12236 (?? . "%3F")
12237 (?= . "%3D")
12238 (?+ . "%2B")
12239 )
12240 "Association list of escapes for some characters problematic in links.
12241 This is the list that is used for internal purposes.")
12243 (defconst org-link-escape-chars-browser
12244 '((?\ . "%20")) ; 32 for the SPC char
12245 "Association list of escapes for some characters problematic in links.
12246 This is the list that is used before handing over to the browser.")
12248 (defun org-link-escape (text &optional table)
12249 "Escape charaters in TEXT that are problematic for links."
12250 (setq table (or table org-link-escape-chars))
12251 (when text
12252 (let ((re (mapconcat (lambda (x) (regexp-quote
12253 (char-to-string (car x))))
12255 (while (string-match re text)
12256 (setq text
12257 (replace-match
12258 (cdr (assoc (string-to-char (match-string 0 text))
12259 table))
12260 t t text)))
12261 text)))
12263 (defun org-link-unescape (text &optional table)
12264 "Reverse the action of `org-link-escape'."
12265 (setq table (or table org-link-escape-chars))
12266 (when text
12267 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12269 (while (string-match re text)
12270 (setq text
12271 (replace-match
12272 (char-to-string (car (rassoc (match-string 0 text) table)))
12273 t t text)))
12274 text)))
12276 (defun org-xor (a b)
12277 "Exclusive or."
12278 (if a (not b) b))
12280 (defun org-get-header (header)
12281 "Find a header field in the current buffer."
12282 (save-excursion
12283 (goto-char (point-min))
12284 (let ((case-fold-search t) s)
12285 (cond
12286 ((eq header 'from)
12288 (setq s (match-string 1)))
12290 (setq s (replace-match "" t t s)))
12291 (if (string-match "[<(].*" s)
12292 (setq s (replace-match "" t t s))))
12293 ((eq header 'message-id)
12295 (setq s (match-string 1))))
12296 ((eq header 'subject)
12298 (setq s (match-string 1)))))
12301 s)))
12304 (defun org-fixup-message-id-for-http (s)
12305 "Replace special characters in a message id, so it can be used in an http query."
12306 (while (string-match "<" s)
12307 (setq s (replace-match "%3C" t t s)))
12308 (while (string-match ">" s)
12309 (setq s (replace-match "%3E" t t s)))
12310 (while (string-match "@" s)
12311 (setq s (replace-match "%40" t t s)))
12312 s)
12314 ;;;###autoload
12315 (defun org-insert-link-global ()
12316 "Insert a link like Org-mode does.
12317 This command can be called in any mode to insert a link in Org-mode syntax."
12318 (interactive)
12319 (org-run-like-in-org-mode 'org-insert-link))
12321 (defun org-insert-link (&optional complete-file)
12322 "Insert a link. At the prompt, enter the link.
12324 Completion can be used to select a link previously stored with
12325 `org-store-link'. When the empty string is entered (i.e. if you just
12326 press RET at the prompt), the link defaults to the most recently
12327 stored link. As SPC triggers completion in the minibuffer, you need to
12328 use M-SPC or C-q SPC to force the insertion of a space character.
12330 You will also be prompted for a description, and if one is given, it will
12331 be displayed in the buffer instead of the link.
12333 If there is already a link at point, this command will allow you to edit link
12334 and description parts.
12337 selected using completion. The path to the file will be relative to
12338 the current directory if the file is in the current directory or a
12339 subdirectory. Otherwise, the link will be the absolute path as
12340 completed in the minibuffer (i.e. normally ~/path/to/file).
12343 is in the current directory or below.
12345 `org-keep-stored-link-after-insertion'."
12346 (interactive "P")
12347 (let* ((wcf (current-window-configuration))
12348 (region (if (org-region-active-p)
12349 (buffer-substring (region-beginning) (region-end))))
12350 (remove (and region (list (region-beginning) (region-end))))
12351 (desc region)
12352 tmphist ; byte-compile incorrectly complains about this
12353 link entry file)
12354 (cond
12355 ((org-in-regexp org-bracket-link-regexp 1)
12356 ;; We do have a link at point, and we are going to edit it.
12357 (setq remove (list (match-beginning 0) (match-end 0)))
12358 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12359 (setq link (read-string "Link: "
12360 (org-link-unescape
12361 (org-match-string-no-properties 1)))))
12362 ((or (org-in-regexp org-angle-link-re)
12363 (org-in-regexp org-plain-link-re))
12364 ;; Convert to bracket link
12365 (setq remove (list (match-beginning 0) (match-end 0))
12366 link (read-string "Link: "
12367 (org-remove-angle-brackets (match-string 0)))))
12368 ((equal complete-file '(4))
12369 ;; Completing read for file names.
12370 (setq file (read-file-name "File: "))
12371 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12372 (pwd1 (file-name-as-directory (abbreviate-file-name
12373 (expand-file-name ".")))))
12374 (cond
12375 ((equal complete-file '(16))
12376 (setq link (org-make-link
12377 "file:"
12378 (abbreviate-file-name (expand-file-name file)))))
12380 (setq link (org-make-link "file:" (match-string 1 file))))
12382 (expand-file-name file))
12383 (setq link (org-make-link
12384 "file:" (match-string 1 (expand-file-name file)))))
12385 (t (setq link (org-make-link "file:" file))))))
12386 (t
12387 ;; Read link, with completion for stored links.
12388 (with-output-to-temp-buffer "*Org Links*"
12390 (when org-stored-links
12392 (princ (mapconcat
12393 (lambda (x)
12394 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12396 (let ((cw (selected-window)))
12397 (select-window (get-buffer-window "*Org Links*"))
12398 (shrink-window-if-larger-than-buffer)
12399 (setq truncate-lines t)
12400 (select-window cw))
12401 ;; Fake a link history, containing the stored links.
12402 (setq tmphist (append (mapcar 'car org-stored-links)
12403 org-insert-link-history))
12404 (unwind-protect
12405 (setq link (org-completing-read
12406 "Link: "
12407 (append
12408 (mapcar (lambda (x) (list (concat (car x) ":")))
12409 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12410 (mapcar (lambda (x) (list (concat x ":")))
12411 org-link-types))
12412 nil nil nil
12413 'tmphist
12414 (or (car (car org-stored-links)))))
12415 (set-window-configuration wcf)
12416 (kill-buffer "*Org Links*"))
12417 (setq entry (assoc link org-stored-links))
12418 (or entry (push link org-insert-link-history))
12419 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12420 (not org-keep-stored-link-after-insertion))
12421 (setq org-stored-links (delq (assoc link org-stored-links)
12422 org-stored-links)))
12423 (setq desc (or desc (nth 1 entry)))))
12425 (if (string-match org-plain-link-re link)
12426 ;; URL-like link, normalize the use of angular brackets.
12427 (setq link (org-make-link (org-remove-angle-brackets link))))
12429 ;; Check if we are linking to the current file with a search option
12430 ;; If yes, simplify the link by using only the search option.
12431 (when (and buffer-file-name
12433 (let* ((path (match-string 1 link))
12434 (case-fold-search nil)
12435 (search (match-string 2 link)))
12436 (save-match-data
12437 (if (equal (file-truename buffer-file-name) (file-truename path))
12438 ;; We are linking to this same file, with a search option
12439 (setq link search)))))
12441 ;; Check if we can/should use a relative path. If yes, simplify the link
12443 (let* ((path (match-string 1 link))
12444 (origpath path)
12445 (desc-is-link (equal link desc))
12446 (case-fold-search nil))
12447 (cond
12448 ((eq org-link-file-path-type 'absolute)
12449 (setq path (abbreviate-file-name (expand-file-name path))))
12450 ((eq org-link-file-path-type 'noabbrev)
12451 (setq path (expand-file-name path)))
12452 ((eq org-link-file-path-type 'relative)
12453 (setq path (file-relative-name path)))
12454 (t
12455 (save-match-data
12456 (if (string-match (concat "^" (regexp-quote
12457 (file-name-as-directory
12458 (expand-file-name "."))))
12459 (expand-file-name path))
12460 ;; We are linking a file with relative path name.
12461 (setq path (substring (expand-file-name path)
12462 (match-end 0)))))))
12463 (setq link (concat "file:" path))
12464 (if (equal desc origpath)
12465 (setq desc path))))
12467 (setq desc (read-string "Description: " desc))
12469 (if remove (apply 'delete-region remove))
12470 (insert (org-make-link-string link desc))))
12472 (defun org-completing-read (&rest args)
12473 (let ((minibuffer-local-completion-map
12474 (copy-keymap minibuffer-local-completion-map)))
12475 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12476 (apply 'completing-read args)))
12478 ;;; Opening/following a link
12479 (defvar org-link-search-failed nil)
12481 (defun org-next-link ()
12482 "Move forward to the next link.
12483 If the link is in hidden text, expose it."
12484 (interactive)
12485 (when (and org-link-search-failed (eq this-command last-command))
12486 (goto-char (point-min))
12487 (message "Link search wrapped back to beginning of buffer"))
12488 (setq org-link-search-failed nil)
12489 (let* ((pos (point))
12490 (ct (org-context))
12491 (a (assoc :link ct)))
12492 (if a (goto-char (nth 2 a)))
12493 (if (re-search-forward org-any-link-re nil t)
12494 (progn
12495 (goto-char (match-beginning 0))
12496 (if (org-invisible-p) (org-show-context)))
12497 (goto-char pos)
12498 (setq org-link-search-failed t)
12499 (error "No further link found"))))
12501 (defun org-previous-link ()
12502 "Move backward to the previous link.
12503 If the link is in hidden text, expose it."
12504 (interactive)
12505 (when (and org-link-search-failed (eq this-command last-command))
12506 (goto-char (point-max))
12507 (message "Link search wrapped back to end of buffer"))
12508 (setq org-link-search-failed nil)
12509 (let* ((pos (point))
12510 (ct (org-context))
12511 (a (assoc :link ct)))
12512 (if a (goto-char (nth 1 a)))
12513 (if (re-search-backward org-any-link-re nil t)
12514 (progn
12515 (goto-char (match-beginning 0))
12516 (if (org-invisible-p) (org-show-context)))
12517 (goto-char pos)
12518 (setq org-link-search-failed t)
12519 (error "No further link found"))))
12521 (defun org-find-file-at-mouse (ev)
12522 "Open file link or URL at mouse."
12523 (interactive "e")
12524 (mouse-set-point ev)
12525 (org-open-at-point 'in-emacs))
12527 (defun org-open-at-mouse (ev)
12528 "Open file link or URL at mouse."
12529 (interactive "e")
12530 (mouse-set-point ev)
12531 (org-open-at-point))
12533 (defvar org-window-config-before-follow-link nil
12534 "The window configuration before following a link.
12535 This is saved in case the need arises to restore it.")
12537 (defvar org-open-link-marker (make-marker)
12538 "Marker pointing to the location where `org-open-at-point; was called.")
12540 ;;;###autoload
12541 (defun org-open-at-point-global ()
12542 "Follow a link like Org-mode does.
12543 This command can be called in any mode to follow a link that has
12544 Org-mode syntax."
12545 (interactive)
12546 (org-run-like-in-org-mode 'org-open-at-point))
12548 (defun org-open-at-point (&optional in-emacs)
12549 "Open link at or after point.
12550 If there is no link at point, this function will search forward up to
12551 the end of the current subtree.
12552 Normally, files will be opened by an appropriate application. If the
12553 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12554 (interactive "P")
12555 (catch 'abort
12556 (move-marker org-open-link-marker (point))
12557 (setq org-window-config-before-follow-link (current-window-configuration))
12558 (org-remove-occur-highlights nil nil t)
12559 (if (org-at-timestamp-p t)
12560 (org-follow-timestamp-link)
12561 (let (type path link line search (pos (point)))
12562 (catch 'match
12563 (save-excursion
12565 (when (org-in-regexp org-bracket-link-regexp)
12566 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12568 (setq link (replace-match " " t t link)))
12569 (setq link (org-link-expand-abbrev link))
12570 (if (string-match org-link-re-with-space2 link)
12571 (setq type (match-string 1 link) path (match-string 2 link))
12572 (setq type "thisfile" path link))
12573 (throw 'match t)))
12575 (when (get-text-property (point) 'org-linked-text)
12576 (setq type "thisfile"
12577 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12578 (1+ (point)) (point))
12579 path (buffer-substring
12580 (previous-single-property-change pos 'org-linked-text)
12581 (next-single-property-change pos 'org-linked-text)))
12582 (throw 'match t))
12584 (save-excursion
12585 (when (or (org-in-regexp org-angle-link-re)
12586 (org-in-regexp org-plain-link-re))
12587 (setq type (match-string 1) path (match-string 2))
12588 (throw 'match t)))
12590 (setq type "tree-match"
12591 path (match-string 1))
12592 (throw 'match t))
12593 (save-excursion
12595 (setq type "tags"
12596 path (match-string 1))
12597 (while (string-match ":" path)
12598 (setq path (replace-match "+" t t path)))
12599 (throw 'match t))))
12600 (unless path
12601 (error "No link found"))
12602 ;; Remove any trailing spaces in path
12604 (setq path (replace-match "" t t path)))
12606 (cond
12608 ((assoc type org-link-protocols)
12609 (funcall (nth 1 (assoc type org-link-protocols)) path))
12611 ((equal type "mailto")
12612 (let ((cmd (car org-link-mailto-program))
12613 (args (cdr org-link-mailto-program)) args1
12614 (address path) (subject "") a)
12616 (setq address (match-string 1 path)
12617 subject (org-link-escape (match-string 2 path))))
12618 (while args
12619 (cond
12620 ((not (stringp (car args))) (push (pop args) args1))
12621 (t (setq a (pop args))
12622 (if (string-match "%a" a)
12623 (setq a (replace-match address t t a)))
12624 (if (string-match "%s" a)
12625 (setq a (replace-match subject t t a)))
12626 (push a args1))))
12627 (apply cmd (nreverse args1))))
12629 ((member type '("http" "https" "ftp" "news"))
12630 (browse-url (concat type ":" (org-link-escape
12631 path org-link-escape-chars-browser))))
12633 ((member type '("message"))
12634 (browse-url (concat type ":" path)))
12636 ((string= type "tags")
12637 (org-tags-view in-emacs path))
12638 ((string= type "thisfile")
12639 (if in-emacs
12640 (switch-to-buffer-other-window
12641 (org-get-buffer-for-internal-link (current-buffer)))
12642 (org-mark-ring-push))
12643 (let ((cmd `(org-link-search
12644 ,path
12645 ,(cond ((equal in-emacs '(4)) 'occur)
12646 ((equal in-emacs '(16)) 'org-occur)
12647 (t nil))
12648 ,pos)))
12649 (condition-case nil (eval cmd)
12650 (error (progn (widen) (eval cmd))))))
12652 ((string= type "tree-match")
12655 ((string= type "file")
12657 (setq line (string-to-number (match-string 1 path))
12658 path (substring path 0 (match-beginning 0)))
12660 (setq search (match-string 1 path)
12661 path (substring path 0 (match-beginning 0)))))
12662 (if (string-match "[*?{]" (file-name-nondirectory path))
12663 (dired path)
12664 (org-open-file path in-emacs line search)))
12666 ((string= type "news")
12667 (org-follow-gnus-link path))
12669 ((string= type "bbdb")
12670 (org-follow-bbdb-link path))
12672 ((string= type "info")
12673 (org-follow-info-link path))
12675 ((string= type "gnus")
12676 (let (group article)
12678 (error "Error in Gnus link"))
12679 (setq group (match-string 1 path)
12680 article (match-string 3 path))
12681 (org-follow-gnus-link group article)))
12683 ((string= type "vm")
12684 (let (folder article)
12686 (error "Error in VM link"))
12687 (setq folder (match-string 1 path)
12688 article (match-string 3 path))
12689 ;; in-emacs is the prefix arg, will be interpreted as read-only
12690 (org-follow-vm-link folder article in-emacs)))
12692 ((string= type "wl")
12693 (let (folder article)
12695 (error "Error in Wanderlust link"))
12696 (setq folder (match-string 1 path)
12697 article (match-string 3 path))
12698 (org-follow-wl-link folder article)))
12700 ((string= type "mhe")
12701 (let (folder article)
12703 (error "Error in MHE link"))
12704 (setq folder (match-string 1 path)
12705 article (match-string 3 path))
12706 (org-follow-mhe-link folder article)))
12708 ((string= type "rmail")
12709 (let (folder article)
12711 (error "Error in RMAIL link"))
12712 (setq folder (match-string 1 path)
12713 article (match-string 3 path))
12714 (org-follow-rmail-link folder article)))
12716 ((string= type "shell")
12717 (let ((cmd path))
12718 (if (or (not org-confirm-shell-link-function)
12719 (funcall org-confirm-shell-link-function
12721 (org-add-props cmd nil
12722 'face 'org-warning))))
12723 (progn
12724 (message "Executing %s" cmd)
12725 (shell-command cmd))
12726 (error "Abort"))))
12728 ((string= type "elisp")
12729 (let ((cmd path))
12730 (if (or (not org-confirm-elisp-link-function)
12731 (funcall org-confirm-elisp-link-function
12733 (org-add-props cmd nil
12734 'face 'org-warning))))
12735 (message "%s => %s" cmd (eval (read cmd)))
12736 (error "Abort"))))
12738 (t
12739 (browse-url-at-point)))))
12740 (move-marker org-open-link-marker nil)))
12742 ;;; File search
12744 (defvar org-create-file-search-functions nil
12745 "List of functions to construct the right search string for a file link.
12746 These functions are called in turn with point at the location to
12747 which the link should point.
12749 A function in the hook should first test if it would like to
12750 handle this file type, for example by checking the major-mode or
12751 the file extension. If it decides not to handle this file, it
12752 should just return nil to give other functions a chance. If it
12753 does handle the file, it must return the search string to be used
12754 when following the link. The search string will be part of the
12755 file link, given after a double colon, and `org-open-at-point'
12756 will automatically search for it. If special measures must be
12757 taken to make the search successful, another function should be
12758 added to the companion hook `org-execute-file-search-functions',
12759 which see.
12761 A function in this hook may also use `setq' to set the variable
12762 `description' to provide a suggestion for the descriptive text to
12763 be used for this link when it gets inserted into an Org-mode
12766 (defvar org-execute-file-search-functions nil
12767 "List of functions to execute a file search triggered by a link.
12769 Functions added to this hook must accept a single argument, the
12770 search string that was part of the file link, the part after the
12771 double colon. The function must first check if it would like to
12772 handle this search, for example by checking the major-mode or the
12773 file extension. If it decides not to handle this search, it
12774 should just return nil to give other functions a chance. If it
12775 does handle the search, it must return a non-nil value to keep
12776 other functions from trying.
12778 Each function can access the current prefix argument through the
12779 variable `current-prefix-argument'. Note that a single prefix is
12780 used to force opening a link in Emacs, so it may be good to only
12781 use a numeric or double prefix to guide the search function.
12783 In case this is needed, a function in this hook can also restore
12784 the window configuration before `org-open-at-point' was called using:
12786 (set-window-configuration org-window-config-before-follow-link)")
12788 (defun org-link-search (s &optional type avoid-pos)
12789 "Search for a link search option.
12790 If S is surrounded by forward slashes, it is interpreted as a
12791 regular expression. In org-mode files, this will create an `org-occur'
12792 sparse tree. In ordinary files, `occur' will be used to list matches.
12793 If the current buffer is in `dired-mode', grep will be used to search
12794 in all files. If AVOID-POS is given, ignore matches near that position."
12795 (let ((case-fold-search t)
12799 org-emphasis-alist)
12801 (pos (point))
12802 (pre "") (post "")
12803 words re0 re1 re2 re3 re4 re5 re2a reall)
12804 (cond
12805 ;; First check if there are any special
12806 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12807 ;; Now try the builtin stuff
12808 ((save-excursion
12809 (goto-char (point-min))
12810 (and
12811 (re-search-forward
12812 (concat "<<" (regexp-quote s0) ">>") nil t)
12813 (setq pos (match-beginning 0))))
12814 ;; There is an exact target for this
12815 (goto-char pos))
12817 ;; A regular expression
12818 (cond
12819 ((org-mode-p)
12820 (org-occur (match-string 1 s)))
12821 ;;((eq major-mode 'dired-mode)
12822 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12823 (t (org-do-occur (match-string 1 s)))))
12824 (t
12825 ;; A normal search strings
12826 (when (equal (string-to-char s) ?*)
12827 ;; Anchor on headlines, post may include tags.
12830 s (substring s 1)))
12831 (remove-text-properties
12832 0 (length s)
12833 '(face nil mouse-face nil keymap nil fontified nil) s)
12834 ;; Make a series of regular expressions to find a match
12841 re1 (concat pre re2 post)
12842 re3 (concat pre re4 post)
12843 re5 (concat pre ".*" re4)
12844 re2 (concat pre re2)
12845 re2a (concat pre re2a)
12846 re4 (concat pre re4)
12850 ))
12851 (cond
12852 ((eq type 'org-occur) (org-occur reall))
12853 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12854 (t (goto-char (point-min))
12855 (if (or (org-search-not-self 1 re0 nil t)
12856 (org-search-not-self 1 re1 nil t)
12857 (org-search-not-self 1 re2 nil t)
12858 (org-search-not-self 1 re2a nil t)
12859 (org-search-not-self 1 re3 nil t)
12860 (org-search-not-self 1 re4 nil t)
12861 (org-search-not-self 1 re5 nil t)
12862 )
12863 (goto-char (match-beginning 1))
12864 (goto-char pos)
12865 (error "No match")))))
12866 (t
12867 ;; Normal string-search
12868 (goto-char (point-min))
12869 (if (search-forward s nil t)
12870 (goto-char (match-beginning 0))
12871 (error "No match"))))
12872 (and (org-mode-p) (org-show-context 'link-search))))
12874 (defun org-search-not-self (group &rest args)
12875 "Execute `re-search-forward', but only accept matches that do not
12876 enclose the position of `org-open-link-marker'."
12877 (let ((m org-open-link-marker))
12878 (catch 'exit
12879 (while (apply 're-search-forward args)
12880 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12881 (goto-char (match-end group))
12882 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12883 (> (match-beginning 0) (marker-position m))
12884 (< (match-end 0) (marker-position m)))
12885 (save-match-data
12886 (or (not (org-in-regexp
12887 org-bracket-link-analytic-regexp 1))
12888 (not (match-end 4)) ; no description
12889 (and (<= (match-beginning 4) (point))
12890 (>= (match-end 4) (point))))))
12891 (throw 'exit (point))))))))
12893 (defun org-get-buffer-for-internal-link (buffer)
12894 "Return a buffer to be used for displaying the link target of internal links."
12895 (cond
12896 ((not org-display-internal-link-with-indirect-buffer)
12897 buffer)
12898 ((string-match "(Clone)$" (buffer-name buffer))
12899 (message "Buffer is already a clone, not making another one")
12900 ;; we also do not modify visibility in this case
12901 buffer)
12902 (t ; make a new indirect buffer for displaying the link
12903 (let* ((bn (buffer-name buffer))
12904 (ibn (concat bn "(Clone)"))
12905 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12906 (with-current-buffer ib (org-overview))
12907 ib))))
12909 (defun org-do-occur (regexp &optional cleanup)
12910 "Call the Emacs command `occur'.
12911 If CLEANUP is non-nil, remove the printout of the regular expression
12912 in the *Occur* buffer. This is useful if the regex is long and not useful
12913 to read."
12914 (occur regexp)
12915 (when cleanup
12916 (let ((cwin (selected-window)) win beg end)
12917 (when (setq win (get-buffer-window "*Occur*"))
12918 (select-window win))
12919 (goto-char (point-min))
12920 (when (re-search-forward "match[a-z]+" nil t)
12921 (setq beg (match-end 0))
12923 (setq end (1- (match-beginning 0)))))
12924 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12925 (goto-char (point-min))
12926 (select-window cwin))))
12928 ;;; The mark ring for links jumps
12930 (defvar org-mark-ring nil
12931 "Mark ring for positions before jumps in Org-mode.")
12932 (defvar org-mark-ring-last-goto nil
12933 "Last position in the mark ring used to go back.")
12934 ;; Fill and close the ring
12935 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12936 (loop for i from 1 to org-mark-ring-length do
12937 (push (make-marker) org-mark-ring))
12938 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12939 org-mark-ring)
12941 (defun org-mark-ring-push (&optional pos buffer)
12942 "Put the current position or POS into the mark ring and rotate it."
12943 (interactive)
12944 (setq pos (or pos (point)))
12945 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12946 (move-marker (car org-mark-ring)
12947 (or pos (point))
12948 (or buffer (current-buffer)))
12949 (message "%s"
12950 (substitute-command-keys
12953 (defun org-mark-ring-goto (&optional n)
12954 "Jump to the previous position in the mark ring.
12955 With prefix arg N, jump back that many stored positions. When
12956 called several times in succession, walk through the entire ring.
12957 Org-mode commands jumping to a different position in the current file,
12958 or to another Org-mode file, automatically push the old position
12959 onto the ring."
12960 (interactive "p")
12961 (let (p m)
12962 (if (eq last-command this-command)
12963 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12964 (setq p org-mark-ring))
12965 (setq org-mark-ring-last-goto p)
12966 (setq m (car p))
12967 (switch-to-buffer (marker-buffer m))
12968 (goto-char m)
12969 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12971 (defun org-remove-angle-brackets (s)
12972 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12973 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12974 s)
12975 (defun org-add-angle-brackets (s)
12976 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12977 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12978 s)
12980 ;;; Following specific links
12982 (defun org-follow-timestamp-link ()
12983 (cond
12984 ((org-at-date-range-p t)
12985 (let ((org-agenda-start-on-weekday)
12986 (t1 (match-string 1))
12987 (t2 (match-string 2)))
12988 (setq t1 (time-to-days (org-time-string-to-time t1))
12989 t2 (time-to-days (org-time-string-to-time t2)))
12990 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12991 ((org-at-timestamp-p t)
12992 (org-agenda-list nil (time-to-days (org-time-string-to-time
12993 (substring (match-string 1) 0 10)))
12994 1))
12995 (t (error "This should not happen"))))
12998 (defun org-follow-bbdb-link (name)
12999 "Follow a BBDB link to NAME."
13000 (require 'bbdb)
13001 (let ((inhibit-redisplay (not debug-on-error))
13002 (bbdb-electric-p nil))
13003 (catch 'exit
13004 ;; Exact match on name
13006 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13007 ;; Exact match on name
13009 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13010 ;; Partial match on name
13011 (bbdb-name name nil)
13012 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13013 ;; Partial match on company
13014 (bbdb-company name nil)
13015 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13016 ;; General match including network address and notes
13017 (bbdb name nil)
13018 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13019 (delete-window (get-buffer-window "*BBDB*"))
13020 (error "No matching BBDB record")))))
13022 (defun org-follow-info-link (name)
13023 "Follow an info file & node link to NAME."
13026 (progn
13027 (require 'info)
13028 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13029 (Info-find-node (match-string 1 name) (match-string 2 name))
13030 (Info-find-node (match-string 1 name) "Top")))
13031 (message "Could not open: %s" name)))
13033 (defun org-follow-gnus-link (&optional group article)
13034 "Follow a Gnus link to GROUP and ARTICLE."
13035 (require 'gnus)
13036 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13037 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13038 (cond ((and group article)
13039 (gnus-group-read-group 1 nil group)
13040 (gnus-summary-goto-article (string-to-number article) nil t))
13041 (group (gnus-group-jump-to-group group))))
13043 (defun org-follow-vm-link (&optional folder article readonly)
13044 "Follow a VM link to FOLDER and ARTICLE."
13045 (require 'vm)
13046 (setq article (org-add-angle-brackets article))
13048 ;; ange-ftp or efs or tramp access
13049 (let ((user (or (match-string 1 folder) (user-login-name)))
13050 (host (match-string 2 folder))
13051 (file (match-string 3 folder)))
13052 (cond
13053 ((featurep 'tramp)
13054 ;; use tramp to access the file
13055 (if (featurep 'xemacs)
13056 (setq folder (format "[%s@%s]%s" user host file))
13057 (setq folder (format "/%s@%s:%s" user host file))))
13058 (t
13059 ;; use ange-ftp or efs
13060 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13061 (setq folder (format "/%s@%s:%s" user host file))))))
13062 (when folder
13063 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13064 (sit-for 0.1)
13065 (when article
13066 (vm-select-folder-buffer)
13067 (widen)
13068 (let ((case-fold-search t))
13069 (goto-char (point-min))
13070 (if (not (re-search-forward
13071 (concat "^" "message-id: *" (regexp-quote article))))
13072 (error "Could not find the specified message in this folder"))
13073 (vm-isearch-update)
13074 (vm-isearch-narrow)
13075 (vm-beginning-of-message)
13076 (vm-summarize)))))
13078 (defun org-follow-wl-link (folder article)
13079 "Follow a Wanderlust link to FOLDER and ARTICLE."
13080 (if (and (string= folder "%")
13081 article
13083 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13084 ;; Thus, we recompose folder and article ids.
13085 (setq folder (format "%s#%s" folder (match-string 1 article))
13086 article (match-string 3 article)))
13087 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13088 (error "No such folder: %s" folder))
13089 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13090 (and article
13091 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13092 (wl-summary-redisplay)))
13094 (defun org-follow-rmail-link (folder article)
13095 "Follow an RMAIL link to FOLDER and ARTICLE."
13096 (setq article (org-add-angle-brackets article))
13097 (let (message-number)
13098 (save-excursion
13099 (save-window-excursion
13100 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13101 (setq message-number
13102 (save-restriction
13103 (widen)
13104 (goto-char (point-max))
13105 (if (re-search-backward
13107 (or article "")))
13108 nil t)
13109 (rmail-what-message))))))
13110 (if message-number
13111 (progn
13112 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13113 (rmail-show-message message-number)
13114 message-number)
13115 (error "Message not found"))))
13117 ;;; mh-e integration based on planner-mode
13118 (defun org-mhe-get-message-real-folder ()
13119 "Return the name of the current message real folder, so if you use
13120 sequences, it will now work."
13121 (save-excursion
13122 (let* ((folder
13123 (if (equal major-mode 'mh-folder-mode)
13124 mh-current-folder
13125 ;; Refer to the show buffer
13126 mh-show-folder-buffer))
13127 (end-index
13128 (if (boundp 'mh-index-folder)
13129 (min (length mh-index-folder) (length folder))))
13130 )
13131 ;; a simple test on mh-index-data does not work, because
13132 ;; mh-index-data is always nil in a show buffer.
13133 (if (and (boundp 'mh-index-folder)
13134 (string= mh-index-folder (substring folder 0 end-index)))
13135 (if (equal major-mode 'mh-show-mode)
13136 (save-window-excursion
13137 (let (pop-up-frames)
13138 (when (buffer-live-p (get-buffer folder))
13139 (progn
13140 (pop-to-buffer folder)
13141 (org-mhe-get-message-folder-from-index)
13142 )
13143 )))
13144 (org-mhe-get-message-folder-from-index)
13145 )
13146 folder
13147 )
13148 )))
13150 (defun org-mhe-get-message-folder-from-index ()
13151 "Returns the name of the message folder in a index folder buffer."
13152 (save-excursion
13153 (mh-index-previous-folder)
13155 (message "%s" (match-string 1))))
13157 (defun org-mhe-get-message-folder ()
13158 "Return the name of the current message folder. Be careful if you
13159 use sequences."
13160 (save-excursion
13161 (if (equal major-mode 'mh-folder-mode)
13162 mh-current-folder
13163 ;; Refer to the show buffer
13164 mh-show-folder-buffer)))
13166 (defun org-mhe-get-message-num ()
13167 "Return the number of the current message. Be careful if you
13168 use sequences."
13169 (save-excursion
13170 (if (equal major-mode 'mh-folder-mode)
13171 (mh-get-msg-num nil)
13172 ;; Refer to the show buffer
13173 (mh-show-buffer-message-number))))
13175 (defun org-mhe-get-header (header)
13176 "Return a header of the message in folder mode. This will create a
13177 show buffer for the corresponding message. If you have a more clever
13178 idea..."
13179 (let* ((folder (org-mhe-get-message-folder))
13180 (num (org-mhe-get-message-num))
13181 (buffer (get-buffer-create (concat "show-" folder)))
13182 (header-field))
13183 (with-current-buffer buffer
13184 (mh-display-msg num folder)
13185 (if (equal major-mode 'mh-folder-mode)
13186 (mh-header-display)
13187 (mh-show-header-display))
13188 (set-buffer buffer)
13189 (setq header-field (mh-get-header-field header))
13190 (if (equal major-mode 'mh-folder-mode)
13191 (mh-show)
13192 (mh-show-show))
13193 header-field)))
13195 (defun org-follow-mhe-link (folder article)
13196 "Follow an MHE link to FOLDER and ARTICLE.
13197 If ARTICLE is nil FOLDER is shown. If the configuration variable
13198 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13199 ARTICLE is searched in all folders. Indexed searches (swish++,
13200 namazu, and others supported by MH-E) will always search in all
13201 folders."
13202 (require 'mh-e)
13203 (require 'mh-search)
13204 (require 'mh-utils)
13205 (mh-find-path)
13206 (if (not article)
13207 (mh-visit-folder (mh-normalize-folder-name folder))
13208 (setq article (org-add-angle-brackets article))
13209 (mh-search-choose)
13210 (if (equal mh-searcher 'pick)
13211 (progn
13212 (mh-search folder (list "--message-id" article))
13213 (when (and org-mhe-search-all-folders
13214 (not (org-mhe-get-message-real-folder)))
13215 (kill-this-buffer)
13216 (mh-search "+" (list "--message-id" article))))
13217 (mh-search "+" article))
13218 (if (org-mhe-get-message-real-folder)
13219 (mh-show-msg 1)
13220 (kill-this-buffer)
13221 (error "Message not found"))))
13223 ;;; BibTeX links
13225 ;; Use the custom search meachnism to construct and use search strings for
13226 ;; file links to BibTeX database entries.
13228 (defun org-create-file-search-in-bibtex ()
13229 "Create the search string and description for a BibTeX database entry."
13230 (when (eq major-mode 'bibtex-mode)
13231 ;; yes, we want to construct this search string.
13232 ;; Make a good description for this entry, using names, year and the title
13233 ;; Put it into the `description' variable which is dynamically scoped.
13234 (let ((bibtex-autokey-names 1)
13235 (bibtex-autokey-names-stretch 1)
13236 (bibtex-autokey-name-case-convert-function 'identity)
13237 (bibtex-autokey-name-separator " & ")
13238 (bibtex-autokey-additional-names " et al.")
13239 (bibtex-autokey-year-length 4)
13240 (bibtex-autokey-name-year-separator " ")
13241 (bibtex-autokey-titlewords 3)
13242 (bibtex-autokey-titleword-separator " ")
13243 (bibtex-autokey-titleword-case-convert-function 'identity)
13244 (bibtex-autokey-titleword-length 'infty)
13245 (bibtex-autokey-year-title-separator ": "))
13246 (setq description (bibtex-generate-autokey)))
13247 ;; Now parse the entry, get the key and return it.
13248 (save-excursion
13249 (bibtex-beginning-of-entry)
13250 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13252 (defun org-execute-file-search-in-bibtex (s)
13253 "Find the link search string S as a key for a database entry."
13254 (when (eq major-mode 'bibtex-mode)
13255 ;; Yes, we want to do the search in this file.
13256 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13257 (goto-char (point-min))
13260 (goto-char (match-beginning 0)))
13261 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13262 ;; Use double prefix to indicate that any web link should be browsed
13263 (let ((b (current-buffer)) (p (point)))
13264 ;; Restore the window configuration because we just use the web link
13265 (set-window-configuration org-window-config-before-follow-link)
13266 (save-excursion (set-buffer b) (goto-char p)
13267 (bibtex-url)))
13268 (recenter 0)) ; Move entry start to beginning of window
13269 ;; return t to indicate that the search is done.
13270 t))
13272 ;; Finally add the functions to the right hooks.
13273 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13274 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13276 ;; end of Bibtex link setup
13278 ;;; Following file links
13280 (defun org-open-file (path &optional in-emacs line search)
13281 "Open the file at PATH.
13282 First, this expands any special file name abbreviations. Then the
13283 configuration variable `org-file-apps' is checked if it contains an
13284 entry for this file type, and if yes, the corresponding command is launched.
13285 If no application is found, Emacs simply visits the file.
13286 With optional argument IN-EMACS, Emacs will visit the file.
13287 Optional LINE specifies a line to go to, optional SEARCH a string to
13288 search for. If LINE or SEARCH is given, the file will always be
13289 opened in Emacs.
13290 If the file does not exist, an error is thrown."
13291 (setq in-emacs (or in-emacs line search))
13292 (let* ((file (if (equal path "")
13293 buffer-file-name
13294 (substitute-in-file-name (expand-file-name path))))
13295 (apps (append org-file-apps (org-default-apps)))
13296 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13297 (dirp (if remp nil (file-directory-p file)))
13298 (dfile (downcase file))
13299 (old-buffer (current-buffer))
13300 (old-pos (point))
13301 (old-mode major-mode)
13302 ext cmd)
13304 (setq ext (match-string 1 dfile))
13306 (setq ext (match-string 1 dfile))))
13307 (if in-emacs
13308 (setq cmd 'emacs)
13309 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13310 (and dirp (cdr (assoc 'directory apps)))
13311 (cdr (assoc ext apps))
13312 (cdr (assoc t apps)))))
13313 (when (eq cmd 'mailcap)
13314 (require 'mailcap)
13315 (mailcap-parse-mailcaps)
13316 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13317 (command (mailcap-mime-info mime-type)))
13318 (if (stringp command)
13319 (setq cmd command)
13320 (setq cmd 'emacs))))
13321 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13322 (not (file-exists-p file))
13323 (not org-open-non-existing-files))
13324 (error "No such file: %s" file))
13325 (cond
13327 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13329 (setq cmd (replace-match "%s" t t cmd)))
13330 (while (string-match "%s" cmd)
13331 (setq cmd (replace-match
13332 (save-match-data (shell-quote-argument file))
13333 t t cmd)))
13334 (save-window-excursion
13335 (start-process-shell-command cmd nil cmd)))
13336 ((or (stringp cmd)
13337 (eq cmd 'emacs))
13338 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13339 (widen)
13340 (if line (goto-line line)
13341 (if search (org-link-search search))))
13342 ((consp cmd)
13343 (eval cmd))
13344 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13345 (and (org-mode-p) (eq old-mode 'org-mode)
13346 (or (not (equal old-buffer (current-buffer)))
13347 (not (equal old-pos (point))))
13348 (org-mark-ring-push old-pos old-buffer))))
13350 (defun org-default-apps ()
13351 "Return the default applications for this operating system."
13352 (cond
13353 ((eq system-type 'darwin)
13354 org-file-apps-defaults-macosx)
13355 ((eq system-type 'windows-nt)
13356 org-file-apps-defaults-windowsnt)
13357 (t org-file-apps-defaults-gnu)))
13359 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13360 (defun org-file-remote-p (file)
13361 "Test whether FILE specifies a location on a remote system.
13362 Return non-nil if the location is indeed remote.
13366 (cond ((fboundp 'file-remote-p)
13367 (file-remote-p file))
13368 ((fboundp 'tramp-handle-file-remote-p)
13369 (tramp-handle-file-remote-p file))
13370 ((and (boundp 'ange-ftp-name-format)
13371 (string-match (car ange-ftp-name-format) file))
13372 t)
13373 (t nil)))
13376 ;;;; Hooks for remember.el, and refiling
13378 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13379 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13381 ;;;###autoload
13382 (defun org-remember-insinuate ()
13383 "Setup remember.el for use wiht Org-mode."
13384 (require 'remember)
13385 (setq remember-annotation-functions '(org-remember-annotation))
13386 (setq remember-handler-functions '(org-remember-handler))
13387 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13389 ;;;###autoload
13390 (defun org-remember-annotation ()
13391 "Return a link to the current location as an annotation for remember.el.
13392 If you are using Org-mode files as target for data storage with
13393 remember.el, then the annotations should include a link compatible with the
13394 conventions in Org-mode. This function returns such a link."
13395 (org-store-link nil))
13397 (defconst org-remember-help
13398 "Select a destination location for the note.
13399 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13400 RET on headline -> Store as sublevel entry to current headline
13401 RET at beg-of-buf -> Append to file as level 2 headline
13402 <left>/<right> -> before/after current headline, same headings level")
13404 (defvar org-remember-previous-location nil)
13405 (defvar org-force-remember-template-char) ;; dynamically scoped
13407 (defun org-select-remember-template (&optional use-char)
13408 (when org-remember-templates
13409 (let* ((templates (mapcar (lambda (x)
13410 (if (stringp (car x))
13411 (append (list (nth 1 x) (car x)) (cddr x))
13412 (append (list (car x) "") (cdr x))))
13413 org-remember-templates))
13414 (char (or use-char
13415 (cond
13416 ((= (length templates) 1)
13417 (caar templates))
13418 ((and (boundp 'org-force-remember-template-char)
13419 org-force-remember-template-char)
13420 (if (stringp org-force-remember-template-char)
13421 (string-to-char org-force-remember-template-char)
13422 org-force-remember-template-char))
13423 (t
13424 (message "Select template: %s"
13425 (mapconcat
13426 (lambda (x)
13427 (cond
13429 (format "[%c]" (car x)))
13430 ((equal (downcase (car x))
13431 (downcase (aref (nth 1 x) 0)))
13432 (format "[%c]%s" (car x)
13433 (substring (nth 1 x) 1)))
13434 (t (format "[%c]%s" (car x) (nth 1 x)))))
13435 templates " "))
13436 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13437 (when (equal char0 ?\C-g)
13438 (jump-to-register remember-register)
13439 (kill-buffer remember-buffer))
13440 char0))))))
13441 (cddr (assoc char templates)))))
13443 (defvar x-last-selected-text)
13444 (defvar x-last-selected-text-primary)
13446 ;;;###autoload
13447 (defun org-remember-apply-template (&optional use-char skip-interactive)
13448 "Initialize *remember* buffer with template, invoke `org-mode'.
13449 This function should be placed into `remember-mode-hook' and in fact requires
13450 to be run from that hook to function properly."
13451 (if org-remember-templates
13452 (let* ((entry (org-select-remember-template use-char))
13453 (tpl (car entry))
13454 (plist-p (if org-store-link-plist t nil))
13455 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13457 (nth 1 entry)
13458 org-default-notes-file))
13459 (headline (nth 2 entry))
13460 (v-c (or (and (eq window-system 'x)
13461 (fboundp 'x-cut-buffer-or-selection-value)
13462 (x-cut-buffer-or-selection-value))
13463 (org-bound-and-true-p x-last-selected-text)
13464 (org-bound-and-true-p x-last-selected-text-primary)
13465 (and (> (length kill-ring) 0) (current-kill 0))))
13466 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13467 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13468 (v-u (concat "[" (substring v-t 1 -1) "]"))
13469 (v-U (concat "[" (substring v-T 1 -1) "]"))
13470 ;; `initial' and `annotation' are bound in `remember'
13471 (v-i (if (boundp 'initial) initial))
13472 (v-a (if (and (boundp 'annotation) annotation)
13473 (if (equal annotation "[[]]") "" annotation)
13474 ""))
13475 (v-A (if (and v-a
13478 v-a))
13479 (v-n user-full-name)
13480 (org-startup-folded nil)
13481 org-time-was-given org-end-time-was-given x
13482 prompt completions char time pos default histvar)
13483 (setq org-store-link-plist
13484 (append (list :annotation v-a :initial v-i)
13485 org-store-link-plist))
13486 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13487 (erase-buffer)
13488 (insert (substitute-command-keys
13489 (format
13490 "## Filing location: Select interactively, default, or last used:
13491 ## %s to select file and header location interactively.
13495 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13496 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13497 (abbreviate-file-name (or file org-default-notes-file))
13498 (or headline "")
13499 (or (car org-remember-previous-location) "???")
13500 (or (cdr org-remember-previous-location) "???"))))
13501 (insert tpl) (goto-char (point-min))
13502 ;; Simple %-escapes
13504 (when (and initial (equal (match-string 0) "%i"))
13505 (save-match-data
13506 (let* ((lead (buffer-substring
13507 (point-at-bol) (match-beginning 0))))
13508 (setq v-i (mapconcat 'identity
13511 (replace-match
13512 (or (eval (intern (concat "v-" (match-string 1)))) "")
13513 t t))
13515 ;; %[] Insert contents of a file.
13516 (goto-char (point-min))
13518 (let ((start (match-beginning 0))
13519 (end (match-end 0))
13520 (filename (expand-file-name (match-string 1))))
13521 (goto-char start)
13522 (delete-region start end)
13523 (condition-case error
13524 (insert-file-contents filename)
13525 (error (insert (format "%%![Couldn't insert %s: %s]"
13526 filename error))))))
13527 ;; %() embedded elisp
13528 (goto-char (point-min))
13530 (goto-char (match-beginning 0))
13531 (let ((template-start (point)))
13532 (forward-char 1)
13533 (let ((result
13534 (condition-case error
13535 (eval (read (current-buffer)))
13536 (error (format "%%![Error: %s]" error)))))
13537 (delete-region template-start (point))
13538 (insert result))))
13540 ;; From the property list
13541 (when plist-p
13542 (goto-char (point-min))
13544 (and (setq x (or (plist-get org-store-link-plist
13545 (intern (match-string 1))) ""))
13546 (replace-match x t t))))
13548 ;; Turn on org-mode in the remember buffer, set local variables
13549 (org-mode)
13550 (org-set-local 'org-finish-function 'org-remember-finalize)
13552 (org-set-local 'org-default-notes-file file))
13554 (org-set-local 'org-remember-default-headline headline))
13555 ;; Interactive template entries
13556 (goto-char (point-min))
13558 (setq char (if (match-end 3) (match-string 3))
13559 prompt (if (match-end 2) (match-string 2)))
13560 (goto-char (match-beginning 0))
13561 (replace-match "")
13562 (setq completions nil default nil)
13563 (when prompt
13564 (setq completions (org-split-string prompt "|")
13565 prompt (pop completions)
13566 default (car completions)
13567 histvar (intern (concat
13568 "org-remember-template-prompt-history::"
13569 (or prompt "")))
13570 completions (mapcar 'list completions)))
13571 (cond
13572 ((member char '("G" "g"))
13573 (let* ((org-last-tags-completion-table
13574 (org-global-tags-completion-table
13575 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13576 (org-add-colon-after-tag-completion t)
13577 (ins (completing-read
13578 (if prompt (concat prompt ": ") "Tags: ")
13579 'org-tags-completion-function nil nil nil
13580 'org-tags-history)))
13581 (setq ins (mapconcat 'identity
13582 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13583 ":"))
13585 (or (equal (char-before) ?:) (insert ":"))
13586 (insert ins)
13587 (or (equal (char-after) ?:) (insert ":")))))
13588 (char
13589 (setq org-time-was-given (equal (upcase char) char))
13590 (setq time (org-read-date (equal (upcase char) "U") t nil
13591 prompt))
13592 (org-insert-time-stamp time org-time-was-given
13593 (member char '("u" "U"))
13594 nil nil (list org-end-time-was-given)))
13595 (t
13596 (insert (org-completing-read
13597 (concat (if prompt prompt "Enter string")
13598 (if default (concat " [" default "]"))
13599 ": ")
13600 completions nil nil nil histvar default)))))
13601 (goto-char (point-min))
13603 (replace-match "")
13605 (org-mode)
13606 (org-set-local 'org-finish-function 'org-remember-finalize))
13607 (when (save-excursion
13608 (goto-char (point-min))
13609 (re-search-forward "%!" nil t))
13610 (replace-match "")
13611 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13613 (defun org-remember-finish-immediately ()
13614 "File remember note immediately.
13615 This should be run in `post-command-hook' and will remove itself
13616 from that hook."
13617 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13618 (when org-finish-function
13619 (funcall org-finish-function)))
13621 (defvar org-clock-marker) ; Defined below
13622 (defun org-remember-finalize ()
13623 "Finalize the remember process."
13624 (unless (fboundp 'remember-finalize)
13625 (defalias 'remember-finalize 'remember-buffer))
13626 (when (and org-clock-marker
13627 (equal (marker-buffer org-clock-marker) (current-buffer)))
13628 ;; FIXME: test this, this is w/o notetaking!
13629 (let (org-log-done) (org-clock-out)))
13630 (when buffer-file-name
13631 (save-buffer)
13632 (setq buffer-file-name nil))
13633 (remember-finalize))
13635 ;;;###autoload
13636 (defun org-remember (&optional goto org-force-remember-template-char)
13637 "Call `remember'. If this is already a remember buffer, re-apply template.
13638 If there is an active region, make sure remember uses it as initial content
13639 of the remember buffer.
13641 When called interactively with a `C-u' prefix argument GOTO, don't remember
13642 anything, just go to the file/headline where the selected template usually
13643 stores its notes. With a double prefix arg `C-u C-u', go to the last
13644 note stored by remember.
13646 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13647 associated with a template in `org-remember-templates'."
13648 (interactive "P")
13649 (cond
13650 ((equal goto '(4)) (org-go-to-remember-target))
13651 ((equal goto '(16)) (org-remember-goto-last-stored))
13652 (t
13653 (if (memq org-finish-function '(remember-buffer remember-finalize))
13654 (progn
13655 (when (< (length org-remember-templates) 2)
13656 (error "No other template available"))
13657 (erase-buffer)
13658 (let ((annotation (plist-get org-store-link-plist :annotation))
13659 (initial (plist-get org-store-link-plist :initial)))
13660 (org-remember-apply-template))
13661 (message "Press C-c C-c to remember data"))
13662 (if (org-region-active-p)
13663 (remember (buffer-substring (point) (mark)))
13664 (call-interactively 'remember))))))
13666 (defun org-remember-goto-last-stored ()
13667 "Go to the location where the last remember note was stored."
13668 (interactive)
13669 (bookmark-jump "org-remember-last-stored")
13670 (message "This is the last note stored by remember"))
13672 (defun org-go-to-remember-target (&optional template-key)
13673 "Go to the target location of a remember template.
13674 The user is queried for the template."
13675 (interactive)
13676 (let* ((entry (org-select-remember-template template-key))
13677 (file (nth 1 entry))
13678 (heading (nth 2 entry))
13679 visiting)
13681 (setq file org-default-notes-file))
13683 (setq heading org-remember-default-headline))
13684 (setq visiting (org-find-base-buffer-visiting file))
13685 (if (not visiting) (find-file-noselect file))
13686 (switch-to-buffer (or visiting (get-file-buffer file)))
13687 (widen)
13688 (goto-char (point-min))
13689 (if (re-search-forward
13692 nil t)
13693 (goto-char (match-beginning 0))
13694 (error "Target headline not found: %s" heading))))
13696 (defvar org-note-abort nil) ; dynamically scoped
13698 ;;;###autoload
13699 (defun org-remember-handler ()
13700 "Store stuff from remember.el into an org file.
13701 First prompts for an org file. If the user just presses return, the value
13702 of `org-default-notes-file' is used.
13703 Then the command offers the headings tree of the selected file in order to
13704 file the text at a specific location.
13705 You can either immediately press RET to get the note appended to the
13706 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13707 find a better place. Then press RET or <left> or <right> in insert the note.
13709 Key Cursor position Note gets inserted
13710 -----------------------------------------------------------------------------
13711 RET buffer-start as level 1 heading at end of file
13712 RET on headline as sublevel of the heading at cursor
13713 RET no heading at cursor position, level taken from context.
13714 Or use prefix arg to specify level manually.
13715 <left> on headline as same level, before current heading
13716 <right> on headline as same level, after current heading
13718 So the fastest way to store the note is to press RET RET to append it to
13719 the default file. This way your current train of thought is not
13720 interrupted, in accordance with the principles of remember.el.
13721 You can also get the fast execution without prompting by using
13722 C-u C-c C-c to exit the remember buffer. See also the variable
13723 `org-remember-store-without-prompt'.
13725 Before being stored away, the function ensures that the text has a
13727 is constructed from the current date and some additional data.
13729 If the variable `org-adapt-indentation' is non-nil, the entire text is
13730 also indented so that it starts in the same column as the headline
13731 \(i.e. after the stars).
13733 See also the variable `org-reverse-note-order'."
13734 (goto-char (point-min))
13736 (replace-match ""))
13737 (goto-char (point-max))
13738 (beginning-of-line 1)
13740 (delete-region (1- (point)) (point-max))
13741 (beginning-of-line 1))
13742 (catch 'quit
13743 (if org-note-abort (throw 'quit nil))
13744 (let* ((txt (buffer-substring (point-min) (point-max)))
13745 (fastp (org-xor (equal current-prefix-arg '(4))
13746 org-remember-store-without-prompt))
13747 (file (cond
13748 (fastp org-default-notes-file)
13749 ((and (eq org-remember-interactive-interface 'refile)
13750 org-refile-targets)
13751 org-default-notes-file)
13752 ((not (and (equal current-prefix-arg '(16))
13753 org-remember-previous-location))
13754 (org-get-org-file))))
13755 (heading org-remember-default-headline)
13756 (visiting (and file (org-find-base-buffer-visiting file)))
13757 (org-startup-folded nil)
13758 (org-startup-align-all-tables nil)
13759 (org-goto-start-pos 1)
13760 spos exitcmd level indent reversed)
13761 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13762 (setq file (car org-remember-previous-location)
13763 heading (cdr org-remember-previous-location)
13764 fastp t))
13765 (setq current-prefix-arg nil)
13767 (setq txt (replace-match "" t t txt)))
13768 ;; Modify text so that it becomes a nice subtree which can be inserted
13769 ;; into an org tree.
13771 first)
13772 (setq first (car lines) lines (cdr lines))
13774 ;; Is already a headline
13775 (setq indent nil)
13776 ;; We need to add a headline: Use time and first buffer line
13777 (setq lines (cons first lines)
13778 first (concat "* " (current-time-string)
13779 " (" (remember-buffer-desc) ")")
13780 indent " "))
13781 (if (and org-adapt-indentation indent)
13782 (setq lines (mapcar
13783 (lambda (x)
13785 (concat indent x) x))
13786 lines)))
13793 ;; Put the modified text back into the remember buffer, for refile.
13794 (erase-buffer)
13795 (insert txt)
13796 (goto-char (point-min))
13797 (when (and (eq org-remember-interactive-interface 'refile)
13798 (not fastp))
13799 (org-refile nil (or visiting (find-file-noselect file)))
13800 (throw 'quit t))
13801 ;; Find the file
13802 (if (not visiting) (find-file-noselect file))
13803 (with-current-buffer (or visiting (get-file-buffer file))
13804 (unless (org-mode-p)
13805 (error "Target files for remember notes must be in Org-mode"))
13806 (save-excursion
13807 (save-restriction
13808 (widen)
13809 (and (goto-char (point-min))
13812 (setq reversed (org-notes-order-reversed-p))
13814 ;; Find the default location
13816 (goto-char (point-min))
13817 (if (re-search-forward
13820 nil t)
13821 (setq org-goto-start-pos (match-beginning 0))
13822 (when fastp
13823 (goto-char (point-max))
13824 (unless (bolp) (newline))
13826 (setq org-goto-start-pos (point-at-bol 0)))))
13828 ;; Ask the User for a location, using the appropriate interface
13829 (cond
13830 (fastp (setq spos org-goto-start-pos
13831 exitcmd 'return))
13832 ((eq org-remember-interactive-interface 'outline)
13833 (setq spos (org-get-location (current-buffer)
13834 org-remember-help)
13835 exitcmd (cdr spos)
13836 spos (car spos)))
13837 ((eq org-remember-interactive-interface 'outline-path-completion)
13838 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13839 (org-refile-use-outline-path t))
13840 (setq spos (org-refile-get-location "Heading: ")
13841 exitcmd 'return
13842 spos (nth 3 spos))))
13843 (t (error "this should not hapen")))
13844 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13845 ; not handle this note
13846 (goto-char spos)
13847 (cond ((org-on-heading-p t)
13848 (org-back-to-heading t)
13849 (setq level (funcall outline-level))
13850 (cond
13851 ((eq exitcmd 'return)
13852 ;; sublevel of current
13853 (setq org-remember-previous-location
13854 (cons (abbreviate-file-name file)
13855 (org-get-heading 'notags)))
13856 (if reversed
13857 (outline-next-heading)
13858 (org-end-of-subtree t)
13859 (if (not (bolp))
13861 (beginning-of-line 2)
13862 (end-of-line 1)
13864 (bookmark-set "org-remember-last-stored")
13865 (org-paste-subtree (org-get-legal-level level 1) txt))
13866 ((eq exitcmd 'left)
13867 ;; before current
13868 (bookmark-set "org-remember-last-stored")
13869 (org-paste-subtree level txt))
13870 ((eq exitcmd 'right)
13871 ;; after current
13872 (org-end-of-subtree t)
13873 (bookmark-set "org-remember-last-stored")
13874 (org-paste-subtree level txt))
13875 (t (error "This should not happen"))))
13877 ((and (bobp) (not reversed))
13878 ;; Put it at the end, one level below level 1
13879 (save-restriction
13880 (widen)
13881 (goto-char (point-max))
13882 (if (not (bolp)) (newline))
13883 (bookmark-set "org-remember-last-stored")
13884 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13886 ((and (bobp) reversed)
13887 ;; Put it at the start, as level 1
13888 (save-restriction
13889 (widen)
13890 (goto-char (point-min))
13892 (beginning-of-line 1)
13893 (bookmark-set "org-remember-last-stored")
13894 (org-paste-subtree 1 txt)))
13895 (t
13896 ;; Put it right there, with automatic level determined by
13897 ;; org-paste-subtree or from prefix arg
13898 (bookmark-set "org-remember-last-stored")
13899 (org-paste-subtree
13900 (if (numberp current-prefix-arg) current-prefix-arg)
13901 txt)))
13902 (when remember-save-after-remembering
13903 (save-buffer)
13904 (if (not visiting) (kill-buffer (current-buffer)))))))))
13906 t) ;; return t to indicate that we took care of this note.
13908 (defun org-get-org-file ()
13909 "Read a filename, with default directory `org-directory'."
13910 (let ((default (or org-default-notes-file remember-data-file)))
13911 (read-file-name (format "File name [%s]: " default)
13912 (file-name-as-directory org-directory)
13913 default)))
13915 (defun org-notes-order-reversed-p ()
13916 "Check if the current file should receive notes in reversed order."
13917 (cond
13918 ((not org-reverse-note-order) nil)
13919 ((eq t org-reverse-note-order) t)
13920 ((not (listp org-reverse-note-order)) nil)
13921 (t (catch 'exit
13922 (let ((all org-reverse-note-order)
13923 entry)
13924 (while (setq entry (pop all))
13925 (if (string-match (car entry) buffer-file-name)
13926 (throw 'exit (cdr entry))))
13927 nil)))))
13929 ;;; Refiling
13931 (defvar org-refile-target-table nil
13932 "The list of refile targets, created by `org-refile'.")
13934 (defvar org-agenda-new-buffers nil
13935 "Buffers created to visit agenda files.")
13937 (defun org-get-refile-targets (&optional default-buffer)
13938 "Produce a table with refile targets."
13939 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13940 targets txt re files f desc descre)
13941 (with-current-buffer (or default-buffer (current-buffer))
13942 (while (setq entry (pop entries))
13943 (setq files (car entry) desc (cdr entry))
13944 (cond
13945 ((null files) (setq files (list (current-buffer))))
13946 ((eq files 'org-agenda-files)
13947 (setq files (org-agenda-files 'unrestricted)))
13948 ((and (symbolp files) (fboundp files))
13949 (setq files (funcall files)))
13950 ((and (symbolp files) (boundp files))
13951 (setq files (symbol-value files))))
13952 (if (stringp files) (setq files (list files)))
13953 (cond
13954 ((eq (car desc) :tag)
13956 ((eq (car desc) :todo)
13958 ((eq (car desc) :regexp)
13959 (setq descre (cdr desc)))
13960 ((eq (car desc) :level)
13962 (if org-odd-levels-only
13963 (1- (* 2 (cdr desc)))
13964 (cdr desc)))
13966 ((eq (car desc) :maxlevel)
13968 (if org-odd-levels-only
13969 (1- (* 2 (cdr desc)))
13970 (cdr desc)))
13972 (t (error "Bad refiling target description %s" desc)))
13973 (while (setq f (pop files))
13974 (save-excursion
13975 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13976 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13977 (save-excursion
13978 (save-restriction
13979 (widen)
13980 (goto-char (point-min))
13981 (while (re-search-forward descre nil t)
13982 (goto-char (point-at-bol))
13983 (when (looking-at org-complex-heading-regexp)
13984 (setq txt (match-string 4)
13985 re (concat "^" (regexp-quote
13986 (buffer-substring (match-beginning 1)
13987 (match-end 4)))))
13989 (regexp-quote
13990 (match-string 5)))))
13992 (when org-refile-use-outline-path
13993 (setq txt (mapconcat 'identity
13994 (append
13995 (if (eq org-refile-use-outline-path 'file)
13996 (list (file-name-nondirectory
13997 (buffer-file-name (buffer-base-buffer))))
13998 (if (eq org-refile-use-outline-path 'full-file-path)
13999 (list (buffer-file-name (buffer-base-buffer)))))
14000 (org-get-outline-path)
14001 (list txt))
14002 "/")))
14003 (push (list txt f re (point)) targets))
14004 (goto-char (point-at-eol))))))))
14005 (nreverse targets))))
14007 (defun org-get-outline-path ()
14008 "Return the outline path to the current entry, as a list."
14009 (let (rtn)
14010 (save-excursion
14011 (while (org-up-heading-safe)
14012 (when (looking-at org-complex-heading-regexp)
14013 (push (org-match-string-no-properties 4) rtn)))
14014 rtn)))
14016 (defvar org-refile-history nil
14017 "History for refiling operations.")
14019 (defun org-refile (&optional goto default-buffer)
14020 "Move the entry at point to another heading.
14021 The list of target headings is compiled using the information in
14022 `org-refile-targets', which see. This list is created upon first use, and
14023 you can update it by calling this command with a double prefix (`C-u C-u').
14024 FIXME: Can we find a better way of updating?
14026 At the target location, the entry is filed as a subitem of the target heading.
14027 Depending on `org-reverse-note-order', the new subitem will either be the
14028 first of the last subitem.
14030 With prefix arg GOTO, the command will only visit the target location,
14031 not actually move anything.
14032 With a double prefix `C-c C-c', go to the location where the last refiling
14033 operation has put the subtree.
14035 With a double prefix argument, the command can be used to jump to any
14036 heading in the current buffer."
14037 (interactive "P")
14038 (let* ((cbuf (current-buffer))
14039 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14040 (fname (and filename (file-truename filename)))
14041 pos it nbuf file re level reversed)
14042 (if (equal goto '(16))
14043 (org-refile-goto-last-stored)
14044 (when (setq it (org-refile-get-location
14045 (if goto "Goto: " "Refile to: ") default-buffer))
14046 (setq file (nth 1 it)
14047 re (nth 2 it)
14048 pos (nth 3 it))
14049 (setq nbuf (or (find-buffer-visiting file)
14050 (find-file-noselect file)))
14051 (if goto
14052 (progn
14053 (switch-to-buffer nbuf)
14054 (goto-char pos)
14055 (org-show-context 'org-goto))
14056 (org-copy-special)
14057 (save-excursion
14058 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14059 (find-file-noselect file))))
14060 (setq reversed (org-notes-order-reversed-p))
14061 (save-excursion
14062 (save-restriction
14063 (widen)
14064 (goto-char pos)
14065 (looking-at outline-regexp)
14066 (setq level (org-get-legal-level (funcall outline-level) 1))
14067 (goto-char
14068 (if reversed
14069 (outline-next-heading)
14070 (or (save-excursion (outline-get-next-sibling))
14071 (org-end-of-subtree t t)
14072 (point-max))))
14073 (bookmark-set "org-refile-last-stored")
14074 (org-paste-subtree level))))
14075 (org-cut-special)
14078 (defun org-refile-goto-last-stored ()
14079 "Go to the location where the last refile was stored."
14080 (interactive)
14081 (bookmark-jump "org-refile-last-stored")
14082 (message "This is the location of the last refile"))
14084 (defun org-refile-get-location (&optional prompt default-buffer)
14085 "Prompt the user for a refile location, using PROMPT."
14086 (let ((org-refile-targets org-refile-targets)
14087 (org-refile-use-outline-path org-refile-use-outline-path))
14088 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14089 (unless org-refile-target-table
14090 (error "No refile targets"))
14091 (let* ((cbuf (current-buffer))
14092 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14093 (fname (and filename (file-truename filename)))
14094 (tbl (mapcar
14095 (lambda (x)
14096 (if (not (equal fname (file-truename (nth 1 x))))
14097 (cons (concat (car x) " (" (file-name-nondirectory
14098 (nth 1 x)) ")")
14099 (cdr x))
14100 x))
14101 org-refile-target-table))
14102 (completion-ignore-case t)
14103 pos it nbuf file re level reversed)
14104 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14105 tbl)))
14107 ;;;; Dynamic blocks
14109 (defun org-find-dblock (name)
14110 "Find the first dynamic block with name NAME in the buffer.
14111 If not found, stay at current position and return nil."
14112 (let (pos)
14113 (save-excursion
14114 (goto-char (point-min))
14116 nil t)
14117 (match-beginning 0))))
14118 (if pos (goto-char pos))
14119 pos))
14121 (defconst org-dblock-start-re
14123 "Matches the startline of a dynamic block, with parameters.")
14126 "Matches the end of a dyhamic block.")
14128 (defun org-create-dblock (plist)
14129 "Create a dynamic block section, with parameters taken from PLIST.
14130 PLIST must containe a :name entry which is used as name of the block."
14131 (unless (bolp) (newline))
14132 (let ((name (plist-get plist :name)))
14133 (insert "#+BEGIN: " name)
14134 (while plist
14135 (if (eq (car plist) :name)
14136 (setq plist (cddr plist))
14137 (insert " " (prin1-to-string (pop plist)))))
14139 (beginning-of-line -2)))
14141 (defun org-prepare-dblock ()
14142 "Prepare dynamic block for refresh.
14143 This empties the block, puts the cursor at the insert position and returns
14144 the property list including an extra property :name with the block name."
14145 (unless (looking-at org-dblock-start-re)
14146 (error "Not at a dynamic block"))
14147 (let* ((begdel (1+ (match-end 0)))
14148 (name (org-no-properties (match-string 1)))
14149 (params (append (list :name name)
14150 (read (concat "(" (match-string 3) ")")))))
14151 (unless (re-search-forward org-dblock-end-re nil t)
14152 (error "Dynamic block not terminated"))
14153 (delete-region begdel (match-beginning 0))
14154 (goto-char begdel)
14155 (open-line 1)
14156 params))
14158 (defun org-map-dblocks (&optional command)
14159 "Apply COMMAND to all dynamic blocks in the current buffer.
14160 If COMMAND is not given, use `org-update-dblock'."
14161 (let ((cmd (or command 'org-update-dblock))
14162 pos)
14163 (save-excursion
14164 (goto-char (point-min))
14165 (while (re-search-forward org-dblock-start-re nil t)
14166 (goto-char (setq pos (match-beginning 0)))
14167 (condition-case nil
14168 (funcall cmd)
14169 (error (message "Error during update of dynamic block")))
14170 (goto-char pos)
14171 (unless (re-search-forward org-dblock-end-re nil t)
14172 (error "Dynamic block not terminated"))))))
14174 (defun org-dblock-update (&optional arg)
14175 "User command for updating dynamic blocks.
14176 Update the dynamic block at point. With prefix ARG, update all dynamic
14177 blocks in the buffer."
14178 (interactive "P")
14179 (if arg
14180 (org-update-all-dblocks)
14181 (or (looking-at org-dblock-start-re)
14182 (org-beginning-of-dblock))
14183 (org-update-dblock)))
14185 (defun org-update-dblock ()
14186 "Update the dynamic block at point
14187 This means to empty the block, parse for parameters and then call
14188 the correct writing function."
14189 (save-window-excursion
14190 (let* ((pos (point))
14191 (line (org-current-line))
14192 (params (org-prepare-dblock))
14193 (name (plist-get params :name))
14194 (cmd (intern (concat "org-dblock-write:" name))))
14195 (message "Updating dynamic block `%s' at line %d..." name line)
14196 (funcall cmd params)
14197 (message "Updating dynamic block `%s' at line %d...done" name line)
14198 (goto-char pos))))
14200 (defun org-beginning-of-dblock ()
14201 "Find the beginning of the dynamic block at point.
14202 Error if there is no scuh block at point."
14203 (let ((pos (point))
14204 beg)
14205 (end-of-line 1)
14206 (if (and (re-search-backward org-dblock-start-re nil t)
14207 (setq beg (match-beginning 0))
14208 (re-search-forward org-dblock-end-re nil t)
14209 (> (match-end 0) pos))
14210 (goto-char beg)
14211 (goto-char pos)
14212 (error "Not in a dynamic block"))))
14214 (defun org-update-all-dblocks ()
14215 "Update all dynamic blocks in the buffer.
14216 This function can be used in a hook."
14217 (when (org-mode-p)
14218 (org-map-dblocks 'org-update-dblock)))
14221 ;;;; Completion
14223 (defconst org-additional-option-like-keywords
14224 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14225 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14226 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14228 (defun org-complete (&optional arg)
14229 "Perform completion on word at point.
14230 At the beginning of a headline, this completes TODO keywords as given in
14231 `org-todo-keywords'.
14232 If the current word is preceded by a backslash, completes the TeX symbols
14233 that are supported for HTML support.
14235 setting file options.
14237 At all other locations, this simply calls the value of
14238 `org-completion-fallback-command'."
14239 (interactive "P")
14240 (org-without-partial-completion
14241 (catch 'exit
14242 (let* ((end (point))
14243 (beg1 (save-excursion
14244 (skip-chars-backward (org-re "[:alnum:]_@"))
14245 (point)))
14246 (beg (save-excursion
14247 (skip-chars-backward "a-zA-Z0-9_:$")
14248 (point)))
14249 (confirm (lambda (x) (stringp (car x))))
14250 (searchhead (equal (char-before beg) ?*))
14251 (tag (and (equal (char-before beg1) ?:)
14252 (equal (char-after (point-at-bol)) ?*)))
14253 (prop (and (equal (char-before beg1) ?:)
14254 (not (equal (char-after (point-at-bol)) ?*))))
14256 (link (equal (char-before beg) ?\[))
14257 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14258 beg)
14259 "#+"))
14261 (buffer-substring (point-at-bol) (point))))
14262 (completion-ignore-case opt)
14263 (type nil)
14264 (tbl nil)
14265 (table (cond
14266 (opt
14267 (setq type :opt)
14268 (append
14269 (mapcar
14270 (lambda (x)
14272 (cons (match-string 2 x) (match-string 1 x)))
14274 (mapcar 'list org-additional-option-like-keywords)))
14275 (startup
14276 (setq type :startup)
14277 org-startup-options)
14278 (link (append org-link-abbrev-alist-local
14279 org-link-abbrev-alist))
14280 (texp
14281 (setq type :tex)
14282 org-html-entities)
14284 (buffer-substring (point-at-bol) beg))
14285 (setq type :todo)
14286 (mapcar 'list org-todo-keywords-1))
14287 (searchhead
14288 (setq type :searchhead)
14289 (save-excursion
14290 (goto-char (point-min))
14291 (while (re-search-forward org-todo-line-regexp nil t)
14292 (push (list
14293 (org-make-org-heading-search-string
14294 (match-string 3) t))
14295 tbl)))
14296 tbl)
14297 (tag (setq type :tag beg beg1)
14298 (or org-tag-alist (org-get-buffer-tags)))
14299 (prop (setq type :prop beg beg1)
14300 (mapcar 'list (org-buffer-property-keys nil t t)))
14301 (t (progn
14302 (call-interactively org-completion-fallback-command)
14303 (throw 'exit nil)))))
14304 (pattern (buffer-substring-no-properties beg end))
14305 (completion (try-completion pattern table confirm)))
14306 (cond ((eq completion t)
14307 (if (not (assoc (upcase pattern) table))
14308 (message "Already complete")
14309 (if (equal type :opt)
14310 (insert (substring (cdr (assoc (upcase pattern) table))
14311 (length pattern)))
14312 (if (memq type '(:tag :prop)) (insert ":")))))
14313 ((null completion)
14315 (ding))
14316 ((not (string= pattern completion))
14317 (delete-region beg end)
14318 (if (string-match " +$" completion)
14319 (setq completion (replace-match "" t t completion)))
14320 (insert completion)
14321 (if (get-buffer-window "*Completions*")
14322 (delete-window (get-buffer-window "*Completions*")))
14323 (if (assoc completion table)
14324 (if (eq type :todo) (insert " ")
14325 (if (memq type '(:tag :prop)) (insert ":"))))
14326 (if (and (equal type :opt) (assoc completion table))
14327 (message "%s" (substitute-command-keys
14329 (t
14330 (message "Making completion list...")
14331 (let ((list (sort (all-completions pattern table confirm)
14332 'string<)))
14333 (with-output-to-temp-buffer "*Completions*"
14334 (condition-case nil
14335 ;; Protection needed for XEmacs and emacs 21
14336 (display-completion-list list pattern)
14337 (error (display-completion-list list)))))
14338 (message "Making completion list...%s" "done")))))))
14340 ;;;; TODO, DEADLINE, Comments
14342 (defun org-toggle-comment ()
14343 "Change the COMMENT state of an entry."
14344 (interactive)
14345 (save-excursion
14346 (org-back-to-heading)
14347 (let (case-fold-search)
14348 (if (looking-at (concat outline-regexp
14350 (replace-match "" t t nil 1)
14351 (if (looking-at outline-regexp)
14352 (progn
14353 (goto-char (match-end 0))
14354 (insert org-comment-string " ")))))))
14356 (defvar org-last-todo-state-is-todo nil
14357 "This is non-nil when the last TODO state change led to a TODO state.
14358 If the last change removed the TODO tag or switched to DONE, then
14359 this is nil.")
14361 (defvar org-setting-tags nil) ; dynamically skiped
14363 ;; FIXME: better place
14364 (defun org-property-or-variable-value (var &optional inherit)
14365 "Check if there is a property fixing the value of VAR.
14366 If yes, return this value. If not, return the current value of the variable."
14367 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14369 (read prop)
14370 (symbol-value var))))
14372 (defun org-parse-local-options (string var)
14373 "Parse STRING for startup setting relevant for variable VAR."
14374 (let ((rtn (symbol-value var))
14375 e opts)
14376 (save-match-data
14378 rtn
14379 (setq opts (delq nil (mapcar (lambda (x)
14380 (setq e (assoc x org-startup-options))
14381 (if (eq (nth 1 e) var) e nil))
14383 (if (not opts)
14384 rtn
14385 (setq rtn nil)
14386 (while (setq e (pop opts))
14387 (if (not (nth 3 e))
14388 (setq rtn (nth 2 e))
14389 (if (not (listp rtn)) (setq rtn nil))
14390 (push (nth 2 e) rtn)))
14391 rtn)))))
14393 (defvar org-blocker-hook nil
14394 "Hook for functions that are allowed to block a state change.
14396 Each function gets as its single argument a property list, see
14397 `org-trigger-hook' for more information about this list.
14399 If any of the functions in this hook returns nil, the state change
14400 is blocked.")
14402 (defvar org-trigger-hook nil
14403 "Hook for functions that are triggered by a state change.
14405 Each function gets as its single argument a property list with at least
14406 the following elements:
14408 (:type type-of-change :position pos-at-entry-start
14409 :from old-state :to new-state)
14411 Depending on the type, more properties may be present.
14413 This mechanism is currently implemented for:
14415 TODO state changes
14416 ------------------
14417 :type todo-state-change
14418 :from previous state (keyword as a string), or nil
14419 :to new state (keyword as a string), or nil")
14422 (defun org-todo (&optional arg)
14423 "Change the TODO state of an item.
14424 The state of an item is given by a keyword at the start of the heading,
14425 like
14426 *** TODO Write paper
14427 *** DONE Call mom
14429 The different keywords are specified in the variable `org-todo-keywords'.
14431 So for this example: when the item starts with TODO, it is changed to DONE.
14432 When it starts with DONE, the DONE is removed. And when neither TODO nor
14433 DONE are present, add TODO at the beginning of the heading.
14435 With C-u prefix arg, use completion to determine the new state.
14436 With numeric prefix arg, switch to that state.
14438 For calling through lisp, arg is also interpreted in the following way:
14439 'none -> empty state
14441 'done -> switch to DONE
14442 'nextset -> switch to the next set of keywords
14443 'previousset -> switch to the previous set of keywords
14445 really is a member of `org-todo-keywords'."
14446 (interactive "P")
14447 (save-excursion
14448 (catch 'exit
14449 (org-back-to-heading)
14450 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14451 (or (looking-at (concat " +" org-todo-regexp " *"))
14452 (looking-at " *"))
14453 (let* ((match-data (match-data))
14454 (startpos (point-at-bol))
14455 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14456 (org-log-done (org-parse-local-options logging 'org-log-done))
14457 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
14458 (this (match-string 1))
14459 (hl-pos (match-beginning 0))
14460 (head (org-get-todo-sequence-head this))
14461 (ass (assoc head org-todo-kwd-alist))
14462 (interpret (nth 1 ass))
14463 (done-word (nth 3 ass))
14464 (final-done-word (nth 4 ass))
14465 (last-state (or this ""))
14466 (completion-ignore-case t)
14467 (member (member this org-todo-keywords-1))
14468 (tail (cdr member))
14469 (state (cond
14470 ((and org-todo-key-trigger
14471 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14472 (and (not arg) org-use-fast-todo-selection
14473 (not (eq org-use-fast-todo-selection 'prefix)))))
14474 ;; Use fast selection
14475 (org-fast-todo-selection))
14476 ((and (equal arg '(4))
14477 (or (not org-use-fast-todo-selection)
14478 (not org-todo-key-trigger)))
14479 ;; Read a state with completion
14480 (completing-read "State: " (mapcar (lambda(x) (list x))
14481 org-todo-keywords-1)
14482 nil t))
14483 ((eq arg 'right)
14484 (if this
14485 (if tail (car tail) nil)
14486 (car org-todo-keywords-1)))
14487 ((eq arg 'left)
14488 (if (equal member org-todo-keywords-1)
14489 nil
14490 (if this
14491 (nth (- (length org-todo-keywords-1) (length tail) 2)
14492 org-todo-keywords-1)
14493 (org-last org-todo-keywords-1))))
14494 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14495 (setq arg nil))) ; hack to fall back to cycling
14496 (arg
14497 ;; user or caller requests a specific state
14498 (cond
14499 ((equal arg "") nil)
14500 ((eq arg 'none) nil)
14501 ((eq arg 'done) (or done-word (car org-done-keywords)))
14502 ((eq arg 'nextset)
14503 (or (car (cdr (member head org-todo-heads)))
14504 (car org-todo-heads)))
14505 ((eq arg 'previousset)
14506 (let ((org-todo-heads (reverse org-todo-heads)))
14507 (or (car (cdr (member head org-todo-heads)))
14508 (car org-todo-heads))))
14509 ((car (member arg org-todo-keywords-1)))
14510 ((nth (1- (prefix-numeric-value arg))
14511 org-todo-keywords-1))))
14512 ((null member) (or head (car org-todo-keywords-1)))
14513 ((equal this final-done-word) nil) ;; -> make empty
14514 ((null tail) nil) ;; -> first entry
14515 ((eq interpret 'sequence)
14516 (car tail))
14517 ((memq interpret '(type priority))
14518 (if (eq this-command last-command)
14519 (car tail)
14520 (if (> (length tail) 0)
14521 (or done-word (car org-done-keywords))
14522 nil)))
14523 (t nil)))
14524 (next (if state (concat " " state " ") " "))
14525 (change-plist (list :type 'todo-state-change :from this :to state
14526 :position startpos))
14527 dostates)
14528 (when org-blocker-hook
14529 (unless (save-excursion
14530 (save-match-data
14531 (run-hook-with-args-until-failure
14532 'org-blocker-hook change-plist)))
14533 (if (interactive-p)
14534 (error "TODO state change from %s to %s blocked" this state)
14535 ;; fail silently
14536 (message "TODO state change from %s to %s blocked" this state)
14537 (throw 'exit nil))))
14538 (store-match-data match-data)
14539 (replace-match next t t)
14540 (unless (pos-visible-in-window-p hl-pos)
14541 (message "TODO state changed to %s" (org-trim next)))
14542 (unless head
14543 (setq head (org-get-todo-sequence-head state)
14544 ass (assoc head org-todo-kwd-alist)
14545 interpret (nth 1 ass)
14546 done-word (nth 3 ass)
14547 final-done-word (nth 4 ass)))
14548 (when (memq arg '(nextset previousset))
14549 (message "Keyword-Set %d/%d: %s"
14550 (- (length org-todo-sets) -1
14551 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14552 (length org-todo-sets)
14553 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14554 (setq org-last-todo-state-is-todo
14555 (not (member state org-done-keywords)))
14556 (when (and org-log-done (not (memq arg '(nextset previousset))))
14557 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
14558 (or (not org-todo-log-states)
14559 (member state org-todo-log-states))))
14561 (cond
14562 ((and state (member state org-not-done-keywords)
14563 (not (member this org-not-done-keywords)))
14564 ;; This is now a todo state and was not one before
14565 ;; Remove any CLOSED timestamp, and possibly log the state change
14566 (org-add-planning-info nil nil 'closed)
14567 (and dostates (org-add-log-maybe 'state state 'findpos)))
14568 ((and state dostates)
14569 ;; This is a non-nil state, and we need to log it
14570 (org-add-log-maybe 'state state 'findpos))
14571 ((and (member state org-done-keywords)
14572 (not (member this org-done-keywords)))
14573 ;; It is now done, and it was not done before
14574 (org-add-planning-info 'closed (org-current-time))
14575 (org-add-log-maybe 'done state 'findpos))))
14576 ;; Fixup tag positioning
14577 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14578 (run-hooks 'org-after-todo-state-change-hook)
14579 (and (member state org-done-keywords) (org-auto-repeat-maybe))
14580 (if (and arg (not (member state org-done-keywords)))
14581 (setq head (org-get-todo-sequence-head state)))
14582 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14583 ;; Fixup cursor location if close to the keyword
14584 (if (and (outline-on-heading-p)
14585 (not (bolp))
14586 (save-excursion (beginning-of-line 1)
14587 (looking-at org-todo-line-regexp))
14588 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14589 (progn
14590 (goto-char (or (match-end 2) (match-end 1)))
14591 (just-one-space)))
14592 (when org-trigger-hook
14593 (save-excursion
14594 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14596 (defun org-get-todo-sequence-head (kwd)
14597 "Return the head of the TODO sequence to which KWD belongs.
14598 If KWD is not set, check if there is a text property remembering the
14599 right sequence."
14600 (let (p)
14601 (cond
14602 ((not kwd)
14603 (or (get-text-property (point-at-bol) 'org-todo-head)
14604 (progn
14605 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14606 nil (point-at-eol)))
14607 (get-text-property p 'org-todo-head))))
14608 ((not (member kwd org-todo-keywords-1))
14609 (car org-todo-keywords-1))
14610 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14612 (defun org-fast-todo-selection ()
14613 "Fast TODO keyword selection with single keys.
14614 Returns the new TODO keyword, or nil if no state change should occur."
14615 (let* ((fulltable org-todo-key-alist)
14616 (done-keywords org-done-keywords) ;; needed for the faces.
14617 (maxlen (apply 'max (mapcar
14618 (lambda (x)
14619 (if (stringp (car x)) (string-width (car x)) 0))
14620 fulltable)))
14621 (expert nil)
14622 (fwidth (+ maxlen 3 1 3))
14623 (ncol (/ (- (window-width) 4) fwidth))
14624 tg cnt e c tbl
14625 groups ingroup)
14626 (save-window-excursion
14627 (if expert
14628 (set-buffer (get-buffer-create " *Org todo*"))
14629 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14630 (erase-buffer)
14631 (org-set-local 'org-done-keywords done-keywords)
14632 (setq tbl fulltable cnt 0)
14633 (while (setq e (pop tbl))
14634 (cond
14635 ((equal e '(:startgroup))
14636 (push '() groups) (setq ingroup t)
14637 (when (not (= cnt 0))
14638 (setq cnt 0)
14640 (insert "{ "))
14641 ((equal e '(:endgroup))
14642 (setq ingroup nil cnt 0)
14644 (t
14645 (setq tg (car e) c (cdr e))
14646 (if ingroup (push tg (car groups)))
14647 (setq tg (org-add-props tg nil 'face
14648 (org-get-todo-face tg)))
14649 (if (and (= cnt 0) (not ingroup)) (insert " "))
14650 (insert "[" c "] " tg (make-string
14651 (- fwidth 4 (length tg)) ?\ ))
14652 (when (= (setq cnt (1+ cnt)) ncol)
14654 (if ingroup (insert " "))
14655 (setq cnt 0)))))
14657 (goto-char (point-min))
14658 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14659 (fit-window-to-buffer))
14660 (message "[a-z..]:Set [SPC]:clear")
14661 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14662 (cond
14663 ((or (= c ?\C-g)
14664 (and (= c ?q) (not (rassoc c fulltable))))
14665 (setq quit-flag t))
14666 ((= c ?\ ) nil)
14667 ((setq e (rassoc c fulltable) tg (car e))
14668 tg)
14669 (t (setq quit-flag t))))))
14671 (defun org-get-repeat ()
14672 "Check if tere is a deadline/schedule with repeater in this entry."
14673 (save-match-data
14674 (save-excursion
14675 (org-back-to-heading t)
14676 (if (re-search-forward
14677 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14678 (match-string 1)))))
14680 (defvar org-last-changed-timestamp)
14681 (defvar org-log-post-message)
14682 (defun org-auto-repeat-maybe ()
14683 "Check if the current headline contains a repeated deadline/schedule.
14684 If yes, set TODO state back to what it was and change the base date
14685 of repeating deadline/scheduled time stamps to new date.
14686 This function should be run in the `org-after-todo-state-change-hook'."
14687 ;; last-state is dynamically scoped into this function
14688 (let* ((repeat (org-get-repeat))
14689 (aa (assoc last-state org-todo-kwd-alist))
14690 (interpret (nth 1 aa))
14691 (head (nth 2 aa))
14692 (done-word (nth 3 aa))
14693 (whata '(("d" . day) ("m" . month) ("y" . year)))
14694 (msg "Entry repeats: ")
14695 (org-log-done)
14696 re type n what ts)
14697 (when repeat
14698 (org-todo (if (eq interpret 'type) last-state head))
14699 (when (and org-log-repeat
14700 (not (memq 'org-add-log-note
14701 (default-value 'post-command-hook))))
14702 ;; Make sure a note is taken
14703 (let ((org-log-done '(done)))
14704 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
14705 'findpos)))
14706 (org-back-to-heading t)
14707 (org-add-planning-info nil nil 'closed)
14711 (while (re-search-forward
14712 re (save-excursion (outline-next-heading) (point)) t)
14713 (setq type (if (match-end 1) org-scheduled-string
14714 (if (match-end 3) org-deadline-string "Plain:"))
14715 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14717 (setq n (string-to-number (match-string 1 ts))
14718 what (match-string 2 ts))
14719 (if (equal what "w") (setq n (* n 7) what "d"))
14720 (org-timestamp-change n (cdr (assoc what whata)))
14721 (setq msg (concat msg type org-last-changed-timestamp " "))))
14722 (setq org-log-post-message msg)
14723 (message "%s" msg))))
14725 (defun org-show-todo-tree (arg)
14726 "Make a compact tree which shows all headlines marked with TODO.
14727 The tree will show the lines where the regexp matches, and all higher
14728 headlines above the match.
14730 With a numeric prefix N, construct a sparse tree for the Nth element
14731 of `org-todo-keywords-1'."
14732 (interactive "P")
14733 (let ((case-fold-search nil)
14734 (kwd-re
14735 (cond ((null arg) org-not-done-regexp)
14736 ((equal arg '(4))
14737 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14738 (mapcar 'list org-todo-keywords-1))))
14742 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14743 (regexp-quote (nth (1- (prefix-numeric-value arg))
14744 org-todo-keywords-1)))
14745 (t (error "Invalid prefix argument: %s" arg)))))
14746 (message "%d TODO entries found"
14747 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14749 (defun org-deadline (&optional remove)
14751 With argument REMOVE, remove any deadline from the item."
14752 (interactive "P")
14753 (if remove
14754 (progn
14755 (org-remove-timestamp-with-keyword org-deadline-string)
14756 (message "Item no longer has a deadline."))
14757 (org-add-planning-info 'deadline nil 'closed)))
14759 (defun org-schedule (&optional remove)
14760 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14761 With argument REMOVE, remove any scheduling date from the item."
14762 (interactive "P")
14763 (if remove
14764 (progn
14765 (org-remove-timestamp-with-keyword org-scheduled-string)
14766 (message "Item is no longer scheduled."))
14767 (org-add-planning-info 'scheduled nil 'closed)))
14769 (defun org-remove-timestamp-with-keyword (keyword)
14770 "Remove all time stamps with KEYWORD in the current entry."
14772 beg)
14773 (save-excursion
14774 (org-back-to-heading t)
14775 (setq beg (point))
14776 (org-end-of-subtree t t)
14777 (while (re-search-backward re beg t)
14778 (replace-match "")
14780 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14782 (defun org-add-planning-info (what &optional time &rest remove)
14783 "Insert new timestamp with keyword in the line directly after the headline.
14784 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14785 If non is given, the user is prompted for a date.
14786 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14787 be removed."
14788 (interactive)
14789 (let (org-time-was-given org-end-time-was-given)
14790 (when what (setq time (or time (org-read-date nil 'to-time))))
14791 (when (and org-insert-labeled-timestamps-at-point
14792 (member what '(scheduled deadline)))
14793 (insert
14794 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14795 (org-insert-time-stamp time org-time-was-given
14796 nil nil nil (list org-end-time-was-given))
14797 (setq what nil))
14798 (save-excursion
14799 (save-restriction
14800 (let (col list elt ts buffer-invisibility-spec)
14801 (org-back-to-heading t)
14803 (goto-char (match-end 1))
14804 (setq col (current-column))
14805 (goto-char (match-end 0))
14807 (if (and (not (looking-at outline-regexp))
14810 (not (equal (match-string 1) org-clock-string)))
14811 (narrow-to-region (match-beginning 0) (match-end 0))
14813 (backward-char 1)
14814 (narrow-to-region (point) (point))
14815 (indent-to-column col))
14816 ;; Check if we have to remove something.
14817 (setq list (cons what remove))
14818 (while list
14819 (setq elt (pop list))
14820 (goto-char (point-min))
14821 (when (or (and (eq elt 'scheduled)
14822 (re-search-forward org-scheduled-time-regexp nil t))
14823 (and (eq elt 'deadline)
14824 (re-search-forward org-deadline-time-regexp nil t))
14825 (and (eq elt 'closed)
14826 (re-search-forward org-closed-time-regexp nil t)))
14827 (replace-match "")
14828 (if (looking-at "--+<[^>]+>") (replace-match ""))
14829 (if (looking-at " +") (replace-match ""))))
14830 (goto-char (point-max))
14831 (when what
14832 (insert
14833 (if (not (equal (char-before) ?\ )) " " "")
14834 (cond ((eq what 'scheduled) org-scheduled-string)
14835 ((eq what 'deadline) org-deadline-string)
14836 ((eq what 'closed) org-closed-string))
14837 " ")
14838 (setq ts (org-insert-time-stamp
14839 time
14840 (or org-time-was-given
14841 (and (eq what 'closed) org-log-done-with-time))
14842 (eq what 'closed)
14843 nil nil (list org-end-time-was-given)))
14844 (end-of-line 1))
14845 (goto-char (point-min))
14846 (widen)
14848 (replace-match ""))
14849 ts)))))
14851 (defvar org-log-note-marker (make-marker))
14852 (defvar org-log-note-purpose nil)
14853 (defvar org-log-note-state nil)
14854 (defvar org-log-note-window-configuration nil)
14855 (defvar org-log-note-return-to (make-marker))
14856 (defvar org-log-post-message nil
14857 "Message to be displayed after a log note has been stored.
14858 The auto-repeater uses this.")
14860 (defun org-add-log-maybe (&optional purpose state findpos)
14861 "Set up the post command hook to take a note."
14862 (save-excursion
14863 (when (and (listp org-log-done)
14864 (memq purpose org-log-done))
14865 (when findpos
14866 (org-back-to-heading t)
14870 (goto-char (match-end 0))
14871 (unless org-log-states-order-reversed
14873 (org-skip-over-state-notes)
14875 (move-marker org-log-note-marker (point))
14876 (setq org-log-note-purpose purpose)
14877 (setq org-log-note-state state)
14878 (add-hook 'post-command-hook 'org-add-log-note 'append))))
14880 (defun org-skip-over-state-notes ()
14881 "Skip past the list of State notes in an entry."
14884 (condition-case nil
14885 (org-next-item)
14886 (error (org-end-of-item)))))
14888 (defun org-add-log-note (&optional purpose)
14889 "Pop up a window for taking a note, and add this note later at point."
14890 (remove-hook 'post-command-hook 'org-add-log-note)
14891 (setq org-log-note-window-configuration (current-window-configuration))
14892 (delete-other-windows)
14893 (move-marker org-log-note-return-to (point))
14894 (switch-to-buffer (marker-buffer org-log-note-marker))
14895 (goto-char org-log-note-marker)
14896 (org-switch-to-buffer-other-window "*Org Note*")
14897 (erase-buffer)
14898 (let ((org-inhibit-startup t)) (org-mode))
14899 (insert (format "# Insert note for %s.
14901 (cond
14902 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14903 ((eq org-log-note-purpose 'done) "closed todo item")
14904 ((eq org-log-note-purpose 'state)
14906 (t (error "This should not happen")))))
14907 (org-set-local 'org-finish-function 'org-store-log-note))
14909 (defun org-store-log-note ()
14910 "Finish taking a log note, and insert it to where it belongs."
14911 (let ((txt (buffer-string))
14912 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14913 lines ind)
14914 (kill-buffer (current-buffer))
14916 (setq txt (replace-match "" t t txt)))
14918 (setq txt (replace-match "" t t txt)))
14921 (setq note
14922 (org-replace-escapes
14923 note
14924 (list (cons "%u" (user-login-name))
14925 (cons "%U" user-full-name)
14926 (cons "%t" (format-time-string
14927 (org-time-stamp-format 'long 'inactive)
14928 (current-time)))
14929 (cons "%s" (if org-log-note-state
14931 "")))))
14933 (push note lines))
14934 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14935 (when lines
14936 (save-excursion
14937 (set-buffer (marker-buffer org-log-note-marker))
14938 (save-excursion
14939 (goto-char org-log-note-marker)
14940 (move-marker org-log-note-marker nil)
14941 (end-of-line 1)
14943 (indent-relative nil)
14944 (insert "- " (pop lines))
14945 (org-indent-line-function)
14946 (beginning-of-line 1)
14948 (setq ind (concat (match-string 0) " "))
14949 (end-of-line 1)
14951 (set-window-configuration org-log-note-window-configuration)
14952 (with-current-buffer (marker-buffer org-log-note-return-to)
14953 (goto-char org-log-note-return-to))
14954 (move-marker org-log-note-return-to nil)
14955 (and org-log-post-message (message "%s" org-log-post-message)))
14957 ;; FIXME: what else would be useful?
14958 ;; - priority
14959 ;; - date
14961 (defun org-sparse-tree (&optional arg)
14962 "Create a sparse tree, prompt for the details.
14963 This command can create sparse trees. You first need to select the type
14964 of match used to create the tree:
14966 t Show entries with a specific TODO keyword.
14967 T Show entries selected by a tags match.
14968 p Enter a property name and its value (both with completion on existing
14969 names/values) and show entries with that property.
14970 r Show entries matching a regular expression
14971 d Show deadlines due within `org-deadline-warning-days'."
14972 (interactive "P")
14973 (let (ans kwd value)
14974 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
14975 (setq ans (read-char-exclusive))
14976 (cond
14977 ((equal ans ?d)
14978 (call-interactively 'org-check-deadlines))
14979 ((equal ans ?b)
14980 (call-interactively 'org-check-before-date))
14981 ((equal ans ?t)
14982 (org-show-todo-tree '(4)))
14983 ((equal ans ?T)
14984 (call-interactively 'org-tags-sparse-tree))
14985 ((member ans '(?p ?P))
14986 (setq kwd (completing-read "Property: "
14987 (mapcar 'list (org-buffer-property-keys))))
14988 (setq value (completing-read "Value: "
14989 (mapcar 'list (org-property-values kwd))))
14992 (org-tags-sparse-tree arg (concat kwd "=" value)))
14993 ((member ans '(?r ?R ?/))
14994 (call-interactively 'org-occur))
14997 (defvar org-occur-highlights nil)
14998 (make-variable-buffer-local 'org-occur-highlights)
15000 (defun org-occur (regexp &optional keep-previous callback)
15001 "Make a compact tree which shows all matches of REGEXP.
15002 The tree will show the lines where the regexp matches, and all higher
15003 headlines above the match. It will also show the heading after the match,
15004 to make sure editing the matching entry is easy.
15005 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15006 call to `org-occur' will be kept, to allow stacking of calls to this
15007 command.
15008 If CALLBACK is non-nil, it is a function which is called to confirm
15009 that the match should indeed be shown."
15011 (or keep-previous (org-remove-occur-highlights nil nil t))
15012 (let ((cnt 0))
15013 (save-excursion
15014 (goto-char (point-min))
15015 (if (or (not keep-previous) ; do not want to keep
15016 (not org-occur-highlights)) ; no previous matches
15017 ;; hide everything
15018 (org-overview))
15019 (while (re-search-forward regexp nil t)
15020 (when (or (not callback)
15021 (save-match-data (funcall callback)))
15022 (setq cnt (1+ cnt))
15023 (when org-highlight-sparse-tree-matches
15024 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15025 (org-show-context 'occur-tree))))
15026 (when org-remove-highlights-with-change
15027 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15028 nil 'local))
15029 (unless org-sparse-tree-open-archived-trees
15030 (org-hide-archived-subtrees (point-min) (point-max)))
15031 (run-hooks 'org-occur-hook)
15032 (if (interactive-p)
15033 (message "%d match(es) for regexp %s" cnt regexp))
15034 cnt))
15036 (defun org-show-context (&optional key)
15037 "Make sure point and context and visible.
15038 How much context is shown depends upon the variables
15039 `org-show-hierarchy-above', `org-show-following-heading'. and
15040 `org-show-siblings'."
15041 (let ((heading-p (org-on-heading-p t))
15042 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15043 (following-p (org-get-alist-option org-show-following-heading key))
15044 (entry-p (org-get-alist-option org-show-entry-below key))
15045 (siblings-p (org-get-alist-option org-show-siblings key)))
15046 (catch 'exit
15047 ;; Show heading or entry text
15048 (if (and heading-p (not entry-p))
15049 (org-flag-heading nil) ; only show the heading
15050 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15051 (org-show-hidden-entry))) ; show entire entry
15052 (when following-p
15053 ;; Show next sibling, or heading below text
15054 (save-excursion
15055 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15056 (org-flag-heading nil))))
15057 (when siblings-p (org-show-siblings))
15058 (when hierarchy-p
15059 ;; show all higher headings, possibly with siblings
15060 (save-excursion
15061 (while (and (condition-case nil
15062 (progn (org-up-heading-all 1) t)
15063 (error nil))
15064 (not (bobp)))
15065 (org-flag-heading nil)
15066 (when siblings-p (org-show-siblings))))))))
15068 (defun org-reveal (&optional siblings)
15069 "Show current entry, hierarchy above it, and the following headline.
15070 This can be used to show a consistent set of context around locations
15071 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15072 not t for the search context.
15074 With optional argument SIBLINGS, on each level of the hierarchy all
15075 siblings are shown. This repairs the tree structure to what it would
15076 look like when opened with hierarchical calls to `org-cycle'."
15077 (interactive "P")
15078 (let ((org-show-hierarchy-above t)
15079 (org-show-following-heading t)
15080 (org-show-siblings (if siblings t org-show-siblings)))
15081 (org-show-context nil)))
15083 (defun org-highlight-new-match (beg end)
15084 "Highlight from BEG to END and mark the highlight is an occur headline."
15085 (let ((ov (org-make-overlay beg end)))
15086 (org-overlay-put ov 'face 'secondary-selection)
15087 (push ov org-occur-highlights)))
15089 (defun org-remove-occur-highlights (&optional beg end noremove)
15090 "Remove the occur highlights from the buffer.
15091 BEG and END are ignored. If NOREMOVE is nil, remove this function
15092 from the `before-change-functions' in the current buffer."
15093 (interactive)
15094 (unless org-inhibit-highlight-removal
15095 (mapc 'org-delete-overlay org-occur-highlights)
15096 (setq org-occur-highlights nil)
15097 (unless noremove
15098 (remove-hook 'before-change-functions
15099 'org-remove-occur-highlights 'local))))
15101 ;;;; Priorities
15104 "Regular expression matching the priority indicator.")
15106 (defvar org-remove-priority-next-time nil)
15108 (defun org-priority-up ()
15109 "Increase the priority of the current item."
15110 (interactive)
15111 (org-priority 'up))
15113 (defun org-priority-down ()
15114 "Decrease the priority of the current item."
15115 (interactive)
15116 (org-priority 'down))
15118 (defun org-priority (&optional action)
15119 "Change the priority of an item by ARG.
15120 ACTION can be `set', `up', `down', or a character."
15121 (interactive)
15122 (setq action (or action 'set))
15123 (let (current new news have remove)
15124 (save-excursion
15125 (org-back-to-heading)
15126 (if (looking-at org-priority-regexp)
15127 (setq current (string-to-char (match-string 2))
15128 have t)
15129 (setq current org-default-priority))
15130 (cond
15131 ((or (eq action 'set) (integerp action))
15132 (if (integerp action)
15133 (setq new action)
15134 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15135 (setq new (read-char-exclusive)))
15136 (if (and (= (upcase org-highest-priority) org-highest-priority)
15137 (= (upcase org-lowest-priority) org-lowest-priority))
15138 (setq new (upcase new)))
15139 (cond ((equal new ?\ ) (setq remove t))
15140 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15141 (error "Priority must be between `%c' and `%c'"
15142 org-highest-priority org-lowest-priority))))
15143 ((eq action 'up)
15144 (if (and (not have) (eq last-command this-command))
15145 (setq new org-lowest-priority)
15146 (setq new (if (and org-priority-start-cycle-with-default (not have))
15147 org-default-priority (1- current)))))
15148 ((eq action 'down)
15149 (if (and (not have) (eq last-command this-command))
15150 (setq new org-highest-priority)
15151 (setq new (if (and org-priority-start-cycle-with-default (not have))
15152 org-default-priority (1+ current)))))
15153 (t (error "Invalid action")))
15154 (if (or (< (upcase new) org-highest-priority)
15155 (> (upcase new) org-lowest-priority))
15156 (setq remove t))
15157 (setq news (format "%c" new))
15158 (if have
15159 (if remove
15160 (replace-match "" t t nil 1)
15161 (replace-match news t t nil 2))
15162 (if remove
15163 (error "No priority cookie found in line")
15164 (looking-at org-todo-line-regexp)
15165 (if (match-end 2)
15166 (progn
15167 (goto-char (match-end 2))
15168 (insert " [#" news "]"))
15169 (goto-char (match-beginning 3))
15170 (insert "[#" news "] ")))))
15171 (org-preserve-lc (org-set-tags nil 'align))
15172 (if remove
15173 (message "Priority removed")
15174 (message "Priority of current item set to %s" news))))
15177 (defun org-get-priority (s)
15178 "Find priority cookie and return priority."
15179 (save-match-data
15180 (if (not (string-match org-priority-regexp s))
15181 (* 1000 (- org-lowest-priority org-default-priority))
15182 (* 1000 (- org-lowest-priority
15183 (string-to-char (match-string 2 s)))))))
15185 ;;;; Tags
15187 (defun org-scan-tags (action matcher &optional todo-only)
15188 "Scan headline tags with inheritance and produce output ACTION.
15189 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15190 evaluated, testing if a given set of tags qualifies a headline for
15191 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15192 are included in the output."
15195 (org-re
15197 (props (list 'face nil
15198 'done-face 'org-done
15199 'undone-face nil
15200 'mouse-face 'highlight
15201 'org-not-done-regexp org-not-done-regexp
15202 'org-todo-regexp org-todo-regexp
15203 'keymap org-agenda-keymap
15204 'help-echo
15205 (format "mouse-2 or RET jump to org file %s"
15206 (abbreviate-file-name
15207 (or (buffer-file-name (buffer-base-buffer))
15208 (buffer-name (buffer-base-buffer)))))))
15209 (case-fold-search nil)
15210 lspos
15211 tags tags-list tags-alist (llast 0) rtn level category i txt
15212 todo marker entry priority)
15213 (save-excursion
15214 (goto-char (point-min))
15215 (when (eq action 'sparse-tree)
15216 (org-overview)
15217 (org-remove-occur-highlights))
15218 (while (re-search-forward re nil t)
15219 (catch :skip
15220 (setq todo (if (match-end 1) (match-string 2))
15221 tags (if (match-end 4) (match-string 4)))
15222 (goto-char (setq lspos (1+ (match-beginning 0))))
15223 (setq level (org-reduced-level (funcall outline-level))
15224 category (org-get-category))
15225 (setq i llast llast level)
15226 ;; remove tag lists from same and sublevels
15227 (while (>= i level)
15228 (when (setq entry (assoc i tags-alist))
15229 (setq tags-alist (delete entry tags-alist)))
15230 (setq i (1- i)))
15231 ;; add the nex tags
15232 (when tags
15233 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15234 tags-alist
15235 (cons (cons level tags) tags-alist)))
15236 ;; compile tags for current headline
15237 (setq tags-list
15238 (if org-use-tag-inheritance
15239 (apply 'append (mapcar 'cdr tags-alist))
15240 tags))
15241 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15242 (eval matcher)
15243 (or (not org-agenda-skip-archived-trees)
15244 (not (member org-archive-tag tags-list))))
15245 (and (eq action 'agenda) (org-agenda-skip))
15246 ;; list this headline
15248 (if (eq action 'sparse-tree)
15249 (progn
15250 (and org-highlight-sparse-tree-matches
15251 (org-get-heading) (match-end 0)
15252 (org-highlight-new-match
15253 (match-beginning 0) (match-beginning 1)))
15254 (org-show-context 'tags-tree))
15255 (setq txt (org-format-agenda-item
15256 ""
15257 (concat
15258 (if org-tags-match-list-sublevels
15259 (make-string (1- level) ?.) "")
15260 (org-get-heading))
15261 category tags-list)
15262 priority (org-get-priority txt))
15263 (goto-char lspos)
15264 (setq marker (org-agenda-new-marker))
15265 (org-add-props txt props
15266 'org-marker marker 'org-hd-marker marker 'org-category category
15267 'priority priority 'type "tagsmatch")
15268 (push txt rtn))
15269 ;; if we are to skip sublevels, jump to end of subtree
15270 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15271 (when (and (eq action 'sparse-tree)
15272 (not org-sparse-tree-open-archived-trees))
15273 (org-hide-archived-subtrees (point-min) (point-max)))
15274 (nreverse rtn)))
15276 (defvar todo-only) ;; dynamically scoped
15278 (defun org-tags-sparse-tree (&optional todo-only match)
15279 "Create a sparse tree according to tags string MATCH.
15280 MATCH can contain positive and negative selection of tags, like
15282 If optional argument TODO_ONLY is non-nil, only select lines that are
15283 also TODO lines."
15284 (interactive "P")
15285 (org-prepare-agenda-buffers (list (current-buffer)))
15286 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15288 (defvar org-cached-props nil)
15289 (defun org-cached-entry-get (pom property)
15290 (if (or (eq t org-use-property-inheritance)
15291 (member property org-use-property-inheritance))
15292 ;; Caching is not possible, check it directly
15293 (org-entry-get pom property 'inherit)
15294 ;; Get all properties, so that we can do complicated checks easily
15295 (cdr (assoc property (or org-cached-props
15296 (setq org-cached-props
15297 (org-entry-properties pom)))))))
15299 (defun org-global-tags-completion-table (&optional files)
15300 "Return the list of all tags in all agenda buffer/files."
15301 (save-excursion
15302 (org-uniquify
15303 (delq nil
15304 (apply 'append
15305 (mapcar
15306 (lambda (file)
15307 (set-buffer (find-file-noselect file))
15308 (append (org-get-buffer-tags)
15309 (mapcar (lambda (x) (if (stringp (car-safe x))
15310 (list (car-safe x)) nil))
15311 org-tag-alist)))
15312 (if (and files (car files))
15313 files
15314 (org-agenda-files))))))))
15316 (defun org-make-tags-matcher (match)
15317 "Create the TAGS//TODO matcher form for the selection string MATCH."
15318 ;; todo-only is scoped dynamically into this function, and the function
15319 ;; may change it it the matcher asksk for it.
15320 (unless match
15321 ;; Get a new match request, with completion
15322 (let ((org-last-tags-completion-table
15323 (org-global-tags-completion-table)))
15324 (setq match (completing-read
15325 "Match: " 'org-tags-completion-function nil nil nil
15326 'org-tags-history))))
15328 ;; Parse the string and create a lisp form
15329 (let ((match0 match)
15330 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
15331 minus tag mm
15332 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15333 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15334 (if (string-match "/+" match)
15335 ;; match contains also a todo-matching request
15336 (progn
15337 (setq tagsmatch (substring match 0 (match-beginning 0))
15338 todomatch (substring match (match-end 0)))
15339 (if (string-match "^!" todomatch)
15340 (setq todo-only t todomatch (substring todomatch 1)))
15342 (setq todomatch nil)))
15343 ;; only matching tags
15344 (setq tagsmatch match todomatch nil))
15346 ;; Make the tags matcher
15348 (setq tagsmatcher t)
15349 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15350 (while (setq term (pop orterms))
15352 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15353 (while (string-match re term)
15354 (setq minus (and (match-end 1)
15355 (equal (match-string 1 term) "-"))
15356 tag (match-string 2 term)
15357 re-p (equal (string-to-char tag) ?{)
15358 level-p (match-end 3)
15359 prop-p (match-end 4)
15360 mm (cond
15361 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15362 (level-p `(= level ,(string-to-number
15363 (match-string 3 term))))
15364 (prop-p
15365 (setq pn (match-string 4 term)
15366 pv (match-string 5 term)
15367 cat-p (equal pn "CATEGORY")
15368 re-p (equal (string-to-char pv) ?{)
15369 pv (substring pv 1 -1))
15370 (if (equal pn "CATEGORY")
15371 (setq gv '(get-text-property (point) 'org-category))
15372 (setq gv `(org-cached-entry-get nil ,pn)))
15373 (if re-p
15374 `(string-match ,pv (or ,gv ""))
15375 `(equal ,pv ,gv)))
15376 (t `(member ,(downcase tag) tags-list)))
15377 mm (if minus (list 'not mm) mm)
15378 term (substring term (match-end 0)))
15379 (push mm tagsmatcher))
15380 (push (if (> (length tagsmatcher) 1)
15381 (cons 'and tagsmatcher)
15382 (car tagsmatcher))
15383 orlist)
15384 (setq tagsmatcher nil))
15385 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15386 (setq tagsmatcher
15387 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15389 ;; Make the todo matcher
15391 (setq todomatcher t)
15392 (setq orterms (org-split-string todomatch "|") orlist nil)
15393 (while (setq term (pop orterms))
15394 (while (string-match re term)
15395 (setq minus (and (match-end 1)
15396 (equal (match-string 1 term) "-"))
15397 kwd (match-string 2 term)
15398 re-p (equal (string-to-char kwd) ?{)
15399 term (substring term (match-end 0))
15400 mm (if re-p
15401 `(string-match ,(substring kwd 1 -1) todo)
15402 (list 'equal 'todo kwd))
15403 mm (if minus (list 'not mm) mm))
15404 (push mm todomatcher))
15405 (push (if (> (length todomatcher) 1)
15406 (cons 'and todomatcher)
15407 (car todomatcher))
15408 orlist)
15409 (setq todomatcher nil))
15410 (setq todomatcher (if (> (length orlist) 1)
15411 (cons 'or orlist) (car orlist))))
15413 ;; Return the string and lisp forms of the matcher
15414 (setq matcher (if todomatcher
15415 (list 'and tagsmatcher todomatcher)
15416 tagsmatcher))
15417 (cons match0 matcher)))
15419 (defun org-match-any-p (re list)
15420 "Does re match any element of list?"
15421 (setq list (mapcar (lambda (x) (string-match re x)) list))
15422 (delq nil list))
15424 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15425 (defvar org-tags-overlay (org-make-overlay 1 1))
15426 (org-detach-overlay org-tags-overlay)
15428 (defun org-align-tags-here (to-col)
15429 ;; Assumes that this is a headline
15430 (let ((pos (point)) (col (current-column)) tags)
15431 (beginning-of-line 1)
15433 (< pos (match-beginning 2)))
15434 (progn
15435 (setq tags (match-string 2))
15436 (goto-char (match-beginning 1))
15437 (insert " ")
15438 (delete-region (point) (1+ (match-end 0)))
15439 (backward-char 1)
15440 (move-to-column
15441 (max (1+ (current-column))
15442 (1+ col)
15443 (if (> to-col 0)
15444 to-col
15445 (- (abs to-col) (length tags))))
15446 t)
15447 (insert tags)
15448 (move-to-column (min (current-column) col) t))
15449 (goto-char pos))))
15451 (defun org-set-tags (&optional arg just-align)
15452 "Set the tags for the current headline.
15453 With prefix ARG, realign all tags in headings in the current buffer."
15454 (interactive "P")
15455 (let* ((re (concat "^" outline-regexp))
15456 (current (org-get-tags-string))
15457 (col (current-column))
15458 (org-setting-tags t)
15459 table current-tags inherited-tags ; computed below when needed
15460 tags p0 c0 c1 rpl)
15461 (if arg
15462 (save-excursion
15463 (goto-char (point-min))
15464 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15465 (while (re-search-forward re nil t)
15466 (org-set-tags nil t)
15467 (end-of-line 1)))
15468 (message "All tags realigned to column %d" org-tags-column))
15469 (if just-align
15470 (setq tags current)
15471 ;; Get a new set of tags from the user
15472 (save-excursion
15473 (setq table (or org-tag-alist (org-get-buffer-tags))
15474 org-last-tags-completion-table table
15475 current-tags (org-split-string current ":")
15476 inherited-tags (nreverse
15477 (nthcdr (length current-tags)
15478 (nreverse (org-get-tags-at))))
15479 tags
15480 (if (or (eq t org-use-fast-tag-selection)
15481 (and org-use-fast-tag-selection
15482 (delq nil (mapcar 'cdr table))))
15483 (org-fast-tag-selection
15484 current-tags inherited-tags table
15485 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15486 (let ((org-add-colon-after-tag-completion t))
15487 (org-trim
15488 (org-without-partial-completion
15489 (completing-read "Tags: " 'org-tags-completion-function
15490 nil nil current 'org-tags-history)))))))
15491 (while (string-match "[-+&]+" tags)
15492 ;; No boolean logic, just a list
15493 (setq tags (replace-match ":" t t tags))))
15496 (setq tags "")
15497 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15498 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15500 ;; Insert new tags at the correct column
15501 (beginning-of-line 1)
15502 (cond
15503 ((and (equal current "") (equal tags "")))
15504 ((re-search-forward
15506 (point-at-eol) t)
15507 (if (equal tags "")
15508 (setq rpl "")
15509 (goto-char (match-beginning 0))
15510 (setq c0 (current-column) p0 (point)
15511 c1 (max (1+ c0) (if (> org-tags-column 0)
15512 org-tags-column
15513 (- (- org-tags-column) (length tags))))
15514 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15515 (replace-match rpl t t)
15516 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15517 tags)
15518 (t (error "Tags alignment failed")))
15519 (move-to-column col)
15520 (unless just-align
15521 (run-hooks 'org-after-tags-change-hook)))))
15523 (defun org-change-tag-in-region (beg end tag off)
15524 "Add or remove TAG for each entry in the region.
15525 This works in the agenda, and also in an org-mode buffer."
15526 (interactive
15527 (list (region-beginning) (region-end)
15528 (let ((org-last-tags-completion-table
15529 (if (org-mode-p)
15530 (org-get-buffer-tags)
15531 (org-global-tags-completion-table))))
15532 (completing-read
15533 "Tag: " 'org-tags-completion-function nil nil nil
15534 'org-tags-history))
15535 (progn
15536 (message "[s]et or [r]emove? ")
15537 (equal (read-char-exclusive) ?r))))
15538 (if (fboundp 'deactivate-mark) (deactivate-mark))
15539 (let ((agendap (equal major-mode 'org-agenda-mode))
15540 l1 l2 m buf pos newhead (cnt 0))
15541 (goto-char end)
15542 (setq l2 (1- (org-current-line)))
15543 (goto-char beg)
15544 (setq l1 (org-current-line))
15545 (loop for l from l1 to l2 do
15546 (goto-line l)
15547 (setq m (get-text-property (point) 'org-hd-marker))
15548 (when (or (and (org-mode-p) (org-on-heading-p))
15549 (and agendap m))
15550 (setq buf (if agendap (marker-buffer m) (current-buffer))
15551 pos (if agendap m (point)))
15552 (with-current-buffer buf
15553 (save-excursion
15554 (save-restriction
15555 (goto-char pos)
15556 (setq cnt (1+ cnt))
15557 (org-toggle-tag tag (if off 'off 'on))
15558 (setq newhead (org-get-heading)))))
15559 (and agendap (org-agenda-change-all-lines newhead m))))
15560 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15562 (defun org-tags-completion-function (string predicate &optional flag)
15563 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15564 (confirm (lambda (x) (stringp (car x)))))
15566 (setq s1 (match-string 1 string)
15567 s2 (match-string 2 string))
15568 (setq s1 "" s2 string))
15569 (cond
15570 ((eq flag nil)
15571 ;; try completion
15572 (setq rtn (try-completion s2 ctable confirm))
15573 (if (stringp rtn)
15574 (setq rtn
15575 (concat s1 s2 (substring rtn (length s2))
15576 (if (and org-add-colon-after-tag-completion
15577 (assoc rtn ctable))
15578 ":" ""))))
15579 rtn)
15580 ((eq flag t)
15581 ;; all-completions
15582 (all-completions s2 ctable confirm)
15583 )
15584 ((eq flag 'lambda)
15585 ;; exact match?
15586 (assoc s2 ctable)))
15587 ))
15589 (defun org-fast-tag-insert (kwd tags face &optional end)
15590 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15591 (insert (format "%-12s" (concat kwd ":"))
15592 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15593 (or end "")))
15595 (defun org-fast-tag-show-exit (flag)
15596 (save-excursion
15597 (goto-line 3)
15599 (replace-match ""))
15600 (when flag
15601 (end-of-line 1)
15602 (move-to-column (- (window-width) 19) t)
15603 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15605 (defun org-set-current-tags-overlay (current prefix)
15606 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15607 (if (featurep 'xemacs)
15608 (org-overlay-display org-tags-overlay (concat prefix s)
15609 'secondary-selection)
15610 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15611 (org-overlay-display org-tags-overlay (concat prefix s)))))
15613 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15614 "Fast tag selection with single keys.
15615 CURRENT is the current list of tags in the headline, INHERITED is the
15616 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15617 possibly with grouping information. TODO-TABLE is a similar table with
15618 TODO keywords, should these have keys assigned to them.
15619 If the keys are nil, a-z are automatically assigned.
15620 Returns the new tags string, or nil to not change the current settings."
15621 (let* ((fulltable (append table todo-table))
15622 (maxlen (apply 'max (mapcar
15623 (lambda (x)
15624 (if (stringp (car x)) (string-width (car x)) 0))
15625 fulltable)))
15626 (buf (current-buffer))
15627 (expert (eq org-fast-tag-selection-single-key 'expert))
15628 (buffer-tags nil)
15629 (fwidth (+ maxlen 3 1 3))
15630 (ncol (/ (- (window-width) 4) fwidth))
15631 (i-face 'org-done)
15632 (c-face 'org-todo)
15633 tg cnt e c char c1 c2 ntable tbl rtn
15634 ov-start ov-end ov-prefix
15635 (exit-after-next org-fast-tag-selection-single-key)
15636 (done-keywords org-done-keywords)
15637 groups ingroup)
15638 (save-excursion
15639 (beginning-of-line 1)
15640 (if (looking-at
15642 (setq ov-start (match-beginning 1)
15643 ov-end (match-end 1)
15644 ov-prefix "")
15645 (setq ov-start (1- (point-at-eol))
15646 ov-end (1+ ov-start))
15648 (setq ov-prefix
15649 (concat
15650 (buffer-substring (1- (point)) (point))
15651 (if (> (current-column) org-tags-column)
15652 " "
15653 (make-string (- org-tags-column (current-column)) ?\ ))))))
15654 (org-move-overlay org-tags-overlay ov-start ov-end)
15655 (save-window-excursion
15656 (if expert
15657 (set-buffer (get-buffer-create " *Org tags*"))
15658 (delete-other-windows)
15659 (split-window-vertically)
15660 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15661 (erase-buffer)
15662 (org-set-local 'org-done-keywords done-keywords)
15665 (org-fast-tag-show-exit exit-after-next)
15666 (org-set-current-tags-overlay current ov-prefix)
15667 (setq tbl fulltable char ?a cnt 0)
15668 (while (setq e (pop tbl))
15669 (cond
15670 ((equal e '(:startgroup))
15671 (push '() groups) (setq ingroup t)
15672 (when (not (= cnt 0))
15673 (setq cnt 0)
15675 (insert "{ "))
15676 ((equal e '(:endgroup))
15677 (setq ingroup nil cnt 0)
15679 (t
15680 (setq tg (car e) c2 nil)
15681 (if (cdr e)
15682 (setq c (cdr e))
15683 ;; automatically assign a character.
15684 (setq c1 (string-to-char
15685 (downcase (substring
15686 tg (if (= (string-to-char tg) ?@) 1 0)))))
15687 (if (or (rassoc c1 ntable) (rassoc c1 table))
15688 (while (or (rassoc char ntable) (rassoc char table))
15689 (setq char (1+ char)))
15690 (setq c2 c1))
15691 (setq c (or c2 char)))
15692 (if ingroup (push tg (car groups)))
15693 (setq tg (org-add-props tg nil 'face
15694 (cond
15695 ((not (assoc tg table))
15696 (org-get-todo-face tg))
15697 ((member tg current) c-face)
15698 ((member tg inherited) i-face)
15699 (t nil))))
15700 (if (and (= cnt 0) (not ingroup)) (insert " "))
15701 (insert "[" c "] " tg (make-string
15702 (- fwidth 4 (length tg)) ?\ ))
15703 (push (cons tg c) ntable)
15704 (when (= (setq cnt (1+ cnt)) ncol)
15706 (if ingroup (insert " "))
15707 (setq cnt 0)))))
15708 (setq ntable (nreverse ntable))
15710 (goto-char (point-min))
15711 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15712 (fit-window-to-buffer))
15713 (setq rtn
15714 (catch 'exit
15715 (while t
15716 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15717 (if groups " [!] no groups" " [!]groups")
15718 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15719 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15720 (cond
15722 ((= c ?!)
15723 (setq groups (not groups))
15724 (goto-char (point-min))
15725 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15726 ((= c ?\C-c)
15727 (if (not expert)
15728 (org-fast-tag-show-exit
15729 (setq exit-after-next (not exit-after-next)))
15730 (setq expert nil)
15731 (delete-other-windows)
15732 (split-window-vertically)
15733 (org-switch-to-buffer-other-window " *Org tags*")
15734 (and (fboundp 'fit-window-to-buffer)
15735 (fit-window-to-buffer))))
15736 ((or (= c ?\C-g)
15737 (and (= c ?q) (not (rassoc c ntable))))
15738 (org-detach-overlay org-tags-overlay)
15739 (setq quit-flag t))
15740 ((= c ?\ )
15741 (setq current nil)
15742 (if exit-after-next (setq exit-after-next 'now)))
15744 (condition-case nil
15745 (setq tg (completing-read
15746 "Tag: "
15747 (or buffer-tags
15748 (with-current-buffer buf
15749 (org-get-buffer-tags)))))
15750 (quit (setq tg "")))
15752 (add-to-list 'buffer-tags (list tg))
15753 (if (member tg current)
15754 (setq current (delete tg current))
15755 (push tg current)))
15756 (if exit-after-next (setq exit-after-next 'now)))
15757 ((setq e (rassoc c todo-table) tg (car e))
15758 (with-current-buffer buf
15759 (save-excursion (org-todo tg)))
15760 (if exit-after-next (setq exit-after-next 'now)))
15761 ((setq e (rassoc c ntable) tg (car e))
15762 (if (member tg current)
15763 (setq current (delete tg current))
15764 (loop for g in groups do
15765 (if (member tg g)
15766 (mapc (lambda (x)
15767 (setq current (delete x current)))
15768 g)))
15769 (push tg current))
15770 (if exit-after-next (setq exit-after-next 'now))))
15772 ;; Create a sorted list
15773 (setq current
15774 (sort current
15775 (lambda (a b)
15776 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15777 (if (eq exit-after-next 'now) (throw 'exit t))
15778 (goto-char (point-min))
15779 (beginning-of-line 2)
15780 (delete-region (point) (point-at-eol))
15781 (org-fast-tag-insert "Current" current c-face)
15782 (org-set-current-tags-overlay current ov-prefix)
15783 (while (re-search-forward
15785 (setq tg (match-string 1))
15786 (add-text-properties
15787 (match-beginning 1) (match-end 1)
15788 (list 'face
15789 (cond
15790 ((member tg current) c-face)
15791 ((member tg inherited) i-face)
15792 (t (get-text-property (match-beginning 1) 'face))))))
15793 (goto-char (point-min)))))
15794 (org-detach-overlay org-tags-overlay)
15795 (if rtn
15796 (mapconcat 'identity current ":")
15797 nil))))
15799 (defun org-get-tags-string ()
15800 "Get the TAGS string in the current headline."
15801 (unless (org-on-heading-p t)
15802 (error "Not on a heading"))
15803 (save-excursion
15804 (beginning-of-line 1)
15806 (org-match-string-no-properties 1)
15807 "")))
15809 (defun org-get-tags ()
15810 "Get the list of tags specified in the current headline."
15811 (org-split-string (org-get-tags-string) ":"))
15813 (defun org-get-buffer-tags ()
15814 "Get a table of all tags used in the buffer, for completion."
15815 (let (tags)
15816 (save-excursion
15817 (goto-char (point-min))
15818 (while (re-search-forward
15820 (when (equal (char-after (point-at-bol 0)) ?*)
15821 (mapc (lambda (x) (add-to-list 'tags x))
15822 (org-split-string (org-match-string-no-properties 1) ":")))))
15823 (mapcar 'list tags)))
15826 ;;;; Properties
15828 ;;; Setting and retrieving properties
15830 (defconst org-special-properties
15831 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15832 "TIMESTAMP" "TIMESTAMP_IA")
15833 "The special properties valid in Org-mode.
15835 These are properties that are not defined in the property drawer,
15836 but in some other way.")
15838 (defconst org-default-properties
15839 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15840 "LOCATION" "LOGGING" "COLUMNS")
15841 "Some properties that are used by Org-mode for various purposes.
15842 Being in this list makes sure that they are offered for completion.")
15845 "Regular expression matching the first line of a property drawer.")
15848 "Regular expression matching the first line of a property drawer.")
15850 (defun org-property-action ()
15851 "Do an action on properties."
15852 (interactive)
15853 (let (c)
15854 (org-at-property-p)
15855 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15856 (setq c (read-char-exclusive))
15857 (cond
15858 ((equal c ?s)
15859 (call-interactively 'org-set-property))
15860 ((equal c ?d)
15861 (call-interactively 'org-delete-property))
15862 ((equal c ?D)
15863 (call-interactively 'org-delete-property-globally))
15864 ((equal c ?c)
15865 (call-interactively 'org-compute-property-at-point))
15866 (t (error "No such property action %c" c)))))
15868 (defun org-at-property-p ()
15869 "Is the cursor in a property line?"
15870 ;; FIXME: Does not check if we are actually in the drawer.
15871 ;; FIXME: also returns true on any drawers.....
15872 ;; This is used by C-c C-c for property action.
15873 (save-excursion
15874 (beginning-of-line 1)
15877 (defmacro org-with-point-at (pom &rest body)
15878 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15879 (declare (indent 1) (debug t))
15880 `(save-excursion
15881 (if (markerp pom) (set-buffer (marker-buffer pom)))
15882 (save-excursion
15883 (goto-char (or pom (point)))
15884 ,@body)))
15886 (defun org-get-property-block (&optional beg end force)
15887 "Return the (beg . end) range of the body of the property drawer.
15888 BEG and END can be beginning and end of subtree, if not given
15889 they will be found.
15890 If the drawer does not exist and FORCE is non-nil, create the drawer."
15891 (catch 'exit
15892 (save-excursion
15893 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15894 (end (or end (progn (outline-next-heading) (point)))))
15895 (goto-char beg)
15896 (if (re-search-forward org-property-start-re end t)
15897 (setq beg (1+ (match-end 0)))
15898 (if force
15899 (save-excursion
15900 (org-insert-property-drawer)
15901 (setq end (progn (outline-next-heading) (point))))
15902 (throw 'exit nil))
15903 (goto-char beg)
15904 (if (re-search-forward org-property-start-re end t)
15905 (setq beg (1+ (match-end 0)))))
15906 (if (re-search-forward org-property-end-re end t)
15907 (setq end (match-beginning 0))
15908 (or force (throw 'exit nil))
15909 (goto-char beg)
15910 (setq end beg)
15911 (org-indent-line-function)
15913 (cons beg end)))))
15915 (defun org-entry-properties (&optional pom which)
15916 "Get all properties of the entry at point-or-marker POM.
15917 This includes the TODO keyword, the tags, time strings for deadline,
15918 scheduled, and clocking, and any additional properties defined in the
15919 entry. The return value is an alist, keys may occur multiple times
15920 if the property key was used several times.
15921 POM may also be nil, in which case the current entry is used.
15922 If WHICH is nil or `all', get all properties. If WHICH is
15923 `special' or `standard', only get that subclass."
15924 (setq which (or which 'all))
15925 (org-with-point-at pom
15926 (let ((clockstr (substring org-clock-string 0 -1))
15927 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15928 beg end range props sum-props key value string clocksum)
15929 (save-excursion
15930 (when (condition-case nil (org-back-to-heading t) (error nil))
15931 (setq beg (point))
15932 (setq sum-props (get-text-property (point) 'org-summaries))
15933 (setq clocksum (get-text-property (point) :org-clock-minutes))
15934 (outline-next-heading)
15935 (setq end (point))
15936 (when (memq which '(all special))
15937 ;; Get the special properties, like TODO and tags
15938 (goto-char beg)
15939 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15940 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15941 (when (looking-at org-priority-regexp)
15942 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15943 (when (and (setq value (org-get-tags-string))
15945 (push (cons "TAGS" value) props))
15946 (when (setq value (org-get-tags-at))
15947 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15948 props))
15949 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15950 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15951 string (if (equal key clockstr)
15952 (org-no-properties
15953 (org-trim
15954 (buffer-substring
15955 (match-beginning 3) (goto-char (point-at-eol)))))
15956 (substring (org-match-string-no-properties 3) 1 -1)))
15957 (unless key
15958 (if (= (char-after (match-beginning 3)) ?\[)
15959 (setq key "TIMESTAMP_IA")
15960 (setq key "TIMESTAMP")))
15961 (when (or (equal key clockstr) (not (assoc key props)))
15962 (push (cons key string) props)))
15964 )
15966 (when (memq which '(all standard))
15967 ;; Get the standard properties, like :PORP: ...
15968 (setq range (org-get-property-block beg end))
15969 (when range
15970 (goto-char (car range))
15971 (while (re-search-forward
15973 (cdr range) t)
15974 (setq key (org-match-string-no-properties 1)
15975 value (org-trim (or (org-match-string-no-properties 2) "")))
15976 (unless (member key excluded)
15977 (push (cons key (or value "")) props)))))
15978 (if clocksum
15979 (push (cons "CLOCKSUM"
15980 (org-column-number-to-string (/ (float clocksum) 60.)
15981 'add_times))
15982 props))
15983 (append sum-props (nreverse props)))))))
15985 (defun org-entry-get (pom property &optional inherit)
15986 "Get value of PROPERTY for entry at point-or-marker POM.
15987 If INHERIT is non-nil and the entry does not have the property,
15988 then also check higher levels of the hierarchy.
15989 If the property is present but empty, the return value is the empty string.
15990 If the property is not present at all, nil is returned."
15991 (org-with-point-at pom
15992 (if inherit
15993 (org-entry-get-with-inheritance property)
15994 (if (member property org-special-properties)
15995 ;; We need a special property. Use brute force, get all properties.
15996 (cdr (assoc property (org-entry-properties nil 'special)))
15997 (let ((range (org-get-property-block)))
15998 (if (and range
15999 (goto-char (car range))
16000 (re-search-forward
16002 (cdr range) t))
16003 ;; Found the property, return it.
16004 (if (match-end 1)
16005 (org-match-string-no-properties 1)
16006 "")))))))
16008 (defun org-entry-delete (pom property)
16009 "Delete the property PROPERTY from entry at point-or-marker POM."
16010 (org-with-point-at pom
16011 (if (member property org-special-properties)
16012 nil ; cannot delete these properties.
16013 (let ((range (org-get-property-block)))
16014 (if (and range
16015 (goto-char (car range))
16016 (re-search-forward
16018 (cdr range) t))
16019 (progn
16020 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16021 t)
16022 nil)))))
16024 ;; Multi-values properties are properties that contain multiple values
16025 ;; These values are assumed to be single words, separated by whitespace.
16026 (defun org-entry-add-to-multivalued-property (pom property value)
16027 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16028 (let* ((old (org-entry-get pom property))
16030 (unless (member value values)
16031 (setq values (cons value values))
16032 (org-entry-put pom property
16033 (mapconcat 'identity values " ")))))
16035 (defun org-entry-remove-from-multivalued-property (pom property value)
16036 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16037 (let* ((old (org-entry-get pom property))
16039 (when (member value values)
16040 (setq values (delete value values))
16041 (org-entry-put pom property
16042 (mapconcat 'identity values " ")))))
16044 (defun org-entry-member-in-multivalued-property (pom property value)
16045 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16046 (let* ((old (org-entry-get pom property))
16048 (member value values)))
16050 (defvar org-entry-property-inherited-from (make-marker))
16052 (defun org-entry-get-with-inheritance (property)
16053 "Get entry property, and search higher levels if not present."
16054 (let (tmp)
16055 (save-excursion
16056 (save-restriction
16057 (widen)
16058 (catch 'ex
16059 (while t
16060 (when (setq tmp (org-entry-get nil property))
16061 (org-back-to-heading t)
16062 (move-marker org-entry-property-inherited-from (point))
16063 (throw 'ex tmp))
16064 (or (org-up-heading-safe) (throw 'ex nil)))))
16065 (or tmp (cdr (assoc property org-local-properties))
16066 (cdr (assoc property org-global-properties))))))
16068 (defun org-entry-put (pom property value)
16069 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16070 (org-with-point-at pom
16071 (org-back-to-heading t)
16072 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16073 range)
16074 (cond
16075 ((equal property "TODO")
16077 (not (member value org-todo-keywords-1)))
16079 (if (or (not value)
16081 (setq value 'none))
16082 (org-todo value)
16083 (org-set-tags nil 'align))
16084 ((equal property "PRIORITY")
16086 (string-to-char value) ?\ ))
16087 (org-set-tags nil 'align))
16088 ((equal property "SCHEDULED")
16089 (if (re-search-forward org-scheduled-time-regexp end t)
16090 (cond
16091 ((eq value 'earlier) (org-timestamp-change -1 'day))
16092 ((eq value 'later) (org-timestamp-change 1 'day))
16093 (t (call-interactively 'org-schedule)))
16094 (call-interactively 'org-schedule)))
16095 ((equal property "DEADLINE")
16096 (if (re-search-forward org-deadline-time-regexp end t)
16097 (cond
16098 ((eq value 'earlier) (org-timestamp-change -1 'day))
16099 ((eq value 'later) (org-timestamp-change 1 'day))
16100 (t (call-interactively 'org-deadline)))
16101 (call-interactively 'org-deadline)))
16102 ((member property org-special-properties)
16103 (error "The %s property can not yet be set with `org-entry-put'"
16104 property))
16105 (t ; a non-special property
16106 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16107 (setq range (org-get-property-block beg end 'force))
16108 (goto-char (car range))
16109 (if (re-search-forward
16111 (progn
16112 (delete-region (match-beginning 1) (match-end 1))
16113 (goto-char (match-beginning 1)))
16114 (goto-char (cdr range))
16116 (backward-char 1)
16117 (org-indent-line-function)
16118 (insert ":" property ":"))
16119 (and value (insert " " value))
16120 (org-indent-line-function)))))))
16122 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16123 "Get all property keys in the current buffer.
16124 With INCLUDE-SPECIALS, also list the special properties that relect things
16125 like tags and TODO state.
16126 With INCLUDE-DEFAULTS, also include properties that has special meaning
16127 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16128 With INCLUDE-COLUMNS, also include property names given in COLUMN
16129 formats in the current buffer."
16130 (let (rtn range cfmt cols)
16131 (save-excursion
16132 (save-restriction
16133 (widen)
16134 (goto-char (point-min))
16135 (while (re-search-forward org-property-start-re nil t)
16136 (setq range (org-get-property-block))
16137 (goto-char (car range))
16138 (while (re-search-forward
16140 (cdr range) t)
16141 (add-to-list 'rtn (org-match-string-no-properties 1)))
16142 (outline-next-heading))))
16144 (when include-specials
16145 (setq rtn (append org-special-properties rtn)))
16147 (when include-defaults
16148 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16150 (when include-columns
16151 (save-excursion
16152 (save-restriction
16153 (widen)
16154 (goto-char (point-min))
16155 (while (re-search-forward
16157 nil t)
16158 (setq cfmt (match-string 2) s 0)
16160 cfmt s)
16161 (setq s (match-end 0)
16162 p (match-string 1 cfmt))
16163 (unless (or (equal p "ITEM")
16164 (member p org-special-properties))
16165 (add-to-list 'rtn (match-string 1 cfmt))))))))
16167 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16169 (defun org-property-values (key)
16170 "Return a list of all values of property KEY."
16171 (save-excursion
16172 (save-restriction
16173 (widen)
16174 (goto-char (point-min))
16176 values)
16177 (while (re-search-forward re nil t)
16178 (add-to-list 'values (org-trim (match-string 1))))
16179 (delete "" values)))))
16181 (defun org-insert-property-drawer ()
16182 "Insert a property drawer into the current entry."
16183 (interactive)
16184 (org-back-to-heading t)
16185 (looking-at outline-regexp)
16186 (let ((indent (- (match-end 0)(match-beginning 0)))
16187 (beg (point))
16189 end hiddenp)
16190 (outline-next-heading)
16191 (setq end (point))
16192 (goto-char beg)
16193 (while (re-search-forward re end t))
16194 (setq hiddenp (org-invisible-p))
16195 (end-of-line 1)
16197 (org-skip-over-state-notes)
16199 (if (eq (char-before) ?*) (forward-char 1))
16201 (beginning-of-line 0)
16202 (indent-to-column indent)
16203 (beginning-of-line 2)
16204 (indent-to-column indent)
16205 (beginning-of-line 0)
16206 (if hiddenp
16207 (save-excursion
16208 (org-back-to-heading t)
16209 (hide-entry))
16210 (org-flag-drawer t))))
16212 (defun org-set-property (property value)
16213 "In the current entry, set PROPERTY to VALUE.
16214 When called interactively, this will prompt for a property name, offering
16215 completion on existing and default properties. And then it will prompt
16216 for a value, offering competion either on allowed values (via an inherited
16217 xxx_ALL property) or on existing values in other instances of this property
16218 in the current file."
16219 (interactive
16220 (let* ((prop (completing-read
16221 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16222 (cur (org-entry-get nil prop))
16223 (allowed (org-property-get-allowed-values nil prop 'table))
16224 (existing (mapcar 'list (org-property-values prop)))
16225 (val (if allowed
16226 (completing-read "Value: " allowed nil 'req-match)
16227 (completing-read
16229 (concat "[" cur "]") "")
16230 ": ")
16231 existing nil nil "" nil cur))))
16232 (list prop (if (equal val "") cur val))))
16233 (unless (equal (org-entry-get nil property) value)
16234 (org-entry-put nil property value)))
16236 (defun org-delete-property (property)
16237 "In the current entry, delete PROPERTY."
16238 (interactive
16239 (let* ((prop (completing-read
16240 "Property: " (org-entry-properties nil 'standard))))
16241 (list prop)))
16242 (message "Property %s %s" property
16243 (if (org-entry-delete nil property)
16244 "deleted"
16245 "was not present in the entry")))
16247 (defun org-delete-property-globally (property)
16248 "Remove PROPERTY globally, from all entries."
16249 (interactive
16250 (let* ((prop (completing-read
16251 "Globally remove property: "
16252 (mapcar 'list (org-buffer-property-keys)))))
16253 (list prop)))
16254 (save-excursion
16255 (save-restriction
16256 (widen)
16257 (goto-char (point-min))
16258 (let ((cnt 0))
16259 (while (re-search-forward
16261 nil t)
16262 (setq cnt (1+ cnt))
16263 (replace-match ""))
16266 (defvar org-columns-current-fmt-compiled) ; defined below
16268 (defun org-compute-property-at-point ()
16269 "Compute the property at point.
16270 This looks for an enclosing column format, extracts the operator and
16271 then applies it to the proerty in the column format's scope."
16272 (interactive)
16273 (unless (org-at-property-p)
16274 (error "Not at a property"))
16275 (let ((prop (org-match-string-no-properties 2)))
16276 (org-columns-get-format-and-top-level)
16277 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16278 (error "No operator defined for property %s" prop))
16279 (org-columns-compute prop)))
16281 (defun org-property-get-allowed-values (pom property &optional table)
16282 "Get allowed values for the property PROPERTY.
16283 When TABLE is non-nil, return an alist that can directly be used for
16284 completion."
16285 (let (vals)
16286 (cond
16287 ((equal property "TODO")
16288 (setq vals (org-with-point-at pom
16289 (append org-todo-keywords-1 '("")))))
16290 ((equal property "PRIORITY")
16291 (let ((n org-lowest-priority))
16292 (while (>= n org-highest-priority)
16293 (push (char-to-string n) vals)
16294 (setq n (1- n)))))
16295 ((member property org-special-properties))
16296 (t
16297 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16300 (setq vals (car (read-from-string (concat "(" vals ")"))))
16301 (setq vals (mapcar (lambda (x)
16302 (cond ((stringp x) x)
16303 ((numberp x) (number-to-string x))
16304 ((symbolp x) (symbol-name x))
16305 (t "???")))
16306 vals)))))
16307 (if table (mapcar 'list vals) vals)))
16309 (defun org-property-previous-allowed-value (&optional previous)
16310 "Switch to the next allowed value for this property."
16311 (interactive)
16312 (org-property-next-allowed-value t))
16314 (defun org-property-next-allowed-value (&optional previous)
16315 "Switch to the next allowed value for this property."
16316 (interactive)
16317 (unless (org-at-property-p)
16318 (error "Not at a property"))
16319 (let* ((key (match-string 2))
16320 (value (match-string 3))
16321 (allowed (or (org-property-get-allowed-values (point) key)
16322 (and (member value '("[ ]" "[-]" "[X]"))
16323 '("[ ]" "[X]"))))
16324 nval)
16325 (unless allowed
16326 (error "Allowed values for this property have not been defined"))
16327 (if previous (setq allowed (reverse allowed)))
16328 (if (member value allowed)
16329 (setq nval (car (cdr (member value allowed)))))
16330 (setq nval (or nval (car allowed)))
16331 (if (equal nval value)
16332 (error "Only one allowed value for this property"))
16333 (org-at-property-p)
16334 (replace-match (concat " :" key ": " nval) t t)
16335 (org-indent-line-function)
16336 (beginning-of-line 1)
16339 (defun org-find-entry-with-id (ident)
16340 "Locate the entry that contains the ID property with exact value IDENT.
16341 IDENT can be a string, a symbol or a number, this function will search for
16342 the string representation of it.
16343 Return the position where this entry starts, or nil if there is no such entry."
16344 (let ((id (cond
16345 ((stringp ident) ident)
16346 ((symbol-name ident) (symbol-name ident))
16347 ((numberp ident) (number-to-string ident))
16348 (t (error "IDENT %s must be a string, symbol or number" ident))))
16349 (case-fold-search nil))
16350 (save-excursion
16351 (save-restriction
16352 (goto-char (point-min))
16353 (when (re-search-forward
16355 nil t)
16356 (org-back-to-heading)
16357 (point))))))
16359 ;;; Column View
16361 (defvar org-columns-overlays nil
16362 "Holds the list of current column overlays.")
16364 (defvar org-columns-current-fmt nil
16365 "Local variable, holds the currently active column format.")
16366 (defvar org-columns-current-fmt-compiled nil
16367 "Local variable, holds the currently active column format.
16368 This is the compiled version of the format.")
16369 (defvar org-columns-current-widths nil
16370 "Loval variable, holds the currently widths of fields.")
16371 (defvar org-columns-current-maxwidths nil
16372 "Loval variable, holds the currently active maximum column widths.")
16373 (defvar org-columns-begin-marker (make-marker)
16374 "Points to the position where last a column creation command was called.")
16375 (defvar org-columns-top-level-marker (make-marker)
16376 "Points to the position where current columns region starts.")
16378 (defvar org-columns-map (make-sparse-keymap)
16379 "The keymap valid in column display.")
16381 (defun org-columns-content ()
16382 "Switch to contents view while in columns view."
16383 (interactive)
16384 (org-overview)
16385 (org-content))
16387 (org-defkey org-columns-map "c" 'org-columns-content)
16388 (org-defkey org-columns-map "o" 'org-overview)
16389 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16390 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16391 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16392 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16393 (org-defkey org-columns-map "v" 'org-columns-show-value)
16394 (org-defkey org-columns-map "q" 'org-columns-quit)
16395 (org-defkey org-columns-map "r" 'org-columns-redo)
16396 (org-defkey org-columns-map "g" 'org-columns-redo)
16397 (org-defkey org-columns-map [left] 'backward-char)
16398 (org-defkey org-columns-map "\M-b" 'backward-char)
16399 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16400 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16401 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16402 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16403 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16404 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16405 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16406 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16407 (org-defkey org-columns-map "<" 'org-columns-narrow)
16408 (org-defkey org-columns-map ">" 'org-columns-widen)
16409 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16410 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16411 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16412 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16414 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16415 '("Column"
16416 ["Edit property" org-columns-edit-value t]
16417 ["Next allowed value" org-columns-next-allowed-value t]
16418 ["Previous allowed value" org-columns-previous-allowed-value t]
16419 ["Show full value" org-columns-show-value t]
16420 ["Edit allowed values" org-columns-edit-allowed t]
16421 "--"
16422 ["Edit column attributes" org-columns-edit-attributes t]
16423 ["Increase column width" org-columns-widen t]
16424 ["Decrease column width" org-columns-narrow t]
16425 "--"
16426 ["Move column right" org-columns-move-right t]
16427 ["Move column left" org-columns-move-left t]
16428 ["Add column" org-columns-new t]
16429 ["Delete column" org-columns-delete t]
16430 "--"
16431 ["CONTENTS" org-columns-content t]
16432 ["OVERVIEW" org-overview t]
16433 ["Refresh columns display" org-columns-redo t]
16434 "--"
16435 ["Open link" org-columns-open-link t]
16436 "--"
16437 ["Quit" org-columns-quit t]))
16439 (defun org-columns-new-overlay (beg end &optional string face)
16440 "Create a new column overlay and add it to the list."
16441 (let ((ov (org-make-overlay beg end)))
16442 (org-overlay-put ov 'face (or face 'secondary-selection))
16443 (org-overlay-display ov string face)
16444 (push ov org-columns-overlays)
16445 ov))
16447 (defun org-columns-display-here (&optional props)
16448 "Overlay the current line with column display."
16449 (interactive)
16450 (let* ((fmt org-columns-current-fmt-compiled)
16451 (beg (point-at-bol))
16452 (level-face (save-excursion
16453 (beginning-of-line 1)
16455 (org-get-level-face 2))))
16456 (color (list :foreground
16457 (face-attribute (or level-face 'default) :foreground)))
16458 props pom property ass width f string ov column val modval)
16459 ;; Check if the entry is in another buffer.
16460 (unless props
16461 (if (eq major-mode 'org-agenda-mode)
16462 (setq pom (or (get-text-property (point) 'org-hd-marker)
16463 (get-text-property (point) 'org-marker))
16464 props (if pom (org-entry-properties pom) nil))
16465 (setq props (org-entry-properties nil))))
16466 ;; Walk the format
16467 (while (setq column (pop fmt))
16468 (setq property (car column)
16469 ass (if (equal property "ITEM")
16470 (cons "ITEM"
16471 (save-match-data
16472 (org-no-properties
16473 (org-remove-tabs
16474 (buffer-substring-no-properties
16475 (point-at-bol) (point-at-eol))))))
16476 (assoc property props))
16477 width (or (cdr (assoc property org-columns-current-maxwidths))
16478 (nth 2 column)
16479 (length property))
16480 f (format "%%-%d.%ds | " width width)
16481 val (or (cdr ass) "")
16482 modval (if (equal property "ITEM")
16483 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16484 string (format f (or modval val)))
16485 ;; Create the overlay
16486 (org-unmodified
16487 (setq ov (org-columns-new-overlay
16488 beg (setq beg (1+ beg)) string
16489 (list color 'org-column)))
16490 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16491 (org-overlay-put ov 'keymap org-columns-map)
16492 (org-overlay-put ov 'org-columns-key property)
16493 (org-overlay-put ov 'org-columns-value (cdr ass))
16494 (org-overlay-put ov 'org-columns-value-modified modval)
16495 (org-overlay-put ov 'org-columns-pom pom)
16496 (org-overlay-put ov 'org-columns-format f))
16497 (if (or (not (char-after beg))
16499 (let ((inhibit-read-only t))
16500 (save-excursion
16501 (goto-char beg)
16502 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16503 ;; Make the rest of the line disappear.
16504 (org-unmodified
16505 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16506 (org-overlay-put ov 'invisible t)
16507 (org-overlay-put ov 'keymap org-columns-map)
16508 (org-overlay-put ov 'intangible t)
16509 (push ov org-columns-overlays)
16510 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16511 (org-overlay-put ov 'keymap org-columns-map)
16512 (push ov org-columns-overlays)
16513 (let ((inhibit-read-only t))
16514 (put-text-property (max (point-min) (1- (point-at-bol)))
16515 (min (point-max) (1+ (point-at-eol)))
16516 'read-only "Type `e' to edit property")))))
16518 (defvar org-previous-header-line-format nil
16519 "The header line format before column view was turned on.")
16520 (defvar org-columns-inhibit-recalculation nil
16521 "Inhibit recomputing of columns on column view startup.")
16524 (defvar header-line-format)
16525 (defun org-columns-display-here-title ()
16526 "Overlay the newline before the current line with the table title."
16527 (interactive)
16528 (let ((fmt org-columns-current-fmt-compiled)
16529 string (title "")
16530 property width f column str widths)
16531 (while (setq column (pop fmt))
16532 (setq property (car column)
16533 str (or (nth 1 column) property)
16534 width (or (cdr (assoc property org-columns-current-maxwidths))
16535 (nth 2 column)
16536 (length str))
16537 widths (push width widths)
16538 f (format "%%-%d.%ds | " width width)
16539 string (format f str)
16540 title (concat title string)))
16541 (setq title (concat
16542 (org-add-props " " nil 'display '(space :align-to 0))
16543 (org-add-props title nil 'face '(:weight bold :underline t))))
16544 (org-set-local 'org-previous-header-line-format header-line-format)
16545 (org-set-local 'org-columns-current-widths (nreverse widths))
16546 (setq header-line-format title)))
16548 (defun org-columns-remove-overlays ()
16549 "Remove all currently active column overlays."
16550 (interactive)
16551 (when (marker-buffer org-columns-begin-marker)
16552 (with-current-buffer (marker-buffer org-columns-begin-marker)
16553 (when (local-variable-p 'org-previous-header-line-format)
16554 (setq header-line-format org-previous-header-line-format)
16555 (kill-local-variable 'org-previous-header-line-format))
16556 (move-marker org-columns-begin-marker nil)
16557 (move-marker org-columns-top-level-marker nil)
16558 (org-unmodified
16559 (mapc 'org-delete-overlay org-columns-overlays)
16560 (setq org-columns-overlays nil)
16561 (let ((inhibit-read-only t))
16562 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16564 (defun org-columns-cleanup-item (item fmt)
16565 "Remove from ITEM what is a column in the format FMT."
16566 (if (not org-complex-heading-regexp)
16567 item
16568 (when (string-match org-complex-heading-regexp item)
16569 (concat
16570 (org-add-props (concat (match-string 1 item) " ") nil
16571 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16572 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16573 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16574 " " (match-string 4 item)
16575 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16577 (defun org-columns-show-value ()
16578 "Show the full value of the property."
16579 (interactive)
16580 (let ((value (get-char-property (point) 'org-columns-value)))
16581 (message "Value is: %s" (or value ""))))
16583 (defun org-columns-quit ()
16584 "Remove the column overlays and in this way exit column editing."
16585 (interactive)
16586 (org-unmodified
16587 (org-columns-remove-overlays)
16588 (let ((inhibit-read-only t))
16589 (remove-text-properties (point-min) (point-max) '(read-only t))))
16590 (when (eq major-mode 'org-agenda-mode)
16591 (message
16592 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16594 (defun org-columns-check-computed ()
16595 "Check if this column value is computed.
16596 If yes, throw an error indicating that changing it does not make sense."
16597 (let ((val (get-char-property (point) 'org-columns-value)))
16598 (when (and (stringp val)
16599 (get-char-property 0 'org-computed val))
16600 (error "This value is computed from the entry's children"))))
16602 (defun org-columns-todo (&optional arg)
16603 "Change the TODO state during column view."
16604 (interactive "P")
16605 (org-columns-edit-value "TODO"))
16607 (defun org-columns-set-tags-or-toggle (&optional arg)
16608 "Toggle checkbox at point, or set tags for current headline."
16609 (interactive "P")
16611 (get-char-property (point) 'org-columns-value))
16612 (org-columns-next-allowed-value)
16613 (org-columns-edit-value "TAGS")))
16615 (defun org-columns-edit-value (&optional key)
16616 "Edit the value of the property at point in column view.
16617 Where possible, use the standard interface for changing this line."
16618 (interactive)
16619 (org-columns-check-computed)
16620 (let* ((external-key key)
16621 (col (current-column))
16622 (key (or key (get-char-property (point) 'org-columns-key)))
16623 (value (get-char-property (point) 'org-columns-value))
16624 (bol (point-at-bol)) (eol (point-at-eol))
16625 (pom (or (get-text-property bol 'org-hd-marker)
16626 (point))) ; keep despite of compiler waring
16627 (line-overlays
16628 (delq nil (mapcar (lambda (x)
16629 (and (eq (overlay-buffer x) (current-buffer))
16630 (>= (overlay-start x) bol)
16631 (<= (overlay-start x) eol)
16632 x))
16633 org-columns-overlays)))
16634 nval eval allowed)
16635 (cond
16636 ((equal key "CLOCKSUM")
16637 (error "This special column cannot be edited"))
16638 ((equal key "ITEM")
16639 (setq eval '(org-with-point-at pom
16640 (org-edit-headline))))
16641 ((equal key "TODO")
16642 (setq eval '(org-with-point-at pom
16643 (let ((current-prefix-arg
16644 (if external-key current-prefix-arg '(4))))
16645 (call-interactively 'org-todo)))))
16646 ((equal key "PRIORITY")
16647 (setq eval '(org-with-point-at pom
16648 (call-interactively 'org-priority))))
16649 ((equal key "TAGS")
16650 (setq eval '(org-with-point-at pom
16651 (let ((org-fast-tag-selection-single-key
16652 (if (eq org-fast-tag-selection-single-key 'expert)
16653 t org-fast-tag-selection-single-key)))
16654 (call-interactively 'org-set-tags)))))
16655 ((equal key "DEADLINE")
16656 (setq eval '(org-with-point-at pom
16657 (call-interactively 'org-deadline))))
16658 ((equal key "SCHEDULED")
16659 (setq eval '(org-with-point-at pom
16660 (call-interactively 'org-schedule))))
16661 (t
16662 (setq allowed (org-property-get-allowed-values pom key 'table))
16663 (if allowed
16664 (setq nval (completing-read "Value: " allowed nil t))
16665 (setq nval (read-string "Edit: " value)))
16666 (setq nval (org-trim nval))
16667 (when (not (equal nval value))
16668 (setq eval '(org-entry-put pom key nval)))))
16669 (when eval
16670 (let ((inhibit-read-only t))
16671 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16672 (unwind-protect
16673 (progn
16674 (setq org-columns-overlays
16675 (org-delete-all line-overlays org-columns-overlays))
16676 (mapc 'org-delete-overlay line-overlays)
16677 (org-columns-eval eval))
16678 (org-columns-display-here))))
16679 (move-to-column col)
16680 (if (and (org-mode-p)
16681 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16682 (org-columns-update key))))
16684 (defun org-edit-headline () ; FIXME: this is not columns specific
16685 "Edit the current headline, the part without TODO keyword, TAGS."
16686 (org-back-to-heading)
16687 (when (looking-at org-todo-line-regexp)
16688 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16689 (txt (match-string 3))
16690 (post "")
16691 txt2)
16693 (setq post (match-string 0 txt)
16694 txt (substring txt 0 (match-beginning 0))))
16695 (setq txt2 (read-string "Edit: " txt))
16696 (when (not (equal txt txt2))
16697 (beginning-of-line 1)
16698 (insert pre txt2 post)
16699 (delete-region (point) (point-at-eol))
16700 (org-set-tags nil t)))))
16702 (defun org-columns-edit-allowed ()
16703 "Edit the list of allowed values for the current property."
16704 (interactive)
16705 (let* ((key (get-char-property (point) 'org-columns-key))
16706 (key1 (concat key "_ALL"))
16707 (allowed (org-entry-get (point) key1 t))
16708 nval)
16709 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16710 (setq nval (read-string "Allowed: " allowed))
16711 (org-entry-put
16712 (cond ((marker-position org-entry-property-inherited-from)
16713 org-entry-property-inherited-from)
16714 ((marker-position org-columns-top-level-marker)
16715 org-columns-top-level-marker))
16716 key1 nval)))
16718 (defmacro org-no-warnings (&rest body)
16719 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16721 (defun org-columns-eval (form)
16722 (let (hidep)
16723 (save-excursion
16724 (beginning-of-line 1)
16725 ;; `next-line' is needed here, because it skips invisible line.
16726 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16727 (setq hidep (org-on-heading-p 1)))
16728 (eval form)
16729 (and hidep (hide-entry))))
16731 (defun org-columns-previous-allowed-value ()
16732 "Switch to the previous allowed value for this column."
16733 (interactive)
16734 (org-columns-next-allowed-value t))
16736 (defun org-columns-next-allowed-value (&optional previous)
16737 "Switch to the next allowed value for this column."
16738 (interactive)
16739 (org-columns-check-computed)
16740 (let* ((col (current-column))
16741 (key (get-char-property (point) 'org-columns-key))
16742 (value (get-char-property (point) 'org-columns-value))
16743 (bol (point-at-bol)) (eol (point-at-eol))
16744 (pom (or (get-text-property bol 'org-hd-marker)
16745 (point))) ; keep despite of compiler waring
16746 (line-overlays
16747 (delq nil (mapcar (lambda (x)
16748 (and (eq (overlay-buffer x) (current-buffer))
16749 (>= (overlay-start x) bol)
16750 (<= (overlay-start x) eol)
16751 x))
16752 org-columns-overlays)))
16753 (allowed (or (org-property-get-allowed-values pom key)
16754 (and (equal
16755 (nth 4 (assoc key org-columns-current-fmt-compiled))
16756 'checkbox) '("[ ]" "[X]"))))
16757 nval)
16758 (when (equal key "ITEM")
16759 (error "Cannot edit item headline from here"))
16760 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16761 (error "Allowed values for this property have not been defined"))
16762 (if (member key '("SCHEDULED" "DEADLINE"))
16763 (setq nval (if previous 'earlier 'later))
16764 (if previous (setq allowed (reverse allowed)))
16765 (if (member value allowed)
16766 (setq nval (car (cdr (member value allowed)))))
16767 (setq nval (or nval (car allowed)))
16768 (if (equal nval value)
16769 (error "Only one allowed value for this property")))
16770 (let ((inhibit-read-only t))
16771 (remove-text-properties (1- bol) eol '(read-only t))
16772 (unwind-protect
16773 (progn
16774 (setq org-columns-overlays
16775 (org-delete-all line-overlays org-columns-overlays))
16776 (mapc 'org-delete-overlay line-overlays)
16777 (org-columns-eval '(org-entry-put pom key nval)))
16778 (org-columns-display-here)))
16779 (move-to-column col)
16780 (if (and (org-mode-p)
16781 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16782 (org-columns-update key))))
16784 (defun org-verify-version (task)
16785 (cond
16786 ((eq task 'columns)
16787 (if (or (featurep 'xemacs)
16788 (< emacs-major-version 22))
16789 (error "Emacs 22 is required for the columns feature")))))
16791 (defun org-columns-open-link (&optional arg)
16792 (interactive "P")
16793 (let ((key (get-char-property (point) 'org-columns-key))
16794 (value (get-char-property (point) 'org-columns-value)))
16795 (org-open-link-from-string arg)))
16797 (defun org-open-link-from-string (s &optional arg)
16798 "Open a link in the string S, as if it was in Org-mode."
16799 (interactive)
16800 (with-temp-buffer
16801 (let ((org-inhibit-startup t))
16802 (org-mode)
16803 (insert s)
16804 (goto-char (point-min))
16805 (org-open-at-point arg))))
16807 (defun org-columns-get-format-and-top-level ()
16808 (let (fmt)
16809 (when (condition-case nil (org-back-to-heading) (error nil))
16810 (move-marker org-entry-property-inherited-from nil)
16811 (setq fmt (org-entry-get nil "COLUMNS" t)))
16812 (setq fmt (or fmt org-columns-default-format))
16813 (org-set-local 'org-columns-current-fmt fmt)
16814 (org-columns-compile-format fmt)
16815 (if (marker-position org-entry-property-inherited-from)
16816 (move-marker org-columns-top-level-marker
16817 org-entry-property-inherited-from)
16818 (move-marker org-columns-top-level-marker (point)))
16819 fmt))
16821 (defun org-columns ()
16822 "Turn on column view on an org-mode file."
16823 (interactive)
16824 (org-verify-version 'columns)
16825 (org-columns-remove-overlays)
16826 (move-marker org-columns-begin-marker (point))
16827 (let (beg end fmt cache maxwidths clocksump)
16828 (setq fmt (org-columns-get-format-and-top-level))
16829 (save-excursion
16830 (goto-char org-columns-top-level-marker)
16831 (setq beg (point))
16832 (unless org-columns-inhibit-recalculation
16833 (org-columns-compute-all))
16834 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16835 (point-max)))
16836 ;; Get and cache the properties
16837 (goto-char beg)
16838 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16839 (setq clocksump t)
16840 (save-excursion
16841 (save-restriction
16842 (narrow-to-region beg end)
16843 (org-clock-sum))))
16844 (while (re-search-forward (concat "^" outline-regexp) end t)
16845 (push (cons (org-current-line) (org-entry-properties)) cache))
16846 (when cache
16847 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16848 (org-set-local 'org-columns-current-maxwidths maxwidths)
16849 (org-columns-display-here-title)
16850 (mapc (lambda (x)
16851 (goto-line (car x))
16852 (org-columns-display-here (cdr x)))
16853 cache)))))
16855 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16856 "Insert a new column, to the leeft o the current column."
16857 (interactive)
16858 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16859 cell)
16860 (setq prop (completing-read
16861 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
16862 nil nil prop))
16863 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16864 (setq width (read-string "Column width: " (if width (number-to-string width))))
16866 (setq width (string-to-number width))
16867 (setq width nil))
16868 (setq fmt (completing-read "Summary [none]: "
16869 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox"))
16870 nil t))
16872 (setq fmt (intern fmt))
16873 (setq fmt nil))
16874 (if (eq fmt 'none) (setq fmt nil))
16875 (if editp
16876 (progn
16877 (setcar editp prop)
16878 (setcdr editp (list title width nil fmt)))
16879 (setq cell (nthcdr (1- (current-column))
16880 org-columns-current-fmt-compiled))
16881 (setcdr cell (cons (list prop title width nil fmt)
16882 (cdr cell))))
16883 (org-columns-store-format)
16884 (org-columns-redo)))
16886 (defun org-columns-delete ()
16887 "Delete the column at point from columns view."
16888 (interactive)
16889 (let* ((n (current-column))
16890 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16891 (when (y-or-n-p
16893 (setq org-columns-current-fmt-compiled
16894 (delq (nth n org-columns-current-fmt-compiled)
16895 org-columns-current-fmt-compiled))
16896 (org-columns-store-format)
16897 (org-columns-redo)
16898 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16899 (backward-char 1)))))
16901 (defun org-columns-edit-attributes ()
16902 "Edit the attributes of the current column."
16903 (interactive)
16904 (let* ((n (current-column))
16905 (info (nth n org-columns-current-fmt-compiled)))
16906 (apply 'org-columns-new info)))
16908 (defun org-columns-widen (arg)
16909 "Make the column wider by ARG characters."
16910 (interactive "p")
16911 (let* ((n (current-column))
16912 (entry (nth n org-columns-current-fmt-compiled))
16913 (width (or (nth 2 entry)
16914 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16915 (setq width (max 1 (+ width arg)))
16916 (setcar (nthcdr 2 entry) width)
16917 (org-columns-store-format)
16918 (org-columns-redo)))
16920 (defun org-columns-narrow (arg)
16921 "Make the column nrrower by ARG characters."
16922 (interactive "p")
16923 (org-columns-widen (- arg)))
16925 (defun org-columns-move-right ()
16926 "Swap this column with the one to the right."
16927 (interactive)
16928 (let* ((n (current-column))
16929 (cell (nthcdr n org-columns-current-fmt-compiled))
16930 e)
16931 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16932 (error "Cannot shift this column further to the right"))
16933 (setq e (car cell))
16934 (setcar cell (car (cdr cell)))
16935 (setcdr cell (cons e (cdr (cdr cell))))
16936 (org-columns-store-format)
16937 (org-columns-redo)
16938 (forward-char 1)))
16940 (defun org-columns-move-left ()
16941 "Swap this column with the one to the left."
16942 (interactive)
16943 (let* ((n (current-column)))
16944 (when (= n 0)
16945 (error "Cannot shift this column further to the left"))
16946 (backward-char 1)
16947 (org-columns-move-right)
16948 (backward-char 1)))
16950 (defun org-columns-store-format ()
16951 "Store the text version of the current columns format in appropriate place.
16952 This is either in the COLUMNS property of the node starting the current column
16953 display, or in the #+COLUMNS line of the current buffer."
16954 (let (fmt (cnt 0))
16955 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16956 (org-set-local 'org-columns-current-fmt fmt)
16957 (if (marker-position org-columns-top-level-marker)
16958 (save-excursion
16959 (goto-char org-columns-top-level-marker)
16960 (if (and (org-at-heading-p)
16961 (org-entry-get nil "COLUMNS"))
16962 (org-entry-put nil "COLUMNS" fmt)
16963 (goto-char (point-min))
16964 ;; Overwrite all #+COLUMNS lines....
16966 (setq cnt (1+ cnt))
16967 (replace-match (concat "#+COLUMNS: " fmt) t t))
16968 (unless (> cnt 0)
16969 (goto-char (point-min))
16970 (or (org-on-heading-p t) (outline-next-heading))
16971 (let ((inhibit-read-only t))
16973 (org-set-local 'org-columns-default-format fmt))))))
16975 (defvar org-overriding-columns-format nil
16976 "When set, overrides any other definition.")
16977 (defvar org-agenda-view-columns-initially nil
16978 "When set, switch to columns view immediately after creating the agenda.")
16980 (defun org-agenda-columns ()
16981 "Turn on column view in the agenda."
16982 (interactive)
16983 (org-verify-version 'columns)
16984 (org-columns-remove-overlays)
16985 (move-marker org-columns-begin-marker (point))
16986 (let (fmt cache maxwidths m)
16987 (cond
16988 ((and (local-variable-p 'org-overriding-columns-format)
16989 org-overriding-columns-format)
16990 (setq fmt org-overriding-columns-format))
16991 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
16992 (setq fmt (org-entry-get m "COLUMNS" t)))
16993 ((and (boundp 'org-columns-current-fmt)
16994 (local-variable-p 'org-columns-current-fmt)
16995 org-columns-current-fmt)
16996 (setq fmt org-columns-current-fmt))
16997 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
16998 (setq m (get-text-property m 'org-hd-marker))
16999 (setq fmt (org-entry-get m "COLUMNS" t))))
17000 (setq fmt (or fmt org-columns-default-format))
17001 (org-set-local 'org-columns-current-fmt fmt)
17002 (org-columns-compile-format fmt)
17003 (save-excursion
17004 ;; Get and cache the properties
17005 (goto-char (point-min))
17006 (while (not (eobp))
17007 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17008 (get-text-property (point) 'org-marker)))
17009 (push (cons (org-current-line) (org-entry-properties m)) cache))
17010 (beginning-of-line 2))
17011 (when cache
17012 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17013 (org-set-local 'org-columns-current-maxwidths maxwidths)
17014 (org-columns-display-here-title)
17015 (mapc (lambda (x)
17016 (goto-line (car x))
17017 (org-columns-display-here (cdr x)))
17018 cache)))))
17020 (defun org-columns-get-autowidth-alist (s cache)
17021 "Derive the maximum column widths from the format and the cache."
17022 (let ((start 0) rtn)
17024 (push (cons (match-string 1 s) 1) rtn)
17025 (setq start (match-end 0)))
17026 (mapc (lambda (x)
17027 (setcdr x (apply 'max
17028 (mapcar
17029 (lambda (y)
17030 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17031 cache))))
17032 rtn)
17033 rtn))
17035 (defun org-columns-compute-all ()
17036 "Compute all columns that have operators defined."
17037 (org-unmodified
17038 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17039 (let ((columns org-columns-current-fmt-compiled) col)
17040 (while (setq col (pop columns))
17041 (when (nth 3 col)
17042 (save-excursion
17043 (org-columns-compute (car col)))))))
17045 (defun org-columns-update (property)
17046 "Recompute PROPERTY, and update the columns display for it."
17047 (org-columns-compute property)
17048 (let (fmt val pos)
17049 (save-excursion
17050 (mapc (lambda (ov)
17051 (when (equal (org-overlay-get ov 'org-columns-key) property)
17052 (setq pos (org-overlay-start ov))
17053 (goto-char pos)
17054 (when (setq val (cdr (assoc property
17055 (get-text-property
17056 (point-at-bol) 'org-summaries))))
17057 (setq fmt (org-overlay-get ov 'org-columns-format))
17058 (org-overlay-put ov 'org-columns-value val)
17059 (org-overlay-put ov 'display (format fmt val)))))
17060 org-columns-overlays))))
17062 (defun org-columns-compute (property)
17063 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17064 (interactive)
17065 (let* ((re (concat "^" outline-regexp))
17066 (lmax 30) ; Does anyone use deeper levels???
17067 (lsum (make-vector lmax 0))
17068 (lflag (make-vector lmax nil))
17069 (level 0)
17070 (ass (assoc property org-columns-current-fmt-compiled))
17071 (format (nth 4 ass))
17072 (printf (nth 5 ass))
17073 (beg org-columns-top-level-marker)
17074 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17075 (save-excursion
17076 ;; Find the region to compute
17077 (goto-char beg)
17078 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17079 (goto-char end)
17080 ;; Walk the tree from the back and do the computations
17081 (while (re-search-backward re beg t)
17082 (setq sumpos (match-beginning 0)
17083 last-level level
17084 level (org-outline-level)
17085 val (org-entry-get nil property)
17087 (cond
17088 ((< level last-level)
17089 ;; put the sum of lower levels here as a property
17090 (setq sum (aref lsum last-level) ; current sum
17091 flag (aref lflag last-level) ; any valid entries from children?
17092 str (org-column-number-to-string sum format printf)
17093 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17094 useval (if flag str1 (if valflag val ""))
17095 sum-alist (get-text-property sumpos 'org-summaries))
17096 (if (assoc property sum-alist)
17097 (setcdr (assoc property sum-alist) useval)
17098 (push (cons property useval) sum-alist)
17099 (org-unmodified
17100 (add-text-properties sumpos (1+ sumpos)
17101 (list 'org-summaries sum-alist))))
17102 (when val
17103 (org-entry-put nil property (if flag str val)))
17104 ;; add current to current level accumulator
17105 (when (or flag valflag)
17106 (aset lsum level (+ (aref lsum level)
17107 (if flag sum (org-column-string-to-number
17108 (if flag str val) format))))
17109 (aset lflag level t))
17110 ;; clear accumulators for deeper levels
17111 (loop for l from (1+ level) to (1- lmax) do
17112 (aset lsum l 0)
17113 (aset lflag l nil)))
17114 ((>= level last-level)
17115 ;; add what we have here to the accumulator for this level
17116 (aset lsum level (+ (aref lsum level)
17117 (org-column-string-to-number (or val "0") format)))
17118 (and valflag (aset lflag level t)))
17119 (t (error "This should not happen")))))))
17121 (defun org-columns-redo ()
17122 "Construct the column display again."
17123 (interactive)
17124 (message "Recomputing columns...")
17125 (save-excursion
17126 (if (marker-position org-columns-begin-marker)
17127 (goto-char org-columns-begin-marker))
17128 (org-columns-remove-overlays)
17129 (if (org-mode-p)
17130 (call-interactively 'org-columns)
17131 (call-interactively 'org-agenda-columns)))
17132 (message "Recomputing columns...done"))
17134 (defun org-columns-not-in-agenda ()
17135 (if (eq major-mode 'org-agenda-mode)
17136 (error "This command is only allowed in Org-mode buffers")))
17139 (defun org-string-to-number (s)
17140 "Convert string to number, and interpret hh:mm:ss."
17141 (if (not (string-match ":" s))
17142 (string-to-number s)
17143 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17144 (while l
17145 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17146 sum)))
17148 (defun org-column-number-to-string (n fmt &optional printf)
17149 "Convert a computed column number to a string value, according to FMT."
17150 (cond
17151 ((eq fmt 'add_times)
17152 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17153 (format "%d:%02d" h m)))
17154 ((eq fmt 'checkbox)
17155 (cond ((= n (floor n)) "[X]")
17156 ((> n 1.) "[-]")
17157 (t "[ ]")))
17158 (printf (format printf n))
17159 ((eq fmt 'currency)
17160 (format "%.2f" n))
17161 (t (number-to-string n))))
17163 (defun org-column-string-to-number (s fmt)
17164 "Convert a column value to a number that can be used for column computing."
17165 (cond
17166 ((string-match ":" s)
17167 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17168 (while l
17169 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17170 sum))
17171 ((eq fmt 'checkbox)
17172 (if (equal s "[X]") 1. 0.000001))
17173 (t (string-to-number s))))
17175 (defun org-columns-uncompile-format (cfmt)
17176 "Turn the compiled columns format back into a string representation."
17177 (let ((rtn "") e s prop title op width fmt printf)
17178 (while (setq e (pop cfmt))
17179 (setq prop (car e)
17180 title (nth 1 e)
17181 width (nth 2 e)
17182 op (nth 3 e)
17183 fmt (nth 4 e)
17184 printf (nth 5 e))
17185 (cond
17186 ((eq fmt 'add_times) (setq op ":"))
17187 ((eq fmt 'checkbox) (setq op "X"))
17188 ((eq fmt 'add_numbers) (setq op "+"))
17189 ((eq fmt 'currency) (setq op "$")))
17190 (if (and op printf) (setq op (concat op ";" printf)))
17191 (if (equal title prop) (setq title nil))
17192 (setq s (concat "%" (if width (number-to-string width))
17193 prop
17194 (if title (concat "(" title ")"))
17195 (if op (concat "{" op "}"))))
17196 (setq rtn (concat rtn " " s)))
17197 (org-trim rtn)))
17199 (defun org-columns-compile-format (fmt)
17200 "Turn a column format string into an alist of specifications.
17201 The alist has one entry for each column in the format. The elements of
17202 that list are:
17203 property the property
17204 title the title field for the columns
17205 width the column width in characters, can be nil for automatic
17206 operator the operator if any
17207 format the output format for computed results, derived from operator
17208 printf a printf format for computed values"
17209 (let ((start 0) width prop title op f printf)
17210 (setq org-columns-current-fmt-compiled nil)
17211 (while (string-match
17212 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17213 fmt start)
17214 (setq start (match-end 0)
17215 width (match-string 1 fmt)
17216 prop (match-string 2 fmt)
17217 title (or (match-string 3 fmt) prop)
17218 op (match-string 4 fmt)
17219 f nil
17220 printf nil)
17221 (if width (setq width (string-to-number width)))
17222 (when (and op (string-match ";" op))
17223 (setq printf (substring op (match-end 0))
17224 op (substring op 0 (match-beginning 0))))
17225 (cond
17226 ((equal op "+") (setq f 'add_numbers))
17227 ((equal op "$") (setq f 'currency))
17228 ((equal op ":") (setq f 'add_times))
17229 ((equal op "X") (setq f 'checkbox)))
17230 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17231 (setq org-columns-current-fmt-compiled
17232 (nreverse org-columns-current-fmt-compiled))))
17235 ;;; Dynamic block for Column view
17237 (defun org-columns-capture-view ()
17238 "Get the column view of the current buffer and return it as a list.
17239 The list will contains the title row and all other rows. Each row is
17240 a list of fields."
17241 (save-excursion
17242 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17243 (n (length title)) row tbl)
17244 (goto-char (point-min))
17246 (when (get-char-property (match-beginning 0) 'org-columns-key)
17247 (setq row nil)
17248 (loop for i from 0 to (1- n) do
17249 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17250 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17251 "")
17252 row))
17253 (setq row (nreverse row))
17254 (push row tbl)))
17255 (append (list title 'hline) (nreverse tbl)))))
17257 (defun org-dblock-write:columnview (params)
17258 "Write the column view table.
17259 PARAMS is a property list of parameters:
17261 :width enforce same column widths with <N> specifiers.
17262 :id the :ID: property of the entry where the columns view
17263 should be built, as a string. When `local', call locally.
17264 When `global' call column view with the cursor at the beginning
17265 of the buffer (usually this means that the whole buffer switches
17266 to column view).
17267 :hlines When t, insert a hline before each item. When a number, insert
17268 a hline before each level <= that number.
17269 :vlines When t, make each column a colgroup to enforce vertical lines."
17270 (let ((pos (move-marker (make-marker) (point)))
17271 (hlines (plist-get params :hlines))
17272 (vlines (plist-get params :vlines))
17273 tbl id idpos nfields tmp)
17274 (save-excursion
17275 (save-restriction
17276 (when (setq id (plist-get params :id))
17277 (cond ((not id) nil)
17278 ((eq id 'global) (goto-char (point-min)))
17279 ((eq id 'local) nil)
17280 ((setq idpos (org-find-entry-with-id id))
17281 (goto-char idpos))
17282 (t (error "Cannot find entry with :ID: %s" id))))
17283 (org-columns)
17284 (setq tbl (org-columns-capture-view))
17285 (setq nfields (length (car tbl)))
17286 (org-columns-quit)))
17287 (goto-char pos)
17288 (move-marker pos nil)
17289 (when tbl
17290 (when (plist-get params :hlines)
17291 (setq tmp nil)
17292 (while tbl
17293 (if (eq (car tbl) 'hline)
17294 (push (pop tbl) tmp)
17296 (if (and (not (eq (car tmp) 'hline))
17297 (or (eq hlines t)
17298 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17299 (push 'hline tmp)))
17300 (push (pop tbl) tmp)))
17301 (setq tbl (nreverse tmp)))
17302 (when vlines
17303 (setq tbl (mapcar (lambda (x)
17304 (if (eq 'hline x) x (cons "" x)))
17305 tbl))
17306 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17307 (setq pos (point))
17308 (insert (org-listtable-to-string tbl))
17309 (when (plist-get params :width)
17311 org-columns-current-widths "|")))
17312 (goto-char pos)
17313 (org-table-align))))
17315 (defun org-listtable-to-string (tbl)
17316 "Convert a listtable TBL to a string that contains the Org-mode table.
17317 The table still need to be alligned. The resulting string has no leading
17318 and tailing newline characters."
17319 (mapconcat
17320 (lambda (x)
17321 (cond
17322 ((listp x)
17323 (concat "|" (mapconcat 'identity x "|") "|"))
17324 ((eq x 'hline) "|-|")
17325 (t (error "Garbage in listtable: %s" x))))
17328 (defun org-insert-columns-dblock ()
17329 "Create a dynamic block capturing a column view table."
17330 (interactive)
17331 (let ((defaults '(:name "columnview" :hlines 1))
17332 (id (completing-read
17333 "Capture columns (local, global, entry with :ID: property) [local]: "
17334 (append '(("global") ("local"))
17335 (mapcar 'list (org-property-values "ID"))))))
17336 (if (equal id "") (setq id 'local))
17337 (if (equal id "global") (setq id 'global))
17338 (setq defaults (append defaults (list :id id)))
17339 (org-create-dblock defaults)
17340 (org-update-dblock)))
17342 ;;;; Timestamps
17344 (defvar org-last-changed-timestamp nil)
17345 (defvar org-time-was-given) ; dynamically scoped parameter
17346 (defvar org-end-time-was-given) ; dynamically scoped parameter
17347 (defvar org-ts-what) ; dynamically scoped parameter
17349 (defun org-time-stamp (arg)
17350 "Prompt for a date/time and insert a time stamp.
17351 If the user specifies a time like HH:MM, or if this command is called
17352 with a prefix argument, the time stamp will contain date and time.
17353 Otherwise, only the date will be included. All parts of a date not
17354 specified by the user will be filled in from the current date/time.
17355 So if you press just return without typing anything, the time stamp
17356 will represent the current date/time. If there is already a timestamp
17357 at the cursor, it will be modified."
17358 (interactive "P")
17359 (let* ((ts nil)
17360 (default-time
17361 ;; Default time is either today, or, when entering a range,
17362 ;; the range start.
17363 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17364 (save-excursion
17365 (re-search-backward
17367 (- (point) 20) t)))
17368 (apply 'encode-time (org-parse-time-string (match-string 1)))
17369 (current-time)))
17370 (default-input (and ts (org-get-compact-tod ts)))
17371 org-time-was-given org-end-time-was-given time)
17372 (cond
17373 ((and (org-at-timestamp-p)
17374 (eq last-command 'org-time-stamp)
17375 (eq this-command 'org-time-stamp))
17376 (insert "--")
17377 (setq time (let ((this-command this-command))
17378 (org-read-date arg 'totime nil nil default-time default-input)))
17379 (org-insert-time-stamp time (or org-time-was-given arg)))
17380 ((org-at-timestamp-p)
17381 (setq time (let ((this-command this-command))
17382 (org-read-date arg 'totime nil nil default-time default-input)))
17383 (when (org-at-timestamp-p) ; just to get the match data
17384 (replace-match "")
17385 (setq org-last-changed-timestamp
17386 (org-insert-time-stamp
17387 time (or org-time-was-given arg)
17388 nil nil nil (list org-end-time-was-given))))
17389 (message "Timestamp updated"))
17390 (t
17391 (setq time (let ((this-command this-command))
17392 (org-read-date arg 'totime nil nil default-time default-input)))
17393 (org-insert-time-stamp time (or org-time-was-given arg)
17394 nil nil nil (list org-end-time-was-given))))))
17396 ;; FIXME: can we use this for something else????
17397 ;; like computing time differences?????
17398 (defun org-get-compact-tod (s)
17399 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17400 (let* ((t1 (match-string 1 s))
17401 (h1 (string-to-number (match-string 2 s)))
17402 (m1 (string-to-number (match-string 3 s)))
17403 (t2 (and (match-end 4) (match-string 5 s)))
17404 (h2 (and t2 (string-to-number (match-string 6 s))))
17405 (m2 (and t2 (string-to-number (match-string 7 s))))
17406 dh dm)
17407 (if (not t2)
17408 t1
17409 (setq dh (- h2 h1) dm (- m2 m1))
17410 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17411 (concat t1 "+" (number-to-string dh)
17412 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17414 (defun org-time-stamp-inactive (&optional arg)
17415 "Insert an inactive time stamp.
17416 An inactive time stamp is enclosed in square brackets instead of angle
17417 brackets. It is inactive in the sense that it does not trigger agenda entries,
17418 does not link to the calendar and cannot be changed with the S-cursor keys.
17419 So these are more for recording a certain time/date."
17420 (interactive "P")
17421 (let (org-time-was-given org-end-time-was-given time)
17422 (setq time (org-read-date arg 'totime))
17423 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17424 nil nil (list org-end-time-was-given))))
17426 (defvar org-date-ovl (org-make-overlay 1 1))
17427 (org-overlay-put org-date-ovl 'face 'org-warning)
17428 (org-detach-overlay org-date-ovl)
17430 (defvar org-ans1) ; dynamically scoped parameter
17431 (defvar org-ans2) ; dynamically scoped parameter
17433 (defvar org-plain-time-of-day-regexp) ; defined below
17435 (defvar org-read-date-overlay nil)
17436 (defvar org-dcst nil) ; dynamically scoped
17438 (defun org-read-date (&optional with-time to-time from-string prompt
17439 default-time default-input)
17440 "Read a date, possibly a time, and make things smooth for the user.
17441 The prompt will suggest to enter an ISO date, but you can also enter anything
17442 which will at least partially be understood by `parse-time-string'.
17443 Unrecognized parts of the date will default to the current day, month, year,
17444 hour and minute. If this command is called to replace a timestamp at point,
17445 of to enter the second timestamp of a range, the default time is taken from the
17446 existing stamp. For example,
17447 3-2-5 --> 2003-02-05
17448 feb 15 --> currentyear-02-15
17449 sep 12 9 --> 2009-09-12
17450 12:45 --> today 12:45
17451 22 sept 0:34 --> currentyear-09-22 0:34
17452 12 --> currentyear-currentmonth-12
17453 Fri --> nearest Friday (today or later)
17454 etc.
17456 Furthermore you can specify a relative date by giving, as the *first* thing
17457 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17458 change in days weeks, months, years.
17459 With a single plus or minus, the date is relative to today. With a double
17460 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17461 +4d --> four days from today
17462 +4 --> same as above
17463 +2w --> two weeks from today
17464 ++5 --> five days from default date
17466 The function understands only English month and weekday abbreviations,
17467 but this can be configured with the variables `parse-time-months' and
17468 `parse-time-weekdays'.
17470 While prompting, a calendar is popped up - you can also select the
17471 date with the mouse (button 1). The calendar shows a period of three
17472 months. To scroll it to other months, use the keys `>' and `<'.
17473 If you don't like the calendar, turn it off with
17474 \(setq org-read-date-popup-calendar nil)
17476 With optional argument TO-TIME, the date will immediately be converted
17477 to an internal time.
17478 With an optional argument WITH-TIME, the prompt will suggest to also
17479 insert a time. Note that when WITH-TIME is not set, you can still
17480 enter a time, and this function will inform the calling routine about
17481 this change. The calling routine may then choose to change the format
17482 used to insert the time stamp into the buffer to include the time.
17483 With optional argument FROM-STRING, read from this string instead from
17484 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17485 the time/date that is used for everything that is not specified by the
17486 user."
17487 (require 'parse-time)
17488 (let* ((org-time-stamp-rounding-minutes
17489 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17490 (org-dcst org-display-custom-times)
17491 (ct (org-current-time))
17492 (def (or default-time ct))
17493 (defdecode (decode-time def))
17494 (dummy (progn
17495 (when (< (nth 2 defdecode) org-extend-today-until)
17496 (setcar (nthcdr 2 defdecode) -1)
17497 (setcar (nthcdr 1 defdecode) 59)
17498 (setq def (apply 'encode-time defdecode)
17499 defdecode (decode-time def)))))
17500 (calendar-move-hook nil)
17501 (view-diary-entries-initially nil)
17502 (view-calendar-holidays-initially nil)
17503 (timestr (format-time-string
17504 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17505 (prompt (concat (if prompt (concat prompt " ") "")
17506 (format "Date+time [%s]: " timestr)))
17507 ans (org-ans0 "") org-ans1 org-ans2 final)
17509 (cond
17510 (from-string (setq ans from-string))
17511 (org-read-date-popup-calendar
17512 (save-excursion
17513 (save-window-excursion
17514 (calendar)
17515 (calendar-forward-day (- (time-to-days def)
17516 (calendar-absolute-from-gregorian
17517 (calendar-current-date))))
17518 (org-eval-in-calendar nil t)
17519 (let* ((old-map (current-local-map))
17520 (map (copy-keymap calendar-mode-map))
17521 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17522 (org-defkey map (kbd "RET") 'org-calendar-select)
17523 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17524 'org-calendar-select-mouse)
17562 ;; org-ans0: from prompt
17563 ;; org-ans1: from mouse click
17564 ;; org-ans2: from calendar motion
17592 "Display the currrent date prompt interpretation in the minibuffer."
17608 org-time-stamp-custom-formats
17609 org-time-stamp-formats))
17618 org-end-time-was-given
17625 "Analyze the combined answer of the date prompt."
17626 ;; FIXME: cleanup and comment
17628 hour minute second wday pm h2 m2 tl wday1)
17636 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17646 t nil ans)))
17647 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17648 ;; If there is a time with am/pm, and *no* time without it, we convert
17649 ;; so that matching will be successful.
17663 t t ans))))
17665 ;; Check if a time range is given as a duration
17666 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17674 ;; Check if there is a time range
17708 ;; Weekday was given, but no day, so pick that day in the week
17709 ;; on or after the derived date.
17723 "Check string S for special relative date string.
17724 TODAY and DEFAULT are internal times, for today and for a default.
17725 Return shift list (N what def-flag)
17727 N is the number of WHATs to shift.
17728 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17729 the DEFAULT date rather than TODAY."
17738 ?+))
17745 delta)
17755 "Eval FORM in the calendar window and return to current window.
17756 Also, store the cursor date in variable org-ans2."
17767 ; ;; Update the prompt to show new default date
17768 ; (save-excursion
17769 ; (goto-char (point-min))
17770 ; (when (and org-ans2
17771 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17772 ; (get-text-property (match-end 0) 'field))
17773 ; (let ((inhibit-read-only t))
17774 ; (replace-match (concat "[" org-ans2 "]") t t)
17775 ; (add-text-properties (point-min) (1+ (match-end 0))
17776 ; (text-properties-at (1+ (point-min)))))))))
17779 "Return to `org-read-date' with the date currently selected.
17780 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17789 "Insert a date stamp for the date given by the internal TIME.
17790 WITH-HM means, use the stamp format that includes the time of the day.
17791 INACTIVE means use square brackets instead of angular ones, so that the
17792 stamp will not contribute to the agenda.
17793 PRE and POST are optional strings to be inserted before and after the
17794 stamp.
17795 The command returns the inserted time stamp."
17797 stamp)
17814 stamp))
17817 "Toggle the use of custom time stamp formats."
17838 "Overlay modified time stamp format over timestamp between BED and END."
17865 "Translate all timestamps in STRING to custom format.
17866 But do this only if the variable `org-display-custom-times' is set."
17871 t1 with-hm inactive tf time str beg end)
17880 org-time-stamp-custom-formats)
17889 string)
17892 "Set 0 instead of nil for the first 6 elements of time.
17893 Don't touch the rest."
17898 "Difference between TIMESTAMP-STRING and now in days."
17903 "Is the time in TIMESTAMP-STRING close to the current date?"
17909 "Get the deadline lead time appropriate for timestring TS."
17912 ;; 0 or negative, enforce this value no matter what
17915 ;; lead time is specified.
17920 ;; go for the default.
17924 "Return to `org-read-date' with the date currently selected.
17925 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17935 "Check if there are any deadlines due or past due.
17936 A deadline is considered due if it happens within `org-deadline-warning-days'
17937 days from today's date. If the deadline appears in an entry marked DONE,
17938 it is not shown. The prefix arg NDAYS can be used to test that many
17953 org-warn-days)))
17956 "Check if there are deadlines or scheduled entries before DATE."
17970 "Evaluate a time range by computing the difference between start and end.
17971 Normally the result is just printed in the echo area, but with prefix arg
17972 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17973 If the time range is actually in a table, the result is inserted into the
17974 next column.
17975 For time difference computation, a year is assumed to be exactly 365
17976 days in order to avoid rounding problems."
17996 ;; (ys (floor (* 365 24 60 60)))
18004 y d h m align)
18007 y 0
18012 y 0
18050 "Convert a time stamp to an absolute day number.
18051 If there is a specifyer for a cyclic time stamp, get the closest date to
18052 DAYNR."
18056 daynr
18061 prefer))
18065 "Return the time corresponding to date D.
18066 D may be an absolute day number, or a calendar-type list (month day year)."
18071 "List of holidays, for Diary display in Org-mode."
18079 "Process a SEXP diary ENTRY for DATE."
18099 "Get iCalendar entries from diary entries in buffer FROMBUF.
18100 This uses the icalendar.el library."
18103 temporary-file-directory))
18106 buf rtn b e)
18122 rtn))
18125 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18126 When PREFER is `past' return a date that is either CURRENT or past.
18127 When PREFER is `future', return a date that is either CURRENT or future."
18128 ;; Make the proper lists from the dates
18131 dn dw sday cday n1 n2
18132 d m y y1 y2 date1 date2 nmonths nm ny m2)
18137 current
18161 ;; approx number of month between the tow dates
18163 ;; How often does dn fit in there?
18192 "Turn any specification of DATE into a gregorian date for the calendar."
18202 "Parse the standard Org-mode time string.
18203 This should be a lot faster than the normal `parse-time-string'.
18204 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18205 hour and minute fields will be nil if not given."
18215 nil nil nil)
18219 "Increase the date item at the cursor by one.
18220 If the cursor is on the year, change the year. If it is on the month or
18221 the day, change that.
18222 With prefix ARG, change by that many units."
18227 "Decrease the date item at the cursor by one.
18228 If the cursor is on the year, change the year. If it is on the month or
18229 the day, change that.
18230 With prefix ARG, change by that many units."
18235 "Increase the date in the time stamp by one day.
18236 With prefix ARG, change that many days."
18244 "Decrease the date in the time stamp by one day.
18245 With prefix ARG, change that many days."
18258 "Determine if the cursor is in or at a timestamp."
18284 ans))
18287 ""
18299 "Change the date in the time stamp at point.
18300 The date will be changed by N times WHAT. WHAT can be `day', `month',
18301 `year', `minute', `second'. If WHAT is not given, the cursor position
18302 in the timestamp determines what will be changed."
18304 with-hm inactive
18305 org-ts-what
18306 extra
18307 ts time time0)
18313 org-display-custom-times
18323 ts)
18351 ;; Try to recenter the calendar window, if any
18357 ;; FIXME: does not yet work for lead times
18359 "Change the different parts of the lead-time and repeat fields in timestamp."
18361 ng h m new)
18362 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18383 new
18385 s))
18388 "If the calendar is visible, recenter it to DATE."
18399 "Go to the Emacs calendar at the current date.
18400 If there is a time stamp in the current line, go to that date.
18401 A prefix ARG can be used to force the current date."
18420 "Return a list (month day year) of date at point in calendar."
18426 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18427 If there is already a time stamp at the cursor position, update it."
18435 ;; Make appt aware of appointments from the agenda
18436 ;;;###autoload
18438 "Activate appointments found in `org-agenda-files'.
18439 When prefixed, prompt for a regular expression and use it as a
18440 filter: only add entries if they match this regular expression.
18442 FILTER can be a string. In this case, use this string as a
18443 regular expression to filter results.
18445 FILTER can also be an alist, with the car of each cell being
18446 either 'headline or 'category. For example:
18451 will only add headlines containing IMPORTANT or headlines
18462 ;; Get all entries which may contain an appt
18467 file today
18470 ;; Map thru entries and find if they pass thru the filter
18483 ;; FIXME: Shall we remove text-properties for the appt text?
18484 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18496 ;;; The clock for measuring work time.
18521 "Start the clock on the current item.
18522 If necessary, clock-out of the currently active clock."
18530 org-clock-in-switch-to-state
18557 "Find the location where the next clock line should be inserted."
18563 first last)
18567 ;; we seem to have a CLOCK drawer, so go there.
18570 ;; Lets count the CLOCK lines
18578 ;; Wrap current entries into a new drawer
18596 ;; Planning info, skip to after it
18608 "Stop the currently running clock.
18609 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18648 "Cancel the running clock be removing the start timestamp."
18662 "Go to the currently clocked-in entry."
18679 "Sum the times for each subtree.
18680 Puts the resulting times in minutes as a text property on each headline."
18684 org-clock-string
18690 ts te dt
18691 time)
18698 ;; Two time stamps
18710 ;; A naket time
18727 "Show subtree times in the entire buffer.
18728 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18729 in the echo area."
18746 ;; Arrange to remove the overlays upon next change.
18756 "Put an overlays on the current line, displaying TIME.
18757 If LEVEL is given, prefix time with a corresponding number of stars.
18758 This creates a new overlay and stores it in `org-clock-overlays', so that it
18759 will be easy to remove."
18763 ov tx)
18782 "Remove the occur highlights from the buffer.
18783 BEG and END are ignored. If NOREMOVE is nil, remove this function
18784 from the `before-change-functions' in the current buffer."
18794 "Clock out if the current entry contains the running clock.
18795 This is used to stop the clock after a TODO entry is marked DONE,
18796 and is only done if the variable `org-clock-out-when-done' is not nil."
18802 org-clock-marker))
18803 ;; Clock out, but don't accept a logging message for this.
18807 org-log-done)))
18814 "Check if the current buffer contains the running clock.
18815 If yes, offer to stop it and to save the buffer with the changes."
18824 "Create a table containing a report about clocked time.
18825 If the cursor is inside an existing clocktable block, then the table
18826 will be updated. If not, a new clocktable will be inserted.
18827 When called with a prefix argument, move to the first clock table in the
18828 buffer and update it."
18841 "Check if the cursor is in a clocktable."
18849 start))))
18852 "If this is a CLOCK line, update it and return t.
18853 Otherwise, return nil."
18862 ts te h m s)
18864 nil
18878 t)))))
18881 "Return two times bordering a special time range.
18882 Key is a symbol specifying the range and can be one of `today', `yesterday',
18883 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18884 A week starts Monday 0:00 and ends Sunday 24:00.
18885 The range is determined relative to TIME. TIME defaults to the current time.
18886 The return value is a cons cell with two internal times like the ones
18887 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18888 the returned times will be formatted strings."
18893 s1 m1 h1 d1 month1 y1 diff ts te fm)
18923 "Write the standard clocktable."
18938 ipos time h m p level hlc hdl
18939 cc beg end pos tbl)
18953 ;; Get the right scope
18976 file)
18986 org-clock-file-total-minutes)))))))
18997 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19018 "Clock summary at ["
19022 "]."
19035 "|"
19036 "*Total time*| "
19058 cc)
19092 x))
19093 lines)
19096 ;; FIXME: I don't think anybody uses this, ask David
19098 "Return an internal list with clocking information.
19099 This list has one entry for each CLOCK interval.
19100 FIXME: describe the elements."
19104 rtn beg end next cont level title total closedp leafp
19105 clockpos titlepos h m donep)
19130 total title titlepos level leafp)
19131 rtn)
19135 ;;;; Agenda, and Diary Integration
19137 ;;; Define the Org-agenda-mode
19151 "Mode for time-sorted view on action items in Org-mode files.
19153 The following commands are available:
19159 org-agenda-pending-undo-list nil)
19161 ;; Keep global-font-lock-mode from turning on font-lock-mode
19169 ;; Make sure properties are removed when copying text
19174 buffer-substring-filters)))
19177 org-agenda-show-log nil))
19184 "Restricted to single file"
19196 org-agenda-mode-map global-map)
19294 "--"
19301 "--"
19305 "--"
19310 "--"
19315 "--"
19320 "--"
19337 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19341 "--"
19343 "--"
19353 "--"
19355 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19359 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19363 "--"
19365 "--"
19368 ))
19370 ;;; Agenda undo
19382 "Execute BODY if there is no `org-protected' text property at point."
19388 "Execute BODY while recording undo information in two buffers."
19396 _c1 _c2)
19397 ,@_body
19404 ;; make sure there are undo boundaries
19407 ;; remember which buffer to undo
19409 org-agenda-undo-list)))))
19412 "Undo a remote editing step in the agenda.
19413 This undoes changes both in the agenda buffer and in the remote buffer
19414 that have been changed along."
19420 org-agenda-pending-undo-list org-agenda-undo-list))
19424 buf line cmd rembuf)
19446 "Verify that a real change occurred between the undo lists L1 and L2."
19451 ;;; Agenda dispatch
19459 ;;;###autoload
19461 "Dispatch agenda commands to collect entries to the agenda buffer.
19462 Prompts for a command to execute. Any prefix arg will be passed
19463 on to the selected command. The default selections are:
19465 a Call `org-agenda-list' to display the agenda for current day or week.
19466 t Call `org-todo-list' to display the global todo list.
19467 T Call `org-todo-list' to display the global todo list, select only
19468 entries with a specific TODO keyword (the user gets a prompt).
19469 m Call `org-tags-view' to display headlines with tags matching
19470 a condition (the user is prompted for the condition).
19471 M Like `m', but select only TODO entries, no ordinary headlines.
19472 L Create a timeline for the current buffer.
19473 e Export views to associated files.
19475 More commands can be added by configuring the variable
19476 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19477 searches can be pre-defined in this way.
19479 If the current buffer is in Org-mode and visiting a file, you can also
19480 first press `<' once to indicate that the agenda should be temporarily
19482 Pressing `<' twice means to restrict to the current subtree or region
19483 \(if active)."
19489 ;; normalize different versions
19495 nil)
19499 org-agenda-custom-commands)))
19502 entry key type match lprops ans)
19503 ;; Turn off restriction unless there is an overriding one
19509 ;; Delete old local properties
19511 ;; Remember where this call originated
19517 ;; Estabish the restriction, if any
19534 ;; For example the todo list should not need it (but does...)
19548 current-prefix-arg)))
19600 cmds)))
19603 "The user interface for selecting an agenda command."
19610 restriction second-time
19611 c entry key type match prefixes rmheader header-end custom1 desc)
19618 "
19619 Press key for an agenda command: < Buffer,subtree/region restriction
19620 -------------------------------- > Remove restriction
19621 a Agenda for current week or day e Export agenda views
19622 t List of all TODO entries T Entries with special TODO kwd
19623 m Match a TAGS query M Like m, but only TODO entries
19624 L Timeline for current buffer # List stuck projects (!=configure)
19625 / Multi-occur C Configure custom agenda commands
19630 header start)
19634 header)))
19686 prefix-descriptions))
19688 prefixes))
19699 " (restriction lock active)"
19712 prefixes nil
19718 nil
19720 custom))))
19737 nil)
19757 match ;; The byte compiler incorrectly complains about this. Keep it!
19758 cmd type lprops)
19789 ;;;###autoload
19791 "Run an agenda command in batch mode and send the result to STDOUT.
19792 If CMD-KEY is a string of length 1, it is used as a key in
19793 `org-agenda-custom-commands' and triggers this command. If it is a
19794 longer string it is used as a tags/todo match string.
19795 Paramters are alternating variable names and values that will be bound
19796 before running the agenda command."
19810 string))
19814 ;;;###autoload
19816 "Run an agenda command in batch mode and send the result to STDOUT.
19817 If CMD-KEY is a string of length 1, it is used as a key in
19818 `org-agenda-custom-commands' and triggers this command. If it is a
19819 longer string it is used as a tags/todo match string.
19820 Paramters are alternating variable names and values that will be bound
19821 before running the agenda command.
19823 The output gives a line for each selected agenda item. Each
19824 item is a list of comma-separated values, like this:
19826 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19828 category The category of the item
19829 head The headline, without TODO kwd, TAGS and PRIORITY
19830 type The type of the agenda entry, can be
19831 todo selected in TODO match
19832 tagsmatch selected in tags match
19833 diary imported from diary
19834 deadline a deadline on given date
19835 scheduled scheduled on given date
19836 timestamp entry has timestamp on given date
19837 closed entry was closed on given date
19838 upcoming-deadline warning about deadline
19839 past-scheduled forwarded scheduled item
19840 block entry has date block including g. date
19841 todo The todo keyword, if any
19842 tags All tags including inherited ones, separated by colons
19843 date The relevant date, like 2007-2-14
19844 time The time, like 15:00-16:50
19845 extra Sting with extra planning info
19846 priority-l The priority letter if any was given
19847 priority-n The computed numerical priority
19848 agenda-day The day in the agenda where this is listed"
19860 line)
19870 priority-letter priority agenda-day)
19875 "Make sure all properties on an agenda item have a canonical form,
19876 so the export commands can easily use it."
19903 props)
19917 ;;;###autoload
19922 ;; FIXME, why is this a macro?????
19923 ;;;###autoload
19925 "Run all custom agenda commands that have a file argument."
19929 pars cmd thiscmdkey files opts)
19952 "Write the current buffer (an agenda view) as a file.
19953 Depending on the extension of the file name, plain text (.txt),
19954 HTML (.html or .htm) or Postscript (.ps) is produced.
19955 If NOSETTINGS is given, do not scope the settings of
19956 `org-agenda-exporter-settings' into the export commands. This is used when
19957 the settings have already been scoped and we do not wish to overrule other,
19958 higher priority settings."
19974 ;; replace <style> section with org-agenda-export-html-style
19995 "Inhibit read-only for BODY."
19999 "Make sure current buffer is in org-mode. Error if not."
20002 major-mode)))
20005 "Fit the window to the buffer size."
20009 nil
20013 ;;; Agenda file list
20016 "Get the list of agenda files.
20017 Optional UNRESTRICTED means return the full list even if a restriction
20018 is currently in place."
20029 org-agenda-file-regexp)
20031 files)))
20037 files))
20041 "Edit the list of agenda files.
20042 Depending on setup, this either uses customize to edit the variable
20043 `org-agenda-files', or it visits the file that is holding the list. In the
20044 latter case, the buffer is set up in a way that saving it automatically kills
20045 the buffer and restores the previous window configuration."
20064 "Set new value for the agenda file list and save it correcly."
20075 "Read the list of agenda files from a file."
20082 ;;;###autoload
20084 "Cycle through the files in `org-agenda-files'.
20085 If the current buffer visits an agenda file, find the next one in the list.
20086 If the current buffer does not, find the first agenda file."
20091 file)
20103 "Move/add the current file to the top of the agenda file list.
20104 If the file is not present in the list, it is added to the front. If it is
20105 present, it is moved there. With optional argument TO-END, add/move to the
20106 end of the list."
20113 x had)
20126 "Remove current file from the list of files in variable `org-agenda-files'.
20127 These are the files which are being checked for agenda entries.
20128 Optional argument FILE means, use this file instead of the current."
20138 nil x))
20151 "Make sure FILE exists. If not, ask user what to do."
20162 ;;; Agenda prepare and finalize
20207 "Finishing touch for the agenda buffer, called just before displaying it."
20219 org-overriding-columns-format)
20221 org-overriding-columns-format))
20223 org-agenda-view-columns-initially)
20229 )))
20232 "Make highest priority lines bold, and lowest italic."
20239 b e p ov h l)
20243 org-highest-priority)
20245 org-lowest-priority)
20250 ov 'face
20258 "Create buffers for all agenda files, protect archived trees and comments."
20265 bmp file re)
20295 "Function to be called at each match during agenda construction.
20296 If this function returns nil, the current match should not be skipped.
20297 Otherwise, the function must return a position from where the search
20298 should be continued.
20299 This may also be a Lisp form, it will be evaluated.
20300 Never set this variable using `setq' or so, because then it will apply
20301 to all future agenda commands. Instead, bind it with `let' to scope
20302 it dynamically into the agenda-constructing command. A good way to set
20306 "Throw to `:skip' in places that should be skipped.
20307 Also moves point to the end of the skipped region, so that search can
20308 continue from there."
20334 "Return a new agenda marker.
20335 Org-mode keeps a list of these markers and resets them when they are
20336 no longer in use."
20340 m))
20343 "Reset markers created by `org-agenda'. But only if they are old enough."
20346 org-agenda-last-marker-time)
20352 "Get a buffer visiting FILE. If the buffer needs to be created, add
20353 it to the list of buffers which might be released later."
20356 buf ; just return it
20357 ;; Make a new buffer and remember it
20360 buf)))
20363 "Release all buffers in list, asking the user for confirmation when needed.
20364 When a buffer is unmodified, it is just killed. When modified, it is saved
20365 \(if the user agrees) and then killed."
20370 file
20376 "Get the category applying to position POS."
20379 ;;; Agenda timeline
20384 "Show a time-sorted view of the entries in the current org file.
20385 Only entries with a time stamp of today or later will be listed. With
20387 under the current date.
20388 If the buffer contains an active region, only check the region for
20389 dates."
20402 t doclosed ; always include today
20403 org-timeline-show-empty-dates))
20408 args
20409 s e rtn d emptyp)
20415 ;; Remove past dates from the list of dates.
20418 day-numbers))))
20435 dopast
20436 past)
20444 date args)))
20467 "Return a list of all relevant day numbers from BEG to END buffer positions.
20468 If NO-RANGES is non-nil, include only the start and end dates of a range,
20469 not every single day in the range. If FORCE-TODAY is non-nil, make
20470 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20471 inactive time stamps (those in square brackets) are included.
20472 When EMPTY is non-nil, also include days without any entries."
20476 dates dates1 date day day1 day2 ts1 ts2)
20506 dates)))
20508 ;;; Agenda Daily/Weekly
20519 ;;;###autoload
20521 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20522 The view will be for the current day or week, but from the overview buffer
20523 you will be able to go to other days/weeks.
20526 all unfinished TODO items will also be shown, before the agenda.
20527 This feature is considered obsolete, please use the TODO list or a block
20528 agenda instead.
20530 With a numeric prefix argument in an interactive call, the agenda will
20531 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20532 the number of days. NDAYS defaults to `org-agenda-ndays'.
20534 START-DAY defaults to TODAY, or to the most recent match for the weekday
20535 given in `org-agenda-start-on-weekday'."
20546 ;; Convert to an absolute day number
20554 org-agenda-start-on-weekday nil))
20563 sd
20572 s e rtn rtnall file date d start-pos end-pos todayp nd)
20575 ;; Make the list of days
20577 nd ndays)
20590 rtnall nil)
20618 rtnall nil)
20624 file date
20627 file date
20651 rtnall nd todayp))
20674 ;;; Agenda TODO list
20679 ;;;###autoload
20681 "Show all TODO entries from all agenda file in a single list.
20682 The prefix arg can be used to select a specific TODO keyword and limit
20684 for a keyword. A numeric prefix directly selects the Nth keyword in
20685 `org-todo-keywords-1'."
20699 rtn rtnall files file pos)
20709 rtnall nil)
20733 kwds))
20744 ;;; Agenda tags match
20746 ;;;###autoload
20748 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20749 The prefix arg TODO-ONLY limits the search to TODO entries."
20756 rtn rtnall files file pos matcher
20757 buffer)
20765 rtnall nil)
20773 ;; If file does not exist, merror message to agenda
20784 org-agenda-restrict-end)
20809 ;;; Agenda Finding stuck projects
20812 "Regular expression used in skipping subtrees for the agenda.
20813 This is basically a temporary global variable that can be set and then
20820 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20821 If yes, it returns the end position of this tree, causing agenda commands
20822 to skip this subtree. This is a function that can be put into
20823 `org-agenda-skip-function' for the duration of a command."
20825 skip)
20831 "Skip entry if any of CONDITIONS is true.
20832 See `org-agenda-skip-if' for details."
20836 "Skip entry if any of CONDITIONS is true.
20837 See `org-agenda-skip-if' for details."
20841 "Checks current entity for CONDITIONS.
20842 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20843 the entry, i.e. the text before the next heading is checked.
20845 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20846 from different tests. Valid conditions are:
20848 scheduled Check if there is a scheduled cookie
20849 notscheduled Check if there is no scheduled cookie
20850 deadline Check if there is a deadline
20851 notdeadline Check if there is no deadline
20852 regexp Check if regexp matches
20853 notregexp Check if regexp does not match.
20855 The regexp is taken from the conditions list, it must come right after
20856 the `regexp' or `notregexp' element.
20858 If any of these conditions is met, this function returns the end point of
20859 the entity, causing the search to continue from there. This is a function
20860 that can be put into `org-agenda-skip-function' for the duration of a command."
20884 end)))
20886 ;;;###autoload
20888 "Create agenda view for projects that are stuck.
20889 Stuck projects are project that have no next actions. For the definitions
20890 of what a project is and how to check if it stuck, customize the variable
20891 `org-stuck-projects'.
20892 MATCH is being ignored."
20895 ;; FIXME: we could have used org-agenda-skip-if here.
20903 org-done-keywords-for-agenda
20905 todo))
20922 gen-re)))))
20933 ;;; Diary integration
20938 "Get the (Emacs Calendar) diary entries for DATE."
20946 entries
20958 ;; No entries
20960 ;; Omit the date and other unnecessary stuff
20962 ;; Add prefix to each line and extend the text properties
20974 ;; Extend the text properties to the beginning of the line
20977 entries)))))
20980 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
20981 This gets rid of the date, the underline under the date, and
20982 the dummy entry installed by `org-mode' to ensure non-empty diary for each
20983 date. It also removes lines that contain only whitespace."
21000 ;; Make sure entries from the diary have the right text properties.
21003 ;; We can rely on the hook, nothing to do
21004 nil
21005 ;; Hook not avaiable, must use advice to make this work
21007 "Make the position visible."
21010 buffer-file-name)
21014 "Add text properties to string, allowing org-mode to act on it."
21017 'keymap org-agenda-keymap
21022 'org-agenda-diary-link t
21026 "Add a dummy entry to the diary.
21027 Needed to avoid empty dates which mess up holiday display."
21028 ;; Catch the error if dealing with the new add-to-diary-alist
21035 ;;;###autoload
21037 "Return diary information from org-files.
21039 It accesses org files and extracts information from those files to be
21040 listed in the diary. The function accepts arguments specifying what
21041 items should be listed. The following arguments are allowed:
21043 :timestamp List the headlines of items containing a date stamp or
21044 date range matching the selected date. Deadlines will
21045 also be listed, on the expiration day.
21047 :sexp List entries resulting from diary-like sexps.
21049 :deadline List any deadlines past due, or due within
21050 `org-deadline-warning-days'. The listing occurs only
21051 in the diary for *today*, not at any other date. If
21052 an entry is marked DONE, it is no longer listed.
21054 :scheduled List all items which are scheduled for the given date.
21055 The diary for *today* also contains items which were
21056 scheduled earlier and are not yet marked DONE.
21058 :todo List all TODO items from the org-file. This may be a
21059 long list - so this is not turned on by default.
21060 Like deadlines, these entries only show up in the
21061 diary for *today*, not at any other date.
21063 The call in the diary file should look like this:
21065 &%%(org-diary) ~/path/to/some/orgfile.org
21067 Use a separate line for each org file to check. Or, if you omit the file name,
21068 all files listed in `org-agenda-files' will be checked automatically:
21070 &%%(org-diary)
21072 If you don't give any arguments (as in the example above), the default
21073 arguments (:deadline :scheduled :timestamp :sexp) are used.
21074 So the example above may also be written as
21076 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21078 The function expects the lisp variables `entry' and `date' to be provided
21079 by the caller, because this is how the calendar works. Don't use this
21080 function from a program - use `org-agenda-get-day-entries' instead."
21088 file rtn results)
21090 ;; If this is called during org-agenda, don't return any entries to
21091 ;; the calendar. Org Agenda will list these entries itself.
21099 ;;; Agenda entry finders
21102 "Does the work for `org-diary' and `org-agenda'.
21103 FILE is the path to a file to be checked for entries. DATE is date like
21104 the one returned by `calendar-current-date'. ARGS are symbols indicating
21105 which kind of entries should be extracted. For details about these, see
21106 the documentation of `org-diary'."
21113 arg results rtn)
21115 ;; If file does not exist, make sure an error message ends up in diary
21125 org-agenda-restrict-end)
21127 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21151 results))))
21167 "Is the cursor inside a date range?"
21182 nil)))
21185 "Return the TODO information for agenda display."
21188 'org-not-done-regexp org-not-done-regexp
21189 'org-todo-regexp org-todo-regexp
21191 'keymap org-agenda-keymap
21192 'help-echo
21195 ;; FIXME: get rid of the \n at some point but watch out
21199 org-todo-regexp
21203 org-not-done-regexp)
21205 marker priority category tags
21206 ee txt beg end)
21245 "Return the date stamp information for agenda display."
21247 'org-not-done-regexp org-not-done-regexp
21248 'org-todo-regexp org-todo-regexp
21250 'keymap org-agenda-keymap
21251 'help-echo
21259 "<%Y-%m-%d"
21273 marker hdmarker deadlinep scheduledp donep tmp priority category
21274 ee txt timestr tags b0 b3 e3 head)
21292 b0)
21299 ;; substring should only run to end of time stamp
21311 nil head category tags timestr nil
21312 remove-re)))
21325 "Return the sexp information for agenda display."
21329 'keymap org-agenda-keymap
21330 'help-echo
21334 marker category ee txt tags entry result beg b sexp sexp-entry)
21366 "Return the logged TODO entries for agenda display."
21368 'org-not-done-regexp org-not-done-regexp
21369 'org-todo-regexp org-todo-regexp
21370 'keymap org-agenda-keymap
21371 'help-echo
21383 marker hdmarker priority category tags closedp
21384 ee txt timestr)
21393 ;; donep (org-entry-is-done-p)
21394 )
21396 ;; substring should only run to end of time stamp
21420 "Return the deadline information for agenda display."
21422 'org-not-done-regexp org-not-done-regexp
21423 'org-todo-regexp org-todo-regexp
21424 'keymap org-agenda-keymap
21425 'help-echo
21431 d2 diff dfrac wdays pos pos1 category tags
21432 ee txt head face s upcomingp donep timestr)
21444 ;; When to show a deadline in the calendar:
21445 ;; If the expiration is within wdays warning time.
21446 ;; Past-due deadlines are only shown on the current date
21474 diff))
21475 head category tags timestr))))
21484 'org-category category
21493 "Return the face to displaying a deadline item.
21494 FRACTION is what fraction of the head-warning time has passed."
21501 "Return the scheduled information for agenda display."
21503 'org-todo-regexp org-todo-regexp
21506 'keymap org-agenda-keymap
21507 'help-echo
21513 d2 diff pos pos1 category tags
21514 ee txt head pastschedp donep face timestr s)
21522 ;;; is this right?
21523 ;;; do we need to do this for deadleine too????
21524 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21527 ;; When to show a scheduled item in the calendar:
21528 ;; If it is on or past the date.
21556 head category tags timestr))))
21560 'org-scheduled-previously
21563 'undone-face face
21575 "Return the date-range information for agenda display."
21577 'org-not-done-regexp org-not-done-regexp
21578 'org-todo-regexp org-todo-regexp
21580 'keymap org-agenda-keymap
21581 'help-echo
21586 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21587 donep head)
21599 ;; Only allow days between the limits, because the normal
21600 ;; date stamps will catch the limits.
21617 head category tags
21626 ;; Sort the entries by expiration date.
21629 ;;; Agenda presentation and sorting
21639 "Regular expression to match a plain time or time range.
21640 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21641 groups carry important information:
21642 0 the full match
21643 1 the first time, range or not
21651 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21652 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21653 groups carry important information:
21654 0 the full match
21655 7 hours of duration
21664 "Regular expression to match a timestamp time or time range.
21665 After a match, the following groups carry important information:
21666 0 the full match
21667 1 date plus weekday, for backreferencing to make sure both times on same day
21668 2 the first time, range or not
21672 "A flag, set by `org-compile-prefix-format'.
21675 "A flag, set by `org-compile-prefix-format'.
21679 noprefix remove-re)
21680 "Format TXT to be inserted into the agenda buffer.
21681 In particular, it adds the prefix and corresponding text properties. EXTRA
21682 must be a string and replaces the `%s' specifier in the prefix format.
21683 CATEGORY (string, symbol or nil) may be used to overrule the default
21684 category taken from local variable or file name. It will replace the `%c'
21685 specifier in the format. DOTIME, when non-nil, indicates that a
21686 time-of-day should be extracted from TXT for sorting of this entry, and for
21687 the `%t' specifier in the format. When DOTIME is a string, this string is
21688 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21689 only the correctly processes TXT should be returned - this is used by
21690 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21691 Any match of REMOVE-RE will be removed from TXT."
21693 ;; Diary entries sometimes have extra whitespace at the beginning
21696 org-category
21702 time ; time and tag are needed for the eval of the prefix format
21705 stamp plain s0 s1 s2 rtn srp)
21707 ;; Extract starting and ending time and move them to prefix
21715 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21716 ;; them, we might want to remove them there to avoid duplication.
21717 ;; The user can turn this off with a variable.
21723 t))
21725 ;; Normalize the time(s) to 24 hour
21733 org-agenda-default-appointment-duration))
21734 h)
21739 txt)
21740 ;; Tags are in the string
21743 org-prefix-has-tag))
21748 t t txt))))
21754 ;; Create the final string
21757 ;; Prepare the variables needed in the eval of the compiled format
21763 ;; Evaluate the compiled format
21766 ;; And finally add the text properties
21769 'org-highest-priority org-highest-priority
21770 'org-lowest-priority org-lowest-priority
21772 'time-of-day time-of-day
21773 'txt txt
21774 'time time
21775 'extra extra
21790 list)))
21795 new time)
21797 ;; don't show empty grid
21803 nil string "" nil
21805 new)
21813 "Compile the prefix format into a Lisp form that can be evaluated.
21814 The resulting form is returned and stored in the variable
21815 `org-prefix-format-compiled'."
21819 org-agenda-prefix-format)
21824 varform vars var e c f opt)
21826 s start)
21839 ""
21849 ;; the old format
21857 "Check string S for a time of day.
21858 If found, return it as a military time number between 0 and 2400.
21859 If not found, return nil.
21860 The optional STRING argument forces conversion into a 5 character wide string
21861 HH:MM."
21883 "Sort and concatenate the agenda items."
21886 list
21905 ; (and re (equal (string-match (concat "\\(\\.*\\)" re) x (or pl 0)) pl)
21906 ; (add-text-properties
21907 ; (or (match-end 1) (match-end 0)) (match-end 0)
21908 ; (list 'face (org-get-todo-face (match-string 2 x)))
21909 ; x))
21916 x)
21920 " "
21922 x)))
21925 "Compare the priorities of string A and B."
21933 "Compare the string values of categories of strings A and B."
21941 "Compare the string values of categories of strings A and B."
21951 "Compare the time-of-day values of strings A and B."
21960 "Predicate for sorting agenda entries."
21961 ;; The following variables will be used when the form is evaluated.
21962 ;; So even though the compiler complains, keep them.
21976 ;;; Agenda restriction lock
21994 "Set restriction lock for agenda, to current subtree or file.
21995 Restriction will be the file if TYPE is `file', or if type is the
21996 universal prefix '(4), or if the cursor is before the first headline
21997 in the file. Otherwise, restriction will be to the current subtree."
22029 "Remove the agenda restriction lock."
22043 "If there is any window showing the agenda view, update it."
22052 org-agenda-overriding-restriction)
22055 ;;; Agenda commands
22058 "Check if agenda buffer is of allowed type.
22059 If ERROR is non-nil, throw an error, otherwise just return nil."
22061 t
22064 nil)))
22067 "Exit agenda by removing the window or the buffer."
22074 ;; Maybe restore the pre-agenda window configuration.
22077 org-pre-agenda-window-conf
22081 "Exit agenda by removing the window or the buffer.
22082 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22083 Org-mode buffers visited directly by the user will not be touched."
22097 "Save all Org-mode buffers without user confirmation."
22104 "Rebuild Agenda.
22105 When this is the global TODO list, a prefix argument will be interpreted."
22114 org-agenda-pending-undo-list nil)
22120 "Jump to DATE in agenda."
22125 "Go to today."
22151 "Go forward in time by thee current span.
22152 With prefix ARG, go forward that many times the current span."
22159 greg2 nd)
22181 "Go backward in time by the current span.
22182 With prefix ARG, go backward that many times the current span."
22187 "Switch to daily view for agenda."
22192 "Switch to daily view for agenda."
22197 "Switch to daily view for agenda."
22201 "Switch to daily view for agenda."
22208 "Change the agenda view to SPAN.
22209 SPAN may be `day', `week', `month', `year'."
22214 org-starting-day))
22225 "Compute starting date and number of days for agenda.
22226 SPAN may be `day', `week', `month', `year'. The return value
22227 is a cons cell with the starting date and the number of days,
22228 so that the date SD will be in that range."
22230 nd)
22247 sd)))
22253 sd))))
22256 ;; FIXME: does not work if user makes date format that starts with a blank
22258 "Jump to the next line indicating a date in agenda buffer."
22270 "Jump to the previous line indicating a date in agenda buffer."
22277 ;; Initialize the highlight
22282 "Highlight a region with overlay."
22287 "Detach overlay INDEX."
22290 ;; FIXME this is currently not used.
22299 "Toggle follow mode in an agenda buffer."
22307 "Toggle log mode in an agenda buffer."
22317 "Toggle diary inclusion in an agenda buffer."
22327 "Toggle time grid in an agenda buffer."
22337 "Set the mode name to indicate all the small mode settings."
22356 "Show the priority of the current item.
22357 This priority is composed of the main priority given with the [#A] cookies,
22358 and by additional input from the age of a schedules or deadline entry."
22364 "Show the tags applicable to the current item."
22373 "Go to the Org-mode file which contains the item at point."
22392 "Normal hook run after an item has been shown from the agenda.
22396 "Kill the entry or subtree belonging to the current agenda entry."
22429 "Kill the entry or subtree belonging to the current agenda entry."
22447 "Remove all lines in the agenda that correspond to a given subtree.
22448 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22449 If this information is not given, the function uses the tree at point."
22472 "Follow the link in the current line, if any."
22481 "Get a variable from a referenced buffer and install it here."
22488 "Go to the Org-mode file which contains the item at point."
22505 "Go to the Org-mode file which contains the item at the mouse click."
22511 "Display the Org-mode file which contains the item at point."
22518 "Display the Org-mode file which contains the item at point and recenter."
22526 "Display the Org-mode file which contains the item at the mouse click."
22532 "Check if the entry is a diary link and abort if yes."
22540 "Show the subtree corresponding to the current entry in an indirect buffer.
22541 This calls the command `org-tree-to-indirect-buffer' from the original
22542 Org-mode buffer.
22543 With numerical prefix arg ARG, go up to this level and then take that tree.
22544 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22545 dedicated frame)."
22558 "Marker pointing to the headline that last changed its TODO state
22562 "Switch TODO entry to next sequence."
22567 "Switch TODO entry to previous sequence."
22572 "Cycle TODO state of line at point, also in Org-mode file.
22573 This changes the line at point, all other lines in the agenda referring to
22574 the same tree node, and the headline of the tree node in the Org-mode file."
22584 newhead)
22605 "Change all lines in the agenda buffer which match HDMARKER.
22606 The new content of the line will be NEWHEAD (as modified by
22607 `org-format-agenda-item'). HDMARKER is checked with
22608 `equal' against all `org-hd-marker' text properties in the file.
22609 If FIXFACE is non-nil, the face of each item is modified acording to
22610 the new TODO state."
22612 props m pl undone-face done-face finish new dotime cat tags)
22642 undone-face done-face))))
22650 "Align all tags in agenda items to `org-agenda-tags-column'."
22663 org-agenda-tags-column))
22671 "Increase the priority of line at point, also in Org-mode file."
22676 "Decrease the priority of line at point, also in Org-mode file."
22681 "Set the priority of line at point, also in Org-mode file.
22682 This changes the line at point, all other lines in the agenda referring to
22683 the same tree node, and the headline of the tree node in the Org-mode file."
22692 newhead)
22708 "Get a list of all headline tags applicable at POS.
22709 POS defaults to point. If tags are inherited, the list contains
22710 the targets in the same sequence as the headlines appear, i.e.
22711 the tags of the current headline come last."
22726 tags)))
22730 tags)))
22732 ;; FIXME: should fix the tags property of the agenda line.
22734 "Set tags for the current headline."
22745 newhead)
22763 "Toggle the archive tag for the current entry."
22772 newhead)
22788 "Change the date of this item to one day later."
22807 "Change the date of this item to one day earlier."
22812 "Show new date stamp via text properties."
22813 ;; We use text properties to make this undoable
22822 ;; Use `duplicable' property to trigger undo recording
22837 "Change the date of this item. Date is prompted for, with default today.
22838 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22839 be used to request time specification in the time stamp."
22857 "Schedule the item at point."
22866 ts)
22876 "Schedule the item at point."
22885 ts)
22895 "Return the heading of the current entry, without the stars."
22905 "Start the clock on the currently selected item."
22918 "Stop the currently running clock."
22926 "Cancel the currently running clock."
22934 "Make a diary entry, like the `i' command from the calendar.
22935 All the standard commands work: block, weekly etc."
22951 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
22960 ;; We implement this by hacking the `calendar-cursor-to-date' function
22961 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
22977 "Execute a calendar command from the agenda, with the date associated to
22978 the cursor position."
22987 ;; the following 3 vars are needed in the calendar
23001 "Display the phases of the moon for the 3 months around the cursor date."
23006 "Display the holidays for the 3 months around the cursor date."
23011 "Display sunrise and sunset for the cursor date.
23012 Latitude and longitude can be specified with the variables
23013 `calendar-latitude' and `calendar-longitude'. When called with prefix
23014 argument, latitude and longitude will be prompted for."
23023 "Open the Emacs calendar with the date at the cursor."
23036 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23037 This is a command that has to be installed in `calendar-mode-map'."
23041 nil))
23047 date s)
23073 ;;;; Embedded LaTeX
23088 "Toggle the minor `org-cdlatex-mode'.
23089 This mode supports entering LaTeX environment and math in LaTeX fragments
23090 in Org-mode.
23092 nil " OCDL" nil
23097 "Always return t in org-mode buffers.
23098 This is because we want to insert math symbols without dollars even outside
23099 the LaTeX math segments. If Orgmode thinks that point is actually inside
23100 en embedded LaTeX fragement, let texmathp do its job.
23117 "Unconditionally turn on `org-cdlatex-mode'."
23121 "Test if point is inside a LaTeX fragment.
23123 sequence appearing also before point.
23124 Even though the matchers for math are configurable, this function assumes
23126 delimiters are skipped when they have been removed by customization.
23127 The return value is nil, or a cons cell with the delimiter and
23128 and the position of this delimiter.
23130 This function does a reasonably good job, but can locally be fooled by
23131 for example currency specifications. For example it will assume being in
23133 fragments that are properly closed, but during editing, we have to live
23134 with the uncertainty caused by missing closing delimiters. This function
23135 looks only before point, not after."
23154 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23158 ;; count $$
23166 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23167 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23168 - inside a LaTeX fragment, or
23169 - after the first word in a line, where an abbreviation expansion could
23170 insert a LaTeX environment."
23183 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23184 Revert to the normal definition outside of these fragments."
23192 "Execute `cdlatex-math-modify' in LaTeX fragments.
23193 Revert to the normal definition outside of these fragments."
23205 "Remove all overlays with LaTeX fragment images in current buffer."
23210 "Preview the LaTeX fragment at point, or all locally or globally.
23211 If the cursor is in a LaTeX fragment, create the image and overlay
23212 it over the source code. If there is no fragment at point, display
23213 all fragments in the current text, from one headline to the next. With
23214 prefix SUBTREE, display all fragments in the current subtree. With a
23215 double prefix `C-u C-u', or when the cursor is before the first headline,
23216 display all fragments in the buffer.
23246 buffer-file-name)))
23252 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23253 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23254 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23261 "Replace LaTeX fragments with links to an image, and produce images."
23270 m n block linkfile movefile ov)
23271 ;; Check if there are old images files with this prefix, and remove them
23275 todir 'full
23277 ;; Check the different regular expressions
23297 txt movefile opt forbuffer)
23305 ov 'end-glyph
23308 ov 'display
23315 ;; This function borrows from Ganesh Swami's latex2png.el
23319 temporary-file-directory))
23348 "-D" dpi
23349 ;;"-x" scale "-y" scale
23351 "-o" pngfile
23352 dvifile)
23355 ;; Use the requested file name and clean up
23359 pngfile))))
23362 "Return an rgb color specification for dvipng."
23368 "Return string to be used as color value for an RGB component."
23371 ;;;; Exporting
23373 ;;; Variables, constants, and parameter plists
23429 "Return the property list with default settings for the export variables."
23433 rtn))
23436 "Return the property list with file-local settings for export."
23443 p key val text options)
23476 o)
23480 options)
23484 p))))
23490 val)))
23491 dir))
23498 rtn line level)
23503 ;; Beginning of a COMMENT subtree. Skip it.
23509 ;; an ordinary comment line
23510 )
23516 ;; a special table line that should be removed
23517 )
23524 \[v] limit export to visible part of outline tree
23526 \[a] export as ASCII
23528 \[h] export as HTML
23529 \[H] export as HTML to temporary buffer
23530 \[R] export region as HTML
23531 \[b] export as HTML and browse immediately
23532 \[x] export as XOXO
23534 \[l] export as LaTeX
23535 \[L] export as LaTeX to temporary buffer
23537 \[i] export current file as iCalendar file
23538 \[I] export all agenda files as iCalendar files
23539 \[c] export agenda files into combined iCalendar file
23541 \[F] publish current file
23542 \[P] publish current project
23543 \[X] publish... (project will be prompted for)
23563 r1 r2 ass)
23866 )
23867 "Entities for TeX->HTML translation.
23871 The list contains HTML entities for Latin-1, Greek and other symbols.
23872 It is supplemented by a number of commonly used TeX macros with appropriate
23875 ;;; General functions for all backends
23878 "Cleanup a buffer STRING so that links can be created safely."
23896 a b xx
23897 rtn p)
23901 ;; Remove license-to-kill stuff
23909 ;; Get rid of drawers
23914 'identity
23922 ;; Get the correct stuff before the first headline
23933 ;; Get rid of archived trees
23945 ;; Find targets in comments and move them out of comments,
23946 ;; but mark them as targets that should be invisible
23951 ;; Protect backend specific stuff, throw away the others.
23956 fmt)
23987 ;; Protect quoted subtrees
23995 ;; Protect verbatim elements
24002 ;; Remove subtrees that are commented
24008 ;; Remove special table lines
24020 ;; Specific LaTeX stuff
24028 ;; Specific HTML stuff
24030 ;; Convert LaTeX fragments to images
24035 org-current-export-file)))
24039 ;; Remove or replace comments
24048 ;; Find matches for radio targets and turn them into internal links
24055 ;; Find all links that contain a newline and put them into a single line
24057 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24063 ;; Normalize links: Convert angle and plain links into bracket links
24064 ;; Expand link abbreviations
24071 ;; added 'org-link face to links
24087 "]"
24095 ;; Find multiline emphasis and put them into single line
24109 rtn))
24112 "Get a title for the current document, from looking at the buffer."
24118 ;; Mark the line so that it will not be exported as normal text.
24122 ;; Return the title string
24126 "Return subtree title and exclude it from export."
24132 ;; This is a subtree, we take the title from the first heading
24139 title))
24142 "Take link text and make a safe target out of it."
24146 'identity
24152 "Get the minimum level in LINES."
24160 ;; Variable holding the vector with section numbers
24164 "Initialize the vector for the section numbers."
24181 "Return a string with the current section number.
24182 When LEVEL is non-nil, increase section numbers on that level."
24204 string))
24206 ;;; ASCII export
24214 "Export the outline as a pretty ASCII file.
24215 If there is an active region, export only the region.
24216 The prefix ARG specifies how many levels of the outline should become
24217 underlined headlines. The default is 3."
24246 filename))
24262 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24271 region
24272 :for-ascii t
24273 :skip-before-1st-heading
24276 :verbatim-multiline t
24277 :archived-trees
24281 thetoc have-headings first-heading-pos
24282 table-open table-buffer)
24300 ;; create local variables for all options, to make sure all called
24301 ;; functions get the correct information
24305 org-export-plist-vars)
24308 org-export-headline-levels))
24311 umax))
24313 ;; File header
24317 org-export-author-info)
24339 line)
24340 ;; This is a headline
24346 todo
24350 org-done-keywords)))
24351 ; TODO, not DONE
24355 line lines level))))
24362 t t txt)))
24367 txt))
24382 thetoc)
24384 ))))
24385 lines)
24390 ;; Remove the quoted HTML tags.
24392 ;; Remove targets
24395 ;; Replace internal links
24399 t nil line)))
24404 ;; a Headline
24413 ;; New table starts
24415 ;; Accumulate lines
24436 ;; insert the table of contents
24448 ;; Convert whitespace place holders
24458 ;; remove display and invisible chars
24474 "Do extra work for ASCII export"
24484 "Search the subtree below LINE for any TODO entries."
24487 line lv todo)
24495 org-done-keywords))))
24496 ; TODO, not DONE
24501 "Handle quoted HTML for ASCII export."
24504 ;; We just remove the tags for now.
24506 line)
24509 "Insert the string S centered and underline it with character UNDERLINE."
24518 "Insert a new level in ASCII export."
24524 org-export-ascii-bullets))
24526 ;; find the indentation of the next non-empty line
24547 "Create a copy of the visible part of the current buffer, and export it.
24548 The copy is created in a temporary buffer and removed after use.
24549 TYPE is the final key (as a string) that also select the export command in
24550 the `C-c C-e' export dispatcher.
24551 As a special case, if the you type SPC at the prompt, the temporary
24552 org-mode file will not be removed but presented to you so that you can
24553 continue to use it. The prefix arg ARG is passed through to the exporting
24554 command."
24557 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24559 current-prefix-arg))
24574 s e)
24575 ;; Need to hack the drawers here.
24591 ;; Copy all comment lines to the end, to make sure #+ settings are
24592 ;; still available for the second export step. Kind of a hack, but
24593 ;; does do the trick.
24614 s))
24619 s))
24621 ;;; HTML export
24624 "Return a string with current options as keyword options.
24625 Does include HTML export options as well as TODO and CATEGORY stuff."
24627 "#+TITLE: %s
24628 #+AUTHOR: %s
24629 #+EMAIL: %s
24630 #+LANGUAGE: %s
24631 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24632 #+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
24633 #+CATEGORY: %s
24634 #+SEQ_TODO: %s
24635 #+TYP_TODO: %s
24636 #+PRIORITIES: %c %c %c
24637 #+DRAWERS: %s
24638 #+STARTUP: %s %s %s %s %s
24639 #+TAGS: %s
24640 #+ARCHIVE: %s
24641 #+LINK: %s
24642 "
24644 org-export-headline-levels
24645 org-export-with-section-numbers
24646 org-export-with-toc
24647 org-export-preserve-breaks
24648 org-export-html-expand
24649 org-export-with-fixed-width
24650 org-export-with-tables
24651 org-export-with-sub-superscripts
24652 org-export-with-special-strings
24653 org-export-with-footnotes
24654 org-export-with-emphasize
24655 org-export-with-TeX-macros
24656 org-export-with-LaTeX-fragments
24657 org-export-skip-text-before-1st-heading
24658 org-export-with-drawers
24659 org-export-with-tags
24661 "TODO FEEDBACK VERIFY DONE"
24662 "Me Jason Marie DONE"
24663 org-highest-priority org-lowest-priority org-default-priority
24682 org-archive-location
24683 "org file:~/org/%s.org"
24684 ))
24687 "Insert into the buffer a template with information for exporting."
24696 "Toggle the fixed-width export.
24697 If there is no active region, the QUOTE keyword at the current headline is
24698 inserted or removed. When present, it causes the text between this headline
24699 and the next to be exported as fixed-width text, and unmodified.
24700 If there is an active region, this command adds or removes a colon as the
24701 first character of this line. If the first character of a line is a colon,
24702 this line is also exported in fixed-width font."
24711 off)
24741 "Export the outline as HTML and immediately open it with a browser.
24742 If there is an active region, export only the region.
24743 The prefix ARG specifies how many levels of the outline should become
24744 headlines. The default is 3. Lower levels will become bulleted lists."
24750 "Call `org-export-as-html', may be used in batch processing as
24751 emacs --batch
24752 --load=$HOME/lib/emacs/org.el
24754 --visit=MyFile --funcall org-export-as-html-batch"
24758 "Call `org-exort-as-html` with output to a temporary buffer.
24759 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24765 "Assume the current region has org-mode syntax, and convert it to HTML.
24766 This can be used in any buffer. For example, you could write an
24767 itemized list in org-mode syntax in an HTML buffer and then use this
24768 command to convert it."
24788 "Convert region from BEG to END in org-mode buffer to HTML.
24789 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24790 contents, and only produce the region of converted text, useful for
24791 cut-and-paste operations.
24792 If BUFFER is a buffer or a string, use/create that buffer as a target
24793 of the converted HTML. If BUFFER is the symbol `string', return the
24794 produced HTML as a string and leave not buffer behind. For example,
24795 a Lisp program could call this function in the following way:
24797 (setq html (org-export-region-as-html beg end t 'string))
24799 When called interactively, the output buffer is selected, and shown
24800 in a window. A non-interactive call will only retunr the buffer."
24805 rtn)
24810 nil nil nil
24811 buffer body-only))
24815 rtn)))
24819 to-buffer body-only)
24820 "Export the outline as a pretty HTML file.
24821 If there is an active region, export only the region. The prefix
24822 ARG specifies how many levels of the outline should become
24823 headlines. The default is 3. Lower levels will become bulleted
24824 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24825 EXT-PLIST is a property list with external parameters overriding
24826 org-mode's default settings, but still inferior to file-local
24827 settings. When TO-BUFFER is non-nil, create a buffer with that
24828 name and export to that buffer. If TO-BUFFER is the symbol `string',
24829 don't leave any buffer behind but just return the resulting HTML as
24830 a string. When BODY-ONLY is set, don't produce the file header and footer,
24831 simply return the content of <body>...</body>, without even
24832 the body tags themselves."
24835 ;; Make sure we have a file name when we need it.
24841 buffer-file-name))
24850 ext-plist
24855 valid thetoc have-headings first-heading-pos
24864 ;; The following two are dynamically scoped into other
24865 ;; routines below.
24884 default-directory))
24918 buffer-file-coding-system))
24920 coding-system))
24922 coding-system))
24934 region
24935 :emph-multiline t
24936 :for-html t
24937 :skip-before-1st-heading
24940 :archived-trees
24942 :add-text
24944 :LaTeX-fragments
24947 table-open type
24948 table-buffer table-orig-buffer
24949 ind start-is-num starter didclose
24950 rpl path desc descp desc1 desc2 link
24951 )
24970 ;; Get the language-dependent settings
24974 ;; Switch to the output buffer
24984 ;; create local variables for all options, to make sure all called
24985 ;; functions get the correct information
24989 org-export-plist-vars)
24991 org-export-headline-levels))
24994 umax))
24996 ;; File header
25002 <head>
25003 <title>%s</title>
25008 %s
25009 </head><body>
25010 "
25023 org-export-html-toplevel-hlevel
25025 org-export-html-toplevel-hlevel)
25026 thetoc)
25031 ;; This is a headline
25040 todo
25044 org-done-keywords)))
25045 ; TODO, not DONE
25049 line lines level))))
25074 ;; Check for targets
25079 t t line))
25082 target-alist))
25093 )))
25094 line)
25095 lines))
25107 ;; end of quote section?
25111 ;; inside a quote section?
25116 ;; verbatim lines
25130 ;; Protected HTML
25145 ;; Horizontal line
25150 ;; make targets to anchors
25158 t t line)))
25162 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25163 t t line)))
25169 t t line)))))
25173 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25174 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25175 ;; Also handle sub_superscripts and checkboxes
25179 ;; Format the links
25189 ;; Make an image out of the description if that is so wanted
25195 ;; FIXME: do we need to unescape here somewhere?
25205 ;; standard URL, just check if we need to inline an image
25213 ;; standard URL
25217 ;; FILE link
25220 thefile file-is-image-p search)
25228 t))
25237 ;; make sure this is can be used as target search
25262 ;; TODO items
25270 org-done-keywords)
25275 ;; Does this contain a reference to a footnote?
25287 t t line))))))
25291 ;; This is a headline
25299 ;; Close any local lists before inserting a new header line
25305 in-local-list nil))
25309 head-count)
25310 ;; QUOTES
25318 ;; New table starts
25320 ;; Accumulate lines
25332 ;; Normal lines
25335 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25336 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25339 line)
25346 ;; empty line. Pretend indentation is large.
25348 0
25364 ;; Start new (level of) list
25371 ;; continue current list
25375 ;; we did close a list, normal text follows: need <p>
25381 "<b>[X]</b>"
25383 t t line))))
25385 ;; Empty lines start a new paragraph. If hand-formatted lists
25386 ;; are not fully interpreted, lines starting with "-", "+", "*"
25387 ;; also start a new paragraph.
25390 ;; Is this the start of a footnote?
25396 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25398 ;; Check if the line break needs to be conserved
25407 ;; Properly close all local lists and other lists
25410 ;; Close any local lists before inserting a new header line
25416 in-local-list nil))
25419 head-count)
25450 ;; insert the table of contents
25467 ;; remove empty paragraphs and lists
25474 ;; Convert whitespace place holders
25495 "Format a table for ascii export."
25499 ;; Table made by table.el - test for spanning
25500 lines
25502 ;; A normal org table
25503 ;; Get rid of hlines at beginning and end
25509 ;; Check if the table has a marking column. If yes remove the
25510 ;; column and the special lines
25512 ;; Get rid of the vertical lines except for grouping
25514 rtn line vl1 start)
25536 vl))
25539 "Find out which HTML converter to use and return the HTML code."
25543 ;; A normal org table
25545 ;; Table made by table.el - test for spanning
25549 nil))
25550 lines)))
25556 hlines))))
25559 ;; We can use my own converter with HTML conversions
25561 ;; Need to use the code generator in table.el, with the original text.
25565 "Format a table into HTML."
25566 ;; Get rid of hlines at beginning and end
25572 ;; Check if the table has a marking column. If yes remove the
25573 ;; column and the special lines
25581 tbopen line fields html gr colgropen)
25593 ;; ignore this line
25595 ;; Break the line into fields
25613 html)))
25618 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25634 html)
25640 "Check if the table has a marking column.
25641 If yes remove the column and the special lines."
25647 lines))
25662 nil)
25664 lines)))
25678 nil)
25683 ;; remove the first column
25685 lines))))
25688 "Format a table generated by table.el into HTML.
25689 This conversion does *not* use `table-generate-source' from table.el.
25690 This has the advantage that Org-mode's HTML conversions can be used.
25691 But it has the disadvantage, that no cell- or row-spanning is allowed."
25694 fields html empty)
25704 html
25706 html
25707 "<tr>"
25720 ;; Ignore this line
25722 ;; Break the line into fields and store the fields
25728 field-buffer))
25731 html))
25734 "Format a table into html, using `table-generate-source' from table.el.
25735 This has the advantage that cell- or row-spanning is allowed.
25736 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25751 "Format time stamps in string S, or remove them."
25756 ;; never export CLOCK
25771 ;; Line break if line started and ended with time stamp stuff
25773 s
25777 r))))
25780 ;; convert & to &, < to < and > to >
25789 s)
25792 "Remove tags and time staps from lines going into the toc."
25801 t t s)))
25802 s)
25805 "Prepare STRING for HTML export. Applies all active conversions.
25806 If there are links in the string, don't modify these."
25809 m s l res)
25820 "Apply all active conversions to translate special ASCII to HTML."
25841 t t s))
25843 s)
25846 "Create a regular expression which will match a balanced sexp.
25847 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25848 as single character strings.
25849 The regexp returned will match the entire expression including the
25850 delimiters. It will also define a single group which contains the
25851 match except for the outermost delimiters. The maximum depth of
25852 stacked delimiters is N. Escaping delimiters is not possible."
25888 "Convert special characters in STRING to HTML."
25890 e a re rpl start)
25897 string))
25900 "Convert sub- and superscripts in STRING to HTML."
25916 t t string)))))
25919 string))
25922 "Apply emphasis."
25929 rpl
25935 org-emphasis-alist))
25940 string))
25944 "Insert <p>, but first close previous paragraph if any."
25949 "Close paragraph if there is one open."
25954 "Close <li> if necessary."
25960 "Insert a new level in HTML export.
25961 When TITLE is nil, just close all open levels."
25971 ;; If title is nil, this means this function is called to close
25972 ;; all levels, so the rest is done only if title is given
25984 t t title)))
26000 level level head-count title level))
26005 "Terminate one level in HTML export."
26011 ;;; iCalendar export
26013 ;;;###autoload
26015 "Export current file as an iCalendar file.
26016 The iCalendar file will be located in the same directory as the Org-mode
26017 file, but with extension `.ics'."
26021 ;;;###autoload
26023 "Export all files in `org-agenda-files' to iCalendar .ics files.
26024 Each iCalendar file will be located in the same directory as the Org-mode
26025 file, but with extension `.ics'."
26029 ;;;###autoload
26031 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26032 The file is stored under the name `org-combined-agenda-icalendar-file'."
26037 "Create iCalendar files for all elements of FILES.
26038 If COMBINE is non-nil, combine all calendar entries into a single large
26039 file and store it under the name `org-combined-agenda-icalendar-file'."
26044 org-export-publishing-directory)))
26045 file ical-file ical-buffer category started org-agenda-new-buffers)
26051 org-combined-agenda-icalendar-file
26084 "Hook run after an iCalendar file has been saved.
26085 The iCalendar buffer is still current when this hook is run.
26086 A good way to use this is to tell a desktop calenndar application to re-read
26090 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26091 When COMBINE is non nil, add the category to each line."
26098 scheduledp deadlinep tmp pri category entry location summary desc
26108 inc t
26115 t org-icalendar-include-body)
26125 pos)
26130 ts)
26133 ;; donep (org-entry-is-done-p)
26134 ))
26153 t t summary)))
26160 %s
26161 %s%s
26162 SUMMARY:%s%s%s
26163 CATEGORIES:%s
26167 rrule summary
26172 category)))))
26177 ;; Get all the literal sexps
26203 )
26210 t org-icalendar-include-body)
26216 t t hd)))
26226 %s
26227 SUMMARY:%s%s%s
26228 CATEGORIES:%s
26229 SEQUENCE:1
26230 PRIORITY:%d
26231 STATUS:%s
26233 dts
26239 category pri status)))))))))
26242 "Take out stuff and quote what needs to be quoted.
26243 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26244 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26245 characters."
26247 nil
26266 s))
26269 "Clean-up description string."
26275 "Start an iCalendar file by inserting the header."
26281 VERSION:2.0
26282 X-WR-CALNAME:%s
26283 PRODID:-//%s//Emacs with Org-mode//EN
26284 X-WR-TIMEZONE:%s
26288 "Finish an iCalendar file by inserting the END statement."
26292 "Take a time string S and convert it to iCalendar format.
26293 KEYWORD is added in front, to make a complete line like DTSTART....
26294 When INC is non-nil, increase the hour by two (if time string contains
26295 a time), or the day by one (if it does not contain a time)."
26297 t2 fmt have-time time)
26313 ;;; XOXO export
26321 "Export the org buffer as XOXO.
26322 The XOXO buffer is named *xoxo-<source buffer name>*"
26324 ;; A quickie abstraction
26326 ;; Output everything as XOXO
26340 ;; Check the output buffer is empty.
26342 ;; Kick off the output
26359 ;; Handle level rendering
26376 )
26380 ;; And output the new li
26386 ;; Finally finish off the ol
26393 ;; Finish the buffer off and clean it up.
26398 )))
26401 ;;;; Key bindings
26403 ;; Make `C-c C-x' a prefix key
26406 ;; TAB key with modifiers
26413 ;; The following line is necessary under Suse GNU/Linux
26419 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26420 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26421 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26423 ;; Cursor keys with modifiers
26424 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26425 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26426 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26427 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26429 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26430 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26431 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26432 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26434 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26435 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26436 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26437 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26439 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26440 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26442 ;;; Extra keys for tty access.
26443 ;; We only set them when really needed because otherwise the
26444 ;; menus don't show the simple keys
26446 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26447 (not window-system))
26448 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26449 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26450 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26451 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26452 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26453 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26454 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26455 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26456 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26457 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26458 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26459 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26460 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26461 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26462 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26463 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26464 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26465 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26466 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26467 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26468 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26469 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26471 ;; All the other keys
26473 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26474 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26475 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26476 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26477 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26478 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26479 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26480 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26481 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26482 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26483 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26484 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26485 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26486 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26487 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26489 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26490 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26491 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26492 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26493 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26494 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26495 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26496 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26497 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26498 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26499 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26500 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26501 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26502 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26503 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26504 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26505 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26507 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26508 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26509 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26510 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26511 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26512 (org-defkey org-mode-map "\C-c^" 'org-sort)
26513 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26514 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26515 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26516 (org-defkey org-mode-map "\C-m" 'org-return)
26517 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26518 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26519 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26520 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26521 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26522 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26523 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26524 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26525 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26526 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26527 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26528 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26529 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26530 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26531 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26532 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26533 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26535 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26536 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26537 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26538 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26540 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26541 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26542 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26543 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26544 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26545 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26546 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26547 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26548 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26549 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26550 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26551 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26553 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26555 (when (featurep 'xemacs)
26556 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26558 (defsubst org-table-p () (org-at-table-p))
26560 (defun org-self-insert-command (N)
26561 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26562 If the cursor is in a table looking at whitespace, the whitespace is
26563 overwritten, and the table is not marked as requiring realignment."
26564 (interactive "p")
26565 (if (and (org-table-p)
26566 (progn
26567 ;; check if we blank the field, and if that triggers align
26568 (and org-table-auto-blank-field
26569 (member last-command
26570 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26572 ;; got extra space, this field does not determine column width
26573 (let (org-table-may-need-update) (org-table-blank-field))
26574 ;; no extra space, this field may determine column width
26575 (org-table-blank-field)))
26576 t)
26577 (eq N 1)
26579 (let (org-table-may-need-update)
26580 (goto-char (1- (match-end 0)))
26581 (delete-backward-char 1)
26582 (goto-char (match-beginning 0))
26583 (self-insert-command N))
26584 (setq org-table-may-need-update t)
26585 (self-insert-command N)
26586 (org-fix-tags-on-the-fly)))
26588 (defun org-fix-tags-on-the-fly ()
26589 (when (and (equal (char-after (point-at-bol)) ?*)
26590 (org-on-heading-p))
26591 (org-align-tags-here org-tags-column)))
26593 (defun org-delete-backward-char (N)
26594 "Like `delete-backward-char', insert whitespace at field end in tables.
26595 When deleting backwards, in tables this function will insert whitespace in
26597 still be marked for re-alignment if the field did fill the entire column,
26598 because, in this case the deletion might narrow the column."
26599 (interactive "p")
26600 (if (and (org-table-p)
26601 (eq N 1)
26602 (string-match "|" (buffer-substring (point-at-bol) (point)))
26603 (looking-at ".*?|"))
26604 (let ((pos (point))
26606 (c org-table-may-need-update))
26607 (backward-delete-char N)
26608 (skip-chars-forward "^|")
26609 (insert " ")
26610 (goto-char (1- pos))
26611 ;; noalign: if there were two spaces at the end, this field
26612 ;; does not determine the width of the column.
26613 (if noalign (setq org-table-may-need-update c)))
26614 (backward-delete-char N)
26615 (org-fix-tags-on-the-fly)))
26617 (defun org-delete-char (N)
26618 "Like `delete-char', but insert whitespace at field end in tables.
26619 When deleting characters, in tables this function will insert whitespace in
26621 still be marked for re-alignment if the field did fill the entire column,
26622 because, in this case the deletion might narrow the column."
26623 (interactive "p")
26624 (if (and (org-table-p)
26625 (not (bolp))
26626 (not (= (char-after) ?|))
26627 (eq N 1))
26628 (if (looking-at ".*?|")
26629 (let ((pos (point))
26631 (c org-table-may-need-update))
26632 (replace-match (concat
26633 (substring (match-string 0) 1 -1)
26634 " |"))
26635 (goto-char pos)
26636 ;; noalign: if there were two spaces at the end, this field
26637 ;; does not determine the width of the column.
26638 (if noalign (setq org-table-may-need-update c)))
26639 (delete-char N))
26640 (delete-char N)
26641 (org-fix-tags-on-the-fly)))
26643 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26644 (put 'org-self-insert-command 'delete-selection t)
26645 (put 'orgtbl-self-insert-command 'delete-selection t)
26646 (put 'org-delete-char 'delete-selection 'supersede)
26647 (put 'org-delete-backward-char 'delete-selection 'supersede)
26649 ;; Make `flyspell-mode' delay after some commands
26650 (put 'org-self-insert-command 'flyspell-delayed t)
26651 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26652 (put 'org-delete-char 'flyspell-delayed t)
26653 (put 'org-delete-backward-char 'flyspell-delayed t)
26655 ;; Make pabbrev-mode expand after org-mode commands
26656 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26657 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26659 ;; How to do this: Measure non-white length of current string
26660 ;; If equal to column width, we should realign.
26662 (defun org-remap (map &rest commands)
26663 "In MAP, remap the functions given in COMMANDS.
26664 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26665 (let (new old)
26666 (while commands
26667 (setq old (pop commands) new (pop commands))
26668 (if (fboundp 'command-remapping)
26669 (org-defkey map (vector 'remap old) new)
26670 (substitute-key-definition old new map global-map)))))
26672 (when (eq org-enable-table-editor 'optimized)
26673 ;; If the user wants maximum table support, we need to hijack
26674 ;; some standard editing functions
26675 (org-remap org-mode-map
26676 'self-insert-command 'org-self-insert-command
26677 'delete-char 'org-delete-char
26678 'delete-backward-char 'org-delete-backward-char)
26679 (org-defkey org-mode-map "|" 'org-force-self-insert))
26681 (defun org-shiftcursor-error ()
26682 "Throw an error because Shift-Cursor command was applied in wrong context."
26683 (error "This command is active in special context like tables, headlines or timestamps"))
26685 (defun org-shifttab (&optional arg)
26686 "Global visibility cycling or move to previous table field.
26687 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26688 on context.
26689 See the individual commands for more information."
26690 (interactive "P")
26691 (cond
26692 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26693 (arg (message "Content view to level: ")
26694 (org-content (prefix-numeric-value arg))
26695 (setq org-cycle-global-status 'overview))
26696 (t (call-interactively 'org-global-cycle))))
26698 (defun org-shiftmetaleft ()
26699 "Promote subtree or delete table column.
26700 Calls `org-promote-subtree', `org-outdent-item',
26701 or `org-table-delete-column', depending on context.
26702 See the individual commands for more information."
26703 (interactive)
26704 (cond
26705 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26706 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26707 ((org-at-item-p) (call-interactively 'org-outdent-item))
26708 (t (org-shiftcursor-error))))
26710 (defun org-shiftmetaright ()
26711 "Demote subtree or insert table column.
26712 Calls `org-demote-subtree', `org-indent-item',
26713 or `org-table-insert-column', depending on context.
26714 See the individual commands for more information."
26715 (interactive)
26716 (cond
26717 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26718 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26719 ((org-at-item-p) (call-interactively 'org-indent-item))
26720 (t (org-shiftcursor-error))))
26722 (defun org-shiftmetaup (&optional arg)
26723 "Move subtree up or kill table row.
26724 Calls `org-move-subtree-up' or `org-table-kill-row' or
26725 `org-move-item-up' depending on context. See the individual commands
26726 for more information."
26727 (interactive "P")
26728 (cond
26729 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26730 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26731 ((org-at-item-p) (call-interactively 'org-move-item-up))
26732 (t (org-shiftcursor-error))))
26733 (defun org-shiftmetadown (&optional arg)
26734 "Move subtree down or insert table row.
26735 Calls `org-move-subtree-down' or `org-table-insert-row' or
26736 `org-move-item-down', depending on context. See the individual
26737 commands for more information."
26738 (interactive "P")
26739 (cond
26740 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26741 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26742 ((org-at-item-p) (call-interactively 'org-move-item-down))
26743 (t (org-shiftcursor-error))))
26745 (defun org-metaleft (&optional arg)
26746 "Promote heading or move table column to left.
26747 Calls `org-do-promote' or `org-table-move-column', depending on context.
26748 With no specific context, calls the Emacs default `backward-word'.
26749 See the individual commands for more information."
26750 (interactive "P")
26751 (cond
26752 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26753 ((or (org-on-heading-p) (org-region-active-p))
26754 (call-interactively 'org-do-promote))
26755 ((org-at-item-p) (call-interactively 'org-outdent-item))
26756 (t (call-interactively 'backward-word))))
26758 (defun org-metaright (&optional arg)
26759 "Demote subtree or move table column to right.
26760 Calls `org-do-demote' or `org-table-move-column', depending on context.
26761 With no specific context, calls the Emacs default `forward-word'.
26762 See the individual commands for more information."
26763 (interactive "P")
26764 (cond
26765 ((org-at-table-p) (call-interactively 'org-table-move-column))
26766 ((or (org-on-heading-p) (org-region-active-p))
26767 (call-interactively 'org-do-demote))
26768 ((org-at-item-p) (call-interactively 'org-indent-item))
26769 (t (call-interactively 'forward-word))))
26771 (defun org-metaup (&optional arg)
26772 "Move subtree up or move table row up.
26773 Calls `org-move-subtree-up' or `org-table-move-row' or
26774 `org-move-item-up', depending on context. See the individual commands
26775 for more information."
26776 (interactive "P")
26777 (cond
26778 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26779 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26780 ((org-at-item-p) (call-interactively 'org-move-item-up))
26781 (t (transpose-lines 1) (beginning-of-line -1))))
26783 (defun org-metadown (&optional arg)
26784 "Move subtree down or move table row down.
26785 Calls `org-move-subtree-down' or `org-table-move-row' or
26786 `org-move-item-down', depending on context. See the individual
26787 commands for more information."
26788 (interactive "P")
26789 (cond
26790 ((org-at-table-p) (call-interactively 'org-table-move-row))
26791 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26792 ((org-at-item-p) (call-interactively 'org-move-item-down))
26793 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26795 (defun org-shiftup (&optional arg)
26796 "Increase item in timestamp or increase priority of current headline.
26797 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26798 depending on context. See the individual commands for more information."
26799 (interactive "P")
26800 (cond
26801 ((org-at-timestamp-p t)
26802 (call-interactively (if org-edit-timestamp-down-means-later
26803 'org-timestamp-down 'org-timestamp-up)))
26804 ((org-on-heading-p) (call-interactively 'org-priority-up))
26805 ((org-at-item-p) (call-interactively 'org-previous-item))
26806 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26808 (defun org-shiftdown (&optional arg)
26809 "Decrease item in timestamp or decrease priority of current headline.
26810 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26811 depending on context. See the individual commands for more information."
26812 (interactive "P")
26813 (cond
26814 ((org-at-timestamp-p t)
26815 (call-interactively (if org-edit-timestamp-down-means-later
26816 'org-timestamp-up 'org-timestamp-down)))
26817 ((org-on-heading-p) (call-interactively 'org-priority-down))
26818 (t (call-interactively 'org-next-item))))
26820 (defun org-shiftright ()
26821 "Next TODO keyword or timestamp one day later, depending on context."
26822 (interactive)
26823 (cond
26824 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26825 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26826 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26827 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26828 (t (org-shiftcursor-error))))
26830 (defun org-shiftleft ()
26831 "Previous TODO keyword or timestamp one day earlier, depending on context."
26832 (interactive)
26833 (cond
26834 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26835 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26836 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26837 ((org-at-property-p)
26838 (call-interactively 'org-property-previous-allowed-value))
26839 (t (org-shiftcursor-error))))
26841 (defun org-shiftcontrolright ()
26842 "Switch to next TODO set."
26843 (interactive)
26844 (cond
26845 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26846 (t (org-shiftcursor-error))))
26848 (defun org-shiftcontrolleft ()
26849 "Switch to previous TODO set."
26850 (interactive)
26851 (cond
26852 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26853 (t (org-shiftcursor-error))))
26855 (defun org-ctrl-c-ret ()
26856 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26857 (interactive)
26858 (cond
26859 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26860 (t (call-interactively 'org-insert-heading))))
26862 (defun org-copy-special ()
26863 "Copy region in table or copy current subtree.
26864 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26865 See the individual commands for more information."
26866 (interactive)
26867 (call-interactively
26868 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26870 (defun org-cut-special ()
26871 "Cut region in table or cut current subtree.
26872 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26873 See the individual commands for more information."
26874 (interactive)
26875 (call-interactively
26876 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26878 (defun org-paste-special (arg)
26879 "Paste rectangular region into table, or past subtree relative to level.
26880 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26881 See the individual commands for more information."
26882 (interactive "P")
26883 (if (org-at-table-p)
26884 (org-table-paste-rectangle)
26885 (org-paste-subtree arg)))
26887 (defun org-ctrl-c-ctrl-c (&optional arg)
26888 "Set tags in headline, or update according to changed information at point.
26890 This command does many different things, depending on context:
26892 - If the cursor is in a headline, prompt for tags and insert them
26893 into the current line, aligned to `org-tags-column'. When called
26894 with prefix arg, realign all tags in the current buffer.
26896 - If the cursor is in one of the special #+KEYWORD lines, this
26897 triggers scanning the buffer for these lines and updating the
26898 information.
26900 - If the cursor is inside a table, realign the table. This command
26901 works even if the automatic table editor has been turned off.
26903 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26904 the entire table.
26906 - If the cursor is a the beginning of a dynamic block, update it.
26908 - If the cursor is inside a table created by the table.el package,
26909 activate that table.
26911 - If the current buffer is a remember buffer, close note and file it.
26912 with a prefix argument, file it without further interaction to the default
26913 location.
26915 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26916 links in this buffer.
26918 - If the cursor is on a numbered item in a plain list, renumber the
26919 ordered list.
26921 - If the cursor is on a checkbox, toggle it."
26922 (interactive "P")
26923 (let ((org-enable-table-editor t))
26924 (cond
26925 ((or org-clock-overlays
26926 org-occur-highlights
26927 org-latex-fragment-image-overlays)
26928 (org-remove-clock-overlays)
26929 (org-remove-occur-highlights)
26930 (org-remove-latex-fragment-image-overlays)
26931 (message "Temporary highlights/overlays removed from current buffer"))
26932 ((and (local-variable-p 'org-finish-function (current-buffer))
26933 (fboundp org-finish-function))
26934 (funcall org-finish-function))
26935 ((org-at-property-p)
26936 (call-interactively 'org-property-action))
26937 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
26938 ((org-on-heading-p) (call-interactively 'org-set-tags))
26939 ((org-at-table.el-p)
26940 (require 'table)
26941 (beginning-of-line 1)
26942 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
26943 (call-interactively 'table-recognize-table))
26944 ((org-at-table-p)
26945 (org-table-maybe-eval-formula)
26946 (if arg
26947 (call-interactively 'org-table-recalculate)
26948 (org-table-maybe-recalculate-line))
26949 (call-interactively 'org-table-align))
26950 ((org-at-item-checkbox-p)
26951 (call-interactively 'org-toggle-checkbox))
26952 ((org-at-item-p)
26953 (call-interactively 'org-maybe-renumber-ordered-list))
26955 ;; Dynamic block
26956 (beginning-of-line 1)
26957 (org-update-dblock))
26959 (cond
26960 ((equal (match-string 1) "TBLFM")
26961 ;; Recalculate the table before this line
26962 (save-excursion
26963 (beginning-of-line 1)
26965 (if (org-at-table-p)
26966 (org-call-with-arg 'org-table-recalculate t))))
26967 (t
26968 (call-interactively 'org-mode-restart))))
26969 (t (error "C-c C-c can do nothing useful at this location.")))))
26971 (defun org-mode-restart ()
26972 "Restart Org-mode, to scan again for special lines.
26973 Also updates the keyword regular expressions."
26974 (interactive)
26975 (let ((org-inhibit-startup t)) (org-mode))
26976 (message "Org-mode restarted to refresh keyword and special line setup"))
26978 (defun org-kill-note-or-show-branches ()
26979 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
26980 (interactive)
26981 (if (not org-finish-function)
26982 (call-interactively 'show-branches)
26983 (let ((org-note-abort t))
26984 (funcall org-finish-function))))
26986 (defun org-return (&optional indent)
26987 "Goto next table row or insert a newline.
26988 Calls `org-table-next-row' or `newline', depending on context.
26989 See the individual commands for more information."
26990 (interactive)
26991 (cond
26992 ((bobp) (if indent (newline-and-indent) (newline)))
26993 ((and (org-at-heading-p)
26994 (looking-at
26996 (org-show-entry)
26997 (end-of-line 1)
26998 (newline))
26999 ((org-at-table-p)
27000 (org-table-justify-field-maybe)
27001 (call-interactively 'org-table-next-row))
27002 (t (if indent (newline-and-indent) (newline)))))
27004 (defun org-return-indent ()
27005 (interactive)
27006 "Goto next table row or insert a newline and indent.
27007 Calls `org-table-next-row' or `newline-and-indent', depending on
27008 context. See the individual commands for more information."
27009 (org-return t))
27011 (defun org-ctrl-c-minus ()
27012 "Insert separator line in table or modify bullet type in list.
27013 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
27014 depending on context."
27015 (interactive)
27016 (cond
27017 ((org-at-table-p)
27018 (call-interactively 'org-table-insert-hline))
27019 ((org-on-heading-p)
27020 ;; Convert to item
27021 (save-excursion
27022 (beginning-of-line 1)
27024 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27025 ((org-in-item-p)
27026 (call-interactively 'org-cycle-list-bullet))
27027 (t (error "`C-c -' does have no function here."))))
27029 (defun org-meta-return (&optional arg)
27030 "Insert a new heading or wrap a region in a table.
27031 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27032 See the individual commands for more information."
27033 (interactive "P")
27034 (cond
27035 ((org-at-table-p)
27036 (call-interactively 'org-table-wrap-region))
27037 (t (call-interactively 'org-insert-heading))))
27039 ;;; Menu entries
27041 ;; Define the Org-mode menus
27042 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27043 '("Tbl"
27044 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27045 ["Next Field" org-cycle (org-at-table-p)]
27046 ["Previous Field" org-shifttab (org-at-table-p)]
27047 ["Next Row" org-return (org-at-table-p)]
27048 "--"
27049 ["Blank Field" org-table-blank-field (org-at-table-p)]
27050 ["Edit Field" org-table-edit-field (org-at-table-p)]
27051 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27052 "--"
27053 ("Column"
27054 ["Move Column Left" org-metaleft (org-at-table-p)]
27055 ["Move Column Right" org-metaright (org-at-table-p)]
27056 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27057 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27058 ("Row"
27059 ["Move Row Up" org-metaup (org-at-table-p)]
27060 ["Move Row Down" org-metadown (org-at-table-p)]
27061 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27062 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27063 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27064 "--"
27065 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27066 ("Rectangle"
27067 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27068 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27069 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27070 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27071 "--"
27072 ("Calculate"
27073 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27074 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27075 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27076 "--"
27077 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27078 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27079 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27080 "--"
27081 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27082 "--"
27083 ["Sum Column/Rectangle" org-table-sum
27084 (or (org-at-table-p) (org-region-active-p))]
27085 ["Which Column?" org-table-current-column (org-at-table-p)])
27086 ["Debug Formulas"
27087 org-table-toggle-formula-debugger
27088 :style toggle :selected org-table-formula-debug]
27089 ["Show Col/Row Numbers"
27090 org-table-toggle-coordinate-overlays
27091 :style toggle :selected org-table-overlay-coordinates]
27092 "--"
27093 ["Create" org-table-create (and (not (org-at-table-p))
27094 org-enable-table-editor)]
27095 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27096 ["Import from File" org-table-import (not (org-at-table-p))]
27097 ["Export to File" org-table-export (org-at-table-p)]
27098 "--"
27099 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27101 (easy-menu-define org-org-menu org-mode-map "Org menu"
27102 '("Org"
27103 ("Show/Hide"
27104 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27105 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27106 ["Sparse Tree" org-occur t]
27107 ["Reveal Context" org-reveal t]
27108 ["Show All" show-all t]
27109 "--"
27110 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27111 "--"
27112 ["New Heading" org-insert-heading t]
27113 ("Navigate Headings"
27114 ["Up" outline-up-heading t]
27115 ["Next" outline-next-visible-heading t]
27116 ["Previous" outline-previous-visible-heading t]
27117 ["Next Same Level" outline-forward-same-level t]
27118 ["Previous Same Level" outline-backward-same-level t]
27119 "--"
27120 ["Jump" org-goto t])
27121 ("Edit Structure"
27122 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27123 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27124 "--"
27125 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27126 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27127 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27128 "--"
27129 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27130 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27131 ["Demote Heading" org-metaright (not (org-at-table-p))]
27132 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27133 "--"
27134 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27135 "--"
27136 ["Convert to odd levels" org-convert-to-odd-levels t]
27137 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27138 ("Editing"
27139 ["Emphasis..." org-emphasize t])
27140 ("Archive"
27141 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27142 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27143 ; :active t :keys "C-u C-c C-x C-a"]
27144 ["Sparse trees open ARCHIVE trees"
27145 (setq org-sparse-tree-open-archived-trees
27146 (not org-sparse-tree-open-archived-trees))
27147 :style toggle :selected org-sparse-tree-open-archived-trees]
27148 ["Cycling opens ARCHIVE trees"
27149 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27150 :style toggle :selected org-cycle-open-archived-trees]
27151 ["Agenda includes ARCHIVE trees"
27152 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27153 :style toggle :selected (not org-agenda-skip-archived-trees)]
27154 "--"
27155 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27156 ; ["Check and Move Children" (org-archive-subtree '(4))
27157 ; :active t :keys "C-u C-c C-x C-s"]
27158 )
27159 "--"
27160 ("TODO Lists"
27161 ["TODO/DONE/-" org-todo t]
27162 ("Select keyword"
27163 ["Next keyword" org-shiftright (org-on-heading-p)]
27164 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27165 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27166 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27167 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27168 ["Show TODO Tree" org-show-todo-tree t]
27169 ["Global TODO list" org-todo-list t]
27170 "--"
27171 ["Set Priority" org-priority t]
27172 ["Priority Up" org-shiftup t]
27173 ["Priority Down" org-shiftdown t])
27174 ("TAGS and Properties"
27175 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27176 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27177 "--"
27178 ["Set property" 'org-set-property t]
27179 ["Column view of properties" org-columns t]
27180 ["Insert Column View DBlock" org-insert-columns-dblock t])
27181 ("Dates and Scheduling"
27182 ["Timestamp" org-time-stamp t]
27183 ["Timestamp (inactive)" org-time-stamp-inactive t]
27184 ("Change Date"
27185 ["1 Day Later" org-shiftright t]
27186 ["1 Day Earlier" org-shiftleft t]
27187 ["1 ... Later" org-shiftup t]
27188 ["1 ... Earlier" org-shiftdown t])
27189 ["Compute Time Range" org-evaluate-time-range t]
27190 ["Schedule Item" org-schedule t]
27191 ["Deadline" org-deadline t]
27192 "--"
27193 ["Custom time format" org-toggle-time-stamp-overlays
27194 :style radio :selected org-display-custom-times]
27195 "--"
27196 ["Goto Calendar" org-goto-calendar t]
27197 ["Date from Calendar" org-date-from-calendar t])
27198 ("Logging work"
27199 ["Clock in" org-clock-in t]
27200 ["Clock out" org-clock-out t]
27201 ["Clock cancel" org-clock-cancel t]
27202 ["Goto running clock" org-clock-goto t]
27203 ["Display times" org-clock-display t]
27204 ["Create clock table" org-clock-report t]
27205 "--"
27206 ["Record DONE time"
27207 (progn (setq org-log-done (not org-log-done))
27208 (message "Switching to %s will %s record a timestamp"
27209 (car org-done-keywords)
27210 (if org-log-done "automatically" "not")))
27211 :style toggle :selected org-log-done])
27212 "--"
27213 ["Agenda Command..." org-agenda t]
27214 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27215 ("File List for Agenda")
27216 ("Special views current file"
27217 ["TODO Tree" org-show-todo-tree t]
27218 ["Check Deadlines" org-check-deadlines t]
27219 ["Timeline" org-timeline t]
27220 ["Tags Tree" org-tags-sparse-tree t])
27221 "--"
27222 ("Hyperlinks"
27223 ["Store Link (Global)" org-store-link t]
27224 ["Insert Link" org-insert-link t]
27225 ["Follow Link" org-open-at-point t]
27226 "--"
27227 ["Next link" org-next-link t]
27228 ["Previous link" org-previous-link t]
27229 "--"
27230 ["Descriptive Links"
27231 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27232 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27233 ["Literal Links"
27234 (progn
27235 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27236 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27237 "--"
27238 ["Export/Publish..." org-export t]
27239 ("LaTeX"
27240 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27241 :selected org-cdlatex-mode]
27242 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27243 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27244 ["Modify math symbol" org-cdlatex-math-modify
27245 (org-inside-LaTeX-fragment-p)]
27246 ["Export LaTeX fragments as images"
27247 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27248 :style toggle :selected org-export-with-LaTeX-fragments])
27249 "--"
27250 ("Documentation"
27251 ["Show Version" org-version t]
27252 ["Info Documentation" org-info t])
27253 ("Customize"
27254 ["Browse Org Group" org-customize t]
27255 "--"
27256 ["Expand This Menu" org-create-customize-menu
27257 (fboundp 'customize-menu-create)])
27258 "--"
27259 ["Refresh setup" org-mode-restart t]
27260 ))
27262 (defun org-info (&optional node)
27263 "Read documentation for Org-mode in the info system.
27264 With optional NODE, go directly to that node."
27265 (interactive)
27266 (require 'info)
27267 (Info-goto-node (format "(org)%s" (or node ""))))
27269 (defun org-install-agenda-files-menu ()
27270 (let ((bl (buffer-list)))
27271 (save-excursion
27272 (while bl
27273 (set-buffer (pop bl))
27274 (if (org-mode-p) (setq bl nil)))
27275 (when (org-mode-p)
27276 (easy-menu-change
27277 '("Org") "File List for Agenda"
27278 (append
27279 (list
27280 ["Edit File List" (org-edit-agenda-file-list) t]
27281 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27282 ["Remove Current File from List" org-remove-file t]
27283 ["Cycle through agenda files" org-cycle-agenda-files t]
27284 ["Occur in all agenda files" org-occur-in-agenda-files t]
27285 "--")
27286 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27288 ;;;; Documentation
27290 (defun org-customize ()
27291 "Call the customize function with org as argument."
27292 (interactive)
27293 (customize-browse 'org))
27295 (defun org-create-customize-menu ()
27296 "Create a full customization menu for Org-mode, insert it into the menu."
27297 (interactive)
27298 (if (fboundp 'customize-menu-create)
27299 (progn
27300 (easy-menu-change
27301 '("Org") "Customize"
27302 `(["Browse Org group" org-customize t]
27303 "--"
27304 ,(customize-menu-create 'org)
27305 ["Set" Custom-set t]
27306 ["Save" Custom-save t]
27307 ["Reset to Current" Custom-reset-current t]
27308 ["Reset to Saved" Custom-reset-saved t]
27309 ["Reset to Standard Settings" Custom-reset-standard t]))
27311 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27313 ;;;; Miscellaneous stuff
27316 ;;; Generally useful functions
27318 (defun org-context ()
27319 "Return a list of contexts of the current cursor position.
27320 If several contexts apply, all are returned.
27321 Each context entry is a list with a symbol naming the context, and
27322 two positions indicating start and end of the context. Possible
27323 contexts are:
27325 :headline anywhere in a headline
27326 :headline-stars on the leading stars in a headline
27327 :todo-keyword on a TODO keyword (including DONE) in a headline
27328 :tags on the TAGS in a headline
27329 :priority on the priority cookie in a headline
27330 :item on the first line of a plain list item
27331 :item-bullet on the bullet/number of a plain list item
27332 :checkbox on the checkbox in a plain list item
27333 :table in an org-mode table
27334 :table-special on a special filed in a table
27335 :table-table in a table.el table
27336 :link on a hyperlink
27337 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27338 :target on a <<target>>
27339 :radio-target on a <<<radio-target>>>
27340 :latex-fragment on a LaTeX fragment
27341 :latex-preview on a LaTeX fragment with overlayed preview image
27343 This function expects the position to be visible because it uses font-lock
27344 faces as a help to recognize the following contexts: :table-special, :link,
27345 and :keyword."
27346 (let* ((f (get-text-property (point) 'face))
27347 (faces (if (listp f) f (list f)))
27348 (p (point)) clist o)
27349 ;; First the large context
27350 (cond
27351 ((org-on-heading-p t)
27352 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27353 (when (progn
27354 (beginning-of-line 1)
27355 (looking-at org-todo-line-tags-regexp))
27356 (push (org-point-in-group p 1 :headline-stars) clist)
27357 (push (org-point-in-group p 2 :todo-keyword) clist)
27358 (push (org-point-in-group p 4 :tags) clist))
27359 (goto-char p)
27362 (push (org-point-in-group p 0 :priority) clist)))
27364 ((org-at-item-p)
27365 (push (org-point-in-group p 2 :item-bullet) clist)
27366 (push (list :item (point-at-bol)
27367 (save-excursion (org-end-of-item) (point)))
27368 clist)
27369 (and (org-at-item-checkbox-p)
27370 (push (org-point-in-group p 0 :checkbox) clist)))
27372 ((org-at-table-p)
27373 (push (list :table (org-table-begin) (org-table-end)) clist)
27374 (if (memq 'org-formula faces)
27375 (push (list :table-special
27376 (previous-single-property-change p 'face)
27377 (next-single-property-change p 'face)) clist)))
27378 ((org-at-table-p 'any)
27379 (push (list :table-table) clist)))
27380 (goto-char p)
27382 ;; Now the small context
27383 (cond
27384 ((org-at-timestamp-p)
27385 (push (org-point-in-group p 0 :timestamp) clist))
27386 ((memq 'org-link faces)
27387 (push (list :link
27388 (previous-single-property-change p 'face)
27389 (next-single-property-change p 'face)) clist))
27390 ((memq 'org-special-keyword faces)
27391 (push (list :keyword
27392 (previous-single-property-change p 'face)
27393 (next-single-property-change p 'face)) clist))
27394 ((org-on-target-p)
27395 (push (org-point-in-group p 0 :target) clist)
27396 (goto-char (1- (match-beginning 0)))
27397 (if (looking-at org-radio-target-regexp)
27398 (push (org-point-in-group p 0 :radio-target) clist))
27399 (goto-char p))
27400 ((setq o (car (delq nil
27401 (mapcar
27402 (lambda (x)
27403 (if (memq x org-latex-fragment-image-overlays) x))
27404 (org-overlays-at (point))))))
27405 (push (list :latex-fragment
27406 (org-overlay-start o) (org-overlay-end o)) clist)
27407 (push (list :latex-preview
27408 (org-overlay-start o) (org-overlay-end o)) clist))
27409 ((org-inside-LaTeX-fragment-p)
27410 ;; FIXME: positions wrong.
27411 (push (list :latex-fragment (point) (point)) clist)))
27413 (setq clist (nreverse (delq nil clist)))
27414 clist))
27416 ;; FIXME: Compare with at-regexp-p Do we need both?
27417 (defun org-in-regexp (re &optional nlines visually)
27418 "Check if point is inside a match of regexp.
27419 Normally only the current line is checked, but you can include NLINES extra
27420 lines both before and after point into the search.
27421 If VISUALLY is set, require that the cursor is not after the match but
27422 really on, so that the block visually is on the match."
27423 (catch 'exit
27424 (let ((pos (point))
27425 (eol (point-at-eol (+ 1 (or nlines 0))))
27426 (inc (if visually 1 0)))
27427 (save-excursion
27428 (beginning-of-line (- 1 (or nlines 0)))
27429 (while (re-search-forward re eol t)
27430 (if (and (<= (match-beginning 0) pos)
27431 (>= (+ inc (match-end 0)) pos))
27432 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27434 (defun org-at-regexp-p (regexp)
27435 "Is point inside a match of REGEXP in the current line?"
27436 (catch 'exit
27437 (save-excursion
27438 (let ((pos (point)) (end (point-at-eol)))
27439 (beginning-of-line 1)
27440 (while (re-search-forward regexp end t)
27441 (if (and (<= (match-beginning 0) pos)
27442 (>= (match-end 0) pos))
27443 (throw 'exit t)))
27444 nil))))
27446 (defun org-occur-in-agenda-files (regexp &optional nlines)
27447 "Call `multi-occur' with buffers for all agenda files."
27449 (let* ((files (org-agenda-files))
27450 (tnames (mapcar 'file-truename files))
27451 (extra org-agenda-multi-occur-extra-files)
27452 f)
27453 (while (setq f (pop extra))
27454 (unless (member (file-truename f) tnames)
27455 (add-to-list 'files f 'append)
27456 (add-to-list 'tnames (file-truename f) 'append)))
27457 (multi-occur
27458 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27459 regexp)))
27461 (if (boundp 'occur-mode-find-occurrence-hook)
27462 ;; Emacs 23
27463 (add-hook 'occur-mode-find-occurrence-hook
27464 (lambda ()
27465 (when (org-mode-p)
27466 (org-reveal))))
27467 ;; Emacs 22
27468 (defadvice occur-mode-goto-occurrence
27469 (after org-occur-reveal activate)
27470 (and (org-mode-p) (org-reveal)))
27471 (defadvice occur-mode-goto-occurrence-other-window
27472 (after org-occur-reveal activate)
27473 (and (org-mode-p) (org-reveal)))
27474 (defadvice occur-mode-display-occurrence
27475 (after org-occur-reveal activate)
27476 (when (org-mode-p)
27477 (let ((pos (occur-mode-find-occurrence)))
27478 (with-current-buffer (marker-buffer pos)
27479 (save-excursion
27480 (goto-char pos)
27481 (org-reveal)))))))
27483 (defun org-uniquify (list)
27484 "Remove duplicate elements from LIST."
27485 (let (res)
27486 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27487 res))
27489 (defun org-delete-all (elts list)
27490 "Remove all elements in ELTS from LIST."
27491 (while elts
27492 (setq list (delete (pop elts) list)))
27493 list)
27495 (defun org-back-over-empty-lines ()
27496 "Move backwards over witespace, to the beginning of the first empty line.
27497 Returns the number o empty lines passed."
27498 (let ((pos (point)))
27500 (beginning-of-line 2)
27501 (goto-char (min (point) pos))
27502 (count-lines (point) pos)))
27504 (defun org-skip-whitespace ()
27507 (defun org-point-in-group (point group &optional context)
27508 "Check if POINT is in match-group GROUP.
27509 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27510 match. If the match group does ot exist or point is not inside it,
27511 return nil."
27512 (and (match-beginning group)
27513 (>= point (match-beginning group))
27514 (<= point (match-end group))
27515 (if context
27516 (list context (match-beginning group) (match-end group))
27517 t)))
27519 (defun org-switch-to-buffer-other-window (&rest args)
27520 "Switch to buffer in a second window on the current frame.
27521 In particular, do not allow pop-up frames."
27522 (let (pop-up-frames special-display-buffer-names special-display-regexps
27523 special-display-function)
27524 (apply 'switch-to-buffer-other-window args)))
27526 (defun org-combine-plists (&rest plists)
27527 "Create a single property list from all plists in PLISTS.
27528 The process starts by copying the first list, and then setting properties
27529 from the other lists. Settings in the last list are the most significant
27530 ones and overrule settings in the other lists."
27531 (let ((rtn (copy-sequence (pop plists)))
27532 p v ls)
27533 (while plists
27534 (setq ls (pop plists))
27535 (while ls
27536 (setq p (pop ls) v (pop ls))
27537 (setq rtn (plist-put rtn p v))))
27538 rtn))
27540 (defun org-move-line-down (arg)
27541 "Move the current line down. With prefix argument, move it past ARG lines."
27542 (interactive "p")
27543 (let ((col (current-column))
27544 beg end pos)
27545 (beginning-of-line 1) (setq beg (point))
27546 (beginning-of-line 2) (setq end (point))
27547 (beginning-of-line (+ 1 arg))
27548 (setq pos (move-marker (make-marker) (point)))
27549 (insert (delete-and-extract-region beg end))
27550 (goto-char pos)
27551 (move-to-column col)))
27553 (defun org-move-line-up (arg)
27554 "Move the current line up. With prefix argument, move it past ARG lines."
27555 (interactive "p")
27556 (let ((col (current-column))
27557 beg end pos)
27558 (beginning-of-line 1) (setq beg (point))
27559 (beginning-of-line 2) (setq end (point))
27560 (beginning-of-line (- arg))
27561 (setq pos (move-marker (make-marker) (point)))
27562 (insert (delete-and-extract-region beg end))
27563 (goto-char pos)
27564 (move-to-column col)))
27566 (defun org-replace-escapes (string table)
27567 "Replace %-escapes in STRING with values in TABLE.
27569 The sequences in STRING may contain normal field width and padding information,
27571 so values can contain further %-escapes if they are define later in TABLE."
27572 (let ((case-fold-search nil)
27573 e re rpl)
27574 (while (setq e (pop table))
27575 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27576 (while (string-match re string)
27577 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27578 (cdr e)))
27579 (setq string (replace-match rpl t t string))))
27580 string))
27583 (defun org-sublist (list start end)
27584 "Return a section of LIST, from START to END.
27585 Counting starts at 1."
27586 (let (rtn (c start))
27587 (setq list (nthcdr (1- start) list))
27588 (while (and list (<= c end))
27589 (push (pop list) rtn)
27590 (setq c (1+ c)))
27591 (nreverse rtn)))
27593 (defun org-find-base-buffer-visiting (file)
27594 "Like `find-buffer-visiting' but alway return the base buffer and
27595 not an indirect buffer"
27596 (let ((buf (find-buffer-visiting file)))
27597 (if buf
27598 (or (buffer-base-buffer buf) buf)
27599 nil)))
27601 (defun org-image-file-name-regexp ()
27602 "Return regexp matching the file names of images."
27603 (if (fboundp 'image-file-name-regexp)
27604 (image-file-name-regexp)
27605 (let ((image-file-name-extensions
27606 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27607 "xbm" "xpm" "pbm" "pgm" "ppm")))
27609 (regexp-opt (nconc (mapcar 'upcase
27610 image-file-name-extensions)
27611 image-file-name-extensions)
27612 t)
27615 (defun org-file-image-p (file)
27616 "Return non-nil if FILE is an image."
27617 (save-match-data
27618 (string-match (org-image-file-name-regexp) file)))
27620 ;;; Paragraph filling stuff.
27621 ;; We want this to be just right, so use the full arsenal.
27623 (defun org-indent-line-function ()
27624 "Indent line like previous, but further if previous was headline or item."
27625 (interactive)
27626 (let* ((pos (point))
27627 (itemp (org-at-item-p))
27628 column bpos bcol tpos tcol bullet btype bullet-type)
27629 ;; Find the previous relevant line
27630 (beginning-of-line 1)
27631 (cond
27632 ((looking-at "#") (setq column 0))
27634 (t
27635 (beginning-of-line 0)
27637 (beginning-of-line 0))
27638 (cond
27640 (goto-char (match-end 0))
27641 (setq column (current-column)))
27642 ((org-in-item-p)
27643 (org-beginning-of-item)
27646 (setq bpos (match-beginning 1) tpos (match-end 0)
27647 bcol (progn (goto-char bpos) (current-column))
27648 tcol (progn (goto-char tpos) (current-column))
27649 bullet (match-string 1)
27650 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27651 (if (not itemp)
27652 (setq column tcol)
27653 (goto-char pos)
27654 (beginning-of-line 1)
27656 (progn
27658 (setq bullet (match-string 1)
27659 btype (if (string-match "[0-9]" bullet) "n" bullet))
27660 (setq column (if (equal btype bullet-type) bcol tcol)))
27661 (setq column (org-get-indentation)))))
27662 (t (setq column (org-get-indentation))))))
27663 (goto-char pos)
27664 (if (<= (current-column) (current-indentation))
27665 (indent-line-to column)
27666 (save-excursion (indent-line-to column)))
27667 (setq column (current-column))
27668 (beginning-of-line 1)
27669 (if (looking-at
27672 (match-string 2) (match-string 3)))
27673 t nil))
27674 (move-to-column column)))
27676 (defun org-set-autofill-regexps ()
27677 (interactive)
27678 ;; In the paragraph separator we include headlines, because filling
27679 ;; text in a line directly attached to a headline would otherwise
27680 ;; fill the headline as well.
27683 ;; The paragraph starter includes hand-formatted lists.
27684 (org-set-local 'paragraph-start
27686 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27687 ;; But only if the user has not turned off tables or fixed-width regions
27688 (org-set-local
27689 'auto-fill-inhibit-regexp
27692 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27693 (concat
27695 (if org-enable-table-editor "|" "")
27696 (if org-enable-fixed-width-editor ":" "")
27697 "]"))))
27698 ;; We use our own fill-paragraph function, to make sure that tables
27699 ;; and fixed-width regions are not wrapped. That function will pass
27700 ;; through to `fill-paragraph' when appropriate.
27701 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27702 ; Adaptive filling: To get full control, first make sure that
27703 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27705 (org-set-local 'adaptive-fill-function
27706 'org-adaptive-fill-function)
27707 (org-set-local
27708 'align-mode-rules-list
27709 '((org-in-buffer-settings
27711 (modes . '(org-mode))))))
27713 (defun org-fill-paragraph (&optional justify)
27714 "Re-align a table, pass through to fill-paragraph if no table."
27715 (let ((table-p (org-at-table-p))
27716 (table.el-p (org-at-table.el-p)))
27717 (cond ((and (equal (char-after (point-at-bol)) ?*)
27718 (save-excursion (goto-char (point-at-bol))
27719 (looking-at outline-regexp)))
27720 t) ; skip headlines
27721 (table.el-p t) ; skip table.el tables
27722 (table-p (org-table-align) t) ; align org-mode tables
27723 (t nil)))) ; call paragraph-fill
27725 ;; For reference, this is the default value of adaptive-fill-regexp
27728 (defun org-adaptive-fill-function ()
27729 "Return a fill prefix for org-mode files.
27730 In particular, this makes sure hanging paragraphs for hand-formatted lists
27731 work correctly."
27733 (match-string 0))
27735 (save-excursion
27736 (goto-char (match-end 0))
27737 (make-string (current-column) ?\ )))
27738 (t nil)))
27740 ;;;; Functions extending outline functionality
27743 (defun org-beginning-of-line (&optional arg)
27744 "Go to the beginning of the current line. If that is invisible, continue
27745 to a visible line beginning. This makes the function of C-a more intuitive.
27746 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27747 first attempt, and only move to after the tags when the cursor is already
27748 beyond the end of the headline."
27749 (interactive "P")
27750 (let ((pos (point)))
27751 (beginning-of-line 1)
27752 (if (bobp)
27753 nil
27754 (backward-char 1)
27755 (if (org-invisible-p)
27756 (while (and (not (bobp)) (org-invisible-p))
27757 (backward-char 1)
27758 (beginning-of-line 1))
27759 (forward-char 1)))
27760 (when org-special-ctrl-a/e
27761 (cond
27762 ((and (looking-at org-todo-line-regexp)
27763 (= (char-after (match-end 1)) ?\ ))
27764 (goto-char
27765 (if (eq org-special-ctrl-a/e t)
27766 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27767 ((= pos (point)) (match-beginning 3))
27768 (t (point)))
27769 (cond ((> pos (point)) (point))
27770 ((not (eq last-command this-command)) (point))
27771 (t (match-beginning 3))))))
27772 ((org-at-item-p)
27773 (goto-char
27774 (if (eq org-special-ctrl-a/e t)
27775 (cond ((> pos (match-end 4)) (match-end 4))
27776 ((= pos (point)) (match-end 4))
27777 (t (point)))
27778 (cond ((> pos (point)) (point))
27779 ((not (eq last-command this-command)) (point))
27780 (t (match-end 4))))))))))
27782 (defun org-end-of-line (&optional arg)
27783 "Go to the end of the line.
27784 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27785 first attempt, and only move to after the tags when the cursor is already
27786 beyond the end of the headline."
27787 (interactive "P")
27788 (if (or (not org-special-ctrl-a/e)
27789 (not (org-on-heading-p)))
27790 (end-of-line arg)
27791 (let ((pos (point)))
27792 (beginning-of-line 1)
27794 (if (eq org-special-ctrl-a/e t)
27795 (if (or (< pos (match-beginning 1))
27796 (= pos (match-end 0)))
27797 (goto-char (match-beginning 1))
27798 (goto-char (match-end 0)))
27799 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27800 (goto-char (match-end 0))
27801 (goto-char (match-beginning 1))))
27802 (end-of-line arg)))))
27804 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27805 (define-key org-mode-map "\C-e" 'org-end-of-line)
27807 (defun org-kill-line (&optional arg)
27808 "Kill line, to tags or end of line."
27809 (interactive "P")
27810 (cond
27811 ((or (not org-special-ctrl-k)
27812 (bolp)
27813 (not (org-on-heading-p)))
27814 (call-interactively 'kill-line))
27816 (kill-region (point) (match-beginning 1))
27817 (org-set-tags nil t))
27818 (t (kill-region (point) (point-at-eol)))))
27820 (define-key org-mode-map "\C-k" 'org-kill-line)
27822 (defun org-invisible-p ()
27823 "Check if point is at a character currently not visible."
27824 ;; Early versions of noutline don't have `outline-invisible-p'.
27825 (if (fboundp 'outline-invisible-p)
27826 (outline-invisible-p)
27827 (get-char-property (point) 'invisible)))
27829 (defun org-invisible-p2 ()
27830 "Check if point is at a character currently not visible."
27831 (save-excursion
27832 (if (and (eolp) (not (bobp))) (backward-char 1))
27833 ;; Early versions of noutline don't have `outline-invisible-p'.
27834 (if (fboundp 'outline-invisible-p)
27835 (outline-invisible-p)
27836 (get-char-property (point) 'invisible))))
27838 (defalias 'org-back-to-heading 'outline-back-to-heading)
27839 (defalias 'org-on-heading-p 'outline-on-heading-p)
27840 (defalias 'org-at-heading-p 'outline-on-heading-p)
27841 (defun org-at-heading-or-item-p ()
27842 (or (org-on-heading-p) (org-at-item-p)))
27844 (defun org-on-target-p ()
27845 (or (org-in-regexp org-radio-target-regexp)
27846 (org-in-regexp org-target-regexp)))
27848 (defun org-up-heading-all (arg)
27849 "Move to the heading line of which the present line is a subheading.
27850 This function considers both visible and invisible heading lines.
27851 With argument, move up ARG levels."
27852 (if (fboundp 'outline-up-heading-all)
27853 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27854 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27856 (defun org-up-heading-safe ()
27857 "Move to the heading line of which the present line is a subheading.
27858 This version will not throw an error. It will return the level of the
27859 headline found, or nil if no higher level is found."
27860 (let ((pos (point)) start-level level
27861 (re (concat "^" outline-regexp)))
27862 (catch 'exit
27863 (outline-back-to-heading t)
27864 (setq start-level (funcall outline-level))
27865 (if (equal start-level 1) (throw 'exit nil))
27866 (while (re-search-backward re nil t)
27867 (setq level (funcall outline-level))
27868 (if (< level start-level) (throw 'exit level)))
27869 nil)))
27871 (defun org-first-sibling-p ()
27872 "Is this heading the first child of its parents?"
27873 (interactive)
27874 (let ((re (concat "^" outline-regexp))
27875 level l)
27876 (unless (org-at-heading-p t)
27877 (error "Not at a heading"))
27878 (setq level (funcall outline-level))
27879 (save-excursion
27880 (if (not (re-search-backward re nil t))
27881 t
27882 (setq l (funcall outline-level))
27883 (< l level)))))
27885 (defun org-goto-sibling (&optional previous)
27886 "Goto the next sibling, even if it is invisible.
27887 When PREVIOUS is set, go to the previous sibling instead. Returns t
27888 when a sibling was found. When none is found, return nil and don't
27889 move point."
27890 (let ((fun (if previous 're-search-backward 're-search-forward))
27891 (pos (point))
27892 (re (concat "^" outline-regexp))
27893 level l)
27894 (when (condition-case nil (org-back-to-heading t) (error nil))
27895 (setq level (funcall outline-level))
27896 (catch 'exit
27897 (or previous (forward-char 1))
27898 (while (funcall fun re nil t)
27899 (setq l (funcall outline-level))
27900 (when (< l level) (goto-char pos) (throw 'exit nil))
27901 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27902 (goto-char pos)
27903 nil))))
27905 (defun org-show-siblings ()
27906 "Show all siblings of the current headline."
27907 (save-excursion
27908 (while (org-goto-sibling) (org-flag-heading nil)))
27909 (save-excursion
27910 (while (org-goto-sibling 'previous)
27911 (org-flag-heading nil))))
27913 (defun org-show-hidden-entry ()
27914 "Show an entry where even the heading is hidden."
27915 (save-excursion
27916 (org-show-entry)))
27918 (defun org-flag-heading (flag &optional entry)
27919 "Flag the current heading. FLAG non-nil means make invisible.
27920 When ENTRY is non-nil, show the entire entry."
27921 (save-excursion
27922 (org-back-to-heading t)
27923 ;; Check if we should show the entire entry
27924 (if entry
27925 (progn
27926 (org-show-entry)
27927 (save-excursion
27928 (and (outline-next-heading)
27929 (org-flag-heading nil))))
27930 (outline-flag-region (max (point-min) (1- (point)))
27931 (save-excursion (outline-end-of-heading) (point))
27932 flag))))
27934 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27935 ;; This is an exact copy of the original function, but it uses
27936 ;; `org-back-to-heading', to make it work also in invisible
27937 ;; trees. And is uses an invisible-OK argument.
27938 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
27939 (org-back-to-heading invisible-OK)
27940 (let ((first t)
27941 (level (funcall outline-level)))
27942 (while (and (not (eobp))
27943 (or first (> (funcall outline-level) level)))
27944 (setq first nil)
27945 (outline-next-heading))
27946 (unless to-heading
27948 (progn
27949 ;; Go to end of line before heading
27950 (forward-char -1)
27952 ;; leave blank line before heading
27953 (forward-char -1))))))
27954 (point))
27956 (defun org-show-subtree ()
27957 "Show everything after this heading at deeper levels."
27958 (outline-flag-region
27959 (point)
27960 (save-excursion
27961 (outline-end-of-subtree) (outline-next-heading) (point))
27962 nil))
27964 (defun org-show-entry ()
27965 "Show the body directly following this heading.
27966 Show the heading too, if it is currently invisible."
27967 (interactive)
27968 (save-excursion
27969 (condition-case nil
27970 (progn
27971 (org-back-to-heading t)
27972 (outline-flag-region
27973 (max (point-min) (1- (point)))
27974 (save-excursion
27975 (re-search-forward
27977 (or (match-beginning 1) (point-max)))
27978 nil))
27979 (error nil))))
27981 (defun org-make-options-regexp (kwds)
27982 "Make a regular expression for keyword lines."
27983 (concat
27984 "^"
27990 ;; Make isearch reveal the necessary context
27991 (defun org-isearch-end ()
27992 "Reveal context after isearch exits."
27993 (when isearch-success ; only if search was successful
27994 (if (featurep 'xemacs)
27995 ;; Under XEmacs, the hook is run in the correct place,
27996 ;; we directly show the context.
27997 (org-show-context 'isearch)
27998 ;; In Emacs the hook runs *before* restoring the overlays.
27999 ;; So we have to use a one-time post-command-hook to do this.
28000 ;; (Emacs 22 has a special variable, see function `org-mode')
28001 (unless (and (boundp 'isearch-mode-end-hook-quit)
28002 isearch-mode-end-hook-quit)
28003 ;; Only when the isearch was not quitted.
28004 (org-add-hook 'post-command-hook 'org-isearch-post-command
28005 'append 'local)))))
28007 (defun org-isearch-post-command ()
28008 "Remove self from hook, and show context."
28009 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28010 (org-show-context 'isearch))
28013 ;;;; Integration with and fixes for other packages
28015 ;;; Imenu support
28017 (defvar org-imenu-markers nil
28018 "All markers currently used by Imenu.")
28019 (make-variable-buffer-local 'org-imenu-markers)
28021 (defun org-imenu-new-marker (&optional pos)
28022 "Return a new marker for use by Imenu, and remember the marker."
28023 (let ((m (make-marker)))
28024 (move-marker m (or pos (point)))
28025 (push m org-imenu-markers)
28026 m))
28028 (defun org-imenu-get-tree ()
28029 "Produce the index for Imenu."
28030 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28031 (setq org-imenu-markers nil)
28032 (let* ((n org-imenu-depth)
28033 (re (concat "^" outline-regexp))
28034 (subs (make-vector (1+ n) nil))
28035 (last-level 0)
28036 m tree level head)
28037 (save-excursion
28038 (save-restriction
28039 (widen)
28040 (goto-char (point-max))
28041 (while (re-search-backward re nil t)
28042 (setq level (org-reduced-level (funcall outline-level)))
28043 (when (<= level n)
28044 (looking-at org-complex-heading-regexp)
28045 (setq head (org-match-string-no-properties 4)
28046 m (org-imenu-new-marker))
28047 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28048 (if (>= level last-level)
28049 (push (cons head m) (aref subs level))
28050 (push (cons head (aref subs (1+ level))) (aref subs level))
28051 (loop for i from (1+ level) to n do (aset subs i nil)))
28052 (setq last-level level)))))
28053 (aref subs 1)))
28055 (eval-after-load "imenu"
28056 '(progn
28057 (add-hook 'imenu-after-jump-hook
28058 (lambda () (org-show-context 'org-goto)))))
28060 ;; Speedbar support
28062 (defun org-speedbar-set-agenda-restriction ()
28063 "Restrict future agenda commands to the location at point in speedbar.
28065 (interactive)
28066 (let (p m tp np dir txt w)
28067 (cond
28068 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28069 'org-imenu t))
28070 (setq m (get-text-property p 'org-imenu-marker))
28071 (save-excursion
28072 (save-restriction
28073 (set-buffer (marker-buffer m))
28074 (goto-char m)
28075 (org-agenda-set-restriction-lock 'subtree))))
28076 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28077 'speedbar-function 'speedbar-find-file))
28078 (setq tp (previous-single-property-change
28079 (1+ p) 'speedbar-function)
28080 np (next-single-property-change
28081 tp 'speedbar-function)
28082 dir (speedbar-line-directory)
28083 txt (buffer-substring-no-properties (or tp (point-min))
28084 (or np (point-max))))
28085 (save-excursion
28086 (save-restriction
28087 (set-buffer (find-file-noselect
28088 (let ((default-directory dir))
28089 (expand-file-name txt))))
28090 (unless (org-mode-p)
28091 (error "Cannot restrict to non-Org-mode file"))
28092 (org-agenda-set-restriction-lock 'file))))
28093 (t (error "Don't know how to restrict Org-mode's agenda")))
28094 (org-move-overlay org-speedbar-restriction-lock-overlay
28095 (point-at-bol) (point-at-eol))
28096 (setq current-prefix-arg nil)
28097 (org-agenda-maybe-redo)))
28099 (eval-after-load "speedbar"
28100 '(progn
28101 (speedbar-add-supported-extension ".org")
28102 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28103 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28104 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28105 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28106 (add-hook 'speedbar-visiting-tag-hook
28107 (lambda () (org-show-context 'org-goto)))))
28110 ;;; Fixes and Hacks
28112 ;; Make flyspell not check words in links, to not mess up our keymap
28113 (defun org-mode-flyspell-verify ()
28114 "Don't let flyspell put overlays at active buttons."
28115 (not (get-text-property (point) 'keymap)))
28117 ;; Make `bookmark-jump' show the jump location if it was hidden.
28118 (eval-after-load "bookmark"
28119 '(if (boundp 'bookmark-after-jump-hook)
28120 ;; We can use the hook
28121 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28122 ;; Hook not available, use advice
28123 (defadvice bookmark-jump (after org-make-visible activate)
28124 "Make the position visible."
28125 (org-bookmark-jump-unhide))))
28127 (defun org-bookmark-jump-unhide ()
28128 "Unhide the current position, to show the bookmark location."
28129 (and (org-mode-p)
28130 (or (org-invisible-p)
28131 (save-excursion (goto-char (max (point-min) (1- (point))))
28132 (org-invisible-p)))
28133 (org-show-context 'bookmark-jump)))
28135 ;; Fix a bug in htmlize where there are text properties (face nil)
28136 (eval-after-load "htmlize"
28137 '(progn
28138 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28139 "Make sure there are no nil faces"
28140 (setq ad-return-value (delq nil ad-return-value)))))
28142 ;; Make session.el ignore our circular variable
28143 (eval-after-load "session"
28144 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28146 ;;;; Experimental code
28148 (defun org-closed-in-range ()
28149 "Sparse tree of items closed in a certain time range.
28150 Still experimental, may disappear in the future."
28151 (interactive)
28152 ;; Get the time interval from the user.
28153 (let* ((time1 (time-to-seconds
28154 (org-read-date nil 'to-time nil "Starting date: ")))
28155 (time2 (time-to-seconds
28156 (org-read-date nil 'to-time nil "End date:")))
28157 ;; callback function
28158 (callback (lambda ()
28159 (let ((time
28160 (time-to-seconds
28161 (apply 'encode-time
28162 (org-parse-time-string
28163 (match-string 1))))))
28164 ;; check if time in interval
28165 (and (>= time time1) (<= time time2))))))
28166 ;; make tree, check each match with the callback
28169 ;;;; Finish up
28171 (provide 'org)
28173 (run-hooks 'org-load-hook)
28175 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28176 ;;; org.el ends here