| blob | d42b1b2dddb5d1cafc2a31e4445bf7eb1be3711c |
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.20a
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 when remember is called with C-u.
1508 If %i is indented, the entire inserted text will be indented
1509 as well.
1510 %c content of the clipboard, or current kill ring head
1511 %^g prompt for tags, with completion on tags in target file
1512 %^G prompt for tags, with completion all tags in all agenda files
1513 %:keyword specific information for certain link types, see below
1514 %[pathname] insert the contents of the file given by `pathname'
1515 %(sexp) evaluate elisp `(sexp)' and replace with the result
1516 %! Store this note immediately after filling the template
1518 %? After completing the template, position cursor here.
1520 Apart from these general escapes, you can access information specific to the
1521 link type that is created. For example, calling `remember' in emails or gnus
1522 will record the author and the subject of the message, which you can access
1523 with %:author and %:subject, respectively. Here is a complete list of what
1524 is recorded for each link type.
1526 Link type | Available information
1527 -------------------+------------------------------------------------------
1528 bbdb | %:type %:name %:company
1529 vm, wl, mh, rmail | %:type %:subject %:message-id
1530 | %:from %:fromname %:fromaddress
1531 | %:to %:toname %:toaddress
1533 gnus | %:group, for messages also all email fields
1534 w3, w3m | %:type %:url
1535 info | %:type %:file %:node
1536 calendar | %:type %:date"
1559 "Non-nil means, store new notes at the beginning of a file or entry.
1560 When nil, new notes will be filed to the end of a file or entry.
1561 This can also be a list with cons cells of regular expressions that
1562 are matched against file names, and values."
1572 This is list of cons cells. Each cell contains:
1573 - a specification of the files to be considered, either a list of files,
1574 or a symbol whose function or value fields will be used to retrieve
1575 a file name or a list of file names. Nil means, refile to a different
1576 heading in the current buffer.
1577 - A specification of how to find candidate refile targets. This may be
1578 any of
1580 This tag has to be present in all target headlines, inheritance will
1581 not be considered.
1583 todo keyword.
1585 headlines that are refiling targets.
1586 - a cons cell (:level . N). Any headline of level N is considered a target.
1587 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1588 ;; FIXME: what if there are a var and func with same name???
1604 "Non-nil means, provide refile targets as paths.
1605 So a level 3 headline will be available as level1/level2/level3.
1606 When the value is `file', also include the file name (without directory)
1607 into the path. When `full-file-path', include the full file path."
1616 "Options concerning TODO items in Org-mode."
1621 "Options concerning Progress logging in Org-mode."
1626 "List of TODO entry keyword sequences and their interpretation.
1629 Each sequence starts with a symbol, either `sequence' or `type',
1630 indicating if the keywords should be interpreted as a sequence of
1631 action steps, or as different types of TODO items. The first
1632 keywords are states requiring action - these states will select a headline
1633 for inclusion into the global TODO list Org-mode produces. If one of
1636 the last keyword is treated as the only DONE state of the sequence.
1639 additional state where no keyword is present. For details about this
1640 cycling, see the manual.
1642 TODO keywords and interpretation can also be set on a per-file basis with
1643 the special #+SEQ_TODO and #+TYP_TODO lines.
1645 For backward compatibility, this variable may also be just a list
1646 of keywords - in this case the interptetation (sequence or type) will be
1647 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1684 "Controls how TODO keywords are interpreted.
1685 This variable is in principle obsolete and is only used for
1686 backward compatibility, if the interpretation of todo keywords is
1687 not given already in `org-todo-keywords'. See that variable for
1688 more information."
1695 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1696 This variable describes if and under what circumstances the cycling
1697 mechanism for TODO keywords will be replaced by a single-key, direct
1698 selection scheme.
1700 When nil, fast selection is never used.
1702 When the symbol `prefix', it will be used when `org-todo' is called with
1703 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1704 in an agenda buffer.
1706 When t, fast selection is used by default. In this case, the prefix
1707 argument forces cycling instead.
1709 In all cases, the special interface is only used if access keys have actually
1710 been assigned by the user, i.e. if keywords in the configuration are followed
1711 by a letter in parenthesis, like TODO(t)."
1719 "Hook which is run after the state of a TODO item was changed.
1720 The new state (a string with a TODO keyword, or nil) is available in the
1721 Lisp variable `state'."
1726 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1727 When the state of an entry is changed from nothing or a DONE state to
1728 a not-done TODO state, remove a previous closing date.
1730 This can also be a list of symbols indicating under which conditions
1731 the time stamp recording the action should be annotated with a short note.
1732 Valid members of this list are
1734 done Offer to record a note when marking entries done
1735 state Offer to record a note whenever changing the TODO state
1736 of an item. This is only relevant if TODO keywords are
1737 interpreted as sequence, see variable `org-todo-interpretation'.
1738 When `state' is set, this includes tracking `done'.
1739 clock-out Offer to record a note when clocking out of an item.
1741 A separate window will then pop up and allow you to type a note.
1742 After finishing with C-c C-c, the note will be added directly after the
1743 timestamp, as a plain list item. See also the variable
1744 `org-log-note-headings'.
1746 Logging can also be configured on a per-file basis by adding one of
1747 the following lines anywhere in the buffer:
1749 #+STARTUP: logdone
1750 #+STARTUP: nologging
1751 #+STARTUP: lognotedone
1752 #+STARTUP: lognotestate
1753 #+STARTUP: lognoteclock-out
1755 You can have local logging settings for a subtree by setting the LOGGING
1756 property to one or more of these keywords."
1768 "Non-nil means, the CLOSED time stamp will contain date and time.
1769 When nil, only the date will be recorded."
1777 "Headings for notes added when clocking out or closing TODO items.
1778 The value is an alist, with the car being a symbol indicating the note
1779 context, and the cdr is the heading to be used. The heading may also be the
1780 empty string.
1781 %t in the heading will be replaced by a time stamp.
1782 %s will be replaced by the new TODO state, in double quotes.
1783 %u will be replaced by the user name.
1784 %U will be replaced by the full user name."
1790 "Heading when changing todo state (todo sequence only)"
1795 "Non-nil means, the latest state change note will be directly after heading.
1796 When nil, the notes will be orderer according to time."
1802 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1803 When nil, no note will be taken.
1804 This option can also be set with on a per-file-basis with
1806 #+STARTUP: logrepeat
1807 #+STARTUP: nologrepeat
1809 You can have local logging settings for a subtree by setting the LOGGING
1810 property to one or more of these keywords."
1816 "Should clocking info be wrapped into a drawer?
1817 When t, clocking info will always be inserted into a :CLOCK: drawer.
1818 If necessary, the drawer will be created.
1819 When nil, the drawer will not be created, but used when present.
1820 When an integer and the number of clocking entries in an item
1821 reaches or exceeds this number, a drawer will be created."
1830 "When t, the clock will be stopped when the relevant entry is marked DONE.
1831 Nil means, clock will keep running until stopped explicitly with
1832 `C-c C-x C-o', or until the clock is started in a different item."
1837 "Set task to a special todo state while clocking it.
1838 The value should be the state to which the entry should be switched."
1846 "Priorities in Org-mode."
1851 "The highest priority of TODO items. A character like ?A, ?B etc.
1852 Must have a smaller ASCII number than `org-lowest-priority'."
1857 "The lowest priority of TODO items. A character like ?A, ?B etc.
1858 Must have a larger ASCII number than `org-highest-priority'."
1863 "The default priority of TODO items.
1864 This is the priority an item get if no explicit priority is given."
1869 "Non-nil means, start with default priority when starting to cycle.
1870 When this is nil, the first step in the cycle will be (depending on the
1871 command used) one higher or lower that the default priority."
1876 "Options concerning time stamps and deadlines in Org-mode."
1881 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1882 When nil, these labeled time stamps are forces into the second line of an
1883 entry, just after the headline. When scheduling from the global TODO list,
1884 the time stamp will always be forced into the second line."
1889 "Formats for `format-time-string' which are used for time stamps.
1893 "Number of minutes to round time stamps to upon insertion.
1894 When zero, insert the time unmodified. Useful rounding numbers
1895 should be factors of 60, so for example 5, 10, 15.
1896 When this is not zero, you can still force an exact time-stamp by using
1897 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1902 "Non-nil means, overlay custom formats over all time stamps.
1903 The formats are defined through the variable `org-time-stamp-custom-formats'.
1904 To turn this on on a per-file basis, insert anywhere in the file:
1905 #+STARTUP: customtime"
1913 "Custom formats for time stamps. See `format-time-string' for the syntax.
1914 These are overlayed over the default ISO format if the variable
1915 `org-display-custom-times' is set. Time like %H:%M should be at the
1916 end of the second format."
1921 "Get the right format for a time string."
1926 f)))
1929 "Non-nil means, assume future for incomplete date input from user.
1930 This affects the following situations:
1931 1. The user gives a day, but no month.
1934 it will be considered as *this* month.
1935 2. The user gives a month but not a year.
1939 When this option is nil, the current month and year will always be used
1940 as defaults."
1945 "Non-nil means, display current interpretation of date prompt live.
1946 This display will be in an overlay, in the minibuffer."
1951 "Non-nil means, pop up a calendar when prompting for a date.
1952 In the calendar, the date can be selected with mouse-1. However, the
1953 minibuffer will also be active, and you can simply enter the date as well.
1954 When nil, only the minibuffer will be available."
1962 "The hour when your day really ends.
1963 This has influence for the following applications:
1965 the time given here, the day recognized as TODAY is actually yesterday.
1966 - When a date is read from the user and it is still before the time given
1967 here, the current date and time will be assumed to be yesterday, 23:59.
1969 FIXME:
1970 IMPORTANT: This is still a very experimental feature, it may disappear
1971 again or it may be extended to mean more things."
1976 "Non-nil means, S-down will increase the time in a time stamp.
1977 When nil, S-up will increase."
1982 "Non-nil means, make the calendar window follow timestamp changes.
1983 When a timestamp is modified and the calendar window is visible, it will be
1984 moved to the new date."
1989 "When non-nil, should be a function to create `org-clock-heading'.
1990 This is the string shown in the mode line when a clock is running.
1991 The function is called with point at the beginning of the headline."
1996 "Options concerning tags in Org-mode."
2001 "List of tags allowed in Org-mode files.
2002 When this list is nil, Org-mode will base TAG input on what is already in the
2003 buffer.
2004 The value of this variable is an alist, the car of each entry must be a
2005 keyword as a string, the cdr may be a character that is used to select
2006 that tag through the fast-tag-selection interface.
2007 See the manual for details."
2017 "Non-nil means, use fast tag selection scheme.
2018 This is a special interface to select and deselect tags with single keys.
2019 When nil, fast selection is never used.
2020 When the symbol `auto', fast selection is used if and only if selection
2021 characters for tags have been configured, either through the variable
2022 `org-tag-alist' or through a #+TAGS line in the buffer.
2023 When t, fast selection is always used and selection keys are assigned
2024 automatically if necessary."
2032 "Non-nil means, fast tag selection exits after first change.
2033 When nil, you have to press RET to exit it.
2034 During fast tag selection, you can toggle this flag with `C-c'.
2035 This variable can also have the value `expert'. In this case, the window
2036 displaying the tags menu is not even shown, until you press C-c again."
2044 "Non-nil means, fast tags selection interface will also offer TODO states.
2048 "The column to which tags should be indented in a headline.
2049 If this number is positive, it specifies the column. If it is negative,
2050 it means that the tags should be flushright to that column. For example,
2051 -80 works well for a normal 80 character screen."
2056 "Non-nil means, realign tags after pro/demotion of TODO state change.
2057 These operations change the length of a headline and therefore shift
2058 the tags around. With this options turned on, after each such operation
2059 the tags are again aligned to `org-tags-column'."
2064 "Non-nil means, tags in levels apply also for sublevels.
2065 When nil, only the tags directly given in a specific line apply there.
2066 If you turn off this option, you very likely want to turn on the
2067 companion option `org-tags-match-list-sublevels'."
2072 "Non-nil means list also sublevels of headlines matching tag search.
2073 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2074 the sublevels of a headline matching a tag search often also match
2075 the same search. Listing all of them can create very long lists.
2076 Setting this variable to nil causes subtrees of a match to be skipped.
2077 This option is off by default, because inheritance in on. If you turn
2078 inheritance off, you very likely want to turn this option on.
2080 As a special case, if the tag search is restricted to TODO items, the
2081 value of this variable is ignored and sublevels are always checked, to
2082 make sure all corresponding TODO items find their way into the list."
2094 "Options concerning properties in Org-mode."
2099 "How property key/value pairs should be formatted by `indent-line'.
2100 When `indent-line' hits a property definition, it will format the line
2101 according to this format, mainly to make sure that the values are
2102 lined-up with respect to each other."
2107 "Non-nil means, properties apply also for sublevels.
2108 This setting is only relevant during property searches, not when querying
2109 an entry with `org-entry-get'. To retrieve a property with inheritance,
2110 you need to call `org-entry-get' with the inheritance flag.
2111 Turning this on can cause significant overhead when doing a search, so
2112 this is turned off by default.
2113 When nil, only the properties directly given in the current entry count.
2114 The value may also be a list of properties that shouldhave inheritance.
2116 However, note that some special properties use inheritance under special
2117 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2119 for valid values of a property."
2127 "The default column format, if no other format has been defined.
2128 This variable can be set on the per-file basis by inserting a line
2130 #+COLUMNS: %25ITEM ....."
2135 "List of property/value pairs that can be inherited by any entry.
2136 You can set buffer-local values for this by adding lines like
2138 #+PROPERTY: NAME VALUE"
2145 "List of property/value pairs that can be inherited by any entry.
2146 Valid for the current buffer.
2150 "Options concerning agenda views in Org-mode."
2155 "Variable used by org files to set a category for agenda display.
2156 Such files should use a file variable to set it, for example
2160 or contain a special line
2162 #+CATEGORY: ELisp
2164 If the file does not specify a category, then file's base name
2169 "The files to be used for agenda display.
2173 If an entry is a directory, all files in that directory that are matched by
2174 `org-agenda-file-regexp' will be part of the file list.
2176 If the value of the variable is not a list but a single file name, then
2177 the list of agenda files is actually stored and maintained in that file, one
2178 agenda file per line."
2185 "Regular expression to match files for `org-agenda-files'.
2186 If any element in the list in that variable contains a directory instead
2187 of a normal file, all files in that directory that are matched by this
2188 regular expression will be included."
2193 "t means to just skip non-reachable files in `org-agenda-files'.
2194 Nil means to remove them, after a query, from the list."
2199 "List of extra files to be searched by `org-occur-in-agenda-files'.
2200 The files in `org-agenda-files' are always searched."
2205 "When set, remote killing from the agenda buffer needs confirmation.
2206 When t, a confirmation is always needed. When a number N, confirmation is
2207 only needed when the text to be killed contains more than N non-white lines."
2215 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2216 The command `org-calendar-goto-agenda' will be bound to this key. The
2217 default is the character `c' because then `c' can be used to switch back and
2218 forth between agenda and calendar."
2223 "Non-nil means, make the block agenda more compact.
2224 This is done by leaving out unnecessary lines."
2229 "Options concerning exporting agenda views in Org-mode."
2234 "Non-nil means, use colors in agenda views."
2239 "Alist of variable/value pairs that should be active during agenda export.
2240 This is a good place to set uptions for ps-print and for htmlize."
2248 "The style specification for exported HTML Agenda files.
2249 If this variable contains a string, it will replace the default <style>
2250 section as produced by `htmlize'.
2251 Since there are different ways of setting style information, this variable
2252 needs to contain the full HTML structure to provide a style, including the
2253 surrounding HTML tags. The style specifications should include definitions
2254 the fonts used by the agenda, here is an example:
2257 p { font-weight: normal; color: gray; }
2258 .org-agenda-structure {
2259 font-size: 110%;
2260 color: #003399;
2261 font-weight: 600;
2262 }
2263 .org-todo {
2264 color: #cc6666;Week-agenda:
2265 font-weight: bold;
2266 }
2267 .org-done {
2268 color: #339933;
2269 }
2270 .title { text-align: center; }
2271 .todo, .deadline { color: red; }
2272 .done { color: green; }
2273 </style>
2275 or, if you want to keep the style in a file,
2279 As the value of this option simply gets inserted into the HTML <head> header,
2281 <style>...</style> is required, if not present the variable will be ignored."
2287 "Options concerning agenda views in Org-mode."
2292 "Custom commands for the agenda.
2293 These commands will be offered on the splash screen displayed by the
2296 (key desc type match options files)
2298 key The key (one or more characters as a string) to be associated
2299 with the command.
2300 desc A description of the commend, when omitted or nil, a default
2301 description is built using MATCH.
2302 type The command type, any of the following symbols:
2303 todo Entries with a specific TODO keyword, in all agenda files.
2304 tags Tags match in all agenda files.
2305 tags-todo Tags match in all agenda files, TODO entries only.
2306 todo-tree Sparse tree of specific TODO keyword in *current* file.
2307 tags-tree Sparse tree with all tags matches in *current* file.
2308 occur-tree Occur sparse tree for *current* file.
2309 ... A user-defined function.
2310 match What to search for:
2311 - a single keyword for TODO keyword searches
2312 - a tags match expression for tags searches
2313 - a regular expression for occur searches
2314 options A list of option settings, similar to that in a let form, so like
2315 this: ((opt1 val1) (opt2 val2) ...)
2316 files A list of files file to write the produced agenda buffer to
2317 with the command `org-store-agenda-views'.
2320 produced. Otherwide, only the plain text is written to the file.
2322 You can also define a set of commands, to create a composite agenda buffer.
2323 In this case, an entry looks like this:
2325 (key desc (cmd1 cmd2 ...) general-options file)
2327 where
2329 desc A description string to be displayed in the dispatcher menu.
2330 cmd An agenda command, similar to the above. However, tree commands
2331 are no allowed, but instead you can get agenda and global todo list.
2332 So valid commands for a set are:
2333 (agenda)
2334 (alltodo)
2335 (stuck)
2340 Each command can carry a list of options, and another set of options can be
2341 given for the whole set of commands. Individual command options take
2342 precedence over the general options.
2344 When using several characters as key to a command, the first characters
2345 are prefix commands. For the dispatcher to display useful information, you
2346 should provide a description for the prefix, like
2348 (setq org-agenda-custom-commands
2420 "How to identify stuck projects.
2421 This is a list of four items:
2422 1. A tags/todo matcher string that is used to identify a project.
2423 The entire tree below a headline matched by this is considered one project.
2424 2. A list of TODO keywords identifying non-stuck projects.
2425 If the project subtree contains any headline with one of these todo
2426 keywords, the project is considered to be not stuck. If you specify
2428 3. A list of tags identifying non-stuck projects.
2429 If the project subtree contains any headline with one of these tags,
2431 a tag, any tag will mark the project unstuck.
2432 4. An arbitrary regular expression matching non-stuck projects.
2435 or `C-c a #' to produce the list."
2439 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2445 "Options concerning skipping parts of agenda files."
2450 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2451 When nil, the sublevels of a TODO entry are not checked, resulting in
2452 potentially much shorter TODO lists."
2458 "Non-nil means, don't show entries with a date in the global todo list.
2459 You can use this if you prefer to mark mere appointments with a TODO keyword,
2460 but don't want them to show up in the TODO list.
2461 When this is set, it also covers deadlines and scheduled items, the settings
2462 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2463 will be ignored."
2469 "Non-nil means, don't show scheduled entries in the global todo list.
2470 The idea behind this is that by scheduling it, you have already taken care
2471 of this item.
2472 See also `org-agenda-todo-ignore-with-date'."
2478 "Non-nil means, don't show near deadline entries in the global todo list.
2479 Near means closer than `org-deadline-warning-days' days.
2480 The idea behind this is that such items will appear in the agenda anyway.
2481 See also `org-agenda-todo-ignore-with-date'."
2487 "Non-nil means don't show scheduled items in agenda when they are done.
2488 This is relevant for the daily/weekly agenda, not for the TODO list. And
2489 it applies only to the actual date of the scheduling. Warnings about
2490 an item with a past scheduling dates are always turned off when the item
2491 is DONE."
2496 "Non-nil means don't show deadines when the corresponding item is done.
2497 When nil, the deadline is still shown and should give you a happy feeling.
2498 This is relevant for the daily/weekly agenda. And it applied only to the
2499 actualy date of the deadline. Warnings about approching and past-due
2500 deadlines are always turned off when the item is DONE."
2505 "Non-nil means don't select item by timestamp or -range if it is DONE."
2510 "Non-nil means, `org-timeline' also shows dates without an entry.
2511 When nil, only the days which actually have entries are shown.
2512 When t, all days between the first and the last date are shown.
2513 When an integer, show also empty dates, but if there is a gap of more than
2514 N days, just insert a special line indicating the size of the gap."
2523 "Options concerning initial settings in the Agenda in Org Mode."
2528 "Hook run just before displaying an agenda buffer."
2533 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2534 A longer mouse click will still set point. Does not wortk on XEmacs.
2535 Needs to be set before org.el is loaded."
2540 "The initial value of follow-mode in a newly created agenda window."
2545 "Options concerning the windows used by the Agenda in Org Mode."
2550 "How the agenda buffer should be displayed.
2551 Possible values for this option are:
2553 current-window Show agenda in the current window, keeping all other windows.
2554 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2555 other-window Use `switch-to-buffer-other-window' to display agenda.
2556 reorganize-frame Show only two windows on the current frame, the current
2557 window and the agenda.
2558 See also the variable `org-agenda-restore-windows-after-quit'."
2567 "The min and max height of the agenda window as a fraction of frame height.
2568 The value of the variable is a cons cell with two numbers between 0 and 1.
2569 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2574 "Non-nil means, restore window configuration open exiting agenda.
2575 Before the window configuration is changed for displaying the agenda,
2576 the current status is recorded. When the agenda is exited with
2577 `q' or `x' and this option is set, the old state is restored. If
2578 `org-agenda-window-setup' is `other-frame', the value of this
2579 option will be ignored.."
2584 "How should indirect tree buffers be displayed?
2585 This applies to indirect buffers created with the commands
2587 Valid values are:
2588 current-window Display in the current window
2589 other-window Just display in another window.
2590 dedicated-frame Create one new frame, and re-use it each time.
2591 new-frame Make a new frame each time. Note that in this case
2592 previously-made indirect buffers are kept, and you need to
2593 kill these buffers yourself."
2603 "Options concerning the daily/weekly agenda."
2608 "Number of days to include in overview display.
2609 Should be 1 or 7."
2614 "Non-nil means, start the overview always on the specified weekday.
2615 0 denotes Sunday, 1 denotes Monday etc.
2616 When nil, always start on the current day."
2622 "Non-nil means, `org-agenda' shows every day in the selected range.
2623 When nil, only the days which actually have entries are shown."
2628 "Format string for displaying dates in the agenda.
2629 Used by the daily/weekly agenda and by the timeline. This should be
2630 a format string understood by `format-time-string', or a function returning
2631 the formatted date as a string. The function must take a single argument,
2632 a calendar-style date list like (month day year)."
2639 "Format a date string for display in the daily/weekly agenda, or timeline.
2640 This function makes sure that dates are aligned for easy reading."
2648 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2653 "Set means weekly/daily agenda will always contain all TODO entries.
2654 The TODO entries will be listed at the top of the agenda, before
2655 the entries for specific days."
2660 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2661 When nil, only one occurence is shown, either today or the
2662 nearest into the future."
2667 "No. of days before expiration during which a deadline becomes active.
2668 This variable governs the display in sparse trees and in the agenda.
2669 When negative, it means use this number (the absolute value of it)
2670 even if a deadline has a different individual lead time specified."
2676 "No. of days to continue listing scheduled items that are not marked DONE.
2677 When an item is scheduled on a date, it shows up in the agenda on this
2678 day and will be listed until it is marked done for the number of days
2679 given here."
2684 "Options concerning the time grid in the Org-mode Agenda."
2689 "Non-nil means, show a time grid in the agenda schedule.
2690 A time grid is a set of lines for specific times (like every two hours between
2691 8:00 and 20:00). The items scheduled for a day at specific times are
2692 sorted in between these lines.
2693 For details about when the grid will be shown, and what it will look like, see
2694 the variable `org-agenda-time-grid'."
2700 "----------------"
2703 "The settings for time grid for agenda display.
2704 This is a list of three items. The first item is again a list. It contains
2705 symbols specifying conditions when the grid should be displayed:
2707 daily if the agenda shows a single day
2708 weekly if the agenda shows an entire week
2709 today show grid on current date, independent of daily/weekly display
2710 require-timed show grid only if at least one item has a time specification
2712 The second item is a string which will be places behing the grid time.
2714 The third item is a list of integers, indicating the times that should have
2715 a grid line."
2717 :type
2724 require-timed)
2726 remove-match))
2731 "Options concerning sorting in the Org-mode Agenda."
2747 "Sorting structure for the agenda items of a single day.
2748 This is a list of symbols which will be used in sequence to determine
2749 if an entry should be listed before another entry. The following
2750 symbols are recognized:
2752 time-up Put entries with time-of-day indications first, early first
2753 time-down Put entries with time-of-day indications first, late first
2754 category-keep Keep the default order of categories, corresponding to the
2755 sequence in `org-agenda-files'.
2756 category-up Sort alphabetically by category, A-Z.
2757 category-down Sort alphabetically by category, Z-A.
2758 tag-up Sort alphabetically by last tag, A-Z.
2759 tag-down Sort alphabetically by last tag, Z-A.
2760 priority-up Sort numerically by priority, high priority last.
2761 priority-down Sort numerically by priority, high priority first.
2763 The different possibilities will be tried in sequence, and testing stops
2765 '(time-up category-keep priority-down)
2766 means: Pull out all entries having a specified time of day and sort them,
2767 in order to make a time schedule for the current day the first thing in the
2768 agenda listing for the day. Of the entries without a time indication, keep
2769 the grouped in categories, don't sort the categories, but keep them in
2770 the sequence given in `org-agenda-files'. Within each category sort by
2771 priority.
2773 Leaving out `category-keep' would mean that items will be sorted across
2774 categories by priority.
2776 Instead of a single list, this can also be a set of list for specific
2777 contents, with a context symbol in the car of the list, any of
2778 `agenda', `todo', `tags' for the corresponding agenda views."
2791 "Non-nil means, items without time are considered late.
2792 This is only relevant for sorting. When t, items which have no explicit
2793 time like 15:30 will be considered as 99:01, i.e. later than any items which
2794 do have a time. When nil, the default time is before 0:00. You can use this
2795 option to decide if the schedule for today should come before or after timeless
2796 agenda entries."
2801 "Options concerning the entry prefix in the Org-mode agenda display."
2810 "Format specifications for the prefix of items in the agenda views.
2811 An alist with four entries, for the different agenda types. The keys to the
2812 sublists are `agenda', `timeline', `todo', and `tags'. The values
2813 are format strings.
2814 This format works similar to a printf format, with the following meaning:
2817 as given by the CATEGORY keyword or derived from the file name.
2818 %T the *last* tag of the item. Last because inherited tags come
2819 first in the list.
2820 %t the time-of-day specification if one applies to the entry, in the
2821 format HH:MM
2822 %s Scheduling/Deadline information, a short string
2824 All specifiers work basically like the standard `%s' of printf, but may
2825 contain two additional characters: A question mark just after the `%' and
2826 a whitespace/punctuation character just before the final letter.
2828 If the first character after `%' is a question mark, the entire field
2829 will only be included if the corresponding value applies to the
2830 current entry. This is useful for fields which should have fixed
2831 width when present, but zero width when absent. For example,
2833 day is specified, but will completely disappear in entries which do
2834 not contain a time.
2836 If there is punctuation or whitespace character just before the final
2837 format letter, this character will be appended to the field value if
2840 empty, no additional colon would be interted.
2843 - Indent the line with two space characters
2844 - Give the category in a 12 chars wide field, padded with whitespace on
2845 the right (because of `-'). Append a colon if there is a category
2846 (because of `:').
2847 - If there is a time-of-day, put it into a 12 chars wide field. If no
2848 time, don't put in an empty field, just skip it (because of '?').
2849 - Finally, put the scheduling information and append a whitespace.
2851 As another example, if you don't want the time-of-day of entries in
2852 the prefix, you could use:
2856 See also the variables `org-agenda-remove-times-when-in-prefix' and
2857 `org-agenda-remove-tags'."
2868 "The compiled version of the most recently used prefix format.
2872 "Format for the TODO keyword in agenda lines.
2874 to occupy a fixed space in the agenda display."
2879 "Text preceeding scheduled items in the agenda view.
2880 This is a list with two strings. The first applies when the item is
2881 scheduled on the current day. The second applies when it has been scheduled
2882 previously, it may contain a %d to capture how many days ago the item was
2883 scheduled."
2890 "Text preceeding deadline items in the agenda view.
2891 This is a list with two strings. The first applies when the item has its
2892 deadline on the current day. The second applies when it is in the past or
2893 in the future, it may contain %d to capture how many days away the deadline
2894 is (was)."
2901 "Non-nil means, remove duplicate time specifications in agenda items.
2902 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2903 time-of-day specification in a headline or diary entry is extracted and
2904 placed into the prefix. If this option is non-nil, the original specification
2905 \(a timestamp or -range, or just a plain time(range) specification like
2906 11:30-4pm) will be removed for agenda display. This makes the agenda less
2907 cluttered.
2908 The option can be t or nil. It may also be the symbol `beg', indicating
2909 that the time should only be removed what it is located at the beginning of
2910 the headline/diary entry."
2919 "Default duration for appointments that only have a starting time.
2920 When nil, no duration is specified in such cases.
2921 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2929 "Non-nil means, remove the tags from the headline copy in the agenda.
2930 When this is the symbol `prefix', only remove tags when
2931 `org-agenda-prefix-format' contains a `%T' specifier."
2943 "Shift tags in agenda items to this column.
2944 If this number is positive, it specifies the column. If it is negative,
2945 it means that the tags should be flushright to that column. For example,
2946 -80 works well for a normal 80 character screen."
2954 "Non-nil means, highlight low and high priorities in agenda.
2955 When t, the highest priority entries are bold, lowest priority italic.
2956 This may also be an association list of priority faces. The face may be
2967 "Options for embedding LaTeX code into Org-mode"
2975 "Options for creating images from LaTeX fragments.
2976 This is a property list with the following properties:
2978 `default' means use the forground of the default face.
2980 `default' means use the background of the default face.
2981 :scale a scaling factor for the size of the images
2982 :html-foreground, :html-background, :html-scale
2983 The same numbers for HTML export.
2984 :matchers a list indicating which matchers should be used to
2985 find LaTeX fragments. Valid members of this list are:
3002 "The document header used for processing LaTeX fragments."
3007 "Options for exporting org-listings."
3012 "General options for exporting Org-mode files."
3016 ;; FIXME
3021 When this option is turned on, these strings will be exported as:
3023 Org HTML LaTeX
3024 -----+----------+--------
3026 -- – --
3027 --- — ---
3028 ... … \ldots
3045 "Terms used in export text, translated to different languages.
3046 Use the variable `org-export-default-language' to set the language,
3047 or use the +OPTION lines for a per-file setting."
3057 "The default language of HTML export, as a string.
3058 This should have an association in `org-export-language-setup'."
3063 "Non-nil means, skip all text before the first headline when exporting.
3064 When nil, that text is exported as well."
3069 "The last level which is still exported as a headline.
3070 Inferior levels will produce itemize lists when exported.
3071 Note that a numeric prefix argument to an exporter function overrides
3072 this setting.
3079 "Non-nil means, add section numbers to headlines when exporting.
3086 "Non-nil means, create a table of contents in exported files.
3087 The TOC contains headlines with levels up to`org-export-headline-levels'.
3088 When an integer, include levels up to N in the toc, this may then be
3089 different from `org-export-headline-levels', but it will not be allowed
3090 to be larger than the number of headline levels.
3091 When nil, no table of contents is made.
3094 ASCII export, and with red color in HTML output, if the option
3095 `org-export-mark-todo-in-toc' is set.
3097 In HTML output, the TOC will be clickable.
3108 "Non-nil means, mark TOC lines that contain any open TODO items."
3113 "Non-nil means, preserve all line breaks when exporting.
3114 Normally, in HTML output paragraphs will be reformatted. In ASCII
3115 export, line breaks will always be preserved, regardless of this variable.
3122 "Whether subtrees with the ARCHIVE tag should be exported.
3123 This can have three different values
3124 nil Do not export, pretend this tree is not present
3125 t Do export the entire tree
3126 headline Only export the headline, but skip the tree below it."
3135 "Non-nil means, insert author name and email into the exported file.
3137 This option can also be set with the +OPTIONS line,
3143 "Non-nil means, insert a time stamp into the exported file.
3144 The time stamp shows when the file was created.
3146 This option can also be set with the +OPTIONS line,
3152 "If nil, do not export time stamps and associated keywords."
3157 "If nil, remove timestamps from the table of contents entries."
3162 "If nil, do not export tags, just remove them from headlines.
3163 If this is the symbol `not-in-toc', tags will be removed from table of
3164 contents entries, but still be shown in the headlines of the document.
3174 "Non-nil means, export with drawers like the property drawer.
3175 When t, all drawers are exported. This may also be a list of
3176 drawer names to export."
3185 "Options for translating special ascii sequences for the export backends."
3190 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3191 If the export target supports emphasizing text, the word will be
3192 typeset in bold, italic, or underlined, respectively. Works only for
3193 single words, but you can say: I *really* *mean* *this*.
3194 Not all export backends support this.
3201 "If nil, export [1] as a footnote marker.
3202 Lines starting with [1] will be formatted as footnotes.
3210 When this option is turned on, you can use TeX-like syntax for sub- and
3212 considered as a single item - so grouping with {} is normally not
3213 needed. For example, the following things will be parsed as single
3214 sub- or superscripts.
3216 10^24 or 10^tau several digits will be considered 1 item.
3217 10^-12 or 10^-tau a leading sign with digits or a word
3218 x^2-y^3 will be read as x^2 - y^3, because items are
3219 terminated by almost any nonword/nondigit char.
3220 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3222 Still, ambiguity is possible - so when in doubt use {} to enclose the
3223 sub/superscript. If you set this variable to the symbol `{}',
3224 the braces are *required* in order to trigger interpretations as
3226 frequently in plain text.
3228 Not all export backends support this, but HTML does.
3239 When this option is turned on, these strings will be exported as:
3242 -- : –
3243 --- : —
3245 Not all export backends support this, but HTML does.
3252 "Non-nil means, interpret simple TeX-like macros when exporting.
3254 No only real TeX macros will work here, but the standard HTML entities
3255 for math can be used as macro names as well. For a list of supported
3256 names in HTML export, see the constant `org-html-entities'.
3257 Not all export backends support this.
3265 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3267 the first non-white thing on a line. It will also find the math delimiters
3269 display math.
3278 This can be used to have pre-formatted text, fragments of code etc. For
3279 example:
3280 : ;; Some Lisp examples
3281 : (while (defc cnt)
3282 : (ding))
3283 will be looking just like this in also HTML. See also the QUOTE keyword.
3284 Not all export backends support this.
3291 "Number of stacked braces for sub/superscript matching.
3292 This has to be set before loading org.el to be effective."
3297 "Options for exporting tables in Org-mode."
3303 For example:
3305 | Name | Address | Birthday |
3306 |-------------+----------+-----------|
3307 | Arthur Dent | England | 29.2.2100 |
3309 Not all export backends support this.
3316 "Non-nil means, highlight the first table line.
3317 In HTML export, this means use <th> instead of <td>.
3318 In tables created with table.el, this applies to the first table line.
3319 In Org-mode tables, all lines before the first horizontal separator
3320 line will be formatted with <th> tags."
3325 "Remove special lines and marking characters in calculating tables.
3326 This removes the special marking character column from tables that are set
3327 up for spreadsheet calculations. It also removes the entire lines
3328 marked with `!', `_', or `^'. The lines with `$' are kept, because
3329 the values of constants may be useful to have."
3334 "Non-nil means, always export tables created with table.el natively.
3335 Natively means, use the HTML code generator in table.el.
3336 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3337 the table does not use row- or column-spanning). This has the
3338 advantage, that the automatic HTML conversions for math symbols and
3339 sub/superscripts can be applied. Org-mode's HTML generator is also
3340 much faster."
3345 "Options specific for ASCII export of Org-mode files."
3350 "Characters for underlining headings in ASCII export.
3351 In the given sequence, these characters will be used for level 1, 2, ..."
3356 "Bullet characters for headlines converted to lists in ASCII export.
3357 The first character is used for the first lest level generated in this
3358 way, and so on. If there are more levels than characters given here,
3359 the list will be repeated.
3360 Note that plain lists will keep the same bullets as the have in the
3361 Org-mode file."
3366 "Options specific for XML export of Org-mode files."
3371 "Options specific for HTML export of Org-mode files."
3376 ""
3381 "The extension for exported HTML files."
3387 html {
3388 font-family: Times, serif;
3389 font-size: 12pt;
3390 }
3391 .title { text-align: center; }
3392 .todo { color: red; }
3393 .done { color: green; }
3394 .timestamp { color: grey }
3395 .timestamp-kwd { color: CadetBlue }
3396 .tag { background-color:lightblue; font-weight:normal }
3397 .target { background-color: lavender; }
3398 pre {
3399 border: 1pt solid #AEBDCC;
3400 background-color: #F3F5F7;
3401 padding: 5pt;
3402 font-family: courier, monospace;
3403 }
3404 table { border-collapse: collapse; }
3405 td, th {
3406 vertical-align: top;
3407 <!--border: 1pt solid #ADB9CC;-->
3408 }
3409 </style>"
3410 "The default style specification for exported HTML files.
3411 Since there are different ways of setting style information, this variable
3412 needs to contain the full HTML structure to provide a style, including the
3413 surrounding HTML tags. The style specifications should include definitions
3414 for new classes todo, done, title, and deadline. For example, legal values
3415 would be:
3418 p { font-weight: normal; color: gray; }
3419 h1 { color: black; }
3420 .title { text-align: center; }
3421 .todo, .deadline { color: red; }
3422 .done { color: green; }
3423 </style>
3425 or, if you want to keep the style in a file,
3429 As the value of this option simply gets inserted into the HTML <head> header,
3436 "Format for typesetting the document title in HTML export."
3441 "The <H> level for level 1 headings in HTML export."
3446 "Non-nil means, make file links to `file.org' point to `file.html'.
3447 When org-mode is exporting an org-mode file to HTML, links to
3448 non-html files are directly put into a href tag in HTML.
3449 However, links to other Org-mode files (recognized by the
3450 extension `.org.) should become links to the corresponding html
3451 file, assuming that the linked org-mode file will also be
3452 converted to HTML.
3453 When nil, the links still point to the plain `.org' file."
3458 "Non-nil means, inline images into exported HTML pages.
3459 This is done using an <img> tag. When nil, an anchor with href is used to
3460 link to the image. If this option is `maybe', then images in links with
3461 an empty description will be inlined, while images with a description will
3462 be linked only."
3468 ;; FIXME: rename
3470 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3471 When nil, these tags will be exported as plain text and therefore
3472 not be interpreted by a browser.
3480 "The HTML tag that is used to start a table.
3481 This must be a <table> tag, but you may change the options like
3482 borders and spacing."
3487 "The opening tag for table header fields.
3488 This is customizable so that alignment options can be specified."
3493 "The opening tag for table data fields.
3494 This is customizable so that alignment options can be specified."
3499 "If non-nil, write `org-export-html-html-helper-timestamp'
3500 into the exported HTML text. Otherwise, the buffer will just be saved
3501 to a file."
3507 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3512 "Options specific for iCalendar export of Org-mode files."
3517 "The file name for the iCalendar file covering all agenda files.
3519 The file name should be absolute, the file will be overwritten without warning."
3524 "Non-nil means, export to iCalendar files should also cover TODO items."
3532 "Non-nil means, export to iCalendar files should also cover sexp entries.
3533 These are entries like in the diary, but directly in an Org-mode file."
3538 "Amount of text below headline to be included in iCalendar export.
3539 This is a number of characters that should maximally be included.
3540 Properties, scheduling and clocking lines will always be removed.
3541 The text will be inserted into the DESCRIPTION field."
3549 "Calendar name for the combined iCalendar representing all agenda files."
3554 "Font-lock settings for highlighting in Org-mode."
3559 "Non-nil means fontify only the stars in each headline.
3560 When nil, the entire headline is fontified.
3561 Changing it requires restart of `font-lock-mode' to become effective
3562 also in regions already fontified."
3567 "Non-nil means, hide the first N-1 stars in a headline.
3568 This works by using the face `org-hide' for these stars. This
3569 face is white for a light background, and black for a dark
3570 background. You may have to customize the face `org-hide' to
3571 make this work.
3572 Changing it requires restart of `font-lock-mode' to become effective
3573 also in regions already fontified.
3574 You may also set this on a per-file basis by adding one of the following
3575 lines to the buffer:
3577 #+STARTUP: hidestars
3578 #+STARTUP: showstars"
3583 "Non-nil means, change the face of a headline if it is marked DONE.
3584 Normally, only the TODO/DONE keyword indicates the state of a headline.
3585 When this is non-nil, the headline after the keyword is set to the
3586 `org-headline-done' as an additional indication."
3591 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3592 Changing this variable requires a restart of Emacs to take effect."
3597 "Non-nil means, fontify what is treated specially by the exporters."
3602 "Non-nil mean font-lock should hide the emphasis marker characters."
3613 "Set variable and compute the emphasis regular expression."
3617 org-emphasis-alist org-emphasis-regexp-components)
3630 ;; make sure special characters appear at the right position in the class
3642 ;; Make the regexp
3650 body1
3662 body1
3670 "Components used to build the regular expression for emphasis.
3671 This is a list with 6 entries. Terminology: In an emphasis string
3675 specify what is allowed/forbidden in each part:
3677 pre Chars allowed as prematch. Beginning of line will be allowed too.
3678 post Chars allowed as postmatch. End of line will be allowed too.
3679 border The chars *forbidden* as border characters.
3681 non-shy groups here, and don't allow newline here.
3682 newline The maximum number of newlines allowed in an emphasis exp.
3684 Use customize to modify this, or restart Emacs after changing it."
3702 )
3703 "Special syntax for emphasized text.
3704 Text starting and ending with a special character will be emphasized, for
3705 example *bold*, _underlined_ and /italic/. This variable sets the marker
3706 characters, the face to be used by font-lock for highlighting in Org-mode
3707 Emacs buffers, and the HTML tags to be used for this.
3708 Use customize to modify this, or restart Emacs after changing it."
3721 ;;; The faces
3724 "Faces in Org-mode."
3729 "Make a compatible face specification.
3730 If INHERITS is an existing face and if the Emacs version supports it,
3731 just inherit the face. If not, use SPECS to define the face.
3732 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3733 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3734 to the top of the list. The `min-colors' attribute will be removed from
3735 any other entries, and any resulting duplicates will be removed entirely."
3739 ;; In Emacs 23, we use inheritance where possible.
3740 ;; We only do this in Emacs 23, because only there the outline
3741 ;; faces have been changed to the original org-mode-level-faces.
3744 ;; These do not understand the `min-colors' attribute.
3763 "Face used to hide leading stars in headlines.
3764 The forground color of this face should be equal to the background
3765 color of the frame."
3776 "Face used for level 1 headlines."
3786 "Face used for level 2 headlines."
3798 "Face used for level 3 headlines."
3810 "Face used for level 4 headlines."
3818 "Face used for level 5 headlines."
3826 "Face used for level 6 headlines."
3834 "Face used for level 7 headlines."
3842 "Face used for level 8 headlines."
3850 "Face used for special keywords."
3861 "Face used for drawers."
3865 "Face used for the value of a property."
3877 "Face for column display of entry properties."
3881 ;; Make sure that a fixed-width face is used when we have a column table.
3893 "Face for deadlines and TODO keywords."
3906 "Face for headline with the ARCHIVE tag."
3913 "Face for links."
3920 "Face for the ellipsis in folded text."
3927 "Face for links."
3934 "Face for links."
3941 "Face for links."
3946 "Face for tags."
3956 "Face for TODO keywords."
3965 "Face used for todo keywords that indicate DONE items."
3973 "Face used to indicate that a headline is DONE.
3974 This face is only used if `org-fontify-done-headline' is set. If applies
3975 to the part of the headline after the DONE keyword."
3979 "Faces for specific TODO keywords.
3980 This is a list of cons cells, with TODO keywords in the car
3981 and faces in the cdr. The face can be a symbol, or a property
3998 "Face used for tables."
4008 "Face for formulas."
4021 "Face for fixed-with text like code snippets."
4035 "Face for fixed-with text like code snippets."
4047 "Face used in agenda for captions and dates."
4056 "Face for items scheduled for a certain day."
4066 "Face for items scheduled previously, and not yet done."
4076 "Face for items scheduled previously, and not yet done."
4083 "Faces for showing deadlines in the agenda.
4084 This is a list of cons cells. The cdr of each cell is a face to be used,
4086 Each car is a fraction of the head-warning time that must have passed for
4087 this the face in the cdr to be used for display. The numbers must be
4088 given in descending order. The head-warning time is normally taken
4089 from `org-deadline-warning-days', but can also be specified in the deadline
4090 timestamp itself, like this:
4092 DEADLINE: <2007-08-13 Mon -8d>
4094 You may use d for days, w for weeks, m for months and y for years. Months
4095 and years will only be treated in an approximate fashion (30.4 days for a
4096 month and 365.24 days for a year)."
4104 ;; FIXME: this is not a good face yet.
4113 "Face for showing the agenda restriction lock."
4121 "Face used for time grids."
4126 org-level-5 org-level-6 org-level-7 org-level-8
4127 ))
4130 "The number different faces to be used for headlines.
4131 Org-mode defines 8 different headline faces, so this can be at most 8.
4132 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4136 ;;; Functions and variables from ther packages
4137 ;; Declared here to avoid compiler warnings
4143 ;; XEmacs only
4149 ;; Emacs only
4152 ;; Various packages
4153 ;; FIXME: get the argument lists for the UNKNOWN stuff
4209 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4210 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4240 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4251 ;; backward compatibility to old version of wl
4254 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4267 ;;; Variables for pre-computed regular expressions, all buffer local
4282 "Matches a headline and puts everything into groups:
4283 group 1: the stars
4284 group 2: The todo keyword, maybe
4285 group 3: Priority cookie
4286 group 4: True headline
4290 "Matches a headline and puts TODO state into group 2 if present.
4335 rear-nonsticky t mouse-map t fontified t)
4342 s)
4349 s)
4358 "Modified `buffer-invisibility-spec' for Emacs 21.
4359 Some ops with invisible text do not work correctly on Emacs 21. For these
4360 we turn off invisibility temporarily. Use this in a `let' form."
4364 "Make VAR local in current buffer and set it to VALUE."
4368 "Check if the current buffer is in Org-mode."
4372 "Return the last element of LIST."
4405 "Variable associated with STARTUP options for org-mode.
4406 Each element is a list of three items: The startup options as written
4407 in the #+STARTUP line, the corresponding variable, and the value to
4408 set this variable to if the option is found. An optional forth element PUSH
4412 "Precompute regular expressions for current buffer."
4427 kwds kws0 kwsa key value cat arch tags const links hw dws
4428 tail sep kws1 prio props drawers
4429 ex log)
4453 links)))
4459 props)))
4466 l var val)
4481 )))
4495 ;; Process the TODO keywords
4497 ;; Use the global values as if they had been given locally.
4508 kwsa nil
4520 kw)
4522 kws0)
4539 ;; Process the constants
4547 ;; Process the tags.
4557 tgs))
4565 ;; Compute the regular expressions and other local variables
4570 org-drawer-regexp
4574 org-not-done-keywords
4576 org-todo-regexp
4579 org-not-done-regexp
4583 org-todo-line-regexp
4587 org-complex-heading-regexp
4592 org-nl-done-regexp
4596 org-todo-line-tags-regexp
4601 org-looking-at-done-regexp
4606 org-deadline-time-regexp
4608 org-deadline-line-regexp
4610 org-scheduled-regexp
4612 org-scheduled-time-regexp
4614 org-closed-time-regexp
4616 org-keyword-time-regexp
4622 org-keyword-time-not-clock-regexp
4628 org-maybe-keyword-time-regexp
4634 org-planning-or-clock-line-re
4639 )
4647 x))
4648 list))
4650 ;; FIXME: this could be done much better, using second characters etc.
4652 "Assign fast keys to a keyword-key alist.
4653 Respect keys that are already there."
4663 ;; automatically assign a character.
4675 ;;; Some variables ujsed in various places
4680 "Function to be called when `C-c C-c' is used.
4684 ;; FIXME: Occasionally check by commenting these, to make sure
4685 ;; no other functions uses these, forgetting to let-bind them.
4692 ;; Defined somewhere in this file, but used before definition.
4705 ;;;; Emacs/XEmacs compatibility
4707 ;; Overlay compatibility functions
4725 "Make overlay OVL display TEXT with face FACE."
4735 "Make overlay OVL display TEXT with face FACE."
4758 "Find all overlays specifying PROP at POS or point.
4759 If DELETE is non-nil, delete all those overlays."
4761 ov found)
4765 found))
4767 ;; Region compatibility
4770 "Add-hook, compatible with both Emacsen."
4779 "Is `transient-mark-mode' on and the region active?
4780 Works on both Emacs and XEmacs."
4782 nil
4789 ;; Invisibility compatibility
4792 "Add elements to `buffer-invisibility-spec'.
4793 See documentation for `buffer-invisibility-spec' for the kind of elements
4794 that can be added."
4805 "Remove elements from `buffer-invisibility-spec'."
4813 "Is ARG a member of `buffer-invisibility-spec'?"
4816 nil))
4818 ;;;; Define the Org-mode
4821 (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."))
4824 ;; We use a before-change function to check if a table might need
4825 ;; an update.
4827 "Indicates that a table might need an update.
4828 This variable is set by `org-before-change-function'.
4837 ;;;###autoload
4839 "Outline-based notes management and organizer, alias
4842 Org-mode develops organizational tasks around a NOTES file which
4843 contains information about projects as plain text. Org-mode is
4844 implemented on top of outline-mode, which is ideal to keep the content
4845 of large files well structured. It supports ToDo items, deadlines and
4846 time stamps, which magically appear in the diary listing of the Emacs
4847 calendar. Tables are easily created with a built-in table editor.
4848 Plain text URL-like links connect to websites, emails (VM), Usenet
4849 messages (Gnus), BBDB entries, and any files related to the project.
4850 For printing and sharing of notes, an Org-mode file (or a part of it)
4851 can be exported as a structured ASCII or HTML file.
4853 The following commands are available:
4857 ;; Get rid of Outline menus, they are not needed
4858 ;; Need to do this here because define-derived-mode sets up
4859 ;; the keymap so late. Still, it is a waste to call this each time
4860 ;; we switch another buffer into org-mode.
4863 ;; Assume this is Greg's port, it used easymenu
4886 org-display-table 4
4889 org-ellipsis)))
4893 ;; Calc embedded
4900 ;; Activate before-change-function
4904 ;; Check for running clock before killing a buffer
4906 ;; Paragraphs and auto-filling
4911 ;; Comment characters
4912 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4915 ;; Align options lines
4917 'align-mode-rules-list
4922 ;; Imenu
4926 ;; Make isearch reveal context
4929 ;; Emacs 21 and XEmacs make use of the hook
4931 ;; Emacs 22 deals with this through a special variable
4935 ;; If empty file that did not turn on org-mode automatically, make it to.
4957 "Call COMMAND interactively, but pretend prefix are was ARG."
4963 ;; works also in narrowed buffer, because we start at 1, not point-min
4967 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4977 "Add text properties to entire string, from beginning to end.
4978 PLIST may be a list of properties, PROPS are individual properties and values
4979 that will be added to PLIST. Returns the string that was modified."
4982 string)
4986 ;;;; Font-Lock stuff, including the activators
4991 (org-defkey org-mouse-map
4992 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4993 (when org-mouse-1-follows-link
4994 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4995 (when org-tab-follows-link
4996 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4997 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4998 (when org-return-follows-link
4999 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5000 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5002 (require 'font-lock)
5005 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5006 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5007 (defvar org-link-re-with-space nil
5008 "Matches a link with spaces, optional angular brackets around it.")
5009 (defvar org-link-re-with-space2 nil
5010 "Matches a link with spaces, optional angular brackets around it.")
5011 (defvar org-angle-link-re nil
5012 "Matches link with angular brackets, spaces are allowed.")
5013 (defvar org-plain-link-re nil
5014 "Matches plain link, without spaces.")
5015 (defvar org-bracket-link-regexp nil
5016 "Matches a link in double brackets.")
5017 (defvar org-bracket-link-analytic-regexp nil
5018 "Regular expression used to analyze links.
5019 Here is what the match groups contain after a match:
5020 1: http:
5021 2: http
5022 3: path
5023 4: [desc]
5024 5: desc")
5025 (defvar org-any-link-re nil
5026 "Regular expression matching any link.")
5028 (defun org-make-link-regexps ()
5029 "Update the link regular expressions.
5030 This should be called after the variable `org-link-types' has changed."
5031 (setq org-link-re-with-space
5032 (concat
5035 "[^" org-non-link-chars "]*"
5037 org-link-re-with-space2
5038 (concat
5043 org-angle-link-re
5044 (concat
5047 "[^" org-non-link-chars "]*"
5049 org-plain-link-re
5050 (concat
5053 org-bracket-link-regexp
5055 org-bracket-link-analytic-regexp
5056 (concat
5063 org-any-link-re
5068 (org-make-link-regexps)
5071 "Regular expression for fast time stamp matching.")
5073 "Regular expression for fast time stamp matching.")
5074 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5075 "Regular expression matching time strings for analysis.
5076 This one does not require the space after the date.")
5077 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5078 "Regular expression matching time strings for analysis.")
5080 "Regular expression matching time stamps, with groups.")
5082 "Regular expression matching time stamps (also [..]), with groups.")
5083 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5084 "Regular expression matching a time stamp range.")
5085 (defconst org-tr-regexp-both
5086 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5087 "Regular expression matching a time stamp range.")
5090 "Regular expression matching a time stamp or time stamp range.")
5093 "Regular expression matching a time stamp or time stamp range.
5094 The time stamps may be either active or inactive.")
5096 (defvar org-emph-face nil)
5098 (defun org-do-emphasis-faces (limit)
5099 "Run through the buffer and add overlays to links."
5100 (let (rtn)
5101 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5102 (if (not (= (char-after (match-beginning 3))
5103 (char-after (match-beginning 4))))
5104 (progn
5105 (setq rtn t)
5106 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5107 'face
5108 (nth 1 (assoc (match-string 3)
5109 org-emphasis-alist)))
5110 (add-text-properties (match-beginning 2) (match-end 2)
5111 '(font-lock-multiline t))
5112 (when org-hide-emphasis-markers
5113 (add-text-properties (match-end 4) (match-beginning 5)
5114 '(invisible org-link))
5115 (add-text-properties (match-beginning 3) (match-end 3)
5116 '(invisible org-link)))))
5117 (backward-char 1))
5118 rtn))
5120 (defun org-emphasize (&optional char)
5121 "Insert or change an emphasis, i.e. a font like bold or italic.
5122 If there is an active region, change that region to a new emphasis.
5123 If there is no region, just insert the marker characters and position
5124 the cursor between them.
5125 CHAR should be either the marker character, or the first character of the
5126 HTML tag associated with that emphasis. If CHAR is a space, the means
5127 to remove the emphasis of the selected region.
5128 If char is not given (for example in an interactive call) it
5129 will be prompted for."
5130 (interactive)
5131 (let ((eal org-emphasis-alist) e det
5132 (erc org-emphasis-regexp-components)
5133 (prompt "")
5134 (string "") beg end move tag c s)
5135 (if (org-region-active-p)
5136 (setq beg (region-beginning) end (region-end)
5137 string (buffer-substring beg end))
5138 (setq move t))
5140 (while (setq e (pop eal))
5141 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5142 c (aref tag 0))
5143 (push (cons c (string-to-char (car e))) det)
5144 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5145 (substring tag 1)))))
5146 (unless char
5147 (message "%s" (concat "Emphasis marker or tag:" prompt))
5148 (setq char (read-char-exclusive)))
5149 (setq char (or (cdr (assoc char det)) char))
5150 (if (equal char ?\ )
5151 (setq s "" move nil)
5152 (unless (assoc (char-to-string char) org-emphasis-alist)
5154 (setq s (char-to-string char)))
5155 (while (and (> (length string) 1)
5156 (equal (substring string 0 1) (substring string -1))
5157 (assoc (substring string 0 1) org-emphasis-alist))
5158 (setq string (substring string 1 -1)))
5159 (setq string (concat s string s))
5160 (if beg (delete-region beg end))
5161 (unless (or (bolp)
5163 (char-to-string (char-before (point)))))
5164 (insert " "))
5166 (char-to-string (char-after (point))))
5167 (insert " ") (backward-char 1))
5168 (insert string)
5169 (and move (backward-char 1))))
5171 (defconst org-nonsticky-props
5172 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5175 (defun org-activate-plain-links (limit)
5176 "Run through the buffer and add overlays to links."
5177 (catch 'exit
5178 (let (f)
5179 (while (re-search-forward org-plain-link-re limit t)
5180 (setq f (get-text-property (match-beginning 0) 'face))
5181 (if (or (eq f 'org-tag)
5182 (and (listp f) (memq 'org-tag f)))
5183 nil
5184 (add-text-properties (match-beginning 0) (match-end 0)
5185 (list 'mouse-face 'highlight
5186 'rear-nonsticky org-nonsticky-props
5187 'keymap org-mouse-map
5188 ))
5189 (throw 'exit t))))))
5191 (defun org-activate-code (limit)
5193 (unless (get-text-property (match-beginning 1) 'face)
5194 (remove-text-properties (match-beginning 0) (match-end 0)
5195 '(display t invisible t intangible t))
5196 t)))
5198 (defun org-activate-angle-links (limit)
5199 "Run through the buffer and add overlays to links."
5200 (if (re-search-forward org-angle-link-re limit t)
5201 (progn
5202 (add-text-properties (match-beginning 0) (match-end 0)
5203 (list 'mouse-face 'highlight
5204 'rear-nonsticky org-nonsticky-props
5205 'keymap org-mouse-map
5206 ))
5207 t)))
5209 (defmacro org-maybe-intangible (props)
5210 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5211 In emacs 21, invisible text is not avoided by the command loop, so the
5212 intangible property is needed to make sure point skips this text.
5213 In Emacs 22, this is not necessary. The intangible text property has
5214 led to problems with flyspell. These problems are fixed in flyspell.el,
5215 but we still avoid setting the property in Emacs 22 and later.
5216 We use a macro so that the test can happen at compilation time."
5217 (if (< emacs-major-version 22)
5218 `(append '(intangible t) ,props)
5219 props))
5221 (defun org-activate-bracket-links (limit)
5222 "Run through the buffer and add overlays to bracketed links."
5223 (if (re-search-forward org-bracket-link-regexp limit t)
5224 (let* ((help (concat "LINK: "
5225 (org-match-string-no-properties 1)))
5226 ;; FIXME: above we should remove the escapes.
5227 ;; but that requires another match, protecting match data,
5228 ;; a lot of overhead for font-lock.
5229 (ip (org-maybe-intangible
5230 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5231 'keymap org-mouse-map 'mouse-face 'highlight
5232 'font-lock-multiline t 'help-echo help)))
5233 (vp (list 'rear-nonsticky org-nonsticky-props
5234 'keymap org-mouse-map 'mouse-face 'highlight
5235 ' font-lock-multiline t 'help-echo help)))
5236 ;; We need to remove the invisible property here. Table narrowing
5237 ;; may have made some of this invisible.
5238 (remove-text-properties (match-beginning 0) (match-end 0)
5239 '(invisible nil))
5240 (if (match-end 3)
5241 (progn
5242 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5243 (add-text-properties (match-beginning 3) (match-end 3) vp)
5244 (add-text-properties (match-end 3) (match-end 0) ip))
5245 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5246 (add-text-properties (match-beginning 1) (match-end 1) vp)
5247 (add-text-properties (match-end 1) (match-end 0) ip))
5248 t)))
5250 (defun org-activate-dates (limit)
5251 "Run through the buffer and add overlays to dates."
5252 (if (re-search-forward org-tsr-regexp-both limit t)
5253 (progn
5254 (add-text-properties (match-beginning 0) (match-end 0)
5255 (list 'mouse-face 'highlight
5256 'rear-nonsticky org-nonsticky-props
5257 'keymap org-mouse-map))
5258 (when org-display-custom-times
5259 (if (match-end 3)
5260 (org-display-custom-time (match-beginning 3) (match-end 3)))
5261 (org-display-custom-time (match-beginning 1) (match-end 1)))
5262 t)))
5264 (defvar org-target-link-regexp nil
5265 "Regular expression matching radio targets in plain text.")
5267 "Regular expression matching a link target.")
5269 "Regular expression matching a radio target.")
5270 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5271 "Regular expression matching any target.")
5273 (defun org-activate-target-links (limit)
5274 "Run through the buffer and add overlays to target matches."
5275 (when org-target-link-regexp
5276 (let ((case-fold-search t))
5277 (if (re-search-forward org-target-link-regexp limit t)
5278 (progn
5279 (add-text-properties (match-beginning 0) (match-end 0)
5280 (list 'mouse-face 'highlight
5281 'rear-nonsticky org-nonsticky-props
5282 'keymap org-mouse-map
5283 'help-echo "Radio target link"
5284 'org-linked-text t))
5285 t)))))
5287 (defun org-update-radio-target-regexp ()
5288 "Find all radio targets in this file and update the regular expression."
5289 (interactive)
5290 (when (memq 'radio org-activate-links)
5291 (setq org-target-link-regexp
5292 (org-make-target-link-regexp (org-all-targets 'radio)))
5293 (org-restart-font-lock)))
5295 (defun org-hide-wide-columns (limit)
5296 (let (s e)
5297 (setq s (text-property-any (point) (or limit (point-max))
5298 'org-cwidth t))
5299 (when s
5300 (setq e (next-single-property-change s 'org-cwidth))
5301 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5302 (goto-char e)
5303 t)))
5305 (defvar org-latex-and-specials-regexp nil
5306 "Regular expression for highlighting export special stuff.")
5307 (defvar org-match-substring-regexp)
5308 (defvar org-match-substring-with-braces-regexp)
5309 (defvar org-export-html-special-string-regexps)
5311 (defun org-compute-latex-and-specials-regexp ()
5312 "Compute regular expression for stuff treated specially by exporters."
5313 (if (not org-highlight-latex-fragments-and-specials)
5314 (org-set-local 'org-latex-and-specials-regexp nil)
5315 (let*
5316 ((matchers (plist-get org-format-latex-options :matchers))
5317 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5318 org-latex-regexps)))
5319 (options (org-combine-plists (org-default-export-plist)
5320 (org-infile-export-plist)))
5321 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5322 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5323 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5324 (org-export-html-expand (plist-get options :expand-quoted-html))
5325 (org-export-with-special-strings (plist-get options :special-strings))
5326 (re-sub
5327 (cond
5328 ((equal org-export-with-sub-superscripts '{})
5329 (list org-match-substring-with-braces-regexp))
5330 (org-export-with-sub-superscripts
5331 (list org-match-substring-regexp))
5332 (t nil)))
5333 (re-latex
5334 (if org-export-with-LaTeX-fragments
5335 (mapcar (lambda (x) (nth 1 x)) latexs)))
5336 (re-macros
5337 (if org-export-with-TeX-macros
5339 (regexp-opt
5340 (append (mapcar 'car org-html-entities)
5341 (if (boundp 'org-latex-entities)
5342 org-latex-entities nil))
5343 'words))) ; FIXME
5344 ))
5346 (re-special (if org-export-with-special-strings
5347 (mapcar (lambda (x) (car x))
5348 org-export-html-special-string-regexps)))
5349 (re-rest
5350 (delq nil
5351 (list
5353 ))))
5354 (org-set-local
5355 'org-latex-and-specials-regexp
5356 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5359 (defface org-latex-and-export-specials
5360 (let ((font (cond ((assq :inherit custom-face-attributes)
5361 '(:inherit underline))
5362 (t '(:underline t)))))
5363 `((((class grayscale) (background light))
5364 (:foreground "DimGray" ,@font))
5365 (((class grayscale) (background dark))
5366 (:foreground "LightGray" ,@font))
5367 (((class color) (background light))
5368 (:foreground "SaddleBrown"))
5369 (((class color) (background dark))
5370 (:foreground "burlywood"))
5371 (t (,@font))))
5372 "Face used to highlight math latex and other special exporter stuff."
5373 :group 'org-faces)
5375 (defun org-do-latex-and-special-faces (limit)
5376 "Run through the buffer and add overlays to links."
5377 (when org-latex-and-specials-regexp
5378 (let (rtn d)
5379 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5380 limit t))
5381 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5382 'face))
5383 '(org-code org-verbatim underline)))
5384 (progn
5385 (setq rtn t
5386 d (cond ((member (char-after (1+ (match-beginning 0)))
5387 '(?_ ?^)) 1)
5388 (t 0)))
5389 (font-lock-prepend-text-property
5390 (+ d (match-beginning 0)) (match-end 0)
5391 'face 'org-latex-and-export-specials)
5392 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5393 '(font-lock-multiline t)))))
5394 rtn)))
5396 (defun org-restart-font-lock ()
5397 "Restart font-lock-mode, to force refontification."
5398 (when (and (boundp 'font-lock-mode) font-lock-mode)
5399 (font-lock-mode -1)
5400 (font-lock-mode 1)))
5402 (defun org-all-targets (&optional radio)
5403 "Return a list of all targets in this file.
5404 With optional argument RADIO, only find radio targets."
5405 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5406 rtn)
5407 (save-excursion
5408 (goto-char (point-min))
5409 (while (re-search-forward re nil t)
5410 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5411 rtn)))
5413 (defun org-make-target-link-regexp (targets)
5414 "Make regular expression matching all strings in TARGETS.
5415 The regular expression finds the targets also if there is a line break
5416 between words."
5417 (and targets
5418 (concat
5420 (mapconcat
5421 (lambda (x)
5422 (while (string-match " +" x)
5424 x)
5425 targets
5429 (defun org-activate-tags (limit)
5431 (progn
5432 (add-text-properties (match-beginning 1) (match-end 1)
5433 (list 'mouse-face 'highlight
5434 'rear-nonsticky org-nonsticky-props
5435 'keymap org-mouse-map))
5436 t)))
5438 (defun org-outline-level ()
5439 (save-excursion
5440 (looking-at outline-regexp)
5441 (if (match-beginning 1)
5442 (+ (org-get-string-indentation (match-string 1)) 1000)
5443 (1- (- (match-end 0) (match-beginning 0))))))
5445 (defvar org-font-lock-keywords nil)
5448 "Regular expression matching a property line.")
5450 (defun org-set-font-lock-defaults ()
5451 (let* ((em org-fontify-emphasized-text)
5452 (lk org-activate-links)
5453 (org-font-lock-extra-keywords
5454 (list
5455 ;; Headlines
5457 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5458 ;; Table lines
5460 (1 'org-table t))
5461 ;; Table internals
5465 ;; Drawers
5466 (list org-drawer-regexp '(0 'org-special-keyword t))
5468 ;; Properties
5469 (list org-property-re
5470 '(1 'org-special-keyword t)
5471 '(3 'org-property-value t))
5472 (if org-format-transports-properties-p
5474 ;; Links
5475 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5476 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5477 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5478 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5479 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5480 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5482 '(org-hide-wide-columns (0 nil append))
5483 ;; TODO lines
5485 '(1 (org-get-todo-face 1) t))
5486 ;; DONE
5487 (if org-fontify-done-headline
5491 '(2 'org-headline-done t))
5492 nil)
5493 ;; Priorities
5495 ;; Special keywords
5500 ;; Emphasis
5501 (if em
5502 (if (featurep 'xemacs)
5503 '(org-do-emphasis-faces (0 nil append))
5504 '(org-do-emphasis-faces)))
5505 ;; Checkboxes
5507 2 'bold prepend)
5508 (if org-provide-checkbox-statistics
5510 (0 (org-get-checkbox-statistics-face) t)))
5512 '(1 'org-archived prepend))
5513 ;; Specials
5514 '(org-do-latex-and-special-faces)
5515 ;; Code
5516 '(org-activate-code (1 'org-code t))
5517 ;; COMMENT
5520 '(1 'org-special-keyword t))
5521 '("^#.*" (0 'font-lock-comment-face t))
5522 )))
5523 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5524 ;; Now set the full font-lock-keywords
5525 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5526 (org-set-local 'font-lock-defaults
5527 '(org-font-lock-keywords t nil nil backward-paragraph))
5528 (kill-local-variable 'font-lock-keywords) nil))
5530 (defvar org-m nil)
5531 (defvar org-l nil)
5532 (defvar org-f nil)
5533 (defun org-get-level-face (n)
5534 "Get the right face for match N in font-lock matching of healdines."
5535 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5536 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5537 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5538 (cond
5539 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5540 ((eq n 2) org-f)
5541 (t (if org-level-color-stars-only nil org-f))))
5543 (defun org-get-todo-face (kwd)
5544 "Get the right face for a TODO keyword KWD.
5545 If KWD is a number, get the corresponding match group."
5546 (if (numberp kwd) (setq kwd (match-string kwd)))
5547 (or (cdr (assoc kwd org-todo-keyword-faces))
5548 (and (member kwd org-done-keywords) 'org-done)
5549 'org-todo))
5551 (defun org-unfontify-region (beg end &optional maybe_loudly)
5552 "Remove fontification and activation overlays from links."
5553 (font-lock-default-unfontify-region beg end)
5554 (let* ((buffer-undo-list t)
5555 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5556 (inhibit-modification-hooks t)
5557 deactivate-mark buffer-file-name buffer-file-truename)
5558 (remove-text-properties beg end
5559 '(mouse-face t keymap t org-linked-text t
5560 invisible t intangible t))))
5562 ;;;; Visibility cycling, including org-goto and indirect buffer
5564 ;;; Cycling
5566 (defvar org-cycle-global-status nil)
5567 (make-variable-buffer-local 'org-cycle-global-status)
5568 (defvar org-cycle-subtree-status nil)
5569 (make-variable-buffer-local 'org-cycle-subtree-status)
5571 ;;;###autoload
5572 (defun org-cycle (&optional arg)
5573 "Visibility cycling for Org-mode.
5575 - When this function is called with a prefix argument, rotate the entire
5576 buffer through 3 states (global cycling)
5577 1. OVERVIEW: Show only top-level headlines.
5578 2. CONTENTS: Show all headlines of all levels, but no body text.
5579 3. SHOW ALL: Show everything.
5581 - When point is at the beginning of a headline, rotate the subtree started
5582 by this line through 3 different states (local cycling)
5583 1. FOLDED: Only the main headline is shown.
5584 2. CHILDREN: The main headline and the direct children are shown.
5585 From this state, you can move to one of the children
5586 and zoom in further.
5587 3. SUBTREE: Show the entire subtree, including body text.
5589 - When there is a numeric prefix, go up to a heading with level ARG, do
5590 a `show-subtree' and return to the previous cursor position. If ARG
5591 is negative, go up that many levels.
5593 - When point is not at the beginning of a headline, execute
5594 `indent-relative', like TAB normally does. See the option
5595 `org-cycle-emulate-tab' for details.
5597 - Special case: if point is at the beginning of the buffer and there is
5598 no headline in line 1, this function will act as if called with prefix arg.
5599 But only if also the variable `org-cycle-global-at-bob' is t."
5600 (interactive "P")
5601 (let* ((outline-regexp
5602 (if (and (org-mode-p) org-cycle-include-plain-lists)
5604 outline-regexp))
5605 (bob-special (and org-cycle-global-at-bob (bobp)
5606 (not (looking-at outline-regexp))))
5607 (org-cycle-hook
5608 (if bob-special
5609 (delq 'org-optimize-window-after-visibility-change
5610 (copy-sequence org-cycle-hook))
5611 org-cycle-hook))
5612 (pos (point)))
5614 (if (or bob-special (equal arg '(4)))
5615 ;; special case: use global cycling
5616 (setq arg t))
5618 (cond
5620 ((org-at-table-p 'any)
5621 ;; Enter the table or move to the next field in the table
5622 (or (org-table-recognize-table.el)
5623 (progn
5624 (if arg (org-table-edit-field t)
5625 (org-table-justify-field-maybe)
5626 (call-interactively 'org-table-next-field)))))
5628 ((eq arg t) ;; Global cycling
5630 (cond
5631 ((and (eq last-command this-command)
5632 (eq org-cycle-global-status 'overview))
5633 ;; We just created the overview - now do table of contents
5634 ;; This can be slow in very large buffers, so indicate action
5635 (message "CONTENTS...")
5636 (org-content)
5637 (message "CONTENTS...done")
5638 (setq org-cycle-global-status 'contents)
5639 (run-hook-with-args 'org-cycle-hook 'contents))
5641 ((and (eq last-command this-command)
5642 (eq org-cycle-global-status 'contents))
5643 ;; We just showed the table of contents - now show everything
5644 (show-all)
5645 (message "SHOW ALL")
5646 (setq org-cycle-global-status 'all)
5647 (run-hook-with-args 'org-cycle-hook 'all))
5649 (t
5650 ;; Default action: go to overview
5651 (org-overview)
5652 (message "OVERVIEW")
5653 (setq org-cycle-global-status 'overview)
5654 (run-hook-with-args 'org-cycle-hook 'overview))))
5656 ((and org-drawers org-drawer-regexp
5657 (save-excursion
5658 (beginning-of-line 1)
5659 (looking-at org-drawer-regexp)))
5660 ;; Toggle block visibility
5661 (org-flag-drawer
5662 (not (get-char-property (match-end 0) 'invisible))))
5664 ((integerp arg)
5665 ;; Show-subtree, ARG levels up from here.
5666 (save-excursion
5667 (org-back-to-heading)
5668 (outline-up-heading (if (< arg 0) (- arg)
5669 (- (funcall outline-level) arg)))
5670 (org-show-subtree)))
5672 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5673 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5674 ;; At a heading: rotate between three different views
5675 (org-back-to-heading)
5676 (let ((goal-column 0) eoh eol eos)
5677 ;; First, some boundaries
5678 (save-excursion
5679 (org-back-to-heading)
5680 (save-excursion
5681 (beginning-of-line 2)
5682 (while (and (not (eobp)) ;; this is like `next-line'
5683 (get-char-property (1- (point)) 'invisible))
5684 (beginning-of-line 2)) (setq eol (point)))
5685 (outline-end-of-heading) (setq eoh (point))
5686 (org-end-of-subtree t)
5687 (unless (eobp)
5689 (beginning-of-line 1) ; in case this is an item
5690 )
5691 (setq eos (1- (point))))
5692 ;; Find out what to do next and set `this-command'
5693 (cond
5694 ((= eos eoh)
5695 ;; Nothing is hidden behind this heading
5696 (message "EMPTY ENTRY")
5697 (setq org-cycle-subtree-status nil)
5698 (save-excursion
5699 (goto-char eos)
5700 (outline-next-heading)
5701 (if (org-invisible-p) (org-flag-heading nil))))
5702 ((or (>= eol eos)
5704 ;; Entire subtree is hidden in one line: open it
5705 (org-show-entry)
5706 (show-children)
5707 (message "CHILDREN")
5708 (save-excursion
5709 (goto-char eos)
5710 (outline-next-heading)
5711 (if (org-invisible-p) (org-flag-heading nil)))
5712 (setq org-cycle-subtree-status 'children)
5713 (run-hook-with-args 'org-cycle-hook 'children))
5714 ((and (eq last-command this-command)
5715 (eq org-cycle-subtree-status 'children))
5716 ;; We just showed the children, now show everything.
5717 (org-show-subtree)
5718 (message "SUBTREE")
5719 (setq org-cycle-subtree-status 'subtree)
5720 (run-hook-with-args 'org-cycle-hook 'subtree))
5721 (t
5722 ;; Default action: hide the subtree.
5723 (hide-subtree)
5724 (message "FOLDED")
5725 (setq org-cycle-subtree-status 'folded)
5726 (run-hook-with-args 'org-cycle-hook 'folded)))))
5728 ;; TAB emulation
5729 (buffer-read-only (org-back-to-heading))
5731 ((org-try-cdlatex-tab))
5733 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5734 (or (not (bolp))
5735 (not (looking-at outline-regexp))))
5738 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5740 (or (and (eq org-cycle-emulate-tab 'white)
5741 (= (match-end 0) (point-at-eol)))
5742 (and (eq org-cycle-emulate-tab 'whitestart)
5743 (>= (match-end 0) pos))))
5744 t
5745 (eq org-cycle-emulate-tab t))
5748 ; (point-at-bol) (point))))
5749 ; (progn
5750 ; (beginning-of-line 1)
5754 (t (save-excursion
5755 (org-back-to-heading)
5756 (org-cycle))))))
5758 ;;;###autoload
5759 (defun org-global-cycle (&optional arg)
5760 "Cycle the global visibility. For details see `org-cycle'."
5761 (interactive "P")
5762 (let ((org-cycle-include-plain-lists
5763 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5764 (if (integerp arg)
5765 (progn
5766 (show-all)
5767 (hide-sublevels arg)
5768 (setq org-cycle-global-status 'contents))
5769 (org-cycle '(4)))))
5771 (defun org-overview ()
5772 "Switch to overview mode, shoing only top-level headlines.
5773 Really, this shows all headlines with level equal or greater than the level
5774 of the first headline in the buffer. This is important, because if the
5775 first headline is not level one, then (hide-sublevels 1) gives confusing
5776 results."
5777 (interactive)
5778 (let ((level (save-excursion
5779 (goto-char (point-min))
5780 (if (re-search-forward (concat "^" outline-regexp) nil t)
5781 (progn
5782 (goto-char (match-beginning 0))
5783 (funcall outline-level))))))
5784 (and level (hide-sublevels level))))
5786 (defun org-content (&optional arg)
5787 "Show all headlines in the buffer, like a table of contents.
5788 With numerical argument N, show content up to level N."
5789 (interactive "P")
5790 (save-excursion
5791 ;; Visit all headings and show their offspring
5792 (and (integerp arg) (org-overview))
5793 (goto-char (point-max))
5794 (catch 'exit
5795 (while (and (progn (condition-case nil
5796 (outline-previous-visible-heading 1)
5797 (error (goto-char (point-min))))
5798 t)
5799 (looking-at outline-regexp))
5800 (if (integerp arg)
5801 (show-children (1- arg))
5802 (show-branches))
5803 (if (bobp) (throw 'exit nil))))))
5806 (defun org-optimize-window-after-visibility-change (state)
5807 "Adjust the window after a change in outline visibility.
5808 This function is the default value of the hook `org-cycle-hook'."
5809 (when (get-buffer-window (current-buffer))
5810 (cond
5811 ; ((eq state 'overview) (org-first-headline-recenter 1))
5812 ; ((eq state 'overview) (org-beginning-of-line))
5813 ((eq state 'content) nil)
5814 ((eq state 'all) nil)
5815 ((eq state 'folded) nil)
5816 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5817 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5819 (defun org-compact-display-after-subtree-move ()
5820 (let (beg end)
5821 (save-excursion
5822 (if (org-up-heading-safe)
5823 (progn
5824 (hide-subtree)
5825 (show-entry)
5826 (show-children)
5827 (org-cycle-show-empty-lines 'children)
5828 (org-cycle-hide-drawers 'children))
5829 (org-overview)))))
5831 (defun org-cycle-show-empty-lines (state)
5832 "Show empty lines above all visible headlines.
5833 The region to be covered depends on STATE when called through
5834 `org-cycle-hook'. Lisp program can use t for STATE to get the
5835 entire buffer covered. Note that an empty line is only shown if there
5836 are at least `org-cycle-separator-lines' empty lines before the headeline."
5837 (when (> org-cycle-separator-lines 0)
5838 (save-excursion
5839 (let* ((n org-cycle-separator-lines)
5840 (re (cond
5843 (t (let ((ns (number-to-string (- n 2))))
5846 beg end)
5847 (cond
5848 ((memq state '(overview contents t))
5849 (setq beg (point-min) end (point-max)))
5850 ((memq state '(children folded))
5851 (setq beg (point) end (progn (org-end-of-subtree t t)
5852 (beginning-of-line 2)
5853 (point)))))
5854 (when beg
5855 (goto-char beg)
5856 (while (re-search-forward re end t)
5857 (if (not (get-char-property (match-end 1) 'invisible))
5858 (outline-flag-region
5859 (match-beginning 1) (match-end 1) nil)))))))
5860 ;; Never hide empty lines at the end of the file.
5861 (save-excursion
5862 (goto-char (point-max))
5863 (outline-previous-heading)
5864 (outline-end-of-heading)
5866 (= (match-end 0) (point-max)))
5867 (outline-flag-region (point) (match-end 0) nil))))
5869 (defun org-subtree-end-visible-p ()
5870 "Is the end of the current subtree visible?"
5871 (pos-visible-in-window-p
5872 (save-excursion (org-end-of-subtree t) (point))))
5874 (defun org-first-headline-recenter (&optional N)
5875 "Move cursor to the first headline and recenter the headline.
5876 Optional argument N means, put the headline into the Nth line of the window."
5877 (goto-char (point-min))
5879 (beginning-of-line)
5880 (recenter (prefix-numeric-value N))))
5882 ;;; Org-goto
5884 (defvar org-goto-window-configuration nil)
5885 (defvar org-goto-marker nil)
5886 (defvar org-goto-map
5887 (let ((map (make-sparse-keymap)))
5888 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5889 (while (setq cmd (pop cmds))
5890 (substitute-key-definition cmd cmd map global-map)))
5891 (suppress-keymap map)
5892 (org-defkey map "\C-m" 'org-goto-ret)
5893 (org-defkey map [(return)] 'org-goto-ret)
5894 (org-defkey map [(left)] 'org-goto-left)
5895 (org-defkey map [(right)] 'org-goto-right)
5896 (org-defkey map [(control ?g)] 'org-goto-quit)
5897 (org-defkey map "\C-i" 'org-cycle)
5898 (org-defkey map [(tab)] 'org-cycle)
5899 (org-defkey map [(down)] 'outline-next-visible-heading)
5900 (org-defkey map [(up)] 'outline-previous-visible-heading)
5901 (if org-goto-auto-isearch
5902 (if (fboundp 'define-key-after)
5903 (define-key-after map [t] 'org-goto-local-auto-isearch)
5904 nil)
5905 (org-defkey map "q" 'org-goto-quit)
5906 (org-defkey map "n" 'outline-next-visible-heading)
5907 (org-defkey map "p" 'outline-previous-visible-heading)
5908 (org-defkey map "f" 'outline-forward-same-level)
5909 (org-defkey map "b" 'outline-backward-same-level)
5910 (org-defkey map "u" 'outline-up-heading))
5911 (org-defkey map "/" 'org-occur)
5912 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5913 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5914 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5915 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5916 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5917 map))
5919 (defconst org-goto-help
5920 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5921 RET=jump to location [Q]uit and return to previous location
5922 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5924 (defvar org-goto-start-pos) ; dynamically scoped parameter
5926 (defun org-goto (&optional alternative-interface)
5927 "Look up a different location in the current file, keeping current visibility.
5929 When you want look-up or go to a different location in a document, the
5930 fastest way is often to fold the entire buffer and then dive into the tree.
5931 This method has the disadvantage, that the previous location will be folded,
5932 which may not be what you want.
5934 This command works around this by showing a copy of the current buffer
5935 in an indirect buffer, in overview mode. You can dive into the tree in
5936 that copy, use org-occur and incremental search to find a location.
5937 When pressing RET or `Q', the command returns to the original buffer in
5938 which the visibility is still unchanged. After RET is will also jump to
5939 the location selected in the indirect buffer and expose the
5940 the headline hierarchy above."
5941 (interactive "P")
5942 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
5943 (org-refile-use-outline-path t)
5944 (interface
5945 (if (not alternative-interface)
5946 org-goto-interface
5947 (if (eq org-goto-interface 'outline)
5948 'outline-path-completion
5949 'outline)))
5950 (org-goto-start-pos (point))
5951 (selected-point
5952 (if (eq interface 'outline)
5953 (car (org-get-location (current-buffer) org-goto-help))
5954 (nth 3 (org-refile-get-location "Goto: ")))))
5955 (if selected-point
5956 (progn
5957 (org-mark-ring-push org-goto-start-pos)
5958 (goto-char selected-point)
5959 (if (or (org-invisible-p) (org-invisible-p2))
5960 (org-show-context 'org-goto)))
5961 (message "Quit"))))
5963 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5964 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5965 (defvar org-goto-local-auto-isearch-map) ; defined below
5967 (defun org-get-location (buf help)
5968 "Let the user select a location in the Org-mode buffer BUF.
5969 This function uses a recursive edit. It returns the selected position
5970 or nil."
5971 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5972 (isearch-hide-immediately nil)
5973 (isearch-search-fun-function
5974 (lambda () 'org-goto-local-search-forward-headings))
5975 (org-goto-selected-point org-goto-exit-command))
5976 (save-excursion
5977 (save-window-excursion
5978 (delete-other-windows)
5979 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5980 (switch-to-buffer
5981 (condition-case nil
5982 (make-indirect-buffer (current-buffer) "*org-goto*")
5983 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5984 (with-output-to-temp-buffer "*Help*"
5985 (princ help))
5986 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5987 (setq buffer-read-only nil)
5988 (let ((org-startup-truncated t)
5989 (org-startup-folded nil)
5990 (org-startup-align-all-tables nil))
5991 (org-mode)
5992 (org-overview))
5993 (setq buffer-read-only t)
5994 (if (and (boundp 'org-goto-start-pos)
5995 (integer-or-marker-p org-goto-start-pos))
5996 (let ((org-show-hierarchy-above t)
5997 (org-show-siblings t)
5998 (org-show-following-heading t))
5999 (goto-char org-goto-start-pos)
6000 (and (org-invisible-p) (org-show-context)))
6001 (goto-char (point-min)))
6002 (org-beginning-of-line)
6003 (message "Select location and press RET")
6004 (use-local-map org-goto-map)
6005 (recursive-edit)
6006 ))
6007 (kill-buffer "*org-goto*")
6008 (cons org-goto-selected-point org-goto-exit-command)))
6010 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6011 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6012 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6013 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6015 (defun org-goto-local-search-forward-headings (string bound noerror)
6016 "Search and make sure that anu matches are in headlines."
6017 (catch 'return
6018 (while (search-forward string bound noerror)
6019 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6020 (and (member :headline context)
6021 (not (member :tags context))))
6022 (throw 'return (point))))))
6024 (defun org-goto-local-auto-isearch ()
6025 "Start isearch."
6026 (interactive)
6027 (goto-char (point-min))
6028 (let ((keys (this-command-keys)))
6029 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6030 (isearch-mode t)
6031 (isearch-process-search-char (string-to-char keys)))))
6033 (defun org-goto-ret (&optional arg)
6034 "Finish `org-goto' by going to the new location."
6035 (interactive "P")
6036 (setq org-goto-selected-point (point)
6037 org-goto-exit-command 'return)
6038 (throw 'exit nil))
6040 (defun org-goto-left ()
6041 "Finish `org-goto' by going to the new location."
6042 (interactive)
6043 (if (org-on-heading-p)
6044 (progn
6045 (beginning-of-line 1)
6046 (setq org-goto-selected-point (point)
6047 org-goto-exit-command 'left)
6048 (throw 'exit nil))
6049 (error "Not on a heading")))
6051 (defun org-goto-right ()
6052 "Finish `org-goto' by going to the new location."
6053 (interactive)
6054 (if (org-on-heading-p)
6055 (progn
6056 (setq org-goto-selected-point (point)
6057 org-goto-exit-command 'right)
6058 (throw 'exit nil))
6059 (error "Not on a heading")))
6061 (defun org-goto-quit ()
6062 "Finish `org-goto' without cursor motion."
6063 (interactive)
6064 (setq org-goto-selected-point nil)
6065 (setq org-goto-exit-command 'quit)
6066 (throw 'exit nil))
6068 ;;; Indirect buffer display of subtrees
6070 (defvar org-indirect-dedicated-frame nil
6071 "This is the frame being used for indirect tree display.")
6072 (defvar org-last-indirect-buffer nil)
6074 (defun org-tree-to-indirect-buffer (&optional arg)
6075 "Create indirect buffer and narrow it to current subtree.
6076 With numerical prefix ARG, go up to this level and then take that tree.
6077 If ARG is negative, go up that many levels.
6078 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6079 indirect buffer previously made with this command, to avoid proliferation of
6080 indirect buffers. However, when you call the command with a `C-u' prefix, or
6081 when `org-indirect-buffer-display' is `new-frame', the last buffer
6082 is kept so that you can work with several indirect buffers at the same time.
6083 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6084 requests that a new frame be made for the new buffer, so that the dedicated
6085 frame is not changed."
6086 (interactive "P")
6087 (let ((cbuf (current-buffer))
6088 (cwin (selected-window))
6089 (pos (point))
6090 beg end level heading ibuf)
6091 (save-excursion
6092 (org-back-to-heading t)
6093 (when (numberp arg)
6094 (setq level (org-outline-level))
6095 (if (< arg 0) (setq arg (+ level arg)))
6096 (while (> (setq level (org-outline-level)) arg)
6097 (outline-up-heading 1 t)))
6098 (setq beg (point)
6099 heading (org-get-heading))
6100 (org-end-of-subtree t) (setq end (point)))
6101 (if (and (buffer-live-p org-last-indirect-buffer)
6102 (not (eq org-indirect-buffer-display 'new-frame))
6103 (not arg))
6104 (kill-buffer org-last-indirect-buffer))
6105 (setq ibuf (org-get-indirect-buffer cbuf)
6106 org-last-indirect-buffer ibuf)
6107 (cond
6108 ((or (eq org-indirect-buffer-display 'new-frame)
6109 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6110 (select-frame (make-frame))
6111 (delete-other-windows)
6112 (switch-to-buffer ibuf)
6113 (org-set-frame-title heading))
6114 ((eq org-indirect-buffer-display 'dedicated-frame)
6115 (raise-frame
6116 (select-frame (or (and org-indirect-dedicated-frame
6117 (frame-live-p org-indirect-dedicated-frame)
6118 org-indirect-dedicated-frame)
6119 (setq org-indirect-dedicated-frame (make-frame)))))
6120 (delete-other-windows)
6121 (switch-to-buffer ibuf)
6122 (org-set-frame-title (concat "Indirect: " heading)))
6123 ((eq org-indirect-buffer-display 'current-window)
6124 (switch-to-buffer ibuf))
6125 ((eq org-indirect-buffer-display 'other-window)
6126 (pop-to-buffer ibuf))
6127 (t (error "Invalid value.")))
6128 (if (featurep 'xemacs)
6129 (save-excursion (org-mode) (turn-on-font-lock)))
6130 (narrow-to-region beg end)
6131 (show-all)
6132 (goto-char pos)
6133 (and (window-live-p cwin) (select-window cwin))))
6135 (defun org-get-indirect-buffer (&optional buffer)
6136 (setq buffer (or buffer (current-buffer)))
6137 (let ((n 1) (base (buffer-name buffer)) bname)
6138 (while (buffer-live-p
6139 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6140 (setq n (1+ n)))
6141 (condition-case nil
6142 (make-indirect-buffer buffer bname 'clone)
6143 (error (make-indirect-buffer buffer bname)))))
6145 (defun org-set-frame-title (title)
6146 "Set the title of the current frame to the string TITLE."
6147 ;; FIXME: how to name a single frame in XEmacs???
6148 (unless (featurep 'xemacs)
6149 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6151 ;;;; Structure editing
6153 ;;; Inserting headlines
6155 (defun org-insert-heading (&optional force-heading)
6156 "Insert a new heading or item with same depth at point.
6157 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6158 If point is at the beginning of a headline, insert a sibling before the
6159 current headline. If point is in the middle of a headline, split the headline
6160 at that position and make the rest of the headline part of the sibling below
6161 the current headline."
6162 (interactive "P")
6163 (if (= (buffer-size) 0)
6165 (when (or force-heading (not (org-insert-item)))
6166 (let* ((head (save-excursion
6167 (condition-case nil
6168 (progn
6169 (org-back-to-heading)
6170 (match-string 0))
6171 (error "*"))))
6172 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6173 pos)
6174 (cond
6175 ((and (org-on-heading-p) (bolp)
6176 (or (bobp)
6177 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6178 (open-line (if blank 2 1)))
6179 ((and (bolp)
6180 (or (bobp)
6181 (save-excursion
6182 (backward-char 1) (not (org-invisible-p)))))
6183 nil)
6184 (t (newline (if blank 2 1))))
6185 (insert head) (just-one-space)
6186 (setq pos (point))
6187 (end-of-line 1)
6188 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6189 (run-hooks 'org-insert-heading-hook)))))
6191 (defun org-insert-heading-after-current ()
6192 "Insert a new heading with same level as current, after current subtree."
6193 (interactive)
6194 (org-back-to-heading)
6195 (org-insert-heading)
6196 (org-move-subtree-down)
6197 (end-of-line 1))
6199 (defun org-insert-todo-heading (arg)
6200 "Insert a new heading with the same level and TODO state as current heading.
6201 If the heading has no TODO state, or if the state is DONE, use the first
6202 state (TODO by default). Also with prefix arg, force first state."
6203 (interactive "P")
6204 (when (not (org-insert-item 'checkbox))
6205 (org-insert-heading)
6206 (save-excursion
6207 (org-back-to-heading)
6208 (outline-previous-heading)
6209 (looking-at org-todo-line-regexp))
6210 (if (or arg
6211 (not (match-beginning 2))
6212 (member (match-string 2) org-done-keywords))
6213 (insert (car org-todo-keywords-1) " ")
6214 (insert (match-string 2) " "))))
6216 (defun org-insert-subheading (arg)
6217 "Insert a new subheading and demote it.
6218 Works for outline headings and for plain lists alike."
6219 (interactive "P")
6220 (org-insert-heading arg)
6221 (cond
6222 ((org-on-heading-p) (org-do-demote))
6223 ((org-at-item-p) (org-indent-item 1))))
6225 (defun org-insert-todo-subheading (arg)
6226 "Insert a new subheading with TODO keyword or checkbox and demote it.
6227 Works for outline headings and for plain lists alike."
6228 (interactive "P")
6229 (org-insert-todo-heading arg)
6230 (cond
6231 ((org-on-heading-p) (org-do-demote))
6232 ((org-at-item-p) (org-indent-item 1))))
6234 ;;; Promotion and Demotion
6236 (defun org-promote-subtree ()
6237 "Promote the entire subtree.
6238 See also `org-promote'."
6239 (interactive)
6240 (save-excursion
6241 (org-map-tree 'org-promote))
6242 (org-fix-position-after-promote))
6244 (defun org-demote-subtree ()
6245 "Demote the entire subtree. See `org-demote'.
6246 See also `org-promote'."
6247 (interactive)
6248 (save-excursion
6249 (org-map-tree 'org-demote))
6250 (org-fix-position-after-promote))
6253 (defun org-do-promote ()
6254 "Promote the current heading higher up the tree.
6255 If the region is active in `transient-mark-mode', promote all headings
6256 in the region."
6257 (interactive)
6258 (save-excursion
6259 (if (org-region-active-p)
6260 (org-map-region 'org-promote (region-beginning) (region-end))
6261 (org-promote)))
6262 (org-fix-position-after-promote))
6264 (defun org-do-demote ()
6265 "Demote the current heading lower down the tree.
6266 If the region is active in `transient-mark-mode', demote all headings
6267 in the region."
6268 (interactive)
6269 (save-excursion
6270 (if (org-region-active-p)
6271 (org-map-region 'org-demote (region-beginning) (region-end))
6272 (org-demote)))
6273 (org-fix-position-after-promote))
6275 (defun org-fix-position-after-promote ()
6276 "Make sure that after pro/demotion cursor position is right."
6277 (let ((pos (point)))
6278 (when (save-excursion
6279 (beginning-of-line 1)
6280 (looking-at org-todo-line-regexp)
6281 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6282 (cond ((eobp) (insert " "))
6283 ((eolp) (insert " "))
6284 ((equal (char-after) ?\ ) (forward-char 1))))))
6286 (defun org-reduced-level (l)
6287 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6289 (defun org-get-legal-level (level &optional change)
6290 "Rectify a level change under the influence of `org-odd-levels-only'
6291 LEVEL is a current level, CHANGE is by how much the level should be
6292 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6293 even level numbers will become the next higher odd number."
6294 (if org-odd-levels-only
6295 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6296 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6297 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6298 (max 1 (+ level change))))
6300 (defun org-promote ()
6301 "Promote the current heading higher up the tree.
6302 If the region is active in `transient-mark-mode', promote all headings
6303 in the region."
6304 (org-back-to-heading t)
6305 (let* ((level (save-match-data (funcall outline-level)))
6306 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6307 (diff (abs (- level (length up-head) -1))))
6308 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6309 (replace-match up-head nil t)
6310 ;; Fixup tag positioning
6311 (and org-auto-align-tags (org-set-tags nil t))
6312 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6314 (defun org-demote ()
6315 "Demote the current heading lower down the tree.
6316 If the region is active in `transient-mark-mode', demote all headings
6317 in the region."
6318 (org-back-to-heading t)
6319 (let* ((level (save-match-data (funcall outline-level)))
6320 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6321 (diff (abs (- level (length down-head) -1))))
6322 (replace-match down-head nil t)
6323 ;; Fixup tag positioning
6324 (and org-auto-align-tags (org-set-tags nil t))
6325 (if org-adapt-indentation (org-fixup-indentation diff))))
6327 (defun org-map-tree (fun)
6328 "Call FUN for every heading underneath the current one."
6329 (org-back-to-heading)
6330 (let ((level (funcall outline-level)))
6331 (save-excursion
6332 (funcall fun)
6333 (while (and (progn
6334 (outline-next-heading)
6335 (> (funcall outline-level) level))
6336 (not (eobp)))
6337 (funcall fun)))))
6339 (defun org-map-region (fun beg end)
6340 "Call FUN for every heading between BEG and END."
6341 (let ((org-ignore-region t))
6342 (save-excursion
6343 (setq end (copy-marker end))
6344 (goto-char beg)
6345 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6346 (< (point) end))
6347 (funcall fun))
6348 (while (and (progn
6349 (outline-next-heading)
6350 (< (point) end))
6351 (not (eobp)))
6352 (funcall fun)))))
6354 (defun org-fixup-indentation (diff)
6355 "Change the indentation in the current entry by DIFF
6356 However, if any line in the current entry has no indentation, or if it
6357 would end up with no indentation after the change, nothing at all is done."
6358 (save-excursion
6359 (let ((end (save-excursion (outline-next-heading)
6360 (point-marker)))
6361 (prohibit (if (> diff 0)
6364 col)
6365 (unless (save-excursion (end-of-line 1)
6366 (re-search-forward prohibit end t))
6367 (while (and (< (point) end)
6369 (goto-char (match-end 0))
6370 (setq col (current-column))
6371 (if (< diff 0) (replace-match ""))
6372 (indent-to (+ diff col))))
6373 (move-marker end nil))))
6375 (defun org-convert-to-odd-levels ()
6376 "Convert an org-mode file with all levels allowed to one with odd levels.
6377 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6378 level 5 etc."
6379 (interactive)
6380 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6381 (let ((org-odd-levels-only nil) n)
6382 (save-excursion
6383 (goto-char (point-min))
6385 (setq n (- (length (match-string 0)) 2))
6386 (while (>= (setq n (1- n)) 0)
6387 (org-demote))
6388 (end-of-line 1))))))
6391 (defun org-convert-to-oddeven-levels ()
6392 "Convert an org-mode file with only odd levels to one with odd and even levels.
6393 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6394 section with an even level, conversion would destroy the structure of the file. An error
6395 is signaled in this case."
6396 (interactive)
6397 (goto-char (point-min))
6398 ;; First check if there are no even levels
6400 (org-show-context t)
6401 (error "Not all levels are odd in this file. Conversion not possible."))
6402 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6403 (let ((org-odd-levels-only nil) n)
6404 (save-excursion
6405 (goto-char (point-min))
6407 (setq n (/ (1- (length (match-string 0))) 2))
6408 (while (>= (setq n (1- n)) 0)
6409 (org-promote))
6410 (end-of-line 1))))))
6412 (defun org-tr-level (n)
6413 "Make N odd if required."
6414 (if org-odd-levels-only (1+ (/ n 2)) n))
6416 ;;; Vertical tree motion, cutting and pasting of subtrees
6418 (defun org-move-subtree-up (&optional arg)
6419 "Move the current subtree up past ARG headlines of the same level."
6420 (interactive "p")
6421 (org-move-subtree-down (- (prefix-numeric-value arg))))
6423 (defun org-move-subtree-down (&optional arg)
6424 "Move the current subtree down past ARG headlines of the same level."
6425 (interactive "p")
6426 (setq arg (prefix-numeric-value arg))
6427 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6428 'outline-get-last-sibling))
6429 (ins-point (make-marker))
6430 (cnt (abs arg))
6431 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6432 ;; Select the tree
6433 (org-back-to-heading)
6434 (setq beg0 (point))
6435 (save-excursion
6436 (setq ne-beg (org-back-over-empty-lines))
6437 (setq beg (point)))
6438 (save-match-data
6439 (save-excursion (outline-end-of-heading)
6440 (setq folded (org-invisible-p)))
6441 (outline-end-of-subtree))
6442 (outline-next-heading)
6443 (setq ne-end (org-back-over-empty-lines))
6444 (setq end (point))
6445 (goto-char beg0)
6446 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6447 ;; include less whitespace
6448 (save-excursion
6449 (goto-char beg)
6450 (forward-line (- ne-beg ne-end))
6451 (setq beg (point))))
6452 ;; Find insertion point, with error handling
6453 (while (> cnt 0)
6454 (or (and (funcall movfunc) (looking-at outline-regexp))
6455 (progn (goto-char beg0)
6456 (error "Cannot move past superior level or buffer limit")))
6457 (setq cnt (1- cnt)))
6458 (if (> arg 0)
6459 ;; Moving forward - still need to move over subtree
6460 (progn (org-end-of-subtree t t)
6461 (save-excursion
6462 (org-back-over-empty-lines)
6463 (or (bolp) (newline)))))
6464 (setq ne-ins (org-back-over-empty-lines))
6465 (move-marker ins-point (point))
6466 (setq txt (buffer-substring beg end))
6467 (delete-region beg end)
6468 (outline-flag-region (1- beg) beg nil)
6469 (outline-flag-region (1- (point)) (point) nil)
6470 (insert txt)
6472 (setq ins-end (point))
6473 (goto-char ins-point)
6474 (org-skip-whitespace)
6475 (when (and (< arg 0)
6476 (org-first-sibling-p)
6477 (> ne-ins ne-beg))
6478 ;; Move whitespace back to beginning
6479 (save-excursion
6480 (goto-char ins-end)
6481 (let ((kill-whole-line t))
6482 (kill-line (- ne-ins ne-beg)) (point)))
6484 (move-marker ins-point nil)
6485 (org-compact-display-after-subtree-move)
6486 (unless folded
6487 (org-show-entry)
6488 (show-children)
6489 (org-cycle-hide-drawers 'children))))
6491 (defvar org-subtree-clip ""
6492 "Clipboard for cut and paste of subtrees.
6493 This is actually only a copy of the kill, because we use the normal kill
6494 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6496 (defvar org-subtree-clip-folded nil
6497 "Was the last copied subtree folded?
6498 This is used to fold the tree back after pasting.")
6500 (defun org-cut-subtree (&optional n)
6501 "Cut the current subtree into the clipboard.
6502 With prefix arg N, cut this many sequential subtrees.
6503 This is a short-hand for marking the subtree and then cutting it."
6504 (interactive "p")
6505 (org-copy-subtree n 'cut))
6507 (defun org-copy-subtree (&optional n cut)
6508 "Cut the current subtree into the clipboard.
6509 With prefix arg N, cut this many sequential subtrees.
6510 This is a short-hand for marking the subtree and then copying it.
6511 If CUT is non-nil, actually cut the subtree."
6512 (interactive "p")
6513 (let (beg end folded (beg0 (point)))
6514 (if (interactive-p)
6515 (org-back-to-heading nil) ; take what looks like a subtree
6516 (org-back-to-heading t)) ; take what is really there
6517 (org-back-over-empty-lines)
6518 (setq beg (point))
6520 (save-match-data
6521 (save-excursion (outline-end-of-heading)
6522 (setq folded (org-invisible-p)))
6523 (condition-case nil
6524 (outline-forward-same-level (1- n))
6525 (error nil))
6526 (org-end-of-subtree t t))
6527 (org-back-over-empty-lines)
6528 (setq end (point))
6529 (goto-char beg0)
6530 (when (> end beg)
6531 (setq org-subtree-clip-folded folded)
6532 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6533 (setq org-subtree-clip (current-kill 0))
6534 (message "%s: Subtree(s) with %d characters"
6535 (if cut "Cut" "Copied")
6536 (length org-subtree-clip)))))
6538 (defun org-paste-subtree (&optional level tree)
6539 "Paste the clipboard as a subtree, with modification of headline level.
6540 The entire subtree is promoted or demoted in order to match a new headline
6541 level. By default, the new level is derived from the visible headings
6542 before and after the insertion point, and taken to be the inferior headline
6543 level of the two. So if the previous visible heading is level 3 and the
6544 next is level 4 (or vice versa), level 4 will be used for insertion.
6545 This makes sure that the subtree remains an independent subtree and does
6546 not swallow low level entries.
6548 You can also force a different level, either by using a numeric prefix
6549 argument, or by inserting the heading marker by hand. For example, if the
6554 If optional TREE is given, use this text instead of the kill ring."
6555 (interactive "P")
6556 (unless (org-kill-is-subtree-p tree)
6557 (error "%s"
6558 (substitute-command-keys
6560 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6565 (old-level (if (string-match ^re txt)
6566 (- (match-end 0) (match-beginning 0) 1)
6567 -1))
6568 (force-level (cond (level (prefix-numeric-value level))
6569 ((string-match
6570 ^re_ (buffer-substring (point-at-bol) (point)))
6571 (- (match-end 1) (match-beginning 1)))
6572 (t nil)))
6573 (previous-level (save-excursion
6574 (condition-case nil
6575 (progn
6576 (outline-previous-visible-heading 1)
6577 (if (looking-at re)
6578 (- (match-end 0) (match-beginning 0) 1)
6579 1))
6580 (error 1))))
6581 (next-level (save-excursion
6582 (condition-case nil
6583 (progn
6584 (or (looking-at outline-regexp)
6585 (outline-next-visible-heading 1))
6586 (if (looking-at re)
6587 (- (match-end 0) (match-beginning 0) 1)
6588 1))
6589 (error 1))))
6590 (new-level (or force-level (max previous-level next-level)))
6591 (shift (if (or (= old-level -1)
6592 (= new-level -1)
6593 (= old-level new-level))
6594 0
6595 (- new-level old-level)))
6596 (delta (if (> shift 0) -1 1))
6597 (func (if (> shift 0) 'org-demote 'org-promote))
6598 (org-odd-levels-only nil)
6599 beg end)
6600 ;; Remove the forced level indicator
6601 (if force-level
6602 (delete-region (point-at-bol) (point)))
6603 ;; Paste
6604 (beginning-of-line 1)
6605 (org-back-over-empty-lines) ;; FIXME: correct fix????
6606 (setq beg (point))
6607 (insert-before-markers txt) ;; FIXME: correct fix????
6609 (setq end (point))
6610 (goto-char beg)
6612 (setq beg (point))
6613 ;; Shift if necessary
6614 (unless (= shift 0)
6615 (save-restriction
6616 (narrow-to-region beg end)
6617 (while (not (= shift 0))
6618 (org-map-region func (point-min) (point-max))
6619 (setq shift (+ delta shift)))
6620 (goto-char (point-min))))
6621 (when (interactive-p)
6622 (message "Clipboard pasted as level %d subtree" new-level))
6623 (if (and kill-ring
6624 (eq org-subtree-clip (current-kill 0))
6625 org-subtree-clip-folded)
6626 ;; The tree was folded before it was killed/copied
6627 (hide-subtree))))
6629 (defun org-kill-is-subtree-p (&optional txt)
6630 "Check if the current kill is an outline subtree, or a set of trees.
6631 Returns nil if kill does not start with a headline, or if the first
6632 headline level is not the largest headline level in the tree.
6633 So this will actually accept several entries of equal levels as well,
6634 which is OK for `org-paste-subtree'.
6635 If optional TXT is given, check this string instead of the current kill."
6636 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6637 (start-level (and kill
6640 kill)
6641 (- (match-end 2) (match-beginning 2) 1)))
6642 (re (concat "^" org-outline-regexp))
6643 (start (1+ (match-beginning 2))))
6644 (if (not start-level)
6645 (progn
6646 nil) ;; does not even start with a heading
6647 (catch 'exit
6648 (while (setq start (string-match re kill (1+ start)))
6649 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6650 (throw 'exit nil)))
6651 t))))
6653 (defun org-narrow-to-subtree ()
6654 "Narrow buffer to the current subtree."
6655 (interactive)
6656 (save-excursion
6657 (narrow-to-region
6658 (progn (org-back-to-heading) (point))
6659 (progn (org-end-of-subtree t t) (point)))))
6662 ;;; Outline Sorting
6664 (defun org-sort (with-case)
6665 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6666 Optional argument WITH-CASE means sort case-sensitively."
6667 (interactive "P")
6668 (if (org-at-table-p)
6669 (org-call-with-arg 'org-table-sort-lines with-case)
6670 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6672 (defvar org-priority-regexp) ; defined later in the file
6674 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6675 "Sort entries on a certain level of an outline tree.
6676 If there is an active region, the entries in the region are sorted.
6677 Else, if the cursor is before the first entry, sort the top-level items.
6678 Else, the children of the entry at point are sorted.
6680 Sorting can be alphabetically, numerically, and by date/time as given by
6681 the first time stamp in the entry. The command prompts for the sorting
6682 type unless it has been given to the function through the SORTING-TYPE
6683 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6684 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6685 called with point at the beginning of the record. It must return either
6686 a string or a number that should serve as the sorting key for that record.
6688 Comparing entries ignores case by default. However, with an optional argument
6689 WITH-CASE, the sorting considers case as well."
6690 (interactive "P")
6691 (let ((case-func (if with-case 'identity 'downcase))
6692 start beg end stars re re2
6693 txt what tmp plain-list-p)
6694 ;; Find beginning and end of region to sort
6695 (cond
6696 ((org-region-active-p)
6697 ;; we will sort the region
6698 (setq end (region-end)
6699 what "region")
6700 (goto-char (region-beginning))
6701 (if (not (org-on-heading-p)) (outline-next-heading))
6702 (setq start (point)))
6703 ((org-at-item-p)
6704 ;; we will sort this plain list
6705 (org-beginning-of-item-list) (setq start (point))
6706 (org-end-of-item-list) (setq end (point))
6707 (goto-char start)
6708 (setq plain-list-p t
6709 what "plain list"))
6710 ((or (org-on-heading-p)
6711 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6712 ;; we will sort the children of the current headline
6713 (org-back-to-heading)
6714 (setq start (point)
6715 end (progn (org-end-of-subtree t t)
6716 (org-back-over-empty-lines)
6717 (point))
6718 what "children")
6719 (goto-char start)
6720 (show-subtree)
6721 (outline-next-heading))
6722 (t
6723 ;; we will sort the top-level entries in this file
6724 (goto-char (point-min))
6725 (or (org-on-heading-p) (outline-next-heading))
6726 (setq start (point) end (point-max) what "top-level")
6727 (goto-char start)
6728 (show-all)))
6730 (setq beg (point))
6731 (if (>= beg end) (error "Nothing to sort"))
6733 (unless plain-list-p
6735 (setq stars (match-string 1)
6736 re (concat "^" (regexp-quote stars) " +")
6737 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6738 txt (buffer-substring beg end))
6740 (if (and (not (equal stars "*")) (string-match re2 txt))
6741 (error "Region to sort contains a level above the first entry")))
6743 (unless sorting-type
6744 (message
6745 (if plain-list-p
6746 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6747 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6748 what)
6749 (setq sorting-type (read-char-exclusive))
6751 (and (= (downcase sorting-type) ?f)
6752 (setq getkey-func
6753 (completing-read "Sort using function: "
6754 obarray 'fboundp t nil nil))
6755 (setq getkey-func (intern getkey-func)))
6757 (and (= (downcase sorting-type) ?r)
6758 (setq property
6759 (completing-read "Property: "
6760 (mapcar 'list (org-buffer-property-keys t))
6761 nil t))))
6763 (message "Sorting entries...")
6765 (save-restriction
6766 (narrow-to-region start end)
6768 (let ((dcst (downcase sorting-type))
6769 (now (current-time)))
6770 (sort-subr
6771 (/= dcst sorting-type)
6772 ;; This function moves to the beginning character of the "record" to
6773 ;; be sorted.
6774 (if plain-list-p
6775 (lambda nil
6776 (if (org-at-item-p) t (goto-char (point-max))))
6777 (lambda nil
6778 (if (re-search-forward re nil t)
6779 (goto-char (match-beginning 0))
6780 (goto-char (point-max)))))
6781 ;; This function moves to the last character of the "record" being
6782 ;; sorted.
6783 (if plain-list-p
6784 'org-end-of-item
6785 (lambda nil
6786 (save-match-data
6787 (condition-case nil
6788 (outline-forward-same-level 1)
6789 (error
6790 (goto-char (point-max)))))))
6792 ;; This function returns the value that gets sorted against.
6793 (if plain-list-p
6794 (lambda nil
6796 (cond
6797 ((= dcst ?n)
6798 (string-to-number (buffer-substring (match-end 0)
6799 (point-at-eol))))
6800 ((= dcst ?a)
6801 (buffer-substring (match-end 0) (point-at-eol)))
6802 ((= dcst ?t)
6803 (if (re-search-forward org-ts-regexp
6804 (point-at-eol) t)
6805 (org-time-string-to-time (match-string 0))
6806 now))
6807 ((= dcst ?f)
6808 (if getkey-func
6809 (progn
6810 (setq tmp (funcall getkey-func))
6811 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6812 tmp)
6813 (error "Invalid key function `%s'" getkey-func)))
6814 (t (error "Invalid sorting type `%c'" sorting-type)))))
6815 (lambda nil
6816 (cond
6817 ((= dcst ?n)
6818 (if (looking-at outline-regexp)
6819 (string-to-number (buffer-substring (match-end 0)
6820 (point-at-eol)))
6821 nil))
6822 ((= dcst ?a)
6823 (funcall case-func (buffer-substring (point-at-bol)
6824 (point-at-eol))))
6825 ((= dcst ?t)
6826 (if (re-search-forward org-ts-regexp
6827 (save-excursion
6828 (forward-line 2)
6829 (point)) t)
6830 (org-time-string-to-time (match-string 0))
6831 now))
6832 ((= dcst ?p)
6833 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6834 (string-to-char (match-string 2))
6835 org-default-priority))
6836 ((= dcst ?r)
6837 (or (org-entry-get nil property) ""))
6838 ((= dcst ?f)
6839 (if getkey-func
6840 (progn
6841 (setq tmp (funcall getkey-func))
6842 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6843 tmp)
6844 (error "Invalid key function `%s'" getkey-func)))
6845 (t (error "Invalid sorting type `%c'" sorting-type)))))
6846 nil
6847 (cond
6848 ((= dcst ?a) 'string<)
6849 ((= dcst ?t) 'time-less-p)
6850 (t nil)))))
6851 (message "Sorting entries...done")))
6853 (defun org-do-sort (table what &optional with-case sorting-type)
6854 "Sort TABLE of WHAT according to SORTING-TYPE.
6855 The user will be prompted for the SORTING-TYPE if the call to this
6856 function does not specify it. WHAT is only for the prompt, to indicate
6857 what is being sorted. The sorting key will be extracted from
6858 the car of the elements of the table.
6859 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6860 (unless sorting-type
6861 (message
6862 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6863 what)
6864 (setq sorting-type (read-char-exclusive)))
6865 (let ((dcst (downcase sorting-type))
6866 extractfun comparefun)
6867 ;; Define the appropriate functions
6868 (cond
6869 ((= dcst ?n)
6870 (setq extractfun 'string-to-number
6871 comparefun (if (= dcst sorting-type) '< '>)))
6872 ((= dcst ?a)
6873 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6874 (lambda(x) (downcase (org-sort-remove-invisible x))))
6875 comparefun (if (= dcst sorting-type)
6876 'string<
6877 (lambda (a b) (and (not (string< a b))
6878 (not (string= a b)))))))
6879 ((= dcst ?t)
6880 (setq extractfun
6881 (lambda (x)
6882 (if (string-match org-ts-regexp x)
6883 (time-to-seconds
6884 (org-time-string-to-time (match-string 0 x)))
6885 0))
6886 comparefun (if (= dcst sorting-type) '< '>)))
6887 (t (error "Invalid sorting type `%c'" sorting-type)))
6889 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6890 table)
6891 (lambda (a b) (funcall comparefun (car a) (car b))))))
6893 ;;;; Plain list items, including checkboxes
6895 ;;; Plain list items
6897 (defun org-at-item-p ()
6898 "Is point in a line starting a hand-formatted item?"
6899 (let ((llt org-plain-list-ordered-item-terminator))
6900 (save-excursion
6901 (goto-char (point-at-bol))
6902 (looking-at
6903 (cond
6907 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6909 (defun org-in-item-p ()
6910 "It the cursor inside a plain list item.
6911 Does not have to be the first line."
6912 (save-excursion
6913 (condition-case nil
6914 (progn
6915 (org-beginning-of-item)
6916 (org-at-item-p)
6917 t)
6918 (error nil))))
6920 (defun org-insert-item (&optional checkbox)
6921 "Insert a new item at the current level.
6922 Return t when things worked, nil when we are not in an item."
6923 (when (save-excursion
6924 (condition-case nil
6925 (progn
6926 (org-beginning-of-item)
6927 (org-at-item-p)
6928 (if (org-invisible-p) (error "Invisible item"))
6929 t)
6930 (error nil)))
6931 (let* ((bul (match-string 0))
6933 (match-end 0)))
6934 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6935 pos)
6936 (cond
6937 ((and (org-at-item-p) (<= (point) eow))
6938 ;; before the bullet
6939 (beginning-of-line 1)
6940 (open-line (if blank 2 1)))
6941 ((<= (point) eow)
6942 (beginning-of-line 1))
6943 (t (newline (if blank 2 1))))
6944 (insert bul (if checkbox "[ ]" ""))
6945 (just-one-space)
6946 (setq pos (point))
6947 (end-of-line 1)
6948 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6949 (org-maybe-renumber-ordered-list)
6950 (and checkbox (org-update-checkbox-count-maybe))
6951 t))
6953 ;;; Checkboxes
6955 (defun org-at-item-checkbox-p ()
6956 "Is point at a line starting a plain-list item with a checklet?"
6957 (and (org-at-item-p)
6958 (save-excursion
6959 (goto-char (match-end 0))
6963 (defun org-toggle-checkbox (&optional arg)
6964 "Toggle the checkbox in the current line."
6965 (interactive "P")
6966 (catch 'exit
6967 (let (beg end status (firstnew 'unknown))
6968 (cond
6969 ((org-region-active-p)
6970 (setq beg (region-beginning) end (region-end)))
6971 ((org-on-heading-p)
6972 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6973 ((org-at-item-checkbox-p)
6974 (let ((pos (point)))
6975 (replace-match
6976 (cond (arg "[-]")
6977 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6978 (t "[ ]"))
6979 t t)
6980 (goto-char pos))
6981 (throw 'exit t))
6982 (t (error "Not at a checkbox or heading, and no active region")))
6983 (save-excursion
6984 (goto-char beg)
6985 (while (< (point) end)
6986 (when (org-at-item-checkbox-p)
6987 (setq status (equal (match-string 0) "[X]"))
6988 (when (eq firstnew 'unknown)
6989 (setq firstnew (not status)))
6990 (replace-match
6991 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6992 (beginning-of-line 2)))))
6993 (org-update-checkbox-count-maybe))
6995 (defun org-update-checkbox-count-maybe ()
6996 "Update checkbox statistics unless turned off by user."
6997 (when org-provide-checkbox-statistics
6998 (org-update-checkbox-count)))
7000 (defun org-update-checkbox-count (&optional all)
7001 "Update the checkbox statistics in the current section.
7002 This will find all statistic cookies like [57%] and [6/12] and update them
7003 with the current numbers. With optional prefix argument ALL, do this for
7004 the whole buffer."
7005 (interactive "P")
7006 (debug)
7007 (save-excursion
7008 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7009 (beg (condition-case nil
7010 (progn (outline-back-to-heading) (point))
7011 (error (point-min))))
7012 (end (move-marker (make-marker)
7013 (progn (outline-next-heading) (point))))
7017 beg-cookie end-cookie is-percent c-on c-off lim
7018 eline curr-ind next-ind continue-from startsearch
7019 (cstat 0)
7020 )
7021 (when all
7022 (goto-char (point-min))
7023 (outline-next-heading)
7024 (setq beg (point) end (point-max)))
7025 (goto-char end)
7026 ;; find each statistic cookie
7027 (while (re-search-backward re-find beg t)
7028 (setq beg-cookie (match-beginning 1)
7029 end-cookie (match-end 1)
7030 cstat (+ cstat (if end-cookie 1 0))
7031 startsearch (point-at-eol)
7032 continue-from (point-at-bol)
7033 is-percent (match-beginning 2)
7034 lim (cond
7035 ((org-on-heading-p) (outline-next-heading) (point))
7036 ((org-at-item-p) (org-end-of-item) (point))
7037 (t nil))
7038 c-on 0
7039 c-off 0)
7040 (when lim
7041 ;; find first checkbox for this cookie and gather
7042 ;; statistics from all that are at this indentation level
7043 (goto-char startsearch)
7044 (if (re-search-forward re-box lim t)
7045 (progn
7046 (org-beginning-of-item)
7047 (setq curr-ind (org-get-indentation))
7048 (setq next-ind curr-ind)
7049 (while (= curr-ind next-ind)
7050 (save-excursion (end-of-line) (setq eline (point)))
7051 (if (re-search-forward re-box eline t)
7052 (if (member (match-string 2) '("[ ]" "[-]"))
7053 (setq c-off (1+ c-off))
7054 (setq c-on (1+ c-on))
7055 )
7056 )
7057 (org-end-of-item)
7058 (setq next-ind (org-get-indentation))
7059 )))
7060 (goto-char continue-from)
7061 ;; update cookie
7062 (when end-cookie
7063 (delete-region beg-cookie end-cookie)
7064 (goto-char beg-cookie)
7065 (insert
7066 (if is-percent
7067 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7068 (format "[%d/%d]" c-on (+ c-on c-off)))))
7069 ;; update items checkbox if it has one
7070 (when (org-at-item-p)
7071 (org-beginning-of-item)
7072 (when (and (> (+ c-on c-off) 0)
7073 (re-search-forward re-box (point-at-eol) t))
7074 (setq beg-cookie (match-beginning 2)
7075 end-cookie (match-end 2))
7076 (delete-region beg-cookie end-cookie)
7077 (goto-char beg-cookie)
7078 (cond ((= c-off 0) (insert "[X]"))
7079 ((= c-on 0) (insert "[ ]"))
7080 (t (insert "[-]")))
7081 )))
7082 (goto-char continue-from))
7083 (when (interactive-p)
7084 (message "Checkbox satistics updated %s (%d places)"
7085 (if all "in entire file" "in current outline entry") cstat)))))
7087 (defun org-get-checkbox-statistics-face ()
7088 "Select the face for checkbox statistics.
7089 The face will be `org-done' when all relevant boxes are checked. Otherwise
7090 it will be `org-todo'."
7091 (if (match-end 1)
7092 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7093 (if (and (> (match-end 2) (match-beginning 2))
7094 (equal (match-string 2) (match-string 3)))
7095 'org-done
7096 'org-todo)))
7098 (defun org-get-indentation (&optional line)
7099 "Get the indentation of the current line, interpreting tabs.
7100 When LINE is given, assume it represents a line and compute its indentation."
7101 (if line
7102 (if (string-match "^ *" (org-remove-tabs line))
7103 (match-end 0))
7104 (save-excursion
7105 (beginning-of-line 1)
7107 (current-column))))
7109 (defun org-remove-tabs (s &optional width)
7110 "Replace tabulators in S with spaces.
7111 Assumes that s is a single line, starting in column 0."
7112 (setq width (or width tab-width))
7114 (setq s (replace-match
7115 (make-string
7116 (- (* width (/ (+ (match-beginning 0) width) width))
7117 (match-beginning 0)) ?\ )
7118 t t s)))
7119 s)
7121 (defun org-fix-indentation (line ind)
7122 "Fix indentation in LINE.
7123 IND is a cons cell with target and minimum indentation.
7124 If the current indenation in LINE is smaller than the minimum,
7125 leave it alone. If it is larger than ind, set it to the target."
7126 (let* ((l (org-remove-tabs line))
7127 (i (org-get-indentation l))
7128 (i1 (car ind)) (i2 (cdr ind)))
7129 (if (>= i i2) (setq l (substring line i2)))
7130 (if (> i1 0)
7131 (concat (make-string i1 ?\ ) l)
7132 l)))
7134 (defcustom org-empty-line-terminates-plain-lists nil
7135 "Non-nil means, an empty line ends all plain list levels.
7136 When nil, empty lines are part of the preceeding item."
7137 :group 'org-plain-lists
7138 :type 'boolean)
7140 (defun org-beginning-of-item ()
7141 "Go to the beginning of the current hand-formatted item.
7142 If the cursor is not in an item, throw an error."
7143 (interactive)
7144 (let ((pos (point))
7145 (limit (save-excursion
7146 (condition-case nil
7147 (progn
7148 (org-back-to-heading)
7149 (beginning-of-line 2) (point))
7150 (error (point-min)))))
7151 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7152 ind ind1)
7153 (if (org-at-item-p)
7154 (beginning-of-line 1)
7155 (beginning-of-line 1)
7157 (setq ind (current-column))
7158 (if (catch 'exit
7159 (while t
7160 (beginning-of-line 0)
7161 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7164 (setq ind1 ind-empty)
7166 (setq ind1 (current-column)))
7167 (if (< ind1 ind)
7168 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7169 nil
7170 (goto-char pos)
7171 (error "Not in an item")))))
7173 (defun org-end-of-item ()
7174 "Go to the end of the current hand-formatted item.
7175 If the cursor is not in an item, throw an error."
7176 (interactive)
7177 (let* ((pos (point))
7178 ind1
7179 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7180 (limit (save-excursion (outline-next-heading) (point)))
7181 (ind (save-excursion
7182 (org-beginning-of-item)
7184 (current-column)))
7185 (end (catch 'exit
7186 (while t
7187 (beginning-of-line 2)
7188 (if (eobp) (throw 'exit (point)))
7189 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7191 (setq ind1 ind-empty)
7193 (setq ind1 (current-column)))
7194 (if (<= ind1 ind)
7195 (throw 'exit (point-at-bol)))))))
7196 (if end
7197 (goto-char end)
7198 (goto-char pos)
7199 (error "Not in an item"))))
7201 (defun org-next-item ()
7202 "Move to the beginning of the next item in the current plain list.
7203 Error if not at a plain list, or if this is the last item in the list."
7204 (interactive)
7205 (let (ind ind1 (pos (point)))
7206 (org-beginning-of-item)
7207 (setq ind (org-get-indentation))
7208 (org-end-of-item)
7209 (setq ind1 (org-get-indentation))
7210 (unless (and (org-at-item-p) (= ind ind1))
7211 (goto-char pos)
7212 (error "On last item"))))
7214 (defun org-previous-item ()
7215 "Move to the beginning of the previous item in the current plain list.
7216 Error if not at a plain list, or if this is the first item in the list."
7217 (interactive)
7218 (let (beg ind ind1 (pos (point)))
7219 (org-beginning-of-item)
7220 (setq beg (point))
7221 (setq ind (org-get-indentation))
7222 (goto-char beg)
7223 (catch 'exit
7224 (while t
7225 (beginning-of-line 0)
7227 nil
7228 (if (<= (setq ind1 (org-get-indentation)) ind)
7229 (throw 'exit t)))))
7230 (condition-case nil
7231 (if (or (not (org-at-item-p))
7232 (< ind1 (1- ind)))
7233 (error "")
7234 (org-beginning-of-item))
7235 (error (goto-char pos)
7236 (error "On first item")))))
7238 (defun org-first-list-item-p ()
7239 "Is this heading the item in a plain list?"
7240 (unless (org-at-item-p)
7241 (error "Not at a plain list item"))
7242 (org-beginning-of-item)
7243 (= (point) (save-excursion (org-beginning-of-item-list))))
7245 (defun org-move-item-down ()
7246 "Move the plain list item at point down, i.e. swap with following item.
7247 Subitems (items with larger indentation) are considered part of the item,
7248 so this really moves item trees."
7249 (interactive)
7250 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7251 (org-beginning-of-item)
7252 (setq beg0 (point))
7253 (save-excursion
7254 (setq ne-beg (org-back-over-empty-lines))
7255 (setq beg (point)))
7256 (goto-char beg0)
7257 (setq ind (org-get-indentation))
7258 (org-end-of-item)
7259 (setq end0 (point))
7260 (setq ind1 (org-get-indentation))
7261 (setq ne-end (org-back-over-empty-lines))
7262 (setq end (point))
7263 (goto-char beg0)
7264 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7265 ;; include less whitespace
7266 (save-excursion
7267 (goto-char beg)
7268 (forward-line (- ne-beg ne-end))
7269 (setq beg (point))))
7270 (goto-char end0)
7271 (if (and (org-at-item-p) (= ind ind1))
7272 (progn
7273 (org-end-of-item)
7274 (org-back-over-empty-lines)
7275 (setq txt (buffer-substring beg end))
7276 (save-excursion
7277 (delete-region beg end))
7278 (setq pos (point))
7279 (insert txt)
7280 (goto-char pos) (org-skip-whitespace)
7281 (org-maybe-renumber-ordered-list))
7282 (goto-char pos)
7283 (error "Cannot move this item further down"))))
7285 (defun org-move-item-up (arg)
7286 "Move the plain list item at point up, i.e. swap with previous item.
7287 Subitems (items with larger indentation) are considered part of the item,
7288 so this really moves item trees."
7289 (interactive "p")
7290 (let (beg beg0 end end0 ind ind1 (pos (point)) txt
7291 ne-beg ne-end ne-ins ins-end)
7292 (org-beginning-of-item)
7293 (setq beg0 (point))
7294 (setq ind (org-get-indentation))
7295 (save-excursion
7296 (setq ne-beg (org-back-over-empty-lines))
7297 (setq beg (point)))
7298 (goto-char beg0)
7299 (org-end-of-item)
7300 (setq ne-end (org-back-over-empty-lines))
7301 (setq end (point))
7302 (goto-char beg0)
7303 (catch 'exit
7304 (while t
7305 (beginning-of-line 0)
7307 (if org-empty-line-terminates-plain-lists
7308 (progn
7309 (goto-char pos)
7310 (error "Cannot move this item further up"))
7311 nil)
7312 (if (<= (setq ind1 (org-get-indentation)) ind)
7313 (throw 'exit t)))))
7314 (condition-case nil
7315 (org-beginning-of-item)
7316 (error (goto-char beg)
7317 (error "Cannot move this item further up")))
7318 (setq ind1 (org-get-indentation))
7319 (if (and (org-at-item-p) (= ind ind1))
7320 (progn
7321 (setq ne-ins (org-back-over-empty-lines))
7322 (setq txt (buffer-substring beg end))
7323 (save-excursion
7324 (delete-region beg end))
7325 (setq pos (point))
7326 (insert txt)
7327 (setq ins-end (point))
7328 (goto-char pos) (org-skip-whitespace)
7330 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7331 ;; Move whitespace back to beginning
7332 (save-excursion
7333 (goto-char ins-end)
7334 (let ((kill-whole-line t))
7335 (kill-line (- ne-ins ne-beg)) (point)))
7338 (org-maybe-renumber-ordered-list))
7339 (goto-char pos)
7340 (error "Cannot move this item further up"))))
7342 (defun org-maybe-renumber-ordered-list ()
7343 "Renumber the ordered list at point if setup allows it.
7344 This tests the user option `org-auto-renumber-ordered-lists' before
7345 doing the renumbering."
7346 (interactive)
7347 (when (and org-auto-renumber-ordered-lists
7348 (org-at-item-p))
7349 (if (match-beginning 3)
7350 (org-renumber-ordered-list 1)
7351 (org-fix-bullet-type))))
7353 (defun org-maybe-renumber-ordered-list-safe ()
7354 (condition-case nil
7355 (save-excursion
7356 (org-maybe-renumber-ordered-list))
7357 (error nil)))
7359 (defun org-cycle-list-bullet (&optional which)
7360 "Cycle through the different itemize/enumerate bullets.
7361 This cycle the entire list level through the sequence:
7363 `-' -> `+' -> `*' -> `1.' -> `1)'
7365 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7366 0 meand `-', 1 means `+' etc."
7367 (interactive "P")
7368 (org-preserve-lc
7369 (org-beginning-of-item-list)
7370 (org-at-item-p)
7371 (beginning-of-line 1)
7372 (let ((current (match-string 0))
7373 (prevp (eq which 'previous))
7374 new)
7375 (setq new (cond
7376 ((and (numberp which)
7377 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7378 ((string-match "-" current) (if prevp "1)" "+"))
7383 ((string-match ")" current) (if prevp "1." "-"))
7384 (t (error "This should not happen"))))
7386 (org-fix-bullet-type)
7387 (org-maybe-renumber-ordered-list))))
7389 (defun org-get-string-indentation (s)
7390 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7391 (let ((n -1) (i 0) (w tab-width) c)
7392 (catch 'exit
7393 (while (< (setq n (1+ n)) (length s))
7394 (setq c (aref s n))
7395 (cond ((= c ?\ ) (setq i (1+ i)))
7397 (t (throw 'exit t)))))
7398 i))
7400 (defun org-renumber-ordered-list (arg)
7401 "Renumber an ordered plain list.
7402 Cursor needs to be in the first line of an item, the line that starts
7404 (interactive "p")
7405 (unless (and (org-at-item-p)
7406 (match-beginning 3))
7407 (error "This is not an ordered list"))
7408 (let ((line (org-current-line))
7409 (col (current-column))
7410 (ind (org-get-string-indentation
7411 (buffer-substring (point-at-bol) (match-beginning 3))))
7412 ;; (term (substring (match-string 3) -1))
7413 ind1 (n (1- arg))
7414 fmt)
7415 ;; find where this list begins
7416 (org-beginning-of-item-list)
7418 (setq fmt (concat "%d" (match-string 1)))
7419 (beginning-of-line 0)
7420 ;; walk forward and replace these numbers
7421 (catch 'exit
7422 (while t
7423 (catch 'next
7424 (beginning-of-line 2)
7425 (if (eobp) (throw 'exit nil))
7428 (if (> ind1 ind) (throw 'next t))
7429 (if (< ind1 ind) (throw 'exit t))
7430 (if (not (org-at-item-p)) (throw 'exit nil))
7431 (delete-region (match-beginning 2) (match-end 2))
7432 (goto-char (match-beginning 2))
7433 (insert (format fmt (setq n (1+ n)))))))
7434 (goto-line line)
7435 (move-to-column col)))
7437 (defun org-fix-bullet-type ()
7438 "Make sure all items in this list have the same bullet as the firsst item."
7439 (interactive)
7440 (unless (org-at-item-p) (error "This is not a list"))
7441 (let ((line (org-current-line))
7442 (col (current-column))
7443 (ind (current-indentation))
7444 ind1 bullet)
7445 ;; find where this list begins
7446 (org-beginning-of-item-list)
7447 (beginning-of-line 1)
7448 ;; find out what the bullet type is
7450 (setq bullet (match-string 1))
7451 ;; walk forward and replace these numbers
7452 (beginning-of-line 0)
7453 (catch 'exit
7454 (while t
7455 (catch 'next
7456 (beginning-of-line 2)
7457 (if (eobp) (throw 'exit nil))
7460 (if (> ind1 ind) (throw 'next t))
7461 (if (< ind1 ind) (throw 'exit t))
7462 (if (not (org-at-item-p)) (throw 'exit nil))
7465 (replace-match bullet))))
7466 (goto-line line)
7467 (move-to-column col)
7468 (if (string-match "[0-9]" bullet)
7469 (org-renumber-ordered-list 1))))
7471 (defun org-beginning-of-item-list ()
7472 "Go to the beginning of the current item list.
7473 I.e. to the first item in this list."
7474 (interactive)
7475 (org-beginning-of-item)
7476 (let ((pos (point-at-bol))
7477 (ind (org-get-indentation))
7478 ind1)
7479 ;; find where this list begins
7480 (catch 'exit
7481 (while t
7482 (catch 'next
7483 (beginning-of-line 0)
7485 (throw (if (bobp) 'exit 'next) t))
7487 (if (or (< ind1 ind)
7488 (and (= ind1 ind)
7489 (not (org-at-item-p)))
7490 (bobp))
7491 (throw 'exit t)
7492 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7493 (goto-char pos)))
7496 (defun org-end-of-item-list ()
7497 "Go to the end of the current item list.
7498 I.e. to the text after the last item."
7499 (interactive)
7500 (org-beginning-of-item)
7501 (let ((pos (point-at-bol))
7502 (ind (org-get-indentation))
7503 ind1)
7504 ;; find where this list begins
7505 (catch 'exit
7506 (while t
7507 (catch 'next
7508 (beginning-of-line 2)
7510 (throw (if (eobp) 'exit 'next) t))
7512 (if (or (< ind1 ind)
7513 (and (= ind1 ind)
7514 (not (org-at-item-p)))
7515 (eobp))
7516 (progn
7517 (setq pos (point-at-bol))
7518 (throw 'exit t))))))
7519 (goto-char pos)))
7522 (defvar org-last-indent-begin-marker (make-marker))
7523 (defvar org-last-indent-end-marker (make-marker))
7525 (defun org-outdent-item (arg)
7526 "Outdent a local list item."
7527 (interactive "p")
7528 (org-indent-item (- arg)))
7530 (defun org-indent-item (arg)
7531 "Indent a local list item."
7532 (interactive "p")
7533 (unless (org-at-item-p)
7534 (error "Not on an item"))
7535 (save-excursion
7536 (let (beg end ind ind1 tmp delta ind-down ind-up)
7537 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7538 (setq beg org-last-indent-begin-marker
7539 end org-last-indent-end-marker)
7540 (org-beginning-of-item)
7541 (setq beg (move-marker org-last-indent-begin-marker (point)))
7542 (org-end-of-item)
7543 (setq end (move-marker org-last-indent-end-marker (point))))
7544 (goto-char beg)
7545 (setq tmp (org-item-indent-positions)
7546 ind (car tmp)
7547 ind-down (nth 2 tmp)
7548 ind-up (nth 1 tmp)
7549 delta (if (> arg 0)
7550 (if ind-down (- ind-down ind) 2)
7551 (if ind-up (- ind-up ind) -2)))
7552 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7553 (while (< (point) end)
7554 (beginning-of-line 1)
7556 (delete-region (point-at-bol) (point))
7557 (or (eolp) (indent-to-column (+ ind1 delta)))
7558 (beginning-of-line 2))))
7559 (org-fix-bullet-type)
7560 (org-maybe-renumber-ordered-list-safe)
7561 (save-excursion
7562 (beginning-of-line 0)
7563 (condition-case nil (org-beginning-of-item) (error nil))
7564 (org-maybe-renumber-ordered-list-safe)))
7566 (defun org-item-indent-positions ()
7567 "Return indentation for plain list items.
7568 This returns a list with three values: The current indentation, the
7569 parent indentation and the indentation a child should habe.
7570 Assumes cursor in item line."
7571 (let* ((bolpos (point-at-bol))
7572 (ind (org-get-indentation))
7573 ind-down ind-up pos)
7574 (save-excursion
7575 (org-beginning-of-item-list)
7577 (when (org-in-item-p)
7578 (org-beginning-of-item)
7579 (setq ind-up (org-get-indentation))))
7580 (setq pos (point))
7581 (save-excursion
7582 (cond
7583 ((and (condition-case nil (progn (org-previous-item) t)
7584 (error nil))
7585 (or (forward-char 1) t)
7586 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7587 (setq ind-down (org-get-indentation)))
7588 ((and (goto-char pos)
7589 (org-at-item-p))
7590 (goto-char (match-end 0))
7592 (setq ind-down (current-column)))))
7593 (list ind ind-up ind-down)))
7595 ;;; The orgstruct minor mode
7597 ;; Define a minor mode which can be used in other modes in order to
7598 ;; integrate the org-mode structure editing commands.
7600 ;; This is really a hack, because the org-mode structure commands use
7601 ;; keys which normally belong to the major mode. Here is how it
7602 ;; works: The minor mode defines all the keys necessary to operate the
7603 ;; structure commands, but wraps the commands into a function which
7604 ;; tests if the cursor is currently at a headline or a plain list
7605 ;; item. If that is the case, the structure command is used,
7606 ;; temporarily setting many Org-mode variables like regular
7607 ;; expressions for filling etc. However, when any of those keys is
7608 ;; used at a different location, function uses `key-binding' to look
7609 ;; up if the key has an associated command in another currently active
7610 ;; keymap (minor modes, major mode, global), and executes that
7611 ;; command. There might be problems if any of the keys is otherwise
7612 ;; used as a prefix key.
7614 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7615 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7616 ;; addresses this by checking explicitly for both bindings.
7618 (defvar orgstruct-mode-map (make-sparse-keymap)
7619 "Keymap for the minor `orgstruct-mode'.")
7621 (defvar org-local-vars nil
7622 "List of local variables, for use by `orgstruct-mode'")
7624 ;;;###autoload
7625 (define-minor-mode orgstruct-mode
7626 "Toggle the minor more `orgstruct-mode'.
7627 This mode is for using Org-mode structure commands in other modes.
7628 The following key behave as if Org-mode was active, if the cursor
7629 is on a headline, or on a plain list item (both in the definition
7630 of Org-mode).
7632 M-up Move entry/item up
7633 M-down Move entry/item down
7634 M-left Promote
7635 M-right Demote
7636 M-S-up Move entry/item up
7637 M-S-down Move entry/item down
7638 M-S-left Promote subtree
7639 M-S-right Demote subtree
7640 M-q Fill paragraph and items like in Org-mode
7641 C-c ^ Sort entries
7642 C-c - Cycle list bullet
7643 TAB Cycle item visibility
7644 M-RET Insert new heading/item
7645 S-M-RET Insert new TODO heading / Chekbox item
7646 C-c C-c Set tags / toggle checkbox"
7647 nil " OrgStruct" nil
7648 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7650 ;;;###autoload
7651 (defun turn-on-orgstruct ()
7652 "Unconditionally turn on `orgstruct-mode'."
7653 (orgstruct-mode 1))
7655 ;;;###autoload
7656 (defun turn-on-orgstruct++ ()
7657 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7658 In addition to setting orgstruct-mode, this also exports all indentation and
7659 autofilling variables from org-mode into the buffer. Note that turning
7660 off orgstruct-mode will *not* remove these additional settings."
7661 (orgstruct-mode 1)
7662 (let (var val)
7663 (mapc
7664 (lambda (x)
7665 (when (string-match
7667 (symbol-name (car x)))
7668 (setq var (car x) val (nth 1 x))
7669 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7670 org-local-vars)))
7672 (defun orgstruct-error ()
7673 "Error when there is no default binding for a structure key."
7674 (interactive)
7675 (error "This key has no function outside structure elements"))
7677 (defun orgstruct-setup ()
7678 "Setup orgstruct keymaps."
7679 (let ((nfunc 0)
7680 (bindings
7681 (list
7682 '([(meta up)] org-metaup)
7683 '([(meta down)] org-metadown)
7684 '([(meta left)] org-metaleft)
7685 '([(meta right)] org-metaright)
7686 '([(meta shift up)] org-shiftmetaup)
7687 '([(meta shift down)] org-shiftmetadown)
7688 '([(meta shift left)] org-shiftmetaleft)
7689 '([(meta shift right)] org-shiftmetaright)
7690 '([(shift up)] org-shiftup)
7691 '([(shift down)] org-shiftdown)
7692 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7693 '("\M-q" fill-paragraph)
7694 '("\C-c^" org-sort)
7695 '("\C-c-" org-cycle-list-bullet)))
7696 elt key fun cmd)
7697 (while (setq elt (pop bindings))
7698 (setq nfunc (1+ nfunc))
7699 (setq key (org-key (car elt))
7700 fun (nth 1 elt)
7701 cmd (orgstruct-make-binding fun nfunc key))
7702 (org-defkey orgstruct-mode-map key cmd))
7704 ;; Special treatment needed for TAB and RET
7705 (org-defkey orgstruct-mode-map [(tab)]
7706 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7707 (org-defkey orgstruct-mode-map "\C-i"
7708 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7710 (org-defkey orgstruct-mode-map "\M-\C-m"
7711 (orgstruct-make-binding 'org-insert-heading 105
7712 "\M-\C-m" [(meta return)]))
7713 (org-defkey orgstruct-mode-map [(meta return)]
7714 (orgstruct-make-binding 'org-insert-heading 106
7715 [(meta return)] "\M-\C-m"))
7717 (org-defkey orgstruct-mode-map [(shift meta return)]
7718 (orgstruct-make-binding 'org-insert-todo-heading 107
7719 [(meta return)] "\M-\C-m"))
7721 (unless org-local-vars
7722 (setq org-local-vars (org-get-local-variables)))
7724 t))
7726 (defun orgstruct-make-binding (fun n &rest keys)
7727 "Create a function for binding in the structure minor mode.
7728 FUN is the command to call inside a table. N is used to create a unique
7729 command name. KEYS are keys that should be checked in for a command
7730 to execute outside of tables."
7731 (eval
7732 (list 'defun
7733 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7734 '(arg)
7736 "Outside of structure, run the binding of `"
7737 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7738 "'.")
7739 '(interactive "p")
7740 (list 'if
7741 '(org-context-p 'headline 'item)
7742 (list 'org-run-like-in-org-mode (list 'quote fun))
7743 (list 'let '(orgstruct-mode)
7744 (list 'call-interactively
7745 (append '(or)
7746 (mapcar (lambda (k)
7747 (list 'key-binding k))
7748 keys)
7749 '('orgstruct-error))))))))
7751 (defun org-context-p (&rest contexts)
7752 "Check if local context is and of CONTEXTS.
7753 Possible values in the list of contexts are `table', `headline', and `item'."
7754 (let ((pos (point)))
7755 (goto-char (point-at-bol))
7756 (prog1 (or (and (memq 'table contexts)
7758 (and (memq 'headline contexts)
7760 (and (memq 'item contexts)
7762 (goto-char pos))))
7764 (defun org-get-local-variables ()
7765 "Return a list of all local variables in an org-mode buffer."
7766 (let (varlist)
7767 (with-current-buffer (get-buffer-create "*Org tmp*")
7768 (erase-buffer)
7769 (org-mode)
7770 (setq varlist (buffer-local-variables)))
7771 (kill-buffer "*Org tmp*")
7772 (delq nil
7773 (mapcar
7774 (lambda (x)
7775 (setq x
7776 (if (symbolp x)
7777 (list x)
7778 (list (car x) (list 'quote (cdr x)))))
7779 (if (string-match
7780 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7781 (symbol-name (car x)))
7782 x nil))
7783 varlist))))
7785 ;;;###autoload
7786 (defun org-run-like-in-org-mode (cmd)
7787 (unless org-local-vars
7788 (setq org-local-vars (org-get-local-variables)))
7789 (eval (list 'let org-local-vars
7790 (list 'call-interactively (list 'quote cmd)))))
7792 ;;;; Archiving
7794 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7796 (defun org-archive-subtree (&optional find-done)
7797 "Move the current subtree to the archive.
7798 The archive can be a certain top-level heading in the current file, or in
7799 a different file. The tree will be moved to that location, the subtree
7800 heading be marked DONE, and the current time will be added.
7802 When called with prefix argument FIND-DONE, find whole trees without any
7803 open TODO items and archive them (after getting confirmation from the user).
7804 If the cursor is not at a headline when this comand is called, try all level
7805 1 trees. If the cursor is on a headline, only try the direct children of
7806 this heading."
7807 (interactive "P")
7808 (if find-done
7809 (org-archive-all-done)
7810 ;; Save all relevant TODO keyword-relatex variables
7812 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7813 (tr-org-todo-keywords-1 org-todo-keywords-1)
7814 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7815 (tr-org-done-keywords org-done-keywords)
7816 (tr-org-todo-regexp org-todo-regexp)
7817 (tr-org-todo-line-regexp org-todo-line-regexp)
7818 (tr-org-odd-levels-only org-odd-levels-only)
7819 (this-buffer (current-buffer))
7820 (org-archive-location org-archive-location)
7822 ;; start of variables that will be used for saving context
7823 ;; The compiler complains about them - keep them anyway!
7824 (file (abbreviate-file-name (buffer-file-name)))
7825 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7826 (time (format-time-string
7827 (substring (cdr org-time-stamp-formats) 1 -1)
7828 (current-time)))
7829 afile heading buffer level newfile-p
7830 category todo priority
7831 ;; start of variables that will be used for savind context
7832 ltags itags prop)
7834 ;; Try to find a local archive location
7835 (save-excursion
7836 (save-restriction
7837 (widen)
7838 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7840 (setq org-archive-location prop)
7841 (if (or (re-search-backward re nil t)
7842 (re-search-forward re nil t))
7843 (setq org-archive-location (match-string 1))))))
7846 (progn
7847 (setq afile (format (match-string 1 org-archive-location)
7848 (file-name-nondirectory buffer-file-name))
7849 heading (match-string 2 org-archive-location)))
7850 (error "Invalid `org-archive-location'"))
7851 (if (> (length afile) 0)
7852 (setq newfile-p (not (file-exists-p afile))
7853 buffer (find-file-noselect afile))
7854 (setq buffer (current-buffer)))
7855 (unless buffer
7857 (if (and (> (length heading) 0)
7859 (setq level (match-end 0))
7860 (setq heading nil level 0))
7861 (save-excursion
7862 (org-back-to-heading t)
7863 ;; Get context information that will be lost by moving the tree
7864 (org-refresh-category-properties)
7865 (setq category (org-get-category)
7866 todo (and (looking-at org-todo-line-regexp)
7867 (match-string 2))
7868 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7869 ltags (org-get-tags)
7870 itags (org-delete-all ltags (org-get-tags-at)))
7871 (setq ltags (mapconcat 'identity ltags " ")
7872 itags (mapconcat 'identity itags " "))
7873 ;; We first only copy, in case something goes wrong
7874 ;; we need to protect this-command, to avoid kill-region sets it,
7875 ;; which would lead to duplication of subtrees
7876 (let (this-command) (org-copy-subtree))
7877 (set-buffer buffer)
7878 ;; Enforce org-mode for the archive buffer
7879 (if (not (org-mode-p))
7880 ;; Force the mode for future visits.
7881 (let ((org-insert-mode-line-in-empty-file t)
7882 (org-inhibit-startup t))
7883 (call-interactively 'org-mode)))
7884 (when newfile-p
7885 (goto-char (point-max))
7887 (buffer-file-name this-buffer))))
7888 ;; Force the TODO keywords of the original buffer
7889 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7890 (org-todo-keywords-1 tr-org-todo-keywords-1)
7891 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7892 (org-done-keywords tr-org-done-keywords)
7893 (org-todo-regexp tr-org-todo-regexp)
7894 (org-todo-line-regexp tr-org-todo-line-regexp)
7895 (org-odd-levels-only
7896 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7897 org-odd-levels-only
7898 tr-org-odd-levels-only)))
7899 (goto-char (point-min))
7900 (if heading
7901 (progn
7902 (if (re-search-forward
7903 (concat "^" (regexp-quote heading)
7905 nil t)
7906 (goto-char (match-end 0))
7907 ;; Heading not found, just insert it at the end
7908 (goto-char (point-max))
7911 (end-of-line 0))
7912 ;; Make the subtree visible
7913 (show-subtree)
7914 (org-end-of-subtree t)
7918 ;; No specific heading, just go to end of file.
7920 ;; Paste
7921 (org-paste-subtree (org-get-legal-level level 1))
7923 ;; Mark the entry as done
7924 (when (and org-archive-mark-done
7925 (looking-at org-todo-line-regexp)
7926 (or (not (match-end 2))
7927 (not (member (match-string 2) org-done-keywords))))
7928 (let (org-log-done)
7929 (org-todo
7930 (car (or (member org-archive-mark-done org-done-keywords)
7931 org-done-keywords)))))
7933 ;; Add the context info
7934 (when org-archive-save-context-info
7935 (let ((l org-archive-save-context-info) e n v)
7936 (while (setq e (pop l))
7937 (when (and (setq v (symbol-value e))
7939 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7940 (org-entry-put (point) n v)))))
7942 ;; Save the buffer, if it is not the same buffer.
7943 (if (not (eq this-buffer buffer)) (save-buffer))))
7944 ;; Here we are back in the original buffer. Everything seems to have
7945 ;; worked. So now cut the tree and finish up.
7946 (let (this-command) (org-cut-subtree))
7948 (message "Subtree archived %s"
7949 (if (eq this-buffer buffer)
7950 (concat "under heading: " heading)
7951 (concat "in file: " (abbreviate-file-name afile)))))))
7953 (defun org-refresh-category-properties ()
7954 "Refresh category text properties in teh buffer."
7955 (let ((def-cat (cond
7956 ((null org-category)
7957 (if buffer-file-name
7958 (file-name-sans-extension
7959 (file-name-nondirectory buffer-file-name))
7960 "???"))
7961 ((symbolp org-category) (symbol-name org-category))
7962 (t org-category)))
7963 beg end cat pos optionp)
7964 (org-unmodified
7965 (save-excursion
7966 (save-restriction
7967 (widen)
7968 (goto-char (point-min))
7969 (put-text-property (point) (point-max) 'org-category def-cat)
7970 (while (re-search-forward
7972 (setq pos (match-end 0)
7973 optionp (equal (char-after (match-beginning 0)) ?#)
7974 cat (org-trim (match-string 2)))
7975 (if optionp
7976 (setq beg (point-at-bol) end (point-max))
7977 (org-back-to-heading t)
7978 (setq beg (point) end (org-end-of-subtree t t)))
7979 (put-text-property beg end 'org-category cat)
7980 (goto-char pos)))))))
7982 (defun org-archive-all-done (&optional tag)
7983 "Archive sublevels of the current tree without open TODO items.
7984 If the cursor is not on a headline, try all level 1 trees. If
7985 it is on a headline, try all direct children.
7986 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7988 (rea (concat ".*:" org-archive-tag ":"))
7989 (begm (make-marker))
7990 (endm (make-marker))
7991 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7992 "Move subtree to archive (no open TODO items)? "))
7993 beg end (cntarch 0))
7994 (if (org-on-heading-p)
7995 (progn
7996 (setq re1 (concat "^" (regexp-quote
7997 (make-string
7998 (1+ (- (match-end 0) (match-beginning 0) 1))
7999 ?*))
8000 " "))
8001 (move-marker begm (point))
8002 (move-marker endm (org-end-of-subtree t)))
8003 (setq re1 "^* ")
8004 (move-marker begm (point-min))
8005 (move-marker endm (point-max)))
8006 (save-excursion
8007 (goto-char begm)
8008 (while (re-search-forward re1 endm t)
8009 (setq beg (match-beginning 0)
8010 end (save-excursion (org-end-of-subtree t) (point)))
8011 (goto-char beg)
8012 (if (re-search-forward re end t)
8013 (goto-char end)
8014 (goto-char beg)
8015 (if (and (or (not tag) (not (looking-at rea)))
8016 (y-or-n-p question))
8017 (progn
8018 (if tag
8019 (org-toggle-tag org-archive-tag 'on)
8020 (org-archive-subtree))
8021 (setq cntarch (1+ cntarch)))
8022 (goto-char end)))))
8023 (message "%d trees archived" cntarch)))
8025 (defun org-cycle-hide-drawers (state)
8026 "Re-hide all drawers after a visibility state change."
8027 (when (and (org-mode-p)
8028 (not (memq state '(overview folded))))
8029 (save-excursion
8030 (let* ((globalp (memq state '(contents all)))
8031 (beg (if globalp (point-min) (point)))
8032 (end (if globalp (point-max) (org-end-of-subtree t))))
8033 (goto-char beg)
8034 (while (re-search-forward org-drawer-regexp end t)
8035 (org-flag-drawer t))))))
8037 (defun org-flag-drawer (flag)
8038 (save-excursion
8039 (beginning-of-line 1)
8041 (let ((b (match-end 0))
8042 (outline-regexp org-outline-regexp))
8043 (if (re-search-forward
8045 (save-excursion (outline-next-heading) (point)) t)
8046 (outline-flag-region b (point-at-eol) flag)
8047 (error ":END: line missing"))))))
8049 (defun org-cycle-hide-archived-subtrees (state)
8050 "Re-hide all archived subtrees after a visibility state change."
8051 (when (and (not org-cycle-open-archived-trees)
8052 (not (memq state '(overview folded))))
8053 (save-excursion
8054 (let* ((globalp (memq state '(contents all)))
8055 (beg (if globalp (point-min) (point)))
8056 (end (if globalp (point-max) (org-end-of-subtree t))))
8057 (org-hide-archived-subtrees beg end)
8058 (goto-char beg)
8059 (if (looking-at (concat ".*:" org-archive-tag ":"))
8060 (message "%s" (substitute-command-keys
8061 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8063 (defun org-force-cycle-archived ()
8064 "Cycle subtree even if it is archived."
8065 (interactive)
8066 (setq this-command 'org-cycle)
8067 (let ((org-cycle-open-archived-trees t))
8068 (call-interactively 'org-cycle)))
8070 (defun org-hide-archived-subtrees (beg end)
8071 "Re-hide all archived subtrees after a visibility state change."
8072 (save-excursion
8073 (let* ((re (concat ":" org-archive-tag ":")))
8074 (goto-char beg)
8075 (while (re-search-forward re end t)
8076 (and (org-on-heading-p) (hide-subtree))
8077 (org-end-of-subtree t)))))
8079 (defun org-toggle-tag (tag &optional onoff)
8080 "Toggle the tag TAG for the current line.
8081 If ONOFF is `on' or `off', don't toggle but set to this state."
8082 (unless (org-on-heading-p t) (error "Not on headling"))
8083 (let (res current)
8084 (save-excursion
8085 (beginning-of-line)
8087 (point-at-eol) t)
8088 (progn
8089 (setq current (match-string 1))
8090 (replace-match ""))
8091 (setq current ""))
8092 (setq current (nreverse (org-split-string current ":")))
8093 (cond
8094 ((eq onoff 'on)
8095 (setq res t)
8096 (or (member tag current) (push tag current)))
8097 ((eq onoff 'off)
8098 (or (not (member tag current)) (setq current (delete tag current))))
8099 (t (if (member tag current)
8100 (setq current (delete tag current))
8101 (setq res t)
8102 (push tag current))))
8103 (end-of-line 1)
8104 (if current
8105 (progn
8106 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8107 (org-set-tags nil t))
8108 (delete-horizontal-space))
8109 (run-hooks 'org-after-tags-change-hook))
8110 res))
8112 (defun org-toggle-archive-tag (&optional arg)
8113 "Toggle the archive tag for the current headline.
8114 With prefix ARG, check all children of current headline and offer tagging
8115 the children that do not contain any open TODO items."
8116 (interactive "P")
8117 (if arg
8118 (org-archive-all-done 'tag)
8119 (let (set)
8120 (save-excursion
8121 (org-back-to-heading t)
8122 (setq set (org-toggle-tag org-archive-tag))
8123 (when set (hide-subtree)))
8124 (and set (beginning-of-line 1))
8125 (message "Subtree %s" (if set "archived" "unarchived")))))
8128 ;;;; Tables
8130 ;;; The table editor
8132 ;; Watch out: Here we are talking about two different kind of tables.
8133 ;; Most of the code is for the tables created with the Org-mode table editor.
8134 ;; Sometimes, we talk about tables created and edited with the table.el
8135 ;; Emacs package. We call the former org-type tables, and the latter
8136 ;; table.el-type tables.
8138 (defun org-before-change-function (beg end)
8139 "Every change indicates that a table might need an update."
8140 (setq org-table-may-need-update t))
8143 "Detects an org-type table line.")
8145 "Detects an org-type table line.")
8147 "Detects a table line marked for automatic recalculation.")
8149 "Detects a table line marked for automatic recalculation.")
8151 "Detects a table line marked for automatic recalculation.")
8153 "Detects an org-type table hline.")
8155 "Detects a table-type table hline.")
8157 "Detects an org-type or table-type table.")
8159 "Searching from within a table (any type) this finds the first line
8160 outside the table.")
8162 "Searching from within a table (any type) this finds the first line
8163 outside the table.")
8165 (defvar org-table-last-highlighted-reference nil)
8166 (defvar org-table-formula-history nil)
8168 (defvar org-table-column-names nil
8169 "Alist with column names, derived from the `!' line.")
8170 (defvar org-table-column-name-regexp nil
8171 "Regular expression matching the current column names.")
8172 (defvar org-table-local-parameters nil
8173 "Alist with parameter names, derived from the `$' line.")
8174 (defvar org-table-named-field-locations nil
8175 "Alist with locations of named fields.")
8177 (defvar org-table-current-line-types nil
8178 "Table row types, non-nil only for the duration of a comand.")
8179 (defvar org-table-current-begin-line nil
8180 "Table begin line, non-nil only for the duration of a comand.")
8181 (defvar org-table-current-begin-pos nil
8182 "Table begin position, non-nil only for the duration of a comand.")
8183 (defvar org-table-dlines nil
8184 "Vector of data line line numbers in the current table.")
8185 (defvar org-table-hlines nil
8186 "Vector of hline line numbers in the current table.")
8188 (defconst org-table-range-regexp
8189 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8190 ;; 1 2 3 4 5
8191 "Regular expression for matching ranges in formulas.")
8193 (defconst org-table-range-regexp2
8194 (concat
8198 "Match a range for reference display.")
8200 (defconst org-table-translate-regexp
8202 "Match a reference that needs translation, for reference display.")
8204 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8206 (defun org-table-create-with-table.el ()
8207 "Use the table.el package to insert a new table.
8208 If there is already a table at point, convert between Org-mode tables
8209 and table.el tables."
8210 (interactive)
8211 (require 'table)
8212 (cond
8213 ((org-at-table.el-p)
8214 (if (y-or-n-p "Convert table to Org-mode table? ")
8215 (org-table-convert)))
8216 ((org-at-table-p)
8217 (if (y-or-n-p "Convert table to table.el table? ")
8218 (org-table-convert)))
8219 (t (call-interactively 'table-insert))))
8221 (defun org-table-create-or-convert-from-region (arg)
8222 "Convert region to table, or create an empty table.
8223 If there is an active region, convert it to a table, using the function
8224 `org-table-convert-region'. See the documentation of that function
8225 to learn how the prefix argument is interpreted to determine the field
8226 separator.
8227 If there is no such region, create an empty table with `org-table-create'."
8228 (interactive "P")
8229 (if (org-region-active-p)
8230 (org-table-convert-region (region-beginning) (region-end) arg)
8231 (org-table-create arg)))
8233 (defun org-table-create (&optional size)
8234 "Query for a size and insert a table skeleton.
8236 (interactive "P")
8237 (unless size
8238 (setq size (read-string
8239 (concat "Table size Columns x Rows [e.g. "
8240 org-table-default-size "]: ")
8241 "" nil org-table-default-size)))
8243 (let* ((pos (point))
8244 (indent (make-string (current-column) ?\ ))
8245 (split (org-split-string size " *x *"))
8246 (rows (string-to-number (nth 1 split)))
8247 (columns (string-to-number (car split)))
8248 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8251 (point-at-bol) (point)))
8252 (beginning-of-line 1)
8253 (newline))
8254 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8255 (dotimes (i rows) (insert line))
8256 (goto-char pos)
8257 (if (> rows 1)
8258 ;; Insert a hline after the first row.
8259 (progn
8260 (end-of-line 1)
8262 (goto-char pos)))
8263 (org-table-align)))
8265 (defun org-table-convert-region (beg0 end0 &optional separator)
8266 "Convert region to a table.
8267 The region goes from BEG0 to END0, but these borders will be moved
8268 slightly, to make sure a beginning of line in the first line is included.
8270 SEPARATOR specifies the field separator in the lines. It can have the
8271 following values:
8273 '(4) Use the comma as a field separator
8274 '(16) Use a TAB as field separator
8275 integer When a number, use that many spaces as field separator
8276 nil When nil, the command tries to be smart and figure out the
8277 separator in the following way:
8278 - when each line contains a TAB, assume TAB-separated material
8279 - when each line contains a comme, assume CSV material
8280 - else, assume one or more SPACE charcters as separator."
8281 (interactive "rP")
8282 (let* ((beg (min beg0 end0))
8283 (end (max beg0 end0))
8284 re)
8285 (goto-char beg)
8286 (beginning-of-line 1)
8287 (setq beg (move-marker (make-marker) (point)))
8288 (goto-char end)
8289 (if (bolp) (backward-char 1) (end-of-line 1))
8290 (setq end (move-marker (make-marker) (point)))
8291 ;; Get the right field separator
8292 (unless separator
8293 (goto-char beg)
8294 (setq separator
8295 (cond
8298 (t 1))))
8299 (setq re (cond
8302 ((integerp separator)
8304 (t (error "This should not happen"))))
8305 (goto-char beg)
8306 (while (re-search-forward re end t)
8307 (replace-match "| " t t))
8308 (goto-char beg)
8309 (insert " ")
8310 (org-table-align)))
8312 (defun org-table-import (file arg)
8313 "Import FILE as a table.
8314 The file is assumed to be tab-separated. Such files can be produced by most
8315 spreadsheet and database applications. If no tabs (at least one per line)
8316 are found, lines will be split on whitespace into fields."
8318 (or (bolp) (newline))
8319 (let ((beg (point))
8320 (pm (point-max)))
8321 (insert-file-contents file)
8322 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8324 (defun org-table-export ()
8325 "Export table as a tab-separated file.
8326 Such a file can be imported into a spreadsheet program like Excel."
8327 (interactive)
8328 (let* ((beg (org-table-begin))
8329 (end (org-table-end))
8330 (table (buffer-substring beg end))
8331 (file (read-file-name "Export table to: "))
8332 buf)
8333 (unless (or (not (file-exists-p file))
8334 (y-or-n-p (format "Overwrite file %s? " file)))
8335 (error "Abort"))
8336 (with-current-buffer (find-file-noselect file)
8337 (setq buf (current-buffer))
8338 (erase-buffer)
8339 (fundamental-mode)
8340 (insert table)
8341 (goto-char (point-min))
8343 (replace-match "" t t)
8344 (end-of-line 1))
8345 (goto-char (point-min))
8347 (replace-match "" t t)
8348 (goto-char (min (1+ (point)) (point-max))))
8349 (goto-char (point-min))
8350 (while (re-search-forward "^-[-+]*$" nil t)
8351 (replace-match "")
8353 (delete-char 1)))
8354 (goto-char (point-min))
8357 (save-buffer))
8358 (kill-buffer buf)))
8360 (defvar org-table-aligned-begin-marker (make-marker)
8361 "Marker at the beginning of the table last aligned.
8362 Used to check if cursor still is in that table, to minimize realignment.")
8363 (defvar org-table-aligned-end-marker (make-marker)
8364 "Marker at the end of the table last aligned.
8365 Used to check if cursor still is in that table, to minimize realignment.")
8366 (defvar org-table-last-alignment nil
8367 "List of flags for flushright alignment, from the last re-alignment.
8368 This is being used to correctly align a single field after TAB or RET.")
8369 (defvar org-table-last-column-widths nil
8370 "List of max width of fields in each column.
8371 This is being used to correctly align a single field after TAB or RET.")
8372 (defvar org-table-overlay-coordinates nil
8373 "Overlay coordinates after each align of a table.")
8374 (make-variable-buffer-local 'org-table-overlay-coordinates)
8376 (defvar org-last-recalc-line nil)
8377 (defconst org-narrow-column-arrow "=>"
8378 "Used as display property in narrowed table columns.")
8380 (defun org-table-align ()
8381 "Align the table at point by aligning all vertical bars."
8382 (interactive)
8383 (let* (
8384 ;; Limits of table
8385 (beg (org-table-begin))
8386 (end (org-table-end))
8387 ;; Current cursor position
8388 (linepos (org-current-line))
8389 (colpos (org-table-current-column))
8390 (winstart (window-start))
8391 (winstartline (org-current-line (min winstart (1- (point-max)))))
8392 lines (new "") lengths l typenums ty fields maxfields i
8393 column
8394 (indent "") cnt frac
8395 rfmt hfmt
8396 (spaces '(1 . 1))
8397 (sp1 (car spaces))
8398 (sp2 (cdr spaces))
8399 (rfmt1 (concat
8400 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8401 (hfmt1 (concat
8402 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8403 emptystrings links dates emph narrow fmax f1 len c e)
8404 (untabify beg end)
8405 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8406 ;; Check if we have links or dates
8407 (goto-char beg)
8408 (setq links (re-search-forward org-bracket-link-regexp end t))
8409 (goto-char beg)
8410 (setq emph (and org-hide-emphasis-markers
8411 (re-search-forward org-emph-re end t)))
8412 (goto-char beg)
8413 (setq dates (and org-display-custom-times
8414 (re-search-forward org-ts-regexp-both end t)))
8415 ;; Make sure the link properties are right
8416 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8417 ;; Make sure the date properties are right
8418 (when dates (goto-char beg) (while (org-activate-dates end)))
8419 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8421 ;; Check if we are narrowing any columns
8422 (goto-char beg)
8423 (setq narrow (and org-format-transports-properties-p
8424 (re-search-forward "<[0-9]+>" end t)))
8425 ;; Get the rows
8426 (setq lines (org-split-string
8428 ;; Store the indentation of the first line
8429 (if (string-match "^ *" (car lines))
8430 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8431 ;; Mark the hlines by setting the corresponding element to nil
8432 ;; At the same time, we remove trailing space.
8433 (setq lines (mapcar (lambda (l)
8434 (if (string-match "^ *|-" l)
8435 nil
8437 (substring l 0 (match-beginning 0))
8438 l)))
8439 lines))
8440 ;; Get the data fields by splitting the lines.
8441 (setq fields (mapcar
8442 (lambda (l)
8443 (org-split-string l " *| *"))
8444 (delq nil (copy-sequence lines))))
8445 ;; How many fields in the longest line?
8446 (condition-case nil
8447 (setq maxfields (apply 'max (mapcar 'length fields)))
8448 (error
8449 (kill-region beg end)
8450 (org-table-create org-table-default-size)
8451 (error "Empty table - created default table")))
8452 ;; A list of empty strings to fill any short rows on output
8453 (setq emptystrings (make-list maxfields ""))
8454 ;; Check for special formatting.
8455 (setq i -1)
8456 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8457 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8458 ;; Check if there is an explicit width specified
8459 (when narrow
8460 (setq c column fmax nil)
8461 (while c
8462 (setq e (pop c))
8464 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8465 ;; Find fields that are wider than fmax, and shorten them
8466 (when fmax
8467 (loop for xx in column do
8468 (when (and (stringp xx)
8469 (> (org-string-width xx) fmax))
8470 (org-add-props xx nil
8471 'help-echo
8472 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8473 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8474 (unless (> f1 1)
8476 (match-string 0 xx)))
8477 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8478 (add-text-properties (- f1 2) f1
8479 (list 'display org-narrow-column-arrow)
8480 xx)))))
8481 ;; Get the maximum width for each column
8482 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8483 ;; Get the fraction of numbers, to decide about alignment of the column
8484 (setq cnt 0 frac 0.0)
8485 (loop for x in column do
8486 (if (equal x "")
8487 nil
8488 (setq frac ( / (+ (* frac cnt)
8489 (if (string-match org-table-number-regexp x) 1 0))
8490 (setq cnt (1+ cnt))))))
8491 (push (>= frac org-table-number-fraction) typenums))
8492 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8494 ;; Store the alignment of this table, for later editing of single fields
8495 (setq org-table-last-alignment typenums
8496 org-table-last-column-widths lengths)
8498 ;; With invisible characters, `format' does not get the field width right
8499 ;; So we need to make these fields wide by hand.
8500 (when (or links emph)
8501 (loop for i from 0 upto (1- maxfields) do
8502 (setq len (nth i lengths))
8503 (loop for j from 0 upto (1- (length fields)) do
8504 (setq c (nthcdr i (car (nthcdr j fields))))
8505 (if (and (stringp (car c))
8506 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8507 ; (string-match org-bracket-link-regexp (car c))
8508 (< (org-string-width (car c)) len))
8509 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8511 ;; Compute the formats needed for output of the table
8512 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8513 (while (setq l (pop lengths))
8514 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8515 (setq rfmt (concat rfmt (format rfmt1 ty l))
8516 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8520 (setq new (mapconcat
8521 (lambda (l)
8522 (if l (apply 'format rfmt
8523 (append (pop fields) emptystrings))
8524 hfmt))
8525 lines ""))
8526 ;; Replace the old one
8527 (delete-region beg end)
8528 (move-marker end nil)
8529 (move-marker org-table-aligned-begin-marker (point))
8530 (insert new)
8531 (move-marker org-table-aligned-end-marker (point))
8532 (when (and orgtbl-mode (not (org-mode-p)))
8533 (goto-char org-table-aligned-begin-marker)
8534 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8535 ;; Try to move to the old location
8536 (goto-line winstartline)
8537 (setq winstart (point-at-bol))
8538 (goto-line linepos)
8539 (set-window-start (selected-window) winstart 'noforce)
8540 (org-table-goto-column colpos)
8541 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8542 (setq org-table-may-need-update nil)
8543 ))
8545 (defun org-string-width (s)
8546 "Compute width of string, ignoring invisible characters.
8547 This ignores character with invisibility property `org-link', and also
8548 characters with property `org-cwidth', because these will become invisible
8549 upon the next fontification round."
8550 (let (b l)
8551 (when (or (eq t buffer-invisibility-spec)
8552 (assq 'org-link buffer-invisibility-spec))
8553 (while (setq b (text-property-any 0 (length s)
8554 'invisible 'org-link s))
8555 (setq s (concat (substring s 0 b)
8556 (substring s (or (next-single-property-change
8557 b 'invisible s) (length s)))))))
8558 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8559 (setq s (concat (substring s 0 b)
8560 (substring s (or (next-single-property-change
8561 b 'org-cwidth s) (length s))))))
8562 (setq l (string-width s) b -1)
8563 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8564 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8565 l))
8567 (defun org-table-begin (&optional table-type)
8568 "Find the beginning of the table and return its position.
8569 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8570 (save-excursion
8571 (if (not (re-search-backward
8572 (if table-type org-table-any-border-regexp
8573 org-table-border-regexp)
8574 nil t))
8575 (progn (goto-char (point-min)) (point))
8576 (goto-char (match-beginning 0))
8577 (beginning-of-line 2)
8578 (point))))
8580 (defun org-table-end (&optional table-type)
8581 "Find the end of the table and return its position.
8582 With argument TABLE-TYPE, go to the end of a table.el-type table."
8583 (save-excursion
8584 (if (not (re-search-forward
8585 (if table-type org-table-any-border-regexp
8586 org-table-border-regexp)
8587 nil t))
8588 (goto-char (point-max))
8589 (goto-char (match-beginning 0)))
8590 (point-marker)))
8592 (defun org-table-justify-field-maybe (&optional new)
8593 "Justify the current field, text to left, number to right.
8594 Optional argument NEW may specify text to replace the current field content."
8595 (cond
8596 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8597 ((org-at-table-hline-p))
8598 ((and (not new)
8599 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8600 (current-buffer)))
8601 (< (point) org-table-aligned-begin-marker)
8602 (>= (point) org-table-aligned-end-marker)))
8603 ;; This is not the same table, force a full re-align
8604 (setq org-table-may-need-update t))
8605 (t ;; realign the current field, based on previous full realign
8606 (let* ((pos (point)) s
8607 (col (org-table-current-column))
8608 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8609 l f n o e)
8610 (when (> col 0)
8613 (progn
8614 (setq s (match-string 1)
8615 o (match-string 0)
8616 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8617 e (not (= (match-beginning 2) (match-end 2))))
8618 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8619 l (if e "|" (setq org-table-may-need-update t) ""))
8620 n (format f s))
8621 (if new
8622 (if (<= (length new) l) ;; FIXME: length -> str-width?
8623 (setq n (format f new))
8624 (setq n (concat new "|") org-table-may-need-update t)))
8625 (or (equal n o)
8626 (let (org-table-may-need-update)
8627 (replace-match n t t))))
8628 (setq org-table-may-need-update t))
8629 (goto-char pos))))))
8631 (defun org-table-next-field ()
8632 "Go to the next field in the current table, creating new lines as needed.
8633 Before doing so, re-align the table if necessary."
8634 (interactive)
8635 (org-table-maybe-eval-formula)
8636 (org-table-maybe-recalculate-line)
8637 (if (and org-table-automatic-realign
8638 org-table-may-need-update)
8639 (org-table-align))
8640 (let ((end (org-table-end)))
8641 (if (org-at-table-hline-p)
8642 (end-of-line 1))
8643 (condition-case nil
8644 (progn
8645 (re-search-forward "|" end)
8647 (re-search-forward "|" end))
8648 (if (and (looking-at "-")
8649 org-table-tab-jumps-over-hlines
8651 (goto-char (match-beginning 1)))
8652 (if (looking-at "-")
8653 (progn
8654 (beginning-of-line 0)
8655 (org-table-insert-row 'below))
8656 (if (looking-at " ") (forward-char 1))))
8657 (error
8658 (org-table-insert-row 'below)))))
8660 (defun org-table-previous-field ()
8661 "Go to the previous field in the table.
8662 Before doing so, re-align the table if necessary."
8663 (interactive)
8664 (org-table-justify-field-maybe)
8665 (org-table-maybe-recalculate-line)
8666 (if (and org-table-automatic-realign
8667 org-table-may-need-update)
8668 (org-table-align))
8669 (if (org-at-table-hline-p)
8670 (end-of-line 1))
8671 (re-search-backward "|" (org-table-begin))
8672 (re-search-backward "|" (org-table-begin))
8674 (re-search-backward "|" (org-table-begin)))
8675 (if (looking-at "| ?")
8676 (goto-char (match-end 0))))
8678 (defun org-table-next-row ()
8679 "Go to the next row (same column) in the current table.
8680 Before doing so, re-align the table if necessary."
8681 (interactive)
8682 (org-table-maybe-eval-formula)
8683 (org-table-maybe-recalculate-line)
8686 (newline)
8687 (if (and org-table-automatic-realign
8688 org-table-may-need-update)
8689 (org-table-align))
8690 (let ((col (org-table-current-column)))
8691 (beginning-of-line 2)
8692 (if (or (not (org-at-table-p))
8693 (org-at-table-hline-p))
8694 (progn
8695 (beginning-of-line 0)
8696 (org-table-insert-row 'below)))
8697 (org-table-goto-column col)
8699 (if (looking-at " ") (forward-char 1)))))
8701 (defun org-table-copy-down (n)
8702 "Copy a field down in the current column.
8703 If the field at the cursor is empty, copy into it the content of the nearest
8704 non-empty field above. With argument N, use the Nth non-empty field.
8705 If the current field is not empty, it is copied down to the next row, and
8706 the cursor is moved with it. Therefore, repeating this command causes the
8707 column to be filled row-by-row.
8708 If the variable `org-table-copy-increment' is non-nil and the field is an
8709 integer or a timestamp, it will be incremented while copying. In the case of
8710 a timestamp, if the cursor is on the year, change the year. If it is on the
8711 month or the day, change that. Point will stay on the current date field
8712 in order to easily repeat the interval."
8713 (interactive "p")
8714 (let* ((colpos (org-table-current-column))
8715 (col (current-column))
8716 (field (org-table-get-field))
8718 (beg (org-table-begin))
8719 txt)
8720 (org-table-check-inside-data-field)
8721 (if non-empty
8722 (progn
8723 (setq txt (org-trim field))
8724 (org-table-next-row)
8725 (org-table-blank-field))
8726 (save-excursion
8727 (setq txt
8728 (catch 'exit
8729 (while (progn (beginning-of-line 1)
8730 (re-search-backward org-table-dataline-regexp
8731 beg t))
8732 (org-table-goto-column colpos t)
8733 (if (and (looking-at
8735 (= (setq n (1- n)) 0))
8736 (throw 'exit (match-string 1))))))))
8737 (if txt
8738 (progn
8739 (if (and org-table-copy-increment
8740 (string-match "^[0-9]+$" txt))
8741 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8742 (insert txt)
8743 (move-to-column col)
8744 (if (and org-table-copy-increment (org-at-timestamp-p t))
8745 (org-timestamp-up 1)
8746 (org-table-maybe-recalculate-line))
8747 (org-table-align)
8748 (move-to-column col))
8749 (error "No non-empty field found"))))
8751 (defun org-table-check-inside-data-field ()
8752 "Is point inside a table data field?
8753 I.e. not on a hline or before the first or after the last column?
8754 This actually throws an error, so it aborts the current command."
8755 (if (or (not (org-at-table-p))
8756 (= (org-table-current-column) 0)
8757 (org-at-table-hline-p)
8759 (error "Not in table data field")))
8761 (defvar org-table-clip nil
8762 "Clipboard for table regions.")
8764 (defun org-table-blank-field ()
8765 "Blank the current table field or active region."
8766 (interactive)
8767 (org-table-check-inside-data-field)
8768 (if (and (interactive-p) (org-region-active-p))
8769 (let (org-table-clip)
8770 (org-table-cut-region (region-beginning) (region-end)))
8771 (skip-chars-backward "^|")
8772 (backward-char 1)
8774 (let* ((pos (match-beginning 0))
8775 (match (match-string 0))
8776 (len (org-string-width match)))
8777 (replace-match (concat "|" (make-string (1- len) ?\ )))
8778 (goto-char (+ 2 pos))
8779 (substring match 1)))))
8781 (defun org-table-get-field (&optional n replace)
8782 "Return the value of the field in column N of current row.
8783 N defaults to current field.
8784 If REPLACE is a string, replace field with this value. The return value
8785 is always the old value."
8786 (and n (org-table-goto-column n))
8788 (backward-char 1)
8790 (let* ((pos (match-beginning 0))
8791 (val (buffer-substring (1+ pos) (match-end 0))))
8792 (if replace
8793 (replace-match (concat "|" replace) t t))
8794 (goto-char (min (point-at-eol) (+ 2 pos)))
8795 val)
8796 (forward-char 1) ""))
8798 (defun org-table-field-info (arg)
8799 "Show info about the current field, and highlight any reference at point."
8800 (interactive "P")
8801 (org-table-get-specials)
8802 (save-excursion
8803 (let* ((pos (point))
8804 (col (org-table-current-column))
8805 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8806 (name (car (rassoc (list (org-current-line) col)
8807 org-table-named-field-locations)))
8808 (eql (org-table-get-stored-formulas))
8809 (dline (org-table-current-dline))
8810 (ref (format "@%d$%d" dline col))
8811 (ref1 (org-table-convert-refs-to-an ref))
8812 (fequation (or (assoc name eql) (assoc ref eql)))
8813 (cequation (assoc (int-to-string col) eql))
8814 (eqn (or fequation cequation)))
8815 (goto-char pos)
8816 (condition-case nil
8817 (org-table-show-reference 'local)
8818 (error nil))
8819 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8820 dline col
8821 (if cname (concat " or $" cname) "")
8822 dline col ref1
8823 (if name (concat " or $" name) "")
8824 ;; FIXME: formula info not correct if special table line
8825 (if eqn
8826 (concat ", formula: "
8827 (org-table-formula-to-user
8828 (concat
8829 (if (string-match "^[$@]"(car eqn)) "" "$")
8830 (car eqn) "=" (cdr eqn))))
8831 "")))))
8833 (defun org-table-current-column ()
8834 "Find out which column we are in.
8835 When called interactively, column is also displayed in echo area."
8836 (interactive)
8837 (if (interactive-p) (org-table-check-inside-data-field))
8838 (save-excursion
8839 (let ((cnt 0) (pos (point)))
8840 (beginning-of-line 1)
8841 (while (search-forward "|" pos t)
8842 (setq cnt (1+ cnt)))
8843 (if (interactive-p) (message "This is table column %d" cnt))
8844 cnt)))
8846 (defun org-table-current-dline ()
8847 "Find out what table data line we are in.
8848 Only datalins count for this."
8849 (interactive)
8850 (if (interactive-p) (org-table-check-inside-data-field))
8851 (save-excursion
8852 (let ((cnt 0) (pos (point)))
8853 (goto-char (org-table-begin))
8854 (while (<= (point) pos)
8855 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8856 (beginning-of-line 2))
8857 (if (interactive-p) (message "This is table line %d" cnt))
8858 cnt)))
8860 (defun org-table-goto-column (n &optional on-delim force)
8861 "Move the cursor to the Nth column in the current table line.
8862 With optional argument ON-DELIM, stop with point before the left delimiter
8863 of the field.
8864 If there are less than N fields, just go to after the last delimiter.
8865 However, when FORCE is non-nil, create new columns if necessary."
8866 (interactive "p")
8867 (let ((pos (point-at-eol)))
8868 (beginning-of-line 1)
8869 (when (> n 0)
8870 (while (and (> (setq n (1- n)) -1)
8871 (or (search-forward "|" pos t)
8872 (and force
8873 (progn (end-of-line 1)
8874 (skip-chars-backward "^|")
8875 (insert " | "))))))
8876 ; (backward-char 2) t)))))
8877 (when (and force (not (looking-at ".*|")))
8878 (save-excursion (end-of-line 1) (insert " | ")))
8879 (if on-delim
8880 (backward-char 1)
8881 (if (looking-at " ") (forward-char 1))))))
8883 (defun org-at-table-p (&optional table-type)
8884 "Return t if the cursor is inside an org-type table.
8885 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8886 (if org-enable-table-editor
8887 (save-excursion
8888 (beginning-of-line 1)
8889 (looking-at (if table-type org-table-any-line-regexp
8890 org-table-line-regexp)))
8891 nil))
8893 (defun org-at-table.el-p ()
8894 "Return t if and only if we are at a table.el table."
8895 (and (org-at-table-p 'any)
8896 (save-excursion
8897 (goto-char (org-table-begin 'any))
8898 (looking-at org-table1-hline-regexp))))
8900 (defun org-table-recognize-table.el ()
8901 "If there is a table.el table nearby, recognize it and move into it."
8902 (if org-table-tab-recognizes-table.el
8903 (if (org-at-table.el-p)
8904 (progn
8905 (beginning-of-line 1)
8906 (if (looking-at org-table-dataline-regexp)
8907 nil
8908 (if (looking-at org-table1-hline-regexp)
8909 (progn
8910 (beginning-of-line 2)
8911 (if (looking-at org-table-any-border-regexp)
8912 (beginning-of-line -1)))))
8913 (if (re-search-forward "|" (org-table-end t) t)
8914 (progn
8915 (require 'table)
8916 (if (table--at-cell-p (point))
8917 t
8918 (message "recognizing table.el table...")
8919 (table-recognize-table)
8920 (message "recognizing table.el table...done")))
8921 (error "This should not happen..."))
8922 t)
8923 nil)
8924 nil))
8926 (defun org-at-table-hline-p ()
8927 "Return t if the cursor is inside a hline in a table."
8928 (if org-enable-table-editor
8929 (save-excursion
8930 (beginning-of-line 1)
8931 (looking-at org-table-hline-regexp))
8932 nil))
8934 (defun org-table-insert-column ()
8935 "Insert a new column into the table."
8936 (interactive)
8937 (if (not (org-at-table-p))
8938 (error "Not at a table"))
8939 (org-table-find-dataline)
8940 (let* ((col (max 1 (org-table-current-column)))
8941 (beg (org-table-begin))
8942 (end (org-table-end))
8943 ;; Current cursor position
8944 (linepos (org-current-line))
8945 (colpos col))
8946 (goto-char beg)
8947 (while (< (point) end)
8948 (if (org-at-table-hline-p)
8949 nil
8950 (org-table-goto-column col t)
8951 (insert "| "))
8952 (beginning-of-line 2))
8953 (move-marker end nil)
8954 (goto-line linepos)
8955 (org-table-goto-column colpos)
8956 (org-table-align)
8957 (org-table-fix-formulas "$" nil (1- col) 1)))
8959 (defun org-table-find-dataline ()
8960 "Find a dataline in the current table, which is needed for column commands."
8961 (if (and (org-at-table-p)
8962 (not (org-at-table-hline-p)))
8963 t
8964 (let ((col (current-column))
8965 (end (org-table-end)))
8966 (move-to-column col)
8967 (while (and (< (point) end)
8968 (or (not (= (current-column) col))
8969 (org-at-table-hline-p)))
8970 (beginning-of-line 2)
8971 (move-to-column col))
8972 (if (and (org-at-table-p)
8973 (not (org-at-table-hline-p)))
8974 t
8975 (error
8976 "Please position cursor in a data line for column operations")))))
8978 (defun org-table-delete-column ()
8979 "Delete a column from the table."
8980 (interactive)
8981 (if (not (org-at-table-p))
8982 (error "Not at a table"))
8983 (org-table-find-dataline)
8984 (org-table-check-inside-data-field)
8985 (let* ((col (org-table-current-column))
8986 (beg (org-table-begin))
8987 (end (org-table-end))
8988 ;; Current cursor position
8989 (linepos (org-current-line))
8990 (colpos col))
8991 (goto-char beg)
8992 (while (< (point) end)
8993 (if (org-at-table-hline-p)
8994 nil
8995 (org-table-goto-column col t)
8997 (replace-match "|")))
8998 (beginning-of-line 2))
8999 (move-marker end nil)
9000 (goto-line linepos)
9001 (org-table-goto-column colpos)
9002 (org-table-align)
9003 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9004 col -1 col)))
9006 (defun org-table-move-column-right ()
9007 "Move column to the right."
9008 (interactive)
9009 (org-table-move-column nil))
9010 (defun org-table-move-column-left ()
9011 "Move column to the left."
9012 (interactive)
9013 (org-table-move-column 'left))
9015 (defun org-table-move-column (&optional left)
9016 "Move the current column to the right. With arg LEFT, move to the left."
9017 (interactive "P")
9018 (if (not (org-at-table-p))
9019 (error "Not at a table"))
9020 (org-table-find-dataline)
9021 (org-table-check-inside-data-field)
9022 (let* ((col (org-table-current-column))
9023 (col1 (if left (1- col) col))
9024 (beg (org-table-begin))
9025 (end (org-table-end))
9026 ;; Current cursor position
9027 (linepos (org-current-line))
9028 (colpos (if left (1- col) (1+ col))))
9029 (if (and left (= col 1))
9030 (error "Cannot move column further left"))
9032 (error "Cannot move column further right"))
9033 (goto-char beg)
9034 (while (< (point) end)
9035 (if (org-at-table-hline-p)
9036 nil
9037 (org-table-goto-column col1 t)
9040 (beginning-of-line 2))
9041 (move-marker end nil)
9042 (goto-line linepos)
9043 (org-table-goto-column colpos)
9044 (org-table-align)
9045 (org-table-fix-formulas
9046 "$" (list (cons (number-to-string col) (number-to-string colpos))
9047 (cons (number-to-string colpos) (number-to-string col))))))
9049 (defun org-table-move-row-down ()
9050 "Move table row down."
9051 (interactive)
9052 (org-table-move-row nil))
9053 (defun org-table-move-row-up ()
9054 "Move table row up."
9055 (interactive)
9056 (org-table-move-row 'up))
9058 (defun org-table-move-row (&optional up)
9059 "Move the current table line down. With arg UP, move it up."
9060 (interactive "P")
9061 (let* ((col (current-column))
9062 (pos (point))
9063 (hline1p (save-excursion (beginning-of-line 1)
9064 (looking-at org-table-hline-regexp)))
9065 (dline1 (org-table-current-dline))
9066 (dline2 (+ dline1 (if up -1 1)))
9067 (tonew (if up 0 2))
9068 txt hline2p)
9069 (beginning-of-line tonew)
9070 (unless (org-at-table-p)
9071 (goto-char pos)
9072 (error "Cannot move row further"))
9073 (setq hline2p (looking-at org-table-hline-regexp))
9074 (goto-char pos)
9075 (beginning-of-line 1)
9076 (setq pos (point))
9077 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9078 (delete-region (point) (1+ (point-at-eol)))
9079 (beginning-of-line tonew)
9080 (insert txt)
9081 (beginning-of-line 0)
9082 (move-to-column col)
9083 (unless (or hline1p hline2p)
9084 (org-table-fix-formulas
9085 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9086 (cons (number-to-string dline2) (number-to-string dline1)))))))
9088 (defun org-table-insert-row (&optional arg)
9089 "Insert a new row above the current line into the table.
9090 With prefix ARG, insert below the current line."
9091 (interactive "P")
9092 (if (not (org-at-table-p))
9093 (error "Not at a table"))
9094 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9095 (new (org-table-clean-line line)))
9096 ;; Fix the first field if necessary
9098 (setq new (replace-match (match-string 0 line) t t new)))
9099 (beginning-of-line (if arg 2 1))
9101 (beginning-of-line 0)
9102 (re-search-forward "| ?" (point-at-eol) t)
9103 (and (or org-table-may-need-update org-table-overlay-coordinates)
9104 (org-table-align))
9105 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9107 (defun org-table-insert-hline (&optional above)
9108 "Insert a horizontal-line below the current line into the table.
9109 With prefix ABOVE, insert above the current line."
9110 (interactive "P")
9111 (if (not (org-at-table-p))
9112 (error "Not at a table"))
9113 (let ((line (org-table-clean-line
9114 (buffer-substring (point-at-bol) (point-at-eol))))
9115 (col (current-column)))
9117 (setq line (replace-match
9118 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9119 ?-) "|") t t line)))
9121 (beginning-of-line (if above 1 2))
9123 (beginning-of-line (if above 1 -1))
9124 (move-to-column col)
9125 (and org-table-overlay-coordinates (org-table-align))))
9127 (defun org-table-hline-and-move (&optional same-column)
9128 "Insert a hline and move to the row below that line."
9129 (interactive "P")
9130 (let ((col (org-table-current-column)))
9131 (org-table-maybe-eval-formula)
9132 (org-table-maybe-recalculate-line)
9133 (org-table-insert-hline)
9134 (end-of-line 2)
9137 (org-table-next-field))
9138 (if same-column (org-table-goto-column col))))
9140 (defun org-table-clean-line (s)
9142 In particular, this does handle wide and invisible characters."
9144 ;; It's a hline, just map the characters
9145 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9147 (setq s (replace-match
9148 (concat "|" (make-string (org-string-width (match-string 1 s))
9149 ?\ ) "|")
9150 t t s)))
9151 s))
9153 (defun org-table-kill-row ()
9154 "Delete the current row or horizontal line from the table."
9155 (interactive)
9156 (if (not (org-at-table-p))
9157 (error "Not at a table"))
9158 (let ((col (current-column))
9159 (dline (org-table-current-dline)))
9160 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9161 (if (not (org-at-table-p)) (beginning-of-line 0))
9162 (move-to-column col)
9163 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9164 dline -1 dline)))
9166 (defun org-table-sort-lines (with-case &optional sorting-type)
9167 "Sort table lines according to the column at point.
9169 The position of point indicates the column to be used for
9170 sorting, and the range of lines is the range between the nearest
9171 horizontal separator lines, or the entire table of no such lines
9172 exist. If point is before the first column, you will be prompted
9173 for the sorting column. If there is an active region, the mark
9174 specifies the first line and the sorting column, while point
9175 should be in the last line to be included into the sorting.
9177 The command then prompts for the sorting type which can be
9178 alphabetically, numerically, or by time (as given in a time stamp
9179 in the field). Sorting in reverse order is also possible.
9181 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9183 If SORTING-TYPE is specified when this function is called from a Lisp
9184 program, no prompting will take place. SORTING-TYPE must be a character,
9185 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9186 should be done in reverse order."
9187 (interactive "P")
9188 (let* ((thisline (org-current-line))
9189 (thiscol (org-table-current-column))
9190 beg end bcol ecol tend tbeg column lns pos)
9191 (when (equal thiscol 0)
9192 (if (interactive-p)
9193 (setq thiscol
9194 (string-to-number
9195 (read-string "Use column N for sorting: ")))
9196 (setq thiscol 1))
9197 (org-table-goto-column thiscol))
9198 (org-table-check-inside-data-field)
9199 (if (org-region-active-p)
9200 (progn
9201 (setq beg (region-beginning) end (region-end))
9202 (goto-char beg)
9203 (setq column (org-table-current-column)
9204 beg (point-at-bol))
9205 (goto-char end)
9206 (setq end (point-at-bol 2)))
9207 (setq column (org-table-current-column)
9208 pos (point)
9209 tbeg (org-table-begin)
9210 tend (org-table-end))
9211 (if (re-search-backward org-table-hline-regexp tbeg t)
9212 (setq beg (point-at-bol 2))
9213 (goto-char tbeg)
9214 (setq beg (point-at-bol 1)))
9215 (goto-char pos)
9216 (if (re-search-forward org-table-hline-regexp tend t)
9217 (setq end (point-at-bol 1))
9218 (goto-char tend)
9219 (setq end (point-at-bol))))
9220 (setq beg (move-marker (make-marker) beg)
9221 end (move-marker (make-marker) end))
9222 (untabify beg end)
9223 (goto-char beg)
9224 (org-table-goto-column column)
9225 (skip-chars-backward "^|")
9226 (setq bcol (current-column))
9227 (org-table-goto-column (1+ column))
9228 (skip-chars-backward "^|")
9229 (setq ecol (1- (current-column)))
9230 (org-table-goto-column column)
9231 (setq lns (mapcar (lambda(x) (cons
9232 (org-sort-remove-invisible
9233 (nth (1- column)
9235 x))
9237 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9238 (delete-region beg end)
9239 (move-marker beg nil)
9240 (move-marker end nil)
9242 (goto-line thisline)
9243 (org-table-goto-column thiscol)
9244 (message "%d lines sorted, based on column %d" (length lns) column)))
9246 ;; FIXME: maybe we will not need this? Table sorting is broken....
9247 (defun org-sort-remove-invisible (s)
9248 (remove-text-properties 0 (length s) org-rm-props s)
9249 (while (string-match org-bracket-link-regexp s)
9250 (setq s (replace-match (if (match-end 2)
9251 (match-string 3 s)
9252 (match-string 1 s)) t t s)))
9253 s)
9255 (defun org-table-cut-region (beg end)
9256 "Copy region in table to the clipboard and blank all relevant fields."
9257 (interactive "r")
9258 (org-table-copy-region beg end 'cut))
9260 (defun org-table-copy-region (beg end &optional cut)
9261 "Copy rectangular region in table to clipboard.
9262 A special clipboard is used which can only be accessed
9263 with `org-table-paste-rectangle'."
9264 (interactive "rP")
9265 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9266 region cols
9267 (rpl (if cut " " nil)))
9268 (goto-char beg)
9269 (org-table-check-inside-data-field)
9270 (setq l01 (org-current-line)
9271 c01 (org-table-current-column))
9272 (goto-char end)
9273 (org-table-check-inside-data-field)
9274 (setq l02 (org-current-line)
9275 c02 (org-table-current-column))
9276 (setq l1 (min l01 l02) l2 (max l01 l02)
9277 c1 (min c01 c02) c2 (max c01 c02))
9278 (catch 'exit
9279 (while t
9280 (catch 'nextline
9281 (if (> l1 l2) (throw 'exit t))
9282 (goto-line l1)
9283 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9284 (setq cols nil ic1 c1 ic2 c2)
9285 (while (< ic1 (1+ ic2))
9286 (push (org-table-get-field ic1 rpl) cols)
9287 (setq ic1 (1+ ic1)))
9288 (push (nreverse cols) region)
9289 (setq l1 (1+ l1)))))
9290 (setq org-table-clip (nreverse region))
9291 (if cut (org-table-align))
9292 org-table-clip))
9294 (defun org-table-paste-rectangle ()
9295 "Paste a rectangular region into a table.
9296 The upper right corner ends up in the current field. All involved fields
9297 will be overwritten. If the rectangle does not fit into the present table,
9298 the table is enlarged as needed. The process ignores horizontal separator
9299 lines."
9300 (interactive)
9301 (unless (and org-table-clip (listp org-table-clip))
9302 (error "First cut/copy a region to paste!"))
9303 (org-table-check-inside-data-field)
9304 (let* ((clip org-table-clip)
9305 (line (org-current-line))
9306 (col (org-table-current-column))
9307 (org-enable-table-editor t)
9308 (org-table-automatic-realign nil)
9309 c cols field)
9310 (while (setq cols (pop clip))
9311 (while (org-at-table-hline-p) (beginning-of-line 2))
9312 (if (not (org-at-table-p))
9313 (progn (end-of-line 0) (org-table-next-field)))
9314 (setq c col)
9315 (while (setq field (pop cols))
9316 (org-table-goto-column c nil 'force)
9317 (org-table-get-field nil field)
9318 (setq c (1+ c)))
9319 (beginning-of-line 2))
9320 (goto-line line)
9321 (org-table-goto-column col)
9322 (org-table-align)))
9324 (defun org-table-convert ()
9325 "Convert from `org-mode' table to table.el and back.
9326 Obviously, this only works within limits. When an Org-mode table is
9327 converted to table.el, all horizontal separator lines get lost, because
9328 table.el uses these as cell boundaries and has no notion of horizontal lines.
9329 A table.el table can be converted to an Org-mode table only if it does not
9330 do row or column spanning. Multiline cells will become multiple cells.
9331 Beware, Org-mode does not test if the table can be successfully converted - it
9332 blindly applies a recipe that works for simple tables."
9333 (interactive)
9334 (require 'table)
9335 (if (org-at-table.el-p)
9336 ;; convert to Org-mode table
9337 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9338 (end (move-marker (make-marker) (org-table-end t))))
9339 (table-unrecognize-region beg end)
9340 (goto-char beg)
9342 (replace-match ""))
9343 (goto-char beg))
9344 (if (org-at-table-p)
9345 ;; convert to table.el table
9346 (let ((beg (move-marker (make-marker) (org-table-begin)))
9347 (end (move-marker (make-marker) (org-table-end))))
9348 ;; first, get rid of all horizontal lines
9349 (goto-char beg)
9351 (replace-match ""))
9352 ;; insert a hline before first
9353 (goto-char beg)
9354 (org-table-insert-hline 'above)
9355 (beginning-of-line -1)
9356 ;; insert a hline after each line
9357 (while (progn (beginning-of-line 3) (< (point) end))
9358 (org-table-insert-hline))
9359 (goto-char beg)
9360 (setq end (move-marker end (org-table-end)))
9361 ;; replace "+" at beginning and ending of hlines
9364 (goto-char beg)
9366 (replace-match "-+"))
9367 (goto-char beg)))))
9369 (defun org-table-wrap-region (arg)
9370 "Wrap several fields in a column like a paragraph.
9371 This is useful if you'd like to spread the contents of a field over several
9372 lines, in order to keep the table compact.
9374 If there is an active region, and both point and mark are in the same column,
9375 the text in the column is wrapped to minimum width for the given number of
9376 lines. Generally, this makes the table more compact. A prefix ARG may be
9378 formats the selected text to two lines. If the region was longer than two
9379 lines, the remaining lines remain empty. A negative prefix argument reduces
9380 the current number of lines by that amount. The wrapped text is pasted back
9381 into the table. If you formatted it to more lines than it was before, fields
9382 further down in the table get overwritten - so you might need to make space in
9383 the table first.
9385 If there is no region, the current field is split at the cursor position and
9386 the text fragment to the right of the cursor is prepended to the field one
9387 line down.
9389 If there is no region, but you specify a prefix ARG, the current field gets
9390 blank, and the content is appended to the field above."
9391 (interactive "P")
9392 (org-table-check-inside-data-field)
9393 (if (org-region-active-p)
9394 ;; There is a region: fill as a paragraph
9395 (let* ((beg (region-beginning))
9396 (cline (save-excursion (goto-char beg) (org-current-line)))
9397 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9398 nlines)
9399 (org-table-cut-region (region-beginning) (region-end))
9400 (if (> (length (car org-table-clip)) 1)
9401 (error "Region must be limited to single column"))
9402 (setq nlines (if arg
9403 (if (< arg 1)
9404 (+ (length org-table-clip) arg)
9405 arg)
9406 (length org-table-clip)))
9407 (setq org-table-clip
9408 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9409 nil nlines)))
9410 (goto-line cline)
9411 (org-table-goto-column ccol)
9412 (org-table-paste-rectangle))
9413 ;; No region, split the current field at point
9414 (if arg
9415 ;; combine with field above
9416 (let ((s (org-table-blank-field))
9417 (col (org-table-current-column)))
9418 (beginning-of-line 0)
9419 (while (org-at-table-hline-p) (beginning-of-line 0))
9420 (org-table-goto-column col)
9421 (skip-chars-forward "^|")
9422 (skip-chars-backward " ")
9423 (insert " " (org-trim s))
9424 (org-table-align))
9425 ;; split field
9427 (let ((s (match-string 1)))
9428 (replace-match " |")
9429 (goto-char (match-beginning 0))
9430 (org-table-next-row)
9431 (insert (org-trim s) " ")
9432 (org-table-align))))))
9434 (defvar org-field-marker nil)
9436 (defun org-table-edit-field (arg)
9437 "Edit table field in a different window.
9438 This is mainly useful for fields that contain hidden parts.
9440 it can be edited in place."
9441 (interactive "P")
9442 (if arg
9443 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9445 (remove-text-properties b e '(org-cwidth t invisible t
9446 display t intangible t))
9447 (if (and (boundp 'font-lock-mode) font-lock-mode)
9448 (font-lock-fontify-block)))
9449 (let ((pos (move-marker (make-marker) (point)))
9450 (field (org-table-get-field))
9451 (cw (current-window-configuration))
9452 p)
9453 (org-switch-to-buffer-other-window "*Org tmp*")
9454 (erase-buffer)
9456 (let ((org-inhibit-startup t)) (org-mode))
9457 (goto-char (setq p (point-max)))
9458 (insert (org-trim field))
9459 (remove-text-properties p (point-max)
9460 '(invisible t org-cwidth t display t
9461 intangible t))
9462 (goto-char p)
9463 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9464 (org-set-local 'org-window-configuration cw)
9465 (org-set-local 'org-field-marker pos)
9466 (message "Edit and finish with C-c C-c"))))
9468 (defun org-table-finish-edit-field ()
9469 "Finish editing a table data field.
9470 Remove all newline characters, insert the result into the table, realign
9471 the table and kill the editing buffer."
9472 (let ((pos org-field-marker)
9473 (cw org-window-configuration)
9474 (cb (current-buffer))
9475 text)
9476 (goto-char (point-min))
9479 (replace-match " "))
9480 (setq text (org-trim (buffer-string)))
9481 (set-window-configuration cw)
9482 (kill-buffer cb)
9483 (select-window (get-buffer-window (marker-buffer pos)))
9484 (goto-char pos)
9485 (move-marker pos nil)
9486 (org-table-check-inside-data-field)
9487 (org-table-get-field nil text)
9488 (org-table-align)
9489 (message "New field value inserted")))
9491 (defun org-trim (s)
9492 "Remove whitespace at beginning and end of string."
9495 s)
9497 (defun org-wrap (string &optional width lines)
9498 "Wrap string to either a number of lines, or a width in characters.
9499 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9500 that costs. If there is a word longer than WIDTH, the text is actually
9501 wrapped to the length of that word.
9502 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9503 many lines, whatever width that takes.
9504 The return value is a list of lines, without newlines at the end."
9506 (maxword (apply 'max (mapcar 'org-string-width words)))
9507 w ll)
9508 (cond (width
9509 (org-do-wrap words (max maxword width)))
9510 (lines
9511 (setq w maxword)
9512 (setq ll (org-do-wrap words maxword))
9513 (if (<= (length ll) lines)
9514 ll
9515 (setq ll words)
9516 (while (> (length ll) lines)
9517 (setq w (1+ w))
9518 (setq ll (org-do-wrap words w)))
9519 ll))
9520 (t (error "Cannot wrap this")))))
9523 (defun org-do-wrap (words width)
9524 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9525 (let (lines line)
9526 (while words
9527 (setq line (pop words))
9528 (while (and words (< (+ (length line) (length (car words))) width))
9529 (setq line (concat line " " (pop words))))
9530 (setq lines (push line lines)))
9531 (nreverse lines)))
9533 (defun org-split-string (string &optional separators)
9534 "Splits STRING into substrings at SEPARATORS.
9535 No empty strings are returned if there are matches at the beginning
9536 and end of string."
9538 (start 0)
9539 notfirst
9540 (list nil))
9541 (while (and (string-match rexp string
9542 (if (and notfirst
9543 (= start (match-beginning 0))
9544 (< start (length string)))
9545 (1+ start) start))
9546 (< (match-beginning 0) (length string)))
9547 (setq notfirst t)
9548 (or (eq (match-beginning 0) 0)
9549 (and (eq (match-beginning 0) (match-end 0))
9550 (eq (match-beginning 0) start))
9551 (setq list
9552 (cons (substring string start (match-beginning 0))
9553 list)))
9554 (setq start (match-end 0)))
9555 (or (eq start (length string))
9556 (setq list
9557 (cons (substring string start)
9558 list)))
9559 (nreverse list)))
9561 (defun org-table-map-tables (function)
9562 "Apply FUNCTION to the start of all tables in the buffer."
9563 (save-excursion
9564 (save-restriction
9565 (widen)
9566 (goto-char (point-min))
9567 (while (re-search-forward org-table-any-line-regexp nil t)
9568 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9569 (beginning-of-line 1)
9570 (if (looking-at org-table-line-regexp)
9571 (save-excursion (funcall function)))
9572 (re-search-forward org-table-any-border-regexp nil 1))))
9573 (message "Mapping tables: done"))
9575 (defvar org-timecnt) ; dynamically scoped parameter
9577 (defun org-table-sum (&optional beg end nlast)
9578 "Sum numbers in region of current table column.
9579 The result will be displayed in the echo area, and will be available
9582 If there is an active region, it is interpreted as a rectangle and all
9583 numbers in that rectangle will be summed. If there is no active
9584 region and point is located in a table column, sum all numbers in that
9585 column.
9587 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9588 numbers are assumed to be times as well (in decimal hours) and the
9589 numbers are added as such.
9591 If NLAST is a number, only the NLAST fields will actually be summed."
9592 (interactive)
9593 (save-excursion
9594 (let (col (org-timecnt 0) diff h m s org-table-clip)
9595 (cond
9596 ((and beg end)) ; beg and end given explicitly
9597 ((org-region-active-p)
9598 (setq beg (region-beginning) end (region-end)))
9599 (t
9600 (setq col (org-table-current-column))
9601 (goto-char (org-table-begin))
9603 (error "No table data"))
9604 (org-table-goto-column col)
9605 (setq beg (point))
9606 (goto-char (org-table-end))
9608 (error "No table data"))
9609 (org-table-goto-column col)
9610 (setq end (point))))
9611 (let* ((items (apply 'append (org-table-copy-region beg end)))
9612 (items1 (cond ((not nlast) items)
9613 ((>= nlast (length items)) items)
9614 (t (setq items (reverse items))
9615 (setcdr (nthcdr (1- nlast) items) nil)
9616 (nreverse items))))
9617 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9618 items1)))
9619 (res (apply '+ numbers))
9620 (sres (if (= org-timecnt 0)
9621 (format "%g" res)
9622 (setq diff (* 3600 res)
9623 h (floor (/ diff 3600)) diff (mod diff 3600)
9624 m (floor (/ diff 60)) diff (mod diff 60)
9625 s diff)
9626 (format "%d:%02d:%02d" h m s))))
9627 (kill-new sres)
9628 (if (interactive-p)
9629 (message "%s"
9630 (substitute-command-keys
9632 (length numbers) sres))))
9633 sres))))
9635 (defun org-table-get-number-for-summing (s)
9636 (let (n)
9637 (if (string-match "^ *|? *" s)
9638 (setq s (replace-match "" nil nil s)))
9639 (if (string-match " *|? *$" s)
9640 (setq s (replace-match "" nil nil s)))
9641 (setq n (string-to-number s))
9642 (cond
9643 ((and (string-match "0" s)
9647 (let ((h (string-to-number (or (match-string 1 s) "0")))
9648 (m (string-to-number (or (match-string 2 s) "0")))
9649 (s (string-to-number (or (match-string 4 s) "0"))))
9650 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9651 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9652 ((equal n 0) nil)
9653 (t n))))
9655 (defun org-table-current-field-formula (&optional key noerror)
9656 "Return the formula active for the current field.
9657 Assumes that specials are in place.
9658 If KEY is given, return the key to this formula.
9660 (let* ((name (car (rassoc (list (org-current-line)
9661 (org-table-current-column))
9662 org-table-named-field-locations)))
9663 (col (org-table-current-column))
9664 (scol (int-to-string col))
9665 (ref (format "@%d$%d" (org-table-current-dline) col))
9666 (stored-list (org-table-get-stored-formulas noerror))
9667 (ass (or (assoc name stored-list)
9668 (assoc ref stored-list)
9669 (assoc scol stored-list))))
9670 (if key
9671 (car ass)
9672 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9673 (cdr ass))))))
9675 (defun org-table-get-formula (&optional equation named)
9676 "Read a formula from the minibuffer, offer stored formula as default.
9677 When NAMED is non-nil, look for a named equation."
9678 (let* ((stored-list (org-table-get-stored-formulas))
9679 (name (car (rassoc (list (org-current-line)
9680 (org-table-current-column))
9681 org-table-named-field-locations)))
9682 (ref (format "@%d$%d" (org-table-current-dline)
9683 (org-table-current-column)))
9684 (refass (assoc ref stored-list))
9685 (scol (if named
9686 (if name name ref)
9687 (int-to-string (org-table-current-column))))
9688 (dummy (and (or name refass) (not named)
9689 (not (y-or-n-p "Replace field formula with column formula? " ))
9690 (error "Abort")))
9691 (name (or name ref))
9692 (org-table-may-need-update nil)
9693 (stored (cdr (assoc scol stored-list)))
9694 (eq (cond
9695 ((and stored equation (string-match "^ *=? *$" equation))
9696 stored)
9697 ((stringp equation)
9698 equation)
9699 (t (org-table-formula-from-user
9700 (read-string
9701 (org-table-formula-to-user
9702 (format "%s formula %s%s="
9703 (if named "Field" "Column")
9704 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9705 scol))
9706 (if stored (org-table-formula-to-user stored) "")
9707 'org-table-formula-history
9708 )))))
9709 mustsave)
9711 ;; remove formula
9712 (setq stored-list (delq (assoc scol stored-list) stored-list))
9713 (org-table-store-formulas stored-list)
9714 (error "Formula removed"))
9715 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9716 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9717 (if (and name (not named))
9718 ;; We set the column equation, delete the named one.
9719 (setq stored-list (delq (assoc name stored-list) stored-list)
9720 mustsave t))
9721 (if stored
9722 (setcdr (assoc scol stored-list) eq)
9723 (setq stored-list (cons (cons scol eq) stored-list)))
9724 (if (or mustsave (not (equal stored eq)))
9725 (org-table-store-formulas stored-list))
9726 eq))
9728 (defun org-table-store-formulas (alist)
9729 "Store the list of formulas below the current table."
9730 (setq alist (sort alist 'org-table-formula-less-p))
9731 (save-excursion
9732 (goto-char (org-table-end))
9734 (progn
9735 ;; don't overwrite TBLFM, we might use text properties to store stuff
9736 (goto-char (match-beginning 2))
9737 (delete-region (match-beginning 2) (match-end 0)))
9738 (insert "#+TBLFM:"))
9739 (insert " "
9740 (mapconcat (lambda (x)
9741 (concat
9742 (if (equal (string-to-char (car x)) ?@) "" "$")
9743 (car x) "=" (cdr x)))
9744 alist "::")
9747 (defsubst org-table-formula-make-cmp-string (a)
9749 (concat
9750 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9751 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9752 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9754 (defun org-table-formula-less-p (a b)
9755 "Compare two formulas for sorting."
9756 (let ((as (org-table-formula-make-cmp-string (car a)))
9757 (bs (org-table-formula-make-cmp-string (car b))))
9758 (and as bs (string< as bs))))
9760 (defun org-table-get-stored-formulas (&optional noerror)
9761 "Return an alist with the stored formulas directly after current table."
9762 (interactive)
9763 (let (scol eq eq-alist strings string seen)
9764 (save-excursion
9765 (goto-char (org-table-end))
9767 (setq strings (org-split-string (match-string 2) " *:: *"))
9768 (while (setq string (pop strings))
9769 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9770 (setq scol (if (match-end 2)
9771 (match-string 2 string)
9772 (match-string 1 string))
9773 eq (match-string 3 string)
9774 eq-alist (cons (cons scol eq) eq-alist))
9775 (if (member scol seen)
9776 (if noerror
9777 (progn
9778 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9779 (ding)
9780 (sit-for 2))
9781 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9782 (push scol seen))))))
9783 (nreverse eq-alist)))
9785 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9786 "Modify the equations after the table structure has been edited.
9788 For all numbers larger than LIMIT, shift them by DELTA."
9789 (save-excursion
9790 (goto-char (org-table-end))
9793 (re2
9794 (when remove
9795 (if (equal key "$")
9798 s n a)
9799 (when remove
9800 (while (re-search-forward re2 (point-at-eol) t)
9801 (replace-match "")))
9802 (while (re-search-forward re (point-at-eol) t)
9803 (setq s (match-string 1) n (string-to-number s))
9804 (cond
9805 ((setq a (assoc s replace))
9806 (replace-match (concat key (cdr a)) t t))
9807 ((and limit (> n limit))
9808 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9810 (defun org-table-get-specials ()
9811 "Get the column names and local parameters for this table."
9812 (save-excursion
9813 (let ((beg (org-table-begin)) (end (org-table-end))
9814 names name fields fields1 field cnt
9815 c v l line col types dlines hlines)
9816 (setq org-table-column-names nil
9817 org-table-local-parameters nil
9818 org-table-named-field-locations nil
9819 org-table-current-begin-line nil
9820 org-table-current-begin-pos nil
9821 org-table-current-line-types nil)
9822 (goto-char beg)
9824 (setq names (org-split-string (match-string 1) " *| *")
9825 cnt 1)
9826 (while (setq name (pop names))
9827 (setq cnt (1+ cnt))
9828 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9829 (push (cons name (int-to-string cnt)) org-table-column-names))))
9830 (setq org-table-column-names (nreverse org-table-column-names))
9831 (setq org-table-column-name-regexp
9833 (goto-char beg)
9835 (setq fields (org-split-string (match-string 1) " *| *"))
9836 (while (setq field (pop fields))
9838 (push (cons (match-string 1 field) (match-string 2 field))
9839 org-table-local-parameters))))
9840 (goto-char beg)
9842 (setq c (match-string 1)
9843 fields (org-split-string (match-string 2) " *| *"))
9844 (save-excursion
9845 (beginning-of-line (if (equal c "_") 2 0))
9846 (setq line (org-current-line) col 1)
9848 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9849 (while (and fields1 (setq field (pop fields)))
9850 (setq v (pop fields1) col (1+ col))
9851 (when (and (stringp field) (stringp v)
9852 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9853 (push (cons field v) org-table-local-parameters)
9854 (push (list field line col) org-table-named-field-locations))))
9855 ;; Analyse the line types
9856 (goto-char beg)
9857 (setq org-table-current-begin-line (org-current-line)
9858 org-table-current-begin-pos (point)
9859 l org-table-current-begin-line)
9861 (push (if (match-end 1) 'hline 'dline) types)
9862 (if (match-end 1) (push l hlines) (push l dlines))
9863 (beginning-of-line 2)
9864 (setq l (1+ l)))
9865 (setq org-table-current-line-types (apply 'vector (nreverse types))
9866 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9867 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9869 (defun org-table-maybe-eval-formula ()
9871 If yes, store the formula and apply it."
9872 ;; We already know we are in a table. Get field will only return a formula
9873 ;; when appropriate. It might return a separator line, but no problem.
9874 (when org-table-formula-evaluate-inline
9875 (let* ((field (org-trim (or (org-table-get-field) "")))
9876 named eq)
9878 (setq named (equal (string-to-char field) ?:)
9879 eq (match-string 1 field))
9880 (if (or (fboundp 'calc-eval)
9881 (equal (substring eq 0 (min 2 (length eq))) "'("))
9882 (org-table-eval-formula (if named '(4) nil)
9883 (org-table-formula-from-user eq))
9884 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9886 (defvar org-recalc-commands nil
9887 "List of commands triggering the recalculation of a line.
9888 Will be filled automatically during use.")
9890 (defvar org-recalc-marks
9891 '((" " . "Unmarked: no special line, no automatic recalculation")
9892 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9893 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9894 ("!" . "Column name definition line. Reference in formula as $name.")
9895 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9896 ("_" . "Names for values in row below this one.")
9897 ("^" . "Names for values in row above this one.")))
9899 (defun org-table-rotate-recalc-marks (&optional newchar)
9900 "Rotate the recalculation mark in the first column.
9901 If in any row, the first field is not consistent with a mark,
9902 insert a new column for the markers.
9903 When there is an active region, change all the lines in the region,
9904 after prompting for the marking character.
9905 After each change, a message will be displayed indicating the meaning
9906 of the new mark."
9907 (interactive)
9908 (unless (org-at-table-p) (error "Not at a table"))
9909 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9910 (beg (org-table-begin))
9911 (end (org-table-end))
9912 (l (org-current-line))
9913 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9914 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9915 (have-col
9916 (save-excursion
9917 (goto-char beg)
9919 (col (org-table-current-column))
9920 (forcenew (car (assoc newchar org-recalc-marks)))
9921 epos new)
9922 (when l1
9923 (message "Change region to what mark? Type # * ! $ or SPC: ")
9924 (setq newchar (char-to-string (read-char-exclusive))
9925 forcenew (car (assoc newchar org-recalc-marks))))
9926 (if (and newchar (not forcenew))
9927 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9928 newchar))
9929 (if l1 (goto-line l1))
9930 (save-excursion
9931 (beginning-of-line 1)
9932 (unless (looking-at org-table-dataline-regexp)
9933 (error "Not at a table data line")))
9934 (unless have-col
9935 (org-table-goto-column 1)
9936 (org-table-insert-column)
9937 (org-table-goto-column (1+ col)))
9938 (setq epos (point-at-eol))
9939 (save-excursion
9940 (beginning-of-line 1)
9941 (org-table-get-field
9943 (concat " "
9944 (setq new (or forcenew
9945 (cadr (member (match-string 1) marks))))
9946 " ")
9947 " # ")))
9948 (if (and l1 l2)
9949 (progn
9950 (goto-line l1)
9951 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9952 (and (looking-at org-table-dataline-regexp)
9953 (org-table-get-field 1 (concat " " new " "))))
9954 (goto-line l1)))
9955 (if (not (= epos (point-at-eol))) (org-table-align))
9956 (goto-line l)
9957 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
9959 (defun org-table-maybe-recalculate-line ()
9960 "Recompute the current line if marked for it, and if we haven't just done it."
9961 (interactive)
9962 (and org-table-allow-automatic-line-recalculation
9963 (not (and (memq last-command org-recalc-commands)
9964 (equal org-last-recalc-line (org-current-line))))
9965 (save-excursion (beginning-of-line 1)
9966 (looking-at org-table-auto-recalculate-regexp))
9967 (org-table-recalculate) t))
9969 (defvar org-table-formula-debug nil
9970 "Non-nil means, debug table formulas.
9972 (make-variable-buffer-local 'org-table-formula-debug)
9974 (defvar modes)
9975 (defsubst org-set-calc-mode (var &optional value)
9976 (if (stringp var)
9977 (setq var (assoc var '(("D" calc-angle-mode deg)
9978 ("R" calc-angle-mode rad)
9979 ("F" calc-prefer-frac t)
9980 ("S" calc-symbolic-mode t)))
9981 value (nth 2 var) var (nth 1 var)))
9982 (if (memq var modes)
9983 (setcar (cdr (memq var modes)) value)
9984 (cons var (cons value modes)))
9985 modes)
9987 (defun org-table-eval-formula (&optional arg equation
9988 suppress-align suppress-const
9989 suppress-store suppress-analysis)
9990 "Replace the table field value at the cursor by the result of a calculation.
9992 This function makes use of Dave Gillespie's Calc package, in my view the
9993 most exciting program ever written for GNU Emacs. So you need to have Calc
9994 installed in order to use this function.
9996 In a table, this command replaces the value in the current field with the
9998 formula, by storing it in a special line below the table. When called
9999 with a `C-u' prefix, the current field must ba a named field, and the
10000 formula is installed as valid in only this specific field.
10002 When called with two `C-u' prefixes, insert the active equation
10003 for the field back into the current field, so that it can be
10005 to check the referenced fields.
10007 When called, the command first prompts for a formula, which is read in
10008 the minibuffer. Previously entered formulas are available through the
10009 history list, and the last used formula is offered as a default.
10010 These stored formulas are adapted correctly when moving, inserting, or
10011 deleting columns with the corresponding commands.
10013 The formula can be any algebraic expression understood by the Calc package.
10014 For details, see the Org-mode manual.
10016 This function can also be called from Lisp programs and offers
10017 additional arguments: EQUATION can be the formula to apply. If this
10018 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10019 used to speed-up recursive calls by by-passing unnecessary aligns.
10020 SUPPRESS-CONST suppresses the interpretation of constants in the
10021 formula, assuming that this has been done already outside the function.
10022 SUPPRESS-STORE means the formula should not be stored, either because
10023 it is already stored, or because it is a modified equation that should
10024 not overwrite the stored one."
10025 (interactive "P")
10026 (org-table-check-inside-data-field)
10027 (or suppress-analysis (org-table-get-specials))
10028 (if (equal arg '(16))
10029 (let ((eq (org-table-current-field-formula)))
10030 (or eq (error "No equation active for current field"))
10031 (org-table-get-field nil eq)
10032 (org-table-align)
10033 (setq org-table-may-need-update t))
10034 (let* (fields
10035 (ndown (if (integerp arg) arg 1))
10036 (org-table-automatic-realign nil)
10037 (case-fold-search nil)
10038 (down (> ndown 1))
10039 (formula (if (and equation suppress-store)
10040 equation
10041 (org-table-get-formula equation (equal arg '(4)))))
10042 (n0 (org-table-current-column))
10043 (modes (copy-sequence org-calc-default-modes))
10044 (numbers nil) ; was a variable, now fixed default
10045 (keep-empty nil)
10046 n form form0 bw fmt x ev orig c lispp literal)
10047 ;; Parse the format string. Since we have a lot of modes, this is
10048 ;; a lot of work. However, I think calc still uses most of the time.
10049 (if (string-match ";" formula)
10050 (let ((tmp (org-split-string formula ";")))
10051 (setq formula (car tmp)
10052 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10053 (nth 1 tmp)))
10055 (setq c (string-to-char (match-string 1 fmt))
10056 n (string-to-number (match-string 2 fmt)))
10057 (if (= c ?p)
10058 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10059 (setq modes (org-set-calc-mode
10060 'calc-float-format
10061 (list (cdr (assoc c '((?n . float) (?f . fix)
10062 (?s . sci) (?e . eng))))
10063 n))))
10064 (setq fmt (replace-match "" t t fmt)))
10065 (if (string-match "[NT]" fmt)
10066 (setq numbers (equal (match-string 0 fmt) "N")
10067 fmt (replace-match "" t t fmt)))
10068 (if (string-match "L" fmt)
10069 (setq literal t
10070 fmt (replace-match "" t t fmt)))
10071 (if (string-match "E" fmt)
10072 (setq keep-empty t
10073 fmt (replace-match "" t t fmt)))
10074 (while (string-match "[DRFS]" fmt)
10075 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10076 (setq fmt (replace-match "" t t fmt)))
10078 (setq fmt nil))))
10079 (if (and (not suppress-const) org-table-formula-use-constants)
10080 (setq formula (org-table-formula-substitute-names formula)))
10081 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10082 (while (> ndown 0)
10083 (setq fields (org-split-string
10084 (org-no-properties
10085 (buffer-substring (point-at-bol) (point-at-eol)))
10086 " *| *"))
10087 (if (eq numbers t)
10088 (setq fields (mapcar
10089 (lambda (x) (number-to-string (string-to-number x)))
10090 fields)))
10091 (setq ndown (1- ndown))
10092 (setq form (copy-sequence formula)
10093 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10094 (if (and lispp literal) (setq lispp 'literal))
10095 ;; Check for old vertical references
10096 (setq form (org-rewrite-old-row-references form))
10097 ;; Insert complex ranges
10098 (while (string-match org-table-range-regexp form)
10099 (setq form
10100 (replace-match
10101 (save-match-data
10102 (org-table-make-reference
10103 (org-table-get-range (match-string 0 form) nil n0)
10104 keep-empty numbers lispp))
10105 t t form)))
10106 ;; Insert simple ranges
10108 (setq form
10109 (replace-match
10110 (save-match-data
10111 (org-table-make-reference
10112 (org-sublist
10113 fields (string-to-number (match-string 1 form))
10114 (string-to-number (match-string 2 form)))
10115 keep-empty numbers lispp))
10116 t t form)))
10117 (setq form0 form)
10118 ;; Insert the references to fields in same row
10120 (setq n (string-to-number (match-string 1 form))
10121 x (nth (1- (if (= n 0) n0 n)) fields))
10123 (match-string 0 form)))
10124 (setq form (replace-match
10125 (save-match-data
10126 (org-table-make-reference x nil numbers lispp))
10127 t t form)))
10129 (if lispp
10130 (setq ev (condition-case nil
10131 (eval (eval (read form)))
10132 (error "#ERROR"))
10133 ev (if (numberp ev) (number-to-string ev) ev))
10134 (or (fboundp 'calc-eval)
10135 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10136 (setq ev (calc-eval (cons form modes)
10137 (if numbers 'num))))
10139 (when org-table-formula-debug
10140 (with-output-to-temp-buffer "*Substitution History*"
10141 (princ (format "Substitution history of formula
10142 Orig: %s
10143 $xyz-> %s
10144 @r$c-> %s
10146 (if (listp ev)
10148 (make-string (car ev) ?\-) (nth 1 ev)))
10150 ev (or fmt "NONE")
10151 (if fmt (format fmt (string-to-number ev)) ev)))))
10152 (setq bw (get-buffer-window "*Substitution History*"))
10153 (shrink-window-if-larger-than-buffer bw)
10154 (unless (and (interactive-p) (not ndown))
10155 (unless (let (inhibit-redisplay)
10156 (y-or-n-p "Debugging Formula. Continue to next? "))
10157 (org-table-align)
10158 (error "Abort"))
10159 (delete-window bw)
10160 (message "")))
10161 (if (listp ev) (setq fmt nil ev "#ERROR"))
10162 (org-table-justify-field-maybe
10163 (if fmt (format fmt (string-to-number ev)) ev))
10165 (call-interactively 'org-return)
10166 (setq ndown 0)))
10167 (and down (org-table-maybe-recalculate-line))
10168 (or suppress-align (and org-table-may-need-update
10169 (org-table-align))))))
10171 (defun org-table-put-field-property (prop value)
10172 (save-excursion
10173 (put-text-property (progn (skip-chars-backward "^|") (point))
10174 (progn (skip-chars-forward "^|") (point))
10175 prop value)))
10177 (defun org-table-get-range (desc &optional tbeg col highlight)
10178 "Get a calc vector from a column, accorting to descriptor DESC.
10179 Optional arguments TBEG and COL can give the beginning of the table and
10180 the current column, to avoid unnecessary parsing.
10181 HIGHLIGHT means, just highlight the range."
10182 (if (not (equal (string-to-char desc) ?@))
10183 (setq desc (concat "@" desc)))
10184 (save-excursion
10185 (or tbeg (setq tbeg (org-table-begin)))
10186 (or col (setq col (org-table-current-column)))
10187 (let ((thisline (org-current-line))
10188 beg end c1 c2 r1 r2 rangep tmp)
10189 (unless (string-match org-table-range-regexp desc)
10190 (error "Invalid table range specifier `%s'" desc))
10191 (setq rangep (match-end 3)
10192 r1 (and (match-end 1) (match-string 1 desc))
10193 r2 (and (match-end 4) (match-string 4 desc))
10194 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10195 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10197 (and c1 (setq c1 (+ (string-to-number c1)
10198 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10199 (and c2 (setq c2 (+ (string-to-number c2)
10200 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10201 (if (equal r1 "") (setq r1 nil))
10202 (if (equal r2 "") (setq r2 nil))
10203 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10204 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10205 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10206 (if (not r1) (setq r1 thisline))
10207 (if (not r2) (setq r2 thisline))
10208 (if (not c1) (setq c1 col))
10209 (if (not c2) (setq c2 col))
10210 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10211 ;; just one field
10212 (progn
10213 (goto-line r1)
10214 (while (not (looking-at org-table-dataline-regexp))
10215 (beginning-of-line 2))
10216 (prog1 (org-trim (org-table-get-field c1))
10217 (if highlight (org-table-highlight-rectangle (point) (point)))))
10218 ;; A range, return a vector
10219 ;; First sort the numbers to get a regular ractangle
10220 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10221 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10222 (goto-line r1)
10223 (while (not (looking-at org-table-dataline-regexp))
10224 (beginning-of-line 2))
10225 (org-table-goto-column c1)
10226 (setq beg (point))
10227 (goto-line r2)
10228 (while (not (looking-at org-table-dataline-regexp))
10229 (beginning-of-line 0))
10230 (org-table-goto-column c2)
10231 (setq end (point))
10232 (if highlight
10233 (org-table-highlight-rectangle
10235 ;; return string representation of calc vector
10236 (mapcar 'org-trim
10237 (apply 'append (org-table-copy-region beg end)))))))
10239 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10240 "Analyze descriptor DESC and retrieve the corresponding line number.
10241 The cursor is currently in line CLINE, the table begins in line BLINE,
10242 and TABLE is a vector with line types."
10243 (if (string-match "^[0-9]+$" desc)
10244 (aref org-table-dlines (string-to-number desc))
10245 (setq cline (or cline (org-current-line))
10246 bline (or bline org-table-current-begin-line)
10247 table (or table org-table-current-line-types))
10248 (if (or
10250 ;; 1 2 3 4 5 6
10251 (and (not (match-end 3)) (not (match-end 6)))
10252 (and (match-end 3) (match-end 6) (not (match-end 5))))
10253 (error "invalid row descriptor `%s'" desc))
10254 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10255 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10256 (odir (and (match-end 5) (match-string 5 desc)))
10257 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10258 (i (- cline bline))
10259 (rel (and (match-end 6)
10260 (or (and (match-end 1) (not (match-end 3)))
10261 (match-end 5)))))
10262 (if (and hn (not hdir))
10263 (progn
10264 (setq i 0 hdir "+")
10265 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10266 (if (and (not hn) on (not odir))
10267 (error "should never happen");;(aref org-table-dlines on)
10268 (if (and hn (> hn 0))
10269 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10270 (if on
10271 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10272 (+ bline i)))))
10274 (defun org-find-row-type (table i type backwards relative n)
10275 (let ((l (length table)))
10276 (while (> n 0)
10277 (while (and (setq i (+ i (if backwards -1 1)))
10278 (>= i 0) (< i l)
10279 (not (eq (aref table i) type))
10280 (if (and relative (eq (aref table i) 'hline))
10281 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10282 t)))
10283 (setq n (1- n)))
10284 (if (or (< i 0) (>= i l))
10285 (error "Row descriptior leads outside table")
10286 i)))
10288 (defun org-rewrite-old-row-references (s)
10289 (if (string-match "&[-+0-9I]" s)
10290 (error "Formula contains old &row reference, please rewrite using @-syntax")
10291 s))
10293 (defun org-table-make-reference (elements keep-empty numbers lispp)
10294 "Convert list ELEMENTS to something appropriate to insert into formula.
10295 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10296 NUMBERS indicates that everything should be converted to numbers.
10297 LISPP means to return something appropriate for a Lisp list."
10298 (if (stringp elements) ; just a single val
10299 (if lispp
10300 (if (eq lispp 'literal)
10301 elements
10302 (prin1-to-string (if numbers (string-to-number elements) elements)))
10303 (if (equal elements "") (setq elements "0"))
10304 (if numbers (number-to-string (string-to-number elements)) elements))
10305 (unless keep-empty
10306 (setq elements
10307 (delq nil
10309 elements))))
10310 (setq elements (or elements '("0")))
10311 (if lispp
10312 (mapconcat
10313 (lambda (x)
10314 (if (eq lispp 'literal)
10315 x
10316 (prin1-to-string (if numbers (string-to-number x) x))))
10317 elements " ")
10318 (concat "[" (mapconcat
10319 (lambda (x)
10320 (if numbers (number-to-string (string-to-number x)) x))
10321 elements
10322 ",") "]"))))
10324 (defun org-table-recalculate (&optional all noalign)
10325 "Recalculate the current table line by applying all stored formulas.
10326 With prefix arg ALL, do this for all lines in the table."
10327 (interactive "P")
10328 (or (memq this-command org-recalc-commands)
10329 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10330 (unless (org-at-table-p) (error "Not at a table"))
10331 (if (equal all '(16))
10332 (org-table-iterate)
10333 (org-table-get-specials)
10334 (let* ((eqlist (sort (org-table-get-stored-formulas)
10335 (lambda (a b) (string< (car a) (car b)))))
10336 (inhibit-redisplay (not debug-on-error))
10337 (line-re org-table-dataline-regexp)
10338 (thisline (org-current-line))
10339 (thiscol (org-table-current-column))
10340 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10341 ;; Insert constants in all formulas
10342 (setq eqlist
10343 (mapcar (lambda (x)
10344 (setcdr x (org-table-formula-substitute-names (cdr x)))
10345 x)
10346 eqlist))
10347 ;; Split the equation list
10348 (while (setq eq (pop eqlist))
10349 (if (<= (string-to-char (car eq)) ?9)
10350 (push eq eqlnum)
10351 (push eq eqlname)))
10352 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10353 (if all
10354 (progn
10355 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10356 (goto-char (setq beg (org-table-begin)))
10357 (if (re-search-forward org-table-calculate-mark-regexp end t)
10358 ;; This is a table with marked lines, compute selected lines
10359 (setq line-re org-table-recalculate-regexp)
10360 ;; Move forward to the first non-header line
10361 (if (and (re-search-forward org-table-dataline-regexp end t)
10362 (re-search-forward org-table-hline-regexp end t)
10363 (re-search-forward org-table-dataline-regexp end t))
10364 (setq beg (match-beginning 0))
10365 nil))) ;; just leave beg where it is
10366 (setq beg (point-at-bol)
10367 end (move-marker (make-marker) (1+ (point-at-eol)))))
10368 (goto-char beg)
10369 (and all (message "Re-applying formulas to full table..."))
10371 ;; First find the named fields, and mark them untouchanble
10372 (remove-text-properties beg end '(org-untouchable t))
10373 (while (setq eq (pop eqlname))
10374 (setq name (car eq)
10375 a (assoc name org-table-named-field-locations))
10376 (and (not a)
10378 (setq a (list name
10379 (aref org-table-dlines
10380 (string-to-number (match-string 1 name)))
10381 (string-to-number (match-string 2 name)))))
10382 (when (and a (or all (equal (nth 1 a) thisline)))
10383 (message "Re-applying formula to field: %s" name)
10384 (goto-line (nth 1 a))
10385 (org-table-goto-column (nth 2 a))
10386 (push (append a (list (cdr eq))) eqlname1)
10387 (org-table-put-field-property :org-untouchable t)))
10389 ;; Now evauluate the column formulas, but skip fields covered by
10390 ;; field formulas
10391 (goto-char beg)
10392 (while (re-search-forward line-re end t)
10393 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10394 ;; Unprotected line, recalculate
10395 (and all (message "Re-applying formulas to full table...(line %d)"
10396 (setq cnt (1+ cnt))))
10397 (setq org-last-recalc-line (org-current-line))
10398 (setq eql eqlnum)
10399 (while (setq entry (pop eql))
10400 (goto-line org-last-recalc-line)
10401 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10402 (unless (get-text-property (point) :org-untouchable)
10403 (org-table-eval-formula nil (cdr entry)
10404 'noalign 'nocst 'nostore 'noanalysis)))))
10406 ;; Now evaluate the field formulas
10407 (while (setq eq (pop eqlname1))
10408 (message "Re-applying formula to field: %s" (car eq))
10409 (goto-line (nth 1 eq))
10410 (org-table-goto-column (nth 2 eq))
10411 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10412 'nostore 'noanalysis))
10414 (goto-line thisline)
10415 (org-table-goto-column thiscol)
10416 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10417 (or noalign (and org-table-may-need-update (org-table-align))
10418 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10420 ;; back to initial position
10421 (message "Re-applying formulas...done")
10422 (goto-line thisline)
10423 (org-table-goto-column thiscol)
10424 (or noalign (and org-table-may-need-update (org-table-align))
10425 (and all (message "Re-applying formulas...done"))))))
10427 (defun org-table-iterate (&optional arg)
10428 "Recalculate the table until it does not change anymore."
10429 (interactive "P")
10430 (let ((imax (if arg (prefix-numeric-value arg) 10))
10431 (i 0)
10432 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10433 thistbl)
10434 (catch 'exit
10435 (while (< i imax)
10436 (setq i (1+ i))
10437 (org-table-recalculate 'all)
10438 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10439 (if (not (string= lasttbl thistbl))
10440 (setq lasttbl thistbl)
10441 (if (> i 1)
10442 (message "Convergence after %d iterations" i)
10443 (message "Table was already stable"))
10444 (throw 'exit t)))
10445 (error "No convergence after %d iterations" i))))
10447 (defun org-table-formula-substitute-names (f)
10448 "Replace $const with values in string F."
10449 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10450 ;; First, check for column names
10451 (while (setq start (string-match org-table-column-name-regexp f start))
10452 (setq start (1+ start))
10453 (setq a (assoc (match-string 1 f) org-table-column-names))
10454 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10455 ;; Parameters and constants
10456 (setq start 0)
10458 (setq start (1+ start))
10459 (if (setq a (save-match-data
10460 (org-table-get-constant (match-string 1 f))))
10461 (setq f (replace-match
10462 (concat (if pp "(") a (if pp ")")) t t f))))
10463 (if org-table-formula-debug
10464 (put-text-property 0 (length f) :orig-formula f1 f))
10465 f))
10467 (defun org-table-get-constant (const)
10468 "Find the value for a parameter or constant in a formula.
10469 Parameters get priority."
10470 (or (cdr (assoc const org-table-local-parameters))
10471 (cdr (assoc const org-table-formula-constants-local))
10472 (cdr (assoc const org-table-formula-constants))
10473 (and (fboundp 'constants-get) (constants-get const))
10474 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10475 (org-entry-get nil (substring const 5) 'inherit))
10476 "#UNDEFINED_NAME"))
10478 (defvar org-table-fedit-map
10479 (let ((map (make-sparse-keymap)))
10480 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10481 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10482 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10483 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10484 (org-defkey map "\C-c?" 'org-table-show-reference)
10485 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10486 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10487 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10488 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10489 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10490 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10491 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10492 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10493 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10494 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10495 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10496 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10497 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10498 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10499 map))
10501 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10502 '("Edit-Formulas"
10503 ["Finish and Install" org-table-fedit-finish t]
10504 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10505 ["Abort" org-table-fedit-abort t]
10506 "--"
10507 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10508 ["Complete Lisp Symbol" lisp-complete-symbol t]
10509 "--"
10510 "Shift Reference at Point"
10511 ["Up" org-table-fedit-ref-up t]
10512 ["Down" org-table-fedit-ref-down t]
10513 ["Left" org-table-fedit-ref-left t]
10514 ["Right" org-table-fedit-ref-right t]
10515 "-"
10516 "Change Test Row for Column Formulas"
10517 ["Up" org-table-fedit-line-up t]
10518 ["Down" org-table-fedit-line-down t]
10519 "--"
10520 ["Scroll Table Window" org-table-fedit-scroll t]
10521 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10522 ["Show Table Grid" org-table-fedit-toggle-coordinates
10523 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10524 org-table-overlay-coordinates)]
10525 "--"
10526 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10527 :style toggle :selected org-table-buffer-is-an]))
10529 (defvar org-pos)
10531 (defun org-table-edit-formulas ()
10532 "Edit the formulas of the current table in a separate buffer."
10533 (interactive)
10535 (beginning-of-line 0))
10536 (unless (org-at-table-p) (error "Not at a table"))
10537 (org-table-get-specials)
10538 (let ((key (org-table-current-field-formula 'key 'noerror))
10539 (eql (sort (org-table-get-stored-formulas 'noerror)
10540 'org-table-formula-less-p))
10541 (pos (move-marker (make-marker) (point)))
10542 (startline 1)
10543 (wc (current-window-configuration))
10547 entry s type title)
10548 (org-switch-to-buffer-other-window "*Edit Formulas*")
10549 (erase-buffer)
10550 ;; Keep global-font-lock-mode from turning on font-lock-mode
10551 (let ((font-lock-global-modes '(not fundamental-mode)))
10552 (fundamental-mode))
10553 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10554 (org-set-local 'org-pos pos)
10555 (org-set-local 'org-window-configuration wc)
10556 (use-local-map org-table-fedit-map)
10557 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10558 (easy-menu-add org-table-fedit-menu)
10559 (setq startline (org-current-line))
10560 (while (setq entry (pop eql))
10561 (setq type (cond
10562 ((equal (string-to-char (car entry)) ?@) 'field)
10563 ((string-match "^[0-9]" (car entry)) 'column)
10564 (t 'named)))
10565 (when (setq title (assq type titles))
10567 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10568 (setq titles (delq title titles)))
10569 (if (equal key (car entry)) (setq startline (org-current-line)))
10570 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10572 (remove-text-properties 0 (length s) '(face nil) s)
10573 (insert s))
10574 (if (eq org-table-use-standard-references t)
10575 (org-table-fedit-toggle-ref-type))
10576 (goto-line startline)
10577 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10579 (defun org-table-fedit-post-command ()
10580 (when (not (memq this-command '(lisp-complete-symbol)))
10581 (let ((win (selected-window)))
10582 (save-excursion
10583 (condition-case nil
10584 (org-table-show-reference)
10585 (error nil))
10586 (select-window win)))))
10588 (defun org-table-formula-to-user (s)
10589 "Convert a formula from internal to user representation."
10590 (if (eq org-table-use-standard-references t)
10591 (org-table-convert-refs-to-an s)
10592 s))
10594 (defun org-table-formula-from-user (s)
10595 "Convert a formula from user to internal representation."
10596 (if org-table-use-standard-references
10597 (org-table-convert-refs-to-rc s)
10598 s))
10600 (defun org-table-convert-refs-to-rc (s)
10601 "Convert spreadsheet references from AB7 to @7$28.
10602 Works for single references, but also for entire formulas and even the
10603 full TBLFM line."
10604 (let ((start 0))
10606 (cond
10607 ((match-end 3)
10608 ;; format match, just advance
10609 (setq start (match-end 0)))
10610 ((and (> (match-beginning 0) 0)
10611 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10612 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10613 ;; 3.e5 or something like this.
10614 (setq start (match-end 0)))
10615 (t
10616 (setq start (match-beginning 0)
10617 s (replace-match
10618 (if (equal (match-string 2 s) "&")
10619 (format "$%d" (org-letters-to-number (match-string 1 s)))
10620 (format "@%d$%d"
10621 (string-to-number (match-string 2 s))
10622 (org-letters-to-number (match-string 1 s))))
10623 t t s)))))
10624 s))
10626 (defun org-table-convert-refs-to-an (s)
10627 "Convert spreadsheet references from to @7$28 to AB7.
10628 Works for single references, but also for entire formulas and even the
10629 full TBLFM line."
10631 (setq s (replace-match
10632 (format "%s%d"
10633 (org-number-to-letters
10634 (string-to-number (match-string 2 s)))
10635 (string-to-number (match-string 1 s)))
10636 t t s)))
10639 (org-number-to-letters
10640 (string-to-number (match-string 2 s))) "&")
10641 t nil s)))
10642 s)
10644 (defun org-letters-to-number (s)
10645 "Convert a base 26 number represented by letters into an integer.
10646 For example: AB -> 28."
10647 (let ((n 0))
10648 (setq s (upcase s))
10649 (while (> (length s) 0)
10650 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10651 s (substring s 1)))
10652 n))
10654 (defun org-number-to-letters (n)
10655 "Convert an integer into a base 26 number represented by letters.
10656 For example: 28 -> AB."
10657 (let ((s ""))
10658 (while (> n 0)
10659 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10660 n (/ (1- n) 26)))
10661 s))
10663 (defun org-table-fedit-convert-buffer (function)
10664 "Convert all references in this buffer, using FUNTION."
10665 (let ((line (org-current-line)))
10666 (goto-char (point-min))
10667 (while (not (eobp))
10668 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10669 (delete-region (point) (point-at-eol))
10670 (or (eobp) (forward-char 1)))
10671 (goto-line line)))
10673 (defun org-table-fedit-toggle-ref-type ()
10674 "Convert all references in the buffer from B3 to @3$2 and back."
10675 (interactive)
10676 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10677 (org-table-fedit-convert-buffer
10678 (if org-table-buffer-is-an
10679 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10680 (message "Reference type switched to %s"
10681 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10683 (defun org-table-fedit-ref-up ()
10684 "Shift the reference at point one row/hline up."
10685 (interactive)
10686 (org-table-fedit-shift-reference 'up))
10687 (defun org-table-fedit-ref-down ()
10688 "Shift the reference at point one row/hline down."
10689 (interactive)
10690 (org-table-fedit-shift-reference 'down))
10691 (defun org-table-fedit-ref-left ()
10692 "Shift the reference at point one field to the left."
10693 (interactive)
10694 (org-table-fedit-shift-reference 'left))
10695 (defun org-table-fedit-ref-right ()
10696 "Shift the reference at point one field to the right."
10697 (interactive)
10698 (org-table-fedit-shift-reference 'right))
10700 (defun org-table-fedit-shift-reference (dir)
10701 (cond
10703 (if (memq dir '(left right))
10704 (org-rematch-and-replace 1 (eq dir 'left))
10705 (error "Cannot shift reference in this direction")))
10707 ;; A B3-like reference
10708 (if (memq dir '(up down))
10709 (org-rematch-and-replace 2 (eq dir 'up))
10710 (org-rematch-and-replace 1 (eq dir 'left))))
10711 ((org-at-regexp-p
10713 ;; An internal reference
10714 (if (memq dir '(up down))
10715 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10716 (org-rematch-and-replace 5 (eq dir 'left))))))
10718 (defun org-rematch-and-replace (n &optional decr hline)
10719 "Re-match the group N, and replace it with the shifted refrence."
10720 (or (match-end n) (error "Cannot shift reference in this direction"))
10721 (goto-char (match-beginning n))
10722 (and (looking-at (regexp-quote (match-string n)))
10723 (replace-match (org-shift-refpart (match-string 0) decr hline)
10724 t t)))
10726 (defun org-shift-refpart (ref &optional decr hline)
10727 "Shift a refrence part REF.
10728 If DECR is set, decrease the references row/column, else increase.
10729 If HLINE is set, this may be a hline reference, it certainly is not
10730 a translation reference."
10731 (save-match-data
10732 (let* ((sign (string-match "^[-+]" ref)) n)
10734 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10735 (cond
10736 ((and hline (string-match "^I+" ref))
10737 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10738 (setq n (+ n (if decr -1 1)))
10739 (if (= n 0) (setq n (+ n (if decr -1 1))))
10740 (if sign
10741 (setq sign (if (< n 0) "-" "+") n (abs n))
10742 (setq n (max 1 n)))
10743 (concat sign (make-string n ?I)))
10745 ((string-match "^[0-9]+" ref)
10746 (setq n (string-to-number (concat sign ref)))
10747 (setq n (+ n (if decr -1 1)))
10748 (if sign
10749 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10750 (number-to-string (max 1 n))))
10752 ((string-match "^[a-zA-Z]+" ref)
10753 (org-number-to-letters
10754 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10756 (t (error "Cannot shift reference"))))))
10758 (defun org-table-fedit-toggle-coordinates ()
10759 "Toggle the display of coordinates in the refrenced table."
10760 (interactive)
10761 (let ((pos (marker-position org-pos)))
10762 (with-current-buffer (marker-buffer org-pos)
10763 (save-excursion
10764 (goto-char pos)
10765 (org-table-toggle-coordinate-overlays)))))
10767 (defun org-table-fedit-finish (&optional arg)
10768 "Parse the buffer for formula definitions and install them.
10769 With prefix ARG, apply the new formulas to the table."
10770 (interactive "P")
10771 (org-table-remove-rectangle-highlight)
10772 (if org-table-use-standard-references
10773 (progn
10774 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10775 (setq org-table-buffer-is-an nil)))
10776 (let ((pos org-pos) eql var form)
10777 (goto-char (point-min))
10778 (while (re-search-forward
10780 nil t)
10781 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10782 form (match-string 3))
10783 (setq form (org-trim form))
10784 (when (not (equal form ""))
10786 (setq form (replace-match " " t t form)))
10787 (when (assoc var eql)
10788 (error "Double formulas for %s" var))
10789 (push (cons var form) eql)))
10790 (setq org-pos nil)
10791 (set-window-configuration org-window-configuration)
10792 (select-window (get-buffer-window (marker-buffer pos)))
10793 (goto-char pos)
10794 (unless (org-at-table-p)
10795 (error "Lost table position - cannot install formulae"))
10796 (org-table-store-formulas eql)
10797 (move-marker pos nil)
10798 (kill-buffer "*Edit Formulas*")
10799 (if arg
10800 (org-table-recalculate 'all)
10801 (message "New formulas installed - press C-u C-c C-c to apply."))))
10803 (defun org-table-fedit-abort ()
10804 "Abort editing formulas, without installing the changes."
10805 (interactive)
10806 (org-table-remove-rectangle-highlight)
10807 (let ((pos org-pos))
10808 (set-window-configuration org-window-configuration)
10809 (select-window (get-buffer-window (marker-buffer pos)))
10810 (goto-char pos)
10811 (move-marker pos nil)
10812 (message "Formula editing aborted without installing changes")))
10814 (defun org-table-fedit-lisp-indent ()
10815 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10816 (interactive)
10817 (let ((pos (point)) beg end ind)
10818 (beginning-of-line 1)
10819 (cond
10821 (goto-char pos)
10822 (call-interactively 'lisp-indent-line))
10824 ((not (fboundp 'pp-buffer))
10825 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10826 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10827 (goto-char (- (match-end 0) 2))
10828 (setq beg (point))
10829 (setq ind (make-string (current-column) ?\ ))
10830 (condition-case nil (forward-sexp 1)
10831 (error
10832 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10833 (setq end (point))
10834 (save-restriction
10835 (narrow-to-region beg end)
10836 (if (eq last-command this-command)
10837 (progn
10838 (goto-char (point-min))
10839 (setq this-command nil)
10841 (replace-match " ")))
10842 (pp-buffer)
10843 (untabify (point-min) (point-max))
10844 (goto-char (1+ (point-min)))
10845 (while (re-search-forward "^." nil t)
10846 (beginning-of-line 1)
10847 (insert ind))
10848 (goto-char (point-max))
10849 (backward-delete-char 1)))
10850 (goto-char beg))
10851 (t nil))))
10853 (defvar org-show-positions nil)
10855 (defun org-table-show-reference (&optional local)
10856 "Show the location/value of the $ expression at point."
10857 (interactive)
10858 (org-table-remove-rectangle-highlight)
10859 (catch 'exit
10860 (let ((pos (if local (point) org-pos))
10861 (face2 'highlight)
10862 (org-inhibit-highlight-removal t)
10863 (win (selected-window))
10864 (org-show-positions nil)
10865 var name e what match dest)
10866 (if local (org-table-get-specials))
10867 (setq what (cond
10868 ((or (org-at-regexp-p org-table-range-regexp2)
10869 (org-at-regexp-p org-table-translate-regexp)
10870 (org-at-regexp-p org-table-range-regexp))
10871 (setq match
10872 (save-match-data
10873 (org-table-convert-refs-to-rc (match-string 0))))
10874 'range)
10877 ((not local) nil)
10878 (t (error "No reference at point")))
10879 match (and what (or match (match-string 0))))
10880 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10881 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10882 'secondary-selection))
10883 (org-add-hook 'before-change-functions
10884 'org-table-remove-rectangle-highlight)
10885 (if (eq what 'name) (setq var (substring match 1)))
10886 (when (eq what 'range)
10887 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10888 (setq match (org-table-formula-substitute-names match)))
10889 (unless local
10890 (save-excursion
10891 (end-of-line 1)
10893 (beginning-of-line 1)
10895 (setq dest
10896 (save-match-data
10897 (org-table-convert-refs-to-rc (match-string 1))))
10898 (org-table-add-rectangle-overlay
10899 (match-beginning 1) (match-end 1) face2))))
10900 (if (and (markerp pos) (marker-buffer pos))
10901 (if (get-buffer-window (marker-buffer pos))
10902 (select-window (get-buffer-window (marker-buffer pos)))
10903 (org-switch-to-buffer-other-window (get-buffer-window
10904 (marker-buffer pos)))))
10905 (goto-char pos)
10906 (org-table-force-dataline)
10907 (when dest
10908 (setq name (substring dest 1))
10909 (cond
10911 (setq e (assoc name org-table-named-field-locations))
10912 (goto-line (nth 1 e))
10913 (org-table-goto-column (nth 2 e)))
10915 (let ((l (string-to-number (match-string 1 dest)))
10916 (c (string-to-number (match-string 2 dest))))
10917 (goto-line (aref org-table-dlines l))
10918 (org-table-goto-column c)))
10919 (t (org-table-goto-column (string-to-number name))))
10920 (move-marker pos (point))
10921 (org-table-highlight-rectangle nil nil face2))
10922 (cond
10923 ((equal dest match))
10924 ((not match))
10925 ((eq what 'range)
10926 (condition-case nil
10927 (save-excursion
10928 (org-table-get-range match nil nil 'highlight))
10929 (error nil)))
10930 ((setq e (assoc var org-table-named-field-locations))
10931 (goto-line (nth 1 e))
10932 (org-table-goto-column (nth 2 e))
10933 (org-table-highlight-rectangle (point) (point))
10934 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10935 ((setq e (assoc var org-table-column-names))
10936 (org-table-goto-column (string-to-number (cdr e)))
10937 (org-table-highlight-rectangle (point) (point))
10938 (goto-char (org-table-begin))
10940 (org-table-end) t)
10941 (progn
10942 (goto-char (match-beginning 1))
10943 (org-table-highlight-rectangle)
10944 (message "Named column (column %s)" (cdr e)))
10945 (error "Column name not found")))
10946 ((eq what 'column)
10947 ;; column number
10948 (org-table-goto-column (string-to-number (substring match 1)))
10949 (org-table-highlight-rectangle (point) (point))
10950 (message "Column %s" (substring match 1)))
10951 ((setq e (assoc var org-table-local-parameters))
10952 (goto-char (org-table-begin))
10954 (progn
10955 (goto-char (match-beginning 1))
10956 (org-table-highlight-rectangle)
10957 (message "Local parameter."))
10958 (error "Parameter not found")))
10959 (t
10960 (cond
10961 ((not var) (error "No reference at point"))
10962 ((setq e (assoc var org-table-formula-constants-local))
10963 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10964 var (cdr e)))
10965 ((setq e (assoc var org-table-formula-constants))
10966 (message "Constant: $%s=%s in `org-table-formula-constants'."
10967 var (cdr e)))
10968 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10969 (message "Constant: $%s=%s, from `constants.el'%s."
10970 var e (format " (%s units)" constants-unit-system)))
10971 (t (error "Undefined name $%s" var)))))
10972 (goto-char pos)
10973 (when (and org-show-positions
10974 (not (memq this-command '(org-table-fedit-scroll
10975 org-table-fedit-scroll-down))))
10976 (push pos org-show-positions)
10977 (push org-table-current-begin-pos org-show-positions)
10978 (let ((min (apply 'min org-show-positions))
10979 (max (apply 'max org-show-positions)))
10980 (goto-char min) (recenter 0)
10981 (goto-char max)
10982 (or (pos-visible-in-window-p max) (recenter -1))))
10983 (select-window win))))
10985 (defun org-table-force-dataline ()
10986 "Make sure the cursor is in a dataline in a table."
10987 (unless (save-excursion
10988 (beginning-of-line 1)
10989 (looking-at org-table-dataline-regexp))
10990 (let* ((re org-table-dataline-regexp)
10991 (p1 (save-excursion (re-search-forward re nil 'move)))
10992 (p2 (save-excursion (re-search-backward re nil 'move))))
10993 (cond ((and p1 p2)
10994 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10995 p1 p2)))
10996 ((or p1 p2) (goto-char (or p1 p2)))
10997 (t (error "No table dataline around here"))))))
10999 (defun org-table-fedit-line-up ()
11000 "Move cursor one line up in the window showing the table."
11001 (interactive)
11002 (org-table-fedit-move 'previous-line))
11004 (defun org-table-fedit-line-down ()
11005 "Move cursor one line down in the window showing the table."
11006 (interactive)
11007 (org-table-fedit-move 'next-line))
11009 (defun org-table-fedit-move (command)
11010 "Move the cursor in the window shoinw the table.
11011 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11012 (let ((org-table-allow-automatic-line-recalculation nil)
11013 (pos org-pos) (win (selected-window)) p)
11014 (select-window (get-buffer-window (marker-buffer org-pos)))
11015 (setq p (point))
11016 (call-interactively command)
11017 (while (and (org-at-table-p)
11018 (org-at-table-hline-p))
11019 (call-interactively command))
11020 (or (org-at-table-p) (goto-char p))
11021 (move-marker pos (point))
11022 (select-window win)))
11024 (defun org-table-fedit-scroll (N)
11025 (interactive "p")
11026 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11027 (scroll-other-window N)))
11029 (defun org-table-fedit-scroll-down (N)
11030 (interactive "p")
11031 (org-table-fedit-scroll (- N)))
11033 (defvar org-table-rectangle-overlays nil)
11035 (defun org-table-add-rectangle-overlay (beg end &optional face)
11036 "Add a new overlay."
11037 (let ((ov (org-make-overlay beg end)))
11038 (org-overlay-put ov 'face (or face 'secondary-selection))
11039 (push ov org-table-rectangle-overlays)))
11041 (defun org-table-highlight-rectangle (&optional beg end face)
11042 "Highlight rectangular region in a table."
11043 (setq beg (or beg (point)) end (or end (point)))
11044 (let ((b (min beg end))
11045 (e (max beg end))
11046 l1 c1 l2 c2 tmp)
11047 (and (boundp 'org-show-positions)
11048 (setq org-show-positions (cons b (cons e org-show-positions))))
11049 (goto-char (min beg end))
11050 (setq l1 (org-current-line)
11051 c1 (org-table-current-column))
11052 (goto-char (max beg end))
11053 (setq l2 (org-current-line)
11054 c2 (org-table-current-column))
11055 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11056 (goto-line l1)
11057 (beginning-of-line 1)
11058 (loop for line from l1 to l2 do
11059 (when (looking-at org-table-dataline-regexp)
11060 (org-table-goto-column c1)
11062 (org-table-goto-column c2)
11064 (org-table-add-rectangle-overlay beg end face))
11065 (beginning-of-line 2))
11066 (goto-char b))
11067 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11069 (defun org-table-remove-rectangle-highlight (&rest ignore)
11070 "Remove the rectangle overlays."
11071 (unless org-inhibit-highlight-removal
11072 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11073 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11074 (setq org-table-rectangle-overlays nil)))
11076 (defvar org-table-coordinate-overlays nil
11077 "Collects the cooordinate grid overlays, so that they can be removed.")
11078 (make-variable-buffer-local 'org-table-coordinate-overlays)
11080 (defun org-table-overlay-coordinates ()
11081 "Add overlays to the table at point, to show row/column coordinates."
11082 (interactive)
11083 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11084 (setq org-table-coordinate-overlays nil)
11085 (save-excursion
11086 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11087 (goto-char (org-table-begin))
11088 (while (org-at-table-p)
11089 (setq eol (point-at-eol))
11090 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11091 (push ov org-table-coordinate-overlays)
11092 (setq hline (looking-at org-table-hline-regexp))
11093 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11094 (format "%4d" (setq id (1+ id)))))
11095 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11096 (when hline
11097 (setq ic 0)
11099 (setq beg (1+ (match-beginning 0))
11100 ic (1+ ic)
11101 s1 (concat "$" (int-to-string ic))
11102 s2 (org-number-to-letters ic)
11103 str (if (eq org-table-use-standard-references t) s2 s1))
11104 (setq ov (org-make-overlay beg (+ beg (length str))))
11105 (push ov org-table-coordinate-overlays)
11106 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11107 (beginning-of-line 2)))))
11109 (defun org-table-toggle-coordinate-overlays ()
11110 "Toggle the display of Row/Column numbers in tables."
11111 (interactive)
11112 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11113 (message "Row/Column number display turned %s"
11114 (if org-table-overlay-coordinates "on" "off"))
11115 (if (and (org-at-table-p) org-table-overlay-coordinates)
11116 (org-table-align))
11117 (unless org-table-overlay-coordinates
11118 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11119 (setq org-table-coordinate-overlays nil)))
11121 (defun org-table-toggle-formula-debugger ()
11122 "Toggle the formula debugger in tables."
11123 (interactive)
11124 (setq org-table-formula-debug (not org-table-formula-debug))
11125 (message "Formula debugging has been turned %s"
11126 (if org-table-formula-debug "on" "off")))
11128 ;;; The orgtbl minor mode
11130 ;; Define a minor mode which can be used in other modes in order to
11131 ;; integrate the org-mode table editor.
11133 ;; This is really a hack, because the org-mode table editor uses several
11134 ;; keys which normally belong to the major mode, for example the TAB and
11135 ;; RET keys. Here is how it works: The minor mode defines all the keys
11136 ;; necessary to operate the table editor, but wraps the commands into a
11137 ;; function which tests if the cursor is currently inside a table. If that
11138 ;; is the case, the table editor command is executed. However, when any of
11139 ;; those keys is used outside a table, the function uses `key-binding' to
11140 ;; look up if the key has an associated command in another currently active
11141 ;; keymap (minor modes, major mode, global), and executes that command.
11142 ;; There might be problems if any of the keys used by the table editor is
11143 ;; otherwise used as a prefix key.
11145 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11146 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11147 ;; addresses this by checking explicitly for both bindings.
11149 ;; The optimized version (see variable `orgtbl-optimized') takes over
11150 ;; all keys which are bound to `self-insert-command' in the *global map*.
11151 ;; Some modes bind other commands to simple characters, for example
11152 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11153 ;; active, this binding is ignored inside tables and replaced with a
11154 ;; modified self-insert.
11156 (defvar orgtbl-mode nil
11157 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11158 table editor in arbitrary modes.")
11159 (make-variable-buffer-local 'orgtbl-mode)
11161 (defvar orgtbl-mode-map (make-keymap)
11162 "Keymap for `orgtbl-mode'.")
11164 ;;;###autoload
11165 (defun turn-on-orgtbl ()
11166 "Unconditionally turn on `orgtbl-mode'."
11167 (orgtbl-mode 1))
11169 (defvar org-old-auto-fill-inhibit-regexp nil
11170 "Local variable used by `orgtbl-mode'")
11173 "Matches a line belonging to an orgtbl.")
11175 (defconst orgtbl-extra-font-lock-keywords
11176 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11177 0 (quote 'org-table) 'prepend))
11178 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11180 ;;;###autoload
11181 (defun orgtbl-mode (&optional arg)
11182 "The `org-mode' table editor as a minor mode for use in other modes."
11183 (interactive)
11184 (if (org-mode-p)
11185 ;; Exit without error, in case some hook functions calls this
11186 ;; by accident in org-mode.
11187 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11188 (setq orgtbl-mode
11189 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11190 (if orgtbl-mode
11191 (progn
11192 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11193 ;; Make sure we are first in minor-mode-map-alist
11194 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11195 (and c (setq minor-mode-map-alist
11196 (cons c (delq c minor-mode-map-alist)))))
11197 (org-set-local (quote org-table-may-need-update) t)
11198 (org-add-hook 'before-change-functions 'org-before-change-function
11199 nil 'local)
11200 (org-set-local 'org-old-auto-fill-inhibit-regexp
11201 auto-fill-inhibit-regexp)
11202 (org-set-local 'auto-fill-inhibit-regexp
11203 (if auto-fill-inhibit-regexp
11205 auto-fill-inhibit-regexp)
11206 orgtbl-line-start-regexp))
11207 (org-add-to-invisibility-spec '(org-cwidth))
11208 (when (fboundp 'font-lock-add-keywords)
11209 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11210 (org-restart-font-lock))
11211 (easy-menu-add orgtbl-mode-menu)
11212 (run-hooks 'orgtbl-mode-hook))
11213 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11214 (org-cleanup-narrow-column-properties)
11215 (org-remove-from-invisibility-spec '(org-cwidth))
11216 (remove-hook 'before-change-functions 'org-before-change-function t)
11217 (when (fboundp 'font-lock-remove-keywords)
11218 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11219 (org-restart-font-lock))
11220 (easy-menu-remove orgtbl-mode-menu)
11221 (force-mode-line-update 'all))))
11223 (defun org-cleanup-narrow-column-properties ()
11224 "Remove all properties related to narrow-column invisibility."
11225 (let ((s 1))
11226 (while (setq s (text-property-any s (point-max)
11227 'display org-narrow-column-arrow))
11228 (remove-text-properties s (1+ s) '(display t)))
11229 (setq s 1)
11230 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11231 (remove-text-properties s (1+ s) '(org-cwidth t)))
11232 (setq s 1)
11233 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11234 (remove-text-properties s (1+ s) '(invisible t)))))
11236 ;; Install it as a minor mode.
11237 (put 'orgtbl-mode :included t)
11238 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11239 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11241 (defun orgtbl-make-binding (fun n &rest keys)
11242 "Create a function for binding in the table minor mode.
11243 FUN is the command to call inside a table. N is used to create a unique
11244 command name. KEYS are keys that should be checked in for a command
11245 to execute outside of tables."
11246 (eval
11247 (list 'defun
11248 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11249 '(arg)
11251 "Outside of tables, run the binding of `"
11252 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11253 "'.")
11254 '(interactive "p")
11255 (list 'if
11256 '(org-at-table-p)
11257 (list 'call-interactively (list 'quote fun))
11258 (list 'let '(orgtbl-mode)
11259 (list 'call-interactively
11260 (append '(or)
11261 (mapcar (lambda (k)
11262 (list 'key-binding k))
11263 keys)
11264 '('orgtbl-error))))))))
11266 (defun orgtbl-error ()
11267 "Error when there is no default binding for a table key."
11268 (interactive)
11269 (error "This key has no function outside tables"))
11271 (defun orgtbl-setup ()
11272 "Setup orgtbl keymaps."
11273 (let ((nfunc 0)
11274 (bindings
11275 (list
11276 '([(meta shift left)] org-table-delete-column)
11277 '([(meta left)] org-table-move-column-left)
11278 '([(meta right)] org-table-move-column-right)
11279 '([(meta shift right)] org-table-insert-column)
11280 '([(meta shift up)] org-table-kill-row)
11281 '([(meta shift down)] org-table-insert-row)
11282 '([(meta up)] org-table-move-row-up)
11283 '([(meta down)] org-table-move-row-down)
11284 '("\C-c\C-w" org-table-cut-region)
11285 '("\C-c\M-w" org-table-copy-region)
11286 '("\C-c\C-y" org-table-paste-rectangle)
11287 '("\C-c-" org-table-insert-hline)
11288 '("\C-c}" org-table-toggle-coordinate-overlays)
11289 '("\C-c{" org-table-toggle-formula-debugger)
11290 '("\C-m" org-table-next-row)
11291 '([(shift return)] org-table-copy-down)
11292 '("\C-c\C-q" org-table-wrap-region)
11293 '("\C-c?" org-table-field-info)
11294 '("\C-c " org-table-blank-field)
11295 '("\C-c+" org-table-sum)
11296 '("\C-c=" org-table-eval-formula)
11297 '("\C-c'" org-table-edit-formulas)
11298 '("\C-c`" org-table-edit-field)
11299 '("\C-c*" org-table-recalculate)
11300 '("\C-c|" org-table-create-or-convert-from-region)
11301 '("\C-c^" org-table-sort-lines)
11302 '([(control ?#)] org-table-rotate-recalc-marks)))
11303 elt key fun cmd)
11304 (while (setq elt (pop bindings))
11305 (setq nfunc (1+ nfunc))
11306 (setq key (org-key (car elt))
11307 fun (nth 1 elt)
11308 cmd (orgtbl-make-binding fun nfunc key))
11309 (org-defkey orgtbl-mode-map key cmd))
11311 ;; Special treatment needed for TAB and RET
11312 (org-defkey orgtbl-mode-map [(return)]
11313 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11314 (org-defkey orgtbl-mode-map "\C-m"
11315 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11317 (org-defkey orgtbl-mode-map [(tab)]
11318 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11319 (org-defkey orgtbl-mode-map "\C-i"
11320 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11322 (org-defkey orgtbl-mode-map [(shift tab)]
11323 (orgtbl-make-binding 'org-table-previous-field 104
11324 [(shift tab)] [(tab)] "\C-i"))
11326 (org-defkey orgtbl-mode-map "\M-\C-m"
11327 (orgtbl-make-binding 'org-table-wrap-region 105
11328 "\M-\C-m" [(meta return)]))
11329 (org-defkey orgtbl-mode-map [(meta return)]
11330 (orgtbl-make-binding 'org-table-wrap-region 106
11331 [(meta return)] "\M-\C-m"))
11333 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11334 (when orgtbl-optimized
11335 ;; If the user wants maximum table support, we need to hijack
11336 ;; some standard editing functions
11337 (org-remap orgtbl-mode-map
11338 'self-insert-command 'orgtbl-self-insert-command
11339 'delete-char 'org-delete-char
11340 'delete-backward-char 'org-delete-backward-char)
11341 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11342 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11343 '("OrgTbl"
11344 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11345 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11346 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11347 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11348 "--"
11349 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11350 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11351 ["Copy Field from Above"
11352 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11353 "--"
11354 ("Column"
11355 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11356 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11357 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11358 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11359 ("Row"
11360 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11361 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11362 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11363 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11364 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11365 "--"
11366 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11367 ("Rectangle"
11368 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11369 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11370 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11371 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11372 "--"
11373 ("Radio tables"
11374 ["Insert table template" orgtbl-insert-radio-table
11375 (assq major-mode orgtbl-radio-table-templates)]
11376 ["Comment/uncomment table" orgtbl-toggle-comment t])
11377 "--"
11378 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11379 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11380 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11381 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11382 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11383 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11384 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11385 ["Sum Column/Rectangle" org-table-sum
11386 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11387 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11388 ["Debug Formulas"
11389 org-table-toggle-formula-debugger :active (org-at-table-p)
11390 :keys "C-c {"
11391 :style toggle :selected org-table-formula-debug]
11392 ["Show Col/Row Numbers"
11393 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11394 :keys "C-c }"
11395 :style toggle :selected org-table-overlay-coordinates]
11396 ))
11397 t))
11399 (defun orgtbl-ctrl-c-ctrl-c (arg)
11400 "If the cursor is inside a table, realign the table.
11401 It it is a table to be sent away to a receiver, do it.
11402 With prefix arg, also recompute table."
11403 (interactive "P")
11404 (let ((pos (point)) action)
11405 (save-excursion
11406 (beginning-of-line 1)
11410 (cond
11411 ((integerp action)
11412 (goto-char action)
11413 (org-table-maybe-eval-formula)
11414 (if arg
11415 (call-interactively 'org-table-recalculate)
11416 (org-table-maybe-recalculate-line))
11417 (call-interactively 'org-table-align)
11418 (orgtbl-send-table 'maybe))
11419 ((eq action 'recalc)
11420 (save-excursion
11421 (beginning-of-line 1)
11423 (if (org-at-table-p)
11424 (org-call-with-arg 'org-table-recalculate t))))
11425 (t (let (orgtbl-mode)
11426 (call-interactively (key-binding "\C-c\C-c")))))))
11428 (defun orgtbl-tab (arg)
11429 "Justification and field motion for `orgtbl-mode'."
11430 (interactive "P")
11431 (if arg (org-table-edit-field t)
11432 (org-table-justify-field-maybe)
11433 (org-table-next-field)))
11435 (defun orgtbl-ret ()
11436 "Justification and field motion for `orgtbl-mode'."
11437 (interactive)
11438 (org-table-justify-field-maybe)
11439 (org-table-next-row))
11441 (defun orgtbl-self-insert-command (N)
11442 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11443 If the cursor is in a table looking at whitespace, the whitespace is
11444 overwritten, and the table is not marked as requiring realignment."
11445 (interactive "p")
11446 (if (and (org-at-table-p)
11447 (or
11448 (and org-table-auto-blank-field
11449 (member last-command
11450 '(orgtbl-hijacker-command-100
11451 orgtbl-hijacker-command-101
11452 orgtbl-hijacker-command-102
11453 orgtbl-hijacker-command-103
11454 orgtbl-hijacker-command-104
11455 orgtbl-hijacker-command-105))
11456 (org-table-blank-field))
11457 t)
11458 (eq N 1)
11460 (let (org-table-may-need-update)
11461 (goto-char (1- (match-end 0)))
11462 (delete-backward-char 1)
11463 (goto-char (match-beginning 0))
11464 (self-insert-command N))
11465 (setq org-table-may-need-update t)
11466 (let (orgtbl-mode)
11467 (call-interactively (key-binding (vector last-input-event))))))
11469 (defun org-force-self-insert (N)
11470 "Needed to enforce self-insert under remapping."
11471 (interactive "p")
11472 (self-insert-command N))
11475 "Regula expression matching exponentials as produced by calc.")
11477 (defvar org-table-clean-did-remove-column nil)
11479 (defun orgtbl-export (table target)
11480 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11482 org-table-last-alignment org-table-last-column-widths
11483 maxcol column)
11484 (if (not (fboundp func))
11485 (error "Cannot export orgtbl table to %s" target))
11486 (setq lines (org-table-clean-before-export lines))
11487 (setq table
11488 (mapcar
11489 (lambda (x)
11490 (if (string-match org-table-hline-regexp x)
11491 'hline
11493 lines))
11494 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11495 table)))
11496 (loop for i from (1- maxcol) downto 0 do
11497 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11498 (setq column (delq nil column))
11499 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11500 (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))
11501 (funcall func table nil)))
11503 (defun orgtbl-send-table (&optional maybe)
11504 "Send a tranformed version of this table to the receiver position.
11505 With argument MAYBE, fail quietly if no transformation is defined for
11506 this table."
11507 (interactive)
11508 (catch 'exit
11509 (unless (org-at-table-p) (error "Not at a table"))
11510 ;; when non-interactive, we assume align has just happened.
11511 (when (interactive-p) (org-table-align))
11512 (save-excursion
11513 (goto-char (org-table-begin))
11514 (beginning-of-line 0)
11516 (if maybe
11517 (throw 'exit nil)
11518 (error "Don't know how to transform this table."))))
11519 (let* ((name (match-string 1))
11520 beg
11521 (transform (intern (match-string 2)))
11522 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11523 (skip (plist-get params :skip))
11524 (skipcols (plist-get params :skipcols))
11525 (txt (buffer-substring-no-properties
11526 (org-table-begin) (org-table-end)))
11528 (lines (org-table-clean-before-export lines))
11529 (i0 (if org-table-clean-did-remove-column 2 1))
11530 (table (mapcar
11531 (lambda (x)
11532 (if (string-match org-table-hline-regexp x)
11533 'hline
11534 (org-remove-by-index
11536 skipcols i0)))
11537 lines))
11538 (fun (if (= i0 2) 'cdr 'identity))
11539 (org-table-last-alignment
11540 (org-remove-by-index (funcall fun org-table-last-alignment)
11541 skipcols i0))
11542 (org-table-last-column-widths
11543 (org-remove-by-index (funcall fun org-table-last-column-widths)
11544 skipcols i0)))
11546 (unless (fboundp transform)
11547 (error "No such transformation function %s" transform))
11548 (setq txt (funcall transform table params))
11549 ;; Find the insertion place
11550 (save-excursion
11551 (goto-char (point-min))
11552 (unless (re-search-forward
11554 (error "Don't know where to insert translated table"))
11555 (goto-char (match-beginning 0))
11556 (beginning-of-line 2)
11557 (setq beg (point))
11558 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11559 (error "Cannot find end of insertion region"))
11560 (beginning-of-line 1)
11561 (delete-region beg (point))
11562 (goto-char beg)
11564 (message "Table converted and installed at receiver location"))))
11566 (defun org-remove-by-index (list indices &optional i0)
11567 "Remove the elements in LIST with indices in INDICES.
11568 First element has index 0, or I0 if given."
11569 (if (not indices)
11570 list
11571 (if (integerp indices) (setq indices (list indices)))
11572 (setq i0 (1- (or i0 0)))
11573 (delq :rm (mapcar (lambda (x)
11574 (setq i0 (1+ i0))
11575 (if (memq i0 indices) :rm x))
11576 list))))
11578 (defun orgtbl-toggle-comment ()
11579 "Comment or uncomment the orgtbl at point."
11580 (interactive)
11581 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11582 (re2 (concat "^" orgtbl-line-start-regexp))
11583 (commented (save-excursion (beginning-of-line 1)
11584 (cond ((looking-at re1) t)
11585 ((looking-at re2) nil)
11586 (t (error "Not at an org table")))))
11587 (re (if commented re1 re2))
11588 beg end)
11589 (save-excursion
11590 (beginning-of-line 1)
11591 (while (looking-at re) (beginning-of-line 0))
11592 (beginning-of-line 2)
11593 (setq beg (point))
11594 (while (looking-at re) (beginning-of-line 2))
11595 (setq end (point)))
11596 (comment-region beg end (if commented '(4) nil))))
11598 (defun orgtbl-insert-radio-table ()
11599 "Insert a radio table template appropriate for this major mode."
11600 (interactive)
11601 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11602 (txt (nth 1 e))
11603 name pos)
11604 (unless e (error "No radio table setup defined for %s" major-mode))
11605 (setq name (read-string "Table name: "))
11606 (while (string-match "%n" txt)
11607 (setq txt (replace-match name t t txt)))
11609 (setq pos (point))
11610 (insert txt)
11611 (goto-char pos)))
11613 (defun org-get-param (params header i sym &optional hsym)
11614 "Get parameter value for symbol SYM.
11615 If this is a header line, actually get the value for the symbol with an
11617 If the value is a protperty list, get the element for the current column.
11618 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11619 (let ((val (plist-get params sym)))
11620 (and hsym header (setq val (or (plist-get params hsym) val)))
11621 (if (consp val) (plist-get val i) val)))
11623 (defun orgtbl-to-generic (table params)
11624 "Convert the orgtbl-mode TABLE to some other format.
11625 This generic routine can be used for many standard cases.
11626 TABLE is a list, each entry either the symbol `hline' for a horizontal
11627 separator line, or a list of fields for that line.
11628 PARAMS is a property list of parameters that can influence the conversion.
11629 For the generic converter, some parameters are obligatory: You need to
11630 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11631 :splice, you must have :tstart and :tend.
11633 Valid parameters are
11635 :tstart String to start the table. Ignored when :splice is t.
11636 :tend String to end the table. Ignored when :splice is t.
11638 :splice When set to t, return only table body lines, don't wrap
11639 them into :tstart and :tend. Default is nil.
11641 :hline String to be inserted on horizontal separation lines.
11642 May be nil to ignore hlines.
11644 :lstart String to start a new table line.
11645 :lend String to end a table line
11646 :sep Separator between two fields
11647 :lfmt Format for entire line, with enough %s to capture all fields.
11648 If this is present, :lstart, :lend, and :sep are ignored.
11649 :fmt A format to be used to wrap the field, should contain
11650 %s for the original field value. For example, to wrap
11652 This may also be a property list with column numbers and
11655 :hlstart :hlend :hlsep :hlfmt :hfmt
11656 Same as above, specific for the header lines in the table.
11657 All lines before the first hline are treated as header.
11658 If any of these is not present, the data line value is used.
11660 :efmt Use this format to print numbers with exponentials.
11661 The format should have %s twice for inserting mantissa
11663 may also be a property list with column numbers and
11664 formats. :fmt will still be applied after :efmt.
11666 In addition to this, the parameters :skip and :skipcols are always handled
11667 directly by `orgtbl-send-table'. See manual."
11668 (interactive)
11669 (let* ((p params)
11670 (splicep (plist-get p :splice))
11671 (hline (plist-get p :hline))
11672 rtn line i fm efm lfmt h)
11674 ;; Do we have a header?
11675 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11676 (setq h t))
11678 ;; Put header
11679 (unless splicep
11680 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11682 ;; Now loop over all lines
11683 (while (setq line (pop table))
11684 (if (eq line 'hline)
11685 ;; A horizontal separator line
11686 (progn (if hline (push hline rtn))
11687 (setq h nil)) ; no longer in header
11688 ;; A normal line. Convert the fields, push line onto the result list
11689 (setq i 0)
11690 (setq line
11691 (mapcar
11692 (lambda (f)
11693 (setq i (1+ i)
11694 fm (org-get-param p h i :fmt :hfmt)
11695 efm (org-get-param p h i :efmt))
11696 (if (and efm (string-match orgtbl-exp-regexp f))
11697 (setq f (format
11698 efm (match-string 1 f) (match-string 2 f))))
11699 (if fm (setq f (format fm f)))
11700 f)
11701 line))
11702 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11703 (push (apply 'format lfmt line) rtn)
11704 (push (concat
11705 (org-get-param p h i :lstart :hlstart)
11706 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11707 (org-get-param p h i :lend :hlend))
11708 rtn))))
11710 (unless splicep
11711 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11715 (defun orgtbl-to-latex (table params)
11716 "Convert the orgtbl-mode TABLE to LaTeX.
11717 TABLE is a list, each entry either the symbol `hline' for a horizontal
11718 separator line, or a list of fields for that line.
11719 PARAMS is a property list of parameters that can influence the conversion.
11720 Supports all parameters from `orgtbl-to-generic'. Most important for
11721 LaTeX are:
11723 :splice When set to t, return only table body lines, don't wrap
11724 them into a tabular environment. Default is nil.
11726 :fmt A format to be used to wrap the field, should contain %s for the
11727 original field value. For example, to wrap everything in dollars,
11731 :efmt Format for transforming numbers with exponentials. The format
11732 should have %s twice for inserting mantissa and exponent, for
11734 This may also be a property list with column numbers and formats.
11736 The general parameters :skip and :skipcols have already been applied when
11737 this function is called."
11738 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11739 org-table-last-alignment ""))
11740 (params2
11741 (list
11746 (orgtbl-to-generic table (org-combine-plists params2 params))))
11748 (defun orgtbl-to-html (table params)
11749 "Convert the orgtbl-mode TABLE to LaTeX.
11750 TABLE is a list, each entry either the symbol `hline' for a horizontal
11751 separator line, or a list of fields for that line.
11752 PARAMS is a property list of parameters that can influence the conversion.
11753 Currently this function recognizes the following parameters:
11755 :splice When set to t, return only table body lines, don't wrap
11756 them into a <table> environment. Default is nil.
11758 The general parameters :skip and :skipcols have already been applied when
11759 this function is called. The function does *not* use `orgtbl-to-generic',
11760 so you cannot specify parameters for it."
11761 (let* ((splicep (plist-get params :splice))
11762 html)
11763 ;; Just call the formatter we already have
11764 ;; We need to make text lines for it, so put the fields back together.
11765 (setq html (org-format-org-table-html
11766 (mapcar
11767 (lambda (x)
11768 (if (eq x 'hline)
11769 "|----+----|"
11770 (concat "| " (mapconcat 'identity x " | ") " |")))
11771 table)
11772 splicep))
11774 (setq html (replace-match "" t t html)))
11775 html))
11777 (defun orgtbl-to-texinfo (table params)
11778 "Convert the orgtbl-mode TABLE to TeXInfo.
11779 TABLE is a list, each entry either the symbol `hline' for a horizontal
11780 separator line, or a list of fields for that line.
11781 PARAMS is a property list of parameters that can influence the conversion.
11782 Supports all parameters from `orgtbl-to-generic'. Most important for
11783 TeXInfo are:
11785 :splice nil/t When set to t, return only table body lines, don't wrap
11786 them into a multitable environment. Default is nil.
11788 :fmt fmt A format to be used to wrap the field, should contain
11789 %s for the original field value. For example, to wrap
11791 This may also be a property list with column numbers and
11795 are computed automatically from the width of the columns
11796 under org-mode.
11798 The general parameters :skip and :skipcols have already been applied when
11799 this function is called."
11800 (let* ((total (float (apply '+ org-table-last-column-widths)))
11801 (colfrac (or (plist-get params :cf)
11802 (mapconcat
11803 (lambda (x) (format "%.3f" (/ (float x) total)))
11804 org-table-last-column-widths " ")))
11805 (params2
11806 (list
11807 :tstart (concat "@multitable @columnfractions " colfrac)
11808 :tend "@end multitable"
11809 :lstart "@item " :lend "" :sep " @tab "
11810 :hlstart "@headitem ")))
11811 (orgtbl-to-generic table (org-combine-plists params2 params))))
11813 ;;;; Link Stuff
11815 ;;; Link abbreviations
11817 (defun org-link-expand-abbrev (link)
11818 "Apply replacements as defined in `org-link-abbrev-alist."
11820 (let* ((key (match-string 1 link))
11821 (as (or (assoc key org-link-abbrev-alist-local)
11822 (assoc key org-link-abbrev-alist)))
11823 (tag (and (match-end 2) (match-string 3 link)))
11824 rpl)
11825 (if (not as)
11826 link
11827 (setq rpl (cdr as))
11828 (cond
11829 ((symbolp rpl) (funcall rpl tag))
11830 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11831 (t (concat rpl tag)))))
11832 link))
11834 ;;; Storing and inserting links
11836 (defvar org-insert-link-history nil
11837 "Minibuffer history for links inserted with `org-insert-link'.")
11839 (defvar org-stored-links nil
11840 "Contains the links stored with `org-store-link'.")
11842 (defvar org-store-link-plist nil
11843 "Plist with info about the most recently link created with `org-store-link'.")
11845 (defvar org-link-protocols nil
11846 "Link protocols added to Org-mode using `org-add-link-type'.")
11848 (defvar org-store-link-functions nil
11849 "List of functions that are called to create and store a link.
11850 Each function will be called in turn until one returns a non-nil
11851 value. Each function should check if it is responsible for creating
11852 this link (for example by looking at the major mode).
11853 If not, it must exit and return nil.
11854 If yes, it should return a non-nil value after a calling
11855 `org-store-link-props' with a list of properties and values.
11856 Special properties are:
11860 This is obligatory as well.
11861 :description Optional default description for the second pair
11862 of brackets in an Org-mode link. The user can still change
11863 this when inserting this link into an Org-mode buffer.
11865 In addition to these, any additional properties can be specified
11866 and then used in remember templates.")
11868 (defun org-add-link-type (type &optional follow publish)
11869 "Add TYPE to the list of `org-link-types'.
11870 Re-compute all regular expressions depending on `org-link-types'
11871 FOLLOW and PUBLISH are two functions. Both take the link path as
11872 an argument.
11873 FOLLOW should do whatever is necessary to follow the link, for example
11874 to find a file or display a mail message.
11876 PUBLISH takes the path and retuns the string that should be used when
11877 this document is published. FIMXE: This is actually not yet implemented."
11878 (add-to-list 'org-link-types type t)
11879 (org-make-link-regexps)
11880 (add-to-list 'org-link-protocols
11881 (list type follow publish)))
11883 (defun org-add-agenda-custom-command (entry)
11884 "Replace or add a command in `org-agenda-custom-commands'.
11885 This is mostly for hacking and trying a new command - once the command
11886 works you probably want to add it to `org-agenda-custom-commands' for good."
11887 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11888 (if ass
11889 (setcdr ass (cdr entry))
11890 (push entry org-agenda-custom-commands))))
11892 ;;;###autoload
11893 (defun org-store-link (arg)
11895 This link can later be inserted into an org-buffer with
11897 For some link types, a prefix arg is interpreted:
11898 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11899 For file links, arg negates `org-context-in-file-links'."
11900 (interactive "P")
11901 (setq org-store-link-plist nil) ; reset
11902 (let (link cpltxt desc description search txt)
11903 (cond
11905 ((run-hook-with-args-until-success 'org-store-link-functions)
11906 (setq link (plist-get org-store-link-plist :link)
11907 desc (or (plist-get org-store-link-plist :description) link)))
11909 ((eq major-mode 'bbdb-mode)
11910 (let ((name (bbdb-record-name (bbdb-current-record)))
11911 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11912 (setq cpltxt (concat "bbdb:" (or name company))
11913 link (org-make-link cpltxt))
11914 (org-store-link-props :type "bbdb" :name name :company company)))
11916 ((eq major-mode 'Info-mode)
11917 (setq link (org-make-link "info:"
11918 (file-name-nondirectory Info-current-file)
11919 ":" Info-current-node))
11920 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11921 ":" Info-current-node))
11922 (org-store-link-props :type "info" :file Info-current-file
11923 :node Info-current-node))
11925 ((eq major-mode 'calendar-mode)
11926 (let ((cd (calendar-cursor-to-date)))
11927 (setq link
11928 (format-time-string
11929 (car org-time-stamp-formats)
11930 (apply 'encode-time
11931 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11932 nil nil nil))))
11933 (org-store-link-props :type "calendar" :date cd)))
11935 ((or (eq major-mode 'vm-summary-mode)
11936 (eq major-mode 'vm-presentation-mode))
11937 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11938 (vm-follow-summary-cursor)
11939 (save-excursion
11940 (vm-select-folder-buffer)
11941 (let* ((message (car vm-message-pointer))
11942 (folder buffer-file-name)
11943 (subject (vm-su-subject message))
11944 (to (vm-get-header-contents message "To"))
11945 (from (vm-get-header-contents message "From"))
11946 (message-id (vm-su-message-id message)))
11947 (org-store-link-props :type "vm" :from from :to to :subject subject
11948 :message-id message-id)
11949 (setq message-id (org-remove-angle-brackets message-id))
11950 (setq folder (abbreviate-file-name folder))
11951 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11952 folder)
11953 (setq folder (replace-match "" t t folder)))
11954 (setq cpltxt (org-email-link-description))
11955 (setq link (org-make-link "vm:" folder "#" message-id)))))
11957 ((eq major-mode 'wl-summary-mode)
11958 (let* ((msgnum (wl-summary-message-number))
11959 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11960 msgnum 'message-id))
11961 (wl-message-entity
11962 (if (fboundp 'elmo-message-entity)
11963 (elmo-message-entity
11964 wl-summary-buffer-elmo-folder msgnum)
11965 (elmo-msgdb-overview-get-entity
11966 msgnum (wl-summary-buffer-msgdb))))
11967 (from (wl-summary-line-from))
11968 (to (car (elmo-message-entity-field wl-message-entity 'to)))
11969 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11970 (wl-summary-line-subject))))
11971 (org-store-link-props :type "wl" :from from :to to
11972 :subject subject :message-id message-id)
11973 (setq message-id (org-remove-angle-brackets message-id))
11974 (setq cpltxt (org-email-link-description))
11975 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11976 "#" message-id))))
11978 ((or (equal major-mode 'mh-folder-mode)
11979 (equal major-mode 'mh-show-mode))
11980 (let ((from (org-mhe-get-header "From:"))
11981 (to (org-mhe-get-header "To:"))
11982 (message-id (org-mhe-get-header "Message-Id:"))
11983 (subject (org-mhe-get-header "Subject:")))
11984 (org-store-link-props :type "mh" :from from :to to
11985 :subject subject :message-id message-id)
11986 (setq cpltxt (org-email-link-description))
11987 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11988 (org-remove-angle-brackets message-id)))))
11990 ((eq major-mode 'rmail-mode)
11991 (save-excursion
11992 (save-restriction
11993 (rmail-narrow-to-non-pruned-header)
11994 (let ((folder buffer-file-name)
11995 (message-id (mail-fetch-field "message-id"))
11996 (from (mail-fetch-field "from"))
11997 (to (mail-fetch-field "to"))
11998 (subject (mail-fetch-field "subject")))
11999 (org-store-link-props
12000 :type "rmail" :from from :to to
12001 :subject subject :message-id message-id)
12002 (setq message-id (org-remove-angle-brackets message-id))
12003 (setq cpltxt (org-email-link-description))
12004 (setq link (org-make-link "rmail:" folder "#" message-id))))))
12006 ((eq major-mode 'gnus-group-mode)
12007 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12008 (gnus-group-group-name)) ; version
12009 ((fboundp 'gnus-group-name)
12010 (gnus-group-name))
12011 (t "???"))))
12012 (unless group (error "Not on a group"))
12013 (org-store-link-props :type "gnus" :group group)
12014 (setq cpltxt (concat
12015 (if (org-xor arg org-usenet-links-prefer-google)
12016 "http://groups.google.com/groups?group="
12017 "gnus:")
12018 group)
12019 link (org-make-link cpltxt))))
12021 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12022 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12023 (let* ((group gnus-newsgroup-name)
12024 (article (gnus-summary-article-number))
12025 (header (gnus-summary-article-header article))
12026 (from (mail-header-from header))
12027 (message-id (mail-header-id header))
12028 (date (mail-header-date header))
12029 (subject (gnus-summary-subject-string)))
12030 (org-store-link-props :type "gnus" :from from :subject subject
12031 :message-id message-id :group group)
12032 (setq cpltxt (org-email-link-description))
12033 (if (org-xor arg org-usenet-links-prefer-google)
12034 (setq link
12035 (concat
12037 (format "http://groups.google.com/groups?as_umsgid=%s"
12038 (org-fixup-message-id-for-http message-id))))
12039 (setq link (org-make-link "gnus:" group
12040 "#" (number-to-string article))))))
12042 ((eq major-mode 'w3-mode)
12043 (setq cpltxt (url-view-url t)
12044 link (org-make-link cpltxt))
12045 (org-store-link-props :type "w3" :url (url-view-url t)))
12047 ((eq major-mode 'w3m-mode)
12048 (setq cpltxt (or w3m-current-title w3m-current-url)
12049 link (org-make-link w3m-current-url))
12050 (org-store-link-props :type "w3m" :url (url-view-url t)))
12052 ((setq search (run-hook-with-args-until-success
12053 'org-create-file-search-functions))
12054 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12055 "::" search))
12056 (setq cpltxt (or description link)))
12058 ((eq major-mode 'image-mode)
12059 (setq cpltxt (concat "file:"
12060 (abbreviate-file-name buffer-file-name))
12061 link (org-make-link cpltxt))
12062 (org-store-link-props :type "image" :file buffer-file-name))
12064 ((eq major-mode 'dired-mode)
12065 ;; link to the file in the current line
12066 (setq cpltxt (concat "file:"
12067 (abbreviate-file-name
12068 (expand-file-name
12069 (dired-get-filename nil t))))
12070 link (org-make-link cpltxt)))
12072 ((and buffer-file-name (org-mode-p))
12073 ;; Just link to current headline
12074 (setq cpltxt (concat "file:"
12075 (abbreviate-file-name buffer-file-name)))
12076 ;; Add a context search string
12077 (when (org-xor org-context-in-file-links arg)
12078 ;; Check if we are on a target
12080 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12081 (setq txt (cond
12082 ((org-on-heading-p) nil)
12083 ((org-region-active-p)
12084 (buffer-substring (region-beginning) (region-end)))
12085 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12087 (setq cpltxt
12088 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12089 desc "NONE"))))
12091 (setq cpltxt (substring cpltxt 0 -2)))
12092 (setq link (org-make-link cpltxt)))
12094 ((buffer-file-name (buffer-base-buffer))
12095 ;; Just link to this file here.
12096 (setq cpltxt (concat "file:"
12097 (abbreviate-file-name
12098 (buffer-file-name (buffer-base-buffer)))))
12099 ;; Add a context string
12100 (when (org-xor org-context-in-file-links arg)
12101 (setq txt (if (org-region-active-p)
12102 (buffer-substring (region-beginning) (region-end))
12103 (buffer-substring (point-at-bol) (point-at-eol))))
12104 ;; Only use search option if there is some text.
12106 (setq cpltxt
12107 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12108 desc "NONE")))
12109 (setq link (org-make-link cpltxt)))
12111 ((interactive-p)
12112 (error "Cannot link to a buffer which is not visiting a file"))
12114 (t (setq link nil)))
12116 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12117 (setq link (or link cpltxt)
12118 desc (or desc cpltxt))
12119 (if (equal desc "NONE") (setq desc nil))
12121 (if (and (interactive-p) link)
12122 (progn
12123 (setq org-stored-links
12124 (cons (list link desc) org-stored-links))
12125 (message "Stored: %s" (or desc link)))
12126 (and link (org-make-link-string link desc)))))
12128 (defun org-store-link-props (&rest plist)
12129 "Store link properties, extract names and addresses."
12130 (let (x adr)
12131 (when (setq x (plist-get plist :from))
12132 (setq adr (mail-extract-address-components x))
12133 (plist-put plist :fromname (car adr))
12134 (plist-put plist :fromaddress (nth 1 adr)))
12135 (when (setq x (plist-get plist :to))
12136 (setq adr (mail-extract-address-components x))
12137 (plist-put plist :toname (car adr))
12138 (plist-put plist :toaddress (nth 1 adr))))
12139 (let ((from (plist-get plist :from))
12140 (to (plist-get plist :to)))
12141 (when (and from to org-from-is-user-regexp)
12142 (plist-put plist :fromto
12143 (if (string-match org-from-is-user-regexp from)
12144 (concat "to %t")
12145 (concat "from %f")))))
12146 (setq org-store-link-plist plist))
12148 (defun org-email-link-description (&optional fmt)
12149 "Return the description part of an email link.
12150 This takes information from `org-store-link-plist' and formats it
12151 according to FMT (default from `org-email-link-description-format')."
12152 (setq fmt (or fmt org-email-link-description-format))
12153 (let* ((p org-store-link-plist)
12154 (to (plist-get p :toaddress))
12155 (from (plist-get p :fromaddress))
12156 (table
12157 (list
12158 (cons "%c" (plist-get p :fromto))
12159 (cons "%F" (plist-get p :from))
12160 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12161 (cons "%T" (plist-get p :to))
12162 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12163 (cons "%s" (plist-get p :subject))
12164 (cons "%m" (plist-get p :message-id)))))
12165 (when (string-match "%c" fmt)
12166 ;; Check if the user wrote this message
12167 (if (and org-from-is-user-regexp from to
12168 (save-match-data (string-match org-from-is-user-regexp from)))
12169 (setq fmt (replace-match "to %t" t t fmt))
12170 (setq fmt (replace-match "from %f" t t fmt))))
12171 (org-replace-escapes fmt table)))
12173 (defun org-make-org-heading-search-string (&optional string heading)
12174 "Make search string for STRING or current headline."
12175 (interactive)
12176 (let ((s (or string (org-get-heading))))
12177 (unless (and string (not heading))
12178 ;; We are using a headline, clean up garbage in there.
12179 (if (string-match org-todo-regexp s)
12180 (setq s (replace-match "" t t s)))
12182 (setq s (replace-match "" t t s)))
12183 (setq s (org-trim s))
12186 (setq s (replace-match "" t t s)))
12187 (while (string-match org-ts-regexp s)
12188 (setq s (replace-match "" t t s))))
12190 (setq s (replace-match " " t t s)))
12191 (or string (setq s (concat "*" s))) ; Add * for headlines
12194 (defun org-make-link (&rest strings)
12195 "Concatenate STRINGS."
12196 (apply 'concat strings))
12198 (defun org-make-link-string (link &optional description)
12199 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12201 (error "Empty link"))
12202 (when (stringp description)
12203 ;; Remove brackets from the description, they are fatal.
12205 (setq description (replace-match "{" t t description)))
12207 (setq description (replace-match "}" t t description))))
12208 (when (equal (org-link-escape link) description)
12209 ;; No description needed, it is identical
12210 (setq description nil))
12211 (when (and (not description)
12212 (not (equal link (org-link-escape link))))
12213 (setq description link))
12214 (concat "[[" (org-link-escape link) "]"
12215 (if description (concat "[" description "]") "")
12216 "]"))
12218 (defconst org-link-escape-chars
12219 '((?\ . "%20")
12220 (?\[ . "%5B")
12221 (?\] . "%5D")
12232 (?\; . "%3B")
12233 (?? . "%3F")
12234 (?= . "%3D")
12235 (?+ . "%2B")
12236 )
12237 "Association list of escapes for some characters problematic in links.
12238 This is the list that is used for internal purposes.")
12240 (defconst org-link-escape-chars-browser
12241 '((?\ . "%20")) ; 32 for the SPC char
12242 "Association list of escapes for some characters problematic in links.
12243 This is the list that is used before handing over to the browser.")
12245 (defun org-link-escape (text &optional table)
12246 "Escape charaters in TEXT that are problematic for links."
12247 (setq table (or table org-link-escape-chars))
12248 (when text
12249 (let ((re (mapconcat (lambda (x) (regexp-quote
12250 (char-to-string (car x))))
12252 (while (string-match re text)
12253 (setq text
12254 (replace-match
12255 (cdr (assoc (string-to-char (match-string 0 text))
12256 table))
12257 t t text)))
12258 text)))
12260 (defun org-link-unescape (text &optional table)
12261 "Reverse the action of `org-link-escape'."
12262 (setq table (or table org-link-escape-chars))
12263 (when text
12264 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12266 (while (string-match re text)
12267 (setq text
12268 (replace-match
12269 (char-to-string (car (rassoc (match-string 0 text) table)))
12270 t t text)))
12271 text)))
12273 (defun org-xor (a b)
12274 "Exclusive or."
12275 (if a (not b) b))
12277 (defun org-get-header (header)
12278 "Find a header field in the current buffer."
12279 (save-excursion
12280 (goto-char (point-min))
12281 (let ((case-fold-search t) s)
12282 (cond
12283 ((eq header 'from)
12285 (setq s (match-string 1)))
12287 (setq s (replace-match "" t t s)))
12288 (if (string-match "[<(].*" s)
12289 (setq s (replace-match "" t t s))))
12290 ((eq header 'message-id)
12292 (setq s (match-string 1))))
12293 ((eq header 'subject)
12295 (setq s (match-string 1)))))
12298 s)))
12301 (defun org-fixup-message-id-for-http (s)
12302 "Replace special characters in a message id, so it can be used in an http query."
12303 (while (string-match "<" s)
12304 (setq s (replace-match "%3C" t t s)))
12305 (while (string-match ">" s)
12306 (setq s (replace-match "%3E" t t s)))
12307 (while (string-match "@" s)
12308 (setq s (replace-match "%40" t t s)))
12309 s)
12311 ;;;###autoload
12312 (defun org-insert-link-global ()
12313 "Insert a link like Org-mode does.
12314 This command can be called in any mode to insert a link in Org-mode syntax."
12315 (interactive)
12316 (org-run-like-in-org-mode 'org-insert-link))
12318 (defun org-insert-link (&optional complete-file)
12319 "Insert a link. At the prompt, enter the link.
12321 Completion can be used to select a link previously stored with
12322 `org-store-link'. When the empty string is entered (i.e. if you just
12323 press RET at the prompt), the link defaults to the most recently
12324 stored link. As SPC triggers completion in the minibuffer, you need to
12325 use M-SPC or C-q SPC to force the insertion of a space character.
12327 You will also be prompted for a description, and if one is given, it will
12328 be displayed in the buffer instead of the link.
12330 If there is already a link at point, this command will allow you to edit link
12331 and description parts.
12334 selected using completion. The path to the file will be relative to
12335 the current directory if the file is in the current directory or a
12336 subdirectory. Otherwise, the link will be the absolute path as
12337 completed in the minibuffer (i.e. normally ~/path/to/file).
12340 is in the current directory or below.
12342 `org-keep-stored-link-after-insertion'."
12343 (interactive "P")
12344 (let* ((wcf (current-window-configuration))
12345 (region (if (org-region-active-p)
12346 (buffer-substring (region-beginning) (region-end))))
12347 (remove (and region (list (region-beginning) (region-end))))
12348 (desc region)
12349 tmphist ; byte-compile incorrectly complains about this
12350 link entry file)
12351 (cond
12352 ((org-in-regexp org-bracket-link-regexp 1)
12353 ;; We do have a link at point, and we are going to edit it.
12354 (setq remove (list (match-beginning 0) (match-end 0)))
12355 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12356 (setq link (read-string "Link: "
12357 (org-link-unescape
12358 (org-match-string-no-properties 1)))))
12359 ((or (org-in-regexp org-angle-link-re)
12360 (org-in-regexp org-plain-link-re))
12361 ;; Convert to bracket link
12362 (setq remove (list (match-beginning 0) (match-end 0))
12363 link (read-string "Link: "
12364 (org-remove-angle-brackets (match-string 0)))))
12365 ((equal complete-file '(4))
12366 ;; Completing read for file names.
12367 (setq file (read-file-name "File: "))
12368 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12369 (pwd1 (file-name-as-directory (abbreviate-file-name
12370 (expand-file-name ".")))))
12371 (cond
12372 ((equal complete-file '(16))
12373 (setq link (org-make-link
12374 "file:"
12375 (abbreviate-file-name (expand-file-name file)))))
12377 (setq link (org-make-link "file:" (match-string 1 file))))
12379 (expand-file-name file))
12380 (setq link (org-make-link
12381 "file:" (match-string 1 (expand-file-name file)))))
12382 (t (setq link (org-make-link "file:" file))))))
12383 (t
12384 ;; Read link, with completion for stored links.
12385 (with-output-to-temp-buffer "*Org Links*"
12387 (when org-stored-links
12389 (princ (mapconcat
12390 (lambda (x)
12391 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12393 (let ((cw (selected-window)))
12394 (select-window (get-buffer-window "*Org Links*"))
12395 (shrink-window-if-larger-than-buffer)
12396 (setq truncate-lines t)
12397 (select-window cw))
12398 ;; Fake a link history, containing the stored links.
12399 (setq tmphist (append (mapcar 'car org-stored-links)
12400 org-insert-link-history))
12401 (unwind-protect
12402 (setq link (org-completing-read
12403 "Link: "
12404 (append
12405 (mapcar (lambda (x) (list (concat (car x) ":")))
12406 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12407 (mapcar (lambda (x) (list (concat x ":")))
12408 org-link-types))
12409 nil nil nil
12410 'tmphist
12411 (or (car (car org-stored-links)))))
12412 (set-window-configuration wcf)
12413 (kill-buffer "*Org Links*"))
12414 (setq entry (assoc link org-stored-links))
12415 (or entry (push link org-insert-link-history))
12416 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12417 (not org-keep-stored-link-after-insertion))
12418 (setq org-stored-links (delq (assoc link org-stored-links)
12419 org-stored-links)))
12420 (setq desc (or desc (nth 1 entry)))))
12422 (if (string-match org-plain-link-re link)
12423 ;; URL-like link, normalize the use of angular brackets.
12424 (setq link (org-make-link (org-remove-angle-brackets link))))
12426 ;; Check if we are linking to the current file with a search option
12427 ;; If yes, simplify the link by using only the search option.
12428 (when (and buffer-file-name
12430 (let* ((path (match-string 1 link))
12431 (case-fold-search nil)
12432 (search (match-string 2 link)))
12433 (save-match-data
12434 (if (equal (file-truename buffer-file-name) (file-truename path))
12435 ;; We are linking to this same file, with a search option
12436 (setq link search)))))
12438 ;; Check if we can/should use a relative path. If yes, simplify the link
12440 (let* ((path (match-string 1 link))
12441 (origpath path)
12442 (desc-is-link (equal link desc))
12443 (case-fold-search nil))
12444 (cond
12445 ((eq org-link-file-path-type 'absolute)
12446 (setq path (abbreviate-file-name (expand-file-name path))))
12447 ((eq org-link-file-path-type 'noabbrev)
12448 (setq path (expand-file-name path)))
12449 ((eq org-link-file-path-type 'relative)
12450 (setq path (file-relative-name path)))
12451 (t
12452 (save-match-data
12453 (if (string-match (concat "^" (regexp-quote
12454 (file-name-as-directory
12455 (expand-file-name "."))))
12456 (expand-file-name path))
12457 ;; We are linking a file with relative path name.
12458 (setq path (substring (expand-file-name path)
12459 (match-end 0)))))))
12460 (setq link (concat "file:" path))
12461 (if (equal desc origpath)
12462 (setq desc path))))
12464 (setq desc (read-string "Description: " desc))
12466 (if remove (apply 'delete-region remove))
12467 (insert (org-make-link-string link desc))))
12469 (defun org-completing-read (&rest args)
12470 (let ((minibuffer-local-completion-map
12471 (copy-keymap minibuffer-local-completion-map)))
12472 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12473 (apply 'completing-read args)))
12475 ;;; Opening/following a link
12476 (defvar org-link-search-failed nil)
12478 (defun org-next-link ()
12479 "Move forward to the next link.
12480 If the link is in hidden text, expose it."
12481 (interactive)
12482 (when (and org-link-search-failed (eq this-command last-command))
12483 (goto-char (point-min))
12484 (message "Link search wrapped back to beginning of buffer"))
12485 (setq org-link-search-failed nil)
12486 (let* ((pos (point))
12487 (ct (org-context))
12488 (a (assoc :link ct)))
12489 (if a (goto-char (nth 2 a)))
12490 (if (re-search-forward org-any-link-re nil t)
12491 (progn
12492 (goto-char (match-beginning 0))
12493 (if (org-invisible-p) (org-show-context)))
12494 (goto-char pos)
12495 (setq org-link-search-failed t)
12496 (error "No further link found"))))
12498 (defun org-previous-link ()
12499 "Move backward to the previous link.
12500 If the link is in hidden text, expose it."
12501 (interactive)
12502 (when (and org-link-search-failed (eq this-command last-command))
12503 (goto-char (point-max))
12504 (message "Link search wrapped back to end of buffer"))
12505 (setq org-link-search-failed nil)
12506 (let* ((pos (point))
12507 (ct (org-context))
12508 (a (assoc :link ct)))
12509 (if a (goto-char (nth 1 a)))
12510 (if (re-search-backward org-any-link-re nil t)
12511 (progn
12512 (goto-char (match-beginning 0))
12513 (if (org-invisible-p) (org-show-context)))
12514 (goto-char pos)
12515 (setq org-link-search-failed t)
12516 (error "No further link found"))))
12518 (defun org-find-file-at-mouse (ev)
12519 "Open file link or URL at mouse."
12520 (interactive "e")
12521 (mouse-set-point ev)
12522 (org-open-at-point 'in-emacs))
12524 (defun org-open-at-mouse (ev)
12525 "Open file link or URL at mouse."
12526 (interactive "e")
12527 (mouse-set-point ev)
12528 (org-open-at-point))
12530 (defvar org-window-config-before-follow-link nil
12531 "The window configuration before following a link.
12532 This is saved in case the need arises to restore it.")
12534 (defvar org-open-link-marker (make-marker)
12535 "Marker pointing to the location where `org-open-at-point; was called.")
12537 ;;;###autoload
12538 (defun org-open-at-point-global ()
12539 "Follow a link like Org-mode does.
12540 This command can be called in any mode to follow a link that has
12541 Org-mode syntax."
12542 (interactive)
12543 (org-run-like-in-org-mode 'org-open-at-point))
12545 (defun org-open-at-point (&optional in-emacs)
12546 "Open link at or after point.
12547 If there is no link at point, this function will search forward up to
12548 the end of the current subtree.
12549 Normally, files will be opened by an appropriate application. If the
12550 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12551 (interactive "P")
12552 (catch 'abort
12553 (move-marker org-open-link-marker (point))
12554 (setq org-window-config-before-follow-link (current-window-configuration))
12555 (org-remove-occur-highlights nil nil t)
12556 (if (org-at-timestamp-p t)
12557 (org-follow-timestamp-link)
12558 (let (type path link line search (pos (point)))
12559 (catch 'match
12560 (save-excursion
12562 (when (org-in-regexp org-bracket-link-regexp)
12563 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12565 (setq link (replace-match " " t t link)))
12566 (setq link (org-link-expand-abbrev link))
12567 (if (string-match org-link-re-with-space2 link)
12568 (setq type (match-string 1 link) path (match-string 2 link))
12569 (setq type "thisfile" path link))
12570 (throw 'match t)))
12572 (when (get-text-property (point) 'org-linked-text)
12573 (setq type "thisfile"
12574 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12575 (1+ (point)) (point))
12576 path (buffer-substring
12577 (previous-single-property-change pos 'org-linked-text)
12578 (next-single-property-change pos 'org-linked-text)))
12579 (throw 'match t))
12581 (save-excursion
12582 (when (or (org-in-regexp org-angle-link-re)
12583 (org-in-regexp org-plain-link-re))
12584 (setq type (match-string 1) path (match-string 2))
12585 (throw 'match t)))
12587 (setq type "tree-match"
12588 path (match-string 1))
12589 (throw 'match t))
12590 (save-excursion
12592 (setq type "tags"
12593 path (match-string 1))
12594 (while (string-match ":" path)
12595 (setq path (replace-match "+" t t path)))
12596 (throw 'match t))))
12597 (unless path
12598 (error "No link found"))
12599 ;; Remove any trailing spaces in path
12601 (setq path (replace-match "" t t path)))
12603 (cond
12605 ((assoc type org-link-protocols)
12606 (funcall (nth 1 (assoc type org-link-protocols)) path))
12608 ((equal type "mailto")
12609 (let ((cmd (car org-link-mailto-program))
12610 (args (cdr org-link-mailto-program)) args1
12611 (address path) (subject "") a)
12613 (setq address (match-string 1 path)
12614 subject (org-link-escape (match-string 2 path))))
12615 (while args
12616 (cond
12617 ((not (stringp (car args))) (push (pop args) args1))
12618 (t (setq a (pop args))
12619 (if (string-match "%a" a)
12620 (setq a (replace-match address t t a)))
12621 (if (string-match "%s" a)
12622 (setq a (replace-match subject t t a)))
12623 (push a args1))))
12624 (apply cmd (nreverse args1))))
12626 ((member type '("http" "https" "ftp" "news"))
12627 (browse-url (concat type ":" (org-link-escape
12628 path org-link-escape-chars-browser))))
12630 ((member type '("message"))
12631 (browse-url (concat type ":" path)))
12633 ((string= type "tags")
12634 (org-tags-view in-emacs path))
12635 ((string= type "thisfile")
12636 (if in-emacs
12637 (switch-to-buffer-other-window
12638 (org-get-buffer-for-internal-link (current-buffer)))
12639 (org-mark-ring-push))
12640 (let ((cmd `(org-link-search
12641 ,path
12642 ,(cond ((equal in-emacs '(4)) 'occur)
12643 ((equal in-emacs '(16)) 'org-occur)
12644 (t nil))
12645 ,pos)))
12646 (condition-case nil (eval cmd)
12647 (error (progn (widen) (eval cmd))))))
12649 ((string= type "tree-match")
12652 ((string= type "file")
12654 (setq line (string-to-number (match-string 1 path))
12655 path (substring path 0 (match-beginning 0)))
12657 (setq search (match-string 1 path)
12658 path (substring path 0 (match-beginning 0)))))
12659 (if (string-match "[*?{]" (file-name-nondirectory path))
12660 (dired path)
12661 (org-open-file path in-emacs line search)))
12663 ((string= type "news")
12664 (org-follow-gnus-link path))
12666 ((string= type "bbdb")
12667 (org-follow-bbdb-link path))
12669 ((string= type "info")
12670 (org-follow-info-link path))
12672 ((string= type "gnus")
12673 (let (group article)
12675 (error "Error in Gnus link"))
12676 (setq group (match-string 1 path)
12677 article (match-string 3 path))
12678 (org-follow-gnus-link group article)))
12680 ((string= type "vm")
12681 (let (folder article)
12683 (error "Error in VM link"))
12684 (setq folder (match-string 1 path)
12685 article (match-string 3 path))
12686 ;; in-emacs is the prefix arg, will be interpreted as read-only
12687 (org-follow-vm-link folder article in-emacs)))
12689 ((string= type "wl")
12690 (let (folder article)
12692 (error "Error in Wanderlust link"))
12693 (setq folder (match-string 1 path)
12694 article (match-string 3 path))
12695 (org-follow-wl-link folder article)))
12697 ((string= type "mhe")
12698 (let (folder article)
12700 (error "Error in MHE link"))
12701 (setq folder (match-string 1 path)
12702 article (match-string 3 path))
12703 (org-follow-mhe-link folder article)))
12705 ((string= type "rmail")
12706 (let (folder article)
12708 (error "Error in RMAIL link"))
12709 (setq folder (match-string 1 path)
12710 article (match-string 3 path))
12711 (org-follow-rmail-link folder article)))
12713 ((string= type "shell")
12714 (let ((cmd path))
12715 (if (or (not org-confirm-shell-link-function)
12716 (funcall org-confirm-shell-link-function
12718 (org-add-props cmd nil
12719 'face 'org-warning))))
12720 (progn
12721 (message "Executing %s" cmd)
12722 (shell-command cmd))
12723 (error "Abort"))))
12725 ((string= type "elisp")
12726 (let ((cmd path))
12727 (if (or (not org-confirm-elisp-link-function)
12728 (funcall org-confirm-elisp-link-function
12730 (org-add-props cmd nil
12731 'face 'org-warning))))
12732 (message "%s => %s" cmd (eval (read cmd)))
12733 (error "Abort"))))
12735 (t
12736 (browse-url-at-point)))))
12737 (move-marker org-open-link-marker nil)))
12739 ;;; File search
12741 (defvar org-create-file-search-functions nil
12742 "List of functions to construct the right search string for a file link.
12743 These functions are called in turn with point at the location to
12744 which the link should point.
12746 A function in the hook should first test if it would like to
12747 handle this file type, for example by checking the major-mode or
12748 the file extension. If it decides not to handle this file, it
12749 should just return nil to give other functions a chance. If it
12750 does handle the file, it must return the search string to be used
12751 when following the link. The search string will be part of the
12752 file link, given after a double colon, and `org-open-at-point'
12753 will automatically search for it. If special measures must be
12754 taken to make the search successful, another function should be
12755 added to the companion hook `org-execute-file-search-functions',
12756 which see.
12758 A function in this hook may also use `setq' to set the variable
12759 `description' to provide a suggestion for the descriptive text to
12760 be used for this link when it gets inserted into an Org-mode
12763 (defvar org-execute-file-search-functions nil
12764 "List of functions to execute a file search triggered by a link.
12766 Functions added to this hook must accept a single argument, the
12767 search string that was part of the file link, the part after the
12768 double colon. The function must first check if it would like to
12769 handle this search, for example by checking the major-mode or the
12770 file extension. If it decides not to handle this search, it
12771 should just return nil to give other functions a chance. If it
12772 does handle the search, it must return a non-nil value to keep
12773 other functions from trying.
12775 Each function can access the current prefix argument through the
12776 variable `current-prefix-argument'. Note that a single prefix is
12777 used to force opening a link in Emacs, so it may be good to only
12778 use a numeric or double prefix to guide the search function.
12780 In case this is needed, a function in this hook can also restore
12781 the window configuration before `org-open-at-point' was called using:
12783 (set-window-configuration org-window-config-before-follow-link)")
12785 (defun org-link-search (s &optional type avoid-pos)
12786 "Search for a link search option.
12787 If S is surrounded by forward slashes, it is interpreted as a
12788 regular expression. In org-mode files, this will create an `org-occur'
12789 sparse tree. In ordinary files, `occur' will be used to list matches.
12790 If the current buffer is in `dired-mode', grep will be used to search
12791 in all files. If AVOID-POS is given, ignore matches near that position."
12792 (let ((case-fold-search t)
12796 org-emphasis-alist)
12798 (pos (point))
12799 (pre "") (post "")
12800 words re0 re1 re2 re3 re4 re5 re2a reall)
12801 (cond
12802 ;; First check if there are any special
12803 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12804 ;; Now try the builtin stuff
12805 ((save-excursion
12806 (goto-char (point-min))
12807 (and
12808 (re-search-forward
12809 (concat "<<" (regexp-quote s0) ">>") nil t)
12810 (setq pos (match-beginning 0))))
12811 ;; There is an exact target for this
12812 (goto-char pos))
12814 ;; A regular expression
12815 (cond
12816 ((org-mode-p)
12817 (org-occur (match-string 1 s)))
12818 ;;((eq major-mode 'dired-mode)
12819 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12820 (t (org-do-occur (match-string 1 s)))))
12821 (t
12822 ;; A normal search strings
12823 (when (equal (string-to-char s) ?*)
12824 ;; Anchor on headlines, post may include tags.
12827 s (substring s 1)))
12828 (remove-text-properties
12829 0 (length s)
12830 '(face nil mouse-face nil keymap nil fontified nil) s)
12831 ;; Make a series of regular expressions to find a match
12838 re1 (concat pre re2 post)
12839 re3 (concat pre re4 post)
12840 re5 (concat pre ".*" re4)
12841 re2 (concat pre re2)
12842 re2a (concat pre re2a)
12843 re4 (concat pre re4)
12847 ))
12848 (cond
12849 ((eq type 'org-occur) (org-occur reall))
12850 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12851 (t (goto-char (point-min))
12852 (if (or (org-search-not-self 1 re0 nil t)
12853 (org-search-not-self 1 re1 nil t)
12854 (org-search-not-self 1 re2 nil t)
12855 (org-search-not-self 1 re2a nil t)
12856 (org-search-not-self 1 re3 nil t)
12857 (org-search-not-self 1 re4 nil t)
12858 (org-search-not-self 1 re5 nil t)
12859 )
12860 (goto-char (match-beginning 1))
12861 (goto-char pos)
12862 (error "No match")))))
12863 (t
12864 ;; Normal string-search
12865 (goto-char (point-min))
12866 (if (search-forward s nil t)
12867 (goto-char (match-beginning 0))
12868 (error "No match"))))
12869 (and (org-mode-p) (org-show-context 'link-search))))
12871 (defun org-search-not-self (group &rest args)
12872 "Execute `re-search-forward', but only accept matches that do not
12873 enclose the position of `org-open-link-marker'."
12874 (let ((m org-open-link-marker))
12875 (catch 'exit
12876 (while (apply 're-search-forward args)
12877 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12878 (goto-char (match-end group))
12879 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12880 (> (match-beginning 0) (marker-position m))
12881 (< (match-end 0) (marker-position m)))
12882 (save-match-data
12883 (or (not (org-in-regexp
12884 org-bracket-link-analytic-regexp 1))
12885 (not (match-end 4)) ; no description
12886 (and (<= (match-beginning 4) (point))
12887 (>= (match-end 4) (point))))))
12888 (throw 'exit (point))))))))
12890 (defun org-get-buffer-for-internal-link (buffer)
12891 "Return a buffer to be used for displaying the link target of internal links."
12892 (cond
12893 ((not org-display-internal-link-with-indirect-buffer)
12894 buffer)
12895 ((string-match "(Clone)$" (buffer-name buffer))
12896 (message "Buffer is already a clone, not making another one")
12897 ;; we also do not modify visibility in this case
12898 buffer)
12899 (t ; make a new indirect buffer for displaying the link
12900 (let* ((bn (buffer-name buffer))
12901 (ibn (concat bn "(Clone)"))
12902 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12903 (with-current-buffer ib (org-overview))
12904 ib))))
12906 (defun org-do-occur (regexp &optional cleanup)
12907 "Call the Emacs command `occur'.
12908 If CLEANUP is non-nil, remove the printout of the regular expression
12909 in the *Occur* buffer. This is useful if the regex is long and not useful
12910 to read."
12911 (occur regexp)
12912 (when cleanup
12913 (let ((cwin (selected-window)) win beg end)
12914 (when (setq win (get-buffer-window "*Occur*"))
12915 (select-window win))
12916 (goto-char (point-min))
12917 (when (re-search-forward "match[a-z]+" nil t)
12918 (setq beg (match-end 0))
12920 (setq end (1- (match-beginning 0)))))
12921 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12922 (goto-char (point-min))
12923 (select-window cwin))))
12925 ;;; The mark ring for links jumps
12927 (defvar org-mark-ring nil
12928 "Mark ring for positions before jumps in Org-mode.")
12929 (defvar org-mark-ring-last-goto nil
12930 "Last position in the mark ring used to go back.")
12931 ;; Fill and close the ring
12932 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12933 (loop for i from 1 to org-mark-ring-length do
12934 (push (make-marker) org-mark-ring))
12935 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12936 org-mark-ring)
12938 (defun org-mark-ring-push (&optional pos buffer)
12939 "Put the current position or POS into the mark ring and rotate it."
12940 (interactive)
12941 (setq pos (or pos (point)))
12942 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12943 (move-marker (car org-mark-ring)
12944 (or pos (point))
12945 (or buffer (current-buffer)))
12946 (message "%s"
12947 (substitute-command-keys
12950 (defun org-mark-ring-goto (&optional n)
12951 "Jump to the previous position in the mark ring.
12952 With prefix arg N, jump back that many stored positions. When
12953 called several times in succession, walk through the entire ring.
12954 Org-mode commands jumping to a different position in the current file,
12955 or to another Org-mode file, automatically push the old position
12956 onto the ring."
12957 (interactive "p")
12958 (let (p m)
12959 (if (eq last-command this-command)
12960 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12961 (setq p org-mark-ring))
12962 (setq org-mark-ring-last-goto p)
12963 (setq m (car p))
12964 (switch-to-buffer (marker-buffer m))
12965 (goto-char m)
12966 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12968 (defun org-remove-angle-brackets (s)
12969 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12970 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12971 s)
12972 (defun org-add-angle-brackets (s)
12973 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12974 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12975 s)
12977 ;;; Following specific links
12979 (defun org-follow-timestamp-link ()
12980 (cond
12981 ((org-at-date-range-p t)
12982 (let ((org-agenda-start-on-weekday)
12983 (t1 (match-string 1))
12984 (t2 (match-string 2)))
12985 (setq t1 (time-to-days (org-time-string-to-time t1))
12986 t2 (time-to-days (org-time-string-to-time t2)))
12987 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12988 ((org-at-timestamp-p t)
12989 (org-agenda-list nil (time-to-days (org-time-string-to-time
12990 (substring (match-string 1) 0 10)))
12991 1))
12992 (t (error "This should not happen"))))
12995 (defun org-follow-bbdb-link (name)
12996 "Follow a BBDB link to NAME."
12997 (require 'bbdb)
12998 (let ((inhibit-redisplay (not debug-on-error))
12999 (bbdb-electric-p nil))
13000 (catch 'exit
13001 ;; Exact match on name
13003 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13004 ;; Exact match on name
13006 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13007 ;; Partial match on name
13008 (bbdb-name name nil)
13009 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13010 ;; Partial match on company
13011 (bbdb-company name nil)
13012 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13013 ;; General match including network address and notes
13014 (bbdb name nil)
13015 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13016 (delete-window (get-buffer-window "*BBDB*"))
13017 (error "No matching BBDB record")))))
13019 (defun org-follow-info-link (name)
13020 "Follow an info file & node link to NAME."
13023 (progn
13024 (require 'info)
13025 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13026 (Info-find-node (match-string 1 name) (match-string 2 name))
13027 (Info-find-node (match-string 1 name) "Top")))
13028 (message "Could not open: %s" name)))
13030 (defun org-follow-gnus-link (&optional group article)
13031 "Follow a Gnus link to GROUP and ARTICLE."
13032 (require 'gnus)
13033 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13034 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13035 (cond ((and group article)
13036 (gnus-group-read-group 1 nil group)
13037 (gnus-summary-goto-article (string-to-number article) nil t))
13038 (group (gnus-group-jump-to-group group))))
13040 (defun org-follow-vm-link (&optional folder article readonly)
13041 "Follow a VM link to FOLDER and ARTICLE."
13042 (require 'vm)
13043 (setq article (org-add-angle-brackets article))
13045 ;; ange-ftp or efs or tramp access
13046 (let ((user (or (match-string 1 folder) (user-login-name)))
13047 (host (match-string 2 folder))
13048 (file (match-string 3 folder)))
13049 (cond
13050 ((featurep 'tramp)
13051 ;; use tramp to access the file
13052 (if (featurep 'xemacs)
13053 (setq folder (format "[%s@%s]%s" user host file))
13054 (setq folder (format "/%s@%s:%s" user host file))))
13055 (t
13056 ;; use ange-ftp or efs
13057 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13058 (setq folder (format "/%s@%s:%s" user host file))))))
13059 (when folder
13060 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13061 (sit-for 0.1)
13062 (when article
13063 (vm-select-folder-buffer)
13064 (widen)
13065 (let ((case-fold-search t))
13066 (goto-char (point-min))
13067 (if (not (re-search-forward
13068 (concat "^" "message-id: *" (regexp-quote article))))
13069 (error "Could not find the specified message in this folder"))
13070 (vm-isearch-update)
13071 (vm-isearch-narrow)
13072 (vm-beginning-of-message)
13073 (vm-summarize)))))
13075 (defun org-follow-wl-link (folder article)
13076 "Follow a Wanderlust link to FOLDER and ARTICLE."
13077 (if (and (string= folder "%")
13078 article
13080 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13081 ;; Thus, we recompose folder and article ids.
13082 (setq folder (format "%s#%s" folder (match-string 1 article))
13083 article (match-string 3 article)))
13084 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13085 (error "No such folder: %s" folder))
13086 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13087 (and article
13088 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13089 (wl-summary-redisplay)))
13091 (defun org-follow-rmail-link (folder article)
13092 "Follow an RMAIL link to FOLDER and ARTICLE."
13093 (setq article (org-add-angle-brackets article))
13094 (let (message-number)
13095 (save-excursion
13096 (save-window-excursion
13097 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13098 (setq message-number
13099 (save-restriction
13100 (widen)
13101 (goto-char (point-max))
13102 (if (re-search-backward
13104 (or article "")))
13105 nil t)
13106 (rmail-what-message))))))
13107 (if message-number
13108 (progn
13109 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13110 (rmail-show-message message-number)
13111 message-number)
13112 (error "Message not found"))))
13114 ;;; mh-e integration based on planner-mode
13115 (defun org-mhe-get-message-real-folder ()
13116 "Return the name of the current message real folder, so if you use
13117 sequences, it will now work."
13118 (save-excursion
13119 (let* ((folder
13120 (if (equal major-mode 'mh-folder-mode)
13121 mh-current-folder
13122 ;; Refer to the show buffer
13123 mh-show-folder-buffer))
13124 (end-index
13125 (if (boundp 'mh-index-folder)
13126 (min (length mh-index-folder) (length folder))))
13127 )
13128 ;; a simple test on mh-index-data does not work, because
13129 ;; mh-index-data is always nil in a show buffer.
13130 (if (and (boundp 'mh-index-folder)
13131 (string= mh-index-folder (substring folder 0 end-index)))
13132 (if (equal major-mode 'mh-show-mode)
13133 (save-window-excursion
13134 (let (pop-up-frames)
13135 (when (buffer-live-p (get-buffer folder))
13136 (progn
13137 (pop-to-buffer folder)
13138 (org-mhe-get-message-folder-from-index)
13139 )
13140 )))
13141 (org-mhe-get-message-folder-from-index)
13142 )
13143 folder
13144 )
13145 )))
13147 (defun org-mhe-get-message-folder-from-index ()
13148 "Returns the name of the message folder in a index folder buffer."
13149 (save-excursion
13150 (mh-index-previous-folder)
13152 (message "%s" (match-string 1))))
13154 (defun org-mhe-get-message-folder ()
13155 "Return the name of the current message folder. Be careful if you
13156 use sequences."
13157 (save-excursion
13158 (if (equal major-mode 'mh-folder-mode)
13159 mh-current-folder
13160 ;; Refer to the show buffer
13161 mh-show-folder-buffer)))
13163 (defun org-mhe-get-message-num ()
13164 "Return the number of the current message. Be careful if you
13165 use sequences."
13166 (save-excursion
13167 (if (equal major-mode 'mh-folder-mode)
13168 (mh-get-msg-num nil)
13169 ;; Refer to the show buffer
13170 (mh-show-buffer-message-number))))
13172 (defun org-mhe-get-header (header)
13173 "Return a header of the message in folder mode. This will create a
13174 show buffer for the corresponding message. If you have a more clever
13175 idea..."
13176 (let* ((folder (org-mhe-get-message-folder))
13177 (num (org-mhe-get-message-num))
13178 (buffer (get-buffer-create (concat "show-" folder)))
13179 (header-field))
13180 (with-current-buffer buffer
13181 (mh-display-msg num folder)
13182 (if (equal major-mode 'mh-folder-mode)
13183 (mh-header-display)
13184 (mh-show-header-display))
13185 (set-buffer buffer)
13186 (setq header-field (mh-get-header-field header))
13187 (if (equal major-mode 'mh-folder-mode)
13188 (mh-show)
13189 (mh-show-show))
13190 header-field)))
13192 (defun org-follow-mhe-link (folder article)
13193 "Follow an MHE link to FOLDER and ARTICLE.
13194 If ARTICLE is nil FOLDER is shown. If the configuration variable
13195 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13196 ARTICLE is searched in all folders. Indexed searches (swish++,
13197 namazu, and others supported by MH-E) will always search in all
13198 folders."
13199 (require 'mh-e)
13200 (require 'mh-search)
13201 (require 'mh-utils)
13202 (mh-find-path)
13203 (if (not article)
13204 (mh-visit-folder (mh-normalize-folder-name folder))
13205 (setq article (org-add-angle-brackets article))
13206 (mh-search-choose)
13207 (if (equal mh-searcher 'pick)
13208 (progn
13209 (mh-search folder (list "--message-id" article))
13210 (when (and org-mhe-search-all-folders
13211 (not (org-mhe-get-message-real-folder)))
13212 (kill-this-buffer)
13213 (mh-search "+" (list "--message-id" article))))
13214 (mh-search "+" article))
13215 (if (org-mhe-get-message-real-folder)
13216 (mh-show-msg 1)
13217 (kill-this-buffer)
13218 (error "Message not found"))))
13220 ;;; BibTeX links
13222 ;; Use the custom search meachnism to construct and use search strings for
13223 ;; file links to BibTeX database entries.
13225 (defun org-create-file-search-in-bibtex ()
13226 "Create the search string and description for a BibTeX database entry."
13227 (when (eq major-mode 'bibtex-mode)
13228 ;; yes, we want to construct this search string.
13229 ;; Make a good description for this entry, using names, year and the title
13230 ;; Put it into the `description' variable which is dynamically scoped.
13231 (let ((bibtex-autokey-names 1)
13232 (bibtex-autokey-names-stretch 1)
13233 (bibtex-autokey-name-case-convert-function 'identity)
13234 (bibtex-autokey-name-separator " & ")
13235 (bibtex-autokey-additional-names " et al.")
13236 (bibtex-autokey-year-length 4)
13237 (bibtex-autokey-name-year-separator " ")
13238 (bibtex-autokey-titlewords 3)
13239 (bibtex-autokey-titleword-separator " ")
13240 (bibtex-autokey-titleword-case-convert-function 'identity)
13241 (bibtex-autokey-titleword-length 'infty)
13242 (bibtex-autokey-year-title-separator ": "))
13243 (setq description (bibtex-generate-autokey)))
13244 ;; Now parse the entry, get the key and return it.
13245 (save-excursion
13246 (bibtex-beginning-of-entry)
13247 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13249 (defun org-execute-file-search-in-bibtex (s)
13250 "Find the link search string S as a key for a database entry."
13251 (when (eq major-mode 'bibtex-mode)
13252 ;; Yes, we want to do the search in this file.
13253 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13254 (goto-char (point-min))
13257 (goto-char (match-beginning 0)))
13258 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13259 ;; Use double prefix to indicate that any web link should be browsed
13260 (let ((b (current-buffer)) (p (point)))
13261 ;; Restore the window configuration because we just use the web link
13262 (set-window-configuration org-window-config-before-follow-link)
13263 (save-excursion (set-buffer b) (goto-char p)
13264 (bibtex-url)))
13265 (recenter 0)) ; Move entry start to beginning of window
13266 ;; return t to indicate that the search is done.
13267 t))
13269 ;; Finally add the functions to the right hooks.
13270 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13271 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13273 ;; end of Bibtex link setup
13275 ;;; Following file links
13277 (defun org-open-file (path &optional in-emacs line search)
13278 "Open the file at PATH.
13279 First, this expands any special file name abbreviations. Then the
13280 configuration variable `org-file-apps' is checked if it contains an
13281 entry for this file type, and if yes, the corresponding command is launched.
13282 If no application is found, Emacs simply visits the file.
13283 With optional argument IN-EMACS, Emacs will visit the file.
13284 Optional LINE specifies a line to go to, optional SEARCH a string to
13285 search for. If LINE or SEARCH is given, the file will always be
13286 opened in Emacs.
13287 If the file does not exist, an error is thrown."
13288 (setq in-emacs (or in-emacs line search))
13289 (let* ((file (if (equal path "")
13290 buffer-file-name
13291 (substitute-in-file-name (expand-file-name path))))
13292 (apps (append org-file-apps (org-default-apps)))
13293 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13294 (dirp (if remp nil (file-directory-p file)))
13295 (dfile (downcase file))
13296 (old-buffer (current-buffer))
13297 (old-pos (point))
13298 (old-mode major-mode)
13299 ext cmd)
13301 (setq ext (match-string 1 dfile))
13303 (setq ext (match-string 1 dfile))))
13304 (if in-emacs
13305 (setq cmd 'emacs)
13306 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13307 (and dirp (cdr (assoc 'directory apps)))
13308 (cdr (assoc ext apps))
13309 (cdr (assoc t apps)))))
13310 (when (eq cmd 'mailcap)
13311 (require 'mailcap)
13312 (mailcap-parse-mailcaps)
13313 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13314 (command (mailcap-mime-info mime-type)))
13315 (if (stringp command)
13316 (setq cmd command)
13317 (setq cmd 'emacs))))
13318 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13319 (not (file-exists-p file))
13320 (not org-open-non-existing-files))
13321 (error "No such file: %s" file))
13322 (cond
13324 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13326 (setq cmd (replace-match "%s" t t cmd)))
13327 (while (string-match "%s" cmd)
13328 (setq cmd (replace-match
13329 (save-match-data (shell-quote-argument file))
13330 t t cmd)))
13331 (save-window-excursion
13332 (start-process-shell-command cmd nil cmd)))
13333 ((or (stringp cmd)
13334 (eq cmd 'emacs))
13335 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13336 (widen)
13337 (if line (goto-line line)
13338 (if search (org-link-search search))))
13339 ((consp cmd)
13340 (eval cmd))
13341 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13342 (and (org-mode-p) (eq old-mode 'org-mode)
13343 (or (not (equal old-buffer (current-buffer)))
13344 (not (equal old-pos (point))))
13345 (org-mark-ring-push old-pos old-buffer))))
13347 (defun org-default-apps ()
13348 "Return the default applications for this operating system."
13349 (cond
13350 ((eq system-type 'darwin)
13351 org-file-apps-defaults-macosx)
13352 ((eq system-type 'windows-nt)
13353 org-file-apps-defaults-windowsnt)
13354 (t org-file-apps-defaults-gnu)))
13356 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13357 (defun org-file-remote-p (file)
13358 "Test whether FILE specifies a location on a remote system.
13359 Return non-nil if the location is indeed remote.
13363 (cond ((fboundp 'file-remote-p)
13364 (file-remote-p file))
13365 ((fboundp 'tramp-handle-file-remote-p)
13366 (tramp-handle-file-remote-p file))
13367 ((and (boundp 'ange-ftp-name-format)
13368 (string-match (car ange-ftp-name-format) file))
13369 t)
13370 (t nil)))
13373 ;;;; Hooks for remember.el, and refiling
13375 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13376 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13378 ;;;###autoload
13379 (defun org-remember-insinuate ()
13380 "Setup remember.el for use wiht Org-mode."
13381 (require 'remember)
13382 (setq remember-annotation-functions '(org-remember-annotation))
13383 (setq remember-handler-functions '(org-remember-handler))
13384 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13386 ;;;###autoload
13387 (defun org-remember-annotation ()
13388 "Return a link to the current location as an annotation for remember.el.
13389 If you are using Org-mode files as target for data storage with
13390 remember.el, then the annotations should include a link compatible with the
13391 conventions in Org-mode. This function returns such a link."
13392 (org-store-link nil))
13394 (defconst org-remember-help
13395 "Select a destination location for the note.
13396 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13397 RET on headline -> Store as sublevel entry to current headline
13398 RET at beg-of-buf -> Append to file as level 2 headline
13399 <left>/<right> -> before/after current headline, same headings level")
13401 (defvar org-remember-previous-location nil)
13402 (defvar org-force-remember-template-char) ;; dynamically scoped
13404 (defun org-select-remember-template (&optional use-char)
13405 (when org-remember-templates
13406 (let* ((templates (mapcar (lambda (x)
13407 (if (stringp (car x))
13408 (append (list (nth 1 x) (car x)) (cddr x))
13409 (append (list (car x) "") (cdr x))))
13410 org-remember-templates))
13411 (char (or use-char
13412 (cond
13413 ((= (length templates) 1)
13414 (caar templates))
13415 ((and (boundp 'org-force-remember-template-char)
13416 org-force-remember-template-char)
13417 (if (stringp org-force-remember-template-char)
13418 (string-to-char org-force-remember-template-char)
13419 org-force-remember-template-char))
13420 (t
13421 (message "Select template: %s"
13422 (mapconcat
13423 (lambda (x)
13424 (cond
13426 (format "[%c]" (car x)))
13427 ((equal (downcase (car x))
13428 (downcase (aref (nth 1 x) 0)))
13429 (format "[%c]%s" (car x)
13430 (substring (nth 1 x) 1)))
13431 (t (format "[%c]%s" (car x) (nth 1 x)))))
13432 templates " "))
13433 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13434 (when (equal char0 ?\C-g)
13435 (jump-to-register remember-register)
13436 (kill-buffer remember-buffer))
13437 char0))))))
13438 (cddr (assoc char templates)))))
13440 (defvar x-last-selected-text)
13441 (defvar x-last-selected-text-primary)
13443 ;;;###autoload
13444 (defun org-remember-apply-template (&optional use-char skip-interactive)
13445 "Initialize *remember* buffer with template, invoke `org-mode'.
13446 This function should be placed into `remember-mode-hook' and in fact requires
13447 to be run from that hook to function properly."
13448 (if org-remember-templates
13449 (let* ((entry (org-select-remember-template use-char))
13450 (tpl (car entry))
13451 (plist-p (if org-store-link-plist t nil))
13452 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13454 (nth 1 entry)
13455 org-default-notes-file))
13456 (headline (nth 2 entry))
13457 (v-c (or (and (eq window-system 'x)
13458 (fboundp 'x-cut-buffer-or-selection-value)
13459 (x-cut-buffer-or-selection-value))
13460 (org-bound-and-true-p x-last-selected-text)
13461 (org-bound-and-true-p x-last-selected-text-primary)
13462 (and (> (length kill-ring) 0) (current-kill 0))))
13463 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13464 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13465 (v-u (concat "[" (substring v-t 1 -1) "]"))
13466 (v-U (concat "[" (substring v-T 1 -1) "]"))
13467 ;; `initial' and `annotation' are bound in `remember'
13468 (v-i (if (boundp 'initial) initial))
13469 (v-a (if (and (boundp 'annotation) annotation)
13470 (if (equal annotation "[[]]") "" annotation)
13471 ""))
13472 (v-A (if (and v-a
13475 v-a))
13476 (v-n user-full-name)
13477 (org-startup-folded nil)
13478 org-time-was-given org-end-time-was-given x
13479 prompt completions char time pos default histvar)
13480 (setq org-store-link-plist
13481 (append (list :annotation v-a :initial v-i)
13482 org-store-link-plist))
13483 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13484 (erase-buffer)
13485 (insert (substitute-command-keys
13486 (format
13487 "## Filing location: Select interactively, default, or last used:
13488 ## %s to select file and header location interactively.
13492 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13493 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13494 (abbreviate-file-name (or file org-default-notes-file))
13495 (or headline "")
13496 (or (car org-remember-previous-location) "???")
13497 (or (cdr org-remember-previous-location) "???"))))
13498 (insert tpl) (goto-char (point-min))
13499 ;; Simple %-escapes
13501 (when (and initial (equal (match-string 0) "%i"))
13502 (save-match-data
13503 (let* ((lead (buffer-substring
13504 (point-at-bol) (match-beginning 0))))
13505 (setq v-i (mapconcat 'identity
13508 (replace-match
13509 (or (eval (intern (concat "v-" (match-string 1)))) "")
13510 t t))
13512 ;; %[] Insert contents of a file.
13513 (goto-char (point-min))
13515 (let ((start (match-beginning 0))
13516 (end (match-end 0))
13517 (filename (expand-file-name (match-string 1))))
13518 (goto-char start)
13519 (delete-region start end)
13520 (condition-case error
13521 (insert-file-contents filename)
13522 (error (insert (format "%%![Couldn't insert %s: %s]"
13523 filename error))))))
13524 ;; %() embedded elisp
13525 (goto-char (point-min))
13527 (goto-char (match-beginning 0))
13528 (let ((template-start (point)))
13529 (forward-char 1)
13530 (let ((result
13531 (condition-case error
13532 (eval (read (current-buffer)))
13533 (error (format "%%![Error: %s]" error)))))
13534 (delete-region template-start (point))
13535 (insert result))))
13537 ;; From the property list
13538 (when plist-p
13539 (goto-char (point-min))
13541 (and (setq x (or (plist-get org-store-link-plist
13542 (intern (match-string 1))) ""))
13543 (replace-match x t t))))
13545 ;; Turn on org-mode in the remember buffer, set local variables
13546 (org-mode)
13547 (org-set-local 'org-finish-function 'org-remember-finalize)
13549 (org-set-local 'org-default-notes-file file))
13551 (org-set-local 'org-remember-default-headline headline))
13552 ;; Interactive template entries
13553 (goto-char (point-min))
13555 (setq char (if (match-end 3) (match-string 3))
13556 prompt (if (match-end 2) (match-string 2)))
13557 (goto-char (match-beginning 0))
13558 (replace-match "")
13559 (setq completions nil default nil)
13560 (when prompt
13561 (setq completions (org-split-string prompt "|")
13562 prompt (pop completions)
13563 default (car completions)
13564 histvar (intern (concat
13565 "org-remember-template-prompt-history::"
13566 (or prompt "")))
13567 completions (mapcar 'list completions)))
13568 (cond
13569 ((member char '("G" "g"))
13570 (let* ((org-last-tags-completion-table
13571 (org-global-tags-completion-table
13572 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13573 (org-add-colon-after-tag-completion t)
13574 (ins (completing-read
13575 (if prompt (concat prompt ": ") "Tags: ")
13576 'org-tags-completion-function nil nil nil
13577 'org-tags-history)))
13578 (setq ins (mapconcat 'identity
13579 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13580 ":"))
13582 (or (equal (char-before) ?:) (insert ":"))
13583 (insert ins)
13584 (or (equal (char-after) ?:) (insert ":")))))
13585 (char
13586 (setq org-time-was-given (equal (upcase char) char))
13587 (setq time (org-read-date (equal (upcase char) "U") t nil
13588 prompt))
13589 (org-insert-time-stamp time org-time-was-given
13590 (member char '("u" "U"))
13591 nil nil (list org-end-time-was-given)))
13592 (t
13593 (insert (org-completing-read
13594 (concat (if prompt prompt "Enter string")
13595 (if default (concat " [" default "]"))
13596 ": ")
13597 completions nil nil nil histvar default)))))
13598 (goto-char (point-min))
13600 (replace-match "")
13602 (org-mode)
13603 (org-set-local 'org-finish-function 'org-remember-finalize))
13604 (when (save-excursion
13605 (goto-char (point-min))
13606 (re-search-forward "%!" nil t))
13607 (replace-match "")
13608 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13610 (defun org-remember-finish-immediately ()
13611 "File remember note immediately.
13612 This should be run in `post-command-hook' and will remove itself
13613 from that hook."
13614 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13615 (when org-finish-function
13616 (funcall org-finish-function)))
13618 (defvar org-clock-marker) ; Defined below
13619 (defun org-remember-finalize ()
13620 "Finalize the remember process."
13621 (unless (fboundp 'remember-finalize)
13622 (defalias 'remember-finalize 'remember-buffer))
13623 (when (and org-clock-marker
13624 (equal (marker-buffer org-clock-marker) (current-buffer)))
13625 ;; FIXME: test this, this is w/o notetaking!
13626 (let (org-log-done) (org-clock-out)))
13627 (when buffer-file-name
13628 (save-buffer)
13629 (setq buffer-file-name nil))
13630 (remember-finalize))
13632 ;;;###autoload
13633 (defun org-remember (&optional goto org-force-remember-template-char)
13634 "Call `remember'. If this is already a remember buffer, re-apply template.
13635 If there is an active region, make sure remember uses it as initial content
13636 of the remember buffer.
13638 When called interactively with a `C-u' prefix argument GOTO, don't remember
13639 anything, just go to the file/headline where the selected template usually
13640 stores its notes. With a double prefix arg `C-u C-u', go to the last
13641 note stored by remember.
13643 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13644 associated with a template in `org-remember-templates'."
13645 (interactive "P")
13646 (cond
13647 ((equal goto '(4)) (org-go-to-remember-target))
13648 ((equal goto '(16)) (org-remember-goto-last-stored))
13649 (t
13650 (if (memq org-finish-function '(remember-buffer remember-finalize))
13651 (progn
13652 (when (< (length org-remember-templates) 2)
13653 (error "No other template available"))
13654 (erase-buffer)
13655 (let ((annotation (plist-get org-store-link-plist :annotation))
13656 (initial (plist-get org-store-link-plist :initial)))
13657 (org-remember-apply-template))
13658 (message "Press C-c C-c to remember data"))
13659 (if (org-region-active-p)
13660 (remember (buffer-substring (point) (mark)))
13661 (call-interactively 'remember))))))
13663 (defun org-remember-goto-last-stored ()
13664 "Go to the location where the last remember note was stored."
13665 (interactive)
13666 (bookmark-jump "org-remember-last-stored")
13667 (message "This is the last note stored by remember"))
13669 (defun org-go-to-remember-target (&optional template-key)
13670 "Go to the target location of a remember template.
13671 The user is queried for the template."
13672 (interactive)
13673 (let* ((entry (org-select-remember-template template-key))
13674 (file (nth 1 entry))
13675 (heading (nth 2 entry))
13676 visiting)
13678 (setq file org-default-notes-file))
13680 (setq heading org-remember-default-headline))
13681 (setq visiting (org-find-base-buffer-visiting file))
13682 (if (not visiting) (find-file-noselect file))
13683 (switch-to-buffer (or visiting (get-file-buffer file)))
13684 (widen)
13685 (goto-char (point-min))
13686 (if (re-search-forward
13689 nil t)
13690 (goto-char (match-beginning 0))
13691 (error "Target headline not found: %s" heading))))
13693 (defvar org-note-abort nil) ; dynamically scoped
13695 ;;;###autoload
13696 (defun org-remember-handler ()
13697 "Store stuff from remember.el into an org file.
13698 First prompts for an org file. If the user just presses return, the value
13699 of `org-default-notes-file' is used.
13700 Then the command offers the headings tree of the selected file in order to
13701 file the text at a specific location.
13702 You can either immediately press RET to get the note appended to the
13703 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13704 find a better place. Then press RET or <left> or <right> in insert the note.
13706 Key Cursor position Note gets inserted
13707 -----------------------------------------------------------------------------
13708 RET buffer-start as level 1 heading at end of file
13709 RET on headline as sublevel of the heading at cursor
13710 RET no heading at cursor position, level taken from context.
13711 Or use prefix arg to specify level manually.
13712 <left> on headline as same level, before current heading
13713 <right> on headline as same level, after current heading
13715 So the fastest way to store the note is to press RET RET to append it to
13716 the default file. This way your current train of thought is not
13717 interrupted, in accordance with the principles of remember.el.
13718 You can also get the fast execution without prompting by using
13719 C-u C-c C-c to exit the remember buffer. See also the variable
13720 `org-remember-store-without-prompt'.
13722 Before being stored away, the function ensures that the text has a
13724 is constructed from the current date and some additional data.
13726 If the variable `org-adapt-indentation' is non-nil, the entire text is
13727 also indented so that it starts in the same column as the headline
13728 \(i.e. after the stars).
13730 See also the variable `org-reverse-note-order'."
13731 (goto-char (point-min))
13733 (replace-match ""))
13734 (goto-char (point-max))
13735 (beginning-of-line 1)
13737 (delete-region (1- (point)) (point-max))
13738 (beginning-of-line 1))
13739 (catch 'quit
13740 (if org-note-abort (throw 'quit nil))
13741 (let* ((txt (buffer-substring (point-min) (point-max)))
13742 (fastp (org-xor (equal current-prefix-arg '(4))
13743 org-remember-store-without-prompt))
13744 (file (cond
13745 (fastp org-default-notes-file)
13746 ((and (eq org-remember-interactive-interface 'refile)
13747 org-refile-targets)
13748 org-default-notes-file)
13749 ((not (and (equal current-prefix-arg '(16))
13750 org-remember-previous-location))
13751 (org-get-org-file))))
13752 (heading org-remember-default-headline)
13753 (visiting (and file (org-find-base-buffer-visiting file)))
13754 (org-startup-folded nil)
13755 (org-startup-align-all-tables nil)
13756 (org-goto-start-pos 1)
13757 spos exitcmd level indent reversed)
13758 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13759 (setq file (car org-remember-previous-location)
13760 heading (cdr org-remember-previous-location)
13761 fastp t))
13762 (setq current-prefix-arg nil)
13764 (setq txt (replace-match "" t t txt)))
13765 ;; Modify text so that it becomes a nice subtree which can be inserted
13766 ;; into an org tree.
13768 first)
13769 (setq first (car lines) lines (cdr lines))
13771 ;; Is already a headline
13772 (setq indent nil)
13773 ;; We need to add a headline: Use time and first buffer line
13774 (setq lines (cons first lines)
13775 first (concat "* " (current-time-string)
13776 " (" (remember-buffer-desc) ")")
13777 indent " "))
13778 (if (and org-adapt-indentation indent)
13779 (setq lines (mapcar
13780 (lambda (x)
13782 (concat indent x) x))
13783 lines)))
13790 ;; Put the modified text back into the remember buffer, for refile.
13791 (erase-buffer)
13792 (insert txt)
13793 (goto-char (point-min))
13794 (when (and (eq org-remember-interactive-interface 'refile)
13795 (not fastp))
13796 (org-refile nil (or visiting (find-file-noselect file)))
13797 (throw 'quit t))
13798 ;; Find the file
13799 (if (not visiting) (find-file-noselect file))
13800 (with-current-buffer (or visiting (get-file-buffer file))
13801 (unless (org-mode-p)
13802 (error "Target files for remember notes must be in Org-mode"))
13803 (save-excursion
13804 (save-restriction
13805 (widen)
13806 (and (goto-char (point-min))
13809 (setq reversed (org-notes-order-reversed-p))
13811 ;; Find the default location
13813 (goto-char (point-min))
13814 (if (re-search-forward
13817 nil t)
13818 (setq org-goto-start-pos (match-beginning 0))
13819 (when fastp
13820 (goto-char (point-max))
13821 (unless (bolp) (newline))
13823 (setq org-goto-start-pos (point-at-bol 0)))))
13825 ;; Ask the User for a location, using the appropriate interface
13826 (cond
13827 (fastp (setq spos org-goto-start-pos
13828 exitcmd 'return))
13829 ((eq org-remember-interactive-interface 'outline)
13830 (setq spos (org-get-location (current-buffer)
13831 org-remember-help)
13832 exitcmd (cdr spos)
13833 spos (car spos)))
13834 ((eq org-remember-interactive-interface 'outline-path-completion)
13835 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13836 (org-refile-use-outline-path t))
13837 (setq spos (org-refile-get-location "Heading: ")
13838 exitcmd 'return
13839 spos (nth 3 spos))))
13840 (t (error "this should not hapen")))
13841 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13842 ; not handle this note
13843 (goto-char spos)
13844 (cond ((org-on-heading-p t)
13845 (org-back-to-heading t)
13846 (setq level (funcall outline-level))
13847 (cond
13848 ((eq exitcmd 'return)
13849 ;; sublevel of current
13850 (setq org-remember-previous-location
13851 (cons (abbreviate-file-name file)
13852 (org-get-heading 'notags)))
13853 (if reversed
13854 (outline-next-heading)
13855 (org-end-of-subtree t)
13856 (if (not (bolp))
13858 (beginning-of-line 2)
13859 (end-of-line 1)
13861 (bookmark-set "org-remember-last-stored")
13862 (org-paste-subtree (org-get-legal-level level 1) txt))
13863 ((eq exitcmd 'left)
13864 ;; before current
13865 (bookmark-set "org-remember-last-stored")
13866 (org-paste-subtree level txt))
13867 ((eq exitcmd 'right)
13868 ;; after current
13869 (org-end-of-subtree t)
13870 (bookmark-set "org-remember-last-stored")
13871 (org-paste-subtree level txt))
13872 (t (error "This should not happen"))))
13874 ((and (bobp) (not reversed))
13875 ;; Put it at the end, one level below level 1
13876 (save-restriction
13877 (widen)
13878 (goto-char (point-max))
13879 (if (not (bolp)) (newline))
13880 (bookmark-set "org-remember-last-stored")
13881 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13883 ((and (bobp) reversed)
13884 ;; Put it at the start, as level 1
13885 (save-restriction
13886 (widen)
13887 (goto-char (point-min))
13889 (beginning-of-line 1)
13890 (bookmark-set "org-remember-last-stored")
13891 (org-paste-subtree 1 txt)))
13892 (t
13893 ;; Put it right there, with automatic level determined by
13894 ;; org-paste-subtree or from prefix arg
13895 (bookmark-set "org-remember-last-stored")
13896 (org-paste-subtree
13897 (if (numberp current-prefix-arg) current-prefix-arg)
13898 txt)))
13899 (when remember-save-after-remembering
13900 (save-buffer)
13901 (if (not visiting) (kill-buffer (current-buffer)))))))))
13903 t) ;; return t to indicate that we took care of this note.
13905 (defun org-get-org-file ()
13906 "Read a filename, with default directory `org-directory'."
13907 (let ((default (or org-default-notes-file remember-data-file)))
13908 (read-file-name (format "File name [%s]: " default)
13909 (file-name-as-directory org-directory)
13910 default)))
13912 (defun org-notes-order-reversed-p ()
13913 "Check if the current file should receive notes in reversed order."
13914 (cond
13915 ((not org-reverse-note-order) nil)
13916 ((eq t org-reverse-note-order) t)
13917 ((not (listp org-reverse-note-order)) nil)
13918 (t (catch 'exit
13919 (let ((all org-reverse-note-order)
13920 entry)
13921 (while (setq entry (pop all))
13922 (if (string-match (car entry) buffer-file-name)
13923 (throw 'exit (cdr entry))))
13924 nil)))))
13926 ;;; Refiling
13928 (defvar org-refile-target-table nil
13929 "The list of refile targets, created by `org-refile'.")
13931 (defvar org-agenda-new-buffers nil
13932 "Buffers created to visit agenda files.")
13934 (defun org-get-refile-targets (&optional default-buffer)
13935 "Produce a table with refile targets."
13936 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13937 targets txt re files f desc descre)
13938 (with-current-buffer (or default-buffer (current-buffer))
13939 (while (setq entry (pop entries))
13940 (setq files (car entry) desc (cdr entry))
13941 (cond
13942 ((null files) (setq files (list (current-buffer))))
13943 ((eq files 'org-agenda-files)
13944 (setq files (org-agenda-files 'unrestricted)))
13945 ((and (symbolp files) (fboundp files))
13946 (setq files (funcall files)))
13947 ((and (symbolp files) (boundp files))
13948 (setq files (symbol-value files))))
13949 (if (stringp files) (setq files (list files)))
13950 (cond
13951 ((eq (car desc) :tag)
13953 ((eq (car desc) :todo)
13955 ((eq (car desc) :regexp)
13956 (setq descre (cdr desc)))
13957 ((eq (car desc) :level)
13959 (if org-odd-levels-only
13960 (1- (* 2 (cdr desc)))
13961 (cdr desc)))
13963 ((eq (car desc) :maxlevel)
13965 (if org-odd-levels-only
13966 (1- (* 2 (cdr desc)))
13967 (cdr desc)))
13969 (t (error "Bad refiling target description %s" desc)))
13970 (while (setq f (pop files))
13971 (save-excursion
13972 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13973 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13974 (save-excursion
13975 (save-restriction
13976 (widen)
13977 (goto-char (point-min))
13978 (while (re-search-forward descre nil t)
13979 (goto-char (point-at-bol))
13980 (when (looking-at org-complex-heading-regexp)
13981 (setq txt (match-string 4)
13982 re (concat "^" (regexp-quote
13983 (buffer-substring (match-beginning 1)
13984 (match-end 4)))))
13986 (regexp-quote
13987 (match-string 5)))))
13989 (when org-refile-use-outline-path
13990 (setq txt (mapconcat 'identity
13991 (append
13992 (if (eq org-refile-use-outline-path 'file)
13993 (list (file-name-nondirectory
13994 (buffer-file-name (buffer-base-buffer))))
13995 (if (eq org-refile-use-outline-path 'full-file-path)
13996 (list (buffer-file-name (buffer-base-buffer)))))
13997 (org-get-outline-path)
13998 (list txt))
13999 "/")))
14000 (push (list txt f re (point)) targets))
14001 (goto-char (point-at-eol))))))))
14002 (nreverse targets))))
14004 (defun org-get-outline-path ()
14005 "Return the outline path to the current entry, as a list."
14006 (let (rtn)
14007 (save-excursion
14008 (while (org-up-heading-safe)
14009 (when (looking-at org-complex-heading-regexp)
14010 (push (org-match-string-no-properties 4) rtn)))
14011 rtn)))
14013 (defvar org-refile-history nil
14014 "History for refiling operations.")
14016 (defun org-refile (&optional goto default-buffer)
14017 "Move the entry at point to another heading.
14018 The list of target headings is compiled using the information in
14019 `org-refile-targets', which see. This list is created upon first use, and
14020 you can update it by calling this command with a double prefix (`C-u C-u').
14021 FIXME: Can we find a better way of updating?
14023 At the target location, the entry is filed as a subitem of the target heading.
14024 Depending on `org-reverse-note-order', the new subitem will either be the
14025 first of the last subitem.
14027 With prefix arg GOTO, the command will only visit the target location,
14028 not actually move anything.
14029 With a double prefix `C-c C-c', go to the location where the last refiling
14030 operation has put the subtree.
14032 With a double prefix argument, the command can be used to jump to any
14033 heading in the current buffer."
14034 (interactive "P")
14035 (let* ((cbuf (current-buffer))
14036 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14037 (fname (and filename (file-truename filename)))
14038 pos it nbuf file re level reversed)
14039 (if (equal goto '(16))
14040 (org-refile-goto-last-stored)
14041 (when (setq it (org-refile-get-location
14042 (if goto "Goto: " "Refile to: ") default-buffer))
14043 (setq file (nth 1 it)
14044 re (nth 2 it)
14045 pos (nth 3 it))
14046 (setq nbuf (or (find-buffer-visiting file)
14047 (find-file-noselect file)))
14048 (if goto
14049 (progn
14050 (switch-to-buffer nbuf)
14051 (goto-char pos)
14052 (org-show-context 'org-goto))
14053 (org-copy-special)
14054 (save-excursion
14055 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14056 (find-file-noselect file))))
14057 (setq reversed (org-notes-order-reversed-p))
14058 (save-excursion
14059 (save-restriction
14060 (widen)
14061 (goto-char pos)
14062 (looking-at outline-regexp)
14063 (setq level (org-get-legal-level (funcall outline-level) 1))
14064 (goto-char (or (save-excursion
14065 (if reversed
14066 (outline-next-heading)
14067 (outline-get-next-sibling)))
14068 (point-max)))
14069 (bookmark-set "org-refile-last-stored")
14070 (org-paste-subtree level))))
14071 (org-cut-special)
14074 (defun org-refile-goto-last-stored ()
14075 "Go to the location where the last refile was stored."
14076 (interactive)
14077 (bookmark-jump "org-refile-last-stored")
14078 (message "This is the location of the last refile"))
14080 (defun org-refile-get-location (&optional prompt default-buffer)
14081 "Prompt the user for a refile location, using PROMPT."
14082 (let ((org-refile-targets org-refile-targets)
14083 (org-refile-use-outline-path org-refile-use-outline-path))
14084 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14085 (unless org-refile-target-table
14086 (error "No refile targets"))
14087 (let* ((cbuf (current-buffer))
14088 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14089 (fname (and filename (file-truename filename)))
14090 (tbl (mapcar
14091 (lambda (x)
14092 (if (not (equal fname (file-truename (nth 1 x))))
14093 (cons (concat (car x) " (" (file-name-nondirectory
14094 (nth 1 x)) ")")
14095 (cdr x))
14096 x))
14097 org-refile-target-table))
14098 (completion-ignore-case t)
14099 pos it nbuf file re level reversed)
14100 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14101 tbl)))
14103 ;;;; Dynamic blocks
14105 (defun org-find-dblock (name)
14106 "Find the first dynamic block with name NAME in the buffer.
14107 If not found, stay at current position and return nil."
14108 (let (pos)
14109 (save-excursion
14110 (goto-char (point-min))
14112 nil t)
14113 (match-beginning 0))))
14114 (if pos (goto-char pos))
14115 pos))
14117 (defconst org-dblock-start-re
14119 "Matches the startline of a dynamic block, with parameters.")
14122 "Matches the end of a dyhamic block.")
14124 (defun org-create-dblock (plist)
14125 "Create a dynamic block section, with parameters taken from PLIST.
14126 PLIST must containe a :name entry which is used as name of the block."
14127 (unless (bolp) (newline))
14128 (let ((name (plist-get plist :name)))
14129 (insert "#+BEGIN: " name)
14130 (while plist
14131 (if (eq (car plist) :name)
14132 (setq plist (cddr plist))
14133 (insert " " (prin1-to-string (pop plist)))))
14135 (beginning-of-line -2)))
14137 (defun org-prepare-dblock ()
14138 "Prepare dynamic block for refresh.
14139 This empties the block, puts the cursor at the insert position and returns
14140 the property list including an extra property :name with the block name."
14141 (unless (looking-at org-dblock-start-re)
14142 (error "Not at a dynamic block"))
14143 (let* ((begdel (1+ (match-end 0)))
14144 (name (org-no-properties (match-string 1)))
14145 (params (append (list :name name)
14146 (read (concat "(" (match-string 3) ")")))))
14147 (unless (re-search-forward org-dblock-end-re nil t)
14148 (error "Dynamic block not terminated"))
14149 (delete-region begdel (match-beginning 0))
14150 (goto-char begdel)
14151 (open-line 1)
14152 params))
14154 (defun org-map-dblocks (&optional command)
14155 "Apply COMMAND to all dynamic blocks in the current buffer.
14156 If COMMAND is not given, use `org-update-dblock'."
14157 (let ((cmd (or command 'org-update-dblock))
14158 pos)
14159 (save-excursion
14160 (goto-char (point-min))
14161 (while (re-search-forward org-dblock-start-re nil t)
14162 (goto-char (setq pos (match-beginning 0)))
14163 (condition-case nil
14164 (funcall cmd)
14165 (error (message "Error during update of dynamic block")))
14166 (goto-char pos)
14167 (unless (re-search-forward org-dblock-end-re nil t)
14168 (error "Dynamic block not terminated"))))))
14170 (defun org-dblock-update (&optional arg)
14171 "User command for updating dynamic blocks.
14172 Update the dynamic block at point. With prefix ARG, update all dynamic
14173 blocks in the buffer."
14174 (interactive "P")
14175 (if arg
14176 (org-update-all-dblocks)
14177 (or (looking-at org-dblock-start-re)
14178 (org-beginning-of-dblock))
14179 (org-update-dblock)))
14181 (defun org-update-dblock ()
14182 "Update the dynamic block at point
14183 This means to empty the block, parse for parameters and then call
14184 the correct writing function."
14185 (save-window-excursion
14186 (let* ((pos (point))
14187 (line (org-current-line))
14188 (params (org-prepare-dblock))
14189 (name (plist-get params :name))
14190 (cmd (intern (concat "org-dblock-write:" name))))
14191 (message "Updating dynamic block `%s' at line %d..." name line)
14192 (funcall cmd params)
14193 (message "Updating dynamic block `%s' at line %d...done" name line)
14194 (goto-char pos))))
14196 (defun org-beginning-of-dblock ()
14197 "Find the beginning of the dynamic block at point.
14198 Error if there is no scuh block at point."
14199 (let ((pos (point))
14200 beg)
14201 (end-of-line 1)
14202 (if (and (re-search-backward org-dblock-start-re nil t)
14203 (setq beg (match-beginning 0))
14204 (re-search-forward org-dblock-end-re nil t)
14205 (> (match-end 0) pos))
14206 (goto-char beg)
14207 (goto-char pos)
14208 (error "Not in a dynamic block"))))
14210 (defun org-update-all-dblocks ()
14211 "Update all dynamic blocks in the buffer.
14212 This function can be used in a hook."
14213 (when (org-mode-p)
14214 (org-map-dblocks 'org-update-dblock)))
14217 ;;;; Completion
14219 (defconst org-additional-option-like-keywords
14220 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14221 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14222 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14224 (defun org-complete (&optional arg)
14225 "Perform completion on word at point.
14226 At the beginning of a headline, this completes TODO keywords as given in
14227 `org-todo-keywords'.
14228 If the current word is preceded by a backslash, completes the TeX symbols
14229 that are supported for HTML support.
14231 setting file options.
14233 At all other locations, this simply calls the value of
14234 `org-completion-fallback-command'."
14235 (interactive "P")
14236 (org-without-partial-completion
14237 (catch 'exit
14238 (let* ((end (point))
14239 (beg1 (save-excursion
14240 (skip-chars-backward (org-re "[:alnum:]_@"))
14241 (point)))
14242 (beg (save-excursion
14243 (skip-chars-backward "a-zA-Z0-9_:$")
14244 (point)))
14245 (confirm (lambda (x) (stringp (car x))))
14246 (searchhead (equal (char-before beg) ?*))
14247 (tag (and (equal (char-before beg1) ?:)
14248 (equal (char-after (point-at-bol)) ?*)))
14249 (prop (and (equal (char-before beg1) ?:)
14250 (not (equal (char-after (point-at-bol)) ?*))))
14252 (link (equal (char-before beg) ?\[))
14253 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14254 beg)
14255 "#+"))
14257 (buffer-substring (point-at-bol) (point))))
14258 (completion-ignore-case opt)
14259 (type nil)
14260 (tbl nil)
14261 (table (cond
14262 (opt
14263 (setq type :opt)
14264 (append
14265 (mapcar
14266 (lambda (x)
14268 (cons (match-string 2 x) (match-string 1 x)))
14270 (mapcar 'list org-additional-option-like-keywords)))
14271 (startup
14272 (setq type :startup)
14273 org-startup-options)
14274 (link (append org-link-abbrev-alist-local
14275 org-link-abbrev-alist))
14276 (texp
14277 (setq type :tex)
14278 org-html-entities)
14280 (buffer-substring (point-at-bol) beg))
14281 (setq type :todo)
14282 (mapcar 'list org-todo-keywords-1))
14283 (searchhead
14284 (setq type :searchhead)
14285 (save-excursion
14286 (goto-char (point-min))
14287 (while (re-search-forward org-todo-line-regexp nil t)
14288 (push (list
14289 (org-make-org-heading-search-string
14290 (match-string 3) t))
14291 tbl)))
14292 tbl)
14293 (tag (setq type :tag beg beg1)
14294 (or org-tag-alist (org-get-buffer-tags)))
14295 (prop (setq type :prop beg beg1)
14296 (mapcar 'list (org-buffer-property-keys)))
14297 (t (progn
14298 (call-interactively org-completion-fallback-command)
14299 (throw 'exit nil)))))
14300 (pattern (buffer-substring-no-properties beg end))
14301 (completion (try-completion pattern table confirm)))
14302 (cond ((eq completion t)
14303 (if (not (assoc (upcase pattern) table))
14304 (message "Already complete")
14305 (if (equal type :opt)
14306 (insert (substring (cdr (assoc (upcase pattern) table))
14307 (length pattern)))
14308 (if (memq type '(:tag :prop)) (insert ":")))))
14309 ((null completion)
14311 (ding))
14312 ((not (string= pattern completion))
14313 (delete-region beg end)
14314 (if (string-match " +$" completion)
14315 (setq completion (replace-match "" t t completion)))
14316 (insert completion)
14317 (if (get-buffer-window "*Completions*")
14318 (delete-window (get-buffer-window "*Completions*")))
14319 (if (assoc completion table)
14320 (if (eq type :todo) (insert " ")
14321 (if (memq type '(:tag :prop)) (insert ":"))))
14322 (if (and (equal type :opt) (assoc completion table))
14323 (message "%s" (substitute-command-keys
14325 (t
14326 (message "Making completion list...")
14327 (let ((list (sort (all-completions pattern table confirm)
14328 'string<)))
14329 (with-output-to-temp-buffer "*Completions*"
14330 (condition-case nil
14331 ;; Protection needed for XEmacs and emacs 21
14332 (display-completion-list list pattern)
14333 (error (display-completion-list list)))))
14334 (message "Making completion list...%s" "done")))))))
14336 ;;;; TODO, DEADLINE, Comments
14338 (defun org-toggle-comment ()
14339 "Change the COMMENT state of an entry."
14340 (interactive)
14341 (save-excursion
14342 (org-back-to-heading)
14343 (let (case-fold-search)
14344 (if (looking-at (concat outline-regexp
14346 (replace-match "" t t nil 1)
14347 (if (looking-at outline-regexp)
14348 (progn
14349 (goto-char (match-end 0))
14350 (insert org-comment-string " ")))))))
14352 (defvar org-last-todo-state-is-todo nil
14353 "This is non-nil when the last TODO state change led to a TODO state.
14354 If the last change removed the TODO tag or switched to DONE, then
14355 this is nil.")
14357 (defvar org-setting-tags nil) ; dynamically skiped
14359 ;; FIXME: better place
14360 (defun org-property-or-variable-value (var &optional inherit)
14361 "Check if there is a property fixing the value of VAR.
14362 If yes, return this value. If not, return the current value of the variable."
14363 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14365 (read prop)
14366 (symbol-value var))))
14368 (defun org-parse-local-options (string var)
14369 "Parse STRING for startup setting relevant for variable VAR."
14370 (let ((rtn (symbol-value var))
14371 e opts)
14372 (save-match-data
14374 rtn
14375 (setq opts (delq nil (mapcar (lambda (x)
14376 (setq e (assoc x org-startup-options))
14377 (if (eq (nth 1 e) var) e nil))
14379 (if (not opts)
14380 rtn
14381 (setq rtn nil)
14382 (while (setq e (pop opts))
14383 (if (not (nth 3 e))
14384 (setq rtn (nth 2 e))
14385 (if (not (listp rtn)) (setq rtn nil))
14386 (push (nth 2 e) rtn)))
14387 rtn)))))
14389 (defvar org-blocker-hook nil
14390 "Hook for functions that are allowed to block a state change.
14392 Each function gets as its single argument a property list, see
14393 `org-trigger-hook' for more information about this list.
14395 If any of the functions in this hook returns nil, the state change
14396 is blocked.")
14398 (defvar org-trigger-hook nil
14399 "Hook for functions that are triggered by a state change.
14401 Each function gets as its single argument a property list with at least
14402 the following elements:
14404 (:type type-of-change :position pos-at-entry-start
14405 :from old-state :to new-state)
14407 Depending on the type, more properties may be present.
14409 This mechanism is currently implemented for:
14411 TODO state changes
14412 ------------------
14413 :type todo-state-change
14414 :from previous state (keyword as a string), or nil
14415 :to new state (keyword as a string), or nil")
14418 (defun org-todo (&optional arg)
14419 "Change the TODO state of an item.
14420 The state of an item is given by a keyword at the start of the heading,
14421 like
14422 *** TODO Write paper
14423 *** DONE Call mom
14425 The different keywords are specified in the variable `org-todo-keywords'.
14427 So for this example: when the item starts with TODO, it is changed to DONE.
14428 When it starts with DONE, the DONE is removed. And when neither TODO nor
14429 DONE are present, add TODO at the beginning of the heading.
14431 With C-u prefix arg, use completion to determine the new state.
14432 With numeric prefix arg, switch to that state.
14434 For calling through lisp, arg is also interpreted in the following way:
14435 'none -> empty state
14437 'done -> switch to DONE
14438 'nextset -> switch to the next set of keywords
14439 'previousset -> switch to the previous set of keywords
14441 really is a member of `org-todo-keywords'."
14442 (interactive "P")
14443 (save-excursion
14444 (catch 'exit
14445 (org-back-to-heading)
14446 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14447 (or (looking-at (concat " +" org-todo-regexp " *"))
14448 (looking-at " *"))
14449 (let* ((match-data (match-data))
14450 (startpos (point-at-bol))
14451 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14452 (org-log-done (org-parse-local-options logging 'org-log-done))
14453 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
14454 (this (match-string 1))
14455 (hl-pos (match-beginning 0))
14456 (head (org-get-todo-sequence-head this))
14457 (ass (assoc head org-todo-kwd-alist))
14458 (interpret (nth 1 ass))
14459 (done-word (nth 3 ass))
14460 (final-done-word (nth 4 ass))
14461 (last-state (or this ""))
14462 (completion-ignore-case t)
14463 (member (member this org-todo-keywords-1))
14464 (tail (cdr member))
14465 (state (cond
14466 ((and org-todo-key-trigger
14467 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14468 (and (not arg) org-use-fast-todo-selection
14469 (not (eq org-use-fast-todo-selection 'prefix)))))
14470 ;; Use fast selection
14471 (org-fast-todo-selection))
14472 ((and (equal arg '(4))
14473 (or (not org-use-fast-todo-selection)
14474 (not org-todo-key-trigger)))
14475 ;; Read a state with completion
14476 (completing-read "State: " (mapcar (lambda(x) (list x))
14477 org-todo-keywords-1)
14478 nil t))
14479 ((eq arg 'right)
14480 (if this
14481 (if tail (car tail) nil)
14482 (car org-todo-keywords-1)))
14483 ((eq arg 'left)
14484 (if (equal member org-todo-keywords-1)
14485 nil
14486 (if this
14487 (nth (- (length org-todo-keywords-1) (length tail) 2)
14488 org-todo-keywords-1)
14489 (org-last org-todo-keywords-1))))
14490 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14491 (setq arg nil))) ; hack to fall back to cycling
14492 (arg
14493 ;; user or caller requests a specific state
14494 (cond
14495 ((equal arg "") nil)
14496 ((eq arg 'none) nil)
14497 ((eq arg 'done) (or done-word (car org-done-keywords)))
14498 ((eq arg 'nextset)
14499 (or (car (cdr (member head org-todo-heads)))
14500 (car org-todo-heads)))
14501 ((eq arg 'previousset)
14502 (let ((org-todo-heads (reverse org-todo-heads)))
14503 (or (car (cdr (member head org-todo-heads)))
14504 (car org-todo-heads))))
14505 ((car (member arg org-todo-keywords-1)))
14506 ((nth (1- (prefix-numeric-value arg))
14507 org-todo-keywords-1))))
14508 ((null member) (or head (car org-todo-keywords-1)))
14509 ((equal this final-done-word) nil) ;; -> make empty
14510 ((null tail) nil) ;; -> first entry
14511 ((eq interpret 'sequence)
14512 (car tail))
14513 ((memq interpret '(type priority))
14514 (if (eq this-command last-command)
14515 (car tail)
14516 (if (> (length tail) 0)
14517 (or done-word (car org-done-keywords))
14518 nil)))
14519 (t nil)))
14520 (next (if state (concat " " state " ") " "))
14521 (change-plist (list :type 'todo-state-change :from this :to state
14522 :position startpos))
14523 dostates)
14524 (when org-blocker-hook
14525 (unless (save-excursion
14526 (save-match-data
14527 (run-hook-with-args-until-failure
14528 'org-blocker-hook change-plist)))
14529 (if (interactive-p)
14530 (error "TODO state change from %s to %s blocked" this state)
14531 ;; fail silently
14532 (message "TODO state change from %s to %s blocked" this state)
14533 (throw 'exit nil))))
14534 (store-match-data match-data)
14535 (replace-match next t t)
14536 (unless (pos-visible-in-window-p hl-pos)
14537 (message "TODO state changed to %s" (org-trim next)))
14538 (unless head
14539 (setq head (org-get-todo-sequence-head state)
14540 ass (assoc head org-todo-kwd-alist)
14541 interpret (nth 1 ass)
14542 done-word (nth 3 ass)
14543 final-done-word (nth 4 ass)))
14544 (when (memq arg '(nextset previousset))
14545 (message "Keyword-Set %d/%d: %s"
14546 (- (length org-todo-sets) -1
14547 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14548 (length org-todo-sets)
14549 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14550 (setq org-last-todo-state-is-todo
14551 (not (member state org-done-keywords)))
14552 (when (and org-log-done (not (memq arg '(nextset previousset))))
14553 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
14554 (or (not org-todo-log-states)
14555 (member state org-todo-log-states))))
14557 (cond
14558 ((and state (member state org-not-done-keywords)
14559 (not (member this org-not-done-keywords)))
14560 ;; This is now a todo state and was not one before
14561 ;; Remove any CLOSED timestamp, and possibly log the state change
14562 (org-add-planning-info nil nil 'closed)
14563 (and dostates (org-add-log-maybe 'state state 'findpos)))
14564 ((and state dostates)
14565 ;; This is a non-nil state, and we need to log it
14566 (org-add-log-maybe 'state state 'findpos))
14567 ((and (member state org-done-keywords)
14568 (not (member this org-done-keywords)))
14569 ;; It is now done, and it was not done before
14570 (org-add-planning-info 'closed (org-current-time))
14571 (org-add-log-maybe 'done state 'findpos))))
14572 ;; Fixup tag positioning
14573 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14574 (run-hooks 'org-after-todo-state-change-hook)
14575 (and (member state org-done-keywords) (org-auto-repeat-maybe))
14576 (if (and arg (not (member state org-done-keywords)))
14577 (setq head (org-get-todo-sequence-head state)))
14578 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14579 ;; Fixup cursor location if close to the keyword
14580 (if (and (outline-on-heading-p)
14581 (not (bolp))
14582 (save-excursion (beginning-of-line 1)
14583 (looking-at org-todo-line-regexp))
14584 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14585 (progn
14586 (goto-char (or (match-end 2) (match-end 1)))
14587 (just-one-space)))
14588 (when org-trigger-hook
14589 (save-excursion
14590 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14592 (defun org-get-todo-sequence-head (kwd)
14593 "Return the head of the TODO sequence to which KWD belongs.
14594 If KWD is not set, check if there is a text property remembering the
14595 right sequence."
14596 (let (p)
14597 (cond
14598 ((not kwd)
14599 (or (get-text-property (point-at-bol) 'org-todo-head)
14600 (progn
14601 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14602 nil (point-at-eol)))
14603 (get-text-property p 'org-todo-head))))
14604 ((not (member kwd org-todo-keywords-1))
14605 (car org-todo-keywords-1))
14606 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14608 (defun org-fast-todo-selection ()
14609 "Fast TODO keyword selection with single keys.
14610 Returns the new TODO keyword, or nil if no state change should occur."
14611 (let* ((fulltable org-todo-key-alist)
14612 (done-keywords org-done-keywords) ;; needed for the faces.
14613 (maxlen (apply 'max (mapcar
14614 (lambda (x)
14615 (if (stringp (car x)) (string-width (car x)) 0))
14616 fulltable)))
14617 (expert nil)
14618 (fwidth (+ maxlen 3 1 3))
14619 (ncol (/ (- (window-width) 4) fwidth))
14620 tg cnt e c tbl
14621 groups ingroup)
14622 (save-window-excursion
14623 (if expert
14624 (set-buffer (get-buffer-create " *Org todo*"))
14625 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14626 (erase-buffer)
14627 (org-set-local 'org-done-keywords done-keywords)
14628 (setq tbl fulltable cnt 0)
14629 (while (setq e (pop tbl))
14630 (cond
14631 ((equal e '(:startgroup))
14632 (push '() groups) (setq ingroup t)
14633 (when (not (= cnt 0))
14634 (setq cnt 0)
14636 (insert "{ "))
14637 ((equal e '(:endgroup))
14638 (setq ingroup nil cnt 0)
14640 (t
14641 (setq tg (car e) c (cdr e))
14642 (if ingroup (push tg (car groups)))
14643 (setq tg (org-add-props tg nil 'face
14644 (org-get-todo-face tg)))
14645 (if (and (= cnt 0) (not ingroup)) (insert " "))
14646 (insert "[" c "] " tg (make-string
14647 (- fwidth 4 (length tg)) ?\ ))
14648 (when (= (setq cnt (1+ cnt)) ncol)
14650 (if ingroup (insert " "))
14651 (setq cnt 0)))))
14653 (goto-char (point-min))
14654 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14655 (fit-window-to-buffer))
14656 (message "[a-z..]:Set [SPC]:clear")
14657 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14658 (cond
14659 ((or (= c ?\C-g)
14660 (and (= c ?q) (not (rassoc c fulltable))))
14661 (setq quit-flag t))
14662 ((= c ?\ ) nil)
14663 ((setq e (rassoc c fulltable) tg (car e))
14664 tg)
14665 (t (setq quit-flag t))))))
14667 (defun org-get-repeat ()
14668 "Check if tere is a deadline/schedule with repeater in this entry."
14669 (save-match-data
14670 (save-excursion
14671 (org-back-to-heading t)
14672 (if (re-search-forward
14673 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14674 (match-string 1)))))
14676 (defvar org-last-changed-timestamp)
14677 (defvar org-log-post-message)
14678 (defun org-auto-repeat-maybe ()
14679 "Check if the current headline contains a repeated deadline/schedule.
14680 If yes, set TODO state back to what it was and change the base date
14681 of repeating deadline/scheduled time stamps to new date.
14682 This function should be run in the `org-after-todo-state-change-hook'."
14683 ;; last-state is dynamically scoped into this function
14684 (let* ((repeat (org-get-repeat))
14685 (aa (assoc last-state org-todo-kwd-alist))
14686 (interpret (nth 1 aa))
14687 (head (nth 2 aa))
14688 (done-word (nth 3 aa))
14689 (whata '(("d" . day) ("m" . month) ("y" . year)))
14690 (msg "Entry repeats: ")
14691 (org-log-done)
14692 re type n what ts)
14693 (when repeat
14694 (org-todo (if (eq interpret 'type) last-state head))
14695 (when (and org-log-repeat
14696 (not (memq 'org-add-log-note
14697 (default-value 'post-command-hook))))
14698 ;; Make sure a note is taken
14699 (let ((org-log-done '(done)))
14700 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
14701 'findpos)))
14702 (org-back-to-heading t)
14703 (org-add-planning-info nil nil 'closed)
14707 (while (re-search-forward
14708 re (save-excursion (outline-next-heading) (point)) t)
14709 (setq type (if (match-end 1) org-scheduled-string
14710 (if (match-end 3) org-deadline-string "Plain:"))
14711 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14713 (setq n (string-to-number (match-string 1 ts))
14714 what (match-string 2 ts))
14715 (if (equal what "w") (setq n (* n 7) what "d"))
14716 (org-timestamp-change n (cdr (assoc what whata)))
14717 (setq msg (concat msg type org-last-changed-timestamp " "))))
14718 (setq org-log-post-message msg)
14719 (message "%s" msg))))
14721 (defun org-show-todo-tree (arg)
14722 "Make a compact tree which shows all headlines marked with TODO.
14723 The tree will show the lines where the regexp matches, and all higher
14724 headlines above the match.
14726 With a numeric prefix N, construct a sparse tree for the Nth element
14727 of `org-todo-keywords-1'."
14728 (interactive "P")
14729 (let ((case-fold-search nil)
14730 (kwd-re
14731 (cond ((null arg) org-not-done-regexp)
14732 ((equal arg '(4))
14733 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14734 (mapcar 'list org-todo-keywords-1))))
14738 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14739 (regexp-quote (nth (1- (prefix-numeric-value arg))
14740 org-todo-keywords-1)))
14741 (t (error "Invalid prefix argument: %s" arg)))))
14742 (message "%d TODO entries found"
14743 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14745 (defun org-deadline (&optional remove)
14747 With argument REMOVE, remove any deadline from the item."
14748 (interactive "P")
14749 (if remove
14750 (progn
14751 (org-remove-timestamp-with-keyword org-deadline-string)
14752 (message "Item no longer has a deadline."))
14753 (org-add-planning-info 'deadline nil 'closed)))
14755 (defun org-schedule (&optional remove)
14756 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14757 With argument REMOVE, remove any scheduling date from the item."
14758 (interactive "P")
14759 (if remove
14760 (progn
14761 (org-remove-timestamp-with-keyword org-scheduled-string)
14762 (message "Item is no longer scheduled."))
14763 (org-add-planning-info 'scheduled nil 'closed)))
14765 (defun org-remove-timestamp-with-keyword (keyword)
14766 "Remove all time stamps with KEYWORD in the current entry."
14768 beg)
14769 (save-excursion
14770 (org-back-to-heading t)
14771 (setq beg (point))
14772 (org-end-of-subtree t t)
14773 (while (re-search-backward re beg t)
14774 (replace-match "")
14776 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14778 (defun org-add-planning-info (what &optional time &rest remove)
14779 "Insert new timestamp with keyword in the line directly after the headline.
14780 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14781 If non is given, the user is prompted for a date.
14782 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14783 be removed."
14784 (interactive)
14785 (let (org-time-was-given org-end-time-was-given)
14786 (when what (setq time (or time (org-read-date nil 'to-time))))
14787 (when (and org-insert-labeled-timestamps-at-point
14788 (member what '(scheduled deadline)))
14789 (insert
14790 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14791 (org-insert-time-stamp time org-time-was-given
14792 nil nil nil (list org-end-time-was-given))
14793 (setq what nil))
14794 (save-excursion
14795 (save-restriction
14796 (let (col list elt ts buffer-invisibility-spec)
14797 (org-back-to-heading t)
14799 (goto-char (match-end 1))
14800 (setq col (current-column))
14801 (goto-char (match-end 0))
14803 (if (and (not (looking-at outline-regexp))
14806 (not (equal (match-string 1) org-clock-string)))
14807 (narrow-to-region (match-beginning 0) (match-end 0))
14809 (backward-char 1)
14810 (narrow-to-region (point) (point))
14811 (indent-to-column col))
14812 ;; Check if we have to remove something.
14813 (setq list (cons what remove))
14814 (while list
14815 (setq elt (pop list))
14816 (goto-char (point-min))
14817 (when (or (and (eq elt 'scheduled)
14818 (re-search-forward org-scheduled-time-regexp nil t))
14819 (and (eq elt 'deadline)
14820 (re-search-forward org-deadline-time-regexp nil t))
14821 (and (eq elt 'closed)
14822 (re-search-forward org-closed-time-regexp nil t)))
14823 (replace-match "")
14824 (if (looking-at "--+<[^>]+>") (replace-match ""))
14825 (if (looking-at " +") (replace-match ""))))
14826 (goto-char (point-max))
14827 (when what
14828 (insert
14829 (if (not (equal (char-before) ?\ )) " " "")
14830 (cond ((eq what 'scheduled) org-scheduled-string)
14831 ((eq what 'deadline) org-deadline-string)
14832 ((eq what 'closed) org-closed-string))
14833 " ")
14834 (setq ts (org-insert-time-stamp
14835 time
14836 (or org-time-was-given
14837 (and (eq what 'closed) org-log-done-with-time))
14838 (eq what 'closed)
14839 nil nil (list org-end-time-was-given)))
14840 (end-of-line 1))
14841 (goto-char (point-min))
14842 (widen)
14844 (replace-match ""))
14845 ts)))))
14847 (defvar org-log-note-marker (make-marker))
14848 (defvar org-log-note-purpose nil)
14849 (defvar org-log-note-state nil)
14850 (defvar org-log-note-window-configuration nil)
14851 (defvar org-log-note-return-to (make-marker))
14852 (defvar org-log-post-message nil
14853 "Message to be displayed after a log note has been stored.
14854 The auto-repeater uses this.")
14856 (defun org-add-log-maybe (&optional purpose state findpos)
14857 "Set up the post command hook to take a note."
14858 (save-excursion
14859 (when (and (listp org-log-done)
14860 (memq purpose org-log-done))
14861 (when findpos
14862 (org-back-to-heading t)
14866 (goto-char (match-end 0))
14867 (unless org-log-states-order-reversed
14869 (org-skip-over-state-notes)
14871 (move-marker org-log-note-marker (point))
14872 (setq org-log-note-purpose purpose)
14873 (setq org-log-note-state state)
14874 (add-hook 'post-command-hook 'org-add-log-note 'append))))
14876 (defun org-skip-over-state-notes ()
14877 "Skip past the list of State notes in an entry."
14880 (condition-case nil
14881 (org-next-item)
14882 (error (org-end-of-item)))))
14884 (defun org-add-log-note (&optional purpose)
14885 "Pop up a window for taking a note, and add this note later at point."
14886 (remove-hook 'post-command-hook 'org-add-log-note)
14887 (setq org-log-note-window-configuration (current-window-configuration))
14888 (delete-other-windows)
14889 (move-marker org-log-note-return-to (point))
14890 (switch-to-buffer (marker-buffer org-log-note-marker))
14891 (goto-char org-log-note-marker)
14892 (org-switch-to-buffer-other-window "*Org Note*")
14893 (erase-buffer)
14894 (let ((org-inhibit-startup t)) (org-mode))
14895 (insert (format "# Insert note for %s.
14897 (cond
14898 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14899 ((eq org-log-note-purpose 'done) "closed todo item")
14900 ((eq org-log-note-purpose 'state)
14902 (t (error "This should not happen")))))
14903 (org-set-local 'org-finish-function 'org-store-log-note))
14905 (defun org-store-log-note ()
14906 "Finish taking a log note, and insert it to where it belongs."
14907 (let ((txt (buffer-string))
14908 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14909 lines ind)
14910 (kill-buffer (current-buffer))
14912 (setq txt (replace-match "" t t txt)))
14914 (setq txt (replace-match "" t t txt)))
14917 (setq note
14918 (org-replace-escapes
14919 note
14920 (list (cons "%u" (user-login-name))
14921 (cons "%U" user-full-name)
14922 (cons "%t" (format-time-string
14923 (org-time-stamp-format 'long 'inactive)
14924 (current-time)))
14925 (cons "%s" (if org-log-note-state
14927 "")))))
14929 (push note lines))
14930 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14931 (when lines
14932 (save-excursion
14933 (set-buffer (marker-buffer org-log-note-marker))
14934 (save-excursion
14935 (goto-char org-log-note-marker)
14936 (move-marker org-log-note-marker nil)
14937 (end-of-line 1)
14939 (indent-relative nil)
14940 (insert "- " (pop lines))
14941 (org-indent-line-function)
14942 (beginning-of-line 1)
14944 (setq ind (concat (match-string 0) " "))
14945 (end-of-line 1)
14947 (set-window-configuration org-log-note-window-configuration)
14948 (with-current-buffer (marker-buffer org-log-note-return-to)
14949 (goto-char org-log-note-return-to))
14950 (move-marker org-log-note-return-to nil)
14951 (and org-log-post-message (message "%s" org-log-post-message)))
14953 ;; FIXME: what else would be useful?
14954 ;; - priority
14955 ;; - date
14957 (defun org-sparse-tree (&optional arg)
14958 "Create a sparse tree, prompt for the details.
14959 This command can create sparse trees. You first need to select the type
14960 of match used to create the tree:
14962 t Show entries with a specific TODO keyword.
14963 T Show entries selected by a tags match.
14964 p Enter a property name and its value (both with completion on existing
14965 names/values) and show entries with that property.
14966 r Show entries matching a regular expression
14967 d Show deadlines due within `org-deadline-warning-days'."
14968 (interactive "P")
14969 (let (ans kwd value)
14970 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
14971 (setq ans (read-char-exclusive))
14972 (cond
14973 ((equal ans ?d)
14974 (call-interactively 'org-check-deadlines))
14975 ((equal ans ?b)
14976 (call-interactively 'org-check-before-date))
14977 ((equal ans ?t)
14978 (org-show-todo-tree '(4)))
14979 ((equal ans ?T)
14980 (call-interactively 'org-tags-sparse-tree))
14981 ((member ans '(?p ?P))
14982 (setq kwd (completing-read "Property: "
14983 (mapcar 'list (org-buffer-property-keys))))
14984 (setq value (completing-read "Value: "
14985 (mapcar 'list (org-property-values kwd))))
14988 (org-tags-sparse-tree arg (concat kwd "=" value)))
14989 ((member ans '(?r ?R ?/))
14990 (call-interactively 'org-occur))
14993 (defvar org-occur-highlights nil)
14994 (make-variable-buffer-local 'org-occur-highlights)
14996 (defun org-occur (regexp &optional keep-previous callback)
14997 "Make a compact tree which shows all matches of REGEXP.
14998 The tree will show the lines where the regexp matches, and all higher
14999 headlines above the match. It will also show the heading after the match,
15000 to make sure editing the matching entry is easy.
15001 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15002 call to `org-occur' will be kept, to allow stacking of calls to this
15003 command.
15004 If CALLBACK is non-nil, it is a function which is called to confirm
15005 that the match should indeed be shown."
15007 (or keep-previous (org-remove-occur-highlights nil nil t))
15008 (let ((cnt 0))
15009 (save-excursion
15010 (goto-char (point-min))
15011 (if (or (not keep-previous) ; do not want to keep
15012 (not org-occur-highlights)) ; no previous matches
15013 ;; hide everything
15014 (org-overview))
15015 (while (re-search-forward regexp nil t)
15016 (when (or (not callback)
15017 (save-match-data (funcall callback)))
15018 (setq cnt (1+ cnt))
15019 (when org-highlight-sparse-tree-matches
15020 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15021 (org-show-context 'occur-tree))))
15022 (when org-remove-highlights-with-change
15023 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15024 nil 'local))
15025 (unless org-sparse-tree-open-archived-trees
15026 (org-hide-archived-subtrees (point-min) (point-max)))
15027 (run-hooks 'org-occur-hook)
15028 (if (interactive-p)
15029 (message "%d match(es) for regexp %s" cnt regexp))
15030 cnt))
15032 (defun org-show-context (&optional key)
15033 "Make sure point and context and visible.
15034 How much context is shown depends upon the variables
15035 `org-show-hierarchy-above', `org-show-following-heading'. and
15036 `org-show-siblings'."
15037 (let ((heading-p (org-on-heading-p t))
15038 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15039 (following-p (org-get-alist-option org-show-following-heading key))
15040 (entry-p (org-get-alist-option org-show-entry-below key))
15041 (siblings-p (org-get-alist-option org-show-siblings key)))
15042 (catch 'exit
15043 ;; Show heading or entry text
15044 (if (and heading-p (not entry-p))
15045 (org-flag-heading nil) ; only show the heading
15046 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15047 (org-show-hidden-entry))) ; show entire entry
15048 (when following-p
15049 ;; Show next sibling, or heading below text
15050 (save-excursion
15051 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15052 (org-flag-heading nil))))
15053 (when siblings-p (org-show-siblings))
15054 (when hierarchy-p
15055 ;; show all higher headings, possibly with siblings
15056 (save-excursion
15057 (while (and (condition-case nil
15058 (progn (org-up-heading-all 1) t)
15059 (error nil))
15060 (not (bobp)))
15061 (org-flag-heading nil)
15062 (when siblings-p (org-show-siblings))))))))
15064 (defun org-reveal (&optional siblings)
15065 "Show current entry, hierarchy above it, and the following headline.
15066 This can be used to show a consistent set of context around locations
15067 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15068 not t for the search context.
15070 With optional argument SIBLINGS, on each level of the hierarchy all
15071 siblings are shown. This repairs the tree structure to what it would
15072 look like when opened with hierarchical calls to `org-cycle'."
15073 (interactive "P")
15074 (let ((org-show-hierarchy-above t)
15075 (org-show-following-heading t)
15076 (org-show-siblings (if siblings t org-show-siblings)))
15077 (org-show-context nil)))
15079 (defun org-highlight-new-match (beg end)
15080 "Highlight from BEG to END and mark the highlight is an occur headline."
15081 (let ((ov (org-make-overlay beg end)))
15082 (org-overlay-put ov 'face 'secondary-selection)
15083 (push ov org-occur-highlights)))
15085 (defun org-remove-occur-highlights (&optional beg end noremove)
15086 "Remove the occur highlights from the buffer.
15087 BEG and END are ignored. If NOREMOVE is nil, remove this function
15088 from the `before-change-functions' in the current buffer."
15089 (interactive)
15090 (unless org-inhibit-highlight-removal
15091 (mapc 'org-delete-overlay org-occur-highlights)
15092 (setq org-occur-highlights nil)
15093 (unless noremove
15094 (remove-hook 'before-change-functions
15095 'org-remove-occur-highlights 'local))))
15097 ;;;; Priorities
15100 "Regular expression matching the priority indicator.")
15102 (defvar org-remove-priority-next-time nil)
15104 (defun org-priority-up ()
15105 "Increase the priority of the current item."
15106 (interactive)
15107 (org-priority 'up))
15109 (defun org-priority-down ()
15110 "Decrease the priority of the current item."
15111 (interactive)
15112 (org-priority 'down))
15114 (defun org-priority (&optional action)
15115 "Change the priority of an item by ARG.
15116 ACTION can be `set', `up', `down', or a character."
15117 (interactive)
15118 (setq action (or action 'set))
15119 (let (current new news have remove)
15120 (save-excursion
15121 (org-back-to-heading)
15122 (if (looking-at org-priority-regexp)
15123 (setq current (string-to-char (match-string 2))
15124 have t)
15125 (setq current org-default-priority))
15126 (cond
15127 ((or (eq action 'set) (integerp action))
15128 (if (integerp action)
15129 (setq new action)
15130 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15131 (setq new (read-char-exclusive)))
15132 (if (and (= (upcase org-highest-priority) org-highest-priority)
15133 (= (upcase org-lowest-priority) org-lowest-priority))
15134 (setq new (upcase new)))
15135 (cond ((equal new ?\ ) (setq remove t))
15136 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15137 (error "Priority must be between `%c' and `%c'"
15138 org-highest-priority org-lowest-priority))))
15139 ((eq action 'up)
15140 (if (and (not have) (eq last-command this-command))
15141 (setq new org-lowest-priority)
15142 (setq new (if (and org-priority-start-cycle-with-default (not have))
15143 org-default-priority (1- current)))))
15144 ((eq action 'down)
15145 (if (and (not have) (eq last-command this-command))
15146 (setq new org-highest-priority)
15147 (setq new (if (and org-priority-start-cycle-with-default (not have))
15148 org-default-priority (1+ current)))))
15149 (t (error "Invalid action")))
15150 (if (or (< (upcase new) org-highest-priority)
15151 (> (upcase new) org-lowest-priority))
15152 (setq remove t))
15153 (setq news (format "%c" new))
15154 (if have
15155 (if remove
15156 (replace-match "" t t nil 1)
15157 (replace-match news t t nil 2))
15158 (if remove
15159 (error "No priority cookie found in line")
15160 (looking-at org-todo-line-regexp)
15161 (if (match-end 2)
15162 (progn
15163 (goto-char (match-end 2))
15164 (insert " [#" news "]"))
15165 (goto-char (match-beginning 3))
15166 (insert "[#" news "] ")))))
15167 (org-preserve-lc (org-set-tags nil 'align))
15168 (if remove
15169 (message "Priority removed")
15170 (message "Priority of current item set to %s" news))))
15173 (defun org-get-priority (s)
15174 "Find priority cookie and return priority."
15175 (save-match-data
15176 (if (not (string-match org-priority-regexp s))
15177 (* 1000 (- org-lowest-priority org-default-priority))
15178 (* 1000 (- org-lowest-priority
15179 (string-to-char (match-string 2 s)))))))
15181 ;;;; Tags
15183 (defun org-scan-tags (action matcher &optional todo-only)
15184 "Scan headline tags with inheritance and produce output ACTION.
15185 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15186 evaluated, testing if a given set of tags qualifies a headline for
15187 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15188 are included in the output."
15191 (org-re
15193 (props (list 'face nil
15194 'done-face 'org-done
15195 'undone-face nil
15196 'mouse-face 'highlight
15197 'org-not-done-regexp org-not-done-regexp
15198 'org-todo-regexp org-todo-regexp
15199 'keymap org-agenda-keymap
15200 'help-echo
15201 (format "mouse-2 or RET jump to org file %s"
15202 (abbreviate-file-name
15203 (or (buffer-file-name (buffer-base-buffer))
15204 (buffer-name (buffer-base-buffer)))))))
15205 (case-fold-search nil)
15206 lspos
15207 tags tags-list tags-alist (llast 0) rtn level category i txt
15208 todo marker entry priority)
15209 (save-excursion
15210 (goto-char (point-min))
15211 (when (eq action 'sparse-tree)
15212 (org-overview)
15213 (org-remove-occur-highlights))
15214 (while (re-search-forward re nil t)
15215 (catch :skip
15216 (setq todo (if (match-end 1) (match-string 2))
15217 tags (if (match-end 4) (match-string 4)))
15218 (goto-char (setq lspos (1+ (match-beginning 0))))
15219 (setq level (org-reduced-level (funcall outline-level))
15220 category (org-get-category))
15221 (setq i llast llast level)
15222 ;; remove tag lists from same and sublevels
15223 (while (>= i level)
15224 (when (setq entry (assoc i tags-alist))
15225 (setq tags-alist (delete entry tags-alist)))
15226 (setq i (1- i)))
15227 ;; add the nex tags
15228 (when tags
15229 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15230 tags-alist
15231 (cons (cons level tags) tags-alist)))
15232 ;; compile tags for current headline
15233 (setq tags-list
15234 (if org-use-tag-inheritance
15235 (apply 'append (mapcar 'cdr tags-alist))
15236 tags))
15237 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15238 (eval matcher)
15239 (or (not org-agenda-skip-archived-trees)
15240 (not (member org-archive-tag tags-list))))
15241 (and (eq action 'agenda) (org-agenda-skip))
15242 ;; list this headline
15244 (if (eq action 'sparse-tree)
15245 (progn
15246 (and org-highlight-sparse-tree-matches
15247 (org-get-heading) (match-end 0)
15248 (org-highlight-new-match
15249 (match-beginning 0) (match-beginning 1)))
15250 (org-show-context 'tags-tree))
15251 (setq txt (org-format-agenda-item
15252 ""
15253 (concat
15254 (if org-tags-match-list-sublevels
15255 (make-string (1- level) ?.) "")
15256 (org-get-heading))
15257 category tags-list)
15258 priority (org-get-priority txt))
15259 (goto-char lspos)
15260 (setq marker (org-agenda-new-marker))
15261 (org-add-props txt props
15262 'org-marker marker 'org-hd-marker marker 'org-category category
15263 'priority priority 'type "tagsmatch")
15264 (push txt rtn))
15265 ;; if we are to skip sublevels, jump to end of subtree
15266 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15267 (when (and (eq action 'sparse-tree)
15268 (not org-sparse-tree-open-archived-trees))
15269 (org-hide-archived-subtrees (point-min) (point-max)))
15270 (nreverse rtn)))
15272 (defvar todo-only) ;; dynamically scoped
15274 (defun org-tags-sparse-tree (&optional todo-only match)
15275 "Create a sparse tree according to tags string MATCH.
15276 MATCH can contain positive and negative selection of tags, like
15278 If optional argument TODO_ONLY is non-nil, only select lines that are
15279 also TODO lines."
15280 (interactive "P")
15281 (org-prepare-agenda-buffers (list (current-buffer)))
15282 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15284 (defvar org-cached-props nil)
15285 (defun org-cached-entry-get (pom property)
15286 (if (or (eq t org-use-property-inheritance)
15287 (member property org-use-property-inheritance))
15288 ;; Caching is not possible, check it directly
15289 (org-entry-get pom property 'inherit)
15290 ;; Get all properties, so that we can do complicated checks easily
15291 (cdr (assoc property (or org-cached-props
15292 (setq org-cached-props
15293 (org-entry-properties pom)))))))
15295 (defun org-global-tags-completion-table (&optional files)
15296 "Return the list of all tags in all agenda buffer/files."
15297 (save-excursion
15298 (org-uniquify
15299 (delq nil
15300 (apply 'append
15301 (mapcar
15302 (lambda (file)
15303 (set-buffer (find-file-noselect file))
15304 (append (org-get-buffer-tags)
15305 (mapcar (lambda (x) (if (stringp (car-safe x))
15306 (list (car-safe x)) nil))
15307 org-tag-alist)))
15308 (if (and files (car files))
15309 files
15310 (org-agenda-files))))))))
15312 (defun org-make-tags-matcher (match)
15313 "Create the TAGS//TODO matcher form for the selection string MATCH."
15314 ;; todo-only is scoped dynamically into this function, and the function
15315 ;; may change it it the matcher asksk for it.
15316 (unless match
15317 ;; Get a new match request, with completion
15318 (let ((org-last-tags-completion-table
15319 (org-global-tags-completion-table)))
15320 (setq match (completing-read
15321 "Match: " 'org-tags-completion-function nil nil nil
15322 'org-tags-history))))
15324 ;; Parse the string and create a lisp form
15325 (let ((match0 match)
15326 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
15327 minus tag mm
15328 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15329 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15330 (if (string-match "/+" match)
15331 ;; match contains also a todo-matching request
15332 (progn
15333 (setq tagsmatch (substring match 0 (match-beginning 0))
15334 todomatch (substring match (match-end 0)))
15335 (if (string-match "^!" todomatch)
15336 (setq todo-only t todomatch (substring todomatch 1)))
15338 (setq todomatch nil)))
15339 ;; only matching tags
15340 (setq tagsmatch match todomatch nil))
15342 ;; Make the tags matcher
15344 (setq tagsmatcher t)
15345 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15346 (while (setq term (pop orterms))
15348 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15349 (while (string-match re term)
15350 (setq minus (and (match-end 1)
15351 (equal (match-string 1 term) "-"))
15352 tag (match-string 2 term)
15353 re-p (equal (string-to-char tag) ?{)
15354 level-p (match-end 3)
15355 prop-p (match-end 4)
15356 mm (cond
15357 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15358 (level-p `(= level ,(string-to-number
15359 (match-string 3 term))))
15360 (prop-p
15361 (setq pn (match-string 4 term)
15362 pv (match-string 5 term)
15363 cat-p (equal pn "CATEGORY")
15364 re-p (equal (string-to-char pv) ?{)
15365 pv (substring pv 1 -1))
15366 (if (equal pn "CATEGORY")
15367 (setq gv '(get-text-property (point) 'org-category))
15368 (setq gv `(org-cached-entry-get nil ,pn)))
15369 (if re-p
15370 `(string-match ,pv (or ,gv ""))
15371 `(equal ,pv ,gv)))
15372 (t `(member ,(downcase tag) tags-list)))
15373 mm (if minus (list 'not mm) mm)
15374 term (substring term (match-end 0)))
15375 (push mm tagsmatcher))
15376 (push (if (> (length tagsmatcher) 1)
15377 (cons 'and tagsmatcher)
15378 (car tagsmatcher))
15379 orlist)
15380 (setq tagsmatcher nil))
15381 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15382 (setq tagsmatcher
15383 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15385 ;; Make the todo matcher
15387 (setq todomatcher t)
15388 (setq orterms (org-split-string todomatch "|") orlist nil)
15389 (while (setq term (pop orterms))
15390 (while (string-match re term)
15391 (setq minus (and (match-end 1)
15392 (equal (match-string 1 term) "-"))
15393 kwd (match-string 2 term)
15394 re-p (equal (string-to-char kwd) ?{)
15395 term (substring term (match-end 0))
15396 mm (if re-p
15397 `(string-match ,(substring kwd 1 -1) todo)
15398 (list 'equal 'todo kwd))
15399 mm (if minus (list 'not mm) mm))
15400 (push mm todomatcher))
15401 (push (if (> (length todomatcher) 1)
15402 (cons 'and todomatcher)
15403 (car todomatcher))
15404 orlist)
15405 (setq todomatcher nil))
15406 (setq todomatcher (if (> (length orlist) 1)
15407 (cons 'or orlist) (car orlist))))
15409 ;; Return the string and lisp forms of the matcher
15410 (setq matcher (if todomatcher
15411 (list 'and tagsmatcher todomatcher)
15412 tagsmatcher))
15413 (cons match0 matcher)))
15415 (defun org-match-any-p (re list)
15416 "Does re match any element of list?"
15417 (setq list (mapcar (lambda (x) (string-match re x)) list))
15418 (delq nil list))
15420 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15421 (defvar org-tags-overlay (org-make-overlay 1 1))
15422 (org-detach-overlay org-tags-overlay)
15424 (defun org-align-tags-here (to-col)
15425 ;; Assumes that this is a headline
15426 (let ((pos (point)) (col (current-column)) tags)
15427 (beginning-of-line 1)
15429 (< pos (match-beginning 2)))
15430 (progn
15431 (setq tags (match-string 2))
15432 (goto-char (match-beginning 1))
15433 (insert " ")
15434 (delete-region (point) (1+ (match-end 0)))
15435 (backward-char 1)
15436 (move-to-column
15437 (max (1+ (current-column))
15438 (1+ col)
15439 (if (> to-col 0)
15440 to-col
15441 (- (abs to-col) (length tags))))
15442 t)
15443 (insert tags)
15444 (move-to-column (min (current-column) col) t))
15445 (goto-char pos))))
15447 (defun org-set-tags (&optional arg just-align)
15448 "Set the tags for the current headline.
15449 With prefix ARG, realign all tags in headings in the current buffer."
15450 (interactive "P")
15451 (let* ((re (concat "^" outline-regexp))
15452 (current (org-get-tags-string))
15453 (col (current-column))
15454 (org-setting-tags t)
15455 table current-tags inherited-tags ; computed below when needed
15456 tags p0 c0 c1 rpl)
15457 (if arg
15458 (save-excursion
15459 (goto-char (point-min))
15460 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15461 (while (re-search-forward re nil t)
15462 (org-set-tags nil t)
15463 (end-of-line 1)))
15464 (message "All tags realigned to column %d" org-tags-column))
15465 (if just-align
15466 (setq tags current)
15467 ;; Get a new set of tags from the user
15468 (save-excursion
15469 (setq table (or org-tag-alist (org-get-buffer-tags))
15470 org-last-tags-completion-table table
15471 current-tags (org-split-string current ":")
15472 inherited-tags (nreverse
15473 (nthcdr (length current-tags)
15474 (nreverse (org-get-tags-at))))
15475 tags
15476 (if (or (eq t org-use-fast-tag-selection)
15477 (and org-use-fast-tag-selection
15478 (delq nil (mapcar 'cdr table))))
15479 (org-fast-tag-selection
15480 current-tags inherited-tags table
15481 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15482 (let ((org-add-colon-after-tag-completion t))
15483 (org-trim
15484 (org-without-partial-completion
15485 (completing-read "Tags: " 'org-tags-completion-function
15486 nil nil current 'org-tags-history)))))))
15487 (while (string-match "[-+&]+" tags)
15488 ;; No boolean logic, just a list
15489 (setq tags (replace-match ":" t t tags))))
15492 (setq tags "")
15493 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15494 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15496 ;; Insert new tags at the correct column
15497 (beginning-of-line 1)
15498 (cond
15499 ((and (equal current "") (equal tags "")))
15500 ((re-search-forward
15502 (point-at-eol) t)
15503 (if (equal tags "")
15504 (setq rpl "")
15505 (goto-char (match-beginning 0))
15506 (setq c0 (current-column) p0 (point)
15507 c1 (max (1+ c0) (if (> org-tags-column 0)
15508 org-tags-column
15509 (- (- org-tags-column) (length tags))))
15510 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15511 (replace-match rpl t t)
15512 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15513 tags)
15514 (t (error "Tags alignment failed")))
15515 (move-to-column col)
15516 (unless just-align
15517 (run-hooks 'org-after-tags-change-hook)))))
15519 (defun org-change-tag-in-region (beg end tag off)
15520 "Add or remove TAG for each entry in the region.
15521 This works in the agenda, and also in an org-mode buffer."
15522 (interactive
15523 (list (region-beginning) (region-end)
15524 (let ((org-last-tags-completion-table
15525 (if (org-mode-p)
15526 (org-get-buffer-tags)
15527 (org-global-tags-completion-table))))
15528 (completing-read
15529 "Tag: " 'org-tags-completion-function nil nil nil
15530 'org-tags-history))
15531 (progn
15532 (message "[s]et or [r]emove? ")
15533 (equal (read-char-exclusive) ?r))))
15534 (if (fboundp 'deactivate-mark) (deactivate-mark))
15535 (let ((agendap (equal major-mode 'org-agenda-mode))
15536 l1 l2 m buf pos newhead (cnt 0))
15537 (goto-char end)
15538 (setq l2 (1- (org-current-line)))
15539 (goto-char beg)
15540 (setq l1 (org-current-line))
15541 (loop for l from l1 to l2 do
15542 (goto-line l)
15543 (setq m (get-text-property (point) 'org-hd-marker))
15544 (when (or (and (org-mode-p) (org-on-heading-p))
15545 (and agendap m))
15546 (setq buf (if agendap (marker-buffer m) (current-buffer))
15547 pos (if agendap m (point)))
15548 (with-current-buffer buf
15549 (save-excursion
15550 (save-restriction
15551 (goto-char pos)
15552 (setq cnt (1+ cnt))
15553 (org-toggle-tag tag (if off 'off 'on))
15554 (setq newhead (org-get-heading)))))
15555 (and agendap (org-agenda-change-all-lines newhead m))))
15556 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15558 (defun org-tags-completion-function (string predicate &optional flag)
15559 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15560 (confirm (lambda (x) (stringp (car x)))))
15562 (setq s1 (match-string 1 string)
15563 s2 (match-string 2 string))
15564 (setq s1 "" s2 string))
15565 (cond
15566 ((eq flag nil)
15567 ;; try completion
15568 (setq rtn (try-completion s2 ctable confirm))
15569 (if (stringp rtn)
15570 (setq rtn
15571 (concat s1 s2 (substring rtn (length s2))
15572 (if (and org-add-colon-after-tag-completion
15573 (assoc rtn ctable))
15574 ":" ""))))
15575 rtn)
15576 ((eq flag t)
15577 ;; all-completions
15578 (all-completions s2 ctable confirm)
15579 )
15580 ((eq flag 'lambda)
15581 ;; exact match?
15582 (assoc s2 ctable)))
15583 ))
15585 (defun org-fast-tag-insert (kwd tags face &optional end)
15586 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15587 (insert (format "%-12s" (concat kwd ":"))
15588 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15589 (or end "")))
15591 (defun org-fast-tag-show-exit (flag)
15592 (save-excursion
15593 (goto-line 3)
15595 (replace-match ""))
15596 (when flag
15597 (end-of-line 1)
15598 (move-to-column (- (window-width) 19) t)
15599 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15601 (defun org-set-current-tags-overlay (current prefix)
15602 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15603 (if (featurep 'xemacs)
15604 (org-overlay-display org-tags-overlay (concat prefix s)
15605 'secondary-selection)
15606 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15607 (org-overlay-display org-tags-overlay (concat prefix s)))))
15609 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15610 "Fast tag selection with single keys.
15611 CURRENT is the current list of tags in the headline, INHERITED is the
15612 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15613 possibly with grouping information. TODO-TABLE is a similar table with
15614 TODO keywords, should these have keys assigned to them.
15615 If the keys are nil, a-z are automatically assigned.
15616 Returns the new tags string, or nil to not change the current settings."
15617 (let* ((fulltable (append table todo-table))
15618 (maxlen (apply 'max (mapcar
15619 (lambda (x)
15620 (if (stringp (car x)) (string-width (car x)) 0))
15621 fulltable)))
15622 (buf (current-buffer))
15623 (expert (eq org-fast-tag-selection-single-key 'expert))
15624 (buffer-tags nil)
15625 (fwidth (+ maxlen 3 1 3))
15626 (ncol (/ (- (window-width) 4) fwidth))
15627 (i-face 'org-done)
15628 (c-face 'org-todo)
15629 tg cnt e c char c1 c2 ntable tbl rtn
15630 ov-start ov-end ov-prefix
15631 (exit-after-next org-fast-tag-selection-single-key)
15632 (done-keywords org-done-keywords)
15633 groups ingroup)
15634 (save-excursion
15635 (beginning-of-line 1)
15636 (if (looking-at
15638 (setq ov-start (match-beginning 1)
15639 ov-end (match-end 1)
15640 ov-prefix "")
15641 (setq ov-start (1- (point-at-eol))
15642 ov-end (1+ ov-start))
15644 (setq ov-prefix
15645 (concat
15646 (buffer-substring (1- (point)) (point))
15647 (if (> (current-column) org-tags-column)
15648 " "
15649 (make-string (- org-tags-column (current-column)) ?\ ))))))
15650 (org-move-overlay org-tags-overlay ov-start ov-end)
15651 (save-window-excursion
15652 (if expert
15653 (set-buffer (get-buffer-create " *Org tags*"))
15654 (delete-other-windows)
15655 (split-window-vertically)
15656 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15657 (erase-buffer)
15658 (org-set-local 'org-done-keywords done-keywords)
15661 (org-fast-tag-show-exit exit-after-next)
15662 (org-set-current-tags-overlay current ov-prefix)
15663 (setq tbl fulltable char ?a cnt 0)
15664 (while (setq e (pop tbl))
15665 (cond
15666 ((equal e '(:startgroup))
15667 (push '() groups) (setq ingroup t)
15668 (when (not (= cnt 0))
15669 (setq cnt 0)
15671 (insert "{ "))
15672 ((equal e '(:endgroup))
15673 (setq ingroup nil cnt 0)
15675 (t
15676 (setq tg (car e) c2 nil)
15677 (if (cdr e)
15678 (setq c (cdr e))
15679 ;; automatically assign a character.
15680 (setq c1 (string-to-char
15681 (downcase (substring
15682 tg (if (= (string-to-char tg) ?@) 1 0)))))
15683 (if (or (rassoc c1 ntable) (rassoc c1 table))
15684 (while (or (rassoc char ntable) (rassoc char table))
15685 (setq char (1+ char)))
15686 (setq c2 c1))
15687 (setq c (or c2 char)))
15688 (if ingroup (push tg (car groups)))
15689 (setq tg (org-add-props tg nil 'face
15690 (cond
15691 ((not (assoc tg table))
15692 (org-get-todo-face tg))
15693 ((member tg current) c-face)
15694 ((member tg inherited) i-face)
15695 (t nil))))
15696 (if (and (= cnt 0) (not ingroup)) (insert " "))
15697 (insert "[" c "] " tg (make-string
15698 (- fwidth 4 (length tg)) ?\ ))
15699 (push (cons tg c) ntable)
15700 (when (= (setq cnt (1+ cnt)) ncol)
15702 (if ingroup (insert " "))
15703 (setq cnt 0)))))
15704 (setq ntable (nreverse ntable))
15706 (goto-char (point-min))
15707 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15708 (fit-window-to-buffer))
15709 (setq rtn
15710 (catch 'exit
15711 (while t
15712 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15713 (if groups " [!] no groups" " [!]groups")
15714 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15715 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15716 (cond
15718 ((= c ?!)
15719 (setq groups (not groups))
15720 (goto-char (point-min))
15721 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15722 ((= c ?\C-c)
15723 (if (not expert)
15724 (org-fast-tag-show-exit
15725 (setq exit-after-next (not exit-after-next)))
15726 (setq expert nil)
15727 (delete-other-windows)
15728 (split-window-vertically)
15729 (org-switch-to-buffer-other-window " *Org tags*")
15730 (and (fboundp 'fit-window-to-buffer)
15731 (fit-window-to-buffer))))
15732 ((or (= c ?\C-g)
15733 (and (= c ?q) (not (rassoc c ntable))))
15734 (org-detach-overlay org-tags-overlay)
15735 (setq quit-flag t))
15736 ((= c ?\ )
15737 (setq current nil)
15738 (if exit-after-next (setq exit-after-next 'now)))
15740 (condition-case nil
15741 (setq tg (completing-read
15742 "Tag: "
15743 (or buffer-tags
15744 (with-current-buffer buf
15745 (org-get-buffer-tags)))))
15746 (quit (setq tg "")))
15748 (add-to-list 'buffer-tags (list tg))
15749 (if (member tg current)
15750 (setq current (delete tg current))
15751 (push tg current)))
15752 (if exit-after-next (setq exit-after-next 'now)))
15753 ((setq e (rassoc c todo-table) tg (car e))
15754 (with-current-buffer buf
15755 (save-excursion (org-todo tg)))
15756 (if exit-after-next (setq exit-after-next 'now)))
15757 ((setq e (rassoc c ntable) tg (car e))
15758 (if (member tg current)
15759 (setq current (delete tg current))
15760 (loop for g in groups do
15761 (if (member tg g)
15762 (mapc (lambda (x)
15763 (setq current (delete x current)))
15764 g)))
15765 (push tg current))
15766 (if exit-after-next (setq exit-after-next 'now))))
15768 ;; Create a sorted list
15769 (setq current
15770 (sort current
15771 (lambda (a b)
15772 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15773 (if (eq exit-after-next 'now) (throw 'exit t))
15774 (goto-char (point-min))
15775 (beginning-of-line 2)
15776 (delete-region (point) (point-at-eol))
15777 (org-fast-tag-insert "Current" current c-face)
15778 (org-set-current-tags-overlay current ov-prefix)
15779 (while (re-search-forward
15781 (setq tg (match-string 1))
15782 (add-text-properties
15783 (match-beginning 1) (match-end 1)
15784 (list 'face
15785 (cond
15786 ((member tg current) c-face)
15787 ((member tg inherited) i-face)
15788 (t (get-text-property (match-beginning 1) 'face))))))
15789 (goto-char (point-min)))))
15790 (org-detach-overlay org-tags-overlay)
15791 (if rtn
15792 (mapconcat 'identity current ":")
15793 nil))))
15795 (defun org-get-tags-string ()
15796 "Get the TAGS string in the current headline."
15797 (unless (org-on-heading-p t)
15798 (error "Not on a heading"))
15799 (save-excursion
15800 (beginning-of-line 1)
15802 (org-match-string-no-properties 1)
15803 "")))
15805 (defun org-get-tags ()
15806 "Get the list of tags specified in the current headline."
15807 (org-split-string (org-get-tags-string) ":"))
15809 (defun org-get-buffer-tags ()
15810 "Get a table of all tags used in the buffer, for completion."
15811 (let (tags)
15812 (save-excursion
15813 (goto-char (point-min))
15814 (while (re-search-forward
15816 (when (equal (char-after (point-at-bol 0)) ?*)
15817 (mapc (lambda (x) (add-to-list 'tags x))
15818 (org-split-string (org-match-string-no-properties 1) ":")))))
15819 (mapcar 'list tags)))
15822 ;;;; Properties
15824 ;;; Setting and retrieving properties
15826 (defconst org-special-properties
15827 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15828 "TIMESTAMP" "TIMESTAMP_IA")
15829 "The special properties valid in Org-mode.
15831 These are properties that are not defined in the property drawer,
15832 but in some other way.")
15834 (defconst org-default-properties
15835 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15836 "LOCATION" "LOGGING" "COLUMNS")
15837 "Some properties that are used by Org-mode for various purposes.
15838 Being in this list makes sure that they are offered for completion.")
15841 "Regular expression matching the first line of a property drawer.")
15844 "Regular expression matching the first line of a property drawer.")
15846 (defun org-property-action ()
15847 "Do an action on properties."
15848 (interactive)
15849 (let (c)
15850 (org-at-property-p)
15851 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15852 (setq c (read-char-exclusive))
15853 (cond
15854 ((equal c ?s)
15855 (call-interactively 'org-set-property))
15856 ((equal c ?d)
15857 (call-interactively 'org-delete-property))
15858 ((equal c ?D)
15859 (call-interactively 'org-delete-property-globally))
15860 ((equal c ?c)
15861 (call-interactively 'org-compute-property-at-point))
15862 (t (error "No such property action %c" c)))))
15864 (defun org-at-property-p ()
15865 "Is the cursor in a property line?"
15866 ;; FIXME: Does not check if we are actually in the drawer.
15867 ;; FIXME: also returns true on any drawers.....
15868 ;; This is used by C-c C-c for property action.
15869 (save-excursion
15870 (beginning-of-line 1)
15873 (defmacro org-with-point-at (pom &rest body)
15874 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15875 (declare (indent 1) (debug t))
15876 `(save-excursion
15877 (if (markerp pom) (set-buffer (marker-buffer pom)))
15878 (save-excursion
15879 (goto-char (or pom (point)))
15880 ,@body)))
15882 (defun org-get-property-block (&optional beg end force)
15883 "Return the (beg . end) range of the body of the property drawer.
15884 BEG and END can be beginning and end of subtree, if not given
15885 they will be found.
15886 If the drawer does not exist and FORCE is non-nil, create the drawer."
15887 (catch 'exit
15888 (save-excursion
15889 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15890 (end (or end (progn (outline-next-heading) (point)))))
15891 (goto-char beg)
15892 (if (re-search-forward org-property-start-re end t)
15893 (setq beg (1+ (match-end 0)))
15894 (if force
15895 (save-excursion
15896 (org-insert-property-drawer)
15897 (setq end (progn (outline-next-heading) (point))))
15898 (throw 'exit nil))
15899 (goto-char beg)
15900 (if (re-search-forward org-property-start-re end t)
15901 (setq beg (1+ (match-end 0)))))
15902 (if (re-search-forward org-property-end-re end t)
15903 (setq end (match-beginning 0))
15904 (or force (throw 'exit nil))
15905 (goto-char beg)
15906 (setq end beg)
15907 (org-indent-line-function)
15909 (cons beg end)))))
15911 (defun org-entry-properties (&optional pom which)
15912 "Get all properties of the entry at point-or-marker POM.
15913 This includes the TODO keyword, the tags, time strings for deadline,
15914 scheduled, and clocking, and any additional properties defined in the
15915 entry. The return value is an alist, keys may occur multiple times
15916 if the property key was used several times.
15917 POM may also be nil, in which case the current entry is used.
15918 If WHICH is nil or `all', get all properties. If WHICH is
15919 `special' or `standard', only get that subclass."
15920 (setq which (or which 'all))
15921 (org-with-point-at pom
15922 (let ((clockstr (substring org-clock-string 0 -1))
15923 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15924 beg end range props sum-props key value string clocksum)
15925 (save-excursion
15926 (when (condition-case nil (org-back-to-heading t) (error nil))
15927 (setq beg (point))
15928 (setq sum-props (get-text-property (point) 'org-summaries))
15929 (setq clocksum (get-text-property (point) :org-clock-minutes))
15930 (outline-next-heading)
15931 (setq end (point))
15932 (when (memq which '(all special))
15933 ;; Get the special properties, like TODO and tags
15934 (goto-char beg)
15935 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15936 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15937 (when (looking-at org-priority-regexp)
15938 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15939 (when (and (setq value (org-get-tags-string))
15941 (push (cons "TAGS" value) props))
15942 (when (setq value (org-get-tags-at))
15943 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15944 props))
15945 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15946 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15947 string (if (equal key clockstr)
15948 (org-no-properties
15949 (org-trim
15950 (buffer-substring
15951 (match-beginning 3) (goto-char (point-at-eol)))))
15952 (substring (org-match-string-no-properties 3) 1 -1)))
15953 (unless key
15954 (if (= (char-after (match-beginning 3)) ?\[)
15955 (setq key "TIMESTAMP_IA")
15956 (setq key "TIMESTAMP")))
15957 (when (or (equal key clockstr) (not (assoc key props)))
15958 (push (cons key string) props)))
15960 )
15962 (when (memq which '(all standard))
15963 ;; Get the standard properties, like :PORP: ...
15964 (setq range (org-get-property-block beg end))
15965 (when range
15966 (goto-char (car range))
15967 (while (re-search-forward
15969 (cdr range) t)
15970 (setq key (org-match-string-no-properties 1)
15971 value (org-trim (or (org-match-string-no-properties 2) "")))
15972 (unless (member key excluded)
15973 (push (cons key (or value "")) props)))))
15974 (if clocksum
15975 (push (cons "CLOCKSUM"
15976 (org-column-number-to-string (/ (float clocksum) 60.)
15977 'add_times))
15978 props))
15979 (append sum-props (nreverse props)))))))
15981 (defun org-entry-get (pom property &optional inherit)
15982 "Get value of PROPERTY for entry at point-or-marker POM.
15983 If INHERIT is non-nil and the entry does not have the property,
15984 then also check higher levels of the hierarchy.
15985 If the property is present but empty, the return value is the empty string.
15986 If the property is not present at all, nil is returned."
15987 (org-with-point-at pom
15988 (if inherit
15989 (org-entry-get-with-inheritance property)
15990 (if (member property org-special-properties)
15991 ;; We need a special property. Use brute force, get all properties.
15992 (cdr (assoc property (org-entry-properties nil 'special)))
15993 (let ((range (org-get-property-block)))
15994 (if (and range
15995 (goto-char (car range))
15996 (re-search-forward
15998 (cdr range) t))
15999 ;; Found the property, return it.
16000 (if (match-end 1)
16001 (org-match-string-no-properties 1)
16002 "")))))))
16004 (defun org-entry-delete (pom property)
16005 "Delete the property PROPERTY from entry at point-or-marker POM."
16006 (org-with-point-at pom
16007 (if (member property org-special-properties)
16008 nil ; cannot delete these properties.
16009 (let ((range (org-get-property-block)))
16010 (if (and range
16011 (goto-char (car range))
16012 (re-search-forward
16014 (cdr range) t))
16015 (progn
16016 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16017 t)
16018 nil)))))
16020 ;; Multi-values properties are properties that contain multiple values
16021 ;; These values are assumed to be single words, separated by whitespace.
16022 (defun org-entry-add-to-multivalued-property (pom property value)
16023 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16024 (let* ((old (org-entry-get pom property))
16026 (unless (member value values)
16027 (setq values (cons value values))
16028 (org-entry-put pom property
16029 (mapconcat 'identity values " ")))))
16031 (defun org-entry-remove-from-multivalued-property (pom property value)
16032 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16033 (let* ((old (org-entry-get pom property))
16035 (when (member value values)
16036 (setq values (delete value values))
16037 (org-entry-put pom property
16038 (mapconcat 'identity values " ")))))
16040 (defun org-entry-member-in-multivalued-property (pom property value)
16041 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16042 (let* ((old (org-entry-get pom property))
16044 (member value values)))
16046 (defvar org-entry-property-inherited-from (make-marker))
16048 (defun org-entry-get-with-inheritance (property)
16049 "Get entry property, and search higher levels if not present."
16050 (let (tmp)
16051 (save-excursion
16052 (save-restriction
16053 (widen)
16054 (catch 'ex
16055 (while t
16056 (when (setq tmp (org-entry-get nil property))
16057 (org-back-to-heading t)
16058 (move-marker org-entry-property-inherited-from (point))
16059 (throw 'ex tmp))
16060 (or (org-up-heading-safe) (throw 'ex nil)))))
16061 (or tmp (cdr (assoc property org-local-properties))
16062 (cdr (assoc property org-global-properties))))))
16064 (defun org-entry-put (pom property value)
16065 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16066 (org-with-point-at pom
16067 (org-back-to-heading t)
16068 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16069 range)
16070 (cond
16071 ((equal property "TODO")
16073 (not (member value org-todo-keywords-1)))
16075 (if (or (not value)
16077 (setq value 'none))
16078 (org-todo value)
16079 (org-set-tags nil 'align))
16080 ((equal property "PRIORITY")
16082 (string-to-char value) ?\ ))
16083 (org-set-tags nil 'align))
16084 ((equal property "SCHEDULED")
16085 (if (re-search-forward org-scheduled-time-regexp end t)
16086 (cond
16087 ((eq value 'earlier) (org-timestamp-change -1 'day))
16088 ((eq value 'later) (org-timestamp-change 1 'day))
16089 (t (call-interactively 'org-schedule)))
16090 (call-interactively 'org-schedule)))
16091 ((equal property "DEADLINE")
16092 (if (re-search-forward org-deadline-time-regexp end t)
16093 (cond
16094 ((eq value 'earlier) (org-timestamp-change -1 'day))
16095 ((eq value 'later) (org-timestamp-change 1 'day))
16096 (t (call-interactively 'org-deadline)))
16097 (call-interactively 'org-deadline)))
16098 ((member property org-special-properties)
16099 (error "The %s property can not yet be set with `org-entry-put'"
16100 property))
16101 (t ; a non-special property
16102 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16103 (setq range (org-get-property-block beg end 'force))
16104 (goto-char (car range))
16105 (if (re-search-forward
16107 (progn
16108 (delete-region (match-beginning 1) (match-end 1))
16109 (goto-char (match-beginning 1)))
16110 (goto-char (cdr range))
16112 (backward-char 1)
16113 (org-indent-line-function)
16114 (insert ":" property ":"))
16115 (and value (insert " " value))
16116 (org-indent-line-function)))))))
16118 (defun org-buffer-property-keys (&optional include-specials include-defaults)
16119 "Get all property keys in the current buffer.
16120 With INCLUDE-SPECIALS, also list the special properties that relect things
16121 like tags and TODO state.
16122 With INCLUDE-DEFAULTS, also include properties that has special meaning
16123 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING."
16124 (let (rtn range)
16125 (save-excursion
16126 (save-restriction
16127 (widen)
16128 (goto-char (point-min))
16129 (while (re-search-forward org-property-start-re nil t)
16130 (setq range (org-get-property-block))
16131 (goto-char (car range))
16132 (while (re-search-forward
16134 (cdr range) t)
16135 (add-to-list 'rtn (org-match-string-no-properties 1)))
16136 (outline-next-heading))))
16138 (when include-specials
16139 (setq rtn (append org-special-properties rtn)))
16141 (when include-defaults
16142 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16144 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16146 (defun org-property-values (key)
16147 "Return a list of all values of property KEY."
16148 (save-excursion
16149 (save-restriction
16150 (widen)
16151 (goto-char (point-min))
16153 values)
16154 (while (re-search-forward re nil t)
16155 (add-to-list 'values (org-trim (match-string 1))))
16156 (delete "" values)))))
16158 (defun org-insert-property-drawer ()
16159 "Insert a property drawer into the current entry."
16160 (interactive)
16161 (org-back-to-heading t)
16162 (looking-at outline-regexp)
16163 (let ((indent (- (match-end 0)(match-beginning 0)))
16164 (beg (point))
16166 end hiddenp)
16167 (outline-next-heading)
16168 (setq end (point))
16169 (goto-char beg)
16170 (while (re-search-forward re end t))
16171 (setq hiddenp (org-invisible-p))
16172 (end-of-line 1)
16174 (org-skip-over-state-notes)
16176 (if (eq (char-before) ?*) (forward-char 1))
16178 (beginning-of-line 0)
16179 (indent-to-column indent)
16180 (beginning-of-line 2)
16181 (indent-to-column indent)
16182 (beginning-of-line 0)
16183 (if hiddenp
16184 (save-excursion
16185 (org-back-to-heading t)
16186 (hide-entry))
16187 (org-flag-drawer t))))
16189 (defun org-set-property (property value)
16190 "In the current entry, set PROPERTY to VALUE.
16191 When called interactively, this will prompt for a property name, offering
16192 completion on existing and default properties. And then it will prompt
16193 for a value, offering competion either on allowed values (via an inherited
16194 xxx_ALL property) or on existing values in other instances of this property
16195 in the current file."
16196 (interactive
16197 (let* ((prop (completing-read
16198 "Property: " (mapcar 'list (org-buffer-property-keys nil t))))
16199 (cur (org-entry-get nil prop))
16200 (allowed (org-property-get-allowed-values nil prop 'table))
16201 (existing (mapcar 'list (org-property-values prop)))
16202 (val (if allowed
16203 (completing-read "Value: " allowed nil 'req-match)
16204 (completing-read
16206 (concat "[" cur "]") "")
16207 ": ")
16208 existing nil nil "" nil cur))))
16209 (list prop (if (equal val "") cur val))))
16210 (unless (equal (org-entry-get nil property) value)
16211 (org-entry-put nil property value)))
16213 (defun org-delete-property (property)
16214 "In the current entry, delete PROPERTY."
16215 (interactive
16216 (let* ((prop (completing-read
16217 "Property: " (org-entry-properties nil 'standard))))
16218 (list prop)))
16219 (message "Property %s %s" property
16220 (if (org-entry-delete nil property)
16221 "deleted"
16222 "was not present in the entry")))
16224 (defun org-delete-property-globally (property)
16225 "Remove PROPERTY globally, from all entries."
16226 (interactive
16227 (let* ((prop (completing-read
16228 "Globally remove property: "
16229 (mapcar 'list (org-buffer-property-keys)))))
16230 (list prop)))
16231 (save-excursion
16232 (save-restriction
16233 (widen)
16234 (goto-char (point-min))
16235 (let ((cnt 0))
16236 (while (re-search-forward
16238 nil t)
16239 (setq cnt (1+ cnt))
16240 (replace-match ""))
16243 (defvar org-columns-current-fmt-compiled) ; defined below
16245 (defun org-compute-property-at-point ()
16246 "Compute the property at point.
16247 This looks for an enclosing column format, extracts the operator and
16248 then applies it to the proerty in the column format's scope."
16249 (interactive)
16250 (unless (org-at-property-p)
16251 (error "Not at a property"))
16252 (let ((prop (org-match-string-no-properties 2)))
16253 (org-columns-get-format-and-top-level)
16254 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16255 (error "No operator defined for property %s" prop))
16256 (org-columns-compute prop)))
16258 (defun org-property-get-allowed-values (pom property &optional table)
16259 "Get allowed values for the property PROPERTY.
16260 When TABLE is non-nil, return an alist that can directly be used for
16261 completion."
16262 (let (vals)
16263 (cond
16264 ((equal property "TODO")
16265 (setq vals (org-with-point-at pom
16266 (append org-todo-keywords-1 '("")))))
16267 ((equal property "PRIORITY")
16268 (let ((n org-lowest-priority))
16269 (while (>= n org-highest-priority)
16270 (push (char-to-string n) vals)
16271 (setq n (1- n)))))
16272 ((member property org-special-properties))
16273 (t
16274 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16277 (setq vals (car (read-from-string (concat "(" vals ")"))))
16278 (setq vals (mapcar (lambda (x)
16279 (cond ((stringp x) x)
16280 ((numberp x) (number-to-string x))
16281 ((symbolp x) (symbol-name x))
16282 (t "???")))
16283 vals)))))
16284 (if table (mapcar 'list vals) vals)))
16286 (defun org-property-previous-allowed-value (&optional previous)
16287 "Switch to the next allowed value for this property."
16288 (interactive)
16289 (org-property-next-allowed-value t))
16291 (defun org-property-next-allowed-value (&optional previous)
16292 "Switch to the next allowed value for this property."
16293 (interactive)
16294 (unless (org-at-property-p)
16295 (error "Not at a property"))
16296 (let* ((key (match-string 2))
16297 (value (match-string 3))
16298 (allowed (or (org-property-get-allowed-values (point) key)
16299 (and (member value '("[ ]" "[-]" "[X]"))
16300 '("[ ]" "[X]"))))
16301 nval)
16302 (unless allowed
16303 (error "Allowed values for this property have not been defined"))
16304 (if previous (setq allowed (reverse allowed)))
16305 (if (member value allowed)
16306 (setq nval (car (cdr (member value allowed)))))
16307 (setq nval (or nval (car allowed)))
16308 (if (equal nval value)
16309 (error "Only one allowed value for this property"))
16310 (org-at-property-p)
16311 (replace-match (concat " :" key ": " nval) t t)
16312 (org-indent-line-function)
16313 (beginning-of-line 1)
16316 (defun org-find-entry-with-id (ident)
16317 "Locate the entry that contains the ID property with exact value IDENT.
16318 IDENT can be a string, a symbol or a number, this function will search for
16319 the string representation of it.
16320 Return the position where this entry starts, or nil if there is no such entry."
16321 (let ((id (cond
16322 ((stringp ident) ident)
16323 ((symbol-name ident) (symbol-name ident))
16324 ((numberp ident) (number-to-string ident))
16325 (t (error "IDENT %s must be a string, symbol or number" ident))))
16326 (case-fold-search nil))
16327 (save-excursion
16328 (save-restriction
16329 (goto-char (point-min))
16330 (when (re-search-forward
16332 nil t)
16333 (org-back-to-heading)
16334 (point))))))
16336 ;;; Column View
16338 (defvar org-columns-overlays nil
16339 "Holds the list of current column overlays.")
16341 (defvar org-columns-current-fmt nil
16342 "Local variable, holds the currently active column format.")
16343 (defvar org-columns-current-fmt-compiled nil
16344 "Local variable, holds the currently active column format.
16345 This is the compiled version of the format.")
16346 (defvar org-columns-current-widths nil
16347 "Loval variable, holds the currently widths of fields.")
16348 (defvar org-columns-current-maxwidths nil
16349 "Loval variable, holds the currently active maximum column widths.")
16350 (defvar org-columns-begin-marker (make-marker)
16351 "Points to the position where last a column creation command was called.")
16352 (defvar org-columns-top-level-marker (make-marker)
16353 "Points to the position where current columns region starts.")
16355 (defvar org-columns-map (make-sparse-keymap)
16356 "The keymap valid in column display.")
16358 (defun org-columns-content ()
16359 "Switch to contents view while in columns view."
16360 (interactive)
16361 (org-overview)
16362 (org-content))
16364 (org-defkey org-columns-map "c" 'org-columns-content)
16365 (org-defkey org-columns-map "o" 'org-overview)
16366 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16367 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16368 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16369 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16370 (org-defkey org-columns-map "v" 'org-columns-show-value)
16371 (org-defkey org-columns-map "q" 'org-columns-quit)
16372 (org-defkey org-columns-map "r" 'org-columns-redo)
16373 (org-defkey org-columns-map "g" 'org-columns-redo)
16374 (org-defkey org-columns-map [left] 'backward-char)
16375 (org-defkey org-columns-map "\M-b" 'backward-char)
16376 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16377 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16378 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16379 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16380 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16381 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16382 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16383 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16384 (org-defkey org-columns-map "<" 'org-columns-narrow)
16385 (org-defkey org-columns-map ">" 'org-columns-widen)
16386 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16387 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16388 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16389 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16391 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16392 '("Column"
16393 ["Edit property" org-columns-edit-value t]
16394 ["Next allowed value" org-columns-next-allowed-value t]
16395 ["Previous allowed value" org-columns-previous-allowed-value t]
16396 ["Show full value" org-columns-show-value t]
16397 ["Edit allowed values" org-columns-edit-allowed t]
16398 "--"
16399 ["Edit column attributes" org-columns-edit-attributes t]
16400 ["Increase column width" org-columns-widen t]
16401 ["Decrease column width" org-columns-narrow t]
16402 "--"
16403 ["Move column right" org-columns-move-right t]
16404 ["Move column left" org-columns-move-left t]
16405 ["Add column" org-columns-new t]
16406 ["Delete column" org-columns-delete t]
16407 "--"
16408 ["CONTENTS" org-columns-content t]
16409 ["OVERVIEW" org-overview t]
16410 ["Refresh columns display" org-columns-redo t]
16411 "--"
16412 ["Open link" org-columns-open-link t]
16413 "--"
16414 ["Quit" org-columns-quit t]))
16416 (defun org-columns-new-overlay (beg end &optional string face)
16417 "Create a new column overlay and add it to the list."
16418 (let ((ov (org-make-overlay beg end)))
16419 (org-overlay-put ov 'face (or face 'secondary-selection))
16420 (org-overlay-display ov string face)
16421 (push ov org-columns-overlays)
16422 ov))
16424 (defun org-columns-display-here (&optional props)
16425 "Overlay the current line with column display."
16426 (interactive)
16427 (let* ((fmt org-columns-current-fmt-compiled)
16428 (beg (point-at-bol))
16429 (level-face (save-excursion
16430 (beginning-of-line 1)
16432 (org-get-level-face 2))))
16433 (color (list :foreground
16434 (face-attribute (or level-face 'default) :foreground)))
16435 props pom property ass width f string ov column val modval)
16436 ;; Check if the entry is in another buffer.
16437 (unless props
16438 (if (eq major-mode 'org-agenda-mode)
16439 (setq pom (or (get-text-property (point) 'org-hd-marker)
16440 (get-text-property (point) 'org-marker))
16441 props (if pom (org-entry-properties pom) nil))
16442 (setq props (org-entry-properties nil))))
16443 ;; Walk the format
16444 (while (setq column (pop fmt))
16445 (setq property (car column)
16446 ass (if (equal property "ITEM")
16447 (cons "ITEM"
16448 (save-match-data
16449 (org-no-properties
16450 (org-remove-tabs
16451 (buffer-substring-no-properties
16452 (point-at-bol) (point-at-eol))))))
16453 (assoc property props))
16454 width (or (cdr (assoc property org-columns-current-maxwidths))
16455 (nth 2 column)
16456 (length property))
16457 f (format "%%-%d.%ds | " width width)
16458 val (or (cdr ass) "")
16459 modval (if (equal property "ITEM")
16460 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16461 string (format f (or modval val)))
16462 ;; Create the overlay
16463 (org-unmodified
16464 (setq ov (org-columns-new-overlay
16465 beg (setq beg (1+ beg)) string
16466 (list color 'org-column)))
16467 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16468 (org-overlay-put ov 'keymap org-columns-map)
16469 (org-overlay-put ov 'org-columns-key property)
16470 (org-overlay-put ov 'org-columns-value (cdr ass))
16471 (org-overlay-put ov 'org-columns-value-modified modval)
16472 (org-overlay-put ov 'org-columns-pom pom)
16473 (org-overlay-put ov 'org-columns-format f))
16474 (if (or (not (char-after beg))
16476 (let ((inhibit-read-only t))
16477 (save-excursion
16478 (goto-char beg)
16479 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16480 ;; Make the rest of the line disappear.
16481 (org-unmodified
16482 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16483 (org-overlay-put ov 'invisible t)
16484 (org-overlay-put ov 'keymap org-columns-map)
16485 (org-overlay-put ov 'intangible t)
16486 (push ov org-columns-overlays)
16487 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16488 (org-overlay-put ov 'keymap org-columns-map)
16489 (push ov org-columns-overlays)
16490 (let ((inhibit-read-only t))
16491 (put-text-property (max (point-min) (1- (point-at-bol)))
16492 (min (point-max) (1+ (point-at-eol)))
16493 'read-only "Type `e' to edit property")))))
16495 (defvar org-previous-header-line-format nil
16496 "The header line format before column view was turned on.")
16497 (defvar org-columns-inhibit-recalculation nil
16498 "Inhibit recomputing of columns on column view startup.")
16501 (defvar header-line-format)
16502 (defun org-columns-display-here-title ()
16503 "Overlay the newline before the current line with the table title."
16504 (interactive)
16505 (let ((fmt org-columns-current-fmt-compiled)
16506 string (title "")
16507 property width f column str widths)
16508 (while (setq column (pop fmt))
16509 (setq property (car column)
16510 str (or (nth 1 column) property)
16511 width (or (cdr (assoc property org-columns-current-maxwidths))
16512 (nth 2 column)
16513 (length str))
16514 widths (push width widths)
16515 f (format "%%-%d.%ds | " width width)
16516 string (format f str)
16517 title (concat title string)))
16518 (setq title (concat
16519 (org-add-props " " nil 'display '(space :align-to 0))
16520 (org-add-props title nil 'face '(:weight bold :underline t))))
16521 (org-set-local 'org-previous-header-line-format header-line-format)
16522 (org-set-local 'org-columns-current-widths (nreverse widths))
16523 (setq header-line-format title)))
16525 (defun org-columns-remove-overlays ()
16526 "Remove all currently active column overlays."
16527 (interactive)
16528 (when (marker-buffer org-columns-begin-marker)
16529 (with-current-buffer (marker-buffer org-columns-begin-marker)
16530 (when (local-variable-p 'org-previous-header-line-format)
16531 (setq header-line-format org-previous-header-line-format)
16532 (kill-local-variable 'org-previous-header-line-format))
16533 (move-marker org-columns-begin-marker nil)
16534 (move-marker org-columns-top-level-marker nil)
16535 (org-unmodified
16536 (mapc 'org-delete-overlay org-columns-overlays)
16537 (setq org-columns-overlays nil)
16538 (let ((inhibit-read-only t))
16539 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16541 (defun org-columns-cleanup-item (item fmt)
16542 "Remove from ITEM what is a column in the format FMT."
16543 (if (not org-complex-heading-regexp)
16544 item
16545 (when (string-match org-complex-heading-regexp item)
16546 (concat
16547 (org-add-props (concat (match-string 1 item) " ") nil
16548 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16549 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16550 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16551 " " (match-string 4 item)
16552 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16554 (defun org-columns-show-value ()
16555 "Show the full value of the property."
16556 (interactive)
16557 (let ((value (get-char-property (point) 'org-columns-value)))
16558 (message "Value is: %s" (or value ""))))
16560 (defun org-columns-quit ()
16561 "Remove the column overlays and in this way exit column editing."
16562 (interactive)
16563 (org-unmodified
16564 (org-columns-remove-overlays)
16565 (let ((inhibit-read-only t))
16566 (remove-text-properties (point-min) (point-max) '(read-only t))))
16567 (when (eq major-mode 'org-agenda-mode)
16568 (message
16569 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16571 (defun org-columns-check-computed ()
16572 "Check if this column value is computed.
16573 If yes, throw an error indicating that changing it does not make sense."
16574 (let ((val (get-char-property (point) 'org-columns-value)))
16575 (when (and (stringp val)
16576 (get-char-property 0 'org-computed val))
16577 (error "This value is computed from the entry's children"))))
16579 (defun org-columns-todo (&optional arg)
16580 "Change the TODO state during column view."
16581 (interactive "P")
16582 (org-columns-edit-value "TODO"))
16584 (defun org-columns-set-tags-or-toggle (&optional arg)
16585 "Toggle checkbox at point, or set tags for current headline."
16586 (interactive "P")
16588 (get-char-property (point) 'org-columns-value))
16589 (org-columns-next-allowed-value)
16590 (org-columns-edit-value "TAGS")))
16592 (defun org-columns-edit-value (&optional key)
16593 "Edit the value of the property at point in column view.
16594 Where possible, use the standard interface for changing this line."
16595 (interactive)
16596 (org-columns-check-computed)
16597 (let* ((external-key key)
16598 (col (current-column))
16599 (key (or key (get-char-property (point) 'org-columns-key)))
16600 (value (get-char-property (point) 'org-columns-value))
16601 (bol (point-at-bol)) (eol (point-at-eol))
16602 (pom (or (get-text-property bol 'org-hd-marker)
16603 (point))) ; keep despite of compiler waring
16604 (line-overlays
16605 (delq nil (mapcar (lambda (x)
16606 (and (eq (overlay-buffer x) (current-buffer))
16607 (>= (overlay-start x) bol)
16608 (<= (overlay-start x) eol)
16609 x))
16610 org-columns-overlays)))
16611 nval eval allowed)
16612 (cond
16613 ((equal key "CLOCKSUM")
16614 (error "This special column cannot be edited"))
16615 ((equal key "ITEM")
16616 (setq eval '(org-with-point-at pom
16617 (org-edit-headline))))
16618 ((equal key "TODO")
16619 (setq eval '(org-with-point-at pom
16620 (let ((current-prefix-arg
16621 (if external-key current-prefix-arg '(4))))
16622 (call-interactively 'org-todo)))))
16623 ((equal key "PRIORITY")
16624 (setq eval '(org-with-point-at pom
16625 (call-interactively 'org-priority))))
16626 ((equal key "TAGS")
16627 (setq eval '(org-with-point-at pom
16628 (let ((org-fast-tag-selection-single-key
16629 (if (eq org-fast-tag-selection-single-key 'expert)
16630 t org-fast-tag-selection-single-key)))
16631 (call-interactively 'org-set-tags)))))
16632 ((equal key "DEADLINE")
16633 (setq eval '(org-with-point-at pom
16634 (call-interactively 'org-deadline))))
16635 ((equal key "SCHEDULED")
16636 (setq eval '(org-with-point-at pom
16637 (call-interactively 'org-schedule))))
16638 (t
16639 (setq allowed (org-property-get-allowed-values pom key 'table))
16640 (if allowed
16641 (setq nval (completing-read "Value: " allowed nil t))
16642 (setq nval (read-string "Edit: " value)))
16643 (setq nval (org-trim nval))
16644 (when (not (equal nval value))
16645 (setq eval '(org-entry-put pom key nval)))))
16646 (when eval
16647 (let ((inhibit-read-only t))
16648 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16649 (unwind-protect
16650 (progn
16651 (setq org-columns-overlays
16652 (org-delete-all line-overlays org-columns-overlays))
16653 (mapc 'org-delete-overlay line-overlays)
16654 (org-columns-eval eval))
16655 (org-columns-display-here))))
16656 (move-to-column col)
16657 (if (and (org-mode-p)
16658 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16659 (org-columns-update key))))
16661 (defun org-edit-headline () ; FIXME: this is not columns specific
16662 "Edit the current headline, the part without TODO keyword, TAGS."
16663 (org-back-to-heading)
16664 (when (looking-at org-todo-line-regexp)
16665 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16666 (txt (match-string 3))
16667 (post "")
16668 txt2)
16670 (setq post (match-string 0 txt)
16671 txt (substring txt 0 (match-beginning 0))))
16672 (setq txt2 (read-string "Edit: " txt))
16673 (when (not (equal txt txt2))
16674 (beginning-of-line 1)
16675 (insert pre txt2 post)
16676 (delete-region (point) (point-at-eol))
16677 (org-set-tags nil t)))))
16679 (defun org-columns-edit-allowed ()
16680 "Edit the list of allowed values for the current property."
16681 (interactive)
16682 (let* ((key (get-char-property (point) 'org-columns-key))
16683 (key1 (concat key "_ALL"))
16684 (allowed (org-entry-get (point) key1 t))
16685 nval)
16686 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16687 (setq nval (read-string "Allowed: " allowed))
16688 (org-entry-put
16689 (cond ((marker-position org-entry-property-inherited-from)
16690 org-entry-property-inherited-from)
16691 ((marker-position org-columns-top-level-marker)
16692 org-columns-top-level-marker))
16693 key1 nval)))
16695 (defmacro org-no-warnings (&rest body)
16696 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16698 (defun org-columns-eval (form)
16699 (let (hidep)
16700 (save-excursion
16701 (beginning-of-line 1)
16702 ;; `next-line' is needed here, because it skips invisible line.
16703 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16704 (setq hidep (org-on-heading-p 1)))
16705 (eval form)
16706 (and hidep (hide-entry))))
16708 (defun org-columns-previous-allowed-value ()
16709 "Switch to the previous allowed value for this column."
16710 (interactive)
16711 (org-columns-next-allowed-value t))
16713 (defun org-columns-next-allowed-value (&optional previous)
16714 "Switch to the next allowed value for this column."
16715 (interactive)
16716 (org-columns-check-computed)
16717 (let* ((col (current-column))
16718 (key (get-char-property (point) 'org-columns-key))
16719 (value (get-char-property (point) 'org-columns-value))
16720 (bol (point-at-bol)) (eol (point-at-eol))
16721 (pom (or (get-text-property bol 'org-hd-marker)
16722 (point))) ; keep despite of compiler waring
16723 (line-overlays
16724 (delq nil (mapcar (lambda (x)
16725 (and (eq (overlay-buffer x) (current-buffer))
16726 (>= (overlay-start x) bol)
16727 (<= (overlay-start x) eol)
16728 x))
16729 org-columns-overlays)))
16730 (allowed (or (org-property-get-allowed-values pom key)
16731 (and (equal
16732 (nth 4 (assoc key org-columns-current-fmt-compiled))
16733 'checkbox) '("[ ]" "[X]"))))
16734 nval)
16735 (when (equal key "ITEM")
16736 (error "Cannot edit item headline from here"))
16737 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16738 (error "Allowed values for this property have not been defined"))
16739 (if (member key '("SCHEDULED" "DEADLINE"))
16740 (setq nval (if previous 'earlier 'later))
16741 (if previous (setq allowed (reverse allowed)))
16742 (if (member value allowed)
16743 (setq nval (car (cdr (member value allowed)))))
16744 (setq nval (or nval (car allowed)))
16745 (if (equal nval value)
16746 (error "Only one allowed value for this property")))
16747 (let ((inhibit-read-only t))
16748 (remove-text-properties (1- bol) eol '(read-only t))
16749 (unwind-protect
16750 (progn
16751 (setq org-columns-overlays
16752 (org-delete-all line-overlays org-columns-overlays))
16753 (mapc 'org-delete-overlay line-overlays)
16754 (org-columns-eval '(org-entry-put pom key nval)))
16755 (org-columns-display-here)))
16756 (move-to-column col)
16757 (if (and (org-mode-p)
16758 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16759 (org-columns-update key))))
16761 (defun org-verify-version (task)
16762 (cond
16763 ((eq task 'columns)
16764 (if (or (featurep 'xemacs)
16765 (< emacs-major-version 22))
16766 (error "Emacs 22 is required for the columns feature")))))
16768 (defun org-columns-open-link (&optional arg)
16769 (interactive "P")
16770 (let ((key (get-char-property (point) 'org-columns-key))
16771 (value (get-char-property (point) 'org-columns-value)))
16772 (org-open-link-from-string arg)))
16774 (defun org-open-link-from-string (s &optional arg)
16775 "Open a link in the string S, as if it was in Org-mode."
16776 (interactive)
16777 (with-temp-buffer
16778 (let ((org-inhibit-startup t))
16779 (org-mode)
16780 (insert s)
16781 (goto-char (point-min))
16782 (org-open-at-point arg))))
16784 (defun org-columns-get-format-and-top-level ()
16785 (let (fmt)
16786 (when (condition-case nil (org-back-to-heading) (error nil))
16787 (move-marker org-entry-property-inherited-from nil)
16788 (setq fmt (org-entry-get nil "COLUMNS" t)))
16789 (setq fmt (or fmt org-columns-default-format))
16790 (org-set-local 'org-columns-current-fmt fmt)
16791 (org-columns-compile-format fmt)
16792 (if (marker-position org-entry-property-inherited-from)
16793 (move-marker org-columns-top-level-marker
16794 org-entry-property-inherited-from)
16795 (move-marker org-columns-top-level-marker (point)))
16796 fmt))
16798 (defun org-columns ()
16799 "Turn on column view on an org-mode file."
16800 (interactive)
16801 (org-verify-version 'columns)
16802 (org-columns-remove-overlays)
16803 (move-marker org-columns-begin-marker (point))
16804 (let (beg end fmt cache maxwidths clocksump)
16805 (setq fmt (org-columns-get-format-and-top-level))
16806 (save-excursion
16807 (goto-char org-columns-top-level-marker)
16808 (setq beg (point))
16809 (unless org-columns-inhibit-recalculation
16810 (org-columns-compute-all))
16811 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16812 (point-max)))
16813 ;; Get and cache the properties
16814 (goto-char beg)
16815 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16816 (setq clocksump t)
16817 (save-excursion
16818 (save-restriction
16819 (narrow-to-region beg end)
16820 (org-clock-sum))))
16821 (while (re-search-forward (concat "^" outline-regexp) end t)
16822 (push (cons (org-current-line) (org-entry-properties)) cache))
16823 (when cache
16824 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16825 (org-set-local 'org-columns-current-maxwidths maxwidths)
16826 (org-columns-display-here-title)
16827 (mapc (lambda (x)
16828 (goto-line (car x))
16829 (org-columns-display-here (cdr x)))
16830 cache)))))
16832 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16833 "Insert a new column, to the leeft o the current column."
16834 (interactive)
16835 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16836 cell)
16837 (setq prop (completing-read
16838 "Property: " (mapcar 'list (org-buffer-property-keys t))
16839 nil nil prop))
16840 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16841 (setq width (read-string "Column width: " (if width (number-to-string width))))
16843 (setq width (string-to-number width))
16844 (setq width nil))
16845 (setq fmt (completing-read "Summary [none]: "
16846 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox"))
16847 nil t))
16849 (setq fmt (intern fmt))
16850 (setq fmt nil))
16851 (if (eq fmt 'none) (setq fmt nil))
16852 (if editp
16853 (progn
16854 (setcar editp prop)
16855 (setcdr editp (list title width nil fmt)))
16856 (setq cell (nthcdr (1- (current-column))
16857 org-columns-current-fmt-compiled))
16858 (setcdr cell (cons (list prop title width nil fmt)
16859 (cdr cell))))
16860 (org-columns-store-format)
16861 (org-columns-redo)))
16863 (defun org-columns-delete ()
16864 "Delete the column at point from columns view."
16865 (interactive)
16866 (let* ((n (current-column))
16867 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16868 (when (y-or-n-p
16870 (setq org-columns-current-fmt-compiled
16871 (delq (nth n org-columns-current-fmt-compiled)
16872 org-columns-current-fmt-compiled))
16873 (org-columns-store-format)
16874 (org-columns-redo)
16875 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16876 (backward-char 1)))))
16878 (defun org-columns-edit-attributes ()
16879 "Edit the attributes of the current column."
16880 (interactive)
16881 (let* ((n (current-column))
16882 (info (nth n org-columns-current-fmt-compiled)))
16883 (apply 'org-columns-new info)))
16885 (defun org-columns-widen (arg)
16886 "Make the column wider by ARG characters."
16887 (interactive "p")
16888 (let* ((n (current-column))
16889 (entry (nth n org-columns-current-fmt-compiled))
16890 (width (or (nth 2 entry)
16891 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16892 (setq width (max 1 (+ width arg)))
16893 (setcar (nthcdr 2 entry) width)
16894 (org-columns-store-format)
16895 (org-columns-redo)))
16897 (defun org-columns-narrow (arg)
16898 "Make the column nrrower by ARG characters."
16899 (interactive "p")
16900 (org-columns-widen (- arg)))
16902 (defun org-columns-move-right ()
16903 "Swap this column with the one to the right."
16904 (interactive)
16905 (let* ((n (current-column))
16906 (cell (nthcdr n org-columns-current-fmt-compiled))
16907 e)
16908 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16909 (error "Cannot shift this column further to the right"))
16910 (setq e (car cell))
16911 (setcar cell (car (cdr cell)))
16912 (setcdr cell (cons e (cdr (cdr cell))))
16913 (org-columns-store-format)
16914 (org-columns-redo)
16915 (forward-char 1)))
16917 (defun org-columns-move-left ()
16918 "Swap this column with the one to the left."
16919 (interactive)
16920 (let* ((n (current-column)))
16921 (when (= n 0)
16922 (error "Cannot shift this column further to the left"))
16923 (backward-char 1)
16924 (org-columns-move-right)
16925 (backward-char 1)))
16927 (defun org-columns-store-format ()
16928 "Store the text version of the current columns format in appropriate place.
16929 This is either in the COLUMNS property of the node starting the current column
16930 display, or in the #+COLUMNS line of the current buffer."
16931 (let (fmt (cnt 0))
16932 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16933 (org-set-local 'org-columns-current-fmt fmt)
16934 (if (marker-position org-columns-top-level-marker)
16935 (save-excursion
16936 (goto-char org-columns-top-level-marker)
16937 (if (and (org-at-heading-p)
16938 (org-entry-get nil "COLUMNS"))
16939 (org-entry-put nil "COLUMNS" fmt)
16940 (goto-char (point-min))
16941 ;; Overwrite all #+COLUMNS lines....
16943 (setq cnt (1+ cnt))
16944 (replace-match (concat "#+COLUMNS: " fmt) t t))
16945 (unless (> cnt 0)
16946 (goto-char (point-min))
16947 (or (org-on-heading-p t) (outline-next-heading))
16948 (let ((inhibit-read-only t))
16950 (org-set-local 'org-columns-default-format fmt))))))
16952 (defvar org-overriding-columns-format nil
16953 "When set, overrides any other definition.")
16954 (defvar org-agenda-view-columns-initially nil
16955 "When set, switch to columns view immediately after creating the agenda.")
16957 (defun org-agenda-columns ()
16958 "Turn on column view in the agenda."
16959 (interactive)
16960 (org-verify-version 'columns)
16961 (org-columns-remove-overlays)
16962 (move-marker org-columns-begin-marker (point))
16963 (let (fmt cache maxwidths m)
16964 (cond
16965 ((and (local-variable-p 'org-overriding-columns-format)
16966 org-overriding-columns-format)
16967 (setq fmt org-overriding-columns-format))
16968 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
16969 (setq fmt (org-entry-get m "COLUMNS" t)))
16970 ((and (boundp 'org-columns-current-fmt)
16971 (local-variable-p 'org-columns-current-fmt)
16972 org-columns-current-fmt)
16973 (setq fmt org-columns-current-fmt))
16974 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
16975 (setq m (get-text-property m 'org-hd-marker))
16976 (setq fmt (org-entry-get m "COLUMNS" t))))
16977 (setq fmt (or fmt org-columns-default-format))
16978 (org-set-local 'org-columns-current-fmt fmt)
16979 (org-columns-compile-format fmt)
16980 (save-excursion
16981 ;; Get and cache the properties
16982 (goto-char (point-min))
16983 (while (not (eobp))
16984 (when (setq m (or (get-text-property (point) 'org-hd-marker)
16985 (get-text-property (point) 'org-marker)))
16986 (push (cons (org-current-line) (org-entry-properties m)) cache))
16987 (beginning-of-line 2))
16988 (when cache
16989 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16990 (org-set-local 'org-columns-current-maxwidths maxwidths)
16991 (org-columns-display-here-title)
16992 (mapc (lambda (x)
16993 (goto-line (car x))
16994 (org-columns-display-here (cdr x)))
16995 cache)))))
16997 (defun org-columns-get-autowidth-alist (s cache)
16998 "Derive the maximum column widths from the format and the cache."
16999 (let ((start 0) rtn)
17001 (push (cons (match-string 1 s) 1) rtn)
17002 (setq start (match-end 0)))
17003 (mapc (lambda (x)
17004 (setcdr x (apply 'max
17005 (mapcar
17006 (lambda (y)
17007 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17008 cache))))
17009 rtn)
17010 rtn))
17012 (defun org-columns-compute-all ()
17013 "Compute all columns that have operators defined."
17014 (org-unmodified
17015 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17016 (let ((columns org-columns-current-fmt-compiled) col)
17017 (while (setq col (pop columns))
17018 (when (nth 3 col)
17019 (save-excursion
17020 (org-columns-compute (car col)))))))
17022 (defun org-columns-update (property)
17023 "Recompute PROPERTY, and update the columns display for it."
17024 (org-columns-compute property)
17025 (let (fmt val pos)
17026 (save-excursion
17027 (mapc (lambda (ov)
17028 (when (equal (org-overlay-get ov 'org-columns-key) property)
17029 (setq pos (org-overlay-start ov))
17030 (goto-char pos)
17031 (when (setq val (cdr (assoc property
17032 (get-text-property
17033 (point-at-bol) 'org-summaries))))
17034 (setq fmt (org-overlay-get ov 'org-columns-format))
17035 (org-overlay-put ov 'org-columns-value val)
17036 (org-overlay-put ov 'display (format fmt val)))))
17037 org-columns-overlays))))
17039 (defun org-columns-compute (property)
17040 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17041 (interactive)
17042 (let* ((re (concat "^" outline-regexp))
17043 (lmax 30) ; Does anyone use deeper levels???
17044 (lsum (make-vector lmax 0))
17045 (lflag (make-vector lmax nil))
17046 (level 0)
17047 (ass (assoc property org-columns-current-fmt-compiled))
17048 (format (nth 4 ass))
17049 (printf (nth 5 ass))
17050 (beg org-columns-top-level-marker)
17051 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17052 (save-excursion
17053 ;; Find the region to compute
17054 (goto-char beg)
17055 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17056 (goto-char end)
17057 ;; Walk the tree from the back and do the computations
17058 (while (re-search-backward re beg t)
17059 (setq sumpos (match-beginning 0)
17060 last-level level
17061 level (org-outline-level)
17062 val (org-entry-get nil property)
17064 (cond
17065 ((< level last-level)
17066 ;; put the sum of lower levels here as a property
17067 (setq sum (aref lsum last-level) ; current sum
17068 flag (aref lflag last-level) ; any valid entries from children?
17069 str (org-column-number-to-string sum format printf)
17070 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17071 useval (if flag str1 (if valflag val ""))
17072 sum-alist (get-text-property sumpos 'org-summaries))
17073 (if (assoc property sum-alist)
17074 (setcdr (assoc property sum-alist) useval)
17075 (push (cons property useval) sum-alist)
17076 (org-unmodified
17077 (add-text-properties sumpos (1+ sumpos)
17078 (list 'org-summaries sum-alist))))
17079 (when val
17080 (org-entry-put nil property (if flag str val)))
17081 ;; add current to current level accumulator
17082 (when (or flag valflag)
17083 (aset lsum level (+ (aref lsum level)
17084 (if flag sum (org-column-string-to-number
17085 (if flag str val) format))))
17086 (aset lflag level t))
17087 ;; clear accumulators for deeper levels
17088 (loop for l from (1+ level) to (1- lmax) do
17089 (aset lsum l 0)
17090 (aset lflag l nil)))
17091 ((>= level last-level)
17092 ;; add what we have here to the accumulator for this level
17093 (aset lsum level (+ (aref lsum level)
17094 (org-column-string-to-number (or val "0") format)))
17095 (and valflag (aset lflag level t)))
17096 (t (error "This should not happen")))))))
17098 (defun org-columns-redo ()
17099 "Construct the column display again."
17100 (interactive)
17101 (message "Recomputing columns...")
17102 (save-excursion
17103 (if (marker-position org-columns-begin-marker)
17104 (goto-char org-columns-begin-marker))
17105 (org-columns-remove-overlays)
17106 (if (org-mode-p)
17107 (call-interactively 'org-columns)
17108 (call-interactively 'org-agenda-columns)))
17109 (message "Recomputing columns...done"))
17111 (defun org-columns-not-in-agenda ()
17112 (if (eq major-mode 'org-agenda-mode)
17113 (error "This command is only allowed in Org-mode buffers")))
17116 (defun org-string-to-number (s)
17117 "Convert string to number, and interpret hh:mm:ss."
17118 (if (not (string-match ":" s))
17119 (string-to-number s)
17120 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17121 (while l
17122 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17123 sum)))
17125 (defun org-column-number-to-string (n fmt &optional printf)
17126 "Convert a computed column number to a string value, according to FMT."
17127 (cond
17128 ((eq fmt 'add_times)
17129 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17130 (format "%d:%02d" h m)))
17131 ((eq fmt 'checkbox)
17132 (cond ((= n (floor n)) "[X]")
17133 ((> n 1.) "[-]")
17134 (t "[ ]")))
17135 (printf (format printf n))
17136 ((eq fmt 'currency)
17137 (format "%.2f" n))
17138 (t (number-to-string n))))
17140 (defun org-column-string-to-number (s fmt)
17141 "Convert a column value to a number that can be used for column computing."
17142 (cond
17143 ((string-match ":" s)
17144 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17145 (while l
17146 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17147 sum))
17148 ((eq fmt 'checkbox)
17149 (if (equal s "[X]") 1. 0.000001))
17150 (t (string-to-number s))))
17152 (defun org-columns-uncompile-format (cfmt)
17153 "Turn the compiled columns format back into a string representation."
17154 (let ((rtn "") e s prop title op width fmt printf)
17155 (while (setq e (pop cfmt))
17156 (setq prop (car e)
17157 title (nth 1 e)
17158 width (nth 2 e)
17159 op (nth 3 e)
17160 fmt (nth 4 e)
17161 printf (nth 5 e))
17162 (cond
17163 ((eq fmt 'add_times) (setq op ":"))
17164 ((eq fmt 'checkbox) (setq op "X"))
17165 ((eq fmt 'add_numbers) (setq op "+"))
17166 ((eq fmt 'currency) (setq op "$")))
17167 (if (and op printf) (setq op (concat op ";" printf)))
17168 (if (equal title prop) (setq title nil))
17169 (setq s (concat "%" (if width (number-to-string width))
17170 prop
17171 (if title (concat "(" title ")"))
17172 (if op (concat "{" op "}"))))
17173 (setq rtn (concat rtn " " s)))
17174 (org-trim rtn)))
17176 (defun org-columns-compile-format (fmt)
17177 "Turn a column format string into an alist of specifications.
17178 The alist has one entry for each column in the format. The elements of
17179 that list are:
17180 property the property
17181 title the title field for the columns
17182 width the column width in characters, can be nil for automatic
17183 operator the operator if any
17184 format the output format for computed results, derived from operator
17185 printf a printf format for computed values"
17186 (let ((start 0) width prop title op f printf)
17187 (setq org-columns-current-fmt-compiled nil)
17188 (while (string-match
17189 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17190 fmt start)
17191 (setq start (match-end 0)
17192 width (match-string 1 fmt)
17193 prop (match-string 2 fmt)
17194 title (or (match-string 3 fmt) prop)
17195 op (match-string 4 fmt)
17196 f nil
17197 printf nil)
17198 (if width (setq width (string-to-number width)))
17199 (when (and op (string-match ";" op))
17200 (setq printf (substring op (match-end 0))
17201 op (substring op 0 (match-beginning 0))))
17202 (cond
17203 ((equal op "+") (setq f 'add_numbers))
17204 ((equal op "$") (setq f 'currency))
17205 ((equal op ":") (setq f 'add_times))
17206 ((equal op "X") (setq f 'checkbox)))
17207 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17208 (setq org-columns-current-fmt-compiled
17209 (nreverse org-columns-current-fmt-compiled))))
17212 ;;; Dynamic block for Column view
17214 (defun org-columns-capture-view ()
17215 "Get the column view of the current buffer and return it as a list.
17216 The list will contains the title row and all other rows. Each row is
17217 a list of fields."
17218 (save-excursion
17219 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17220 (n (length title)) row tbl)
17221 (goto-char (point-min))
17223 (when (get-char-property (match-beginning 0) 'org-columns-key)
17224 (setq row nil)
17225 (loop for i from 0 to (1- n) do
17226 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17227 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17228 "")
17229 row))
17230 (setq row (nreverse row))
17231 (push row tbl)))
17232 (append (list title 'hline) (nreverse tbl)))))
17234 (defun org-dblock-write:columnview (params)
17235 "Write the column view table.
17236 PARAMS is a property list of parameters:
17238 :width enforce same column widths with <N> specifiers.
17239 :id the :ID: property of the entry where the columns view
17240 should be built, as a string. When `local', call locally.
17241 When `global' call column view with the cursor at the beginning
17242 of the buffer (usually this means that the whole buffer switches
17243 to column view).
17244 :hlines When t, insert a hline before each item. When a number, insert
17245 a hline before each level <= that number.
17246 :vlines When t, make each column a colgroup to enforce vertical lines."
17247 (let ((pos (move-marker (make-marker) (point)))
17248 (hlines (plist-get params :hlines))
17249 (vlines (plist-get params :vlines))
17250 tbl id idpos nfields tmp)
17251 (save-excursion
17252 (save-restriction
17253 (when (setq id (plist-get params :id))
17254 (cond ((not id) nil)
17255 ((eq id 'global) (goto-char (point-min)))
17256 ((eq id 'local) nil)
17257 ((setq idpos (org-find-entry-with-id id))
17258 (goto-char idpos))
17259 (t (error "Cannot find entry with :ID: %s" id))))
17260 (org-columns)
17261 (setq tbl (org-columns-capture-view))
17262 (setq nfields (length (car tbl)))
17263 (org-columns-quit)))
17264 (goto-char pos)
17265 (move-marker pos nil)
17266 (when tbl
17267 (when (plist-get params :hlines)
17268 (setq tmp nil)
17269 (while tbl
17270 (if (eq (car tbl) 'hline)
17271 (push (pop tbl) tmp)
17273 (if (and (not (eq (car tmp) 'hline))
17274 (or (eq hlines t)
17275 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17276 (push 'hline tmp)))
17277 (push (pop tbl) tmp)))
17278 (setq tbl (nreverse tmp)))
17279 (when vlines
17280 (setq tbl (mapcar (lambda (x)
17281 (if (eq 'hline x) x (cons "" x)))
17282 tbl))
17283 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17284 (setq pos (point))
17285 (insert (org-listtable-to-string tbl))
17286 (when (plist-get params :width)
17288 org-columns-current-widths "|")))
17289 (goto-char pos)
17290 (org-table-align))))
17292 (defun org-listtable-to-string (tbl)
17293 "Convert a listtable TBL to a string that contains the Org-mode table.
17294 The table still need to be alligned. The resulting string has no leading
17295 and tailing newline characters."
17296 (mapconcat
17297 (lambda (x)
17298 (cond
17299 ((listp x)
17300 (concat "|" (mapconcat 'identity x "|") "|"))
17301 ((eq x 'hline) "|-|")
17302 (t (error "Garbage in listtable: %s" x))))
17305 (defun org-insert-columns-dblock ()
17306 "Create a dynamic block capturing a column view table."
17307 (interactive)
17308 (let ((defaults '(:name "columnview" :hlines 1))
17309 (id (completing-read
17310 "Capture columns (local, global, entry with :ID: property) [local]: "
17311 (append '(("global") ("local"))
17312 (mapcar 'list (org-property-values "ID"))))))
17313 (if (equal id "") (setq id 'local))
17314 (if (equal id "global") (setq id 'global))
17315 (setq defaults (append defaults (list :id id)))
17316 (org-create-dblock defaults)
17317 (org-update-dblock)))
17319 ;;;; Timestamps
17321 (defvar org-last-changed-timestamp nil)
17322 (defvar org-time-was-given) ; dynamically scoped parameter
17323 (defvar org-end-time-was-given) ; dynamically scoped parameter
17324 (defvar org-ts-what) ; dynamically scoped parameter
17326 (defun org-time-stamp (arg)
17327 "Prompt for a date/time and insert a time stamp.
17328 If the user specifies a time like HH:MM, or if this command is called
17329 with a prefix argument, the time stamp will contain date and time.
17330 Otherwise, only the date will be included. All parts of a date not
17331 specified by the user will be filled in from the current date/time.
17332 So if you press just return without typing anything, the time stamp
17333 will represent the current date/time. If there is already a timestamp
17334 at the cursor, it will be modified."
17335 (interactive "P")
17336 (let* ((ts nil)
17337 (default-time
17338 ;; Default time is either today, or, when entering a range,
17339 ;; the range start.
17340 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17341 (save-excursion
17342 (re-search-backward
17344 (- (point) 20) t)))
17345 (apply 'encode-time (org-parse-time-string (match-string 1)))
17346 (current-time)))
17347 (default-input (and ts (org-get-compact-tod ts)))
17348 org-time-was-given org-end-time-was-given time)
17349 (cond
17350 ((and (org-at-timestamp-p)
17351 (eq last-command 'org-time-stamp)
17352 (eq this-command 'org-time-stamp))
17353 (insert "--")
17354 (setq time (let ((this-command this-command))
17355 (org-read-date arg 'totime nil nil default-time default-input)))
17356 (org-insert-time-stamp time (or org-time-was-given arg)))
17357 ((org-at-timestamp-p)
17358 (setq time (let ((this-command this-command))
17359 (org-read-date arg 'totime nil nil default-time default-input)))
17360 (when (org-at-timestamp-p) ; just to get the match data
17361 (replace-match "")
17362 (setq org-last-changed-timestamp
17363 (org-insert-time-stamp
17364 time (or org-time-was-given arg)
17365 nil nil nil (list org-end-time-was-given))))
17366 (message "Timestamp updated"))
17367 (t
17368 (setq time (let ((this-command this-command))
17369 (org-read-date arg 'totime nil nil default-time default-input)))
17370 (org-insert-time-stamp time (or org-time-was-given arg)
17371 nil nil nil (list org-end-time-was-given))))))
17373 ;; FIXME: can we use this for something else????
17374 ;; like computing time differences?????
17375 (defun org-get-compact-tod (s)
17376 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17377 (let* ((t1 (match-string 1 s))
17378 (h1 (string-to-number (match-string 2 s)))
17379 (m1 (string-to-number (match-string 3 s)))
17380 (t2 (and (match-end 4) (match-string 5 s)))
17381 (h2 (and t2 (string-to-number (match-string 6 s))))
17382 (m2 (and t2 (string-to-number (match-string 7 s))))
17383 dh dm)
17384 (if (not t2)
17385 t1
17386 (setq dh (- h2 h1) dm (- m2 m1))
17387 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17388 (concat t1 "+" (number-to-string dh)
17389 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17391 (defun org-time-stamp-inactive (&optional arg)
17392 "Insert an inactive time stamp.
17393 An inactive time stamp is enclosed in square brackets instead of angle
17394 brackets. It is inactive in the sense that it does not trigger agenda entries,
17395 does not link to the calendar and cannot be changed with the S-cursor keys.
17396 So these are more for recording a certain time/date."
17397 (interactive "P")
17398 (let (org-time-was-given org-end-time-was-given time)
17399 (setq time (org-read-date arg 'totime))
17400 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17401 nil nil (list org-end-time-was-given))))
17403 (defvar org-date-ovl (org-make-overlay 1 1))
17404 (org-overlay-put org-date-ovl 'face 'org-warning)
17405 (org-detach-overlay org-date-ovl)
17407 (defvar org-ans1) ; dynamically scoped parameter
17408 (defvar org-ans2) ; dynamically scoped parameter
17410 (defvar org-plain-time-of-day-regexp) ; defined below
17412 (defvar org-read-date-overlay nil)
17413 (defvar org-dcst nil) ; dynamically scoped
17415 (defun org-read-date (&optional with-time to-time from-string prompt
17416 default-time default-input)
17417 "Read a date, possibly a time, and make things smooth for the user.
17418 The prompt will suggest to enter an ISO date, but you can also enter anything
17419 which will at least partially be understood by `parse-time-string'.
17420 Unrecognized parts of the date will default to the current day, month, year,
17421 hour and minute. If this command is called to replace a timestamp at point,
17422 of to enter the second timestamp of a range, the default time is taken from the
17423 existing stamp. For example,
17424 3-2-5 --> 2003-02-05
17425 feb 15 --> currentyear-02-15
17426 sep 12 9 --> 2009-09-12
17427 12:45 --> today 12:45
17428 22 sept 0:34 --> currentyear-09-22 0:34
17429 12 --> currentyear-currentmonth-12
17430 Fri --> nearest Friday (today or later)
17431 etc.
17433 Furthermore you can specify a relative date by giving, as the *first* thing
17434 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17435 change in days weeks, months, years.
17436 With a single plus or minus, the date is relative to today. With a double
17437 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17438 +4d --> four days from today
17439 +4 --> same as above
17440 +2w --> two weeks from today
17441 ++5 --> five days from default date
17443 The function understands only English month and weekday abbreviations,
17444 but this can be configured with the variables `parse-time-months' and
17445 `parse-time-weekdays'.
17447 While prompting, a calendar is popped up - you can also select the
17448 date with the mouse (button 1). The calendar shows a period of three
17449 months. To scroll it to other months, use the keys `>' and `<'.
17450 If you don't like the calendar, turn it off with
17451 \(setq org-read-date-popup-calendar nil)
17453 With optional argument TO-TIME, the date will immediately be converted
17454 to an internal time.
17455 With an optional argument WITH-TIME, the prompt will suggest to also
17456 insert a time. Note that when WITH-TIME is not set, you can still
17457 enter a time, and this function will inform the calling routine about
17458 this change. The calling routine may then choose to change the format
17459 used to insert the time stamp into the buffer to include the time.
17460 With optional argument FROM-STRING, read from this string instead from
17461 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17462 the time/date that is used for everything that is not specified by the
17463 user."
17464 (require 'parse-time)
17465 (let* ((org-time-stamp-rounding-minutes
17466 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17467 (org-dcst org-display-custom-times)
17468 (ct (org-current-time))
17469 (def (or default-time ct))
17470 (defdecode (decode-time def))
17471 (dummy (progn
17472 (when (< (nth 2 defdecode) org-extend-today-until)
17473 (setcar (nthcdr 2 defdecode) -1)
17474 (setcar (nthcdr 1 defdecode) 59)
17475 (setq def (apply 'encode-time defdecode)
17476 defdecode (decode-time def)))))
17477 (calendar-move-hook nil)
17478 (view-diary-entries-initially nil)
17479 (view-calendar-holidays-initially nil)
17480 (timestr (format-time-string
17481 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17482 (prompt (concat (if prompt (concat prompt " ") "")
17483 (format "Date+time [%s]: " timestr)))
17484 ans (org-ans0 "") org-ans1 org-ans2 final)
17486 (cond
17487 (from-string (setq ans from-string))
17488 (org-read-date-popup-calendar
17489 (save-excursion
17490 (save-window-excursion
17491 (calendar)
17492 (calendar-forward-day (- (time-to-days def)
17493 (calendar-absolute-from-gregorian
17494 (calendar-current-date))))
17495 (org-eval-in-calendar nil t)
17496 (let* ((old-map (current-local-map))
17497 (map (copy-keymap calendar-mode-map))
17498 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17499 (org-defkey map (kbd "RET") 'org-calendar-select)
17500 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17501 'org-calendar-select-mouse)
17539 ;; org-ans0: from prompt
17540 ;; org-ans1: from mouse click
17541 ;; org-ans2: from calendar motion
17569 "Display the currrent date prompt interpretation in the minibuffer."
17585 org-time-stamp-custom-formats
17586 org-time-stamp-formats))
17595 org-end-time-was-given
17602 "Analyze the combined answer of the date prompt."
17603 ;; FIXME: cleanup and comment
17605 hour minute second wday pm h2 m2 tl wday1)
17613 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17623 t nil ans)))
17624 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17625 ;; If there is a time with am/pm, and *no* time without it, we convert
17626 ;; so that matching will be successful.
17640 t t ans))))
17642 ;; Check if a time range is given as a duration
17643 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17651 ;; Check if there is a time range
17685 ;; Weekday was given, but no day, so pick that day in the week
17686 ;; on or after the derived date.
17700 "Check string S for special relative date string.
17701 TODAY and DEFAULT are internal times, for today and for a default.
17702 Return shift list (N what def-flag)
17704 N is the number of WHATs to shift.
17705 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17706 the DEFAULT date rather than TODAY."
17715 ?+))
17722 delta)
17732 "Eval FORM in the calendar window and return to current window.
17733 Also, store the cursor date in variable org-ans2."
17744 ; ;; Update the prompt to show new default date
17745 ; (save-excursion
17746 ; (goto-char (point-min))
17747 ; (when (and org-ans2
17748 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17749 ; (get-text-property (match-end 0) 'field))
17750 ; (let ((inhibit-read-only t))
17751 ; (replace-match (concat "[" org-ans2 "]") t t)
17752 ; (add-text-properties (point-min) (1+ (match-end 0))
17753 ; (text-properties-at (1+ (point-min)))))))))
17756 "Return to `org-read-date' with the date currently selected.
17757 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17766 "Insert a date stamp for the date given by the internal TIME.
17767 WITH-HM means, use the stamp format that includes the time of the day.
17768 INACTIVE means use square brackets instead of angular ones, so that the
17769 stamp will not contribute to the agenda.
17770 PRE and POST are optional strings to be inserted before and after the
17771 stamp.
17772 The command returns the inserted time stamp."
17774 stamp)
17791 stamp))
17794 "Toggle the use of custom time stamp formats."
17815 "Overlay modified time stamp format over timestamp between BED and END."
17842 "Translate all timestamps in STRING to custom format.
17843 But do this only if the variable `org-display-custom-times' is set."
17848 t1 with-hm inactive tf time str beg end)
17857 org-time-stamp-custom-formats)
17866 string)
17869 "Set 0 instead of nil for the first 6 elements of time.
17870 Don't touch the rest."
17875 "Difference between TIMESTAMP-STRING and now in days."
17880 "Is the time in TIMESTAMP-STRING close to the current date?"
17886 "Get the deadline lead time appropriate for timestring TS."
17889 ;; 0 or negative, enforce this value no matter what
17892 ;; lead time is specified.
17897 ;; go for the default.
17901 "Return to `org-read-date' with the date currently selected.
17902 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17912 "Check if there are any deadlines due or past due.
17913 A deadline is considered due if it happens within `org-deadline-warning-days'
17914 days from today's date. If the deadline appears in an entry marked DONE,
17915 it is not shown. The prefix arg NDAYS can be used to test that many
17930 org-warn-days)))
17933 "Check if there are deadlines or scheduled entries before DATE."
17947 "Evaluate a time range by computing the difference between start and end.
17948 Normally the result is just printed in the echo area, but with prefix arg
17949 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17950 If the time range is actually in a table, the result is inserted into the
17951 next column.
17952 For time difference computation, a year is assumed to be exactly 365
17953 days in order to avoid rounding problems."
17973 ;; (ys (floor (* 365 24 60 60)))
17981 y d h m align)
17984 y 0
17989 y 0
18027 "Convert a time stamp to an absolute day number.
18028 If there is a specifyer for a cyclic time stamp, get the closest date to
18029 DAYNR."
18033 daynr
18038 prefer))
18042 "Return the time corresponding to date D.
18043 D may be an absolute day number, or a calendar-type list (month day year)."
18048 "List of holidays, for Diary display in Org-mode."
18056 "Process a SEXP diary ENTRY for DATE."
18076 "Get iCalendar entries from diary entries in buffer FROMBUF.
18077 This uses the icalendar.el library."
18080 temporary-file-directory))
18083 buf rtn b e)
18099 rtn))
18102 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18103 When PREFER is `past' return a date that is either CURRENT or past.
18104 When PREFER is `future', return a date that is either CURRENT or future."
18105 ;; Make the proper lists from the dates
18108 dn dw sday cday n1 n2
18109 d m y y1 y2 date1 date2 nmonths nm ny m2)
18114 current
18138 ;; approx number of month between the tow dates
18140 ;; How often does dn fit in there?
18169 "Turn any specification of DATE into a gregorian date for the calendar."
18179 "Parse the standard Org-mode time string.
18180 This should be a lot faster than the normal `parse-time-string'.
18181 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18182 hour and minute fields will be nil if not given."
18192 nil nil nil)
18196 "Increase the date item at the cursor by one.
18197 If the cursor is on the year, change the year. If it is on the month or
18198 the day, change that.
18199 With prefix ARG, change by that many units."
18204 "Decrease the date item at the cursor by one.
18205 If the cursor is on the year, change the year. If it is on the month or
18206 the day, change that.
18207 With prefix ARG, change by that many units."
18212 "Increase the date in the time stamp by one day.
18213 With prefix ARG, change that many days."
18221 "Decrease the date in the time stamp by one day.
18222 With prefix ARG, change that many days."
18235 "Determine if the cursor is in or at a timestamp."
18261 ans))
18264 ""
18276 "Change the date in the time stamp at point.
18277 The date will be changed by N times WHAT. WHAT can be `day', `month',
18278 `year', `minute', `second'. If WHAT is not given, the cursor position
18279 in the timestamp determines what will be changed."
18281 with-hm inactive
18282 org-ts-what
18283 extra
18284 ts time time0)
18290 org-display-custom-times
18300 ts)
18328 ;; Try to recenter the calendar window, if any
18334 ;; FIXME: does not yet work for lead times
18336 "Change the different parts of the lead-time and repeat fields in timestamp."
18338 ng h m new)
18339 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18360 new
18362 s))
18365 "If the calendar is visible, recenter it to DATE."
18376 "Go to the Emacs calendar at the current date.
18377 If there is a time stamp in the current line, go to that date.
18378 A prefix ARG can be used to force the current date."
18397 "Return a list (month day year) of date at point in calendar."
18403 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18404 If there is already a time stamp at the cursor position, update it."
18412 ;; Make appt aware of appointments from the agenda
18413 ;;;###autoload
18415 "Activate appointments found in `org-agenda-files'.
18416 When prefixed, prompt for a regular expression and use it as a
18417 filter: only add entries if they match this regular expression.
18419 FILTER can be a string. In this case, use this string as a
18420 regular expression to filter results.
18422 FILTER can also be an alist, with the car of each cell being
18423 either 'headline or 'category. For example:
18428 will only add headlines containing IMPORTANT or headlines
18439 ;; Get all entries which may contain an appt
18444 file today
18447 ;; Map thru entries and find if they pass thru the filter
18460 ;; FIXME: Shall we remove text-properties for the appt text?
18461 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18473 ;;; The clock for measuring work time.
18498 "Start the clock on the current item.
18499 If necessary, clock-out of the currently active clock."
18507 org-clock-in-switch-to-state
18534 "Find the location where the next clock line should be inserted."
18540 first last)
18544 ;; we seem to have a CLOCK drawer, so go there.
18547 ;; Lets count the CLOCK lines
18555 ;; Wrap current entries into a new drawer
18573 ;; Planning info, skip to after it
18585 "Stop the currently running clock.
18586 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18625 "Cancel the running clock be removing the start timestamp."
18639 "Go to the currently clocked-in entry."
18656 "Sum the times for each subtree.
18657 Puts the resulting times in minutes as a text property on each headline."
18661 org-clock-string
18667 ts te dt
18668 time)
18675 ;; Two time stamps
18687 ;; A naket time
18704 "Show subtree times in the entire buffer.
18705 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18706 in the echo area."
18723 ;; Arrange to remove the overlays upon next change.
18733 "Put an overlays on the current line, displaying TIME.
18734 If LEVEL is given, prefix time with a corresponding number of stars.
18735 This creates a new overlay and stores it in `org-clock-overlays', so that it
18736 will be easy to remove."
18740 ov tx)
18759 "Remove the occur highlights from the buffer.
18760 BEG and END are ignored. If NOREMOVE is nil, remove this function
18761 from the `before-change-functions' in the current buffer."
18771 "Clock out if the current entry contains the running clock.
18772 This is used to stop the clock after a TODO entry is marked DONE,
18773 and is only done if the variable `org-clock-out-when-done' is not nil."
18779 org-clock-marker))
18780 ;; Clock out, but don't accept a logging message for this.
18784 org-log-done)))
18791 "Check if the current buffer contains the running clock.
18792 If yes, offer to stop it and to save the buffer with the changes."
18801 "Create a table containing a report about clocked time.
18802 If the cursor is inside an existing clocktable block, then the table
18803 will be updated. If not, a new clocktable will be inserted.
18804 When called with a prefix argument, move to the first clock table in the
18805 buffer and update it."
18816 "Check if the cursor is in a clocktable."
18824 start))))
18827 "If this is a CLOCK line, update it and return t.
18828 Otherwise, return nil."
18837 ts te h m s)
18839 nil
18853 t)))))
18856 "Return two times bordering a special time range.
18857 Key is a symbol specifying the range and can be one of `today', `yesterday',
18858 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18859 A week starts Monday 0:00 and ends Sunday 24:00.
18860 The range is determined relative to TIME. TIME defaults to the current time.
18861 The return value is a cons cell with two internal times like the ones
18862 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18863 the returned times will be formatted strings."
18868 s1 m1 h1 d1 month1 y1 diff ts te fm)
18898 "Write the standard clocktable."
18913 ipos time h m p level hlc hdl
18914 cc beg end pos tbl)
18928 ;; Get the right scope
18951 file)
18961 org-clock-file-total-minutes)))))))
18972 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
18993 "Clock summary at ["
18997 "]."
19010 "|"
19011 "*Total time*| "
19033 cc)
19067 x))
19068 lines)
19071 ;; FIXME: I don't think anybody uses this, ask David
19073 "Return an internal list with clocking information.
19074 This list has one entry for each CLOCK interval.
19075 FIXME: describe the elements."
19079 rtn beg end next cont level title total closedp leafp
19080 clockpos titlepos h m donep)
19105 total title titlepos level leafp)
19106 rtn)
19110 ;;;; Agenda, and Diary Integration
19112 ;;; Define the Org-agenda-mode
19126 "Mode for time-sorted view on action items in Org-mode files.
19128 The following commands are available:
19134 org-agenda-pending-undo-list nil)
19136 ;; Keep global-font-lock-mode from turning on font-lock-mode
19144 ;; Make sure properties are removed when copying text
19149 buffer-substring-filters)))
19152 org-agenda-show-log nil))
19159 "Restricted to single file"
19171 org-agenda-mode-map global-map)
19269 "--"
19276 "--"
19280 "--"
19285 "--"
19290 "--"
19295 "--"
19312 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19316 "--"
19318 "--"
19328 "--"
19330 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19334 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19338 "--"
19340 "--"
19343 ))
19345 ;;; Agenda undo
19357 "Execute BODY if there is no `org-protected' text property at point."
19363 "Execute BODY while recording undo information in two buffers."
19371 _c1 _c2)
19372 ,@_body
19379 ;; make sure there are undo boundaries
19382 ;; remember which buffer to undo
19384 org-agenda-undo-list)))))
19387 "Undo a remote editing step in the agenda.
19388 This undoes changes both in the agenda buffer and in the remote buffer
19389 that have been changed along."
19395 org-agenda-pending-undo-list org-agenda-undo-list))
19399 buf line cmd rembuf)
19421 "Verify that a real change occurred between the undo lists L1 and L2."
19426 ;;; Agenda dispatch
19434 ;;;###autoload
19436 "Dispatch agenda commands to collect entries to the agenda buffer.
19437 Prompts for a command to execute. Any prefix arg will be passed
19438 on to the selected command. The default selections are:
19440 a Call `org-agenda-list' to display the agenda for current day or week.
19441 t Call `org-todo-list' to display the global todo list.
19442 T Call `org-todo-list' to display the global todo list, select only
19443 entries with a specific TODO keyword (the user gets a prompt).
19444 m Call `org-tags-view' to display headlines with tags matching
19445 a condition (the user is prompted for the condition).
19446 M Like `m', but select only TODO entries, no ordinary headlines.
19447 L Create a timeline for the current buffer.
19448 e Export views to associated files.
19450 More commands can be added by configuring the variable
19451 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19452 searches can be pre-defined in this way.
19454 If the current buffer is in Org-mode and visiting a file, you can also
19455 first press `<' once to indicate that the agenda should be temporarily
19457 Pressing `<' twice means to restrict to the current subtree or region
19458 \(if active)."
19464 ;; normalize different versions
19470 nil)
19474 org-agenda-custom-commands)))
19477 entry key type match lprops ans)
19478 ;; Turn off restriction unless there is an overriding one
19484 ;; Delete old local properties
19486 ;; Remember where this call originated
19492 ;; Estabish the restriction, if any
19509 ;; For example the todo list should not need it (but does...)
19523 current-prefix-arg)))
19575 cmds)))
19578 "The user interface for selecting an agenda command."
19585 restriction second-time
19586 c entry key type match prefixes rmheader header-end custom1 desc)
19593 "
19594 Press key for an agenda command: < Buffer,subtree/region restriction
19595 -------------------------------- > Remove restriction
19596 a Agenda for current week or day e Export agenda views
19597 t List of all TODO entries T Entries with special TODO kwd
19598 m Match a TAGS query M Like m, but only TODO entries
19599 L Timeline for current buffer # List stuck projects (!=configure)
19600 / Multi-occur C Configure custom agenda commands
19605 header start)
19609 header)))
19661 prefix-descriptions))
19663 prefixes))
19674 " (restriction lock active)"
19687 prefixes nil
19693 nil
19695 custom))))
19712 nil)
19732 match ;; The byte compiler incorrectly complains about this. Keep it!
19733 cmd type lprops)
19764 ;;;###autoload
19766 "Run an agenda command in batch mode and send the result to STDOUT.
19767 If CMD-KEY is a string of length 1, it is used as a key in
19768 `org-agenda-custom-commands' and triggers this command. If it is a
19769 longer string it is used as a tags/todo match string.
19770 Paramters are alternating variable names and values that will be bound
19771 before running the agenda command."
19785 string))
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.
19798 The output gives a line for each selected agenda item. Each
19799 item is a list of comma-separated values, like this:
19801 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19803 category The category of the item
19804 head The headline, without TODO kwd, TAGS and PRIORITY
19805 type The type of the agenda entry, can be
19806 todo selected in TODO match
19807 tagsmatch selected in tags match
19808 diary imported from diary
19809 deadline a deadline on given date
19810 scheduled scheduled on given date
19811 timestamp entry has timestamp on given date
19812 closed entry was closed on given date
19813 upcoming-deadline warning about deadline
19814 past-scheduled forwarded scheduled item
19815 block entry has date block including g. date
19816 todo The todo keyword, if any
19817 tags All tags including inherited ones, separated by colons
19818 date The relevant date, like 2007-2-14
19819 time The time, like 15:00-16:50
19820 extra Sting with extra planning info
19821 priority-l The priority letter if any was given
19822 priority-n The computed numerical priority
19823 agenda-day The day in the agenda where this is listed"
19835 line)
19845 priority-letter priority agenda-day)
19850 "Make sure all properties on an agenda item have a canonical form,
19851 so the export commands can easily use it."
19878 props)
19892 ;;;###autoload
19897 ;; FIXME, why is this a macro?????
19898 ;;;###autoload
19900 "Run all custom agenda commands that have a file argument."
19904 pars cmd thiscmdkey files opts)
19927 "Write the current buffer (an agenda view) as a file.
19928 Depending on the extension of the file name, plain text (.txt),
19929 HTML (.html or .htm) or Postscript (.ps) is produced.
19930 If NOSETTINGS is given, do not scope the settings of
19931 `org-agenda-exporter-settings' into the export commands. This is used when
19932 the settings have already been scoped and we do not wish to overrule other,
19933 higher priority settings."
19949 ;; replace <style> section with org-agenda-export-html-style
19970 "Inhibit read-only for BODY."
19974 "Make sure current buffer is in org-mode. Error if not."
19977 major-mode)))
19980 "Fit the window to the buffer size."
19984 nil
19988 ;;; Agenda file list
19991 "Get the list of agenda files.
19992 Optional UNRESTRICTED means return the full list even if a restriction
19993 is currently in place."
20004 org-agenda-file-regexp)
20006 files)))
20012 files))
20016 "Edit the list of agenda files.
20017 Depending on setup, this either uses customize to edit the variable
20018 `org-agenda-files', or it visits the file that is holding the list. In the
20019 latter case, the buffer is set up in a way that saving it automatically kills
20020 the buffer and restores the previous window configuration."
20039 "Set new value for the agenda file list and save it correcly."
20050 "Read the list of agenda files from a file."
20057 ;;;###autoload
20059 "Cycle through the files in `org-agenda-files'.
20060 If the current buffer visits an agenda file, find the next one in the list.
20061 If the current buffer does not, find the first agenda file."
20066 file)
20078 "Move/add the current file to the top of the agenda file list.
20079 If the file is not present in the list, it is added to the front. If it is
20080 present, it is moved there. With optional argument TO-END, add/move to the
20081 end of the list."
20088 x had)
20101 "Remove current file from the list of files in variable `org-agenda-files'.
20102 These are the files which are being checked for agenda entries.
20103 Optional argument FILE means, use this file instead of the current."
20113 nil x))
20126 "Make sure FILE exists. If not, ask user what to do."
20137 ;;; Agenda prepare and finalize
20182 "Finishing touch for the agenda buffer, called just before displaying it."
20194 org-overriding-columns-format)
20196 org-overriding-columns-format))
20198 org-agenda-view-columns-initially)
20204 )))
20207 "Make highest priority lines bold, and lowest italic."
20214 b e p ov h l)
20218 org-highest-priority)
20220 org-lowest-priority)
20225 ov 'face
20233 "Create buffers for all agenda files, protect archived trees and comments."
20240 bmp file re)
20270 "Function to be called at each match during agenda construction.
20271 If this function returns nil, the current match should not be skipped.
20272 Otherwise, the function must return a position from where the search
20273 should be continued.
20274 This may also be a Lisp form, it will be evaluated.
20275 Never set this variable using `setq' or so, because then it will apply
20276 to all future agenda commands. Instead, bind it with `let' to scope
20277 it dynamically into the agenda-constructing command. A good way to set
20281 "Throw to `:skip' in places that should be skipped.
20282 Also moves point to the end of the skipped region, so that search can
20283 continue from there."
20309 "Return a new agenda marker.
20310 Org-mode keeps a list of these markers and resets them when they are
20311 no longer in use."
20315 m))
20318 "Reset markers created by `org-agenda'. But only if they are old enough."
20321 org-agenda-last-marker-time)
20327 "Get a buffer visiting FILE. If the buffer needs to be created, add
20328 it to the list of buffers which might be released later."
20331 buf ; just return it
20332 ;; Make a new buffer and remember it
20335 buf)))
20338 "Release all buffers in list, asking the user for confirmation when needed.
20339 When a buffer is unmodified, it is just killed. When modified, it is saved
20340 \(if the user agrees) and then killed."
20345 file
20351 "Get the category applying to position POS."
20354 ;;; Agenda timeline
20359 "Show a time-sorted view of the entries in the current org file.
20360 Only entries with a time stamp of today or later will be listed. With
20362 under the current date.
20363 If the buffer contains an active region, only check the region for
20364 dates."
20377 t doclosed ; always include today
20378 org-timeline-show-empty-dates))
20383 args
20384 s e rtn d emptyp)
20390 ;; Remove past dates from the list of dates.
20393 day-numbers))))
20410 dopast
20411 past)
20419 date args)))
20442 "Return a list of all relevant day numbers from BEG to END buffer positions.
20443 If NO-RANGES is non-nil, include only the start and end dates of a range,
20444 not every single day in the range. If FORCE-TODAY is non-nil, make
20445 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20446 inactive time stamps (those in square brackets) are included.
20447 When EMPTY is non-nil, also include days without any entries."
20451 dates dates1 date day day1 day2 ts1 ts2)
20481 dates)))
20483 ;;; Agenda Daily/Weekly
20494 ;;;###autoload
20496 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20497 The view will be for the current day or week, but from the overview buffer
20498 you will be able to go to other days/weeks.
20501 all unfinished TODO items will also be shown, before the agenda.
20502 This feature is considered obsolete, please use the TODO list or a block
20503 agenda instead.
20505 With a numeric prefix argument in an interactive call, the agenda will
20506 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20507 the number of days. NDAYS defaults to `org-agenda-ndays'.
20509 START-DAY defaults to TODAY, or to the most recent match for the weekday
20510 given in `org-agenda-start-on-weekday'."
20521 ;; Convert to an absolute day number
20529 org-agenda-start-on-weekday nil))
20538 sd
20547 s e rtn rtnall file date d start-pos end-pos todayp nd)
20550 ;; Make the list of days
20552 nd ndays)
20565 rtnall nil)
20593 rtnall nil)
20599 file date
20602 file date
20626 rtnall nd todayp))
20649 ;;; Agenda TODO list
20654 ;;;###autoload
20656 "Show all TODO entries from all agenda file in a single list.
20657 The prefix arg can be used to select a specific TODO keyword and limit
20659 for a keyword. A numeric prefix directly selects the Nth keyword in
20660 `org-todo-keywords-1'."
20674 rtn rtnall files file pos)
20684 rtnall nil)
20708 kwds))
20719 ;;; Agenda tags match
20721 ;;;###autoload
20723 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20724 The prefix arg TODO-ONLY limits the search to TODO entries."
20731 rtn rtnall files file pos matcher
20732 buffer)
20740 rtnall nil)
20748 ;; If file does not exist, merror message to agenda
20759 org-agenda-restrict-end)
20784 ;;; Agenda Finding stuck projects
20787 "Regular expression used in skipping subtrees for the agenda.
20788 This is basically a temporary global variable that can be set and then
20795 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20796 If yes, it returns the end position of this tree, causing agenda commands
20797 to skip this subtree. This is a function that can be put into
20798 `org-agenda-skip-function' for the duration of a command."
20800 skip)
20806 "Skip entry if any of CONDITIONS is true.
20807 See `org-agenda-skip-if' for details."
20811 "Skip entry if any of CONDITIONS is true.
20812 See `org-agenda-skip-if' for details."
20816 "Checks current entity for CONDITIONS.
20817 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20818 the entry, i.e. the text before the next heading is checked.
20820 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20821 from different tests. Valid conditions are:
20823 scheduled Check if there is a scheduled cookie
20824 notscheduled Check if there is no scheduled cookie
20825 deadline Check if there is a deadline
20826 notdeadline Check if there is no deadline
20827 regexp Check if regexp matches
20828 notregexp Check if regexp does not match.
20830 The regexp is taken from the conditions list, it must come right after
20831 the `regexp' or `notregexp' element.
20833 If any of these conditions is met, this function returns the end point of
20834 the entity, causing the search to continue from there. This is a function
20835 that can be put into `org-agenda-skip-function' for the duration of a command."
20859 end)))
20861 ;;;###autoload
20863 "Create agenda view for projects that are stuck.
20864 Stuck projects are project that have no next actions. For the definitions
20865 of what a project is and how to check if it stuck, customize the variable
20866 `org-stuck-projects'.
20867 MATCH is being ignored."
20870 ;; FIXME: we could have used org-agenda-skip-if here.
20878 org-done-keywords-for-agenda
20880 todo))
20897 gen-re)))))
20908 ;;; Diary integration
20913 "Get the (Emacs Calendar) diary entries for DATE."
20921 entries
20933 ;; No entries
20935 ;; Omit the date and other unnecessary stuff
20937 ;; Add prefix to each line and extend the text properties
20949 ;; Extend the text properties to the beginning of the line
20952 entries)))))
20955 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
20956 This gets rid of the date, the underline under the date, and
20957 the dummy entry installed by `org-mode' to ensure non-empty diary for each
20958 date. It also removes lines that contain only whitespace."
20975 ;; Make sure entries from the diary have the right text properties.
20978 ;; We can rely on the hook, nothing to do
20979 nil
20980 ;; Hook not avaiable, must use advice to make this work
20982 "Make the position visible."
20985 buffer-file-name)
20989 "Add text properties to string, allowing org-mode to act on it."
20992 'keymap org-agenda-keymap
20997 'org-agenda-diary-link t
21001 "Add a dummy entry to the diary.
21002 Needed to avoid empty dates which mess up holiday display."
21003 ;; Catch the error if dealing with the new add-to-diary-alist
21010 ;;;###autoload
21012 "Return diary information from org-files.
21014 It accesses org files and extracts information from those files to be
21015 listed in the diary. The function accepts arguments specifying what
21016 items should be listed. The following arguments are allowed:
21018 :timestamp List the headlines of items containing a date stamp or
21019 date range matching the selected date. Deadlines will
21020 also be listed, on the expiration day.
21022 :sexp List entries resulting from diary-like sexps.
21024 :deadline List any deadlines past due, or due within
21025 `org-deadline-warning-days'. The listing occurs only
21026 in the diary for *today*, not at any other date. If
21027 an entry is marked DONE, it is no longer listed.
21029 :scheduled List all items which are scheduled for the given date.
21030 The diary for *today* also contains items which were
21031 scheduled earlier and are not yet marked DONE.
21033 :todo List all TODO items from the org-file. This may be a
21034 long list - so this is not turned on by default.
21035 Like deadlines, these entries only show up in the
21036 diary for *today*, not at any other date.
21038 The call in the diary file should look like this:
21040 &%%(org-diary) ~/path/to/some/orgfile.org
21042 Use a separate line for each org file to check. Or, if you omit the file name,
21043 all files listed in `org-agenda-files' will be checked automatically:
21045 &%%(org-diary)
21047 If you don't give any arguments (as in the example above), the default
21048 arguments (:deadline :scheduled :timestamp :sexp) are used.
21049 So the example above may also be written as
21051 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21053 The function expects the lisp variables `entry' and `date' to be provided
21054 by the caller, because this is how the calendar works. Don't use this
21055 function from a program - use `org-agenda-get-day-entries' instead."
21063 file rtn results)
21065 ;; If this is called during org-agenda, don't return any entries to
21066 ;; the calendar. Org Agenda will list these entries itself.
21074 ;;; Agenda entry finders
21077 "Does the work for `org-diary' and `org-agenda'.
21078 FILE is the path to a file to be checked for entries. DATE is date like
21079 the one returned by `calendar-current-date'. ARGS are symbols indicating
21080 which kind of entries should be extracted. For details about these, see
21081 the documentation of `org-diary'."
21088 arg results rtn)
21090 ;; If file does not exist, make sure an error message ends up in diary
21100 org-agenda-restrict-end)
21102 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21126 results))))
21142 "Is the cursor inside a date range?"
21157 nil)))
21160 "Return the TODO information for agenda display."
21163 'org-not-done-regexp org-not-done-regexp
21164 'org-todo-regexp org-todo-regexp
21166 'keymap org-agenda-keymap
21167 'help-echo
21170 ;; FIXME: get rid of the \n at some point but watch out
21174 org-todo-regexp
21178 org-not-done-regexp)
21180 marker priority category tags
21181 ee txt beg end)
21220 "Return the date stamp information for agenda display."
21222 'org-not-done-regexp org-not-done-regexp
21223 'org-todo-regexp org-todo-regexp
21225 'keymap org-agenda-keymap
21226 'help-echo
21234 "<%Y-%m-%d"
21248 marker hdmarker deadlinep scheduledp donep tmp priority category
21249 ee txt timestr tags b0 b3 e3 head)
21267 b0)
21274 ;; substring should only run to end of time stamp
21286 nil head category tags timestr nil
21287 remove-re)))
21300 "Return the sexp information for agenda display."
21304 'keymap org-agenda-keymap
21305 'help-echo
21309 marker category ee txt tags entry result beg b sexp sexp-entry)
21341 "Return the logged TODO entries for agenda display."
21343 'org-not-done-regexp org-not-done-regexp
21344 'org-todo-regexp org-todo-regexp
21345 'keymap org-agenda-keymap
21346 'help-echo
21358 marker hdmarker priority category tags closedp
21359 ee txt timestr)
21368 ;; donep (org-entry-is-done-p)
21369 )
21371 ;; substring should only run to end of time stamp
21392 ; (outline-next-heading)))
21396 "Return the deadline information for agenda display."
21398 'org-not-done-regexp org-not-done-regexp
21399 'org-todo-regexp org-todo-regexp
21400 'keymap org-agenda-keymap
21401 'help-echo
21407 d2 diff dfrac wdays pos pos1 category tags
21408 ee txt head face s upcomingp donep timestr)
21420 ;; When to show a deadline in the calendar:
21421 ;; If the expiration is within wdays warning time.
21422 ;; Past-due deadlines are only shown on the current date
21450 diff))
21451 head category tags timestr))))
21460 'org-category category
21469 "Return the face to displaying a deadline item.
21470 FRACTION is what fraction of the head-warning time has passed."
21477 "Return the scheduled information for agenda display."
21479 'org-todo-regexp org-todo-regexp
21482 'keymap org-agenda-keymap
21483 'help-echo
21489 d2 diff pos pos1 category tags
21490 ee txt head pastschedp donep face timestr s)
21498 ;;; is this right?
21499 ;;; do we need to do this for deadleine too????
21500 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21503 ;; When to show a scheduled item in the calendar:
21504 ;; If it is on or past the date.
21532 head category tags timestr))))
21536 'org-scheduled-previously
21539 'undone-face face
21551 "Return the date-range information for agenda display."
21553 'org-not-done-regexp org-not-done-regexp
21554 'org-todo-regexp org-todo-regexp
21556 'keymap org-agenda-keymap
21557 'help-echo
21562 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21563 donep head)
21575 ;; Only allow days between the limits, because the normal
21576 ;; date stamps will catch the limits.
21593 head category tags
21602 ;; Sort the entries by expiration date.
21605 ;;; Agenda presentation and sorting
21615 "Regular expression to match a plain time or time range.
21616 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21617 groups carry important information:
21618 0 the full match
21619 1 the first time, range or not
21627 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21628 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21629 groups carry important information:
21630 0 the full match
21631 7 hours of duration
21640 "Regular expression to match a timestamp time or time range.
21641 After a match, the following groups carry important information:
21642 0 the full match
21643 1 date plus weekday, for backreferencing to make sure both times on same day
21644 2 the first time, range or not
21648 "A flag, set by `org-compile-prefix-format'.
21651 "A flag, set by `org-compile-prefix-format'.
21655 noprefix remove-re)
21656 "Format TXT to be inserted into the agenda buffer.
21657 In particular, it adds the prefix and corresponding text properties. EXTRA
21658 must be a string and replaces the `%s' specifier in the prefix format.
21659 CATEGORY (string, symbol or nil) may be used to overrule the default
21660 category taken from local variable or file name. It will replace the `%c'
21661 specifier in the format. DOTIME, when non-nil, indicates that a
21662 time-of-day should be extracted from TXT for sorting of this entry, and for
21663 the `%t' specifier in the format. When DOTIME is a string, this string is
21664 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21665 only the correctly processes TXT should be returned - this is used by
21666 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21667 Any match of REMOVE-RE will be removed from TXT."
21669 ;; Diary entries sometimes have extra whitespace at the beginning
21672 org-category
21678 time ; time and tag are needed for the eval of the prefix format
21681 stamp plain s0 s1 s2 rtn srp)
21683 ;; Extract starting and ending time and move them to prefix
21691 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21692 ;; them, we might want to remove them there to avoid duplication.
21693 ;; The user can turn this off with a variable.
21699 t))
21701 ;; Normalize the time(s) to 24 hour
21709 org-agenda-default-appointment-duration))
21710 h)
21715 txt)
21716 ;; Tags are in the string
21719 org-prefix-has-tag))
21724 t t txt))))
21730 ;; Create the final string
21733 ;; Prepare the variables needed in the eval of the compiled format
21739 ;; Evaluate the compiled format
21742 ;; And finally add the text properties
21745 'org-highest-priority org-highest-priority
21746 'org-lowest-priority org-lowest-priority
21748 'time-of-day time-of-day
21749 'txt txt
21750 'time time
21751 'extra extra
21766 list)))
21771 new time)
21773 ;; don't show empty grid
21779 nil string "" nil
21781 new)
21789 "Compile the prefix format into a Lisp form that can be evaluated.
21790 The resulting form is returned and stored in the variable
21791 `org-prefix-format-compiled'."
21795 org-agenda-prefix-format)
21800 varform vars var e c f opt)
21802 s start)
21815 ""
21825 ;; the old format
21833 "Check string S for a time of day.
21834 If found, return it as a military time number between 0 and 2400.
21835 If not found, return nil.
21836 The optional STRING argument forces conversion into a 5 character wide string
21837 HH:MM."
21859 "Sort and concatenate the agenda items."
21862 list
21881 ; (and re (equal (string-match (concat "\\(\\.*\\)" re) x (or pl 0)) pl)
21882 ; (add-text-properties
21883 ; (or (match-end 1) (match-end 0)) (match-end 0)
21884 ; (list 'face (org-get-todo-face (match-string 2 x)))
21885 ; x))
21892 x)
21896 " "
21898 x)))
21901 "Compare the priorities of string A and B."
21909 "Compare the string values of categories of strings A and B."
21917 "Compare the string values of categories of strings A and B."
21927 "Compare the time-of-day values of strings A and B."
21936 "Predicate for sorting agenda entries."
21937 ;; The following variables will be used when the form is evaluated.
21938 ;; So even though the compiler complains, keep them.
21952 ;;; Agenda restriction lock
21970 "Set restriction lock for agenda, to current subtree or file.
21971 Restriction will be the file if TYPE is `file', or if type is the
21972 universal prefix '(4), or if the cursor is before the first headline
21973 in the file. Otherwise, restriction will be to the current subtree."
22005 "Remove the agenda restriction lock."
22019 "If there is any window showing the agenda view, update it."
22028 org-agenda-overriding-restriction)
22031 ;;; Agenda commands
22034 "Check if agenda buffer is of allowed type.
22035 If ERROR is non-nil, throw an error, otherwise just return nil."
22037 t
22040 nil)))
22043 "Exit agenda by removing the window or the buffer."
22050 ;; Maybe restore the pre-agenda window configuration.
22053 org-pre-agenda-window-conf
22057 "Exit agenda by removing the window or the buffer.
22058 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22059 Org-mode buffers visited directly by the user will not be touched."
22073 "Save all Org-mode buffers without user confirmation."
22080 "Rebuild Agenda.
22081 When this is the global TODO list, a prefix argument will be interpreted."
22090 org-agenda-pending-undo-list nil)
22096 "Jump to DATE in agenda."
22101 "Go to today."
22127 "Go forward in time by thee current span.
22128 With prefix ARG, go forward that many times the current span."
22135 greg2 nd)
22157 "Go backward in time by the current span.
22158 With prefix ARG, go backward that many times the current span."
22163 "Switch to daily view for agenda."
22168 "Switch to daily view for agenda."
22173 "Switch to daily view for agenda."
22177 "Switch to daily view for agenda."
22184 "Change the agenda view to SPAN.
22185 SPAN may be `day', `week', `month', `year'."
22190 org-starting-day))
22201 "Compute starting date and number of days for agenda.
22202 SPAN may be `day', `week', `month', `year'. The return value
22203 is a cons cell with the starting date and the number of days,
22204 so that the date SD will be in that range."
22206 nd)
22223 sd)))
22229 sd))))
22232 ;; FIXME: does not work if user makes date format that starts with a blank
22234 "Jump to the next line indicating a date in agenda buffer."
22246 "Jump to the previous line indicating a date in agenda buffer."
22253 ;; Initialize the highlight
22258 "Highlight a region with overlay."
22263 "Detach overlay INDEX."
22266 ;; FIXME this is currently not used.
22275 "Toggle follow mode in an agenda buffer."
22283 "Toggle log mode in an agenda buffer."
22293 "Toggle diary inclusion in an agenda buffer."
22303 "Toggle time grid in an agenda buffer."
22313 "Set the mode name to indicate all the small mode settings."
22332 "Show the priority of the current item.
22333 This priority is composed of the main priority given with the [#A] cookies,
22334 and by additional input from the age of a schedules or deadline entry."
22340 "Show the tags applicable to the current item."
22349 "Go to the Org-mode file which contains the item at point."
22368 "Normal hook run after an item has been shown from the agenda.
22372 "Kill the entry or subtree belonging to the current agenda entry."
22405 "Kill the entry or subtree belonging to the current agenda entry."
22423 "Remove all lines in the agenda that correspond to a given subtree.
22424 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22425 If this information is not given, the function uses the tree at point."
22448 "Follow the link in the current line, if any."
22457 "Get a variable from a referenced buffer and install it here."
22464 "Go to the Org-mode file which contains the item at point."
22481 "Go to the Org-mode file which contains the item at the mouse click."
22487 "Display the Org-mode file which contains the item at point."
22494 "Display the Org-mode file which contains the item at point and recenter."
22502 "Display the Org-mode file which contains the item at the mouse click."
22508 "Check if the entry is a diary link and abort if yes."
22516 "Show the subtree corresponding to the current entry in an indirect buffer.
22517 This calls the command `org-tree-to-indirect-buffer' from the original
22518 Org-mode buffer.
22519 With numerical prefix arg ARG, go up to this level and then take that tree.
22520 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22521 dedicated frame)."
22534 "Marker pointing to the headline that last changed its TODO state
22538 "Switch TODO entry to next sequence."
22543 "Switch TODO entry to previous sequence."
22548 "Cycle TODO state of line at point, also in Org-mode file.
22549 This changes the line at point, all other lines in the agenda referring to
22550 the same tree node, and the headline of the tree node in the Org-mode file."
22560 newhead)
22581 "Change all lines in the agenda buffer which match HDMARKER.
22582 The new content of the line will be NEWHEAD (as modified by
22583 `org-format-agenda-item'). HDMARKER is checked with
22584 `equal' against all `org-hd-marker' text properties in the file.
22585 If FIXFACE is non-nil, the face of each item is modified acording to
22586 the new TODO state."
22588 props m pl undone-face done-face finish new dotime cat tags)
22618 undone-face done-face))))
22626 "Align all tags in agenda items to `org-agenda-tags-column'."
22639 org-agenda-tags-column))
22647 "Increase the priority of line at point, also in Org-mode file."
22652 "Decrease the priority of line at point, also in Org-mode file."
22657 "Set the priority of line at point, also in Org-mode file.
22658 This changes the line at point, all other lines in the agenda referring to
22659 the same tree node, and the headline of the tree node in the Org-mode file."
22668 newhead)
22684 "Get a list of all headline tags applicable at POS.
22685 POS defaults to point. If tags are inherited, the list contains
22686 the targets in the same sequence as the headlines appear, i.e.
22687 the tags of the current headline come last."
22702 tags)))
22706 tags)))
22708 ;; FIXME: should fix the tags property of the agenda line.
22710 "Set tags for the current headline."
22721 newhead)
22739 "Toggle the archive tag for the current entry."
22748 newhead)
22764 "Change the date of this item to one day later."
22783 "Change the date of this item to one day earlier."
22788 "Show new date stamp via text properties."
22789 ;; We use text properties to make this undoable
22798 ;; Use `duplicable' property to trigger undo recording
22813 "Change the date of this item. Date is prompted for, with default today.
22814 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22815 be used to request time specification in the time stamp."
22833 "Schedule the item at point."
22842 ts)
22852 "Schedule the item at point."
22861 ts)
22871 "Return the heading of the current entry, without the stars."
22881 "Start the clock on the currently selected item."
22894 "Stop the currently running clock."
22902 "Cancel the currently running clock."
22910 "Make a diary entry, like the `i' command from the calendar.
22911 All the standard commands work: block, weekly etc."
22927 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
22936 ;; We implement this by hacking the `calendar-cursor-to-date' function
22937 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
22953 "Execute a calendar command from the agenda, with the date associated to
22954 the cursor position."
22963 ;; the following 3 vars are needed in the calendar
22977 "Display the phases of the moon for the 3 months around the cursor date."
22982 "Display the holidays for the 3 months around the cursor date."
22987 "Display sunrise and sunset for the cursor date.
22988 Latitude and longitude can be specified with the variables
22989 `calendar-latitude' and `calendar-longitude'. When called with prefix
22990 argument, latitude and longitude will be prompted for."
22999 "Open the Emacs calendar with the date at the cursor."
23012 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23013 This is a command that has to be installed in `calendar-mode-map'."
23017 nil))
23023 date s)
23049 ;;;; Embedded LaTeX
23064 "Toggle the minor `org-cdlatex-mode'.
23065 This mode supports entering LaTeX environment and math in LaTeX fragments
23066 in Org-mode.
23068 nil " OCDL" nil
23073 "Always return t in org-mode buffers.
23074 This is because we want to insert math symbols without dollars even outside
23075 the LaTeX math segments. If Orgmode thinks that point is actually inside
23076 en embedded LaTeX fragement, let texmathp do its job.
23093 "Unconditionally turn on `org-cdlatex-mode'."
23097 "Test if point is inside a LaTeX fragment.
23099 sequence appearing also before point.
23100 Even though the matchers for math are configurable, this function assumes
23102 delimiters are skipped when they have been removed by customization.
23103 The return value is nil, or a cons cell with the delimiter and
23104 and the position of this delimiter.
23106 This function does a reasonably good job, but can locally be fooled by
23107 for example currency specifications. For example it will assume being in
23109 fragments that are properly closed, but during editing, we have to live
23110 with the uncertainty caused by missing closing delimiters. This function
23111 looks only before point, not after."
23130 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23134 ;; count $$
23142 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23143 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23144 - inside a LaTeX fragment, or
23145 - after the first word in a line, where an abbreviation expansion could
23146 insert a LaTeX environment."
23159 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23160 Revert to the normal definition outside of these fragments."
23168 "Execute `cdlatex-math-modify' in LaTeX fragments.
23169 Revert to the normal definition outside of these fragments."
23181 "Remove all overlays with LaTeX fragment images in current buffer."
23186 "Preview the LaTeX fragment at point, or all locally or globally.
23187 If the cursor is in a LaTeX fragment, create the image and overlay
23188 it over the source code. If there is no fragment at point, display
23189 all fragments in the current text, from one headline to the next. With
23190 prefix SUBTREE, display all fragments in the current subtree. With a
23191 double prefix `C-u C-u', or when the cursor is before the first headline,
23192 display all fragments in the buffer.
23222 buffer-file-name)))
23228 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23229 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23230 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23237 "Replace LaTeX fragments with links to an image, and produce images."
23246 m n block linkfile movefile ov)
23247 ;; Check if there are old images files with this prefix, and remove them
23251 todir 'full
23253 ;; Check the different regular expressions
23273 txt movefile opt forbuffer)
23281 ov 'end-glyph
23284 ov 'display
23291 ;; This function borrows from Ganesh Swami's latex2png.el
23295 temporary-file-directory))
23324 "-D" dpi
23325 ;;"-x" scale "-y" scale
23327 "-o" pngfile
23328 dvifile)
23331 ;; Use the requested file name and clean up
23335 pngfile))))
23338 "Return an rgb color specification for dvipng."
23344 "Return string to be used as color value for an RGB component."
23347 ;;;; Exporting
23349 ;;; Variables, constants, and parameter plists
23405 "Return the property list with default settings for the export variables."
23409 rtn))
23412 "Return the property list with file-local settings for export."
23419 p key val text options)
23452 o)
23456 options)
23460 p))))
23466 val)))
23467 dir))
23474 rtn line level)
23479 ;; Beginning of a COMMENT subtree. Skip it.
23485 ;; an ordinary comment line
23486 )
23492 ;; a special table line that should be removed
23493 )
23500 \[v] limit export to visible part of outline tree
23502 \[a] export as ASCII
23504 \[h] export as HTML
23505 \[H] export as HTML to temporary buffer
23506 \[R] export region as HTML
23507 \[b] export as HTML and browse immediately
23508 \[x] export as XOXO
23510 \[l] export as LaTeX
23511 \[L] export as LaTeX to temporary buffer
23513 \[i] export current file as iCalendar file
23514 \[I] export all agenda files as iCalendar files
23515 \[c] export agenda files into combined iCalendar file
23517 \[F] publish current file
23518 \[P] publish current project
23519 \[X] publish... (project will be prompted for)
23539 r1 r2 ass)
23842 )
23843 "Entities for TeX->HTML translation.
23847 The list contains HTML entities for Latin-1, Greek and other symbols.
23848 It is supplemented by a number of commonly used TeX macros with appropriate
23851 ;;; General functions for all backends
23854 "Cleanup a buffer STRING so that links can be created safely."
23872 a b xx
23873 rtn p)
23877 ;; Remove license-to-kill stuff
23885 ;; Get the correct stuff before the first headline
23896 ;; Get rid of archived trees
23908 ;; Get rid of drawers
23913 'identity
23921 ;; Find targets in comments and move them out of comments,
23922 ;; but mark them as targets that should be invisible
23927 ;; Protect backend specific stuff, throw away the others.
23932 fmt)
23963 ;; Protect quoted subtrees
23971 ;; Protect verbatim elements
23978 ;; Remove subtrees that are commented
23984 ;; Remove special table lines
23996 ;; Specific LaTeX stuff
24004 ;; Specific HTML stuff
24006 ;; Convert LaTeX fragments to images
24011 org-current-export-file)))
24015 ;; Remove or replace comments
24024 ;; Find matches for radio targets and turn them into internal links
24031 ;; Find all links that contain a newline and put them into a single line
24033 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24039 ;; Normalize links: Convert angle and plain links into bracket links
24040 ;; Expand link abbreviations
24047 ;; added 'org-link face to links
24063 "]"
24071 ;; Find multiline emphasis and put them into single line
24085 rtn))
24088 "Get a title for the current document, from looking at the buffer."
24094 ;; Mark the line so that it will not be exported as normal text.
24098 ;; Return the title string
24102 "Return subtree title and exclude it from export."
24108 ;; This is a subtree, we take the title from the first heading
24115 title))
24118 "Take link text and make a safe target out of it."
24122 'identity
24128 "Get the minimum level in LINES."
24136 ;; Variable holding the vector with section numbers
24140 "Initialize the vector for the section numbers."
24157 "Return a string with the current section number.
24158 When LEVEL is non-nil, increase section numbers on that level."
24180 string))
24182 ;;; ASCII export
24190 "Export the outline as a pretty ASCII file.
24191 If there is an active region, export only the region.
24192 The prefix ARG specifies how many levels of the outline should become
24193 underlined headlines. The default is 3."
24222 filename))
24238 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24247 region
24248 :for-ascii t
24249 :skip-before-1st-heading
24252 :verbatim-multiline t
24253 :archived-trees
24257 thetoc have-headings first-heading-pos
24258 table-open table-buffer)
24276 ;; create local variables for all options, to make sure all called
24277 ;; functions get the correct information
24281 org-export-plist-vars)
24284 org-export-headline-levels))
24287 umax))
24289 ;; File header
24293 org-export-author-info)
24315 line)
24316 ;; This is a headline
24322 todo
24326 org-done-keywords)))
24327 ; TODO, not DONE
24331 line lines level))))
24338 t t txt)))
24343 txt))
24358 thetoc)
24360 ))))
24361 lines)
24366 ;; Remove the quoted HTML tags.
24368 ;; Remove targets
24371 ;; Replace internal links
24375 t nil line)))
24380 ;; a Headline
24389 ;; New table starts
24391 ;; Accumulate lines
24412 ;; insert the table of contents
24424 ;; Convert whitespace place holders
24434 ;; remove display and invisible chars
24450 "Do extra work for ASCII export"
24460 "Search the subtree below LINE for any TODO entries."
24463 line lv todo)
24471 org-done-keywords))))
24472 ; TODO, not DONE
24477 "Handle quoted HTML for ASCII export."
24480 ;; We just remove the tags for now.
24482 line)
24485 "Insert the string S centered and underline it with character UNDERLINE."
24494 "Insert a new level in ASCII export."
24500 org-export-ascii-bullets))
24502 ;; find the indentation of the next non-empty line
24523 "Create a copy of the visible part of the current buffer, and export it.
24524 The copy is created in a temporary buffer and removed after use.
24525 TYPE is the final key (as a string) that also select the export command in
24526 the `C-c C-e' export dispatcher.
24527 As a special case, if the you type SPC at the prompt, the temporary
24528 org-mode file will not be removed but presented to you so that you can
24529 continue to use it. The prefix arg ARG is passed through to the exporting
24530 command."
24533 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24535 current-prefix-arg))
24550 s e)
24551 ;; Need to hack the drawers here.
24567 ;; Copy all comment lines to the end, to make sure #+ settings are
24568 ;; still available for the second export step. Kind of a hack, but
24569 ;; does do the trick.
24590 s))
24595 s))
24597 ;;; HTML export
24600 "Return a string with current options as keyword options.
24601 Does include HTML export options as well as TODO and CATEGORY stuff."
24603 "#+TITLE: %s
24604 #+AUTHOR: %s
24605 #+EMAIL: %s
24606 #+LANGUAGE: %s
24607 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24608 #+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
24609 #+CATEGORY: %s
24610 #+SEQ_TODO: %s
24611 #+TYP_TODO: %s
24612 #+PRIORITIES: %c %c %c
24613 #+DRAWERS: %s
24614 #+STARTUP: %s %s %s %s %s
24615 #+TAGS: %s
24616 #+ARCHIVE: %s
24617 #+LINK: %s
24618 "
24620 org-export-headline-levels
24621 org-export-with-section-numbers
24622 org-export-with-toc
24623 org-export-preserve-breaks
24624 org-export-html-expand
24625 org-export-with-fixed-width
24626 org-export-with-tables
24627 org-export-with-sub-superscripts
24628 org-export-with-special-strings
24629 org-export-with-footnotes
24630 org-export-with-emphasize
24631 org-export-with-TeX-macros
24632 org-export-with-LaTeX-fragments
24633 org-export-skip-text-before-1st-heading
24634 org-export-with-drawers
24635 org-export-with-tags
24637 "TODO FEEDBACK VERIFY DONE"
24638 "Me Jason Marie DONE"
24639 org-highest-priority org-lowest-priority org-default-priority
24658 org-archive-location
24659 "org file:~/org/%s.org"
24660 ))
24663 "Insert into the buffer a template with information for exporting."
24672 "Toggle the fixed-width export.
24673 If there is no active region, the QUOTE keyword at the current headline is
24674 inserted or removed. When present, it causes the text between this headline
24675 and the next to be exported as fixed-width text, and unmodified.
24676 If there is an active region, this command adds or removes a colon as the
24677 first character of this line. If the first character of a line is a colon,
24678 this line is also exported in fixed-width font."
24687 off)
24717 "Export the outline as HTML and immediately open it with a browser.
24718 If there is an active region, export only the region.
24719 The prefix ARG specifies how many levels of the outline should become
24720 headlines. The default is 3. Lower levels will become bulleted lists."
24726 "Call `org-export-as-html', may be used in batch processing as
24727 emacs --batch
24728 --load=$HOME/lib/emacs/org.el
24730 --visit=MyFile --funcall org-export-as-html-batch"
24734 "Call `org-exort-as-html` with output to a temporary buffer.
24735 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24741 "Assume the current region has org-mode syntax, and convert it to HTML.
24742 This can be used in any buffer. For example, you could write an
24743 itemized list in org-mode syntax in an HTML buffer and then use this
24744 command to convert it."
24764 "Convert region from BEG to END in org-mode buffer to HTML.
24765 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24766 contents, and only produce the region of converted text, useful for
24767 cut-and-paste operations.
24768 If BUFFER is a buffer or a string, use/create that buffer as a target
24769 of the converted HTML. If BUFFER is the symbol `string', return the
24770 produced HTML as a string and leave not buffer behind. For example,
24771 a Lisp program could call this function in the following way:
24773 (setq html (org-export-region-as-html beg end t 'string))
24775 When called interactively, the output buffer is selected, and shown
24776 in a window. A non-interactive call will only retunr the buffer."
24781 rtn)
24786 nil nil nil
24787 buffer body-only))
24791 rtn)))
24795 to-buffer body-only)
24796 "Export the outline as a pretty HTML file.
24797 If there is an active region, export only the region. The prefix
24798 ARG specifies how many levels of the outline should become
24799 headlines. The default is 3. Lower levels will become bulleted
24800 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24801 EXT-PLIST is a property list with external parameters overriding
24802 org-mode's default settings, but still inferior to file-local
24803 settings. When TO-BUFFER is non-nil, create a buffer with that
24804 name and export to that buffer. If TO-BUFFER is the symbol `string',
24805 don't leave any buffer behind but just return the resulting HTML as
24806 a string. When BODY-ONLY is set, don't produce the file header and footer,
24807 simply return the content of <body>...</body>, without even
24808 the body tags themselves."
24811 ;; Make sure we have a file name when we need it.
24817 buffer-file-name))
24826 ext-plist
24831 valid thetoc have-headings first-heading-pos
24840 ;; The following two are dynamically scoped into other
24841 ;; routines below.
24860 default-directory))
24894 buffer-file-coding-system))
24896 coding-system))
24898 coding-system))
24910 region
24911 :emph-multiline t
24912 :for-html t
24913 :skip-before-1st-heading
24916 :archived-trees
24918 :add-text
24920 :LaTeX-fragments
24923 table-open type
24924 table-buffer table-orig-buffer
24925 ind start-is-num starter didclose
24926 rpl path desc descp desc1 desc2 link
24927 )
24946 ;; Get the language-dependent settings
24950 ;; Switch to the output buffer
24960 ;; create local variables for all options, to make sure all called
24961 ;; functions get the correct information
24965 org-export-plist-vars)
24967 org-export-headline-levels))
24970 umax))
24972 ;; File header
24978 <head>
24979 <title>%s</title>
24984 %s
24985 </head><body>
24986 "
24999 org-export-html-toplevel-hlevel
25001 org-export-html-toplevel-hlevel)
25002 thetoc)
25007 ;; This is a headline
25016 todo
25020 org-done-keywords)))
25021 ; TODO, not DONE
25025 line lines level))))
25050 ;; Check for targets
25055 t t line))
25058 target-alist))
25069 )))
25070 line)
25071 lines))
25083 ;; end of quote section?
25087 ;; inside a quote section?
25092 ;; verbatim lines
25106 ;; Protected HTML
25121 ;; Horizontal line
25126 ;; make targets to anchors
25134 t t line)))
25138 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25139 t t line)))
25145 t t line)))))
25149 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25150 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25151 ;; Also handle sub_superscripts and checkboxes
25155 ;; Format the links
25165 ;; Make an image out of the description if that is so wanted
25171 ;; FIXME: do we need to unescape here somewhere?
25181 ;; standard URL, just check if we need to inline an image
25189 ;; standard URL
25193 ;; FILE link
25196 thefile file-is-image-p search)
25204 t))
25213 ;; make sure this is can be used as target search
25238 ;; TODO items
25246 org-done-keywords)
25251 ;; Does this contain a reference to a footnote?
25263 t t line))))))
25267 ;; This is a headline
25275 ;; Close any local lists before inserting a new header line
25281 in-local-list nil))
25285 head-count)
25286 ;; QUOTES
25294 ;; New table starts
25296 ;; Accumulate lines
25308 ;; Normal lines
25311 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25312 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25315 line)
25322 ;; empty line. Pretend indentation is large.
25324 0
25340 ;; Start new (level of) list
25347 ;; continue current list
25351 ;; we did close a list, normal text follows: need <p>
25357 "<b>[X]</b>"
25359 t t line))))
25361 ;; Empty lines start a new paragraph. If hand-formatted lists
25362 ;; are not fully interpreted, lines starting with "-", "+", "*"
25363 ;; also start a new paragraph.
25366 ;; Is this the start of a footnote?
25372 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25374 ;; Check if the line break needs to be conserved
25383 ;; Properly close all local lists and other lists
25386 ;; Close any local lists before inserting a new header line
25392 in-local-list nil))
25395 head-count)
25426 ;; insert the table of contents
25443 ;; remove empty paragraphs and lists
25450 ;; Convert whitespace place holders
25471 "Format a table for ascii export."
25475 ;; Table made by table.el - test for spanning
25476 lines
25478 ;; A normal org table
25479 ;; Get rid of hlines at beginning and end
25485 ;; Check if the table has a marking column. If yes remove the
25486 ;; column and the special lines
25488 ;; Get rid of the vertical lines except for grouping
25490 rtn line vl1 start)
25512 vl))
25515 "Find out which HTML converter to use and return the HTML code."
25519 ;; A normal org table
25521 ;; Table made by table.el - test for spanning
25525 nil))
25526 lines)))
25532 hlines))))
25535 ;; We can use my own converter with HTML conversions
25537 ;; Need to use the code generator in table.el, with the original text.
25541 "Format a table into HTML."
25542 ;; Get rid of hlines at beginning and end
25548 ;; Check if the table has a marking column. If yes remove the
25549 ;; column and the special lines
25557 tbopen line fields html gr colgropen)
25569 ;; ignore this line
25571 ;; Break the line into fields
25589 html)))
25594 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25610 html)
25616 "Check if the table has a marking column.
25617 If yes remove the column and the special lines."
25623 lines))
25638 nil)
25640 lines)))
25654 nil)
25659 ;; remove the first column
25661 lines))))
25664 "Format a table generated by table.el into HTML.
25665 This conversion does *not* use `table-generate-source' from table.el.
25666 This has the advantage that Org-mode's HTML conversions can be used.
25667 But it has the disadvantage, that no cell- or row-spanning is allowed."
25670 fields html empty)
25680 html
25682 html
25683 "<tr>"
25696 ;; Ignore this line
25698 ;; Break the line into fields and store the fields
25704 field-buffer))
25707 html))
25710 "Format a table into html, using `table-generate-source' from table.el.
25711 This has the advantage that cell- or row-spanning is allowed.
25712 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25727 "Format time stamps in string S, or remove them."
25732 ;; never export CLOCK
25747 ;; Line break if line started and ended with time stamp stuff
25749 s
25753 r))))
25756 ;; convert & to &, < to < and > to >
25765 s)
25768 "Remove tags and time staps from lines going into the toc."
25777 t t s)))
25778 s)
25781 "Prepare STRING for HTML export. Applies all active conversions.
25782 If there are links in the string, don't modify these."
25785 m s l res)
25796 "Apply all active conversions to translate special ASCII to HTML."
25817 t t s))
25819 s)
25822 "Create a regular expression which will match a balanced sexp.
25823 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25824 as single character strings.
25825 The regexp returned will match the entire expression including the
25826 delimiters. It will also define a single group which contains the
25827 match except for the outermost delimiters. The maximum depth of
25828 stacked delimiters is N. Escaping delimiters is not possible."
25864 "Convert special characters in STRING to HTML."
25866 e a re rpl start)
25873 string))
25876 "Convert sub- and superscripts in STRING to HTML."
25892 t t string)))))
25895 string))
25898 "Apply emphasis."
25905 rpl
25911 org-emphasis-alist))
25916 string))
25920 "Insert <p>, but first close previous paragraph if any."
25925 "Close paragraph if there is one open."
25930 "Close <li> if necessary."
25936 "Insert a new level in HTML export.
25937 When TITLE is nil, just close all open levels."
25947 ;; If title is nil, this means this function is called to close
25948 ;; all levels, so the rest is done only if title is given
25960 t t title)))
25976 level level head-count title level))
25981 "Terminate one level in HTML export."
25987 ;;; iCalendar export
25989 ;;;###autoload
25991 "Export current file as an iCalendar file.
25992 The iCalendar file will be located in the same directory as the Org-mode
25993 file, but with extension `.ics'."
25997 ;;;###autoload
25999 "Export all files in `org-agenda-files' to iCalendar .ics files.
26000 Each iCalendar file will be located in the same directory as the Org-mode
26001 file, but with extension `.ics'."
26005 ;;;###autoload
26007 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26008 The file is stored under the name `org-combined-agenda-icalendar-file'."
26013 "Create iCalendar files for all elements of FILES.
26014 If COMBINE is non-nil, combine all calendar entries into a single large
26015 file and store it under the name `org-combined-agenda-icalendar-file'."
26020 org-export-publishing-directory)))
26021 file ical-file ical-buffer category started org-agenda-new-buffers)
26027 org-combined-agenda-icalendar-file
26060 "Hook run after an iCalendar file has been saved.
26061 The iCalendar buffer is still current when this hook is run.
26062 A good way to use this is to tell a desktop calenndar application to re-read
26066 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26067 When COMBINE is non nil, add the category to each line."
26074 scheduledp deadlinep tmp pri category entry location summary desc
26084 inc t
26091 t org-icalendar-include-body)
26101 pos)
26106 ts)
26109 ;; donep (org-entry-is-done-p)
26110 ))
26129 t t summary)))
26136 %s
26137 %s%s
26138 SUMMARY:%s%s%s
26139 CATEGORIES:%s
26143 rrule summary
26148 category)))))
26153 ;; Get all the literal sexps
26179 )
26186 t org-icalendar-include-body)
26192 t t hd)))
26202 %s
26203 SUMMARY:%s%s%s
26204 CATEGORIES:%s
26205 SEQUENCE:1
26206 PRIORITY:%d
26207 STATUS:%s
26209 dts
26215 category pri status)))))))))
26218 "Take out stuff and quote what needs to be quoted.
26219 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26220 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26221 characters."
26223 nil
26242 s))
26245 "Clean-up description string."
26251 "Start an iCalendar file by inserting the header."
26257 VERSION:2.0
26258 X-WR-CALNAME:%s
26259 PRODID:-//%s//Emacs with Org-mode//EN
26260 X-WR-TIMEZONE:%s
26264 "Finish an iCalendar file by inserting the END statement."
26268 "Take a time string S and convert it to iCalendar format.
26269 KEYWORD is added in front, to make a complete line like DTSTART....
26270 When INC is non-nil, increase the hour by two (if time string contains
26271 a time), or the day by one (if it does not contain a time)."
26273 t2 fmt have-time time)
26289 ;;; XOXO export
26297 "Export the org buffer as XOXO.
26298 The XOXO buffer is named *xoxo-<source buffer name>*"
26300 ;; A quickie abstraction
26302 ;; Output everything as XOXO
26316 ;; Check the output buffer is empty.
26318 ;; Kick off the output
26335 ;; Handle level rendering
26352 )
26356 ;; And output the new li
26362 ;; Finally finish off the ol
26369 ;; Finish the buffer off and clean it up.
26374 )))
26377 ;;;; Key bindings
26379 ;; Make `C-c C-x' a prefix key
26382 ;; TAB key with modifiers
26389 ;; The following line is necessary under Suse GNU/Linux
26395 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26396 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26397 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26399 ;; Cursor keys with modifiers
26400 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26401 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26402 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26403 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26405 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26406 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26407 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26408 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26410 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26411 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26412 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26413 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26415 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26416 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26418 ;;; Extra keys for tty access.
26419 ;; We only set them when really needed because otherwise the
26420 ;; menus don't show the simple keys
26422 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26423 (not window-system))
26424 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26425 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26426 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26427 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26428 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26429 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26430 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26431 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26432 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26433 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26434 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26435 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26436 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26437 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26438 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26439 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26440 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26441 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26442 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26443 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26444 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26445 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26447 ;; All the other keys
26449 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26450 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26451 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26452 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26453 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26454 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26455 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26456 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26457 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26458 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26459 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26460 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26461 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26462 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26463 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26465 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26466 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26467 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26468 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26469 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26470 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26471 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26472 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26473 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26474 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26475 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26476 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26477 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26478 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26479 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26480 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26481 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26483 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26484 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26485 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26486 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26487 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26488 (org-defkey org-mode-map "\C-c^" 'org-sort)
26489 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26490 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26491 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26492 (org-defkey org-mode-map "\C-m" 'org-return)
26493 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26494 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26495 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26496 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26497 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26498 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26499 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26500 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26501 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26502 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26503 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26504 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26505 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26506 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26507 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26508 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26509 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26511 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26512 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26513 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26514 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26516 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26517 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26518 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26519 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26520 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26521 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26522 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26523 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26524 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26525 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26526 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26527 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26529 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26531 (when (featurep 'xemacs)
26532 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26534 (defsubst org-table-p () (org-at-table-p))
26536 (defun org-self-insert-command (N)
26537 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26538 If the cursor is in a table looking at whitespace, the whitespace is
26539 overwritten, and the table is not marked as requiring realignment."
26540 (interactive "p")
26541 (if (and (org-table-p)
26542 (progn
26543 ;; check if we blank the field, and if that triggers align
26544 (and org-table-auto-blank-field
26545 (member last-command
26546 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26548 ;; got extra space, this field does not determine column width
26549 (let (org-table-may-need-update) (org-table-blank-field))
26550 ;; no extra space, this field may determine column width
26551 (org-table-blank-field)))
26552 t)
26553 (eq N 1)
26555 (let (org-table-may-need-update)
26556 (goto-char (1- (match-end 0)))
26557 (delete-backward-char 1)
26558 (goto-char (match-beginning 0))
26559 (self-insert-command N))
26560 (setq org-table-may-need-update t)
26561 (self-insert-command N)
26562 (org-fix-tags-on-the-fly)))
26564 (defun org-fix-tags-on-the-fly ()
26565 (when (and (equal (char-after (point-at-bol)) ?*)
26566 (org-on-heading-p))
26567 (org-align-tags-here org-tags-column)))
26569 (defun org-delete-backward-char (N)
26570 "Like `delete-backward-char', insert whitespace at field end in tables.
26571 When deleting backwards, in tables this function will insert whitespace in
26573 still be marked for re-alignment if the field did fill the entire column,
26574 because, in this case the deletion might narrow the column."
26575 (interactive "p")
26576 (if (and (org-table-p)
26577 (eq N 1)
26578 (string-match "|" (buffer-substring (point-at-bol) (point)))
26579 (looking-at ".*?|"))
26580 (let ((pos (point))
26582 (c org-table-may-need-update))
26583 (backward-delete-char N)
26584 (skip-chars-forward "^|")
26585 (insert " ")
26586 (goto-char (1- pos))
26587 ;; noalign: if there were two spaces at the end, this field
26588 ;; does not determine the width of the column.
26589 (if noalign (setq org-table-may-need-update c)))
26590 (backward-delete-char N)
26591 (org-fix-tags-on-the-fly)))
26593 (defun org-delete-char (N)
26594 "Like `delete-char', but insert whitespace at field end in tables.
26595 When deleting characters, 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 (not (bolp))
26602 (not (= (char-after) ?|))
26603 (eq N 1))
26604 (if (looking-at ".*?|")
26605 (let ((pos (point))
26607 (c org-table-may-need-update))
26608 (replace-match (concat
26609 (substring (match-string 0) 1 -1)
26610 " |"))
26611 (goto-char pos)
26612 ;; noalign: if there were two spaces at the end, this field
26613 ;; does not determine the width of the column.
26614 (if noalign (setq org-table-may-need-update c)))
26615 (delete-char N))
26616 (delete-char N)
26617 (org-fix-tags-on-the-fly)))
26619 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26620 (put 'org-self-insert-command 'delete-selection t)
26621 (put 'orgtbl-self-insert-command 'delete-selection t)
26622 (put 'org-delete-char 'delete-selection 'supersede)
26623 (put 'org-delete-backward-char 'delete-selection 'supersede)
26625 ;; Make `flyspell-mode' delay after some commands
26626 (put 'org-self-insert-command 'flyspell-delayed t)
26627 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26628 (put 'org-delete-char 'flyspell-delayed t)
26629 (put 'org-delete-backward-char 'flyspell-delayed t)
26631 ;; Make pabbrev-mode expand after org-mode commands
26632 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26633 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26635 ;; How to do this: Measure non-white length of current string
26636 ;; If equal to column width, we should realign.
26638 (defun org-remap (map &rest commands)
26639 "In MAP, remap the functions given in COMMANDS.
26640 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26641 (let (new old)
26642 (while commands
26643 (setq old (pop commands) new (pop commands))
26644 (if (fboundp 'command-remapping)
26645 (org-defkey map (vector 'remap old) new)
26646 (substitute-key-definition old new map global-map)))))
26648 (when (eq org-enable-table-editor 'optimized)
26649 ;; If the user wants maximum table support, we need to hijack
26650 ;; some standard editing functions
26651 (org-remap org-mode-map
26652 'self-insert-command 'org-self-insert-command
26653 'delete-char 'org-delete-char
26654 'delete-backward-char 'org-delete-backward-char)
26655 (org-defkey org-mode-map "|" 'org-force-self-insert))
26657 (defun org-shiftcursor-error ()
26658 "Throw an error because Shift-Cursor command was applied in wrong context."
26659 (error "This command is active in special context like tables, headlines or timestamps"))
26661 (defun org-shifttab (&optional arg)
26662 "Global visibility cycling or move to previous table field.
26663 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26664 on context.
26665 See the individual commands for more information."
26666 (interactive "P")
26667 (cond
26668 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26669 (arg (message "Content view to level: ")
26670 (org-content (prefix-numeric-value arg))
26671 (setq org-cycle-global-status 'overview))
26672 (t (call-interactively 'org-global-cycle))))
26674 (defun org-shiftmetaleft ()
26675 "Promote subtree or delete table column.
26676 Calls `org-promote-subtree', `org-outdent-item',
26677 or `org-table-delete-column', depending on context.
26678 See the individual commands for more information."
26679 (interactive)
26680 (cond
26681 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26682 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26683 ((org-at-item-p) (call-interactively 'org-outdent-item))
26684 (t (org-shiftcursor-error))))
26686 (defun org-shiftmetaright ()
26687 "Demote subtree or insert table column.
26688 Calls `org-demote-subtree', `org-indent-item',
26689 or `org-table-insert-column', depending on context.
26690 See the individual commands for more information."
26691 (interactive)
26692 (cond
26693 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26694 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26695 ((org-at-item-p) (call-interactively 'org-indent-item))
26696 (t (org-shiftcursor-error))))
26698 (defun org-shiftmetaup (&optional arg)
26699 "Move subtree up or kill table row.
26700 Calls `org-move-subtree-up' or `org-table-kill-row' or
26701 `org-move-item-up' depending on context. See the individual commands
26702 for more information."
26703 (interactive "P")
26704 (cond
26705 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26706 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26707 ((org-at-item-p) (call-interactively 'org-move-item-up))
26708 (t (org-shiftcursor-error))))
26709 (defun org-shiftmetadown (&optional arg)
26710 "Move subtree down or insert table row.
26711 Calls `org-move-subtree-down' or `org-table-insert-row' or
26712 `org-move-item-down', depending on context. See the individual
26713 commands for more information."
26714 (interactive "P")
26715 (cond
26716 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26717 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26718 ((org-at-item-p) (call-interactively 'org-move-item-down))
26719 (t (org-shiftcursor-error))))
26721 (defun org-metaleft (&optional arg)
26722 "Promote heading or move table column to left.
26723 Calls `org-do-promote' or `org-table-move-column', depending on context.
26724 With no specific context, calls the Emacs default `backward-word'.
26725 See the individual commands for more information."
26726 (interactive "P")
26727 (cond
26728 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26729 ((or (org-on-heading-p) (org-region-active-p))
26730 (call-interactively 'org-do-promote))
26731 ((org-at-item-p) (call-interactively 'org-outdent-item))
26732 (t (call-interactively 'backward-word))))
26734 (defun org-metaright (&optional arg)
26735 "Demote subtree or move table column to right.
26736 Calls `org-do-demote' or `org-table-move-column', depending on context.
26737 With no specific context, calls the Emacs default `forward-word'.
26738 See the individual commands for more information."
26739 (interactive "P")
26740 (cond
26741 ((org-at-table-p) (call-interactively 'org-table-move-column))
26742 ((or (org-on-heading-p) (org-region-active-p))
26743 (call-interactively 'org-do-demote))
26744 ((org-at-item-p) (call-interactively 'org-indent-item))
26745 (t (call-interactively 'forward-word))))
26747 (defun org-metaup (&optional arg)
26748 "Move subtree up or move table row up.
26749 Calls `org-move-subtree-up' or `org-table-move-row' or
26750 `org-move-item-up', depending on context. See the individual commands
26751 for more information."
26752 (interactive "P")
26753 (cond
26754 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26755 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26756 ((org-at-item-p) (call-interactively 'org-move-item-up))
26757 (t (transpose-lines 1) (beginning-of-line -1))))
26759 (defun org-metadown (&optional arg)
26760 "Move subtree down or move table row down.
26761 Calls `org-move-subtree-down' or `org-table-move-row' or
26762 `org-move-item-down', depending on context. See the individual
26763 commands for more information."
26764 (interactive "P")
26765 (cond
26766 ((org-at-table-p) (call-interactively 'org-table-move-row))
26767 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26768 ((org-at-item-p) (call-interactively 'org-move-item-down))
26769 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26771 (defun org-shiftup (&optional arg)
26772 "Increase item in timestamp or increase priority of current headline.
26773 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26774 depending on context. See the individual commands for more information."
26775 (interactive "P")
26776 (cond
26777 ((org-at-timestamp-p t)
26778 (call-interactively (if org-edit-timestamp-down-means-later
26779 'org-timestamp-down 'org-timestamp-up)))
26780 ((org-on-heading-p) (call-interactively 'org-priority-up))
26781 ((org-at-item-p) (call-interactively 'org-previous-item))
26782 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26784 (defun org-shiftdown (&optional arg)
26785 "Decrease item in timestamp or decrease priority of current headline.
26786 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26787 depending on context. See the individual commands for more information."
26788 (interactive "P")
26789 (cond
26790 ((org-at-timestamp-p t)
26791 (call-interactively (if org-edit-timestamp-down-means-later
26792 'org-timestamp-up 'org-timestamp-down)))
26793 ((org-on-heading-p) (call-interactively 'org-priority-down))
26794 (t (call-interactively 'org-next-item))))
26796 (defun org-shiftright ()
26797 "Next TODO keyword or timestamp one day later, depending on context."
26798 (interactive)
26799 (cond
26800 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26801 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26802 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26803 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26804 (t (org-shiftcursor-error))))
26806 (defun org-shiftleft ()
26807 "Previous TODO keyword or timestamp one day earlier, depending on context."
26808 (interactive)
26809 (cond
26810 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26811 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26812 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26813 ((org-at-property-p)
26814 (call-interactively 'org-property-previous-allowed-value))
26815 (t (org-shiftcursor-error))))
26817 (defun org-shiftcontrolright ()
26818 "Switch to next TODO set."
26819 (interactive)
26820 (cond
26821 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26822 (t (org-shiftcursor-error))))
26824 (defun org-shiftcontrolleft ()
26825 "Switch to previous TODO set."
26826 (interactive)
26827 (cond
26828 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26829 (t (org-shiftcursor-error))))
26831 (defun org-ctrl-c-ret ()
26832 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26833 (interactive)
26834 (cond
26835 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26836 (t (call-interactively 'org-insert-heading))))
26838 (defun org-copy-special ()
26839 "Copy region in table or copy current subtree.
26840 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26841 See the individual commands for more information."
26842 (interactive)
26843 (call-interactively
26844 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26846 (defun org-cut-special ()
26847 "Cut region in table or cut current subtree.
26848 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26849 See the individual commands for more information."
26850 (interactive)
26851 (call-interactively
26852 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26854 (defun org-paste-special (arg)
26855 "Paste rectangular region into table, or past subtree relative to level.
26856 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26857 See the individual commands for more information."
26858 (interactive "P")
26859 (if (org-at-table-p)
26860 (org-table-paste-rectangle)
26861 (org-paste-subtree arg)))
26863 (defun org-ctrl-c-ctrl-c (&optional arg)
26864 "Set tags in headline, or update according to changed information at point.
26866 This command does many different things, depending on context:
26868 - If the cursor is in a headline, prompt for tags and insert them
26869 into the current line, aligned to `org-tags-column'. When called
26870 with prefix arg, realign all tags in the current buffer.
26872 - If the cursor is in one of the special #+KEYWORD lines, this
26873 triggers scanning the buffer for these lines and updating the
26874 information.
26876 - If the cursor is inside a table, realign the table. This command
26877 works even if the automatic table editor has been turned off.
26879 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26880 the entire table.
26882 - If the cursor is a the beginning of a dynamic block, update it.
26884 - If the cursor is inside a table created by the table.el package,
26885 activate that table.
26887 - If the current buffer is a remember buffer, close note and file it.
26888 with a prefix argument, file it without further interaction to the default
26889 location.
26891 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26892 links in this buffer.
26894 - If the cursor is on a numbered item in a plain list, renumber the
26895 ordered list.
26897 - If the cursor is on a checkbox, toggle it."
26898 (interactive "P")
26899 (let ((org-enable-table-editor t))
26900 (cond
26901 ((or org-clock-overlays
26902 org-occur-highlights
26903 org-latex-fragment-image-overlays)
26904 (org-remove-clock-overlays)
26905 (org-remove-occur-highlights)
26906 (org-remove-latex-fragment-image-overlays)
26907 (message "Temporary highlights/overlays removed from current buffer"))
26908 ((and (local-variable-p 'org-finish-function (current-buffer))
26909 (fboundp org-finish-function))
26910 (funcall org-finish-function))
26911 ((org-at-property-p)
26912 (call-interactively 'org-property-action))
26913 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
26914 ((org-on-heading-p) (call-interactively 'org-set-tags))
26915 ((org-at-table.el-p)
26916 (require 'table)
26917 (beginning-of-line 1)
26918 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
26919 (call-interactively 'table-recognize-table))
26920 ((org-at-table-p)
26921 (org-table-maybe-eval-formula)
26922 (if arg
26923 (call-interactively 'org-table-recalculate)
26924 (org-table-maybe-recalculate-line))
26925 (call-interactively 'org-table-align))
26926 ((org-at-item-checkbox-p)
26927 (call-interactively 'org-toggle-checkbox))
26928 ((org-at-item-p)
26929 (call-interactively 'org-maybe-renumber-ordered-list))
26931 ;; Dynamic block
26932 (beginning-of-line 1)
26933 (org-update-dblock))
26935 (cond
26936 ((equal (match-string 1) "TBLFM")
26937 ;; Recalculate the table before this line
26938 (save-excursion
26939 (beginning-of-line 1)
26941 (if (org-at-table-p)
26942 (org-call-with-arg 'org-table-recalculate t))))
26943 (t
26944 (call-interactively 'org-mode-restart))))
26945 (t (error "C-c C-c can do nothing useful at this location.")))))
26947 (defun org-mode-restart ()
26948 "Restart Org-mode, to scan again for special lines.
26949 Also updates the keyword regular expressions."
26950 (interactive)
26951 (let ((org-inhibit-startup t)) (org-mode))
26952 (message "Org-mode restarted to refresh keyword and special line setup"))
26954 (defun org-kill-note-or-show-branches ()
26955 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
26956 (interactive)
26957 (if (not org-finish-function)
26958 (call-interactively 'show-branches)
26959 (let ((org-note-abort t))
26960 (funcall org-finish-function))))
26962 (defun org-return (&optional indent)
26963 "Goto next table row or insert a newline.
26964 Calls `org-table-next-row' or `newline', depending on context.
26965 See the individual commands for more information."
26966 (interactive)
26967 (cond
26968 ((bobp) (if indent (newline-and-indent) (newline)))
26969 ((org-at-table-p)
26970 (org-table-justify-field-maybe)
26971 (call-interactively 'org-table-next-row))
26972 (t (if indent (newline-and-indent) (newline)))))
26974 (defun org-return-indent ()
26975 (interactive)
26976 "Goto next table row or insert a newline and indent.
26977 Calls `org-table-next-row' or `newline-and-indent', depending on
26978 context. See the individual commands for more information."
26979 (org-return t))
26981 (defun org-ctrl-c-minus ()
26982 "Insert separator line in table or modify bullet type in list.
26983 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
26984 depending on context."
26985 (interactive)
26986 (cond
26987 ((org-at-table-p)
26988 (call-interactively 'org-table-insert-hline))
26989 ((org-on-heading-p)
26990 ;; Convert to item
26991 (save-excursion
26992 (beginning-of-line 1)
26994 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
26995 ((org-in-item-p)
26996 (call-interactively 'org-cycle-list-bullet))
26997 (t (error "`C-c -' does have no function here."))))
26999 (defun org-meta-return (&optional arg)
27000 "Insert a new heading or wrap a region in a table.
27001 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27002 See the individual commands for more information."
27003 (interactive "P")
27004 (cond
27005 ((org-at-table-p)
27006 (call-interactively 'org-table-wrap-region))
27007 (t (call-interactively 'org-insert-heading))))
27009 ;;; Menu entries
27011 ;; Define the Org-mode menus
27012 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27013 '("Tbl"
27014 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27015 ["Next Field" org-cycle (org-at-table-p)]
27016 ["Previous Field" org-shifttab (org-at-table-p)]
27017 ["Next Row" org-return (org-at-table-p)]
27018 "--"
27019 ["Blank Field" org-table-blank-field (org-at-table-p)]
27020 ["Edit Field" org-table-edit-field (org-at-table-p)]
27021 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27022 "--"
27023 ("Column"
27024 ["Move Column Left" org-metaleft (org-at-table-p)]
27025 ["Move Column Right" org-metaright (org-at-table-p)]
27026 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27027 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27028 ("Row"
27029 ["Move Row Up" org-metaup (org-at-table-p)]
27030 ["Move Row Down" org-metadown (org-at-table-p)]
27031 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27032 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27033 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27034 "--"
27035 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27036 ("Rectangle"
27037 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27038 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27039 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27040 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27041 "--"
27042 ("Calculate"
27043 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27044 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27045 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27046 "--"
27047 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27048 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27049 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27050 "--"
27051 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27052 "--"
27053 ["Sum Column/Rectangle" org-table-sum
27054 (or (org-at-table-p) (org-region-active-p))]
27055 ["Which Column?" org-table-current-column (org-at-table-p)])
27056 ["Debug Formulas"
27057 org-table-toggle-formula-debugger
27058 :style toggle :selected org-table-formula-debug]
27059 ["Show Col/Row Numbers"
27060 org-table-toggle-coordinate-overlays
27061 :style toggle :selected org-table-overlay-coordinates]
27062 "--"
27063 ["Create" org-table-create (and (not (org-at-table-p))
27064 org-enable-table-editor)]
27065 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27066 ["Import from File" org-table-import (not (org-at-table-p))]
27067 ["Export to File" org-table-export (org-at-table-p)]
27068 "--"
27069 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27071 (easy-menu-define org-org-menu org-mode-map "Org menu"
27072 '("Org"
27073 ("Show/Hide"
27074 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27075 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27076 ["Sparse Tree" org-occur t]
27077 ["Reveal Context" org-reveal t]
27078 ["Show All" show-all t]
27079 "--"
27080 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27081 "--"
27082 ["New Heading" org-insert-heading t]
27083 ("Navigate Headings"
27084 ["Up" outline-up-heading t]
27085 ["Next" outline-next-visible-heading t]
27086 ["Previous" outline-previous-visible-heading t]
27087 ["Next Same Level" outline-forward-same-level t]
27088 ["Previous Same Level" outline-backward-same-level t]
27089 "--"
27090 ["Jump" org-goto t])
27091 ("Edit Structure"
27092 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27093 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27094 "--"
27095 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27096 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27097 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27098 "--"
27099 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27100 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27101 ["Demote Heading" org-metaright (not (org-at-table-p))]
27102 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27103 "--"
27104 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27105 "--"
27106 ["Convert to odd levels" org-convert-to-odd-levels t]
27107 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27108 ("Editing"
27109 ["Emphasis..." org-emphasize t])
27110 ("Archive"
27111 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27112 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27113 ; :active t :keys "C-u C-c C-x C-a"]
27114 ["Sparse trees open ARCHIVE trees"
27115 (setq org-sparse-tree-open-archived-trees
27116 (not org-sparse-tree-open-archived-trees))
27117 :style toggle :selected org-sparse-tree-open-archived-trees]
27118 ["Cycling opens ARCHIVE trees"
27119 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27120 :style toggle :selected org-cycle-open-archived-trees]
27121 ["Agenda includes ARCHIVE trees"
27122 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27123 :style toggle :selected (not org-agenda-skip-archived-trees)]
27124 "--"
27125 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27126 ; ["Check and Move Children" (org-archive-subtree '(4))
27127 ; :active t :keys "C-u C-c C-x C-s"]
27128 )
27129 "--"
27130 ("TODO Lists"
27131 ["TODO/DONE/-" org-todo t]
27132 ("Select keyword"
27133 ["Next keyword" org-shiftright (org-on-heading-p)]
27134 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27135 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27136 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27137 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27138 ["Show TODO Tree" org-show-todo-tree t]
27139 ["Global TODO list" org-todo-list t]
27140 "--"
27141 ["Set Priority" org-priority t]
27142 ["Priority Up" org-shiftup t]
27143 ["Priority Down" org-shiftdown t])
27144 ("TAGS and Properties"
27145 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27146 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27147 "--"
27148 ["Set property" 'org-set-property t]
27149 ["Column view of properties" org-columns t]
27150 ["Insert Column View DBlock" org-insert-columns-dblock t])
27151 ("Dates and Scheduling"
27152 ["Timestamp" org-time-stamp t]
27153 ["Timestamp (inactive)" org-time-stamp-inactive t]
27154 ("Change Date"
27155 ["1 Day Later" org-shiftright t]
27156 ["1 Day Earlier" org-shiftleft t]
27157 ["1 ... Later" org-shiftup t]
27158 ["1 ... Earlier" org-shiftdown t])
27159 ["Compute Time Range" org-evaluate-time-range t]
27160 ["Schedule Item" org-schedule t]
27161 ["Deadline" org-deadline t]
27162 "--"
27163 ["Custom time format" org-toggle-time-stamp-overlays
27164 :style radio :selected org-display-custom-times]
27165 "--"
27166 ["Goto Calendar" org-goto-calendar t]
27167 ["Date from Calendar" org-date-from-calendar t])
27168 ("Logging work"
27169 ["Clock in" org-clock-in t]
27170 ["Clock out" org-clock-out t]
27171 ["Clock cancel" org-clock-cancel t]
27172 ["Goto running clock" org-clock-goto t]
27173 ["Display times" org-clock-display t]
27174 ["Create clock table" org-clock-report t]
27175 "--"
27176 ["Record DONE time"
27177 (progn (setq org-log-done (not org-log-done))
27178 (message "Switching to %s will %s record a timestamp"
27179 (car org-done-keywords)
27180 (if org-log-done "automatically" "not")))
27181 :style toggle :selected org-log-done])
27182 "--"
27183 ["Agenda Command..." org-agenda t]
27184 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27185 ("File List for Agenda")
27186 ("Special views current file"
27187 ["TODO Tree" org-show-todo-tree t]
27188 ["Check Deadlines" org-check-deadlines t]
27189 ["Timeline" org-timeline t]
27190 ["Tags Tree" org-tags-sparse-tree t])
27191 "--"
27192 ("Hyperlinks"
27193 ["Store Link (Global)" org-store-link t]
27194 ["Insert Link" org-insert-link t]
27195 ["Follow Link" org-open-at-point t]
27196 "--"
27197 ["Next link" org-next-link t]
27198 ["Previous link" org-previous-link t]
27199 "--"
27200 ["Descriptive Links"
27201 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27202 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27203 ["Literal Links"
27204 (progn
27205 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27206 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27207 "--"
27208 ["Export/Publish..." org-export t]
27209 ("LaTeX"
27210 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27211 :selected org-cdlatex-mode]
27212 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27213 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27214 ["Modify math symbol" org-cdlatex-math-modify
27215 (org-inside-LaTeX-fragment-p)]
27216 ["Export LaTeX fragments as images"
27217 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27218 :style toggle :selected org-export-with-LaTeX-fragments])
27219 "--"
27220 ("Documentation"
27221 ["Show Version" org-version t]
27222 ["Info Documentation" org-info t])
27223 ("Customize"
27224 ["Browse Org Group" org-customize t]
27225 "--"
27226 ["Expand This Menu" org-create-customize-menu
27227 (fboundp 'customize-menu-create)])
27228 "--"
27229 ["Refresh setup" org-mode-restart t]
27230 ))
27232 (defun org-info (&optional node)
27233 "Read documentation for Org-mode in the info system.
27234 With optional NODE, go directly to that node."
27235 (interactive)
27236 (require 'info)
27237 (Info-goto-node (format "(org)%s" (or node ""))))
27239 (defun org-install-agenda-files-menu ()
27240 (let ((bl (buffer-list)))
27241 (save-excursion
27242 (while bl
27243 (set-buffer (pop bl))
27244 (if (org-mode-p) (setq bl nil)))
27245 (when (org-mode-p)
27246 (easy-menu-change
27247 '("Org") "File List for Agenda"
27248 (append
27249 (list
27250 ["Edit File List" (org-edit-agenda-file-list) t]
27251 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27252 ["Remove Current File from List" org-remove-file t]
27253 ["Cycle through agenda files" org-cycle-agenda-files t]
27254 ["Occur in all agenda files" org-occur-in-agenda-files t]
27255 "--")
27256 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27258 ;;;; Documentation
27260 (defun org-customize ()
27261 "Call the customize function with org as argument."
27262 (interactive)
27263 (customize-browse 'org))
27265 (defun org-create-customize-menu ()
27266 "Create a full customization menu for Org-mode, insert it into the menu."
27267 (interactive)
27268 (if (fboundp 'customize-menu-create)
27269 (progn
27270 (easy-menu-change
27271 '("Org") "Customize"
27272 `(["Browse Org group" org-customize t]
27273 "--"
27274 ,(customize-menu-create 'org)
27275 ["Set" Custom-set t]
27276 ["Save" Custom-save t]
27277 ["Reset to Current" Custom-reset-current t]
27278 ["Reset to Saved" Custom-reset-saved t]
27279 ["Reset to Standard Settings" Custom-reset-standard t]))
27281 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27283 ;;;; Miscellaneous stuff
27286 ;;; Generally useful functions
27288 (defun org-context ()
27289 "Return a list of contexts of the current cursor position.
27290 If several contexts apply, all are returned.
27291 Each context entry is a list with a symbol naming the context, and
27292 two positions indicating start and end of the context. Possible
27293 contexts are:
27295 :headline anywhere in a headline
27296 :headline-stars on the leading stars in a headline
27297 :todo-keyword on a TODO keyword (including DONE) in a headline
27298 :tags on the TAGS in a headline
27299 :priority on the priority cookie in a headline
27300 :item on the first line of a plain list item
27301 :item-bullet on the bullet/number of a plain list item
27302 :checkbox on the checkbox in a plain list item
27303 :table in an org-mode table
27304 :table-special on a special filed in a table
27305 :table-table in a table.el table
27306 :link on a hyperlink
27307 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27308 :target on a <<target>>
27309 :radio-target on a <<<radio-target>>>
27310 :latex-fragment on a LaTeX fragment
27311 :latex-preview on a LaTeX fragment with overlayed preview image
27313 This function expects the position to be visible because it uses font-lock
27314 faces as a help to recognize the following contexts: :table-special, :link,
27315 and :keyword."
27316 (let* ((f (get-text-property (point) 'face))
27317 (faces (if (listp f) f (list f)))
27318 (p (point)) clist o)
27319 ;; First the large context
27320 (cond
27321 ((org-on-heading-p t)
27322 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27323 (when (progn
27324 (beginning-of-line 1)
27325 (looking-at org-todo-line-tags-regexp))
27326 (push (org-point-in-group p 1 :headline-stars) clist)
27327 (push (org-point-in-group p 2 :todo-keyword) clist)
27328 (push (org-point-in-group p 4 :tags) clist))
27329 (goto-char p)
27332 (push (org-point-in-group p 0 :priority) clist)))
27334 ((org-at-item-p)
27335 (push (org-point-in-group p 2 :item-bullet) clist)
27336 (push (list :item (point-at-bol)
27337 (save-excursion (org-end-of-item) (point)))
27338 clist)
27339 (and (org-at-item-checkbox-p)
27340 (push (org-point-in-group p 0 :checkbox) clist)))
27342 ((org-at-table-p)
27343 (push (list :table (org-table-begin) (org-table-end)) clist)
27344 (if (memq 'org-formula faces)
27345 (push (list :table-special
27346 (previous-single-property-change p 'face)
27347 (next-single-property-change p 'face)) clist)))
27348 ((org-at-table-p 'any)
27349 (push (list :table-table) clist)))
27350 (goto-char p)
27352 ;; Now the small context
27353 (cond
27354 ((org-at-timestamp-p)
27355 (push (org-point-in-group p 0 :timestamp) clist))
27356 ((memq 'org-link faces)
27357 (push (list :link
27358 (previous-single-property-change p 'face)
27359 (next-single-property-change p 'face)) clist))
27360 ((memq 'org-special-keyword faces)
27361 (push (list :keyword
27362 (previous-single-property-change p 'face)
27363 (next-single-property-change p 'face)) clist))
27364 ((org-on-target-p)
27365 (push (org-point-in-group p 0 :target) clist)
27366 (goto-char (1- (match-beginning 0)))
27367 (if (looking-at org-radio-target-regexp)
27368 (push (org-point-in-group p 0 :radio-target) clist))
27369 (goto-char p))
27370 ((setq o (car (delq nil
27371 (mapcar
27372 (lambda (x)
27373 (if (memq x org-latex-fragment-image-overlays) x))
27374 (org-overlays-at (point))))))
27375 (push (list :latex-fragment
27376 (org-overlay-start o) (org-overlay-end o)) clist)
27377 (push (list :latex-preview
27378 (org-overlay-start o) (org-overlay-end o)) clist))
27379 ((org-inside-LaTeX-fragment-p)
27380 ;; FIXME: positions wrong.
27381 (push (list :latex-fragment (point) (point)) clist)))
27383 (setq clist (nreverse (delq nil clist)))
27384 clist))
27386 ;; FIXME: Compare with at-regexp-p Do we need both?
27387 (defun org-in-regexp (re &optional nlines visually)
27388 "Check if point is inside a match of regexp.
27389 Normally only the current line is checked, but you can include NLINES extra
27390 lines both before and after point into the search.
27391 If VISUALLY is set, require that the cursor is not after the match but
27392 really on, so that the block visually is on the match."
27393 (catch 'exit
27394 (let ((pos (point))
27395 (eol (point-at-eol (+ 1 (or nlines 0))))
27396 (inc (if visually 1 0)))
27397 (save-excursion
27398 (beginning-of-line (- 1 (or nlines 0)))
27399 (while (re-search-forward re eol t)
27400 (if (and (<= (match-beginning 0) pos)
27401 (>= (+ inc (match-end 0)) pos))
27402 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27404 (defun org-at-regexp-p (regexp)
27405 "Is point inside a match of REGEXP in the current line?"
27406 (catch 'exit
27407 (save-excursion
27408 (let ((pos (point)) (end (point-at-eol)))
27409 (beginning-of-line 1)
27410 (while (re-search-forward regexp end t)
27411 (if (and (<= (match-beginning 0) pos)
27412 (>= (match-end 0) pos))
27413 (throw 'exit t)))
27414 nil))))
27416 (defun org-occur-in-agenda-files (regexp &optional nlines)
27417 "Call `multi-occur' with buffers for all agenda files."
27419 (let* ((files (org-agenda-files))
27420 (tnames (mapcar 'file-truename files))
27421 (extra org-agenda-multi-occur-extra-files)
27422 f)
27423 (while (setq f (pop extra))
27424 (unless (member (file-truename f) tnames)
27425 (add-to-list 'files f 'append)
27426 (add-to-list 'tnames (file-truename f) 'append)))
27427 (multi-occur
27428 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27429 regexp)))
27431 (if (boundp 'occur-mode-find-occurrence-hook)
27432 ;; Emacs 23
27433 (add-hook 'occur-mode-find-occurrence-hook
27434 (lambda ()
27435 (when (org-mode-p)
27436 (org-reveal))))
27437 ;; Emacs 22
27438 (defadvice occur-mode-goto-occurrence
27439 (after org-occur-reveal activate)
27440 (and (org-mode-p) (org-reveal)))
27441 (defadvice occur-mode-goto-occurrence-other-window
27442 (after org-occur-reveal activate)
27443 (and (org-mode-p) (org-reveal)))
27444 (defadvice occur-mode-display-occurrence
27445 (after org-occur-reveal activate)
27446 (when (org-mode-p)
27447 (let ((pos (occur-mode-find-occurrence)))
27448 (with-current-buffer (marker-buffer pos)
27449 (save-excursion
27450 (goto-char pos)
27451 (org-reveal)))))))
27453 (defun org-uniquify (list)
27454 "Remove duplicate elements from LIST."
27455 (let (res)
27456 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27457 res))
27459 (defun org-delete-all (elts list)
27460 "Remove all elements in ELTS from LIST."
27461 (while elts
27462 (setq list (delete (pop elts) list)))
27463 list)
27465 (defun org-back-over-empty-lines ()
27466 "Move backwards over witespace, to the beginning of the first empty line.
27467 Returns the number o empty lines passed."
27468 (let ((pos (point)))
27470 (beginning-of-line 2)
27471 (goto-char (min (point) pos))
27472 (count-lines (point) pos)))
27474 (defun org-skip-whitespace ()
27477 (defun org-point-in-group (point group &optional context)
27478 "Check if POINT is in match-group GROUP.
27479 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27480 match. If the match group does ot exist or point is not inside it,
27481 return nil."
27482 (and (match-beginning group)
27483 (>= point (match-beginning group))
27484 (<= point (match-end group))
27485 (if context
27486 (list context (match-beginning group) (match-end group))
27487 t)))
27489 (defun org-switch-to-buffer-other-window (&rest args)
27490 "Switch to buffer in a second window on the current frame.
27491 In particular, do not allow pop-up frames."
27492 (let (pop-up-frames special-display-buffer-names special-display-regexps
27493 special-display-function)
27494 (apply 'switch-to-buffer-other-window args)))
27496 (defun org-combine-plists (&rest plists)
27497 "Create a single property list from all plists in PLISTS.
27498 The process starts by copying the first list, and then setting properties
27499 from the other lists. Settings in the last list are the most significant
27500 ones and overrule settings in the other lists."
27501 (let ((rtn (copy-sequence (pop plists)))
27502 p v ls)
27503 (while plists
27504 (setq ls (pop plists))
27505 (while ls
27506 (setq p (pop ls) v (pop ls))
27507 (setq rtn (plist-put rtn p v))))
27508 rtn))
27510 (defun org-move-line-down (arg)
27511 "Move the current line down. With prefix argument, move it past ARG lines."
27512 (interactive "p")
27513 (let ((col (current-column))
27514 beg end pos)
27515 (beginning-of-line 1) (setq beg (point))
27516 (beginning-of-line 2) (setq end (point))
27517 (beginning-of-line (+ 1 arg))
27518 (setq pos (move-marker (make-marker) (point)))
27519 (insert (delete-and-extract-region beg end))
27520 (goto-char pos)
27521 (move-to-column col)))
27523 (defun org-move-line-up (arg)
27524 "Move the current line up. With prefix argument, move it past ARG lines."
27525 (interactive "p")
27526 (let ((col (current-column))
27527 beg end pos)
27528 (beginning-of-line 1) (setq beg (point))
27529 (beginning-of-line 2) (setq end (point))
27530 (beginning-of-line (- arg))
27531 (setq pos (move-marker (make-marker) (point)))
27532 (insert (delete-and-extract-region beg end))
27533 (goto-char pos)
27534 (move-to-column col)))
27536 (defun org-replace-escapes (string table)
27537 "Replace %-escapes in STRING with values in TABLE.
27539 The sequences in STRING may contain normal field width and padding information,
27541 so values can contain further %-escapes if they are define later in TABLE."
27542 (let ((case-fold-search nil)
27543 e re rpl)
27544 (while (setq e (pop table))
27545 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27546 (while (string-match re string)
27547 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27548 (cdr e)))
27549 (setq string (replace-match rpl t t string))))
27550 string))
27553 (defun org-sublist (list start end)
27554 "Return a section of LIST, from START to END.
27555 Counting starts at 1."
27556 (let (rtn (c start))
27557 (setq list (nthcdr (1- start) list))
27558 (while (and list (<= c end))
27559 (push (pop list) rtn)
27560 (setq c (1+ c)))
27561 (nreverse rtn)))
27563 (defun org-find-base-buffer-visiting (file)
27564 "Like `find-buffer-visiting' but alway return the base buffer and
27565 not an indirect buffer"
27566 (let ((buf (find-buffer-visiting file)))
27567 (if buf
27568 (or (buffer-base-buffer buf) buf)
27569 nil)))
27571 (defun org-image-file-name-regexp ()
27572 "Return regexp matching the file names of images."
27573 (if (fboundp 'image-file-name-regexp)
27574 (image-file-name-regexp)
27575 (let ((image-file-name-extensions
27576 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27577 "xbm" "xpm" "pbm" "pgm" "ppm")))
27579 (regexp-opt (nconc (mapcar 'upcase
27580 image-file-name-extensions)
27581 image-file-name-extensions)
27582 t)
27585 (defun org-file-image-p (file)
27586 "Return non-nil if FILE is an image."
27587 (save-match-data
27588 (string-match (org-image-file-name-regexp) file)))
27590 ;;; Paragraph filling stuff.
27591 ;; We want this to be just right, so use the full arsenal.
27593 (defun org-indent-line-function ()
27594 "Indent line like previous, but further if previous was headline or item."
27595 (interactive)
27596 (let* ((pos (point))
27597 (itemp (org-at-item-p))
27598 column bpos bcol tpos tcol bullet btype bullet-type)
27599 ;; Find the previous relevant line
27600 (beginning-of-line 1)
27601 (cond
27602 ((looking-at "#") (setq column 0))
27604 (t
27605 (beginning-of-line 0)
27607 (beginning-of-line 0))
27608 (cond
27610 (goto-char (match-end 0))
27611 (setq column (current-column)))
27612 ((org-in-item-p)
27613 (org-beginning-of-item)
27616 (setq bpos (match-beginning 1) tpos (match-end 0)
27617 bcol (progn (goto-char bpos) (current-column))
27618 tcol (progn (goto-char tpos) (current-column))
27619 bullet (match-string 1)
27620 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27621 (if (not itemp)
27622 (setq column tcol)
27623 (goto-char pos)
27624 (beginning-of-line 1)
27626 (progn
27628 (setq bullet (match-string 1)
27629 btype (if (string-match "[0-9]" bullet) "n" bullet))
27630 (setq column (if (equal btype bullet-type) bcol tcol)))
27631 (setq column (org-get-indentation)))))
27632 (t (setq column (org-get-indentation))))))
27633 (goto-char pos)
27634 (if (<= (current-column) (current-indentation))
27635 (indent-line-to column)
27636 (save-excursion (indent-line-to column)))
27637 (setq column (current-column))
27638 (beginning-of-line 1)
27639 (if (looking-at
27642 (match-string 2) (match-string 3)))
27643 t nil))
27644 (move-to-column column)))
27646 (defun org-set-autofill-regexps ()
27647 (interactive)
27648 ;; In the paragraph separator we include headlines, because filling
27649 ;; text in a line directly attached to a headline would otherwise
27650 ;; fill the headline as well.
27653 ;; The paragraph starter includes hand-formatted lists.
27654 (org-set-local 'paragraph-start
27656 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27657 ;; But only if the user has not turned off tables or fixed-width regions
27658 (org-set-local
27659 'auto-fill-inhibit-regexp
27662 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27663 (concat
27665 (if org-enable-table-editor "|" "")
27666 (if org-enable-fixed-width-editor ":" "")
27667 "]"))))
27668 ;; We use our own fill-paragraph function, to make sure that tables
27669 ;; and fixed-width regions are not wrapped. That function will pass
27670 ;; through to `fill-paragraph' when appropriate.
27671 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27672 ; Adaptive filling: To get full control, first make sure that
27673 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27675 (org-set-local 'adaptive-fill-function
27676 'org-adaptive-fill-function)
27677 (org-set-local
27678 'align-mode-rules-list
27679 '((org-in-buffer-settings
27681 (modes . '(org-mode))))))
27683 (defun org-fill-paragraph (&optional justify)
27684 "Re-align a table, pass through to fill-paragraph if no table."
27685 (let ((table-p (org-at-table-p))
27686 (table.el-p (org-at-table.el-p)))
27687 (cond ((and (equal (char-after (point-at-bol)) ?*)
27688 (save-excursion (goto-char (point-at-bol))
27689 (looking-at outline-regexp)))
27690 t) ; skip headlines
27691 (table.el-p t) ; skip table.el tables
27692 (table-p (org-table-align) t) ; align org-mode tables
27693 (t nil)))) ; call paragraph-fill
27695 ;; For reference, this is the default value of adaptive-fill-regexp
27698 (defun org-adaptive-fill-function ()
27699 "Return a fill prefix for org-mode files.
27700 In particular, this makes sure hanging paragraphs for hand-formatted lists
27701 work correctly."
27703 (match-string 0))
27705 (save-excursion
27706 (goto-char (match-end 0))
27707 (make-string (current-column) ?\ )))
27708 (t nil)))
27710 ;;;; Functions extending outline functionality
27713 (defun org-beginning-of-line (&optional arg)
27714 "Go to the beginning of the current line. If that is invisible, continue
27715 to a visible line beginning. This makes the function of C-a more intuitive.
27716 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27717 first attempt, and only move to after the tags when the cursor is already
27718 beyond the end of the headline."
27719 (interactive "P")
27720 (let ((pos (point)))
27721 (beginning-of-line 1)
27722 (if (bobp)
27723 nil
27724 (backward-char 1)
27725 (if (org-invisible-p)
27726 (while (and (not (bobp)) (org-invisible-p))
27727 (backward-char 1)
27728 (beginning-of-line 1))
27729 (forward-char 1)))
27730 (when org-special-ctrl-a/e
27731 (cond
27732 ((and (looking-at org-todo-line-regexp)
27733 (= (char-after (match-end 1)) ?\ ))
27734 (goto-char
27735 (if (eq org-special-ctrl-a/e t)
27736 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27737 ((= pos (point)) (match-beginning 3))
27738 (t (point)))
27739 (cond ((> pos (point)) (point))
27740 ((not (eq last-command this-command)) (point))
27741 (t (match-beginning 3))))))
27742 ((org-at-item-p)
27743 (goto-char
27744 (if (eq org-special-ctrl-a/e t)
27745 (cond ((> pos (match-end 4)) (match-end 4))
27746 ((= pos (point)) (match-end 4))
27747 (t (point)))
27748 (cond ((> pos (point)) (point))
27749 ((not (eq last-command this-command)) (point))
27750 (t (match-end 4))))))))))
27752 (defun org-end-of-line (&optional arg)
27753 "Go to the end of the line.
27754 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27755 first attempt, and only move to after the tags when the cursor is already
27756 beyond the end of the headline."
27757 (interactive "P")
27758 (if (or (not org-special-ctrl-a/e)
27759 (not (org-on-heading-p)))
27760 (end-of-line arg)
27761 (let ((pos (point)))
27762 (beginning-of-line 1)
27764 (if (eq org-special-ctrl-a/e t)
27765 (if (or (< pos (match-beginning 1))
27766 (= pos (match-end 0)))
27767 (goto-char (match-beginning 1))
27768 (goto-char (match-end 0)))
27769 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27770 (goto-char (match-end 0))
27771 (goto-char (match-beginning 1))))
27772 (end-of-line arg)))))
27774 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27775 (define-key org-mode-map "\C-e" 'org-end-of-line)
27777 (defun org-kill-line (&optional arg)
27778 "Kill line, to tags or end of line."
27779 (interactive "P")
27780 (cond
27781 ((or (not org-special-ctrl-k)
27782 (bolp)
27783 (not (org-on-heading-p)))
27784 (call-interactively 'kill-line))
27786 (kill-region (point) (match-beginning 1))
27787 (org-set-tags nil t))
27788 (t (kill-region (point) (point-at-eol)))))
27790 (define-key org-mode-map "\C-k" 'org-kill-line)
27792 (defun org-invisible-p ()
27793 "Check if point is at a character currently not visible."
27794 ;; Early versions of noutline don't have `outline-invisible-p'.
27795 (if (fboundp 'outline-invisible-p)
27796 (outline-invisible-p)
27797 (get-char-property (point) 'invisible)))
27799 (defun org-invisible-p2 ()
27800 "Check if point is at a character currently not visible."
27801 (save-excursion
27802 (if (and (eolp) (not (bobp))) (backward-char 1))
27803 ;; Early versions of noutline don't have `outline-invisible-p'.
27804 (if (fboundp 'outline-invisible-p)
27805 (outline-invisible-p)
27806 (get-char-property (point) 'invisible))))
27808 (defalias 'org-back-to-heading 'outline-back-to-heading)
27809 (defalias 'org-on-heading-p 'outline-on-heading-p)
27810 (defalias 'org-at-heading-p 'outline-on-heading-p)
27811 (defun org-at-heading-or-item-p ()
27812 (or (org-on-heading-p) (org-at-item-p)))
27814 (defun org-on-target-p ()
27815 (or (org-in-regexp org-radio-target-regexp)
27816 (org-in-regexp org-target-regexp)))
27818 (defun org-up-heading-all (arg)
27819 "Move to the heading line of which the present line is a subheading.
27820 This function considers both visible and invisible heading lines.
27821 With argument, move up ARG levels."
27822 (if (fboundp 'outline-up-heading-all)
27823 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27824 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27826 (defun org-up-heading-safe ()
27827 "Move to the heading line of which the present line is a subheading.
27828 This version will not throw an error. It will return the level of the
27829 headline found, or nil if no higher level is found."
27830 (let ((pos (point)) start-level level
27831 (re (concat "^" outline-regexp)))
27832 (catch 'exit
27833 (outline-back-to-heading t)
27834 (setq start-level (funcall outline-level))
27835 (if (equal start-level 1) (throw 'exit nil))
27836 (while (re-search-backward re nil t)
27837 (setq level (funcall outline-level))
27838 (if (< level start-level) (throw 'exit level)))
27839 nil)))
27841 (defun org-first-sibling-p ()
27842 "Is this heading the first child of its parents?"
27843 (interactive)
27844 (let ((re (concat "^" outline-regexp))
27845 level l)
27846 (unless (org-at-heading-p t)
27847 (error "Not at a heading"))
27848 (setq level (funcall outline-level))
27849 (save-excursion
27850 (if (not (re-search-backward re nil t))
27851 t
27852 (setq l (funcall outline-level))
27853 (< l level)))))
27855 (defun org-goto-sibling (&optional previous)
27856 "Goto the next sibling, even if it is invisible.
27857 When PREVIOUS is set, go to the previous sibling instead. Returns t
27858 when a sibling was found. When none is found, return nil and don't
27859 move point."
27860 (let ((fun (if previous 're-search-backward 're-search-forward))
27861 (pos (point))
27862 (re (concat "^" outline-regexp))
27863 level l)
27864 (when (condition-case nil (org-back-to-heading t) (error nil))
27865 (setq level (funcall outline-level))
27866 (catch 'exit
27867 (or previous (forward-char 1))
27868 (while (funcall fun re nil t)
27869 (setq l (funcall outline-level))
27870 (when (< l level) (goto-char pos) (throw 'exit nil))
27871 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27872 (goto-char pos)
27873 nil))))
27875 (defun org-show-siblings ()
27876 "Show all siblings of the current headline."
27877 (save-excursion
27878 (while (org-goto-sibling) (org-flag-heading nil)))
27879 (save-excursion
27880 (while (org-goto-sibling 'previous)
27881 (org-flag-heading nil))))
27883 (defun org-show-hidden-entry ()
27884 "Show an entry where even the heading is hidden."
27885 (save-excursion
27886 (org-show-entry)))
27888 (defun org-flag-heading (flag &optional entry)
27889 "Flag the current heading. FLAG non-nil means make invisible.
27890 When ENTRY is non-nil, show the entire entry."
27891 (save-excursion
27892 (org-back-to-heading t)
27893 ;; Check if we should show the entire entry
27894 (if entry
27895 (progn
27896 (org-show-entry)
27897 (save-excursion
27898 (and (outline-next-heading)
27899 (org-flag-heading nil))))
27900 (outline-flag-region (max (point-min) (1- (point)))
27901 (save-excursion (outline-end-of-heading) (point))
27902 flag))))
27904 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27905 ;; This is an exact copy of the original function, but it uses
27906 ;; `org-back-to-heading', to make it work also in invisible
27907 ;; trees. And is uses an invisible-OK argument.
27908 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
27909 (org-back-to-heading invisible-OK)
27910 (let ((first t)
27911 (level (funcall outline-level)))
27912 (while (and (not (eobp))
27913 (or first (> (funcall outline-level) level)))
27914 (setq first nil)
27915 (outline-next-heading))
27916 (unless to-heading
27918 (progn
27919 ;; Go to end of line before heading
27920 (forward-char -1)
27922 ;; leave blank line before heading
27923 (forward-char -1))))))
27924 (point))
27926 (defun org-show-subtree ()
27927 "Show everything after this heading at deeper levels."
27928 (outline-flag-region
27929 (point)
27930 (save-excursion
27931 (outline-end-of-subtree) (outline-next-heading) (point))
27932 nil))
27934 (defun org-show-entry ()
27935 "Show the body directly following this heading.
27936 Show the heading too, if it is currently invisible."
27937 (interactive)
27938 (save-excursion
27939 (condition-case nil
27940 (progn
27941 (org-back-to-heading t)
27942 (outline-flag-region
27943 (max (point-min) (1- (point)))
27944 (save-excursion
27945 (re-search-forward
27947 (or (match-beginning 1) (point-max)))
27948 nil))
27949 (error nil))))
27951 (defun org-make-options-regexp (kwds)
27952 "Make a regular expression for keyword lines."
27953 (concat
27954 "^"
27960 ;; Make isearch reveal the necessary context
27961 (defun org-isearch-end ()
27962 "Reveal context after isearch exits."
27963 (when isearch-success ; only if search was successful
27964 (if (featurep 'xemacs)
27965 ;; Under XEmacs, the hook is run in the correct place,
27966 ;; we directly show the context.
27967 (org-show-context 'isearch)
27968 ;; In Emacs the hook runs *before* restoring the overlays.
27969 ;; So we have to use a one-time post-command-hook to do this.
27970 ;; (Emacs 22 has a special variable, see function `org-mode')
27971 (unless (and (boundp 'isearch-mode-end-hook-quit)
27972 isearch-mode-end-hook-quit)
27973 ;; Only when the isearch was not quitted.
27974 (org-add-hook 'post-command-hook 'org-isearch-post-command
27975 'append 'local)))))
27977 (defun org-isearch-post-command ()
27978 "Remove self from hook, and show context."
27979 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
27980 (org-show-context 'isearch))
27983 ;;;; Integration with and fixes for other packages
27985 ;;; Imenu support
27987 (defvar org-imenu-markers nil
27988 "All markers currently used by Imenu.")
27989 (make-variable-buffer-local 'org-imenu-markers)
27991 (defun org-imenu-new-marker (&optional pos)
27992 "Return a new marker for use by Imenu, and remember the marker."
27993 (let ((m (make-marker)))
27994 (move-marker m (or pos (point)))
27995 (push m org-imenu-markers)
27996 m))
27998 (defun org-imenu-get-tree ()
27999 "Produce the index for Imenu."
28000 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28001 (setq org-imenu-markers nil)
28002 (let* ((n org-imenu-depth)
28003 (re (concat "^" outline-regexp))
28004 (subs (make-vector (1+ n) nil))
28005 (last-level 0)
28006 m tree level head)
28007 (save-excursion
28008 (save-restriction
28009 (widen)
28010 (goto-char (point-max))
28011 (while (re-search-backward re nil t)
28012 (setq level (org-reduced-level (funcall outline-level)))
28013 (when (<= level n)
28014 (looking-at org-complex-heading-regexp)
28015 (setq head (org-match-string-no-properties 4)
28016 m (org-imenu-new-marker))
28017 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28018 (if (>= level last-level)
28019 (push (cons head m) (aref subs level))
28020 (push (cons head (aref subs (1+ level))) (aref subs level))
28021 (loop for i from (1+ level) to n do (aset subs i nil)))
28022 (setq last-level level)))))
28023 (aref subs 1)))
28025 (eval-after-load "imenu"
28026 '(progn
28027 (add-hook 'imenu-after-jump-hook
28028 (lambda () (org-show-context 'org-goto)))))
28030 ;; Speedbar support
28032 (defun org-speedbar-set-agenda-restriction ()
28033 "Restrict future agenda commands to the location at point in speedbar.
28035 (interactive)
28036 (let (p m tp np dir txt w)
28037 (cond
28038 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28039 'org-imenu t))
28040 (setq m (get-text-property p 'org-imenu-marker))
28041 (save-excursion
28042 (save-restriction
28043 (set-buffer (marker-buffer m))
28044 (goto-char m)
28045 (org-agenda-set-restriction-lock 'subtree))))
28046 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28047 'speedbar-function 'speedbar-find-file))
28048 (setq tp (previous-single-property-change
28049 (1+ p) 'speedbar-function)
28050 np (next-single-property-change
28051 tp 'speedbar-function)
28052 dir (speedbar-line-directory)
28053 txt (buffer-substring-no-properties (or tp (point-min))
28054 (or np (point-max))))
28055 (save-excursion
28056 (save-restriction
28057 (set-buffer (find-file-noselect
28058 (let ((default-directory dir))
28059 (expand-file-name txt))))
28060 (unless (org-mode-p)
28061 (error "Cannot restrict to non-Org-mode file"))
28062 (org-agenda-set-restriction-lock 'file))))
28063 (t (error "Don't know how to restrict Org-mode's agenda")))
28064 (org-move-overlay org-speedbar-restriction-lock-overlay
28065 (point-at-bol) (point-at-eol))
28066 (setq current-prefix-arg nil)
28067 (org-agenda-maybe-redo)))
28069 (eval-after-load "speedbar"
28070 '(progn
28071 (speedbar-add-supported-extension ".org")
28072 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28073 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28074 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28075 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28076 (add-hook 'speedbar-visiting-tag-hook
28077 (lambda () (org-show-context 'org-goto)))))
28080 ;;; Fixes and Hacks
28082 ;; Make flyspell not check words in links, to not mess up our keymap
28083 (defun org-mode-flyspell-verify ()
28084 "Don't let flyspell put overlays at active buttons."
28085 (not (get-text-property (point) 'keymap)))
28087 ;; Make `bookmark-jump' show the jump location if it was hidden.
28088 (eval-after-load "bookmark"
28089 '(if (boundp 'bookmark-after-jump-hook)
28090 ;; We can use the hook
28091 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28092 ;; Hook not available, use advice
28093 (defadvice bookmark-jump (after org-make-visible activate)
28094 "Make the position visible."
28095 (org-bookmark-jump-unhide))))
28097 (defun org-bookmark-jump-unhide ()
28098 "Unhide the current position, to show the bookmark location."
28099 (and (org-mode-p)
28100 (or (org-invisible-p)
28101 (save-excursion (goto-char (max (point-min) (1- (point))))
28102 (org-invisible-p)))
28103 (org-show-context 'bookmark-jump)))
28105 ;; Fix a bug in htmlize where there are text properties (face nil)
28106 (eval-after-load "htmlize"
28107 '(progn
28108 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28109 "Make sure there are no nil faces"
28110 (setq ad-return-value (delq nil ad-return-value)))))
28112 ;; Make session.el ignore our circular variable
28113 (eval-after-load "session"
28114 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28116 ;;;; Experimental code
28118 (defun org-closed-in-range ()
28119 "Sparse tree of items closed in a certain time range.
28120 Still experimental, may disappear in the future."
28121 (interactive)
28122 ;; Get the time interval from the user.
28123 (let* ((time1 (time-to-seconds
28124 (org-read-date nil 'to-time nil "Starting date: ")))
28125 (time2 (time-to-seconds
28126 (org-read-date nil 'to-time nil "End date:")))
28127 ;; callback function
28128 (callback (lambda ()
28129 (let ((time
28130 (time-to-seconds
28131 (apply 'encode-time
28132 (org-parse-time-string
28133 (match-string 1))))))
28134 ;; check if time in interval
28135 (and (>= time time1) (<= time time2))))))
28136 ;; make tree, check each match with the callback
28139 ;;;; Finish up
28141 (provide 'org)
28143 (run-hooks 'org-load-hook)
28145 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28146 ;;; org.el ends here