| blob | bdd8b2ef91265b93422d93c33e4574133cbc7d4c |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 5.21
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
67 ;;;; Require other packages
73 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
74 ;; the file noutline.el being loaded.
76 ;; We require noutline, which might be provided in outline.el
78 ;; Other stuff we need.
83 ;;;; Customization variables
85 ;;; Version
91 "Show the org-mode version in the echo area.
92 With prefix arg HERE, insert it at point."
99 ;;; Compatibility constants
108 "Return the value of symbol VAR if it is bound, else nil."
112 "Execute body without changing `buffer-modified-p'."
117 "Replace posix classes in regular expression."
125 ss))
126 s))
138 partial-completion-mode)))
145 ;;; The custom variables
148 "Outline-based notes management and organizer."
154 ;; FIXME: Needs a separate group...
157 Normal means, no org-mode-specific context."
162 "Options concerning startup of Org-mode."
167 "Non-nil means, entering Org-mode will switch to OVERVIEW.
168 This can also be configured on a per-file basis by adding one of
169 the following lines anywhere in the buffer:
171 #+STARTUP: fold
172 #+STARTUP: nofold
173 #+STARTUP: content"
181 "Non-nil means, entering Org-mode will set `truncate-lines'.
182 This is useful since some lines containing links can be very long and
183 uninteresting. Also tables look terrible when wrapped."
188 "Non-nil means, align all tables when visiting a file.
189 This is useful when the column width in tables is forced with <N> cookies
190 in table fields. Such tables will look correct only after the first re-align.
191 This can also be configured on a per-file basis by adding one of
192 the following lines anywhere in the buffer:
193 #+STARTUP: align
194 #+STARTUP: noalign"
199 "Non-nil means insert the first line setting Org-mode in empty files.
200 When the function `org-mode' is called interactively in an empty file, this
201 normally means that the file name does not automatically trigger Org-mode.
202 To ensure that the file will always be in Org-mode in the future, a
203 line enforcing Org-mode will be inserted into the buffer, if this option
204 has been set."
209 "Non-nil means use alternative key bindings for some keys.
210 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
211 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
212 If you want to use Org-mode together with one of these other modes,
213 or more generally if you would like to move some Org-mode commands to
214 other keys, set this variable and configure the keys with the variable
215 `org-disputed-keys'.
217 This option is only relevant at load-time of Org-mode, and must be set
218 *before* org.el is loaded. Changing it requires a restart of Emacs to
219 become effective."
233 "Keys for which Org-mode and other modes compete.
234 This is an alist, cars are the default keys, second element specifies
235 the alternative to use when `org-replace-disputed-keys' is t.
237 Keys can be specified in any syntax supported by `define-key'.
238 The value of this option takes effect only at Org-mode's startup,
239 therefore you'll have to restart Emacs to apply it after changing."
244 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
245 Or return the original if not disputed."
250 org-disputed-keys)))
252 key))
262 "Define a key, possibly translated, as returned by `org-key'."
266 "The ellipsis to use in the Org-mode outline.
267 When nil, just use the standard three dots. When a string, use that instead,
268 When a face, use the standart 3 dots, but with the specified face.
269 The change affects only Org-mode (which will then use its own display table).
270 Changing this requires executing `M-x org-mode' in a buffer to become
271 effective."
281 "Keywords in Org-mode."
286 "String to mark deadline entries.
287 A deadline is this string, followed by a time stamp. Should be a word,
288 terminated by a colon. You can insert a schedule keyword and
290 Changes become only effective after restarting Emacs."
295 "String to mark scheduled TODO entries.
296 A schedule is this string, followed by a time stamp. Should be a word,
297 terminated by a colon. You can insert a schedule keyword and
299 Changes become only effective after restarting Emacs."
304 "String used as the prefix for timestamps logging closing a TODO entry."
309 "String used as prefix for timestamps clocking work hours on an item."
314 "Entries starting with this keyword will never be exported.
315 An entry can be toggled between COMMENT and normal with
317 Changes become only effective after restarting Emacs."
322 "Entries starting with this keyword will be exported in fixed-width font.
323 Quoting applies only to the text in the entry following the headline, and does
324 not extend beyond the next headline, even if that is lower level.
325 An entry can be toggled between QUOTE and normal with
331 ; (concat "\\(?:\\<\\(?:" org-scheduled-string "\\|" org-deadline-string "\\)"
332 ; " +<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\)\\(\\+[0-9]+[dwmy]\\)")
334 "Regular expression for specifying repeated events.
338 "Options concerning the general structure of Org-mode files."
343 "Options about how to make context of a location visible."
367 "Non-nil means, show full hierarchy when revealing a location.
368 Org-mode often shows locations in an org-mode file which might have
369 been invisible before. When this is set, the hierarchy of headings
370 above the exposed location is shown.
371 Turning this off for example for sparse trees makes them very compact.
372 Instead of t, this can also be an alist specifying this option for different
373 contexts. Valid contexts are
374 agenda when exposing an entry from the agenda
375 org-goto when using the command `org-goto' on key C-c C-j
376 occur-tree when using the command `org-occur' on key C-c /
377 tags-tree when constructing a sparse tree based on tags matches
378 link-search when exposing search matches associated with a link
379 mark-goto when exposing the jump goal of a mark
380 bookmark-jump when exposing a bookmark location
381 isearch when exiting from an incremental search
382 default default for all contexts not set explicitly"
387 "Non-nil means, show following heading when revealing a location.
388 Org-mode often shows locations in an org-mode file which might have
389 been invisible before. When this is set, the heading following the
390 match is shown.
391 Turning this off for example for sparse trees makes them very compact,
392 but makes it harder to edit the location of the match. In such a case,
394 Instead of t, this can also be an alist specifying this option for different
395 contexts. See `org-show-hierarchy-above' for valid contexts."
400 "Non-nil means, show all sibling heading when revealing a location.
401 Org-mode often shows locations in an org-mode file which might have
402 been invisible before. When this is set, the sibling of the current entry
403 heading are all made visible. If `org-show-hierarchy-above' is t,
404 the same happens on each level of the hierarchy above the current entry.
406 By default this is on for the isearch context, off for all other contexts.
407 Turning this off for example for sparse trees makes them very compact,
408 but makes it harder to edit the location of the match. In such a case,
410 Instead of t, this can also be an alist specifying this option for different
411 contexts. See `org-show-hierarchy-above' for valid contexts."
416 "Non-nil means, show the entry below a headline when revealing a location.
417 Org-mode often shows locations in an org-mode file which might have
418 been invisible before. When this is set, the text below the headline that is
419 exposed is also shown.
421 By default this is off for all contexts.
422 Instead of t, this can also be an alist specifying this option for different
423 contexts. See `org-show-hierarchy-above' for valid contexts."
428 "Options concerning visibility cycling in Org-mode."
433 "Names of drawers. Drawers are not opened by cycling on the headline above.
434 Drawers only open with a TAB on the drawer line itself. A drawer looks like
435 this:
436 :DRAWERNAME:
437 .....
438 :END:
440 the property API.
442 Drawers can be defined on the per-file basis with a line like:
444 #+DRAWERS: HIDDEN STATE PROPERTIES"
449 "Cycle globally if cursor is at beginning of buffer and not at a headline.
450 This makes it possible to do global cycling without having to use S-TAB or
451 C-u TAB. For this special case to work, the first line of the buffer
452 must not be a headline - it may be empty ot some other text. When used in
453 this way, `org-cycle-hook' is disables temporarily, to make sure the
454 cursor stays at the beginning of the buffer.
455 When this option is nil, don't do anything special at the beginning
456 of the buffer."
461 "Where should `org-cycle' emulate TAB.
462 nil Never
463 white Only in completely white lines
464 whitestart Only at the beginning of lines, before the first non-white char
465 t Everywhere except in headlines
466 exc-hl-bol Everywhere except at the start of a headline
467 If TAB is used in a place where it does not emulate TAB, the current subtree
468 visibility is cycled."
475 ))
478 "Number of empty lines needed to keep an empty line between collapsed trees.
479 If you leave an empty line between the end of a subtree and the following
480 headline, this empty line is hidden when the subtree is folded.
481 Org-mode will leave (exactly) one empty line visible if the number of
482 empty lines is equal or larger to the number given in this variable.
483 So the default 2 means, at least 2 empty lines after the end of a subtree
484 are needed to produce free space between a collapsed subtree and the
485 following headline.
487 Special case: when 0, never leave empty lines in collapsed view."
492 org-cycle-hide-drawers
493 org-cycle-show-empty-lines
494 org-optimize-window-after-visibility-change)
495 "Hook that is run after `org-cycle' has changed the buffer visibility.
496 The function(s) in this hook must accept a single argument which indicates
497 the new state that was set by the most recent `org-cycle' command. The
498 argument is a symbol. After a global state change, it can have the values
499 `overview', `content', or `all'. After a local state change, it can have
500 the values `folded', `children', or `subtree'."
505 "Options concerning structure editing in Org-mode."
510 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
511 When t, `C-a' will bring back the cursor to the beginning of the
512 headline text, i.e. after the stars and after a possible TODO keyword.
513 In an item, this will be the position after the bullet.
514 When the cursor is already at that position, another `C-a' will bring
515 it to the beginning of the line.
516 `C-e' will jump to the end of the headline, ignoring the presence of tags
517 in the headline. A second `C-e' will then jump to the true end of the
518 line, after any tags.
519 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
520 and only a directly following, identical keypress will bring the cursor
521 to the special positions."
532 "Non-nil means `C-k' will behave specially in headlines.
533 When nil, `C-k' will call the default `kill-line' command.
534 When t, the following will happen while the cursor is in the headline:
536 - When the cursor is at the beginning of a headline, kill the entire
537 line and possible the folded subtree below the line.
538 - When in the middle of the headline text, kill the headline up to the tags.
539 - When after the headline text, kill the tags."
544 "Non-nil means, skip even levels and only use odd levels for the outline.
545 This has the effect that two stars are being added/taken away in
546 promotion/demotion commands. It also influences how levels are
547 handled by the exporters.
548 Changing it requires restart of `font-lock-mode' to become effective
549 for fontification also in regions already fontified.
550 You may also set this on a per-file basis by adding one of the following
551 lines to the buffer:
553 #+STARTUP: odd
554 #+STARTUP: oddeven"
560 "Non-nil means, adapt indentation when promoting and demoting.
561 When this is set and the *entire* text in an entry is indented, the
562 indentation is increased by one space in a demotion command, and
563 decreased by one in a promotion command. If any line in the entry
564 body starts at column 0, indentation is not changed at all."
570 "Should `org-insert-heading' leave a blank line before new heading/item?
571 The value is an alist, with `heading' and `plain-list-item' as car,
572 and a boolean flag as cdr."
579 "Hook being run after inserting a new heading."
585 This currently only means, they are never auto-wrapped.
586 When nil, such lines will be treated like ordinary lines.
587 See also the QUOTE keyword."
592 "Non-nil means, typing characters in org-goto starts incremental search."
597 "Options concerning sparse trees in Org-mode."
602 "Non-nil means, highlight all matches that define a sparse tree.
603 The highlights will automatically disappear the next time the buffer is
604 changed by an edit command."
609 "Non-nil means, any change to the buffer will remove temporary highlights.
610 Such highlights are created by `org-occur' and `org-clock-display'.
611 When nil, `C-c C-c needs to be used to get rid of the highlights.
612 The highlights created by `org-preview-latex-fragment' always need
613 `C-c C-c' to be removed."
620 "Hook that is run after `org-occur' has constructed a sparse tree.
621 This can be used to recenter the window to show as much of the structure
622 as possible."
627 "Options concerning plain lists in Org-mode."
632 "Non-nil means, include plain lists into visibility cycling.
633 This means that during cycling, plain list items will *temporarily* be
634 interpreted as outline headlines with a level given by 1000+i where i is the
635 indentation of the bullet. In all other operations, plain list items are
636 not seen as headlines. For example, you cannot assign a TODO keyword to
637 such an item."
642 "The character that makes a line with leading number an ordered list item.
643 Valid values are ?. and ?\). To get both terminators, use t. While
644 ?. may look nicer, it creates the danger that a line with leading
645 number may be incorrectly interpreted as an item. ?\) therefore is
646 the safe choice."
653 "Non-nil means, automatically renumber ordered plain lists.
654 Renumbering happens when the sequence have been changed with
661 "Non-nil means, update checkbox statistics after insert and toggle.
662 When this is set, checkbox statistics is updated each time you either insert
669 "Options concerning archiving in Org-mode."
674 "The tag that marks a subtree as archived.
675 An archived subtree does not open during visibility cycling, and does
676 not contribute to the agenda listings.
677 After changing this, font-lock must be restarted in the relevant buffers to
678 get the proper fontification."
684 "Non-nil means, the agenda will skip any items located in archived trees.
685 An archived tree is a tree marked with the tag ARCHIVE."
691 "Non-nil means, `org-cycle' will open archived trees.
692 An archived tree is a tree marked with the tag ARCHIVE.
693 When nil, archived trees will stay folded. You can still open them with
694 normal outline commands like `show-all', but not with the cycling commands."
700 "Non-nil means sparse tree construction shows matches in archived trees.
701 When nil, matches in these trees are highlighted, but the trees are kept in
702 collapsed state."
708 "The location where subtrees should be archived.
709 This string consists of two parts, separated by a double-colon.
711 The first part is a file name - when omitted, archiving happens in the same
712 file. %s will be replaced by the current file name (without directory part).
713 Archiving to a different file is useful to keep archived entries from
714 contributing to the Org-mode Agenda.
716 The part after the double colon is a headline. The archived entries will be
717 filed under that headline. When omitted, the subtrees are simply filed away
718 at the end of the file, as top-level entries.
720 Here are a few examples:
722 If the current file is Projects.org, archive in file
723 Projects.org_archive, as top-level trees. This is the default.
726 Archive in the current file, under the top-level headline
730 Archive in file ~/org/archive.org (absolute path), as top-level trees.
733 Archive in file ./basement (relative path), as level 3 trees
736 You may set this option on a per-file basis by adding to the buffer a
737 line like
739 #+ARCHIVE: basement::** Finished Tasks"
744 "Non-nil means, mark entries as DONE when they are moved to the archive file.
745 This can be a string to set the keyword to use. When t, Org-mode will
746 use the first keyword in its list that means done."
754 "Non-nil means, add a time stamp to entries moved to an archive file.
755 This variable is obsolete and has no effect anymore, instead add ot remove
756 `time' from the variablle `org-archive-save-context-info'."
761 "Parts of context info that should be stored as properties when archiving.
762 When a subtree is moved to an archive file, it looses information given by
763 context, like inherited tags, the category, and possibly also the TODO
764 state (depending on the variable `org-archive-mark-done').
765 This variable can be a list of any of the following symbols:
767 time The time of archiving.
768 file The file where the entry originates.
769 itags The local tags, in the headline of the subtree.
770 ltags The tags the subtree inherits from further up the hierarchy.
771 todo The pre-archive TODO state.
772 category The category, taken from file name or #+CATEGORY lines.
773 olpath The outline path to the item. These are all headlines above
774 the current item, separated by /, like a file path.
776 For each symbol present in the list, a property will be created in
778 information."
791 "Options concerning imenu and speedbar in Org-mode."
796 "The maximum level for Imenu access to Org-mode headlines.
797 This also applied for speedbar access."
802 "Options concerning tables in Org-mode."
808 When nil, such lines will be treated like ordinary lines.
810 When equal to the symbol `optimized', the table editor will be optimized to
811 do the following:
812 - Automatic overwrite mode in front of whitespace in table fields.
813 This makes the structure of the table stay in tact as long as the edited
814 field does not exceed the column width.
815 - Minimize the number of realigns. Normally, the table is aligned each time
816 TAB or RET are pressed to move to another field. With optimization this
817 happens only if changes to a field might have changed the column width.
818 Optimization requires replacing the functions `self-insert-command',
819 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
820 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
821 very good at guessing when a re-align will be necessary, but you can always
824 If you would like to use the optimized version in Org-mode, but the
825 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
827 This variable can be used to turn on and off the table editor during a session,
828 but in order to toggle optimization, a restart is required.
830 See also the variable `org-table-auto-blank-field'."
838 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
839 In the optimized version, the table editor takes over all simple keys that
840 normally just insert a character. In tables, the characters are inserted
841 in a way to minimize disturbing the table structure (i.e. in overwrite mode
842 for empty fields). Outside tables, the correct binding of the keys is
843 restored.
845 The default for this option is t if the optimized version is also used in
846 Org-mode. See the variable `org-enable-table-editor' for details. Changing
847 this variable requires a restart of Emacs to become effective."
853 % END RECEIVE ORGTBL %n
855 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
856 | | |
859 @c END RECEIVE ORGTBL %n
860 @ignore
861 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
862 | | |
865 <!-- END RECEIVE ORGTBL %n -->
866 <!--
867 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
868 | | |
870 "Templates for radio tables in different major modes.
871 All occurrences of %n in a template will be replaced with the name of the
872 table, obtained by prompting the user."
879 "Settings for tables in Org-mode."
884 "The default size for newly created tables, Columns x Rows."
890 "Regular expression for recognizing numbers in table columns.
891 If a table column contains mostly numbers, it will be aligned to the
892 right. If not, it will be aligned to the left.
894 The default value of this option is a regular expression which allows
895 anything which looks remotely like a number as used in scientific
896 context. For example, all of the following will be considered a
897 number:
898 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
900 Other options offered by the customize interface are more restrictive."
918 "Fraction of numbers in a column required to make the column align right.
919 In a column all non-white fields are considered. If at least this
920 fraction of fields is matched by `org-table-number-fraction',
921 alignment to the right border applies."
926 "Behavior of tables during editing in Org-mode."
931 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
933 removal/insertion."
938 "Non-nil means, automatically blank table field when starting to type into it.
939 This only happens when typing immediately after a field motion
940 command (TAB, S-TAB or RET).
941 Only relevant when `org-enable-table-editor' is equal to `optimized'."
946 "Non-nil means, tab in the last column of a table with jump over a hline.
947 If a horizontal separator line is following the current line,
948 `org-table-next-field' can either create a new row before that line, or jump
949 over the line. When this option is nil, a new line will be created before
950 this line."
955 "Non-nil means, TAB will automatically notice a table.el table.
956 When it sees such a table, it moves point into it and - if necessary -
957 calls `table-recognize-table'."
962 "Options concerning tables in Org-mode."
967 "Should org-mode work with table refrences like B3 instead of @3$2?
968 Possible values are:
969 nil never use them
970 from accept as input, do not present for editing
971 t: accept as input and present for editing"
986 calc-angle-mode deg
987 calc-prefer-frac nil
988 calc-symbolic-mode nil
990 calc-display-working-message t
991 )
992 "List with Calc mode settings for use in calc-eval for table formulas.
993 The list must contain alternating symbols (Calc modes variables and values).
994 Don't remove any of the default settings, just change the values. Org-mode
995 relies on the variables to be present in the list."
1000 "Non-nil means, TAB and RET evaluate a formula in current table field.
1001 If the current field starts with an equal sign, it is assumed to be a formula
1002 which should be evaluated as described in the manual and in the documentation
1003 string of the command `org-table-eval-formula'. This feature requires the
1004 Emacs calc package.
1005 When this variable is nil, formula calculation is only available through
1011 "Non-nil means, interpret constants in formulas in tables.
1012 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
1013 by the value given in `org-table-formula-constants', or by a value obtained
1014 from the `constants.el' package."
1019 "Alist with constant names and values, for use in table formulas.
1020 The car of each element is a name of a constant, without the `$' before it.
1021 The cdr is the value as a string. For example, if you'd like to use the
1022 speed of light in a formula, you would configure
1026 and then use it in an equation like `$1*$c'.
1028 Constants can also be defined on a per-file basis using a line like
1030 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1041 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1042 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1047 "Options concerning links in Org-mode."
1052 "Buffer-local version of `org-link-abbrev-alist', which see.
1057 "Alist of link abbreviations.
1058 The car of each element is a string, to be replaced at the start of a link.
1060 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1062 [[linkkey:tag][description]]
1064 If REPLACE is a string, the tag will simply be appended to create the link.
1067 REPLACE may also be a function that will be called with the tag as the
1068 only argument to create the link, which should be returned as a string.
1070 See the manual for examples."
1075 "Non-nil means, hide link part and only show description of bracket links.
1076 Bracket links are like [[link][descritpion]]. This variable sets the initial
1077 state in new org-mode buffers. The setting can then be toggled on a
1078 per-buffer basis from the Org->Hyperlinks menu."
1083 "How the path name in file links should be stored.
1084 Valid values are:
1086 relative Relative to the current directory, i.e. the directory of the file
1087 into which the link is being inserted.
1088 absolute Absolute path, if possible with ~ for home directory.
1089 noabbrev Absolute path, no abbreviation of home directory.
1090 adaptive Use relative path for files in the current directory and sub-
1091 directories of it. For other files, use an absolute path."
1100 "Types of links that should be activated in Org-mode files.
1101 This is a list of symbols, each leading to the activation of a certain link
1102 type. In principle, it does not hurt to turn on most link types - there may
1103 be a small gain when turning off unused link types. The types are:
1105 bracket The recommended [[link][description]] or [[link]] links with hiding.
1106 angular Links in angular brackes that may contain whitespace like
1107 <bbdb:Carsten Dominik>.
1108 plain Plain links in normal text, no whitespace, like http://google.com.
1109 radio Text that is matched by a radio target, see manual for details.
1110 tag Tag settings in a headline (link to tag search).
1111 date Time stamps (link to calendar).
1113 Changing this variable requires a restart of Emacs to become effective."
1124 "Options concerning storing links in Org-mode"
1129 "Format of the description part of a link to an email or usenet message.
1130 The following %-excapes will be replaced by corresponding information:
1138 %s subject
1139 %m message-id.
1141 You may use normal field width specification between the % and the letter.
1142 This is for example useful to limit the length of the subject.
1156 It should match if the message is from the user him/herself."
1161 "Non-nil means, file links from `org-store-link' contain context.
1162 A search string will be added to the file name with :: as separator and
1163 used to find the context when the link is activated by the command
1164 `org-open-at-point'.
1166 negates this setting for the duration of the command."
1171 "Non-nil means, keep link in list for entire session.
1173 The command `org-store-link' adds a link pointing to the current
1174 location to an internal list. These links accumulate during a session.
1175 The command `org-insert-link' can be used to insert links into any
1176 Org-mode file (offering completion for all stored links). When this
1178 will be removed from the list, to make completing the unused links
1179 more efficient."
1184 "Non-nil means, `org-store-link' will create web links to Google groups.
1185 When nil, Gnus will be used for such links.
1187 negates this setting for the duration of the command."
1192 "Options concerning following links in Org-mode"
1197 "Non-nil means, on links TAB will follow the link.
1198 Needs to be set before org.el is loaded."
1203 "Non-nil means, on links RET will follow the link.
1204 Needs to be set before org.el is loaded."
1209 "Non-nil means, mouse-1 on a link will follow the link.
1210 A longer mouse click will still set point. Does not wortk on XEmacs.
1211 Needs to be set before org.el is loaded."
1216 "Number of different positions to be recorded in the ring
1217 Changing this requires a restart of Emacs to work correctly."
1225 "Setup the frame configuration for following links.
1226 When following a link with Emacs, it may often be useful to display
1227 this link in another window or frame. This variable can be used to
1228 set this up for the different types of links.
1229 For VM, use any of
1230 `vm-visit-folder'
1231 `vm-visit-folder-other-frame'
1232 For Gnus, use any of
1233 `gnus'
1234 `gnus-other-frame'
1235 For FILE, use any of
1236 `find-file'
1237 `find-file-other-window'
1238 `find-file-other-frame'
1239 For the calendar, use the variable `calendar-setup'.
1240 For BBDB, it is currently only possible to display the matches in
1241 another window."
1260 "Non-nil means, use indirect buffer to display infile links.
1261 Activating internal links (from one location in a file to another location
1262 in the same file) normally just jumps to the location. When the link is
1263 activated with a C-u prefix (or with mouse-3), the link is displayed in
1264 another window. When this option is set, the other window actually displays
1265 an indirect buffer clone of the current buffer, to avoid any visibility
1266 changes to the current buffer."
1271 "Non-nil means, `org-open-file' will open non-existing files.
1272 When nil, an error will be generated."
1277 "Function and arguments to call for following mailto links.
1278 This is a list with the first element being a lisp function, and the
1279 remaining elements being arguments to the function. In string arguments,
1280 %a will be replaced by the address, and %s will be replaced by the subject
1281 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1290 "Non-nil means, ask for confirmation before executing shell links.
1291 Shell links can be dangerous: just think about a link
1293 [[shell:rm -rf ~/*][Google Search]]
1296 but really it would remove your entire home directory.
1297 Therefore we advise against setting this variable to nil.
1298 Just change it to `y-or-n-p' of you want to confirm with a
1307 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1308 Elisp links can be dangerous: just think about a link
1313 but really it would remove your entire home directory.
1314 Therefore we advise against setting this variable to nil.
1315 Just change it to `y-or-n-p' of you want to confirm with a
1326 "Default file applications on a UNIX or GNU/Linux system.
1338 "Default file applications on a MacOS X system.
1340 for some files for which the OS does not have a good default.
1348 'mswindows-shell-execute
1351 "Default file applications on a Windows NT system.
1356 '(
1363 )
1364 "External applications for opening `file:path' items in a document.
1365 Org-mode uses system defaults for different file types, but
1366 you can use this variable to set the application for a given file
1367 extension. The entries in this list are cons cells where the car identifies
1368 files and the cdr the corresponding command. Possible values for the
1369 file identifier are
1371 `directory' Matches a directory
1372 `remote' Matches a remote file, accessible through tramp or efs.
1373 Remote files most likely should be visited through Emacs
1374 because external applications cannot handle such paths.
1375 t Default for all remaining files
1377 Possible values for the command are:
1378 `emacs' The file will be visited by the current Emacs process.
1379 `default' Use the default application for this file type.
1380 string A command to be executed by a shell; %s will be replaced
1381 by the path to the file.
1382 sexp A Lisp form which will be evaluated. The file path will
1383 be available in the Lisp variable `file'.
1384 For more examples, see the system specific constants
1385 `org-file-apps-defaults-macosx'
1386 `org-file-apps-defaults-windowsnt'
1387 `org-file-apps-defaults-gnu'."
1402 "Non-nil means, that the search for the mh-message will be extended to
1403 all folders if the message cannot be found in the folder given in the link.
1404 Searching all folders is very efficient with one of the search engines
1405 supported by MH-E, but will be slow with pick."
1410 "Options concerning interaction with remember.el."
1415 "Directory with org files.
1416 This directory will be used as default to prompt for org files.
1417 Used by the hooks for remember.el."
1422 "Default target for storing notes.
1423 Used by the hooks for remember.el. This can be a string, or nil to mean
1424 the value of `remember-data-file'.
1425 You can set this on a per-template basis with the variable
1426 `org-remember-templates'."
1430 file))
1433 "Non-nil means, `C-c C-c' stores remember note without further promts.
1434 In this case, you need `C-u C-c C-c' to get the prompts for
1435 note file and headline.
1436 When this variable is nil, `C-c C-c' give you the prompts, and
1437 `C-u C-c C-c' trigger the fasttrack."
1442 "The interface to be used for interactive filing of remember notes.
1443 This is only used when the interactive mode for selecting a filing
1444 location is used (see the variable `org-remember-store-without-prompt').
1445 Allowed vaues are:
1446 outline The interface shows an outline of the relevant file
1447 and the correct heading is found by moving through
1448 the outline or by searching with incremental search.
1449 outline-path-completion Headlines in the current buffer are offered via
1450 completion.
1451 refile Use the refile interface, and offer headlines,
1452 possibly from different buffers."
1460 "The default interface to be used for `org-goto'.
1461 Allowed vaues are:
1462 outline The interface shows an outline of the relevant file
1463 and the correct heading is found by moving through
1464 the outline or by searching with incremental search.
1465 outline-path-completion Headlines in the current buffer are offered via
1466 completion."
1473 "The headline that should be the default location in the notes file.
1474 When filing remember notes, the cursor will start at that position.
1475 You can set this on a per-template basis with the variable
1476 `org-remember-templates'."
1481 "Templates for the creation of remember buffers.
1482 When nil, just let remember make the buffer.
1483 When not nil, this is a list of 5-element lists. In each entry, the first
1484 element is the name of the template, which should be a single short word.
1485 The second element is a character, a unique key to select this template.
1486 The third element is the template. The fourth element is optional and can
1487 specify a destination file for remember items created with this template.
1488 The default file is given by `org-default-notes-file'. An optional fifth
1489 element can specify the headline in that file that should be offered
1490 first when the user is asked to file the entry. The default headline is
1491 given in the variable `org-remember-default-headline'.
1493 The template specifies the structure of the remember buffer. It should have
1494 a first line starting with a star, to act as the org-mode headline.
1495 Furthermore, the following %-escapes will be replaced with content:
1497 %^{prompt} Prompt the user for a string and replace this sequence with it.
1498 A default value and a completion table ca be specified like this:
1499 %^{prompt|default|completion2|completion3|...}
1500 %t time stamp, date only
1501 %T time stamp with date and time
1502 %u, %U like the above, but inactive time stamps
1503 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1504 You may define a prompt like %^{Please specify birthday}t
1505 %n user name (taken from `user-full-name')
1506 %a annotation, normally the link created with org-store-link
1507 %i initial content, the region active. If %i is indented,
1508 the entire inserted text will be indented as well.
1509 %c content of the clipboard, or current kill ring head
1510 %^g prompt for tags, with completion on tags in target file
1511 %^G prompt for tags, with completion all tags in all agenda files
1512 %:keyword specific information for certain link types, see below
1513 %[pathname] insert the contents of the file given by `pathname'
1514 %(sexp) evaluate elisp `(sexp)' and replace with the result
1515 %! Store this note immediately after filling the template
1517 %? After completing the template, position cursor here.
1519 Apart from these general escapes, you can access information specific to the
1520 link type that is created. For example, calling `remember' in emails or gnus
1521 will record the author and the subject of the message, which you can access
1522 with %:author and %:subject, respectively. Here is a complete list of what
1523 is recorded for each link type.
1525 Link type | Available information
1526 -------------------+------------------------------------------------------
1527 bbdb | %:type %:name %:company
1528 vm, wl, mh, rmail | %:type %:subject %:message-id
1529 | %:from %:fromname %:fromaddress
1530 | %:to %:toname %:toaddress
1532 gnus | %:group, for messages also all email fields
1533 w3, w3m | %:type %:url
1534 info | %:type %:file %:node
1535 calendar | %:type %:date"
1558 "Non-nil means, store new notes at the beginning of a file or entry.
1559 When nil, new notes will be filed to the end of a file or entry.
1560 This can also be a list with cons cells of regular expressions that
1561 are matched against file names, and values."
1571 This is list of cons cells. Each cell contains:
1572 - a specification of the files to be considered, either a list of files,
1573 or a symbol whose function or value fields will be used to retrieve
1574 a file name or a list of file names. Nil means, refile to a different
1575 heading in the current buffer.
1576 - A specification of how to find candidate refile targets. This may be
1577 any of
1579 This tag has to be present in all target headlines, inheritance will
1580 not be considered.
1582 todo keyword.
1584 headlines that are refiling targets.
1585 - a cons cell (:level . N). Any headline of level N is considered a target.
1586 - a cons cell (:maxlevel . N). Any headline with level <= N is a target."
1587 ;; FIXME: what if there are a var and func with same name???
1603 "Non-nil means, provide refile targets as paths.
1604 So a level 3 headline will be available as level1/level2/level3.
1605 When the value is `file', also include the file name (without directory)
1606 into the path. When `full-file-path', include the full file path."
1615 "Options concerning TODO items in Org-mode."
1620 "Options concerning Progress logging in Org-mode."
1625 "List of TODO entry keyword sequences and their interpretation.
1628 Each sequence starts with a symbol, either `sequence' or `type',
1629 indicating if the keywords should be interpreted as a sequence of
1630 action steps, or as different types of TODO items. The first
1631 keywords are states requiring action - these states will select a headline
1632 for inclusion into the global TODO list Org-mode produces. If one of
1635 the last keyword is treated as the only DONE state of the sequence.
1638 additional state where no keyword is present. For details about this
1639 cycling, see the manual.
1641 TODO keywords and interpretation can also be set on a per-file basis with
1642 the special #+SEQ_TODO and #+TYP_TODO lines.
1644 For backward compatibility, this variable may also be just a list
1645 of keywords - in this case the interptetation (sequence or type) will be
1646 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1683 "Controls how TODO keywords are interpreted.
1684 This variable is in principle obsolete and is only used for
1685 backward compatibility, if the interpretation of todo keywords is
1686 not given already in `org-todo-keywords'. See that variable for
1687 more information."
1694 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1695 This variable describes if and under what circumstances the cycling
1696 mechanism for TODO keywords will be replaced by a single-key, direct
1697 selection scheme.
1699 When nil, fast selection is never used.
1701 When the symbol `prefix', it will be used when `org-todo' is called with
1702 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1703 in an agenda buffer.
1705 When t, fast selection is used by default. In this case, the prefix
1706 argument forces cycling instead.
1708 In all cases, the special interface is only used if access keys have actually
1709 been assigned by the user, i.e. if keywords in the configuration are followed
1710 by a letter in parenthesis, like TODO(t)."
1718 "Hook which is run after the state of a TODO item was changed.
1719 The new state (a string with a TODO keyword, or nil) is available in the
1720 Lisp variable `state'."
1725 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1726 When the state of an entry is changed from nothing or a DONE state to
1727 a not-done TODO state, remove a previous closing date.
1729 This can also be a list of symbols indicating under which conditions
1730 the time stamp recording the action should be annotated with a short note.
1731 Valid members of this list are
1733 done Offer to record a note when marking entries done
1734 state Offer to record a note whenever changing the TODO state
1735 of an item. This is only relevant if TODO keywords are
1736 interpreted as sequence, see variable `org-todo-interpretation'.
1737 When `state' is set, this includes tracking `done'.
1738 clock-out Offer to record a note when clocking out of an item.
1740 A separate window will then pop up and allow you to type a note.
1741 After finishing with C-c C-c, the note will be added directly after the
1742 timestamp, as a plain list item. See also the variable
1743 `org-log-note-headings'.
1745 Logging can also be configured on a per-file basis by adding one of
1746 the following lines anywhere in the buffer:
1748 #+STARTUP: logdone
1749 #+STARTUP: nologging
1750 #+STARTUP: lognotedone
1751 #+STARTUP: lognotestate
1752 #+STARTUP: lognoteclock-out
1754 You can have local logging settings for a subtree by setting the LOGGING
1755 property to one or more of these keywords."
1767 "Non-nil means, the CLOSED time stamp will contain date and time.
1768 When nil, only the date will be recorded."
1776 "Headings for notes added when clocking out or closing TODO items.
1777 The value is an alist, with the car being a symbol indicating the note
1778 context, and the cdr is the heading to be used. The heading may also be the
1779 empty string.
1780 %t in the heading will be replaced by a time stamp.
1781 %s will be replaced by the new TODO state, in double quotes.
1782 %u will be replaced by the user name.
1783 %U will be replaced by the full user name."
1789 "Heading when changing todo state (todo sequence only)"
1794 "Non-nil means, the latest state change note will be directly after heading.
1795 When nil, the notes will be orderer according to time."
1801 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1802 When nil, no note will be taken.
1803 This option can also be set with on a per-file-basis with
1805 #+STARTUP: logrepeat
1806 #+STARTUP: nologrepeat
1808 You can have local logging settings for a subtree by setting the LOGGING
1809 property to one or more of these keywords."
1815 "Should clocking info be wrapped into a drawer?
1816 When t, clocking info will always be inserted into a :CLOCK: drawer.
1817 If necessary, the drawer will be created.
1818 When nil, the drawer will not be created, but used when present.
1819 When an integer and the number of clocking entries in an item
1820 reaches or exceeds this number, a drawer will be created."
1829 "When t, the clock will be stopped when the relevant entry is marked DONE.
1830 Nil means, clock will keep running until stopped explicitly with
1831 `C-c C-x C-o', or until the clock is started in a different item."
1836 "Set task to a special todo state while clocking it.
1837 The value should be the state to which the entry should be switched."
1845 "Priorities in Org-mode."
1850 "The highest priority of TODO items. A character like ?A, ?B etc.
1851 Must have a smaller ASCII number than `org-lowest-priority'."
1856 "The lowest priority of TODO items. A character like ?A, ?B etc.
1857 Must have a larger ASCII number than `org-highest-priority'."
1862 "The default priority of TODO items.
1863 This is the priority an item get if no explicit priority is given."
1868 "Non-nil means, start with default priority when starting to cycle.
1869 When this is nil, the first step in the cycle will be (depending on the
1870 command used) one higher or lower that the default priority."
1875 "Options concerning time stamps and deadlines in Org-mode."
1880 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1881 When nil, these labeled time stamps are forces into the second line of an
1882 entry, just after the headline. When scheduling from the global TODO list,
1883 the time stamp will always be forced into the second line."
1888 "Formats for `format-time-string' which are used for time stamps.
1892 "Number of minutes to round time stamps to upon insertion.
1893 When zero, insert the time unmodified. Useful rounding numbers
1894 should be factors of 60, so for example 5, 10, 15.
1895 When this is not zero, you can still force an exact time-stamp by using
1896 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1901 "Non-nil means, overlay custom formats over all time stamps.
1902 The formats are defined through the variable `org-time-stamp-custom-formats'.
1903 To turn this on on a per-file basis, insert anywhere in the file:
1904 #+STARTUP: customtime"
1912 "Custom formats for time stamps. See `format-time-string' for the syntax.
1913 These are overlayed over the default ISO format if the variable
1914 `org-display-custom-times' is set. Time like %H:%M should be at the
1915 end of the second format."
1920 "Get the right format for a time string."
1925 f)))
1928 "Non-nil means, assume future for incomplete date input from user.
1929 This affects the following situations:
1930 1. The user gives a day, but no month.
1933 it will be considered as *this* month.
1934 2. The user gives a month but not a year.
1938 When this option is nil, the current month and year will always be used
1939 as defaults."
1944 "Non-nil means, display current interpretation of date prompt live.
1945 This display will be in an overlay, in the minibuffer."
1950 "Non-nil means, pop up a calendar when prompting for a date.
1951 In the calendar, the date can be selected with mouse-1. However, the
1952 minibuffer will also be active, and you can simply enter the date as well.
1953 When nil, only the minibuffer will be available."
1961 "The hour when your day really ends.
1962 This has influence for the following applications:
1964 the time given here, the day recognized as TODAY is actually yesterday.
1965 - When a date is read from the user and it is still before the time given
1966 here, the current date and time will be assumed to be yesterday, 23:59.
1968 FIXME:
1969 IMPORTANT: This is still a very experimental feature, it may disappear
1970 again or it may be extended to mean more things."
1975 "Non-nil means, S-down will increase the time in a time stamp.
1976 When nil, S-up will increase."
1981 "Non-nil means, make the calendar window follow timestamp changes.
1982 When a timestamp is modified and the calendar window is visible, it will be
1983 moved to the new date."
1988 "When non-nil, should be a function to create `org-clock-heading'.
1989 This is the string shown in the mode line when a clock is running.
1990 The function is called with point at the beginning of the headline."
1995 "Options concerning tags in Org-mode."
2000 "List of tags allowed in Org-mode files.
2001 When this list is nil, Org-mode will base TAG input on what is already in the
2002 buffer.
2003 The value of this variable is an alist, the car of each entry must be a
2004 keyword as a string, the cdr may be a character that is used to select
2005 that tag through the fast-tag-selection interface.
2006 See the manual for details."
2016 "Non-nil means, use fast tag selection scheme.
2017 This is a special interface to select and deselect tags with single keys.
2018 When nil, fast selection is never used.
2019 When the symbol `auto', fast selection is used if and only if selection
2020 characters for tags have been configured, either through the variable
2021 `org-tag-alist' or through a #+TAGS line in the buffer.
2022 When t, fast selection is always used and selection keys are assigned
2023 automatically if necessary."
2031 "Non-nil means, fast tag selection exits after first change.
2032 When nil, you have to press RET to exit it.
2033 During fast tag selection, you can toggle this flag with `C-c'.
2034 This variable can also have the value `expert'. In this case, the window
2035 displaying the tags menu is not even shown, until you press C-c again."
2043 "Non-nil means, fast tags selection interface will also offer TODO states.
2047 "The column to which tags should be indented in a headline.
2048 If this number is positive, it specifies the column. If it is negative,
2049 it means that the tags should be flushright to that column. For example,
2050 -80 works well for a normal 80 character screen."
2055 "Non-nil means, realign tags after pro/demotion of TODO state change.
2056 These operations change the length of a headline and therefore shift
2057 the tags around. With this options turned on, after each such operation
2058 the tags are again aligned to `org-tags-column'."
2063 "Non-nil means, tags in levels apply also for sublevels.
2064 When nil, only the tags directly given in a specific line apply there.
2065 If you turn off this option, you very likely want to turn on the
2066 companion option `org-tags-match-list-sublevels'."
2071 "Non-nil means list also sublevels of headlines matching tag search.
2072 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2073 the sublevels of a headline matching a tag search often also match
2074 the same search. Listing all of them can create very long lists.
2075 Setting this variable to nil causes subtrees of a match to be skipped.
2076 This option is off by default, because inheritance in on. If you turn
2077 inheritance off, you very likely want to turn this option on.
2079 As a special case, if the tag search is restricted to TODO items, the
2080 value of this variable is ignored and sublevels are always checked, to
2081 make sure all corresponding TODO items find their way into the list."
2093 "Options concerning properties in Org-mode."
2098 "How property key/value pairs should be formatted by `indent-line'.
2099 When `indent-line' hits a property definition, it will format the line
2100 according to this format, mainly to make sure that the values are
2101 lined-up with respect to each other."
2106 "Non-nil means, properties apply also for sublevels.
2107 This setting is only relevant during property searches, not when querying
2108 an entry with `org-entry-get'. To retrieve a property with inheritance,
2109 you need to call `org-entry-get' with the inheritance flag.
2110 Turning this on can cause significant overhead when doing a search, so
2111 this is turned off by default.
2112 When nil, only the properties directly given in the current entry count.
2113 The value may also be a list of properties that shouldhave inheritance.
2115 However, note that some special properties use inheritance under special
2116 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2118 for valid values of a property."
2126 "The default column format, if no other format has been defined.
2127 This variable can be set on the per-file basis by inserting a line
2129 #+COLUMNS: %25ITEM ....."
2134 "List of property/value pairs that can be inherited by any entry.
2135 You can set buffer-local values for this by adding lines like
2137 #+PROPERTY: NAME VALUE"
2144 "List of property/value pairs that can be inherited by any entry.
2145 Valid for the current buffer.
2149 "Options concerning agenda views in Org-mode."
2154 "Variable used by org files to set a category for agenda display.
2155 Such files should use a file variable to set it, for example
2159 or contain a special line
2161 #+CATEGORY: ELisp
2163 If the file does not specify a category, then file's base name
2168 "The files to be used for agenda display.
2172 If an entry is a directory, all files in that directory that are matched by
2173 `org-agenda-file-regexp' will be part of the file list.
2175 If the value of the variable is not a list but a single file name, then
2176 the list of agenda files is actually stored and maintained in that file, one
2177 agenda file per line."
2184 "Regular expression to match files for `org-agenda-files'.
2185 If any element in the list in that variable contains a directory instead
2186 of a normal file, all files in that directory that are matched by this
2187 regular expression will be included."
2192 "t means to just skip non-reachable files in `org-agenda-files'.
2193 Nil means to remove them, after a query, from the list."
2198 "List of extra files to be searched by `org-occur-in-agenda-files'.
2199 The files in `org-agenda-files' are always searched."
2204 "When set, remote killing from the agenda buffer needs confirmation.
2205 When t, a confirmation is always needed. When a number N, confirmation is
2206 only needed when the text to be killed contains more than N non-white lines."
2214 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2215 The command `org-calendar-goto-agenda' will be bound to this key. The
2216 default is the character `c' because then `c' can be used to switch back and
2217 forth between agenda and calendar."
2222 "Non-nil means, make the block agenda more compact.
2223 This is done by leaving out unnecessary lines."
2228 "Options concerning exporting agenda views in Org-mode."
2233 "Non-nil means, use colors in agenda views."
2238 "Alist of variable/value pairs that should be active during agenda export.
2239 This is a good place to set uptions for ps-print and for htmlize."
2247 "The style specification for exported HTML Agenda files.
2248 If this variable contains a string, it will replace the default <style>
2249 section as produced by `htmlize'.
2250 Since there are different ways of setting style information, this variable
2251 needs to contain the full HTML structure to provide a style, including the
2252 surrounding HTML tags. The style specifications should include definitions
2253 the fonts used by the agenda, here is an example:
2256 p { font-weight: normal; color: gray; }
2257 .org-agenda-structure {
2258 font-size: 110%;
2259 color: #003399;
2260 font-weight: 600;
2261 }
2262 .org-todo {
2263 color: #cc6666;Week-agenda:
2264 font-weight: bold;
2265 }
2266 .org-done {
2267 color: #339933;
2268 }
2269 .title { text-align: center; }
2270 .todo, .deadline { color: red; }
2271 .done { color: green; }
2272 </style>
2274 or, if you want to keep the style in a file,
2278 As the value of this option simply gets inserted into the HTML <head> header,
2280 <style>...</style> is required, if not present the variable will be ignored."
2286 "Options concerning agenda views in Org-mode."
2291 "Custom commands for the agenda.
2292 These commands will be offered on the splash screen displayed by the
2295 (key desc type match options files)
2297 key The key (one or more characters as a string) to be associated
2298 with the command.
2299 desc A description of the commend, when omitted or nil, a default
2300 description is built using MATCH.
2301 type The command type, any of the following symbols:
2302 todo Entries with a specific TODO keyword, in all agenda files.
2303 tags Tags match in all agenda files.
2304 tags-todo Tags match in all agenda files, TODO entries only.
2305 todo-tree Sparse tree of specific TODO keyword in *current* file.
2306 tags-tree Sparse tree with all tags matches in *current* file.
2307 occur-tree Occur sparse tree for *current* file.
2308 ... A user-defined function.
2309 match What to search for:
2310 - a single keyword for TODO keyword searches
2311 - a tags match expression for tags searches
2312 - a regular expression for occur searches
2313 options A list of option settings, similar to that in a let form, so like
2314 this: ((opt1 val1) (opt2 val2) ...)
2315 files A list of files file to write the produced agenda buffer to
2316 with the command `org-store-agenda-views'.
2319 produced. Otherwide, only the plain text is written to the file.
2321 You can also define a set of commands, to create a composite agenda buffer.
2322 In this case, an entry looks like this:
2324 (key desc (cmd1 cmd2 ...) general-options file)
2326 where
2328 desc A description string to be displayed in the dispatcher menu.
2329 cmd An agenda command, similar to the above. However, tree commands
2330 are no allowed, but instead you can get agenda and global todo list.
2331 So valid commands for a set are:
2332 (agenda)
2333 (alltodo)
2334 (stuck)
2339 Each command can carry a list of options, and another set of options can be
2340 given for the whole set of commands. Individual command options take
2341 precedence over the general options.
2343 When using several characters as key to a command, the first characters
2344 are prefix commands. For the dispatcher to display useful information, you
2345 should provide a description for the prefix, like
2347 (setq org-agenda-custom-commands
2419 "How to identify stuck projects.
2420 This is a list of four items:
2421 1. A tags/todo matcher string that is used to identify a project.
2422 The entire tree below a headline matched by this is considered one project.
2423 2. A list of TODO keywords identifying non-stuck projects.
2424 If the project subtree contains any headline with one of these todo
2425 keywords, the project is considered to be not stuck. If you specify
2427 3. A list of tags identifying non-stuck projects.
2428 If the project subtree contains any headline with one of these tags,
2430 a tag, any tag will mark the project unstuck.
2431 4. An arbitrary regular expression matching non-stuck projects.
2434 or `C-c a #' to produce the list."
2438 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2444 "Options concerning skipping parts of agenda files."
2449 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2450 When nil, the sublevels of a TODO entry are not checked, resulting in
2451 potentially much shorter TODO lists."
2457 "Non-nil means, don't show entries with a date in the global todo list.
2458 You can use this if you prefer to mark mere appointments with a TODO keyword,
2459 but don't want them to show up in the TODO list.
2460 When this is set, it also covers deadlines and scheduled items, the settings
2461 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2462 will be ignored."
2468 "Non-nil means, don't show scheduled entries in the global todo list.
2469 The idea behind this is that by scheduling it, you have already taken care
2470 of this item.
2471 See also `org-agenda-todo-ignore-with-date'."
2477 "Non-nil means, don't show near deadline entries in the global todo list.
2478 Near means closer than `org-deadline-warning-days' days.
2479 The idea behind this is that such items will appear in the agenda anyway.
2480 See also `org-agenda-todo-ignore-with-date'."
2486 "Non-nil means don't show scheduled items in agenda when they are done.
2487 This is relevant for the daily/weekly agenda, not for the TODO list. And
2488 it applies only to the actual date of the scheduling. Warnings about
2489 an item with a past scheduling dates are always turned off when the item
2490 is DONE."
2495 "Non-nil means don't show deadines when the corresponding item is done.
2496 When nil, the deadline is still shown and should give you a happy feeling.
2497 This is relevant for the daily/weekly agenda. And it applied only to the
2498 actualy date of the deadline. Warnings about approching and past-due
2499 deadlines are always turned off when the item is DONE."
2504 "Non-nil means don't select item by timestamp or -range if it is DONE."
2509 "Non-nil means, `org-timeline' also shows dates without an entry.
2510 When nil, only the days which actually have entries are shown.
2511 When t, all days between the first and the last date are shown.
2512 When an integer, show also empty dates, but if there is a gap of more than
2513 N days, just insert a special line indicating the size of the gap."
2522 "Options concerning initial settings in the Agenda in Org Mode."
2527 "Hook run just before displaying an agenda buffer."
2532 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2533 A longer mouse click will still set point. Does not wortk on XEmacs.
2534 Needs to be set before org.el is loaded."
2539 "The initial value of follow-mode in a newly created agenda window."
2544 "Options concerning the windows used by the Agenda in Org Mode."
2549 "How the agenda buffer should be displayed.
2550 Possible values for this option are:
2552 current-window Show agenda in the current window, keeping all other windows.
2553 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2554 other-window Use `switch-to-buffer-other-window' to display agenda.
2555 reorganize-frame Show only two windows on the current frame, the current
2556 window and the agenda.
2557 See also the variable `org-agenda-restore-windows-after-quit'."
2566 "The min and max height of the agenda window as a fraction of frame height.
2567 The value of the variable is a cons cell with two numbers between 0 and 1.
2568 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2573 "Non-nil means, restore window configuration open exiting agenda.
2574 Before the window configuration is changed for displaying the agenda,
2575 the current status is recorded. When the agenda is exited with
2576 `q' or `x' and this option is set, the old state is restored. If
2577 `org-agenda-window-setup' is `other-frame', the value of this
2578 option will be ignored.."
2583 "How should indirect tree buffers be displayed?
2584 This applies to indirect buffers created with the commands
2586 Valid values are:
2587 current-window Display in the current window
2588 other-window Just display in another window.
2589 dedicated-frame Create one new frame, and re-use it each time.
2590 new-frame Make a new frame each time. Note that in this case
2591 previously-made indirect buffers are kept, and you need to
2592 kill these buffers yourself."
2602 "Options concerning the daily/weekly agenda."
2607 "Number of days to include in overview display.
2608 Should be 1 or 7."
2613 "Non-nil means, start the overview always on the specified weekday.
2614 0 denotes Sunday, 1 denotes Monday etc.
2615 When nil, always start on the current day."
2621 "Non-nil means, `org-agenda' shows every day in the selected range.
2622 When nil, only the days which actually have entries are shown."
2627 "Format string for displaying dates in the agenda.
2628 Used by the daily/weekly agenda and by the timeline. This should be
2629 a format string understood by `format-time-string', or a function returning
2630 the formatted date as a string. The function must take a single argument,
2631 a calendar-style date list like (month day year)."
2638 "Format a date string for display in the daily/weekly agenda, or timeline.
2639 This function makes sure that dates are aligned for easy reading."
2647 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2652 "Set means weekly/daily agenda will always contain all TODO entries.
2653 The TODO entries will be listed at the top of the agenda, before
2654 the entries for specific days."
2659 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2660 When nil, only one occurence is shown, either today or the
2661 nearest into the future."
2666 "No. of days before expiration during which a deadline becomes active.
2667 This variable governs the display in sparse trees and in the agenda.
2668 When negative, it means use this number (the absolute value of it)
2669 even if a deadline has a different individual lead time specified."
2675 "No. of days to continue listing scheduled items that are not marked DONE.
2676 When an item is scheduled on a date, it shows up in the agenda on this
2677 day and will be listed until it is marked done for the number of days
2678 given here."
2683 "Options concerning the time grid in the Org-mode Agenda."
2688 "Non-nil means, show a time grid in the agenda schedule.
2689 A time grid is a set of lines for specific times (like every two hours between
2690 8:00 and 20:00). The items scheduled for a day at specific times are
2691 sorted in between these lines.
2692 For details about when the grid will be shown, and what it will look like, see
2693 the variable `org-agenda-time-grid'."
2699 "----------------"
2702 "The settings for time grid for agenda display.
2703 This is a list of three items. The first item is again a list. It contains
2704 symbols specifying conditions when the grid should be displayed:
2706 daily if the agenda shows a single day
2707 weekly if the agenda shows an entire week
2708 today show grid on current date, independent of daily/weekly display
2709 require-timed show grid only if at least one item has a time specification
2711 The second item is a string which will be places behing the grid time.
2713 The third item is a list of integers, indicating the times that should have
2714 a grid line."
2716 :type
2723 require-timed)
2725 remove-match))
2730 "Options concerning sorting in the Org-mode Agenda."
2746 "Sorting structure for the agenda items of a single day.
2747 This is a list of symbols which will be used in sequence to determine
2748 if an entry should be listed before another entry. The following
2749 symbols are recognized:
2751 time-up Put entries with time-of-day indications first, early first
2752 time-down Put entries with time-of-day indications first, late first
2753 category-keep Keep the default order of categories, corresponding to the
2754 sequence in `org-agenda-files'.
2755 category-up Sort alphabetically by category, A-Z.
2756 category-down Sort alphabetically by category, Z-A.
2757 tag-up Sort alphabetically by last tag, A-Z.
2758 tag-down Sort alphabetically by last tag, Z-A.
2759 priority-up Sort numerically by priority, high priority last.
2760 priority-down Sort numerically by priority, high priority first.
2762 The different possibilities will be tried in sequence, and testing stops
2764 '(time-up category-keep priority-down)
2765 means: Pull out all entries having a specified time of day and sort them,
2766 in order to make a time schedule for the current day the first thing in the
2767 agenda listing for the day. Of the entries without a time indication, keep
2768 the grouped in categories, don't sort the categories, but keep them in
2769 the sequence given in `org-agenda-files'. Within each category sort by
2770 priority.
2772 Leaving out `category-keep' would mean that items will be sorted across
2773 categories by priority.
2775 Instead of a single list, this can also be a set of list for specific
2776 contents, with a context symbol in the car of the list, any of
2777 `agenda', `todo', `tags' for the corresponding agenda views."
2790 "Non-nil means, items without time are considered late.
2791 This is only relevant for sorting. When t, items which have no explicit
2792 time like 15:30 will be considered as 99:01, i.e. later than any items which
2793 do have a time. When nil, the default time is before 0:00. You can use this
2794 option to decide if the schedule for today should come before or after timeless
2795 agenda entries."
2800 "Options concerning the entry prefix in the Org-mode agenda display."
2809 "Format specifications for the prefix of items in the agenda views.
2810 An alist with four entries, for the different agenda types. The keys to the
2811 sublists are `agenda', `timeline', `todo', and `tags'. The values
2812 are format strings.
2813 This format works similar to a printf format, with the following meaning:
2816 as given by the CATEGORY keyword or derived from the file name.
2817 %T the *last* tag of the item. Last because inherited tags come
2818 first in the list.
2819 %t the time-of-day specification if one applies to the entry, in the
2820 format HH:MM
2821 %s Scheduling/Deadline information, a short string
2823 All specifiers work basically like the standard `%s' of printf, but may
2824 contain two additional characters: A question mark just after the `%' and
2825 a whitespace/punctuation character just before the final letter.
2827 If the first character after `%' is a question mark, the entire field
2828 will only be included if the corresponding value applies to the
2829 current entry. This is useful for fields which should have fixed
2830 width when present, but zero width when absent. For example,
2832 day is specified, but will completely disappear in entries which do
2833 not contain a time.
2835 If there is punctuation or whitespace character just before the final
2836 format letter, this character will be appended to the field value if
2839 empty, no additional colon would be interted.
2842 - Indent the line with two space characters
2843 - Give the category in a 12 chars wide field, padded with whitespace on
2844 the right (because of `-'). Append a colon if there is a category
2845 (because of `:').
2846 - If there is a time-of-day, put it into a 12 chars wide field. If no
2847 time, don't put in an empty field, just skip it (because of '?').
2848 - Finally, put the scheduling information and append a whitespace.
2850 As another example, if you don't want the time-of-day of entries in
2851 the prefix, you could use:
2855 See also the variables `org-agenda-remove-times-when-in-prefix' and
2856 `org-agenda-remove-tags'."
2867 "The compiled version of the most recently used prefix format.
2871 "Format for the TODO keyword in agenda lines.
2873 to occupy a fixed space in the agenda display."
2878 "Text preceeding scheduled items in the agenda view.
2879 This is a list with two strings. The first applies when the item is
2880 scheduled on the current day. The second applies when it has been scheduled
2881 previously, it may contain a %d to capture how many days ago the item was
2882 scheduled."
2889 "Text preceeding deadline items in the agenda view.
2890 This is a list with two strings. The first applies when the item has its
2891 deadline on the current day. The second applies when it is in the past or
2892 in the future, it may contain %d to capture how many days away the deadline
2893 is (was)."
2900 "Non-nil means, remove duplicate time specifications in agenda items.
2901 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2902 time-of-day specification in a headline or diary entry is extracted and
2903 placed into the prefix. If this option is non-nil, the original specification
2904 \(a timestamp or -range, or just a plain time(range) specification like
2905 11:30-4pm) will be removed for agenda display. This makes the agenda less
2906 cluttered.
2907 The option can be t or nil. It may also be the symbol `beg', indicating
2908 that the time should only be removed what it is located at the beginning of
2909 the headline/diary entry."
2918 "Default duration for appointments that only have a starting time.
2919 When nil, no duration is specified in such cases.
2920 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2928 "Non-nil means, remove the tags from the headline copy in the agenda.
2929 When this is the symbol `prefix', only remove tags when
2930 `org-agenda-prefix-format' contains a `%T' specifier."
2942 "Shift tags in agenda items to this column.
2943 If this number is positive, it specifies the column. If it is negative,
2944 it means that the tags should be flushright to that column. For example,
2945 -80 works well for a normal 80 character screen."
2953 "Non-nil means, highlight low and high priorities in agenda.
2954 When t, the highest priority entries are bold, lowest priority italic.
2955 This may also be an association list of priority faces. The face may be
2966 "Options for embedding LaTeX code into Org-mode"
2974 "Options for creating images from LaTeX fragments.
2975 This is a property list with the following properties:
2977 `default' means use the forground of the default face.
2979 `default' means use the background of the default face.
2980 :scale a scaling factor for the size of the images
2981 :html-foreground, :html-background, :html-scale
2982 The same numbers for HTML export.
2983 :matchers a list indicating which matchers should be used to
2984 find LaTeX fragments. Valid members of this list are:
3001 "The document header used for processing LaTeX fragments."
3006 "Options for exporting org-listings."
3011 "General options for exporting Org-mode files."
3015 ;; FIXME
3020 When this option is turned on, these strings will be exported as:
3022 Org HTML LaTeX
3023 -----+----------+--------
3025 -- – --
3026 --- — ---
3027 ... … \ldots
3044 "Terms used in export text, translated to different languages.
3045 Use the variable `org-export-default-language' to set the language,
3046 or use the +OPTION lines for a per-file setting."
3056 "The default language of HTML export, as a string.
3057 This should have an association in `org-export-language-setup'."
3062 "Non-nil means, skip all text before the first headline when exporting.
3063 When nil, that text is exported as well."
3068 "The last level which is still exported as a headline.
3069 Inferior levels will produce itemize lists when exported.
3070 Note that a numeric prefix argument to an exporter function overrides
3071 this setting.
3078 "Non-nil means, add section numbers to headlines when exporting.
3085 "Non-nil means, create a table of contents in exported files.
3086 The TOC contains headlines with levels up to`org-export-headline-levels'.
3087 When an integer, include levels up to N in the toc, this may then be
3088 different from `org-export-headline-levels', but it will not be allowed
3089 to be larger than the number of headline levels.
3090 When nil, no table of contents is made.
3093 ASCII export, and with red color in HTML output, if the option
3094 `org-export-mark-todo-in-toc' is set.
3096 In HTML output, the TOC will be clickable.
3107 "Non-nil means, mark TOC lines that contain any open TODO items."
3112 "Non-nil means, preserve all line breaks when exporting.
3113 Normally, in HTML output paragraphs will be reformatted. In ASCII
3114 export, line breaks will always be preserved, regardless of this variable.
3121 "Whether subtrees with the ARCHIVE tag should be exported.
3122 This can have three different values
3123 nil Do not export, pretend this tree is not present
3124 t Do export the entire tree
3125 headline Only export the headline, but skip the tree below it."
3134 "Non-nil means, insert author name and email into the exported file.
3136 This option can also be set with the +OPTIONS line,
3142 "Non-nil means, insert a time stamp into the exported file.
3143 The time stamp shows when the file was created.
3145 This option can also be set with the +OPTIONS line,
3151 "If nil, do not export time stamps and associated keywords."
3156 "If nil, remove timestamps from the table of contents entries."
3161 "If nil, do not export tags, just remove them from headlines.
3162 If this is the symbol `not-in-toc', tags will be removed from table of
3163 contents entries, but still be shown in the headlines of the document.
3173 "Non-nil means, export with drawers like the property drawer.
3174 When t, all drawers are exported. This may also be a list of
3175 drawer names to export."
3184 "Options for translating special ascii sequences for the export backends."
3189 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3190 If the export target supports emphasizing text, the word will be
3191 typeset in bold, italic, or underlined, respectively. Works only for
3192 single words, but you can say: I *really* *mean* *this*.
3193 Not all export backends support this.
3200 "If nil, export [1] as a footnote marker.
3201 Lines starting with [1] will be formatted as footnotes.
3209 When this option is turned on, you can use TeX-like syntax for sub- and
3211 considered as a single item - so grouping with {} is normally not
3212 needed. For example, the following things will be parsed as single
3213 sub- or superscripts.
3215 10^24 or 10^tau several digits will be considered 1 item.
3216 10^-12 or 10^-tau a leading sign with digits or a word
3217 x^2-y^3 will be read as x^2 - y^3, because items are
3218 terminated by almost any nonword/nondigit char.
3219 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3221 Still, ambiguity is possible - so when in doubt use {} to enclose the
3222 sub/superscript. If you set this variable to the symbol `{}',
3223 the braces are *required* in order to trigger interpretations as
3225 frequently in plain text.
3227 Not all export backends support this, but HTML does.
3238 When this option is turned on, these strings will be exported as:
3241 -- : –
3242 --- : —
3244 Not all export backends support this, but HTML does.
3251 "Non-nil means, interpret simple TeX-like macros when exporting.
3253 No only real TeX macros will work here, but the standard HTML entities
3254 for math can be used as macro names as well. For a list of supported
3255 names in HTML export, see the constant `org-html-entities'.
3256 Not all export backends support this.
3264 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3266 the first non-white thing on a line. It will also find the math delimiters
3268 display math.
3277 This can be used to have pre-formatted text, fragments of code etc. For
3278 example:
3279 : ;; Some Lisp examples
3280 : (while (defc cnt)
3281 : (ding))
3282 will be looking just like this in also HTML. See also the QUOTE keyword.
3283 Not all export backends support this.
3290 "Number of stacked braces for sub/superscript matching.
3291 This has to be set before loading org.el to be effective."
3296 "Options for exporting tables in Org-mode."
3302 For example:
3304 | Name | Address | Birthday |
3305 |-------------+----------+-----------|
3306 | Arthur Dent | England | 29.2.2100 |
3308 Not all export backends support this.
3315 "Non-nil means, highlight the first table line.
3316 In HTML export, this means use <th> instead of <td>.
3317 In tables created with table.el, this applies to the first table line.
3318 In Org-mode tables, all lines before the first horizontal separator
3319 line will be formatted with <th> tags."
3324 "Remove special lines and marking characters in calculating tables.
3325 This removes the special marking character column from tables that are set
3326 up for spreadsheet calculations. It also removes the entire lines
3327 marked with `!', `_', or `^'. The lines with `$' are kept, because
3328 the values of constants may be useful to have."
3333 "Non-nil means, always export tables created with table.el natively.
3334 Natively means, use the HTML code generator in table.el.
3335 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3336 the table does not use row- or column-spanning). This has the
3337 advantage, that the automatic HTML conversions for math symbols and
3338 sub/superscripts can be applied. Org-mode's HTML generator is also
3339 much faster."
3344 "Options specific for ASCII export of Org-mode files."
3349 "Characters for underlining headings in ASCII export.
3350 In the given sequence, these characters will be used for level 1, 2, ..."
3355 "Bullet characters for headlines converted to lists in ASCII export.
3356 The first character is used for the first lest level generated in this
3357 way, and so on. If there are more levels than characters given here,
3358 the list will be repeated.
3359 Note that plain lists will keep the same bullets as the have in the
3360 Org-mode file."
3365 "Options specific for XML export of Org-mode files."
3370 "Options specific for HTML export of Org-mode files."
3375 ""
3380 "The extension for exported HTML files."
3386 html {
3387 font-family: Times, serif;
3388 font-size: 12pt;
3389 }
3390 .title { text-align: center; }
3391 .todo { color: red; }
3392 .done { color: green; }
3393 .timestamp { color: grey }
3394 .timestamp-kwd { color: CadetBlue }
3395 .tag { background-color:lightblue; font-weight:normal }
3396 .target { background-color: lavender; }
3397 pre {
3398 border: 1pt solid #AEBDCC;
3399 background-color: #F3F5F7;
3400 padding: 5pt;
3401 font-family: courier, monospace;
3402 }
3403 table { border-collapse: collapse; }
3404 td, th {
3405 vertical-align: top;
3406 <!--border: 1pt solid #ADB9CC;-->
3407 }
3408 </style>"
3409 "The default style specification for exported HTML files.
3410 Since there are different ways of setting style information, this variable
3411 needs to contain the full HTML structure to provide a style, including the
3412 surrounding HTML tags. The style specifications should include definitions
3413 for new classes todo, done, title, and deadline. For example, legal values
3414 would be:
3417 p { font-weight: normal; color: gray; }
3418 h1 { color: black; }
3419 .title { text-align: center; }
3420 .todo, .deadline { color: red; }
3421 .done { color: green; }
3422 </style>
3424 or, if you want to keep the style in a file,
3428 As the value of this option simply gets inserted into the HTML <head> header,
3435 "Format for typesetting the document title in HTML export."
3440 "The <H> level for level 1 headings in HTML export."
3445 "Non-nil means, make file links to `file.org' point to `file.html'.
3446 When org-mode is exporting an org-mode file to HTML, links to
3447 non-html files are directly put into a href tag in HTML.
3448 However, links to other Org-mode files (recognized by the
3449 extension `.org.) should become links to the corresponding html
3450 file, assuming that the linked org-mode file will also be
3451 converted to HTML.
3452 When nil, the links still point to the plain `.org' file."
3457 "Non-nil means, inline images into exported HTML pages.
3458 This is done using an <img> tag. When nil, an anchor with href is used to
3459 link to the image. If this option is `maybe', then images in links with
3460 an empty description will be inlined, while images with a description will
3461 be linked only."
3467 ;; FIXME: rename
3469 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3470 When nil, these tags will be exported as plain text and therefore
3471 not be interpreted by a browser.
3479 "The HTML tag that is used to start a table.
3480 This must be a <table> tag, but you may change the options like
3481 borders and spacing."
3486 "The opening tag for table header fields.
3487 This is customizable so that alignment options can be specified."
3492 "The opening tag for table data fields.
3493 This is customizable so that alignment options can be specified."
3498 "If non-nil, write `org-export-html-html-helper-timestamp'
3499 into the exported HTML text. Otherwise, the buffer will just be saved
3500 to a file."
3506 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3511 "Options specific for iCalendar export of Org-mode files."
3516 "The file name for the iCalendar file covering all agenda files.
3518 The file name should be absolute, the file will be overwritten without warning."
3523 "Non-nil means, export to iCalendar files should also cover TODO items."
3531 "Non-nil means, export to iCalendar files should also cover sexp entries.
3532 These are entries like in the diary, but directly in an Org-mode file."
3537 "Amount of text below headline to be included in iCalendar export.
3538 This is a number of characters that should maximally be included.
3539 Properties, scheduling and clocking lines will always be removed.
3540 The text will be inserted into the DESCRIPTION field."
3548 "Calendar name for the combined iCalendar representing all agenda files."
3553 "Font-lock settings for highlighting in Org-mode."
3558 "Non-nil means fontify only the stars in each headline.
3559 When nil, the entire headline is fontified.
3560 Changing it requires restart of `font-lock-mode' to become effective
3561 also in regions already fontified."
3566 "Non-nil means, hide the first N-1 stars in a headline.
3567 This works by using the face `org-hide' for these stars. This
3568 face is white for a light background, and black for a dark
3569 background. You may have to customize the face `org-hide' to
3570 make this work.
3571 Changing it requires restart of `font-lock-mode' to become effective
3572 also in regions already fontified.
3573 You may also set this on a per-file basis by adding one of the following
3574 lines to the buffer:
3576 #+STARTUP: hidestars
3577 #+STARTUP: showstars"
3582 "Non-nil means, change the face of a headline if it is marked DONE.
3583 Normally, only the TODO/DONE keyword indicates the state of a headline.
3584 When this is non-nil, the headline after the keyword is set to the
3585 `org-headline-done' as an additional indication."
3590 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3591 Changing this variable requires a restart of Emacs to take effect."
3596 "Non-nil means, fontify what is treated specially by the exporters."
3601 "Non-nil mean font-lock should hide the emphasis marker characters."
3612 "Set variable and compute the emphasis regular expression."
3616 org-emphasis-alist org-emphasis-regexp-components)
3629 ;; make sure special characters appear at the right position in the class
3641 ;; Make the regexp
3649 body1
3661 body1
3669 "Components used to build the regular expression for emphasis.
3670 This is a list with 6 entries. Terminology: In an emphasis string
3674 specify what is allowed/forbidden in each part:
3676 pre Chars allowed as prematch. Beginning of line will be allowed too.
3677 post Chars allowed as postmatch. End of line will be allowed too.
3678 border The chars *forbidden* as border characters.
3680 non-shy groups here, and don't allow newline here.
3681 newline The maximum number of newlines allowed in an emphasis exp.
3683 Use customize to modify this, or restart Emacs after changing it."
3701 )
3702 "Special syntax for emphasized text.
3703 Text starting and ending with a special character will be emphasized, for
3704 example *bold*, _underlined_ and /italic/. This variable sets the marker
3705 characters, the face to be used by font-lock for highlighting in Org-mode
3706 Emacs buffers, and the HTML tags to be used for this.
3707 Use customize to modify this, or restart Emacs after changing it."
3720 ;;; The faces
3723 "Faces in Org-mode."
3728 "Make a compatible face specification.
3729 If INHERITS is an existing face and if the Emacs version supports it,
3730 just inherit the face. If not, use SPECS to define the face.
3731 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3732 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3733 to the top of the list. The `min-colors' attribute will be removed from
3734 any other entries, and any resulting duplicates will be removed entirely."
3738 ;; In Emacs 23, we use inheritance where possible.
3739 ;; We only do this in Emacs 23, because only there the outline
3740 ;; faces have been changed to the original org-mode-level-faces.
3743 ;; These do not understand the `min-colors' attribute.
3762 "Face used to hide leading stars in headlines.
3763 The forground color of this face should be equal to the background
3764 color of the frame."
3775 "Face used for level 1 headlines."
3785 "Face used for level 2 headlines."
3797 "Face used for level 3 headlines."
3809 "Face used for level 4 headlines."
3817 "Face used for level 5 headlines."
3825 "Face used for level 6 headlines."
3833 "Face used for level 7 headlines."
3841 "Face used for level 8 headlines."
3849 "Face used for special keywords."
3860 "Face used for drawers."
3864 "Face used for the value of a property."
3876 "Face for column display of entry properties."
3880 ;; Make sure that a fixed-width face is used when we have a column table.
3892 "Face for deadlines and TODO keywords."
3905 "Face for headline with the ARCHIVE tag."
3912 "Face for links."
3919 "Face for the ellipsis in folded text."
3926 "Face for links."
3933 "Face for links."
3940 "Face for links."
3945 "Face for tags."
3955 "Face for TODO keywords."
3964 "Face used for todo keywords that indicate DONE items."
3972 "Face used to indicate that a headline is DONE.
3973 This face is only used if `org-fontify-done-headline' is set. If applies
3974 to the part of the headline after the DONE keyword."
3978 "Faces for specific TODO keywords.
3979 This is a list of cons cells, with TODO keywords in the car
3980 and faces in the cdr. The face can be a symbol, or a property
3997 "Face used for tables."
4007 "Face for formulas."
4020 "Face for fixed-with text like code snippets."
4034 "Face for fixed-with text like code snippets."
4046 "Face used in agenda for captions and dates."
4055 "Face for items scheduled for a certain day."
4065 "Face for items scheduled previously, and not yet done."
4075 "Face for items scheduled previously, and not yet done."
4082 "Faces for showing deadlines in the agenda.
4083 This is a list of cons cells. The cdr of each cell is a face to be used,
4085 Each car is a fraction of the head-warning time that must have passed for
4086 this the face in the cdr to be used for display. The numbers must be
4087 given in descending order. The head-warning time is normally taken
4088 from `org-deadline-warning-days', but can also be specified in the deadline
4089 timestamp itself, like this:
4091 DEADLINE: <2007-08-13 Mon -8d>
4093 You may use d for days, w for weeks, m for months and y for years. Months
4094 and years will only be treated in an approximate fashion (30.4 days for a
4095 month and 365.24 days for a year)."
4103 ;; FIXME: this is not a good face yet.
4112 "Face for showing the agenda restriction lock."
4120 "Face used for time grids."
4125 org-level-5 org-level-6 org-level-7 org-level-8
4126 ))
4129 "The number different faces to be used for headlines.
4130 Org-mode defines 8 different headline faces, so this can be at most 8.
4131 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4135 ;;; Functions and variables from ther packages
4136 ;; Declared here to avoid compiler warnings
4142 ;; XEmacs only
4148 ;; Emacs only
4151 ;; Various packages
4152 ;; FIXME: get the argument lists for the UNKNOWN stuff
4208 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4209 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4239 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4250 ;; backward compatibility to old version of wl
4253 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4266 ;;; Variables for pre-computed regular expressions, all buffer local
4281 "Matches a headline and puts everything into groups:
4282 group 1: the stars
4283 group 2: The todo keyword, maybe
4284 group 3: Priority cookie
4285 group 4: True headline
4289 "Matches a headline and puts TODO state into group 2 if present.
4334 rear-nonsticky t mouse-map t fontified t)
4341 s)
4348 s)
4357 "Modified `buffer-invisibility-spec' for Emacs 21.
4358 Some ops with invisible text do not work correctly on Emacs 21. For these
4359 we turn off invisibility temporarily. Use this in a `let' form."
4363 "Make VAR local in current buffer and set it to VALUE."
4367 "Check if the current buffer is in Org-mode."
4371 "Return the last element of LIST."
4404 "Variable associated with STARTUP options for org-mode.
4405 Each element is a list of three items: The startup options as written
4406 in the #+STARTUP line, the corresponding variable, and the value to
4407 set this variable to if the option is found. An optional forth element PUSH
4411 "Precompute regular expressions for current buffer."
4426 kwds kws0 kwsa key value cat arch tags const links hw dws
4427 tail sep kws1 prio props drawers
4428 ex log)
4452 links)))
4458 props)))
4465 l var val)
4480 )))
4494 ;; Process the TODO keywords
4496 ;; Use the global values as if they had been given locally.
4507 kwsa nil
4519 kw)
4521 kws0)
4538 ;; Process the constants
4546 ;; Process the tags.
4556 tgs))
4564 ;; Compute the regular expressions and other local variables
4569 org-drawer-regexp
4573 org-not-done-keywords
4575 org-todo-regexp
4578 org-not-done-regexp
4582 org-todo-line-regexp
4586 org-complex-heading-regexp
4591 org-nl-done-regexp
4595 org-todo-line-tags-regexp
4600 org-looking-at-done-regexp
4605 org-deadline-time-regexp
4607 org-deadline-line-regexp
4609 org-scheduled-regexp
4611 org-scheduled-time-regexp
4613 org-closed-time-regexp
4615 org-keyword-time-regexp
4621 org-keyword-time-not-clock-regexp
4627 org-maybe-keyword-time-regexp
4633 org-planning-or-clock-line-re
4638 )
4646 x))
4647 list))
4649 ;; FIXME: this could be done much better, using second characters etc.
4651 "Assign fast keys to a keyword-key alist.
4652 Respect keys that are already there."
4662 ;; automatically assign a character.
4674 ;;; Some variables ujsed in various places
4679 "Function to be called when `C-c C-c' is used.
4683 ;; FIXME: Occasionally check by commenting these, to make sure
4684 ;; no other functions uses these, forgetting to let-bind them.
4691 ;; Defined somewhere in this file, but used before definition.
4704 ;;;; Emacs/XEmacs compatibility
4706 ;; Overlay compatibility functions
4724 "Make overlay OVL display TEXT with face FACE."
4734 "Make overlay OVL display TEXT with face FACE."
4757 "Find all overlays specifying PROP at POS or point.
4758 If DELETE is non-nil, delete all those overlays."
4760 ov found)
4764 found))
4766 ;; Region compatibility
4769 "Add-hook, compatible with both Emacsen."
4778 "Is `transient-mark-mode' on and the region active?
4779 Works on both Emacs and XEmacs."
4781 nil
4788 ;; Invisibility compatibility
4791 "Add elements to `buffer-invisibility-spec'.
4792 See documentation for `buffer-invisibility-spec' for the kind of elements
4793 that can be added."
4804 "Remove elements from `buffer-invisibility-spec'."
4812 "Is ARG a member of `buffer-invisibility-spec'?"
4815 nil))
4817 ;;;; Define the Org-mode
4820 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or ugrade to newer allout, for example by switching to Emacs 22."))
4823 ;; We use a before-change function to check if a table might need
4824 ;; an update.
4826 "Indicates that a table might need an update.
4827 This variable is set by `org-before-change-function'.
4836 ;;;###autoload
4838 "Outline-based notes management and organizer, alias
4841 Org-mode develops organizational tasks around a NOTES file which
4842 contains information about projects as plain text. Org-mode is
4843 implemented on top of outline-mode, which is ideal to keep the content
4844 of large files well structured. It supports ToDo items, deadlines and
4845 time stamps, which magically appear in the diary listing of the Emacs
4846 calendar. Tables are easily created with a built-in table editor.
4847 Plain text URL-like links connect to websites, emails (VM), Usenet
4848 messages (Gnus), BBDB entries, and any files related to the project.
4849 For printing and sharing of notes, an Org-mode file (or a part of it)
4850 can be exported as a structured ASCII or HTML file.
4852 The following commands are available:
4856 ;; Get rid of Outline menus, they are not needed
4857 ;; Need to do this here because define-derived-mode sets up
4858 ;; the keymap so late. Still, it is a waste to call this each time
4859 ;; we switch another buffer into org-mode.
4862 ;; Assume this is Greg's port, it used easymenu
4885 org-display-table 4
4888 org-ellipsis)))
4892 ;; Calc embedded
4899 ;; Activate before-change-function
4903 ;; Check for running clock before killing a buffer
4905 ;; Paragraphs and auto-filling
4910 ;; Comment characters
4911 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4914 ;; Align options lines
4916 'align-mode-rules-list
4921 ;; Imenu
4925 ;; Make isearch reveal context
4928 ;; Emacs 21 and XEmacs make use of the hook
4930 ;; Emacs 22 deals with this through a special variable
4934 ;; If empty file that did not turn on org-mode automatically, make it to.
4956 "Call COMMAND interactively, but pretend prefix are was ARG."
4962 ;; works also in narrowed buffer, because we start at 1, not point-min
4966 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4976 "Add text properties to entire string, from beginning to end.
4977 PLIST may be a list of properties, PROPS are individual properties and values
4978 that will be added to PLIST. Returns the string that was modified."
4981 string)
4985 ;;;; Font-Lock stuff, including the activators
4990 (org-defkey org-mouse-map
4991 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4992 (when org-mouse-1-follows-link
4993 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4994 (when org-tab-follows-link
4995 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4996 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4997 (when org-return-follows-link
4998 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4999 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5001 (require 'font-lock)
5004 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5005 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5006 (defvar org-link-re-with-space nil
5007 "Matches a link with spaces, optional angular brackets around it.")
5008 (defvar org-link-re-with-space2 nil
5009 "Matches a link with spaces, optional angular brackets around it.")
5010 (defvar org-angle-link-re nil
5011 "Matches link with angular brackets, spaces are allowed.")
5012 (defvar org-plain-link-re nil
5013 "Matches plain link, without spaces.")
5014 (defvar org-bracket-link-regexp nil
5015 "Matches a link in double brackets.")
5016 (defvar org-bracket-link-analytic-regexp nil
5017 "Regular expression used to analyze links.
5018 Here is what the match groups contain after a match:
5019 1: http:
5020 2: http
5021 3: path
5022 4: [desc]
5023 5: desc")
5024 (defvar org-any-link-re nil
5025 "Regular expression matching any link.")
5027 (defun org-make-link-regexps ()
5028 "Update the link regular expressions.
5029 This should be called after the variable `org-link-types' has changed."
5030 (setq org-link-re-with-space
5031 (concat
5034 "[^" org-non-link-chars "]*"
5036 org-link-re-with-space2
5037 (concat
5042 org-angle-link-re
5043 (concat
5046 "[^" org-non-link-chars "]*"
5048 org-plain-link-re
5049 (concat
5052 org-bracket-link-regexp
5054 org-bracket-link-analytic-regexp
5055 (concat
5062 org-any-link-re
5067 (org-make-link-regexps)
5070 "Regular expression for fast time stamp matching.")
5072 "Regular expression for fast time stamp matching.")
5073 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5074 "Regular expression matching time strings for analysis.
5075 This one does not require the space after the date.")
5076 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5077 "Regular expression matching time strings for analysis.")
5079 "Regular expression matching time stamps, with groups.")
5081 "Regular expression matching time stamps (also [..]), with groups.")
5082 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5083 "Regular expression matching a time stamp range.")
5084 (defconst org-tr-regexp-both
5085 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5086 "Regular expression matching a time stamp range.")
5089 "Regular expression matching a time stamp or time stamp range.")
5092 "Regular expression matching a time stamp or time stamp range.
5093 The time stamps may be either active or inactive.")
5095 (defvar org-emph-face nil)
5097 (defun org-do-emphasis-faces (limit)
5098 "Run through the buffer and add overlays to links."
5099 (let (rtn)
5100 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5101 (if (not (= (char-after (match-beginning 3))
5102 (char-after (match-beginning 4))))
5103 (progn
5104 (setq rtn t)
5105 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5106 'face
5107 (nth 1 (assoc (match-string 3)
5108 org-emphasis-alist)))
5109 (add-text-properties (match-beginning 2) (match-end 2)
5110 '(font-lock-multiline t))
5111 (when org-hide-emphasis-markers
5112 (add-text-properties (match-end 4) (match-beginning 5)
5113 '(invisible org-link))
5114 (add-text-properties (match-beginning 3) (match-end 3)
5115 '(invisible org-link)))))
5116 (backward-char 1))
5117 rtn))
5119 (defun org-emphasize (&optional char)
5120 "Insert or change an emphasis, i.e. a font like bold or italic.
5121 If there is an active region, change that region to a new emphasis.
5122 If there is no region, just insert the marker characters and position
5123 the cursor between them.
5124 CHAR should be either the marker character, or the first character of the
5125 HTML tag associated with that emphasis. If CHAR is a space, the means
5126 to remove the emphasis of the selected region.
5127 If char is not given (for example in an interactive call) it
5128 will be prompted for."
5129 (interactive)
5130 (let ((eal org-emphasis-alist) e det
5131 (erc org-emphasis-regexp-components)
5132 (prompt "")
5133 (string "") beg end move tag c s)
5134 (if (org-region-active-p)
5135 (setq beg (region-beginning) end (region-end)
5136 string (buffer-substring beg end))
5137 (setq move t))
5139 (while (setq e (pop eal))
5140 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5141 c (aref tag 0))
5142 (push (cons c (string-to-char (car e))) det)
5143 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5144 (substring tag 1)))))
5145 (unless char
5146 (message "%s" (concat "Emphasis marker or tag:" prompt))
5147 (setq char (read-char-exclusive)))
5148 (setq char (or (cdr (assoc char det)) char))
5149 (if (equal char ?\ )
5150 (setq s "" move nil)
5151 (unless (assoc (char-to-string char) org-emphasis-alist)
5153 (setq s (char-to-string char)))
5154 (while (and (> (length string) 1)
5155 (equal (substring string 0 1) (substring string -1))
5156 (assoc (substring string 0 1) org-emphasis-alist))
5157 (setq string (substring string 1 -1)))
5158 (setq string (concat s string s))
5159 (if beg (delete-region beg end))
5160 (unless (or (bolp)
5162 (char-to-string (char-before (point)))))
5163 (insert " "))
5165 (char-to-string (char-after (point))))
5166 (insert " ") (backward-char 1))
5167 (insert string)
5168 (and move (backward-char 1))))
5170 (defconst org-nonsticky-props
5171 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5174 (defun org-activate-plain-links (limit)
5175 "Run through the buffer and add overlays to links."
5176 (catch 'exit
5177 (let (f)
5178 (while (re-search-forward org-plain-link-re limit t)
5179 (setq f (get-text-property (match-beginning 0) 'face))
5180 (if (or (eq f 'org-tag)
5181 (and (listp f) (memq 'org-tag f)))
5182 nil
5183 (add-text-properties (match-beginning 0) (match-end 0)
5184 (list 'mouse-face 'highlight
5185 'rear-nonsticky org-nonsticky-props
5186 'keymap org-mouse-map
5187 ))
5188 (throw 'exit t))))))
5190 (defun org-activate-code (limit)
5192 (unless (get-text-property (match-beginning 1) 'face)
5193 (remove-text-properties (match-beginning 0) (match-end 0)
5194 '(display t invisible t intangible t))
5195 t)))
5197 (defun org-activate-angle-links (limit)
5198 "Run through the buffer and add overlays to links."
5199 (if (re-search-forward org-angle-link-re limit t)
5200 (progn
5201 (add-text-properties (match-beginning 0) (match-end 0)
5202 (list 'mouse-face 'highlight
5203 'rear-nonsticky org-nonsticky-props
5204 'keymap org-mouse-map
5205 ))
5206 t)))
5208 (defmacro org-maybe-intangible (props)
5209 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5210 In emacs 21, invisible text is not avoided by the command loop, so the
5211 intangible property is needed to make sure point skips this text.
5212 In Emacs 22, this is not necessary. The intangible text property has
5213 led to problems with flyspell. These problems are fixed in flyspell.el,
5214 but we still avoid setting the property in Emacs 22 and later.
5215 We use a macro so that the test can happen at compilation time."
5216 (if (< emacs-major-version 22)
5217 `(append '(intangible t) ,props)
5218 props))
5220 (defun org-activate-bracket-links (limit)
5221 "Run through the buffer and add overlays to bracketed links."
5222 (if (re-search-forward org-bracket-link-regexp limit t)
5223 (let* ((help (concat "LINK: "
5224 (org-match-string-no-properties 1)))
5225 ;; FIXME: above we should remove the escapes.
5226 ;; but that requires another match, protecting match data,
5227 ;; a lot of overhead for font-lock.
5228 (ip (org-maybe-intangible
5229 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5230 'keymap org-mouse-map 'mouse-face 'highlight
5231 'font-lock-multiline t 'help-echo help)))
5232 (vp (list 'rear-nonsticky org-nonsticky-props
5233 'keymap org-mouse-map 'mouse-face 'highlight
5234 ' font-lock-multiline t 'help-echo help)))
5235 ;; We need to remove the invisible property here. Table narrowing
5236 ;; may have made some of this invisible.
5237 (remove-text-properties (match-beginning 0) (match-end 0)
5238 '(invisible nil))
5239 (if (match-end 3)
5240 (progn
5241 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5242 (add-text-properties (match-beginning 3) (match-end 3) vp)
5243 (add-text-properties (match-end 3) (match-end 0) ip))
5244 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5245 (add-text-properties (match-beginning 1) (match-end 1) vp)
5246 (add-text-properties (match-end 1) (match-end 0) ip))
5247 t)))
5249 (defun org-activate-dates (limit)
5250 "Run through the buffer and add overlays to dates."
5251 (if (re-search-forward org-tsr-regexp-both limit t)
5252 (progn
5253 (add-text-properties (match-beginning 0) (match-end 0)
5254 (list 'mouse-face 'highlight
5255 'rear-nonsticky org-nonsticky-props
5256 'keymap org-mouse-map))
5257 (when org-display-custom-times
5258 (if (match-end 3)
5259 (org-display-custom-time (match-beginning 3) (match-end 3)))
5260 (org-display-custom-time (match-beginning 1) (match-end 1)))
5261 t)))
5263 (defvar org-target-link-regexp nil
5264 "Regular expression matching radio targets in plain text.")
5266 "Regular expression matching a link target.")
5268 "Regular expression matching a radio target.")
5269 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5270 "Regular expression matching any target.")
5272 (defun org-activate-target-links (limit)
5273 "Run through the buffer and add overlays to target matches."
5274 (when org-target-link-regexp
5275 (let ((case-fold-search t))
5276 (if (re-search-forward org-target-link-regexp limit t)
5277 (progn
5278 (add-text-properties (match-beginning 0) (match-end 0)
5279 (list 'mouse-face 'highlight
5280 'rear-nonsticky org-nonsticky-props
5281 'keymap org-mouse-map
5282 'help-echo "Radio target link"
5283 'org-linked-text t))
5284 t)))))
5286 (defun org-update-radio-target-regexp ()
5287 "Find all radio targets in this file and update the regular expression."
5288 (interactive)
5289 (when (memq 'radio org-activate-links)
5290 (setq org-target-link-regexp
5291 (org-make-target-link-regexp (org-all-targets 'radio)))
5292 (org-restart-font-lock)))
5294 (defun org-hide-wide-columns (limit)
5295 (let (s e)
5296 (setq s (text-property-any (point) (or limit (point-max))
5297 'org-cwidth t))
5298 (when s
5299 (setq e (next-single-property-change s 'org-cwidth))
5300 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5301 (goto-char e)
5302 t)))
5304 (defvar org-latex-and-specials-regexp nil
5305 "Regular expression for highlighting export special stuff.")
5306 (defvar org-match-substring-regexp)
5307 (defvar org-match-substring-with-braces-regexp)
5308 (defvar org-export-html-special-string-regexps)
5310 (defun org-compute-latex-and-specials-regexp ()
5311 "Compute regular expression for stuff treated specially by exporters."
5312 (if (not org-highlight-latex-fragments-and-specials)
5313 (org-set-local 'org-latex-and-specials-regexp nil)
5314 (let*
5315 ((matchers (plist-get org-format-latex-options :matchers))
5316 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5317 org-latex-regexps)))
5318 (options (org-combine-plists (org-default-export-plist)
5319 (org-infile-export-plist)))
5320 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5321 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5322 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5323 (org-export-html-expand (plist-get options :expand-quoted-html))
5324 (org-export-with-special-strings (plist-get options :special-strings))
5325 (re-sub
5326 (cond
5327 ((equal org-export-with-sub-superscripts '{})
5328 (list org-match-substring-with-braces-regexp))
5329 (org-export-with-sub-superscripts
5330 (list org-match-substring-regexp))
5331 (t nil)))
5332 (re-latex
5333 (if org-export-with-LaTeX-fragments
5334 (mapcar (lambda (x) (nth 1 x)) latexs)))
5335 (re-macros
5336 (if org-export-with-TeX-macros
5338 (regexp-opt
5339 (append (mapcar 'car org-html-entities)
5340 (if (boundp 'org-latex-entities)
5341 org-latex-entities nil))
5342 'words))) ; FIXME
5343 ))
5345 (re-special (if org-export-with-special-strings
5346 (mapcar (lambda (x) (car x))
5347 org-export-html-special-string-regexps)))
5348 (re-rest
5349 (delq nil
5350 (list
5352 ))))
5353 (org-set-local
5354 'org-latex-and-specials-regexp
5355 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5358 (defface org-latex-and-export-specials
5359 (let ((font (cond ((assq :inherit custom-face-attributes)
5360 '(:inherit underline))
5361 (t '(:underline t)))))
5362 `((((class grayscale) (background light))
5363 (:foreground "DimGray" ,@font))
5364 (((class grayscale) (background dark))
5365 (:foreground "LightGray" ,@font))
5366 (((class color) (background light))
5367 (:foreground "SaddleBrown"))
5368 (((class color) (background dark))
5369 (:foreground "burlywood"))
5370 (t (,@font))))
5371 "Face used to highlight math latex and other special exporter stuff."
5372 :group 'org-faces)
5374 (defun org-do-latex-and-special-faces (limit)
5375 "Run through the buffer and add overlays to links."
5376 (when org-latex-and-specials-regexp
5377 (let (rtn d)
5378 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5379 limit t))
5380 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5381 'face))
5382 '(org-code org-verbatim underline)))
5383 (progn
5384 (setq rtn t
5385 d (cond ((member (char-after (1+ (match-beginning 0)))
5386 '(?_ ?^)) 1)
5387 (t 0)))
5388 (font-lock-prepend-text-property
5389 (+ d (match-beginning 0)) (match-end 0)
5390 'face 'org-latex-and-export-specials)
5391 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5392 '(font-lock-multiline t)))))
5393 rtn)))
5395 (defun org-restart-font-lock ()
5396 "Restart font-lock-mode, to force refontification."
5397 (when (and (boundp 'font-lock-mode) font-lock-mode)
5398 (font-lock-mode -1)
5399 (font-lock-mode 1)))
5401 (defun org-all-targets (&optional radio)
5402 "Return a list of all targets in this file.
5403 With optional argument RADIO, only find radio targets."
5404 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5405 rtn)
5406 (save-excursion
5407 (goto-char (point-min))
5408 (while (re-search-forward re nil t)
5409 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5410 rtn)))
5412 (defun org-make-target-link-regexp (targets)
5413 "Make regular expression matching all strings in TARGETS.
5414 The regular expression finds the targets also if there is a line break
5415 between words."
5416 (and targets
5417 (concat
5419 (mapconcat
5420 (lambda (x)
5421 (while (string-match " +" x)
5423 x)
5424 targets
5428 (defun org-activate-tags (limit)
5430 (progn
5431 (add-text-properties (match-beginning 1) (match-end 1)
5432 (list 'mouse-face 'highlight
5433 'rear-nonsticky org-nonsticky-props
5434 'keymap org-mouse-map))
5435 t)))
5437 (defun org-outline-level ()
5438 (save-excursion
5439 (looking-at outline-regexp)
5440 (if (match-beginning 1)
5441 (+ (org-get-string-indentation (match-string 1)) 1000)
5442 (1- (- (match-end 0) (match-beginning 0))))))
5444 (defvar org-font-lock-keywords nil)
5447 "Regular expression matching a property line.")
5449 (defun org-set-font-lock-defaults ()
5450 (let* ((em org-fontify-emphasized-text)
5451 (lk org-activate-links)
5452 (org-font-lock-extra-keywords
5453 (list
5454 ;; Headlines
5456 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5457 ;; Table lines
5459 (1 'org-table t))
5460 ;; Table internals
5464 ;; Drawers
5465 (list org-drawer-regexp '(0 'org-special-keyword t))
5467 ;; Properties
5468 (list org-property-re
5469 '(1 'org-special-keyword t)
5470 '(3 'org-property-value t))
5471 (if org-format-transports-properties-p
5473 ;; Links
5474 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5475 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5476 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5477 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5478 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5479 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5481 '(org-hide-wide-columns (0 nil append))
5482 ;; TODO lines
5484 '(1 (org-get-todo-face 1) t))
5485 ;; DONE
5486 (if org-fontify-done-headline
5490 '(2 'org-headline-done t))
5491 nil)
5492 ;; Priorities
5494 ;; Special keywords
5499 ;; Emphasis
5500 (if em
5501 (if (featurep 'xemacs)
5502 '(org-do-emphasis-faces (0 nil append))
5503 '(org-do-emphasis-faces)))
5504 ;; Checkboxes
5506 2 'bold prepend)
5507 (if org-provide-checkbox-statistics
5509 (0 (org-get-checkbox-statistics-face) t)))
5511 '(1 'org-archived prepend))
5512 ;; Specials
5513 '(org-do-latex-and-special-faces)
5514 ;; Code
5515 '(org-activate-code (1 'org-code t))
5516 ;; COMMENT
5519 '(1 'org-special-keyword t))
5520 '("^#.*" (0 'font-lock-comment-face t))
5521 )))
5522 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5523 ;; Now set the full font-lock-keywords
5524 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5525 (org-set-local 'font-lock-defaults
5526 '(org-font-lock-keywords t nil nil backward-paragraph))
5527 (kill-local-variable 'font-lock-keywords) nil))
5529 (defvar org-m nil)
5530 (defvar org-l nil)
5531 (defvar org-f nil)
5532 (defun org-get-level-face (n)
5533 "Get the right face for match N in font-lock matching of healdines."
5534 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5535 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5536 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5537 (cond
5538 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5539 ((eq n 2) org-f)
5540 (t (if org-level-color-stars-only nil org-f))))
5542 (defun org-get-todo-face (kwd)
5543 "Get the right face for a TODO keyword KWD.
5544 If KWD is a number, get the corresponding match group."
5545 (if (numberp kwd) (setq kwd (match-string kwd)))
5546 (or (cdr (assoc kwd org-todo-keyword-faces))
5547 (and (member kwd org-done-keywords) 'org-done)
5548 'org-todo))
5550 (defun org-unfontify-region (beg end &optional maybe_loudly)
5551 "Remove fontification and activation overlays from links."
5552 (font-lock-default-unfontify-region beg end)
5553 (let* ((buffer-undo-list t)
5554 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5555 (inhibit-modification-hooks t)
5556 deactivate-mark buffer-file-name buffer-file-truename)
5557 (remove-text-properties beg end
5558 '(mouse-face t keymap t org-linked-text t
5559 invisible t intangible t))))
5561 ;;;; Visibility cycling, including org-goto and indirect buffer
5563 ;;; Cycling
5565 (defvar org-cycle-global-status nil)
5566 (make-variable-buffer-local 'org-cycle-global-status)
5567 (defvar org-cycle-subtree-status nil)
5568 (make-variable-buffer-local 'org-cycle-subtree-status)
5570 ;;;###autoload
5571 (defun org-cycle (&optional arg)
5572 "Visibility cycling for Org-mode.
5574 - When this function is called with a prefix argument, rotate the entire
5575 buffer through 3 states (global cycling)
5576 1. OVERVIEW: Show only top-level headlines.
5577 2. CONTENTS: Show all headlines of all levels, but no body text.
5578 3. SHOW ALL: Show everything.
5580 - When point is at the beginning of a headline, rotate the subtree started
5581 by this line through 3 different states (local cycling)
5582 1. FOLDED: Only the main headline is shown.
5583 2. CHILDREN: The main headline and the direct children are shown.
5584 From this state, you can move to one of the children
5585 and zoom in further.
5586 3. SUBTREE: Show the entire subtree, including body text.
5588 - When there is a numeric prefix, go up to a heading with level ARG, do
5589 a `show-subtree' and return to the previous cursor position. If ARG
5590 is negative, go up that many levels.
5592 - When point is not at the beginning of a headline, execute
5593 `indent-relative', like TAB normally does. See the option
5594 `org-cycle-emulate-tab' for details.
5596 - Special case: if point is at the beginning of the buffer and there is
5597 no headline in line 1, this function will act as if called with prefix arg.
5598 But only if also the variable `org-cycle-global-at-bob' is t."
5599 (interactive "P")
5600 (let* ((outline-regexp
5601 (if (and (org-mode-p) org-cycle-include-plain-lists)
5603 outline-regexp))
5604 (bob-special (and org-cycle-global-at-bob (bobp)
5605 (not (looking-at outline-regexp))))
5606 (org-cycle-hook
5607 (if bob-special
5608 (delq 'org-optimize-window-after-visibility-change
5609 (copy-sequence org-cycle-hook))
5610 org-cycle-hook))
5611 (pos (point)))
5613 (if (or bob-special (equal arg '(4)))
5614 ;; special case: use global cycling
5615 (setq arg t))
5617 (cond
5619 ((org-at-table-p 'any)
5620 ;; Enter the table or move to the next field in the table
5621 (or (org-table-recognize-table.el)
5622 (progn
5623 (if arg (org-table-edit-field t)
5624 (org-table-justify-field-maybe)
5625 (call-interactively 'org-table-next-field)))))
5627 ((eq arg t) ;; Global cycling
5629 (cond
5630 ((and (eq last-command this-command)
5631 (eq org-cycle-global-status 'overview))
5632 ;; We just created the overview - now do table of contents
5633 ;; This can be slow in very large buffers, so indicate action
5634 (message "CONTENTS...")
5635 (org-content)
5636 (message "CONTENTS...done")
5637 (setq org-cycle-global-status 'contents)
5638 (run-hook-with-args 'org-cycle-hook 'contents))
5640 ((and (eq last-command this-command)
5641 (eq org-cycle-global-status 'contents))
5642 ;; We just showed the table of contents - now show everything
5643 (show-all)
5644 (message "SHOW ALL")
5645 (setq org-cycle-global-status 'all)
5646 (run-hook-with-args 'org-cycle-hook 'all))
5648 (t
5649 ;; Default action: go to overview
5650 (org-overview)
5651 (message "OVERVIEW")
5652 (setq org-cycle-global-status 'overview)
5653 (run-hook-with-args 'org-cycle-hook 'overview))))
5655 ((and org-drawers org-drawer-regexp
5656 (save-excursion
5657 (beginning-of-line 1)
5658 (looking-at org-drawer-regexp)))
5659 ;; Toggle block visibility
5660 (org-flag-drawer
5661 (not (get-char-property (match-end 0) 'invisible))))
5663 ((integerp arg)
5664 ;; Show-subtree, ARG levels up from here.
5665 (save-excursion
5666 (org-back-to-heading)
5667 (outline-up-heading (if (< arg 0) (- arg)
5668 (- (funcall outline-level) arg)))
5669 (org-show-subtree)))
5671 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5672 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5673 ;; At a heading: rotate between three different views
5674 (org-back-to-heading)
5675 (let ((goal-column 0) eoh eol eos)
5676 ;; First, some boundaries
5677 (save-excursion
5678 (org-back-to-heading)
5679 (save-excursion
5680 (beginning-of-line 2)
5681 (while (and (not (eobp)) ;; this is like `next-line'
5682 (get-char-property (1- (point)) 'invisible))
5683 (beginning-of-line 2)) (setq eol (point)))
5684 (outline-end-of-heading) (setq eoh (point))
5685 (org-end-of-subtree t)
5686 (unless (eobp)
5688 (beginning-of-line 1) ; in case this is an item
5689 )
5690 (setq eos (1- (point))))
5691 ;; Find out what to do next and set `this-command'
5692 (cond
5693 ((= eos eoh)
5694 ;; Nothing is hidden behind this heading
5695 (message "EMPTY ENTRY")
5696 (setq org-cycle-subtree-status nil)
5697 (save-excursion
5698 (goto-char eos)
5699 (outline-next-heading)
5700 (if (org-invisible-p) (org-flag-heading nil))))
5701 ((or (>= eol eos)
5703 ;; Entire subtree is hidden in one line: open it
5704 (org-show-entry)
5705 (show-children)
5706 (message "CHILDREN")
5707 (save-excursion
5708 (goto-char eos)
5709 (outline-next-heading)
5710 (if (org-invisible-p) (org-flag-heading nil)))
5711 (setq org-cycle-subtree-status 'children)
5712 (run-hook-with-args 'org-cycle-hook 'children))
5713 ((and (eq last-command this-command)
5714 (eq org-cycle-subtree-status 'children))
5715 ;; We just showed the children, now show everything.
5716 (org-show-subtree)
5717 (message "SUBTREE")
5718 (setq org-cycle-subtree-status 'subtree)
5719 (run-hook-with-args 'org-cycle-hook 'subtree))
5720 (t
5721 ;; Default action: hide the subtree.
5722 (hide-subtree)
5723 (message "FOLDED")
5724 (setq org-cycle-subtree-status 'folded)
5725 (run-hook-with-args 'org-cycle-hook 'folded)))))
5727 ;; TAB emulation
5728 (buffer-read-only (org-back-to-heading))
5730 ((org-try-cdlatex-tab))
5732 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5733 (or (not (bolp))
5734 (not (looking-at outline-regexp))))
5737 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5739 (or (and (eq org-cycle-emulate-tab 'white)
5740 (= (match-end 0) (point-at-eol)))
5741 (and (eq org-cycle-emulate-tab 'whitestart)
5742 (>= (match-end 0) pos))))
5743 t
5744 (eq org-cycle-emulate-tab t))
5747 ; (point-at-bol) (point))))
5748 ; (progn
5749 ; (beginning-of-line 1)
5753 (t (save-excursion
5754 (org-back-to-heading)
5755 (org-cycle))))))
5757 ;;;###autoload
5758 (defun org-global-cycle (&optional arg)
5759 "Cycle the global visibility. For details see `org-cycle'."
5760 (interactive "P")
5761 (let ((org-cycle-include-plain-lists
5762 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5763 (if (integerp arg)
5764 (progn
5765 (show-all)
5766 (hide-sublevels arg)
5767 (setq org-cycle-global-status 'contents))
5768 (org-cycle '(4)))))
5770 (defun org-overview ()
5771 "Switch to overview mode, shoing only top-level headlines.
5772 Really, this shows all headlines with level equal or greater than the level
5773 of the first headline in the buffer. This is important, because if the
5774 first headline is not level one, then (hide-sublevels 1) gives confusing
5775 results."
5776 (interactive)
5777 (let ((level (save-excursion
5778 (goto-char (point-min))
5779 (if (re-search-forward (concat "^" outline-regexp) nil t)
5780 (progn
5781 (goto-char (match-beginning 0))
5782 (funcall outline-level))))))
5783 (and level (hide-sublevels level))))
5785 (defun org-content (&optional arg)
5786 "Show all headlines in the buffer, like a table of contents.
5787 With numerical argument N, show content up to level N."
5788 (interactive "P")
5789 (save-excursion
5790 ;; Visit all headings and show their offspring
5791 (and (integerp arg) (org-overview))
5792 (goto-char (point-max))
5793 (catch 'exit
5794 (while (and (progn (condition-case nil
5795 (outline-previous-visible-heading 1)
5796 (error (goto-char (point-min))))
5797 t)
5798 (looking-at outline-regexp))
5799 (if (integerp arg)
5800 (show-children (1- arg))
5801 (show-branches))
5802 (if (bobp) (throw 'exit nil))))))
5805 (defun org-optimize-window-after-visibility-change (state)
5806 "Adjust the window after a change in outline visibility.
5807 This function is the default value of the hook `org-cycle-hook'."
5808 (when (get-buffer-window (current-buffer))
5809 (cond
5810 ; ((eq state 'overview) (org-first-headline-recenter 1))
5811 ; ((eq state 'overview) (org-beginning-of-line))
5812 ((eq state 'content) nil)
5813 ((eq state 'all) nil)
5814 ((eq state 'folded) nil)
5815 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5816 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5818 (defun org-compact-display-after-subtree-move ()
5819 (let (beg end)
5820 (save-excursion
5821 (if (org-up-heading-safe)
5822 (progn
5823 (hide-subtree)
5824 (show-entry)
5825 (show-children)
5826 (org-cycle-show-empty-lines 'children)
5827 (org-cycle-hide-drawers 'children))
5828 (org-overview)))))
5830 (defun org-cycle-show-empty-lines (state)
5831 "Show empty lines above all visible headlines.
5832 The region to be covered depends on STATE when called through
5833 `org-cycle-hook'. Lisp program can use t for STATE to get the
5834 entire buffer covered. Note that an empty line is only shown if there
5835 are at least `org-cycle-separator-lines' empty lines before the headeline."
5836 (when (> org-cycle-separator-lines 0)
5837 (save-excursion
5838 (let* ((n org-cycle-separator-lines)
5839 (re (cond
5842 (t (let ((ns (number-to-string (- n 2))))
5845 beg end)
5846 (cond
5847 ((memq state '(overview contents t))
5848 (setq beg (point-min) end (point-max)))
5849 ((memq state '(children folded))
5850 (setq beg (point) end (progn (org-end-of-subtree t t)
5851 (beginning-of-line 2)
5852 (point)))))
5853 (when beg
5854 (goto-char beg)
5855 (while (re-search-forward re end t)
5856 (if (not (get-char-property (match-end 1) 'invisible))
5857 (outline-flag-region
5858 (match-beginning 1) (match-end 1) nil)))))))
5859 ;; Never hide empty lines at the end of the file.
5860 (save-excursion
5861 (goto-char (point-max))
5862 (outline-previous-heading)
5863 (outline-end-of-heading)
5865 (= (match-end 0) (point-max)))
5866 (outline-flag-region (point) (match-end 0) nil))))
5868 (defun org-subtree-end-visible-p ()
5869 "Is the end of the current subtree visible?"
5870 (pos-visible-in-window-p
5871 (save-excursion (org-end-of-subtree t) (point))))
5873 (defun org-first-headline-recenter (&optional N)
5874 "Move cursor to the first headline and recenter the headline.
5875 Optional argument N means, put the headline into the Nth line of the window."
5876 (goto-char (point-min))
5878 (beginning-of-line)
5879 (recenter (prefix-numeric-value N))))
5881 ;;; Org-goto
5883 (defvar org-goto-window-configuration nil)
5884 (defvar org-goto-marker nil)
5885 (defvar org-goto-map
5886 (let ((map (make-sparse-keymap)))
5887 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5888 (while (setq cmd (pop cmds))
5889 (substitute-key-definition cmd cmd map global-map)))
5890 (suppress-keymap map)
5891 (org-defkey map "\C-m" 'org-goto-ret)
5892 (org-defkey map [(return)] 'org-goto-ret)
5893 (org-defkey map [(left)] 'org-goto-left)
5894 (org-defkey map [(right)] 'org-goto-right)
5895 (org-defkey map [(control ?g)] 'org-goto-quit)
5896 (org-defkey map "\C-i" 'org-cycle)
5897 (org-defkey map [(tab)] 'org-cycle)
5898 (org-defkey map [(down)] 'outline-next-visible-heading)
5899 (org-defkey map [(up)] 'outline-previous-visible-heading)
5900 (if org-goto-auto-isearch
5901 (if (fboundp 'define-key-after)
5902 (define-key-after map [t] 'org-goto-local-auto-isearch)
5903 nil)
5904 (org-defkey map "q" 'org-goto-quit)
5905 (org-defkey map "n" 'outline-next-visible-heading)
5906 (org-defkey map "p" 'outline-previous-visible-heading)
5907 (org-defkey map "f" 'outline-forward-same-level)
5908 (org-defkey map "b" 'outline-backward-same-level)
5909 (org-defkey map "u" 'outline-up-heading))
5910 (org-defkey map "/" 'org-occur)
5911 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5912 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5913 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5914 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5915 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5916 map))
5918 (defconst org-goto-help
5919 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5920 RET=jump to location [Q]uit and return to previous location
5921 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5923 (defvar org-goto-start-pos) ; dynamically scoped parameter
5925 (defun org-goto (&optional alternative-interface)
5926 "Look up a different location in the current file, keeping current visibility.
5928 When you want look-up or go to a different location in a document, the
5929 fastest way is often to fold the entire buffer and then dive into the tree.
5930 This method has the disadvantage, that the previous location will be folded,
5931 which may not be what you want.
5933 This command works around this by showing a copy of the current buffer
5934 in an indirect buffer, in overview mode. You can dive into the tree in
5935 that copy, use org-occur and incremental search to find a location.
5936 When pressing RET or `Q', the command returns to the original buffer in
5937 which the visibility is still unchanged. After RET is will also jump to
5938 the location selected in the indirect buffer and expose the
5939 the headline hierarchy above."
5940 (interactive "P")
5941 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
5942 (org-refile-use-outline-path t)
5943 (interface
5944 (if (not alternative-interface)
5945 org-goto-interface
5946 (if (eq org-goto-interface 'outline)
5947 'outline-path-completion
5948 'outline)))
5949 (org-goto-start-pos (point))
5950 (selected-point
5951 (if (eq interface 'outline)
5952 (car (org-get-location (current-buffer) org-goto-help))
5953 (nth 3 (org-refile-get-location "Goto: ")))))
5954 (if selected-point
5955 (progn
5956 (org-mark-ring-push org-goto-start-pos)
5957 (goto-char selected-point)
5958 (if (or (org-invisible-p) (org-invisible-p2))
5959 (org-show-context 'org-goto)))
5960 (message "Quit"))))
5962 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5963 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5964 (defvar org-goto-local-auto-isearch-map) ; defined below
5966 (defun org-get-location (buf help)
5967 "Let the user select a location in the Org-mode buffer BUF.
5968 This function uses a recursive edit. It returns the selected position
5969 or nil."
5970 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5971 (isearch-hide-immediately nil)
5972 (isearch-search-fun-function
5973 (lambda () 'org-goto-local-search-forward-headings))
5974 (org-goto-selected-point org-goto-exit-command))
5975 (save-excursion
5976 (save-window-excursion
5977 (delete-other-windows)
5978 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5979 (switch-to-buffer
5980 (condition-case nil
5981 (make-indirect-buffer (current-buffer) "*org-goto*")
5982 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5983 (with-output-to-temp-buffer "*Help*"
5984 (princ help))
5985 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5986 (setq buffer-read-only nil)
5987 (let ((org-startup-truncated t)
5988 (org-startup-folded nil)
5989 (org-startup-align-all-tables nil))
5990 (org-mode)
5991 (org-overview))
5992 (setq buffer-read-only t)
5993 (if (and (boundp 'org-goto-start-pos)
5994 (integer-or-marker-p org-goto-start-pos))
5995 (let ((org-show-hierarchy-above t)
5996 (org-show-siblings t)
5997 (org-show-following-heading t))
5998 (goto-char org-goto-start-pos)
5999 (and (org-invisible-p) (org-show-context)))
6000 (goto-char (point-min)))
6001 (org-beginning-of-line)
6002 (message "Select location and press RET")
6003 (use-local-map org-goto-map)
6004 (recursive-edit)
6005 ))
6006 (kill-buffer "*org-goto*")
6007 (cons org-goto-selected-point org-goto-exit-command)))
6009 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6010 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6011 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6012 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6014 (defun org-goto-local-search-forward-headings (string bound noerror)
6015 "Search and make sure that anu matches are in headlines."
6016 (catch 'return
6017 (while (search-forward string bound noerror)
6018 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6019 (and (member :headline context)
6020 (not (member :tags context))))
6021 (throw 'return (point))))))
6023 (defun org-goto-local-auto-isearch ()
6024 "Start isearch."
6025 (interactive)
6026 (goto-char (point-min))
6027 (let ((keys (this-command-keys)))
6028 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6029 (isearch-mode t)
6030 (isearch-process-search-char (string-to-char keys)))))
6032 (defun org-goto-ret (&optional arg)
6033 "Finish `org-goto' by going to the new location."
6034 (interactive "P")
6035 (setq org-goto-selected-point (point)
6036 org-goto-exit-command 'return)
6037 (throw 'exit nil))
6039 (defun org-goto-left ()
6040 "Finish `org-goto' by going to the new location."
6041 (interactive)
6042 (if (org-on-heading-p)
6043 (progn
6044 (beginning-of-line 1)
6045 (setq org-goto-selected-point (point)
6046 org-goto-exit-command 'left)
6047 (throw 'exit nil))
6048 (error "Not on a heading")))
6050 (defun org-goto-right ()
6051 "Finish `org-goto' by going to the new location."
6052 (interactive)
6053 (if (org-on-heading-p)
6054 (progn
6055 (setq org-goto-selected-point (point)
6056 org-goto-exit-command 'right)
6057 (throw 'exit nil))
6058 (error "Not on a heading")))
6060 (defun org-goto-quit ()
6061 "Finish `org-goto' without cursor motion."
6062 (interactive)
6063 (setq org-goto-selected-point nil)
6064 (setq org-goto-exit-command 'quit)
6065 (throw 'exit nil))
6067 ;;; Indirect buffer display of subtrees
6069 (defvar org-indirect-dedicated-frame nil
6070 "This is the frame being used for indirect tree display.")
6071 (defvar org-last-indirect-buffer nil)
6073 (defun org-tree-to-indirect-buffer (&optional arg)
6074 "Create indirect buffer and narrow it to current subtree.
6075 With numerical prefix ARG, go up to this level and then take that tree.
6076 If ARG is negative, go up that many levels.
6077 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6078 indirect buffer previously made with this command, to avoid proliferation of
6079 indirect buffers. However, when you call the command with a `C-u' prefix, or
6080 when `org-indirect-buffer-display' is `new-frame', the last buffer
6081 is kept so that you can work with several indirect buffers at the same time.
6082 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6083 requests that a new frame be made for the new buffer, so that the dedicated
6084 frame is not changed."
6085 (interactive "P")
6086 (let ((cbuf (current-buffer))
6087 (cwin (selected-window))
6088 (pos (point))
6089 beg end level heading ibuf)
6090 (save-excursion
6091 (org-back-to-heading t)
6092 (when (numberp arg)
6093 (setq level (org-outline-level))
6094 (if (< arg 0) (setq arg (+ level arg)))
6095 (while (> (setq level (org-outline-level)) arg)
6096 (outline-up-heading 1 t)))
6097 (setq beg (point)
6098 heading (org-get-heading))
6099 (org-end-of-subtree t) (setq end (point)))
6100 (if (and (buffer-live-p org-last-indirect-buffer)
6101 (not (eq org-indirect-buffer-display 'new-frame))
6102 (not arg))
6103 (kill-buffer org-last-indirect-buffer))
6104 (setq ibuf (org-get-indirect-buffer cbuf)
6105 org-last-indirect-buffer ibuf)
6106 (cond
6107 ((or (eq org-indirect-buffer-display 'new-frame)
6108 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6109 (select-frame (make-frame))
6110 (delete-other-windows)
6111 (switch-to-buffer ibuf)
6112 (org-set-frame-title heading))
6113 ((eq org-indirect-buffer-display 'dedicated-frame)
6114 (raise-frame
6115 (select-frame (or (and org-indirect-dedicated-frame
6116 (frame-live-p org-indirect-dedicated-frame)
6117 org-indirect-dedicated-frame)
6118 (setq org-indirect-dedicated-frame (make-frame)))))
6119 (delete-other-windows)
6120 (switch-to-buffer ibuf)
6121 (org-set-frame-title (concat "Indirect: " heading)))
6122 ((eq org-indirect-buffer-display 'current-window)
6123 (switch-to-buffer ibuf))
6124 ((eq org-indirect-buffer-display 'other-window)
6125 (pop-to-buffer ibuf))
6126 (t (error "Invalid value.")))
6127 (if (featurep 'xemacs)
6128 (save-excursion (org-mode) (turn-on-font-lock)))
6129 (narrow-to-region beg end)
6130 (show-all)
6131 (goto-char pos)
6132 (and (window-live-p cwin) (select-window cwin))))
6134 (defun org-get-indirect-buffer (&optional buffer)
6135 (setq buffer (or buffer (current-buffer)))
6136 (let ((n 1) (base (buffer-name buffer)) bname)
6137 (while (buffer-live-p
6138 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6139 (setq n (1+ n)))
6140 (condition-case nil
6141 (make-indirect-buffer buffer bname 'clone)
6142 (error (make-indirect-buffer buffer bname)))))
6144 (defun org-set-frame-title (title)
6145 "Set the title of the current frame to the string TITLE."
6146 ;; FIXME: how to name a single frame in XEmacs???
6147 (unless (featurep 'xemacs)
6148 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6150 ;;;; Structure editing
6152 ;;; Inserting headlines
6154 (defun org-insert-heading (&optional force-heading)
6155 "Insert a new heading or item with same depth at point.
6156 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6157 If point is at the beginning of a headline, insert a sibling before the
6158 current headline. If point is not at the beginning, do not split the line,
6159 but create the new hedline after the current line."
6160 (interactive "P")
6161 (if (= (buffer-size) 0)
6163 (when (or force-heading (not (org-insert-item)))
6164 (let* ((head (save-excursion
6165 (condition-case nil
6166 (progn
6167 (org-back-to-heading)
6168 (match-string 0))
6169 (error "*"))))
6170 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6171 pos)
6172 (cond
6173 ((and (org-on-heading-p) (bolp)
6174 (or (bobp)
6175 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6176 ;; insert before the current line
6177 (open-line (if blank 2 1)))
6178 ((and (bolp)
6179 (or (bobp)
6180 (save-excursion
6181 (backward-char 1) (not (org-invisible-p)))))
6182 ;; insert right here
6183 nil)
6184 (t
6185 ;; in the middle of the line
6186 (org-show-entry)
6187 (end-of-line 1)
6188 (newline (if blank 2 1))))
6189 (insert head) (just-one-space)
6190 (setq pos (point))
6191 (end-of-line 1)
6192 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6193 (run-hooks 'org-insert-heading-hook)))))
6195 (defun org-insert-heading-after-current ()
6196 "Insert a new heading with same level as current, after current subtree."
6197 (interactive)
6198 (org-back-to-heading)
6199 (org-insert-heading)
6200 (org-move-subtree-down)
6201 (end-of-line 1))
6203 (defun org-insert-todo-heading (arg)
6204 "Insert a new heading with the same level and TODO state as current heading.
6205 If the heading has no TODO state, or if the state is DONE, use the first
6206 state (TODO by default). Also with prefix arg, force first state."
6207 (interactive "P")
6208 (when (not (org-insert-item 'checkbox))
6209 (org-insert-heading)
6210 (save-excursion
6211 (org-back-to-heading)
6212 (outline-previous-heading)
6213 (looking-at org-todo-line-regexp))
6214 (if (or arg
6215 (not (match-beginning 2))
6216 (member (match-string 2) org-done-keywords))
6217 (insert (car org-todo-keywords-1) " ")
6218 (insert (match-string 2) " "))))
6220 (defun org-insert-subheading (arg)
6221 "Insert a new subheading and demote it.
6222 Works for outline headings and for plain lists alike."
6223 (interactive "P")
6224 (org-insert-heading arg)
6225 (cond
6226 ((org-on-heading-p) (org-do-demote))
6227 ((org-at-item-p) (org-indent-item 1))))
6229 (defun org-insert-todo-subheading (arg)
6230 "Insert a new subheading with TODO keyword or checkbox and demote it.
6231 Works for outline headings and for plain lists alike."
6232 (interactive "P")
6233 (org-insert-todo-heading arg)
6234 (cond
6235 ((org-on-heading-p) (org-do-demote))
6236 ((org-at-item-p) (org-indent-item 1))))
6238 ;;; Promotion and Demotion
6240 (defun org-promote-subtree ()
6241 "Promote the entire subtree.
6242 See also `org-promote'."
6243 (interactive)
6244 (save-excursion
6245 (org-map-tree 'org-promote))
6246 (org-fix-position-after-promote))
6248 (defun org-demote-subtree ()
6249 "Demote the entire subtree. See `org-demote'.
6250 See also `org-promote'."
6251 (interactive)
6252 (save-excursion
6253 (org-map-tree 'org-demote))
6254 (org-fix-position-after-promote))
6257 (defun org-do-promote ()
6258 "Promote the current heading higher up the tree.
6259 If the region is active in `transient-mark-mode', promote all headings
6260 in the region."
6261 (interactive)
6262 (save-excursion
6263 (if (org-region-active-p)
6264 (org-map-region 'org-promote (region-beginning) (region-end))
6265 (org-promote)))
6266 (org-fix-position-after-promote))
6268 (defun org-do-demote ()
6269 "Demote the current heading lower down the tree.
6270 If the region is active in `transient-mark-mode', demote all headings
6271 in the region."
6272 (interactive)
6273 (save-excursion
6274 (if (org-region-active-p)
6275 (org-map-region 'org-demote (region-beginning) (region-end))
6276 (org-demote)))
6277 (org-fix-position-after-promote))
6279 (defun org-fix-position-after-promote ()
6280 "Make sure that after pro/demotion cursor position is right."
6281 (let ((pos (point)))
6282 (when (save-excursion
6283 (beginning-of-line 1)
6284 (looking-at org-todo-line-regexp)
6285 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6286 (cond ((eobp) (insert " "))
6287 ((eolp) (insert " "))
6288 ((equal (char-after) ?\ ) (forward-char 1))))))
6290 (defun org-reduced-level (l)
6291 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6293 (defun org-get-legal-level (level &optional change)
6294 "Rectify a level change under the influence of `org-odd-levels-only'
6295 LEVEL is a current level, CHANGE is by how much the level should be
6296 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6297 even level numbers will become the next higher odd number."
6298 (if org-odd-levels-only
6299 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6300 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6301 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6302 (max 1 (+ level change))))
6304 (defun org-promote ()
6305 "Promote the current heading higher up the tree.
6306 If the region is active in `transient-mark-mode', promote all headings
6307 in the region."
6308 (org-back-to-heading t)
6309 (let* ((level (save-match-data (funcall outline-level)))
6310 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6311 (diff (abs (- level (length up-head) -1))))
6312 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6313 (replace-match up-head nil t)
6314 ;; Fixup tag positioning
6315 (and org-auto-align-tags (org-set-tags nil t))
6316 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6318 (defun org-demote ()
6319 "Demote the current heading lower down the tree.
6320 If the region is active in `transient-mark-mode', demote all headings
6321 in the region."
6322 (org-back-to-heading t)
6323 (let* ((level (save-match-data (funcall outline-level)))
6324 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6325 (diff (abs (- level (length down-head) -1))))
6326 (replace-match down-head nil t)
6327 ;; Fixup tag positioning
6328 (and org-auto-align-tags (org-set-tags nil t))
6329 (if org-adapt-indentation (org-fixup-indentation diff))))
6331 (defun org-map-tree (fun)
6332 "Call FUN for every heading underneath the current one."
6333 (org-back-to-heading)
6334 (let ((level (funcall outline-level)))
6335 (save-excursion
6336 (funcall fun)
6337 (while (and (progn
6338 (outline-next-heading)
6339 (> (funcall outline-level) level))
6340 (not (eobp)))
6341 (funcall fun)))))
6343 (defun org-map-region (fun beg end)
6344 "Call FUN for every heading between BEG and END."
6345 (let ((org-ignore-region t))
6346 (save-excursion
6347 (setq end (copy-marker end))
6348 (goto-char beg)
6349 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6350 (< (point) end))
6351 (funcall fun))
6352 (while (and (progn
6353 (outline-next-heading)
6354 (< (point) end))
6355 (not (eobp)))
6356 (funcall fun)))))
6358 (defun org-fixup-indentation (diff)
6359 "Change the indentation in the current entry by DIFF
6360 However, if any line in the current entry has no indentation, or if it
6361 would end up with no indentation after the change, nothing at all is done."
6362 (save-excursion
6363 (let ((end (save-excursion (outline-next-heading)
6364 (point-marker)))
6365 (prohibit (if (> diff 0)
6368 col)
6369 (unless (save-excursion (end-of-line 1)
6370 (re-search-forward prohibit end t))
6371 (while (and (< (point) end)
6373 (goto-char (match-end 0))
6374 (setq col (current-column))
6375 (if (< diff 0) (replace-match ""))
6376 (indent-to (+ diff col))))
6377 (move-marker end nil))))
6379 (defun org-convert-to-odd-levels ()
6380 "Convert an org-mode file with all levels allowed to one with odd levels.
6381 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6382 level 5 etc."
6383 (interactive)
6384 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6385 (let ((org-odd-levels-only nil) n)
6386 (save-excursion
6387 (goto-char (point-min))
6389 (setq n (- (length (match-string 0)) 2))
6390 (while (>= (setq n (1- n)) 0)
6391 (org-demote))
6392 (end-of-line 1))))))
6395 (defun org-convert-to-oddeven-levels ()
6396 "Convert an org-mode file with only odd levels to one with odd and even levels.
6397 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6398 section with an even level, conversion would destroy the structure of the file. An error
6399 is signaled in this case."
6400 (interactive)
6401 (goto-char (point-min))
6402 ;; First check if there are no even levels
6404 (org-show-context t)
6405 (error "Not all levels are odd in this file. Conversion not possible."))
6406 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6407 (let ((org-odd-levels-only nil) n)
6408 (save-excursion
6409 (goto-char (point-min))
6411 (setq n (/ (1- (length (match-string 0))) 2))
6412 (while (>= (setq n (1- n)) 0)
6413 (org-promote))
6414 (end-of-line 1))))))
6416 (defun org-tr-level (n)
6417 "Make N odd if required."
6418 (if org-odd-levels-only (1+ (/ n 2)) n))
6420 ;;; Vertical tree motion, cutting and pasting of subtrees
6422 (defun org-move-subtree-up (&optional arg)
6423 "Move the current subtree up past ARG headlines of the same level."
6424 (interactive "p")
6425 (org-move-subtree-down (- (prefix-numeric-value arg))))
6427 (defun org-move-subtree-down (&optional arg)
6428 "Move the current subtree down past ARG headlines of the same level."
6429 (interactive "p")
6430 (setq arg (prefix-numeric-value arg))
6431 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6432 'outline-get-last-sibling))
6433 (ins-point (make-marker))
6434 (cnt (abs arg))
6435 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6436 ;; Select the tree
6437 (org-back-to-heading)
6438 (setq beg0 (point))
6439 (save-excursion
6440 (setq ne-beg (org-back-over-empty-lines))
6441 (setq beg (point)))
6442 (save-match-data
6443 (save-excursion (outline-end-of-heading)
6444 (setq folded (org-invisible-p)))
6445 (outline-end-of-subtree))
6446 (outline-next-heading)
6447 (setq ne-end (org-back-over-empty-lines))
6448 (setq end (point))
6449 (goto-char beg0)
6450 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6451 ;; include less whitespace
6452 (save-excursion
6453 (goto-char beg)
6454 (forward-line (- ne-beg ne-end))
6455 (setq beg (point))))
6456 ;; Find insertion point, with error handling
6457 (while (> cnt 0)
6458 (or (and (funcall movfunc) (looking-at outline-regexp))
6459 (progn (goto-char beg0)
6460 (error "Cannot move past superior level or buffer limit")))
6461 (setq cnt (1- cnt)))
6462 (if (> arg 0)
6463 ;; Moving forward - still need to move over subtree
6464 (progn (org-end-of-subtree t t)
6465 (save-excursion
6466 (org-back-over-empty-lines)
6467 (or (bolp) (newline)))))
6468 (setq ne-ins (org-back-over-empty-lines))
6469 (move-marker ins-point (point))
6470 (setq txt (buffer-substring beg end))
6471 (delete-region beg end)
6472 (outline-flag-region (1- beg) beg nil)
6473 (outline-flag-region (1- (point)) (point) nil)
6474 (insert txt)
6476 (setq ins-end (point))
6477 (goto-char ins-point)
6478 (org-skip-whitespace)
6479 (when (and (< arg 0)
6480 (org-first-sibling-p)
6481 (> ne-ins ne-beg))
6482 ;; Move whitespace back to beginning
6483 (save-excursion
6484 (goto-char ins-end)
6485 (let ((kill-whole-line t))
6486 (kill-line (- ne-ins ne-beg)) (point)))
6488 (move-marker ins-point nil)
6489 (org-compact-display-after-subtree-move)
6490 (unless folded
6491 (org-show-entry)
6492 (show-children)
6493 (org-cycle-hide-drawers 'children))))
6495 (defvar org-subtree-clip ""
6496 "Clipboard for cut and paste of subtrees.
6497 This is actually only a copy of the kill, because we use the normal kill
6498 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6500 (defvar org-subtree-clip-folded nil
6501 "Was the last copied subtree folded?
6502 This is used to fold the tree back after pasting.")
6504 (defun org-cut-subtree (&optional n)
6505 "Cut the current subtree into the clipboard.
6506 With prefix arg N, cut this many sequential subtrees.
6507 This is a short-hand for marking the subtree and then cutting it."
6508 (interactive "p")
6509 (org-copy-subtree n 'cut))
6511 (defun org-copy-subtree (&optional n cut)
6512 "Cut the current subtree into the clipboard.
6513 With prefix arg N, cut this many sequential subtrees.
6514 This is a short-hand for marking the subtree and then copying it.
6515 If CUT is non-nil, actually cut the subtree."
6516 (interactive "p")
6517 (let (beg end folded (beg0 (point)))
6518 (if (interactive-p)
6519 (org-back-to-heading nil) ; take what looks like a subtree
6520 (org-back-to-heading t)) ; take what is really there
6521 (org-back-over-empty-lines)
6522 (setq beg (point))
6524 (save-match-data
6525 (save-excursion (outline-end-of-heading)
6526 (setq folded (org-invisible-p)))
6527 (condition-case nil
6528 (outline-forward-same-level (1- n))
6529 (error nil))
6530 (org-end-of-subtree t t))
6531 (org-back-over-empty-lines)
6532 (setq end (point))
6533 (goto-char beg0)
6534 (when (> end beg)
6535 (setq org-subtree-clip-folded folded)
6536 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6537 (setq org-subtree-clip (current-kill 0))
6538 (message "%s: Subtree(s) with %d characters"
6539 (if cut "Cut" "Copied")
6540 (length org-subtree-clip)))))
6542 (defun org-paste-subtree (&optional level tree)
6543 "Paste the clipboard as a subtree, with modification of headline level.
6544 The entire subtree is promoted or demoted in order to match a new headline
6545 level. By default, the new level is derived from the visible headings
6546 before and after the insertion point, and taken to be the inferior headline
6547 level of the two. So if the previous visible heading is level 3 and the
6548 next is level 4 (or vice versa), level 4 will be used for insertion.
6549 This makes sure that the subtree remains an independent subtree and does
6550 not swallow low level entries.
6552 You can also force a different level, either by using a numeric prefix
6553 argument, or by inserting the heading marker by hand. For example, if the
6558 If optional TREE is given, use this text instead of the kill ring."
6559 (interactive "P")
6560 (unless (org-kill-is-subtree-p tree)
6561 (error "%s"
6562 (substitute-command-keys
6564 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6569 (old-level (if (string-match ^re txt)
6570 (- (match-end 0) (match-beginning 0) 1)
6571 -1))
6572 (force-level (cond (level (prefix-numeric-value level))
6573 ((string-match
6574 ^re_ (buffer-substring (point-at-bol) (point)))
6575 (- (match-end 1) (match-beginning 1)))
6576 (t nil)))
6577 (previous-level (save-excursion
6578 (condition-case nil
6579 (progn
6580 (outline-previous-visible-heading 1)
6581 (if (looking-at re)
6582 (- (match-end 0) (match-beginning 0) 1)
6583 1))
6584 (error 1))))
6585 (next-level (save-excursion
6586 (condition-case nil
6587 (progn
6588 (or (looking-at outline-regexp)
6589 (outline-next-visible-heading 1))
6590 (if (looking-at re)
6591 (- (match-end 0) (match-beginning 0) 1)
6592 1))
6593 (error 1))))
6594 (new-level (or force-level (max previous-level next-level)))
6595 (shift (if (or (= old-level -1)
6596 (= new-level -1)
6597 (= old-level new-level))
6598 0
6599 (- new-level old-level)))
6600 (delta (if (> shift 0) -1 1))
6601 (func (if (> shift 0) 'org-demote 'org-promote))
6602 (org-odd-levels-only nil)
6603 beg end)
6604 ;; Remove the forced level indicator
6605 (if force-level
6606 (delete-region (point-at-bol) (point)))
6607 ;; Paste
6608 (beginning-of-line 1)
6609 (org-back-over-empty-lines) ;; FIXME: correct fix????
6610 (setq beg (point))
6611 (insert-before-markers txt) ;; FIXME: correct fix????
6613 (setq end (point))
6614 (goto-char beg)
6616 (setq beg (point))
6617 ;; Shift if necessary
6618 (unless (= shift 0)
6619 (save-restriction
6620 (narrow-to-region beg end)
6621 (while (not (= shift 0))
6622 (org-map-region func (point-min) (point-max))
6623 (setq shift (+ delta shift)))
6624 (goto-char (point-min))))
6625 (when (interactive-p)
6626 (message "Clipboard pasted as level %d subtree" new-level))
6627 (if (and kill-ring
6628 (eq org-subtree-clip (current-kill 0))
6629 org-subtree-clip-folded)
6630 ;; The tree was folded before it was killed/copied
6631 (hide-subtree))))
6633 (defun org-kill-is-subtree-p (&optional txt)
6634 "Check if the current kill is an outline subtree, or a set of trees.
6635 Returns nil if kill does not start with a headline, or if the first
6636 headline level is not the largest headline level in the tree.
6637 So this will actually accept several entries of equal levels as well,
6638 which is OK for `org-paste-subtree'.
6639 If optional TXT is given, check this string instead of the current kill."
6640 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6641 (start-level (and kill
6644 kill)
6645 (- (match-end 2) (match-beginning 2) 1)))
6646 (re (concat "^" org-outline-regexp))
6647 (start (1+ (match-beginning 2))))
6648 (if (not start-level)
6649 (progn
6650 nil) ;; does not even start with a heading
6651 (catch 'exit
6652 (while (setq start (string-match re kill (1+ start)))
6653 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6654 (throw 'exit nil)))
6655 t))))
6657 (defun org-narrow-to-subtree ()
6658 "Narrow buffer to the current subtree."
6659 (interactive)
6660 (save-excursion
6661 (narrow-to-region
6662 (progn (org-back-to-heading) (point))
6663 (progn (org-end-of-subtree t t) (point)))))
6666 ;;; Outline Sorting
6668 (defun org-sort (with-case)
6669 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6670 Optional argument WITH-CASE means sort case-sensitively."
6671 (interactive "P")
6672 (if (org-at-table-p)
6673 (org-call-with-arg 'org-table-sort-lines with-case)
6674 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6676 (defvar org-priority-regexp) ; defined later in the file
6678 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6679 "Sort entries on a certain level of an outline tree.
6680 If there is an active region, the entries in the region are sorted.
6681 Else, if the cursor is before the first entry, sort the top-level items.
6682 Else, the children of the entry at point are sorted.
6684 Sorting can be alphabetically, numerically, and by date/time as given by
6685 the first time stamp in the entry. The command prompts for the sorting
6686 type unless it has been given to the function through the SORTING-TYPE
6687 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6688 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6689 called with point at the beginning of the record. It must return either
6690 a string or a number that should serve as the sorting key for that record.
6692 Comparing entries ignores case by default. However, with an optional argument
6693 WITH-CASE, the sorting considers case as well."
6694 (interactive "P")
6695 (let ((case-func (if with-case 'identity 'downcase))
6696 start beg end stars re re2
6697 txt what tmp plain-list-p)
6698 ;; Find beginning and end of region to sort
6699 (cond
6700 ((org-region-active-p)
6701 ;; we will sort the region
6702 (setq end (region-end)
6703 what "region")
6704 (goto-char (region-beginning))
6705 (if (not (org-on-heading-p)) (outline-next-heading))
6706 (setq start (point)))
6707 ((org-at-item-p)
6708 ;; we will sort this plain list
6709 (org-beginning-of-item-list) (setq start (point))
6710 (org-end-of-item-list) (setq end (point))
6711 (goto-char start)
6712 (setq plain-list-p t
6713 what "plain list"))
6714 ((or (org-on-heading-p)
6715 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6716 ;; we will sort the children of the current headline
6717 (org-back-to-heading)
6718 (setq start (point)
6719 end (progn (org-end-of-subtree t t)
6720 (org-back-over-empty-lines)
6721 (point))
6722 what "children")
6723 (goto-char start)
6724 (show-subtree)
6725 (outline-next-heading))
6726 (t
6727 ;; we will sort the top-level entries in this file
6728 (goto-char (point-min))
6729 (or (org-on-heading-p) (outline-next-heading))
6730 (setq start (point) end (point-max) what "top-level")
6731 (goto-char start)
6732 (show-all)))
6734 (setq beg (point))
6735 (if (>= beg end) (error "Nothing to sort"))
6737 (unless plain-list-p
6739 (setq stars (match-string 1)
6740 re (concat "^" (regexp-quote stars) " +")
6741 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6742 txt (buffer-substring beg end))
6744 (if (and (not (equal stars "*")) (string-match re2 txt))
6745 (error "Region to sort contains a level above the first entry")))
6747 (unless sorting-type
6748 (message
6749 (if plain-list-p
6750 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6751 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6752 what)
6753 (setq sorting-type (read-char-exclusive))
6755 (and (= (downcase sorting-type) ?f)
6756 (setq getkey-func
6757 (completing-read "Sort using function: "
6758 obarray 'fboundp t nil nil))
6759 (setq getkey-func (intern getkey-func)))
6761 (and (= (downcase sorting-type) ?r)
6762 (setq property
6763 (completing-read "Property: "
6764 (mapcar 'list (org-buffer-property-keys t))
6765 nil t))))
6767 (message "Sorting entries...")
6769 (save-restriction
6770 (narrow-to-region start end)
6772 (let ((dcst (downcase sorting-type))
6773 (now (current-time)))
6774 (sort-subr
6775 (/= dcst sorting-type)
6776 ;; This function moves to the beginning character of the "record" to
6777 ;; be sorted.
6778 (if plain-list-p
6779 (lambda nil
6780 (if (org-at-item-p) t (goto-char (point-max))))
6781 (lambda nil
6782 (if (re-search-forward re nil t)
6783 (goto-char (match-beginning 0))
6784 (goto-char (point-max)))))
6785 ;; This function moves to the last character of the "record" being
6786 ;; sorted.
6787 (if plain-list-p
6788 'org-end-of-item
6789 (lambda nil
6790 (save-match-data
6791 (condition-case nil
6792 (outline-forward-same-level 1)
6793 (error
6794 (goto-char (point-max)))))))
6796 ;; This function returns the value that gets sorted against.
6797 (if plain-list-p
6798 (lambda nil
6800 (cond
6801 ((= dcst ?n)
6802 (string-to-number (buffer-substring (match-end 0)
6803 (point-at-eol))))
6804 ((= dcst ?a)
6805 (buffer-substring (match-end 0) (point-at-eol)))
6806 ((= dcst ?t)
6807 (if (re-search-forward org-ts-regexp
6808 (point-at-eol) t)
6809 (org-time-string-to-time (match-string 0))
6810 now))
6811 ((= dcst ?f)
6812 (if getkey-func
6813 (progn
6814 (setq tmp (funcall getkey-func))
6815 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6816 tmp)
6817 (error "Invalid key function `%s'" getkey-func)))
6818 (t (error "Invalid sorting type `%c'" sorting-type)))))
6819 (lambda nil
6820 (cond
6821 ((= dcst ?n)
6822 (if (looking-at outline-regexp)
6823 (string-to-number (buffer-substring (match-end 0)
6824 (point-at-eol)))
6825 nil))
6826 ((= dcst ?a)
6827 (funcall case-func (buffer-substring (point-at-bol)
6828 (point-at-eol))))
6829 ((= dcst ?t)
6830 (if (re-search-forward org-ts-regexp
6831 (save-excursion
6832 (forward-line 2)
6833 (point)) t)
6834 (org-time-string-to-time (match-string 0))
6835 now))
6836 ((= dcst ?p)
6837 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6838 (string-to-char (match-string 2))
6839 org-default-priority))
6840 ((= dcst ?r)
6841 (or (org-entry-get nil property) ""))
6842 ((= dcst ?f)
6843 (if getkey-func
6844 (progn
6845 (setq tmp (funcall getkey-func))
6846 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6847 tmp)
6848 (error "Invalid key function `%s'" getkey-func)))
6849 (t (error "Invalid sorting type `%c'" sorting-type)))))
6850 nil
6851 (cond
6852 ((= dcst ?a) 'string<)
6853 ((= dcst ?t) 'time-less-p)
6854 (t nil)))))
6855 (message "Sorting entries...done")))
6857 (defun org-do-sort (table what &optional with-case sorting-type)
6858 "Sort TABLE of WHAT according to SORTING-TYPE.
6859 The user will be prompted for the SORTING-TYPE if the call to this
6860 function does not specify it. WHAT is only for the prompt, to indicate
6861 what is being sorted. The sorting key will be extracted from
6862 the car of the elements of the table.
6863 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6864 (unless sorting-type
6865 (message
6866 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6867 what)
6868 (setq sorting-type (read-char-exclusive)))
6869 (let ((dcst (downcase sorting-type))
6870 extractfun comparefun)
6871 ;; Define the appropriate functions
6872 (cond
6873 ((= dcst ?n)
6874 (setq extractfun 'string-to-number
6875 comparefun (if (= dcst sorting-type) '< '>)))
6876 ((= dcst ?a)
6877 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6878 (lambda(x) (downcase (org-sort-remove-invisible x))))
6879 comparefun (if (= dcst sorting-type)
6880 'string<
6881 (lambda (a b) (and (not (string< a b))
6882 (not (string= a b)))))))
6883 ((= dcst ?t)
6884 (setq extractfun
6885 (lambda (x)
6886 (if (string-match org-ts-regexp x)
6887 (time-to-seconds
6888 (org-time-string-to-time (match-string 0 x)))
6889 0))
6890 comparefun (if (= dcst sorting-type) '< '>)))
6891 (t (error "Invalid sorting type `%c'" sorting-type)))
6893 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6894 table)
6895 (lambda (a b) (funcall comparefun (car a) (car b))))))
6897 ;;;; Plain list items, including checkboxes
6899 ;;; Plain list items
6901 (defun org-at-item-p ()
6902 "Is point in a line starting a hand-formatted item?"
6903 (let ((llt org-plain-list-ordered-item-terminator))
6904 (save-excursion
6905 (goto-char (point-at-bol))
6906 (looking-at
6907 (cond
6911 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6913 (defun org-in-item-p ()
6914 "It the cursor inside a plain list item.
6915 Does not have to be the first line."
6916 (save-excursion
6917 (condition-case nil
6918 (progn
6919 (org-beginning-of-item)
6920 (org-at-item-p)
6921 t)
6922 (error nil))))
6924 (defun org-insert-item (&optional checkbox)
6925 "Insert a new item at the current level.
6926 Return t when things worked, nil when we are not in an item."
6927 (when (save-excursion
6928 (condition-case nil
6929 (progn
6930 (org-beginning-of-item)
6931 (org-at-item-p)
6932 (if (org-invisible-p) (error "Invisible item"))
6933 t)
6934 (error nil)))
6935 (let* ((bul (match-string 0))
6937 (match-end 0)))
6938 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6939 pos)
6940 (cond
6941 ((and (org-at-item-p) (<= (point) eow))
6942 ;; before the bullet
6943 (beginning-of-line 1)
6944 (open-line (if blank 2 1)))
6945 ((<= (point) eow)
6946 (beginning-of-line 1))
6947 (t (newline (if blank 2 1))))
6948 (insert bul (if checkbox "[ ]" ""))
6949 (just-one-space)
6950 (setq pos (point))
6951 (end-of-line 1)
6952 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6953 (org-maybe-renumber-ordered-list)
6954 (and checkbox (org-update-checkbox-count-maybe))
6955 t))
6957 ;;; Checkboxes
6959 (defun org-at-item-checkbox-p ()
6960 "Is point at a line starting a plain-list item with a checklet?"
6961 (and (org-at-item-p)
6962 (save-excursion
6963 (goto-char (match-end 0))
6967 (defun org-toggle-checkbox (&optional arg)
6968 "Toggle the checkbox in the current line."
6969 (interactive "P")
6970 (catch 'exit
6971 (let (beg end status (firstnew 'unknown))
6972 (cond
6973 ((org-region-active-p)
6974 (setq beg (region-beginning) end (region-end)))
6975 ((org-on-heading-p)
6976 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6977 ((org-at-item-checkbox-p)
6978 (let ((pos (point)))
6979 (replace-match
6980 (cond (arg "[-]")
6981 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6982 (t "[ ]"))
6983 t t)
6984 (goto-char pos))
6985 (throw 'exit t))
6986 (t (error "Not at a checkbox or heading, and no active region")))
6987 (save-excursion
6988 (goto-char beg)
6989 (while (< (point) end)
6990 (when (org-at-item-checkbox-p)
6991 (setq status (equal (match-string 0) "[X]"))
6992 (when (eq firstnew 'unknown)
6993 (setq firstnew (not status)))
6994 (replace-match
6995 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6996 (beginning-of-line 2)))))
6997 (org-update-checkbox-count-maybe))
6999 (defun org-update-checkbox-count-maybe ()
7000 "Update checkbox statistics unless turned off by user."
7001 (when org-provide-checkbox-statistics
7002 (org-update-checkbox-count)))
7004 (defun org-update-checkbox-count (&optional all)
7005 "Update the checkbox statistics in the current section.
7006 This will find all statistic cookies like [57%] and [6/12] and update them
7007 with the current numbers. With optional prefix argument ALL, do this for
7008 the whole buffer."
7009 (interactive "P")
7010 (save-excursion
7011 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7012 (beg (condition-case nil
7013 (progn (outline-back-to-heading) (point))
7014 (error (point-min))))
7015 (end (move-marker (make-marker)
7016 (progn (outline-next-heading) (point))))
7020 beg-cookie end-cookie is-percent c-on c-off lim
7021 eline curr-ind next-ind continue-from startsearch
7022 (cstat 0)
7023 )
7024 (when all
7025 (goto-char (point-min))
7026 (outline-next-heading)
7027 (setq beg (point) end (point-max)))
7028 (goto-char end)
7029 ;; find each statistic cookie
7030 (while (re-search-backward re-find beg t)
7031 (setq beg-cookie (match-beginning 1)
7032 end-cookie (match-end 1)
7033 cstat (+ cstat (if end-cookie 1 0))
7034 startsearch (point-at-eol)
7035 continue-from (point-at-bol)
7036 is-percent (match-beginning 2)
7037 lim (cond
7038 ((org-on-heading-p) (outline-next-heading) (point))
7039 ((org-at-item-p) (org-end-of-item) (point))
7040 (t nil))
7041 c-on 0
7042 c-off 0)
7043 (when lim
7044 ;; find first checkbox for this cookie and gather
7045 ;; statistics from all that are at this indentation level
7046 (goto-char startsearch)
7047 (if (re-search-forward re-box lim t)
7048 (progn
7049 (org-beginning-of-item)
7050 (setq curr-ind (org-get-indentation))
7051 (setq next-ind curr-ind)
7052 (while (= curr-ind next-ind)
7053 (save-excursion (end-of-line) (setq eline (point)))
7054 (if (re-search-forward re-box eline t)
7055 (if (member (match-string 2) '("[ ]" "[-]"))
7056 (setq c-off (1+ c-off))
7057 (setq c-on (1+ c-on))
7058 )
7059 )
7060 (org-end-of-item)
7061 (setq next-ind (org-get-indentation))
7062 )))
7063 (goto-char continue-from)
7064 ;; update cookie
7065 (when end-cookie
7066 (delete-region beg-cookie end-cookie)
7067 (goto-char beg-cookie)
7068 (insert
7069 (if is-percent
7070 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7071 (format "[%d/%d]" c-on (+ c-on c-off)))))
7072 ;; update items checkbox if it has one
7073 (when (org-at-item-p)
7074 (org-beginning-of-item)
7075 (when (and (> (+ c-on c-off) 0)
7076 (re-search-forward re-box (point-at-eol) t))
7077 (setq beg-cookie (match-beginning 2)
7078 end-cookie (match-end 2))
7079 (delete-region beg-cookie end-cookie)
7080 (goto-char beg-cookie)
7081 (cond ((= c-off 0) (insert "[X]"))
7082 ((= c-on 0) (insert "[ ]"))
7083 (t (insert "[-]")))
7084 )))
7085 (goto-char continue-from))
7086 (when (interactive-p)
7087 (message "Checkbox satistics updated %s (%d places)"
7088 (if all "in entire file" "in current outline entry") cstat)))))
7090 (defun org-get-checkbox-statistics-face ()
7091 "Select the face for checkbox statistics.
7092 The face will be `org-done' when all relevant boxes are checked. Otherwise
7093 it will be `org-todo'."
7094 (if (match-end 1)
7095 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7096 (if (and (> (match-end 2) (match-beginning 2))
7097 (equal (match-string 2) (match-string 3)))
7098 'org-done
7099 'org-todo)))
7101 (defun org-get-indentation (&optional line)
7102 "Get the indentation of the current line, interpreting tabs.
7103 When LINE is given, assume it represents a line and compute its indentation."
7104 (if line
7105 (if (string-match "^ *" (org-remove-tabs line))
7106 (match-end 0))
7107 (save-excursion
7108 (beginning-of-line 1)
7110 (current-column))))
7112 (defun org-remove-tabs (s &optional width)
7113 "Replace tabulators in S with spaces.
7114 Assumes that s is a single line, starting in column 0."
7115 (setq width (or width tab-width))
7117 (setq s (replace-match
7118 (make-string
7119 (- (* width (/ (+ (match-beginning 0) width) width))
7120 (match-beginning 0)) ?\ )
7121 t t s)))
7122 s)
7124 (defun org-fix-indentation (line ind)
7125 "Fix indentation in LINE.
7126 IND is a cons cell with target and minimum indentation.
7127 If the current indenation in LINE is smaller than the minimum,
7128 leave it alone. If it is larger than ind, set it to the target."
7129 (let* ((l (org-remove-tabs line))
7130 (i (org-get-indentation l))
7131 (i1 (car ind)) (i2 (cdr ind)))
7132 (if (>= i i2) (setq l (substring line i2)))
7133 (if (> i1 0)
7134 (concat (make-string i1 ?\ ) l)
7135 l)))
7137 (defcustom org-empty-line-terminates-plain-lists nil
7138 "Non-nil means, an empty line ends all plain list levels.
7139 When nil, empty lines are part of the preceeding item."
7140 :group 'org-plain-lists
7141 :type 'boolean)
7143 (defun org-beginning-of-item ()
7144 "Go to the beginning of the current hand-formatted item.
7145 If the cursor is not in an item, throw an error."
7146 (interactive)
7147 (let ((pos (point))
7148 (limit (save-excursion
7149 (condition-case nil
7150 (progn
7151 (org-back-to-heading)
7152 (beginning-of-line 2) (point))
7153 (error (point-min)))))
7154 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7155 ind ind1)
7156 (if (org-at-item-p)
7157 (beginning-of-line 1)
7158 (beginning-of-line 1)
7160 (setq ind (current-column))
7161 (if (catch 'exit
7162 (while t
7163 (beginning-of-line 0)
7164 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7167 (setq ind1 ind-empty)
7169 (setq ind1 (current-column)))
7170 (if (< ind1 ind)
7171 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7172 nil
7173 (goto-char pos)
7174 (error "Not in an item")))))
7176 (defun org-end-of-item ()
7177 "Go to the end of the current hand-formatted item.
7178 If the cursor is not in an item, throw an error."
7179 (interactive)
7180 (let* ((pos (point))
7181 ind1
7182 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7183 (limit (save-excursion (outline-next-heading) (point)))
7184 (ind (save-excursion
7185 (org-beginning-of-item)
7187 (current-column)))
7188 (end (catch 'exit
7189 (while t
7190 (beginning-of-line 2)
7191 (if (eobp) (throw 'exit (point)))
7192 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7194 (setq ind1 ind-empty)
7196 (setq ind1 (current-column)))
7197 (if (<= ind1 ind)
7198 (throw 'exit (point-at-bol)))))))
7199 (if end
7200 (goto-char end)
7201 (goto-char pos)
7202 (error "Not in an item"))))
7204 (defun org-next-item ()
7205 "Move to the beginning of the next item in the current plain list.
7206 Error if not at a plain list, or if this is the last item in the list."
7207 (interactive)
7208 (let (ind ind1 (pos (point)))
7209 (org-beginning-of-item)
7210 (setq ind (org-get-indentation))
7211 (org-end-of-item)
7212 (setq ind1 (org-get-indentation))
7213 (unless (and (org-at-item-p) (= ind ind1))
7214 (goto-char pos)
7215 (error "On last item"))))
7217 (defun org-previous-item ()
7218 "Move to the beginning of the previous item in the current plain list.
7219 Error if not at a plain list, or if this is the first item in the list."
7220 (interactive)
7221 (let (beg ind ind1 (pos (point)))
7222 (org-beginning-of-item)
7223 (setq beg (point))
7224 (setq ind (org-get-indentation))
7225 (goto-char beg)
7226 (catch 'exit
7227 (while t
7228 (beginning-of-line 0)
7230 nil
7231 (if (<= (setq ind1 (org-get-indentation)) ind)
7232 (throw 'exit t)))))
7233 (condition-case nil
7234 (if (or (not (org-at-item-p))
7235 (< ind1 (1- ind)))
7236 (error "")
7237 (org-beginning-of-item))
7238 (error (goto-char pos)
7239 (error "On first item")))))
7241 (defun org-first-list-item-p ()
7242 "Is this heading the item in a plain list?"
7243 (unless (org-at-item-p)
7244 (error "Not at a plain list item"))
7245 (org-beginning-of-item)
7246 (= (point) (save-excursion (org-beginning-of-item-list))))
7248 (defun org-move-item-down ()
7249 "Move the plain list item at point down, i.e. swap with following item.
7250 Subitems (items with larger indentation) are considered part of the item,
7251 so this really moves item trees."
7252 (interactive)
7253 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7254 (org-beginning-of-item)
7255 (setq beg0 (point))
7256 (save-excursion
7257 (setq ne-beg (org-back-over-empty-lines))
7258 (setq beg (point)))
7259 (goto-char beg0)
7260 (setq ind (org-get-indentation))
7261 (org-end-of-item)
7262 (setq end0 (point))
7263 (setq ind1 (org-get-indentation))
7264 (setq ne-end (org-back-over-empty-lines))
7265 (setq end (point))
7266 (goto-char beg0)
7267 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7268 ;; include less whitespace
7269 (save-excursion
7270 (goto-char beg)
7271 (forward-line (- ne-beg ne-end))
7272 (setq beg (point))))
7273 (goto-char end0)
7274 (if (and (org-at-item-p) (= ind ind1))
7275 (progn
7276 (org-end-of-item)
7277 (org-back-over-empty-lines)
7278 (setq txt (buffer-substring beg end))
7279 (save-excursion
7280 (delete-region beg end))
7281 (setq pos (point))
7282 (insert txt)
7283 (goto-char pos) (org-skip-whitespace)
7284 (org-maybe-renumber-ordered-list))
7285 (goto-char pos)
7286 (error "Cannot move this item further down"))))
7288 (defun org-move-item-up (arg)
7289 "Move the plain list item at point up, i.e. swap with previous item.
7290 Subitems (items with larger indentation) are considered part of the item,
7291 so this really moves item trees."
7292 (interactive "p")
7293 (let (beg beg0 end end0 ind ind1 (pos (point)) txt
7294 ne-beg ne-end ne-ins ins-end)
7295 (org-beginning-of-item)
7296 (setq beg0 (point))
7297 (setq ind (org-get-indentation))
7298 (save-excursion
7299 (setq ne-beg (org-back-over-empty-lines))
7300 (setq beg (point)))
7301 (goto-char beg0)
7302 (org-end-of-item)
7303 (setq ne-end (org-back-over-empty-lines))
7304 (setq end (point))
7305 (goto-char beg0)
7306 (catch 'exit
7307 (while t
7308 (beginning-of-line 0)
7310 (if org-empty-line-terminates-plain-lists
7311 (progn
7312 (goto-char pos)
7313 (error "Cannot move this item further up"))
7314 nil)
7315 (if (<= (setq ind1 (org-get-indentation)) ind)
7316 (throw 'exit t)))))
7317 (condition-case nil
7318 (org-beginning-of-item)
7319 (error (goto-char beg)
7320 (error "Cannot move this item further up")))
7321 (setq ind1 (org-get-indentation))
7322 (if (and (org-at-item-p) (= ind ind1))
7323 (progn
7324 (setq ne-ins (org-back-over-empty-lines))
7325 (setq txt (buffer-substring beg end))
7326 (save-excursion
7327 (delete-region beg end))
7328 (setq pos (point))
7329 (insert txt)
7330 (setq ins-end (point))
7331 (goto-char pos) (org-skip-whitespace)
7333 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7334 ;; Move whitespace back to beginning
7335 (save-excursion
7336 (goto-char ins-end)
7337 (let ((kill-whole-line t))
7338 (kill-line (- ne-ins ne-beg)) (point)))
7341 (org-maybe-renumber-ordered-list))
7342 (goto-char pos)
7343 (error "Cannot move this item further up"))))
7345 (defun org-maybe-renumber-ordered-list ()
7346 "Renumber the ordered list at point if setup allows it.
7347 This tests the user option `org-auto-renumber-ordered-lists' before
7348 doing the renumbering."
7349 (interactive)
7350 (when (and org-auto-renumber-ordered-lists
7351 (org-at-item-p))
7352 (if (match-beginning 3)
7353 (org-renumber-ordered-list 1)
7354 (org-fix-bullet-type))))
7356 (defun org-maybe-renumber-ordered-list-safe ()
7357 (condition-case nil
7358 (save-excursion
7359 (org-maybe-renumber-ordered-list))
7360 (error nil)))
7362 (defun org-cycle-list-bullet (&optional which)
7363 "Cycle through the different itemize/enumerate bullets.
7364 This cycle the entire list level through the sequence:
7366 `-' -> `+' -> `*' -> `1.' -> `1)'
7368 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7369 0 meand `-', 1 means `+' etc."
7370 (interactive "P")
7371 (org-preserve-lc
7372 (org-beginning-of-item-list)
7373 (org-at-item-p)
7374 (beginning-of-line 1)
7375 (let ((current (match-string 0))
7376 (prevp (eq which 'previous))
7377 new)
7378 (setq new (cond
7379 ((and (numberp which)
7380 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7381 ((string-match "-" current) (if prevp "1)" "+"))
7386 ((string-match ")" current) (if prevp "1." "-"))
7387 (t (error "This should not happen"))))
7389 (org-fix-bullet-type)
7390 (org-maybe-renumber-ordered-list))))
7392 (defun org-get-string-indentation (s)
7393 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7394 (let ((n -1) (i 0) (w tab-width) c)
7395 (catch 'exit
7396 (while (< (setq n (1+ n)) (length s))
7397 (setq c (aref s n))
7398 (cond ((= c ?\ ) (setq i (1+ i)))
7400 (t (throw 'exit t)))))
7401 i))
7403 (defun org-renumber-ordered-list (arg)
7404 "Renumber an ordered plain list.
7405 Cursor needs to be in the first line of an item, the line that starts
7407 (interactive "p")
7408 (unless (and (org-at-item-p)
7409 (match-beginning 3))
7410 (error "This is not an ordered list"))
7411 (let ((line (org-current-line))
7412 (col (current-column))
7413 (ind (org-get-string-indentation
7414 (buffer-substring (point-at-bol) (match-beginning 3))))
7415 ;; (term (substring (match-string 3) -1))
7416 ind1 (n (1- arg))
7417 fmt)
7418 ;; find where this list begins
7419 (org-beginning-of-item-list)
7421 (setq fmt (concat "%d" (match-string 1)))
7422 (beginning-of-line 0)
7423 ;; walk forward and replace these numbers
7424 (catch 'exit
7425 (while t
7426 (catch 'next
7427 (beginning-of-line 2)
7428 (if (eobp) (throw 'exit nil))
7431 (if (> ind1 ind) (throw 'next t))
7432 (if (< ind1 ind) (throw 'exit t))
7433 (if (not (org-at-item-p)) (throw 'exit nil))
7434 (delete-region (match-beginning 2) (match-end 2))
7435 (goto-char (match-beginning 2))
7436 (insert (format fmt (setq n (1+ n)))))))
7437 (goto-line line)
7438 (move-to-column col)))
7440 (defun org-fix-bullet-type ()
7441 "Make sure all items in this list have the same bullet as the firsst item."
7442 (interactive)
7443 (unless (org-at-item-p) (error "This is not a list"))
7444 (let ((line (org-current-line))
7445 (col (current-column))
7446 (ind (current-indentation))
7447 ind1 bullet)
7448 ;; find where this list begins
7449 (org-beginning-of-item-list)
7450 (beginning-of-line 1)
7451 ;; find out what the bullet type is
7453 (setq bullet (match-string 1))
7454 ;; walk forward and replace these numbers
7455 (beginning-of-line 0)
7456 (catch 'exit
7457 (while t
7458 (catch 'next
7459 (beginning-of-line 2)
7460 (if (eobp) (throw 'exit nil))
7463 (if (> ind1 ind) (throw 'next t))
7464 (if (< ind1 ind) (throw 'exit t))
7465 (if (not (org-at-item-p)) (throw 'exit nil))
7468 (replace-match bullet))))
7469 (goto-line line)
7470 (move-to-column col)
7471 (if (string-match "[0-9]" bullet)
7472 (org-renumber-ordered-list 1))))
7474 (defun org-beginning-of-item-list ()
7475 "Go to the beginning of the current item list.
7476 I.e. to the first item in this list."
7477 (interactive)
7478 (org-beginning-of-item)
7479 (let ((pos (point-at-bol))
7480 (ind (org-get-indentation))
7481 ind1)
7482 ;; find where this list begins
7483 (catch 'exit
7484 (while t
7485 (catch 'next
7486 (beginning-of-line 0)
7488 (throw (if (bobp) 'exit 'next) t))
7490 (if (or (< ind1 ind)
7491 (and (= ind1 ind)
7492 (not (org-at-item-p)))
7493 (bobp))
7494 (throw 'exit t)
7495 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7496 (goto-char pos)))
7499 (defun org-end-of-item-list ()
7500 "Go to the end of the current item list.
7501 I.e. to the text after the last item."
7502 (interactive)
7503 (org-beginning-of-item)
7504 (let ((pos (point-at-bol))
7505 (ind (org-get-indentation))
7506 ind1)
7507 ;; find where this list begins
7508 (catch 'exit
7509 (while t
7510 (catch 'next
7511 (beginning-of-line 2)
7513 (throw (if (eobp) 'exit 'next) t))
7515 (if (or (< ind1 ind)
7516 (and (= ind1 ind)
7517 (not (org-at-item-p)))
7518 (eobp))
7519 (progn
7520 (setq pos (point-at-bol))
7521 (throw 'exit t))))))
7522 (goto-char pos)))
7525 (defvar org-last-indent-begin-marker (make-marker))
7526 (defvar org-last-indent-end-marker (make-marker))
7528 (defun org-outdent-item (arg)
7529 "Outdent a local list item."
7530 (interactive "p")
7531 (org-indent-item (- arg)))
7533 (defun org-indent-item (arg)
7534 "Indent a local list item."
7535 (interactive "p")
7536 (unless (org-at-item-p)
7537 (error "Not on an item"))
7538 (save-excursion
7539 (let (beg end ind ind1 tmp delta ind-down ind-up)
7540 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7541 (setq beg org-last-indent-begin-marker
7542 end org-last-indent-end-marker)
7543 (org-beginning-of-item)
7544 (setq beg (move-marker org-last-indent-begin-marker (point)))
7545 (org-end-of-item)
7546 (setq end (move-marker org-last-indent-end-marker (point))))
7547 (goto-char beg)
7548 (setq tmp (org-item-indent-positions)
7549 ind (car tmp)
7550 ind-down (nth 2 tmp)
7551 ind-up (nth 1 tmp)
7552 delta (if (> arg 0)
7553 (if ind-down (- ind-down ind) 2)
7554 (if ind-up (- ind-up ind) -2)))
7555 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7556 (while (< (point) end)
7557 (beginning-of-line 1)
7559 (delete-region (point-at-bol) (point))
7560 (or (eolp) (indent-to-column (+ ind1 delta)))
7561 (beginning-of-line 2))))
7562 (org-fix-bullet-type)
7563 (org-maybe-renumber-ordered-list-safe)
7564 (save-excursion
7565 (beginning-of-line 0)
7566 (condition-case nil (org-beginning-of-item) (error nil))
7567 (org-maybe-renumber-ordered-list-safe)))
7569 (defun org-item-indent-positions ()
7570 "Return indentation for plain list items.
7571 This returns a list with three values: The current indentation, the
7572 parent indentation and the indentation a child should habe.
7573 Assumes cursor in item line."
7574 (let* ((bolpos (point-at-bol))
7575 (ind (org-get-indentation))
7576 ind-down ind-up pos)
7577 (save-excursion
7578 (org-beginning-of-item-list)
7580 (when (org-in-item-p)
7581 (org-beginning-of-item)
7582 (setq ind-up (org-get-indentation))))
7583 (setq pos (point))
7584 (save-excursion
7585 (cond
7586 ((and (condition-case nil (progn (org-previous-item) t)
7587 (error nil))
7588 (or (forward-char 1) t)
7589 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7590 (setq ind-down (org-get-indentation)))
7591 ((and (goto-char pos)
7592 (org-at-item-p))
7593 (goto-char (match-end 0))
7595 (setq ind-down (current-column)))))
7596 (list ind ind-up ind-down)))
7598 ;;; The orgstruct minor mode
7600 ;; Define a minor mode which can be used in other modes in order to
7601 ;; integrate the org-mode structure editing commands.
7603 ;; This is really a hack, because the org-mode structure commands use
7604 ;; keys which normally belong to the major mode. Here is how it
7605 ;; works: The minor mode defines all the keys necessary to operate the
7606 ;; structure commands, but wraps the commands into a function which
7607 ;; tests if the cursor is currently at a headline or a plain list
7608 ;; item. If that is the case, the structure command is used,
7609 ;; temporarily setting many Org-mode variables like regular
7610 ;; expressions for filling etc. However, when any of those keys is
7611 ;; used at a different location, function uses `key-binding' to look
7612 ;; up if the key has an associated command in another currently active
7613 ;; keymap (minor modes, major mode, global), and executes that
7614 ;; command. There might be problems if any of the keys is otherwise
7615 ;; used as a prefix key.
7617 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7618 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7619 ;; addresses this by checking explicitly for both bindings.
7621 (defvar orgstruct-mode-map (make-sparse-keymap)
7622 "Keymap for the minor `orgstruct-mode'.")
7624 (defvar org-local-vars nil
7625 "List of local variables, for use by `orgstruct-mode'")
7627 ;;;###autoload
7628 (define-minor-mode orgstruct-mode
7629 "Toggle the minor more `orgstruct-mode'.
7630 This mode is for using Org-mode structure commands in other modes.
7631 The following key behave as if Org-mode was active, if the cursor
7632 is on a headline, or on a plain list item (both in the definition
7633 of Org-mode).
7635 M-up Move entry/item up
7636 M-down Move entry/item down
7637 M-left Promote
7638 M-right Demote
7639 M-S-up Move entry/item up
7640 M-S-down Move entry/item down
7641 M-S-left Promote subtree
7642 M-S-right Demote subtree
7643 M-q Fill paragraph and items like in Org-mode
7644 C-c ^ Sort entries
7645 C-c - Cycle list bullet
7646 TAB Cycle item visibility
7647 M-RET Insert new heading/item
7648 S-M-RET Insert new TODO heading / Chekbox item
7649 C-c C-c Set tags / toggle checkbox"
7650 nil " OrgStruct" nil
7651 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7653 ;;;###autoload
7654 (defun turn-on-orgstruct ()
7655 "Unconditionally turn on `orgstruct-mode'."
7656 (orgstruct-mode 1))
7658 ;;;###autoload
7659 (defun turn-on-orgstruct++ ()
7660 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7661 In addition to setting orgstruct-mode, this also exports all indentation and
7662 autofilling variables from org-mode into the buffer. Note that turning
7663 off orgstruct-mode will *not* remove these additional settings."
7664 (orgstruct-mode 1)
7665 (let (var val)
7666 (mapc
7667 (lambda (x)
7668 (when (string-match
7670 (symbol-name (car x)))
7671 (setq var (car x) val (nth 1 x))
7672 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7673 org-local-vars)))
7675 (defun orgstruct-error ()
7676 "Error when there is no default binding for a structure key."
7677 (interactive)
7678 (error "This key has no function outside structure elements"))
7680 (defun orgstruct-setup ()
7681 "Setup orgstruct keymaps."
7682 (let ((nfunc 0)
7683 (bindings
7684 (list
7685 '([(meta up)] org-metaup)
7686 '([(meta down)] org-metadown)
7687 '([(meta left)] org-metaleft)
7688 '([(meta right)] org-metaright)
7689 '([(meta shift up)] org-shiftmetaup)
7690 '([(meta shift down)] org-shiftmetadown)
7691 '([(meta shift left)] org-shiftmetaleft)
7692 '([(meta shift right)] org-shiftmetaright)
7693 '([(shift up)] org-shiftup)
7694 '([(shift down)] org-shiftdown)
7695 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7696 '("\M-q" fill-paragraph)
7697 '("\C-c^" org-sort)
7698 '("\C-c-" org-cycle-list-bullet)))
7699 elt key fun cmd)
7700 (while (setq elt (pop bindings))
7701 (setq nfunc (1+ nfunc))
7702 (setq key (org-key (car elt))
7703 fun (nth 1 elt)
7704 cmd (orgstruct-make-binding fun nfunc key))
7705 (org-defkey orgstruct-mode-map key cmd))
7707 ;; Special treatment needed for TAB and RET
7708 (org-defkey orgstruct-mode-map [(tab)]
7709 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7710 (org-defkey orgstruct-mode-map "\C-i"
7711 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7713 (org-defkey orgstruct-mode-map "\M-\C-m"
7714 (orgstruct-make-binding 'org-insert-heading 105
7715 "\M-\C-m" [(meta return)]))
7716 (org-defkey orgstruct-mode-map [(meta return)]
7717 (orgstruct-make-binding 'org-insert-heading 106
7718 [(meta return)] "\M-\C-m"))
7720 (org-defkey orgstruct-mode-map [(shift meta return)]
7721 (orgstruct-make-binding 'org-insert-todo-heading 107
7722 [(meta return)] "\M-\C-m"))
7724 (unless org-local-vars
7725 (setq org-local-vars (org-get-local-variables)))
7727 t))
7729 (defun orgstruct-make-binding (fun n &rest keys)
7730 "Create a function for binding in the structure minor mode.
7731 FUN is the command to call inside a table. N is used to create a unique
7732 command name. KEYS are keys that should be checked in for a command
7733 to execute outside of tables."
7734 (eval
7735 (list 'defun
7736 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7737 '(arg)
7739 "Outside of structure, run the binding of `"
7740 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7741 "'.")
7742 '(interactive "p")
7743 (list 'if
7744 '(org-context-p 'headline 'item)
7745 (list 'org-run-like-in-org-mode (list 'quote fun))
7746 (list 'let '(orgstruct-mode)
7747 (list 'call-interactively
7748 (append '(or)
7749 (mapcar (lambda (k)
7750 (list 'key-binding k))
7751 keys)
7752 '('orgstruct-error))))))))
7754 (defun org-context-p (&rest contexts)
7755 "Check if local context is and of CONTEXTS.
7756 Possible values in the list of contexts are `table', `headline', and `item'."
7757 (let ((pos (point)))
7758 (goto-char (point-at-bol))
7759 (prog1 (or (and (memq 'table contexts)
7761 (and (memq 'headline contexts)
7763 (and (memq 'item contexts)
7765 (goto-char pos))))
7767 (defun org-get-local-variables ()
7768 "Return a list of all local variables in an org-mode buffer."
7769 (let (varlist)
7770 (with-current-buffer (get-buffer-create "*Org tmp*")
7771 (erase-buffer)
7772 (org-mode)
7773 (setq varlist (buffer-local-variables)))
7774 (kill-buffer "*Org tmp*")
7775 (delq nil
7776 (mapcar
7777 (lambda (x)
7778 (setq x
7779 (if (symbolp x)
7780 (list x)
7781 (list (car x) (list 'quote (cdr x)))))
7782 (if (string-match
7783 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7784 (symbol-name (car x)))
7785 x nil))
7786 varlist))))
7788 ;;;###autoload
7789 (defun org-run-like-in-org-mode (cmd)
7790 (unless org-local-vars
7791 (setq org-local-vars (org-get-local-variables)))
7792 (eval (list 'let org-local-vars
7793 (list 'call-interactively (list 'quote cmd)))))
7795 ;;;; Archiving
7797 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7799 (defun org-archive-subtree (&optional find-done)
7800 "Move the current subtree to the archive.
7801 The archive can be a certain top-level heading in the current file, or in
7802 a different file. The tree will be moved to that location, the subtree
7803 heading be marked DONE, and the current time will be added.
7805 When called with prefix argument FIND-DONE, find whole trees without any
7806 open TODO items and archive them (after getting confirmation from the user).
7807 If the cursor is not at a headline when this comand is called, try all level
7808 1 trees. If the cursor is on a headline, only try the direct children of
7809 this heading."
7810 (interactive "P")
7811 (if find-done
7812 (org-archive-all-done)
7813 ;; Save all relevant TODO keyword-relatex variables
7815 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7816 (tr-org-todo-keywords-1 org-todo-keywords-1)
7817 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7818 (tr-org-done-keywords org-done-keywords)
7819 (tr-org-todo-regexp org-todo-regexp)
7820 (tr-org-todo-line-regexp org-todo-line-regexp)
7821 (tr-org-odd-levels-only org-odd-levels-only)
7822 (this-buffer (current-buffer))
7823 (org-archive-location org-archive-location)
7825 ;; start of variables that will be used for saving context
7826 ;; The compiler complains about them - keep them anyway!
7827 (file (abbreviate-file-name (buffer-file-name)))
7828 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7829 (time (format-time-string
7830 (substring (cdr org-time-stamp-formats) 1 -1)
7831 (current-time)))
7832 afile heading buffer level newfile-p
7833 category todo priority
7834 ;; start of variables that will be used for savind context
7835 ltags itags prop)
7837 ;; Try to find a local archive location
7838 (save-excursion
7839 (save-restriction
7840 (widen)
7841 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7843 (setq org-archive-location prop)
7844 (if (or (re-search-backward re nil t)
7845 (re-search-forward re nil t))
7846 (setq org-archive-location (match-string 1))))))
7849 (progn
7850 (setq afile (format (match-string 1 org-archive-location)
7851 (file-name-nondirectory buffer-file-name))
7852 heading (match-string 2 org-archive-location)))
7853 (error "Invalid `org-archive-location'"))
7854 (if (> (length afile) 0)
7855 (setq newfile-p (not (file-exists-p afile))
7856 buffer (find-file-noselect afile))
7857 (setq buffer (current-buffer)))
7858 (unless buffer
7860 (if (and (> (length heading) 0)
7862 (setq level (match-end 0))
7863 (setq heading nil level 0))
7864 (save-excursion
7865 (org-back-to-heading t)
7866 ;; Get context information that will be lost by moving the tree
7867 (org-refresh-category-properties)
7868 (setq category (org-get-category)
7869 todo (and (looking-at org-todo-line-regexp)
7870 (match-string 2))
7871 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7872 ltags (org-get-tags)
7873 itags (org-delete-all ltags (org-get-tags-at)))
7874 (setq ltags (mapconcat 'identity ltags " ")
7875 itags (mapconcat 'identity itags " "))
7876 ;; We first only copy, in case something goes wrong
7877 ;; we need to protect this-command, to avoid kill-region sets it,
7878 ;; which would lead to duplication of subtrees
7879 (let (this-command) (org-copy-subtree))
7880 (set-buffer buffer)
7881 ;; Enforce org-mode for the archive buffer
7882 (if (not (org-mode-p))
7883 ;; Force the mode for future visits.
7884 (let ((org-insert-mode-line-in-empty-file t)
7885 (org-inhibit-startup t))
7886 (call-interactively 'org-mode)))
7887 (when newfile-p
7888 (goto-char (point-max))
7890 (buffer-file-name this-buffer))))
7891 ;; Force the TODO keywords of the original buffer
7892 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7893 (org-todo-keywords-1 tr-org-todo-keywords-1)
7894 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7895 (org-done-keywords tr-org-done-keywords)
7896 (org-todo-regexp tr-org-todo-regexp)
7897 (org-todo-line-regexp tr-org-todo-line-regexp)
7898 (org-odd-levels-only
7899 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7900 org-odd-levels-only
7901 tr-org-odd-levels-only)))
7902 (goto-char (point-min))
7903 (if heading
7904 (progn
7905 (if (re-search-forward
7906 (concat "^" (regexp-quote heading)
7908 nil t)
7909 (goto-char (match-end 0))
7910 ;; Heading not found, just insert it at the end
7911 (goto-char (point-max))
7914 (end-of-line 0))
7915 ;; Make the subtree visible
7916 (show-subtree)
7917 (org-end-of-subtree t)
7921 ;; No specific heading, just go to end of file.
7923 ;; Paste
7924 (org-paste-subtree (org-get-legal-level level 1))
7926 ;; Mark the entry as done
7927 (when (and org-archive-mark-done
7928 (looking-at org-todo-line-regexp)
7929 (or (not (match-end 2))
7930 (not (member (match-string 2) org-done-keywords))))
7931 (let (org-log-done)
7932 (org-todo
7933 (car (or (member org-archive-mark-done org-done-keywords)
7934 org-done-keywords)))))
7936 ;; Add the context info
7937 (when org-archive-save-context-info
7938 (let ((l org-archive-save-context-info) e n v)
7939 (while (setq e (pop l))
7940 (when (and (setq v (symbol-value e))
7942 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7943 (org-entry-put (point) n v)))))
7945 ;; Save the buffer, if it is not the same buffer.
7946 (if (not (eq this-buffer buffer)) (save-buffer))))
7947 ;; Here we are back in the original buffer. Everything seems to have
7948 ;; worked. So now cut the tree and finish up.
7949 (let (this-command) (org-cut-subtree))
7951 (message "Subtree archived %s"
7952 (if (eq this-buffer buffer)
7953 (concat "under heading: " heading)
7954 (concat "in file: " (abbreviate-file-name afile)))))))
7956 (defun org-refresh-category-properties ()
7957 "Refresh category text properties in teh buffer."
7958 (let ((def-cat (cond
7959 ((null org-category)
7960 (if buffer-file-name
7961 (file-name-sans-extension
7962 (file-name-nondirectory buffer-file-name))
7963 "???"))
7964 ((symbolp org-category) (symbol-name org-category))
7965 (t org-category)))
7966 beg end cat pos optionp)
7967 (org-unmodified
7968 (save-excursion
7969 (save-restriction
7970 (widen)
7971 (goto-char (point-min))
7972 (put-text-property (point) (point-max) 'org-category def-cat)
7973 (while (re-search-forward
7975 (setq pos (match-end 0)
7976 optionp (equal (char-after (match-beginning 0)) ?#)
7977 cat (org-trim (match-string 2)))
7978 (if optionp
7979 (setq beg (point-at-bol) end (point-max))
7980 (org-back-to-heading t)
7981 (setq beg (point) end (org-end-of-subtree t t)))
7982 (put-text-property beg end 'org-category cat)
7983 (goto-char pos)))))))
7985 (defun org-archive-all-done (&optional tag)
7986 "Archive sublevels of the current tree without open TODO items.
7987 If the cursor is not on a headline, try all level 1 trees. If
7988 it is on a headline, try all direct children.
7989 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7991 (rea (concat ".*:" org-archive-tag ":"))
7992 (begm (make-marker))
7993 (endm (make-marker))
7994 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7995 "Move subtree to archive (no open TODO items)? "))
7996 beg end (cntarch 0))
7997 (if (org-on-heading-p)
7998 (progn
7999 (setq re1 (concat "^" (regexp-quote
8000 (make-string
8001 (1+ (- (match-end 0) (match-beginning 0) 1))
8002 ?*))
8003 " "))
8004 (move-marker begm (point))
8005 (move-marker endm (org-end-of-subtree t)))
8006 (setq re1 "^* ")
8007 (move-marker begm (point-min))
8008 (move-marker endm (point-max)))
8009 (save-excursion
8010 (goto-char begm)
8011 (while (re-search-forward re1 endm t)
8012 (setq beg (match-beginning 0)
8013 end (save-excursion (org-end-of-subtree t) (point)))
8014 (goto-char beg)
8015 (if (re-search-forward re end t)
8016 (goto-char end)
8017 (goto-char beg)
8018 (if (and (or (not tag) (not (looking-at rea)))
8019 (y-or-n-p question))
8020 (progn
8021 (if tag
8022 (org-toggle-tag org-archive-tag 'on)
8023 (org-archive-subtree))
8024 (setq cntarch (1+ cntarch)))
8025 (goto-char end)))))
8026 (message "%d trees archived" cntarch)))
8028 (defun org-cycle-hide-drawers (state)
8029 "Re-hide all drawers after a visibility state change."
8030 (when (and (org-mode-p)
8031 (not (memq state '(overview folded))))
8032 (save-excursion
8033 (let* ((globalp (memq state '(contents all)))
8034 (beg (if globalp (point-min) (point)))
8035 (end (if globalp (point-max) (org-end-of-subtree t))))
8036 (goto-char beg)
8037 (while (re-search-forward org-drawer-regexp end t)
8038 (org-flag-drawer t))))))
8040 (defun org-flag-drawer (flag)
8041 (save-excursion
8042 (beginning-of-line 1)
8044 (let ((b (match-end 0))
8045 (outline-regexp org-outline-regexp))
8046 (if (re-search-forward
8048 (save-excursion (outline-next-heading) (point)) t)
8049 (outline-flag-region b (point-at-eol) flag)
8050 (error ":END: line missing"))))))
8052 (defun org-cycle-hide-archived-subtrees (state)
8053 "Re-hide all archived subtrees after a visibility state change."
8054 (when (and (not org-cycle-open-archived-trees)
8055 (not (memq state '(overview folded))))
8056 (save-excursion
8057 (let* ((globalp (memq state '(contents all)))
8058 (beg (if globalp (point-min) (point)))
8059 (end (if globalp (point-max) (org-end-of-subtree t))))
8060 (org-hide-archived-subtrees beg end)
8061 (goto-char beg)
8062 (if (looking-at (concat ".*:" org-archive-tag ":"))
8063 (message "%s" (substitute-command-keys
8064 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8066 (defun org-force-cycle-archived ()
8067 "Cycle subtree even if it is archived."
8068 (interactive)
8069 (setq this-command 'org-cycle)
8070 (let ((org-cycle-open-archived-trees t))
8071 (call-interactively 'org-cycle)))
8073 (defun org-hide-archived-subtrees (beg end)
8074 "Re-hide all archived subtrees after a visibility state change."
8075 (save-excursion
8076 (let* ((re (concat ":" org-archive-tag ":")))
8077 (goto-char beg)
8078 (while (re-search-forward re end t)
8079 (and (org-on-heading-p) (hide-subtree))
8080 (org-end-of-subtree t)))))
8082 (defun org-toggle-tag (tag &optional onoff)
8083 "Toggle the tag TAG for the current line.
8084 If ONOFF is `on' or `off', don't toggle but set to this state."
8085 (unless (org-on-heading-p t) (error "Not on headling"))
8086 (let (res current)
8087 (save-excursion
8088 (beginning-of-line)
8090 (point-at-eol) t)
8091 (progn
8092 (setq current (match-string 1))
8093 (replace-match ""))
8094 (setq current ""))
8095 (setq current (nreverse (org-split-string current ":")))
8096 (cond
8097 ((eq onoff 'on)
8098 (setq res t)
8099 (or (member tag current) (push tag current)))
8100 ((eq onoff 'off)
8101 (or (not (member tag current)) (setq current (delete tag current))))
8102 (t (if (member tag current)
8103 (setq current (delete tag current))
8104 (setq res t)
8105 (push tag current))))
8106 (end-of-line 1)
8107 (if current
8108 (progn
8109 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8110 (org-set-tags nil t))
8111 (delete-horizontal-space))
8112 (run-hooks 'org-after-tags-change-hook))
8113 res))
8115 (defun org-toggle-archive-tag (&optional arg)
8116 "Toggle the archive tag for the current headline.
8117 With prefix ARG, check all children of current headline and offer tagging
8118 the children that do not contain any open TODO items."
8119 (interactive "P")
8120 (if arg
8121 (org-archive-all-done 'tag)
8122 (let (set)
8123 (save-excursion
8124 (org-back-to-heading t)
8125 (setq set (org-toggle-tag org-archive-tag))
8126 (when set (hide-subtree)))
8127 (and set (beginning-of-line 1))
8128 (message "Subtree %s" (if set "archived" "unarchived")))))
8131 ;;;; Tables
8133 ;;; The table editor
8135 ;; Watch out: Here we are talking about two different kind of tables.
8136 ;; Most of the code is for the tables created with the Org-mode table editor.
8137 ;; Sometimes, we talk about tables created and edited with the table.el
8138 ;; Emacs package. We call the former org-type tables, and the latter
8139 ;; table.el-type tables.
8141 (defun org-before-change-function (beg end)
8142 "Every change indicates that a table might need an update."
8143 (setq org-table-may-need-update t))
8146 "Detects an org-type table line.")
8148 "Detects an org-type table line.")
8150 "Detects a table line marked for automatic recalculation.")
8152 "Detects a table line marked for automatic recalculation.")
8154 "Detects a table line marked for automatic recalculation.")
8156 "Detects an org-type table hline.")
8158 "Detects a table-type table hline.")
8160 "Detects an org-type or table-type table.")
8162 "Searching from within a table (any type) this finds the first line
8163 outside the table.")
8165 "Searching from within a table (any type) this finds the first line
8166 outside the table.")
8168 (defvar org-table-last-highlighted-reference nil)
8169 (defvar org-table-formula-history nil)
8171 (defvar org-table-column-names nil
8172 "Alist with column names, derived from the `!' line.")
8173 (defvar org-table-column-name-regexp nil
8174 "Regular expression matching the current column names.")
8175 (defvar org-table-local-parameters nil
8176 "Alist with parameter names, derived from the `$' line.")
8177 (defvar org-table-named-field-locations nil
8178 "Alist with locations of named fields.")
8180 (defvar org-table-current-line-types nil
8181 "Table row types, non-nil only for the duration of a comand.")
8182 (defvar org-table-current-begin-line nil
8183 "Table begin line, non-nil only for the duration of a comand.")
8184 (defvar org-table-current-begin-pos nil
8185 "Table begin position, non-nil only for the duration of a comand.")
8186 (defvar org-table-dlines nil
8187 "Vector of data line line numbers in the current table.")
8188 (defvar org-table-hlines nil
8189 "Vector of hline line numbers in the current table.")
8191 (defconst org-table-range-regexp
8192 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8193 ;; 1 2 3 4 5
8194 "Regular expression for matching ranges in formulas.")
8196 (defconst org-table-range-regexp2
8197 (concat
8201 "Match a range for reference display.")
8203 (defconst org-table-translate-regexp
8205 "Match a reference that needs translation, for reference display.")
8207 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8209 (defun org-table-create-with-table.el ()
8210 "Use the table.el package to insert a new table.
8211 If there is already a table at point, convert between Org-mode tables
8212 and table.el tables."
8213 (interactive)
8214 (require 'table)
8215 (cond
8216 ((org-at-table.el-p)
8217 (if (y-or-n-p "Convert table to Org-mode table? ")
8218 (org-table-convert)))
8219 ((org-at-table-p)
8220 (if (y-or-n-p "Convert table to table.el table? ")
8221 (org-table-convert)))
8222 (t (call-interactively 'table-insert))))
8224 (defun org-table-create-or-convert-from-region (arg)
8225 "Convert region to table, or create an empty table.
8226 If there is an active region, convert it to a table, using the function
8227 `org-table-convert-region'. See the documentation of that function
8228 to learn how the prefix argument is interpreted to determine the field
8229 separator.
8230 If there is no such region, create an empty table with `org-table-create'."
8231 (interactive "P")
8232 (if (org-region-active-p)
8233 (org-table-convert-region (region-beginning) (region-end) arg)
8234 (org-table-create arg)))
8236 (defun org-table-create (&optional size)
8237 "Query for a size and insert a table skeleton.
8239 (interactive "P")
8240 (unless size
8241 (setq size (read-string
8242 (concat "Table size Columns x Rows [e.g. "
8243 org-table-default-size "]: ")
8244 "" nil org-table-default-size)))
8246 (let* ((pos (point))
8247 (indent (make-string (current-column) ?\ ))
8248 (split (org-split-string size " *x *"))
8249 (rows (string-to-number (nth 1 split)))
8250 (columns (string-to-number (car split)))
8251 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8254 (point-at-bol) (point)))
8255 (beginning-of-line 1)
8256 (newline))
8257 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8258 (dotimes (i rows) (insert line))
8259 (goto-char pos)
8260 (if (> rows 1)
8261 ;; Insert a hline after the first row.
8262 (progn
8263 (end-of-line 1)
8265 (goto-char pos)))
8266 (org-table-align)))
8268 (defun org-table-convert-region (beg0 end0 &optional separator)
8269 "Convert region to a table.
8270 The region goes from BEG0 to END0, but these borders will be moved
8271 slightly, to make sure a beginning of line in the first line is included.
8273 SEPARATOR specifies the field separator in the lines. It can have the
8274 following values:
8276 '(4) Use the comma as a field separator
8277 '(16) Use a TAB as field separator
8278 integer When a number, use that many spaces as field separator
8279 nil When nil, the command tries to be smart and figure out the
8280 separator in the following way:
8281 - when each line contains a TAB, assume TAB-separated material
8282 - when each line contains a comme, assume CSV material
8283 - else, assume one or more SPACE charcters as separator."
8284 (interactive "rP")
8285 (let* ((beg (min beg0 end0))
8286 (end (max beg0 end0))
8287 re)
8288 (goto-char beg)
8289 (beginning-of-line 1)
8290 (setq beg (move-marker (make-marker) (point)))
8291 (goto-char end)
8292 (if (bolp) (backward-char 1) (end-of-line 1))
8293 (setq end (move-marker (make-marker) (point)))
8294 ;; Get the right field separator
8295 (unless separator
8296 (goto-char beg)
8297 (setq separator
8298 (cond
8301 (t 1))))
8302 (setq re (cond
8305 ((integerp separator)
8307 (t (error "This should not happen"))))
8308 (goto-char beg)
8309 (while (re-search-forward re end t)
8310 (replace-match "| " t t))
8311 (goto-char beg)
8312 (insert " ")
8313 (org-table-align)))
8315 (defun org-table-import (file arg)
8316 "Import FILE as a table.
8317 The file is assumed to be tab-separated. Such files can be produced by most
8318 spreadsheet and database applications. If no tabs (at least one per line)
8319 are found, lines will be split on whitespace into fields."
8321 (or (bolp) (newline))
8322 (let ((beg (point))
8323 (pm (point-max)))
8324 (insert-file-contents file)
8325 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8327 (defun org-table-export ()
8328 "Export table as a tab-separated file.
8329 Such a file can be imported into a spreadsheet program like Excel."
8330 (interactive)
8331 (let* ((beg (org-table-begin))
8332 (end (org-table-end))
8333 (table (buffer-substring beg end))
8334 (file (read-file-name "Export table to: "))
8335 buf)
8336 (unless (or (not (file-exists-p file))
8337 (y-or-n-p (format "Overwrite file %s? " file)))
8338 (error "Abort"))
8339 (with-current-buffer (find-file-noselect file)
8340 (setq buf (current-buffer))
8341 (erase-buffer)
8342 (fundamental-mode)
8343 (insert table)
8344 (goto-char (point-min))
8346 (replace-match "" t t)
8347 (end-of-line 1))
8348 (goto-char (point-min))
8350 (replace-match "" t t)
8351 (goto-char (min (1+ (point)) (point-max))))
8352 (goto-char (point-min))
8353 (while (re-search-forward "^-[-+]*$" nil t)
8354 (replace-match "")
8356 (delete-char 1)))
8357 (goto-char (point-min))
8360 (save-buffer))
8361 (kill-buffer buf)))
8363 (defvar org-table-aligned-begin-marker (make-marker)
8364 "Marker at the beginning of the table last aligned.
8365 Used to check if cursor still is in that table, to minimize realignment.")
8366 (defvar org-table-aligned-end-marker (make-marker)
8367 "Marker at the end of the table last aligned.
8368 Used to check if cursor still is in that table, to minimize realignment.")
8369 (defvar org-table-last-alignment nil
8370 "List of flags for flushright alignment, from the last re-alignment.
8371 This is being used to correctly align a single field after TAB or RET.")
8372 (defvar org-table-last-column-widths nil
8373 "List of max width of fields in each column.
8374 This is being used to correctly align a single field after TAB or RET.")
8375 (defvar org-table-overlay-coordinates nil
8376 "Overlay coordinates after each align of a table.")
8377 (make-variable-buffer-local 'org-table-overlay-coordinates)
8379 (defvar org-last-recalc-line nil)
8380 (defconst org-narrow-column-arrow "=>"
8381 "Used as display property in narrowed table columns.")
8383 (defun org-table-align ()
8384 "Align the table at point by aligning all vertical bars."
8385 (interactive)
8386 (let* (
8387 ;; Limits of table
8388 (beg (org-table-begin))
8389 (end (org-table-end))
8390 ;; Current cursor position
8391 (linepos (org-current-line))
8392 (colpos (org-table-current-column))
8393 (winstart (window-start))
8394 (winstartline (org-current-line (min winstart (1- (point-max)))))
8395 lines (new "") lengths l typenums ty fields maxfields i
8396 column
8397 (indent "") cnt frac
8398 rfmt hfmt
8399 (spaces '(1 . 1))
8400 (sp1 (car spaces))
8401 (sp2 (cdr spaces))
8402 (rfmt1 (concat
8403 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8404 (hfmt1 (concat
8405 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8406 emptystrings links dates emph narrow fmax f1 len c e)
8407 (untabify beg end)
8408 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8409 ;; Check if we have links or dates
8410 (goto-char beg)
8411 (setq links (re-search-forward org-bracket-link-regexp end t))
8412 (goto-char beg)
8413 (setq emph (and org-hide-emphasis-markers
8414 (re-search-forward org-emph-re end t)))
8415 (goto-char beg)
8416 (setq dates (and org-display-custom-times
8417 (re-search-forward org-ts-regexp-both end t)))
8418 ;; Make sure the link properties are right
8419 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8420 ;; Make sure the date properties are right
8421 (when dates (goto-char beg) (while (org-activate-dates end)))
8422 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8424 ;; Check if we are narrowing any columns
8425 (goto-char beg)
8426 (setq narrow (and org-format-transports-properties-p
8427 (re-search-forward "<[0-9]+>" end t)))
8428 ;; Get the rows
8429 (setq lines (org-split-string
8431 ;; Store the indentation of the first line
8432 (if (string-match "^ *" (car lines))
8433 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8434 ;; Mark the hlines by setting the corresponding element to nil
8435 ;; At the same time, we remove trailing space.
8436 (setq lines (mapcar (lambda (l)
8437 (if (string-match "^ *|-" l)
8438 nil
8440 (substring l 0 (match-beginning 0))
8441 l)))
8442 lines))
8443 ;; Get the data fields by splitting the lines.
8444 (setq fields (mapcar
8445 (lambda (l)
8446 (org-split-string l " *| *"))
8447 (delq nil (copy-sequence lines))))
8448 ;; How many fields in the longest line?
8449 (condition-case nil
8450 (setq maxfields (apply 'max (mapcar 'length fields)))
8451 (error
8452 (kill-region beg end)
8453 (org-table-create org-table-default-size)
8454 (error "Empty table - created default table")))
8455 ;; A list of empty strings to fill any short rows on output
8456 (setq emptystrings (make-list maxfields ""))
8457 ;; Check for special formatting.
8458 (setq i -1)
8459 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8460 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8461 ;; Check if there is an explicit width specified
8462 (when narrow
8463 (setq c column fmax nil)
8464 (while c
8465 (setq e (pop c))
8467 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8468 ;; Find fields that are wider than fmax, and shorten them
8469 (when fmax
8470 (loop for xx in column do
8471 (when (and (stringp xx)
8472 (> (org-string-width xx) fmax))
8473 (org-add-props xx nil
8474 'help-echo
8475 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8476 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8477 (unless (> f1 1)
8479 (match-string 0 xx)))
8480 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8481 (add-text-properties (- f1 2) f1
8482 (list 'display org-narrow-column-arrow)
8483 xx)))))
8484 ;; Get the maximum width for each column
8485 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8486 ;; Get the fraction of numbers, to decide about alignment of the column
8487 (setq cnt 0 frac 0.0)
8488 (loop for x in column do
8489 (if (equal x "")
8490 nil
8491 (setq frac ( / (+ (* frac cnt)
8492 (if (string-match org-table-number-regexp x) 1 0))
8493 (setq cnt (1+ cnt))))))
8494 (push (>= frac org-table-number-fraction) typenums))
8495 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8497 ;; Store the alignment of this table, for later editing of single fields
8498 (setq org-table-last-alignment typenums
8499 org-table-last-column-widths lengths)
8501 ;; With invisible characters, `format' does not get the field width right
8502 ;; So we need to make these fields wide by hand.
8503 (when (or links emph)
8504 (loop for i from 0 upto (1- maxfields) do
8505 (setq len (nth i lengths))
8506 (loop for j from 0 upto (1- (length fields)) do
8507 (setq c (nthcdr i (car (nthcdr j fields))))
8508 (if (and (stringp (car c))
8509 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8510 ; (string-match org-bracket-link-regexp (car c))
8511 (< (org-string-width (car c)) len))
8512 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8514 ;; Compute the formats needed for output of the table
8515 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8516 (while (setq l (pop lengths))
8517 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8518 (setq rfmt (concat rfmt (format rfmt1 ty l))
8519 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8523 (setq new (mapconcat
8524 (lambda (l)
8525 (if l (apply 'format rfmt
8526 (append (pop fields) emptystrings))
8527 hfmt))
8528 lines ""))
8529 ;; Replace the old one
8530 (delete-region beg end)
8531 (move-marker end nil)
8532 (move-marker org-table-aligned-begin-marker (point))
8533 (insert new)
8534 (move-marker org-table-aligned-end-marker (point))
8535 (when (and orgtbl-mode (not (org-mode-p)))
8536 (goto-char org-table-aligned-begin-marker)
8537 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8538 ;; Try to move to the old location
8539 (goto-line winstartline)
8540 (setq winstart (point-at-bol))
8541 (goto-line linepos)
8542 (set-window-start (selected-window) winstart 'noforce)
8543 (org-table-goto-column colpos)
8544 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8545 (setq org-table-may-need-update nil)
8546 ))
8548 (defun org-string-width (s)
8549 "Compute width of string, ignoring invisible characters.
8550 This ignores character with invisibility property `org-link', and also
8551 characters with property `org-cwidth', because these will become invisible
8552 upon the next fontification round."
8553 (let (b l)
8554 (when (or (eq t buffer-invisibility-spec)
8555 (assq 'org-link buffer-invisibility-spec))
8556 (while (setq b (text-property-any 0 (length s)
8557 'invisible 'org-link s))
8558 (setq s (concat (substring s 0 b)
8559 (substring s (or (next-single-property-change
8560 b 'invisible s) (length s)))))))
8561 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8562 (setq s (concat (substring s 0 b)
8563 (substring s (or (next-single-property-change
8564 b 'org-cwidth s) (length s))))))
8565 (setq l (string-width s) b -1)
8566 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8567 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8568 l))
8570 (defun org-table-begin (&optional table-type)
8571 "Find the beginning of the table and return its position.
8572 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8573 (save-excursion
8574 (if (not (re-search-backward
8575 (if table-type org-table-any-border-regexp
8576 org-table-border-regexp)
8577 nil t))
8578 (progn (goto-char (point-min)) (point))
8579 (goto-char (match-beginning 0))
8580 (beginning-of-line 2)
8581 (point))))
8583 (defun org-table-end (&optional table-type)
8584 "Find the end of the table and return its position.
8585 With argument TABLE-TYPE, go to the end of a table.el-type table."
8586 (save-excursion
8587 (if (not (re-search-forward
8588 (if table-type org-table-any-border-regexp
8589 org-table-border-regexp)
8590 nil t))
8591 (goto-char (point-max))
8592 (goto-char (match-beginning 0)))
8593 (point-marker)))
8595 (defun org-table-justify-field-maybe (&optional new)
8596 "Justify the current field, text to left, number to right.
8597 Optional argument NEW may specify text to replace the current field content."
8598 (cond
8599 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8600 ((org-at-table-hline-p))
8601 ((and (not new)
8602 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8603 (current-buffer)))
8604 (< (point) org-table-aligned-begin-marker)
8605 (>= (point) org-table-aligned-end-marker)))
8606 ;; This is not the same table, force a full re-align
8607 (setq org-table-may-need-update t))
8608 (t ;; realign the current field, based on previous full realign
8609 (let* ((pos (point)) s
8610 (col (org-table-current-column))
8611 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8612 l f n o e)
8613 (when (> col 0)
8616 (progn
8617 (setq s (match-string 1)
8618 o (match-string 0)
8619 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8620 e (not (= (match-beginning 2) (match-end 2))))
8621 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8622 l (if e "|" (setq org-table-may-need-update t) ""))
8623 n (format f s))
8624 (if new
8625 (if (<= (length new) l) ;; FIXME: length -> str-width?
8626 (setq n (format f new))
8627 (setq n (concat new "|") org-table-may-need-update t)))
8628 (or (equal n o)
8629 (let (org-table-may-need-update)
8630 (replace-match n t t))))
8631 (setq org-table-may-need-update t))
8632 (goto-char pos))))))
8634 (defun org-table-next-field ()
8635 "Go to the next field in the current table, creating new lines as needed.
8636 Before doing so, re-align the table if necessary."
8637 (interactive)
8638 (org-table-maybe-eval-formula)
8639 (org-table-maybe-recalculate-line)
8640 (if (and org-table-automatic-realign
8641 org-table-may-need-update)
8642 (org-table-align))
8643 (let ((end (org-table-end)))
8644 (if (org-at-table-hline-p)
8645 (end-of-line 1))
8646 (condition-case nil
8647 (progn
8648 (re-search-forward "|" end)
8650 (re-search-forward "|" end))
8651 (if (and (looking-at "-")
8652 org-table-tab-jumps-over-hlines
8654 (goto-char (match-beginning 1)))
8655 (if (looking-at "-")
8656 (progn
8657 (beginning-of-line 0)
8658 (org-table-insert-row 'below))
8659 (if (looking-at " ") (forward-char 1))))
8660 (error
8661 (org-table-insert-row 'below)))))
8663 (defun org-table-previous-field ()
8664 "Go to the previous field in the table.
8665 Before doing so, re-align the table if necessary."
8666 (interactive)
8667 (org-table-justify-field-maybe)
8668 (org-table-maybe-recalculate-line)
8669 (if (and org-table-automatic-realign
8670 org-table-may-need-update)
8671 (org-table-align))
8672 (if (org-at-table-hline-p)
8673 (end-of-line 1))
8674 (re-search-backward "|" (org-table-begin))
8675 (re-search-backward "|" (org-table-begin))
8677 (re-search-backward "|" (org-table-begin)))
8678 (if (looking-at "| ?")
8679 (goto-char (match-end 0))))
8681 (defun org-table-next-row ()
8682 "Go to the next row (same column) in the current table.
8683 Before doing so, re-align the table if necessary."
8684 (interactive)
8685 (org-table-maybe-eval-formula)
8686 (org-table-maybe-recalculate-line)
8689 (newline)
8690 (if (and org-table-automatic-realign
8691 org-table-may-need-update)
8692 (org-table-align))
8693 (let ((col (org-table-current-column)))
8694 (beginning-of-line 2)
8695 (if (or (not (org-at-table-p))
8696 (org-at-table-hline-p))
8697 (progn
8698 (beginning-of-line 0)
8699 (org-table-insert-row 'below)))
8700 (org-table-goto-column col)
8702 (if (looking-at " ") (forward-char 1)))))
8704 (defun org-table-copy-down (n)
8705 "Copy a field down in the current column.
8706 If the field at the cursor is empty, copy into it the content of the nearest
8707 non-empty field above. With argument N, use the Nth non-empty field.
8708 If the current field is not empty, it is copied down to the next row, and
8709 the cursor is moved with it. Therefore, repeating this command causes the
8710 column to be filled row-by-row.
8711 If the variable `org-table-copy-increment' is non-nil and the field is an
8712 integer or a timestamp, it will be incremented while copying. In the case of
8713 a timestamp, if the cursor is on the year, change the year. If it is on the
8714 month or the day, change that. Point will stay on the current date field
8715 in order to easily repeat the interval."
8716 (interactive "p")
8717 (let* ((colpos (org-table-current-column))
8718 (col (current-column))
8719 (field (org-table-get-field))
8721 (beg (org-table-begin))
8722 txt)
8723 (org-table-check-inside-data-field)
8724 (if non-empty
8725 (progn
8726 (setq txt (org-trim field))
8727 (org-table-next-row)
8728 (org-table-blank-field))
8729 (save-excursion
8730 (setq txt
8731 (catch 'exit
8732 (while (progn (beginning-of-line 1)
8733 (re-search-backward org-table-dataline-regexp
8734 beg t))
8735 (org-table-goto-column colpos t)
8736 (if (and (looking-at
8738 (= (setq n (1- n)) 0))
8739 (throw 'exit (match-string 1))))))))
8740 (if txt
8741 (progn
8742 (if (and org-table-copy-increment
8743 (string-match "^[0-9]+$" txt))
8744 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8745 (insert txt)
8746 (move-to-column col)
8747 (if (and org-table-copy-increment (org-at-timestamp-p t))
8748 (org-timestamp-up 1)
8749 (org-table-maybe-recalculate-line))
8750 (org-table-align)
8751 (move-to-column col))
8752 (error "No non-empty field found"))))
8754 (defun org-table-check-inside-data-field ()
8755 "Is point inside a table data field?
8756 I.e. not on a hline or before the first or after the last column?
8757 This actually throws an error, so it aborts the current command."
8758 (if (or (not (org-at-table-p))
8759 (= (org-table-current-column) 0)
8760 (org-at-table-hline-p)
8762 (error "Not in table data field")))
8764 (defvar org-table-clip nil
8765 "Clipboard for table regions.")
8767 (defun org-table-blank-field ()
8768 "Blank the current table field or active region."
8769 (interactive)
8770 (org-table-check-inside-data-field)
8771 (if (and (interactive-p) (org-region-active-p))
8772 (let (org-table-clip)
8773 (org-table-cut-region (region-beginning) (region-end)))
8774 (skip-chars-backward "^|")
8775 (backward-char 1)
8777 (let* ((pos (match-beginning 0))
8778 (match (match-string 0))
8779 (len (org-string-width match)))
8780 (replace-match (concat "|" (make-string (1- len) ?\ )))
8781 (goto-char (+ 2 pos))
8782 (substring match 1)))))
8784 (defun org-table-get-field (&optional n replace)
8785 "Return the value of the field in column N of current row.
8786 N defaults to current field.
8787 If REPLACE is a string, replace field with this value. The return value
8788 is always the old value."
8789 (and n (org-table-goto-column n))
8791 (backward-char 1)
8793 (let* ((pos (match-beginning 0))
8794 (val (buffer-substring (1+ pos) (match-end 0))))
8795 (if replace
8796 (replace-match (concat "|" replace) t t))
8797 (goto-char (min (point-at-eol) (+ 2 pos)))
8798 val)
8799 (forward-char 1) ""))
8801 (defun org-table-field-info (arg)
8802 "Show info about the current field, and highlight any reference at point."
8803 (interactive "P")
8804 (org-table-get-specials)
8805 (save-excursion
8806 (let* ((pos (point))
8807 (col (org-table-current-column))
8808 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8809 (name (car (rassoc (list (org-current-line) col)
8810 org-table-named-field-locations)))
8811 (eql (org-table-get-stored-formulas))
8812 (dline (org-table-current-dline))
8813 (ref (format "@%d$%d" dline col))
8814 (ref1 (org-table-convert-refs-to-an ref))
8815 (fequation (or (assoc name eql) (assoc ref eql)))
8816 (cequation (assoc (int-to-string col) eql))
8817 (eqn (or fequation cequation)))
8818 (goto-char pos)
8819 (condition-case nil
8820 (org-table-show-reference 'local)
8821 (error nil))
8822 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8823 dline col
8824 (if cname (concat " or $" cname) "")
8825 dline col ref1
8826 (if name (concat " or $" name) "")
8827 ;; FIXME: formula info not correct if special table line
8828 (if eqn
8829 (concat ", formula: "
8830 (org-table-formula-to-user
8831 (concat
8832 (if (string-match "^[$@]"(car eqn)) "" "$")
8833 (car eqn) "=" (cdr eqn))))
8834 "")))))
8836 (defun org-table-current-column ()
8837 "Find out which column we are in.
8838 When called interactively, column is also displayed in echo area."
8839 (interactive)
8840 (if (interactive-p) (org-table-check-inside-data-field))
8841 (save-excursion
8842 (let ((cnt 0) (pos (point)))
8843 (beginning-of-line 1)
8844 (while (search-forward "|" pos t)
8845 (setq cnt (1+ cnt)))
8846 (if (interactive-p) (message "This is table column %d" cnt))
8847 cnt)))
8849 (defun org-table-current-dline ()
8850 "Find out what table data line we are in.
8851 Only datalins count for this."
8852 (interactive)
8853 (if (interactive-p) (org-table-check-inside-data-field))
8854 (save-excursion
8855 (let ((cnt 0) (pos (point)))
8856 (goto-char (org-table-begin))
8857 (while (<= (point) pos)
8858 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8859 (beginning-of-line 2))
8860 (if (interactive-p) (message "This is table line %d" cnt))
8861 cnt)))
8863 (defun org-table-goto-column (n &optional on-delim force)
8864 "Move the cursor to the Nth column in the current table line.
8865 With optional argument ON-DELIM, stop with point before the left delimiter
8866 of the field.
8867 If there are less than N fields, just go to after the last delimiter.
8868 However, when FORCE is non-nil, create new columns if necessary."
8869 (interactive "p")
8870 (let ((pos (point-at-eol)))
8871 (beginning-of-line 1)
8872 (when (> n 0)
8873 (while (and (> (setq n (1- n)) -1)
8874 (or (search-forward "|" pos t)
8875 (and force
8876 (progn (end-of-line 1)
8877 (skip-chars-backward "^|")
8878 (insert " | "))))))
8879 ; (backward-char 2) t)))))
8880 (when (and force (not (looking-at ".*|")))
8881 (save-excursion (end-of-line 1) (insert " | ")))
8882 (if on-delim
8883 (backward-char 1)
8884 (if (looking-at " ") (forward-char 1))))))
8886 (defun org-at-table-p (&optional table-type)
8887 "Return t if the cursor is inside an org-type table.
8888 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8889 (if org-enable-table-editor
8890 (save-excursion
8891 (beginning-of-line 1)
8892 (looking-at (if table-type org-table-any-line-regexp
8893 org-table-line-regexp)))
8894 nil))
8896 (defun org-at-table.el-p ()
8897 "Return t if and only if we are at a table.el table."
8898 (and (org-at-table-p 'any)
8899 (save-excursion
8900 (goto-char (org-table-begin 'any))
8901 (looking-at org-table1-hline-regexp))))
8903 (defun org-table-recognize-table.el ()
8904 "If there is a table.el table nearby, recognize it and move into it."
8905 (if org-table-tab-recognizes-table.el
8906 (if (org-at-table.el-p)
8907 (progn
8908 (beginning-of-line 1)
8909 (if (looking-at org-table-dataline-regexp)
8910 nil
8911 (if (looking-at org-table1-hline-regexp)
8912 (progn
8913 (beginning-of-line 2)
8914 (if (looking-at org-table-any-border-regexp)
8915 (beginning-of-line -1)))))
8916 (if (re-search-forward "|" (org-table-end t) t)
8917 (progn
8918 (require 'table)
8919 (if (table--at-cell-p (point))
8920 t
8921 (message "recognizing table.el table...")
8922 (table-recognize-table)
8923 (message "recognizing table.el table...done")))
8924 (error "This should not happen..."))
8925 t)
8926 nil)
8927 nil))
8929 (defun org-at-table-hline-p ()
8930 "Return t if the cursor is inside a hline in a table."
8931 (if org-enable-table-editor
8932 (save-excursion
8933 (beginning-of-line 1)
8934 (looking-at org-table-hline-regexp))
8935 nil))
8937 (defun org-table-insert-column ()
8938 "Insert a new column into the table."
8939 (interactive)
8940 (if (not (org-at-table-p))
8941 (error "Not at a table"))
8942 (org-table-find-dataline)
8943 (let* ((col (max 1 (org-table-current-column)))
8944 (beg (org-table-begin))
8945 (end (org-table-end))
8946 ;; Current cursor position
8947 (linepos (org-current-line))
8948 (colpos col))
8949 (goto-char beg)
8950 (while (< (point) end)
8951 (if (org-at-table-hline-p)
8952 nil
8953 (org-table-goto-column col t)
8954 (insert "| "))
8955 (beginning-of-line 2))
8956 (move-marker end nil)
8957 (goto-line linepos)
8958 (org-table-goto-column colpos)
8959 (org-table-align)
8960 (org-table-fix-formulas "$" nil (1- col) 1)))
8962 (defun org-table-find-dataline ()
8963 "Find a dataline in the current table, which is needed for column commands."
8964 (if (and (org-at-table-p)
8965 (not (org-at-table-hline-p)))
8966 t
8967 (let ((col (current-column))
8968 (end (org-table-end)))
8969 (move-to-column col)
8970 (while (and (< (point) end)
8971 (or (not (= (current-column) col))
8972 (org-at-table-hline-p)))
8973 (beginning-of-line 2)
8974 (move-to-column col))
8975 (if (and (org-at-table-p)
8976 (not (org-at-table-hline-p)))
8977 t
8978 (error
8979 "Please position cursor in a data line for column operations")))))
8981 (defun org-table-delete-column ()
8982 "Delete a column from the table."
8983 (interactive)
8984 (if (not (org-at-table-p))
8985 (error "Not at a table"))
8986 (org-table-find-dataline)
8987 (org-table-check-inside-data-field)
8988 (let* ((col (org-table-current-column))
8989 (beg (org-table-begin))
8990 (end (org-table-end))
8991 ;; Current cursor position
8992 (linepos (org-current-line))
8993 (colpos col))
8994 (goto-char beg)
8995 (while (< (point) end)
8996 (if (org-at-table-hline-p)
8997 nil
8998 (org-table-goto-column col t)
9000 (replace-match "|")))
9001 (beginning-of-line 2))
9002 (move-marker end nil)
9003 (goto-line linepos)
9004 (org-table-goto-column colpos)
9005 (org-table-align)
9006 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9007 col -1 col)))
9009 (defun org-table-move-column-right ()
9010 "Move column to the right."
9011 (interactive)
9012 (org-table-move-column nil))
9013 (defun org-table-move-column-left ()
9014 "Move column to the left."
9015 (interactive)
9016 (org-table-move-column 'left))
9018 (defun org-table-move-column (&optional left)
9019 "Move the current column to the right. With arg LEFT, move to the left."
9020 (interactive "P")
9021 (if (not (org-at-table-p))
9022 (error "Not at a table"))
9023 (org-table-find-dataline)
9024 (org-table-check-inside-data-field)
9025 (let* ((col (org-table-current-column))
9026 (col1 (if left (1- col) col))
9027 (beg (org-table-begin))
9028 (end (org-table-end))
9029 ;; Current cursor position
9030 (linepos (org-current-line))
9031 (colpos (if left (1- col) (1+ col))))
9032 (if (and left (= col 1))
9033 (error "Cannot move column further left"))
9035 (error "Cannot move column further right"))
9036 (goto-char beg)
9037 (while (< (point) end)
9038 (if (org-at-table-hline-p)
9039 nil
9040 (org-table-goto-column col1 t)
9043 (beginning-of-line 2))
9044 (move-marker end nil)
9045 (goto-line linepos)
9046 (org-table-goto-column colpos)
9047 (org-table-align)
9048 (org-table-fix-formulas
9049 "$" (list (cons (number-to-string col) (number-to-string colpos))
9050 (cons (number-to-string colpos) (number-to-string col))))))
9052 (defun org-table-move-row-down ()
9053 "Move table row down."
9054 (interactive)
9055 (org-table-move-row nil))
9056 (defun org-table-move-row-up ()
9057 "Move table row up."
9058 (interactive)
9059 (org-table-move-row 'up))
9061 (defun org-table-move-row (&optional up)
9062 "Move the current table line down. With arg UP, move it up."
9063 (interactive "P")
9064 (let* ((col (current-column))
9065 (pos (point))
9066 (hline1p (save-excursion (beginning-of-line 1)
9067 (looking-at org-table-hline-regexp)))
9068 (dline1 (org-table-current-dline))
9069 (dline2 (+ dline1 (if up -1 1)))
9070 (tonew (if up 0 2))
9071 txt hline2p)
9072 (beginning-of-line tonew)
9073 (unless (org-at-table-p)
9074 (goto-char pos)
9075 (error "Cannot move row further"))
9076 (setq hline2p (looking-at org-table-hline-regexp))
9077 (goto-char pos)
9078 (beginning-of-line 1)
9079 (setq pos (point))
9080 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9081 (delete-region (point) (1+ (point-at-eol)))
9082 (beginning-of-line tonew)
9083 (insert txt)
9084 (beginning-of-line 0)
9085 (move-to-column col)
9086 (unless (or hline1p hline2p)
9087 (org-table-fix-formulas
9088 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9089 (cons (number-to-string dline2) (number-to-string dline1)))))))
9091 (defun org-table-insert-row (&optional arg)
9092 "Insert a new row above the current line into the table.
9093 With prefix ARG, insert below the current line."
9094 (interactive "P")
9095 (if (not (org-at-table-p))
9096 (error "Not at a table"))
9097 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9098 (new (org-table-clean-line line)))
9099 ;; Fix the first field if necessary
9101 (setq new (replace-match (match-string 0 line) t t new)))
9102 (beginning-of-line (if arg 2 1))
9104 (beginning-of-line 0)
9105 (re-search-forward "| ?" (point-at-eol) t)
9106 (and (or org-table-may-need-update org-table-overlay-coordinates)
9107 (org-table-align))
9108 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9110 (defun org-table-insert-hline (&optional above)
9111 "Insert a horizontal-line below the current line into the table.
9112 With prefix ABOVE, insert above the current line."
9113 (interactive "P")
9114 (if (not (org-at-table-p))
9115 (error "Not at a table"))
9116 (let ((line (org-table-clean-line
9117 (buffer-substring (point-at-bol) (point-at-eol))))
9118 (col (current-column)))
9120 (setq line (replace-match
9121 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9122 ?-) "|") t t line)))
9124 (beginning-of-line (if above 1 2))
9126 (beginning-of-line (if above 1 -1))
9127 (move-to-column col)
9128 (and org-table-overlay-coordinates (org-table-align))))
9130 (defun org-table-hline-and-move (&optional same-column)
9131 "Insert a hline and move to the row below that line."
9132 (interactive "P")
9133 (let ((col (org-table-current-column)))
9134 (org-table-maybe-eval-formula)
9135 (org-table-maybe-recalculate-line)
9136 (org-table-insert-hline)
9137 (end-of-line 2)
9140 (org-table-next-field))
9141 (if same-column (org-table-goto-column col))))
9143 (defun org-table-clean-line (s)
9145 In particular, this does handle wide and invisible characters."
9147 ;; It's a hline, just map the characters
9148 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9150 (setq s (replace-match
9151 (concat "|" (make-string (org-string-width (match-string 1 s))
9152 ?\ ) "|")
9153 t t s)))
9154 s))
9156 (defun org-table-kill-row ()
9157 "Delete the current row or horizontal line from the table."
9158 (interactive)
9159 (if (not (org-at-table-p))
9160 (error "Not at a table"))
9161 (let ((col (current-column))
9162 (dline (org-table-current-dline)))
9163 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9164 (if (not (org-at-table-p)) (beginning-of-line 0))
9165 (move-to-column col)
9166 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9167 dline -1 dline)))
9169 (defun org-table-sort-lines (with-case &optional sorting-type)
9170 "Sort table lines according to the column at point.
9172 The position of point indicates the column to be used for
9173 sorting, and the range of lines is the range between the nearest
9174 horizontal separator lines, or the entire table of no such lines
9175 exist. If point is before the first column, you will be prompted
9176 for the sorting column. If there is an active region, the mark
9177 specifies the first line and the sorting column, while point
9178 should be in the last line to be included into the sorting.
9180 The command then prompts for the sorting type which can be
9181 alphabetically, numerically, or by time (as given in a time stamp
9182 in the field). Sorting in reverse order is also possible.
9184 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9186 If SORTING-TYPE is specified when this function is called from a Lisp
9187 program, no prompting will take place. SORTING-TYPE must be a character,
9188 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9189 should be done in reverse order."
9190 (interactive "P")
9191 (let* ((thisline (org-current-line))
9192 (thiscol (org-table-current-column))
9193 beg end bcol ecol tend tbeg column lns pos)
9194 (when (equal thiscol 0)
9195 (if (interactive-p)
9196 (setq thiscol
9197 (string-to-number
9198 (read-string "Use column N for sorting: ")))
9199 (setq thiscol 1))
9200 (org-table-goto-column thiscol))
9201 (org-table-check-inside-data-field)
9202 (if (org-region-active-p)
9203 (progn
9204 (setq beg (region-beginning) end (region-end))
9205 (goto-char beg)
9206 (setq column (org-table-current-column)
9207 beg (point-at-bol))
9208 (goto-char end)
9209 (setq end (point-at-bol 2)))
9210 (setq column (org-table-current-column)
9211 pos (point)
9212 tbeg (org-table-begin)
9213 tend (org-table-end))
9214 (if (re-search-backward org-table-hline-regexp tbeg t)
9215 (setq beg (point-at-bol 2))
9216 (goto-char tbeg)
9217 (setq beg (point-at-bol 1)))
9218 (goto-char pos)
9219 (if (re-search-forward org-table-hline-regexp tend t)
9220 (setq end (point-at-bol 1))
9221 (goto-char tend)
9222 (setq end (point-at-bol))))
9223 (setq beg (move-marker (make-marker) beg)
9224 end (move-marker (make-marker) end))
9225 (untabify beg end)
9226 (goto-char beg)
9227 (org-table-goto-column column)
9228 (skip-chars-backward "^|")
9229 (setq bcol (current-column))
9230 (org-table-goto-column (1+ column))
9231 (skip-chars-backward "^|")
9232 (setq ecol (1- (current-column)))
9233 (org-table-goto-column column)
9234 (setq lns (mapcar (lambda(x) (cons
9235 (org-sort-remove-invisible
9236 (nth (1- column)
9238 x))
9240 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9241 (delete-region beg end)
9242 (move-marker beg nil)
9243 (move-marker end nil)
9245 (goto-line thisline)
9246 (org-table-goto-column thiscol)
9247 (message "%d lines sorted, based on column %d" (length lns) column)))
9249 ;; FIXME: maybe we will not need this? Table sorting is broken....
9250 (defun org-sort-remove-invisible (s)
9251 (remove-text-properties 0 (length s) org-rm-props s)
9252 (while (string-match org-bracket-link-regexp s)
9253 (setq s (replace-match (if (match-end 2)
9254 (match-string 3 s)
9255 (match-string 1 s)) t t s)))
9256 s)
9258 (defun org-table-cut-region (beg end)
9259 "Copy region in table to the clipboard and blank all relevant fields."
9260 (interactive "r")
9261 (org-table-copy-region beg end 'cut))
9263 (defun org-table-copy-region (beg end &optional cut)
9264 "Copy rectangular region in table to clipboard.
9265 A special clipboard is used which can only be accessed
9266 with `org-table-paste-rectangle'."
9267 (interactive "rP")
9268 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9269 region cols
9270 (rpl (if cut " " nil)))
9271 (goto-char beg)
9272 (org-table-check-inside-data-field)
9273 (setq l01 (org-current-line)
9274 c01 (org-table-current-column))
9275 (goto-char end)
9276 (org-table-check-inside-data-field)
9277 (setq l02 (org-current-line)
9278 c02 (org-table-current-column))
9279 (setq l1 (min l01 l02) l2 (max l01 l02)
9280 c1 (min c01 c02) c2 (max c01 c02))
9281 (catch 'exit
9282 (while t
9283 (catch 'nextline
9284 (if (> l1 l2) (throw 'exit t))
9285 (goto-line l1)
9286 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9287 (setq cols nil ic1 c1 ic2 c2)
9288 (while (< ic1 (1+ ic2))
9289 (push (org-table-get-field ic1 rpl) cols)
9290 (setq ic1 (1+ ic1)))
9291 (push (nreverse cols) region)
9292 (setq l1 (1+ l1)))))
9293 (setq org-table-clip (nreverse region))
9294 (if cut (org-table-align))
9295 org-table-clip))
9297 (defun org-table-paste-rectangle ()
9298 "Paste a rectangular region into a table.
9299 The upper right corner ends up in the current field. All involved fields
9300 will be overwritten. If the rectangle does not fit into the present table,
9301 the table is enlarged as needed. The process ignores horizontal separator
9302 lines."
9303 (interactive)
9304 (unless (and org-table-clip (listp org-table-clip))
9305 (error "First cut/copy a region to paste!"))
9306 (org-table-check-inside-data-field)
9307 (let* ((clip org-table-clip)
9308 (line (org-current-line))
9309 (col (org-table-current-column))
9310 (org-enable-table-editor t)
9311 (org-table-automatic-realign nil)
9312 c cols field)
9313 (while (setq cols (pop clip))
9314 (while (org-at-table-hline-p) (beginning-of-line 2))
9315 (if (not (org-at-table-p))
9316 (progn (end-of-line 0) (org-table-next-field)))
9317 (setq c col)
9318 (while (setq field (pop cols))
9319 (org-table-goto-column c nil 'force)
9320 (org-table-get-field nil field)
9321 (setq c (1+ c)))
9322 (beginning-of-line 2))
9323 (goto-line line)
9324 (org-table-goto-column col)
9325 (org-table-align)))
9327 (defun org-table-convert ()
9328 "Convert from `org-mode' table to table.el and back.
9329 Obviously, this only works within limits. When an Org-mode table is
9330 converted to table.el, all horizontal separator lines get lost, because
9331 table.el uses these as cell boundaries and has no notion of horizontal lines.
9332 A table.el table can be converted to an Org-mode table only if it does not
9333 do row or column spanning. Multiline cells will become multiple cells.
9334 Beware, Org-mode does not test if the table can be successfully converted - it
9335 blindly applies a recipe that works for simple tables."
9336 (interactive)
9337 (require 'table)
9338 (if (org-at-table.el-p)
9339 ;; convert to Org-mode table
9340 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9341 (end (move-marker (make-marker) (org-table-end t))))
9342 (table-unrecognize-region beg end)
9343 (goto-char beg)
9345 (replace-match ""))
9346 (goto-char beg))
9347 (if (org-at-table-p)
9348 ;; convert to table.el table
9349 (let ((beg (move-marker (make-marker) (org-table-begin)))
9350 (end (move-marker (make-marker) (org-table-end))))
9351 ;; first, get rid of all horizontal lines
9352 (goto-char beg)
9354 (replace-match ""))
9355 ;; insert a hline before first
9356 (goto-char beg)
9357 (org-table-insert-hline 'above)
9358 (beginning-of-line -1)
9359 ;; insert a hline after each line
9360 (while (progn (beginning-of-line 3) (< (point) end))
9361 (org-table-insert-hline))
9362 (goto-char beg)
9363 (setq end (move-marker end (org-table-end)))
9364 ;; replace "+" at beginning and ending of hlines
9367 (goto-char beg)
9369 (replace-match "-+"))
9370 (goto-char beg)))))
9372 (defun org-table-wrap-region (arg)
9373 "Wrap several fields in a column like a paragraph.
9374 This is useful if you'd like to spread the contents of a field over several
9375 lines, in order to keep the table compact.
9377 If there is an active region, and both point and mark are in the same column,
9378 the text in the column is wrapped to minimum width for the given number of
9379 lines. Generally, this makes the table more compact. A prefix ARG may be
9381 formats the selected text to two lines. If the region was longer than two
9382 lines, the remaining lines remain empty. A negative prefix argument reduces
9383 the current number of lines by that amount. The wrapped text is pasted back
9384 into the table. If you formatted it to more lines than it was before, fields
9385 further down in the table get overwritten - so you might need to make space in
9386 the table first.
9388 If there is no region, the current field is split at the cursor position and
9389 the text fragment to the right of the cursor is prepended to the field one
9390 line down.
9392 If there is no region, but you specify a prefix ARG, the current field gets
9393 blank, and the content is appended to the field above."
9394 (interactive "P")
9395 (org-table-check-inside-data-field)
9396 (if (org-region-active-p)
9397 ;; There is a region: fill as a paragraph
9398 (let* ((beg (region-beginning))
9399 (cline (save-excursion (goto-char beg) (org-current-line)))
9400 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9401 nlines)
9402 (org-table-cut-region (region-beginning) (region-end))
9403 (if (> (length (car org-table-clip)) 1)
9404 (error "Region must be limited to single column"))
9405 (setq nlines (if arg
9406 (if (< arg 1)
9407 (+ (length org-table-clip) arg)
9408 arg)
9409 (length org-table-clip)))
9410 (setq org-table-clip
9411 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9412 nil nlines)))
9413 (goto-line cline)
9414 (org-table-goto-column ccol)
9415 (org-table-paste-rectangle))
9416 ;; No region, split the current field at point
9417 (if arg
9418 ;; combine with field above
9419 (let ((s (org-table-blank-field))
9420 (col (org-table-current-column)))
9421 (beginning-of-line 0)
9422 (while (org-at-table-hline-p) (beginning-of-line 0))
9423 (org-table-goto-column col)
9424 (skip-chars-forward "^|")
9425 (skip-chars-backward " ")
9426 (insert " " (org-trim s))
9427 (org-table-align))
9428 ;; split field
9430 (let ((s (match-string 1)))
9431 (replace-match " |")
9432 (goto-char (match-beginning 0))
9433 (org-table-next-row)
9434 (insert (org-trim s) " ")
9435 (org-table-align))))))
9437 (defvar org-field-marker nil)
9439 (defun org-table-edit-field (arg)
9440 "Edit table field in a different window.
9441 This is mainly useful for fields that contain hidden parts.
9443 it can be edited in place."
9444 (interactive "P")
9445 (if arg
9446 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9448 (remove-text-properties b e '(org-cwidth t invisible t
9449 display t intangible t))
9450 (if (and (boundp 'font-lock-mode) font-lock-mode)
9451 (font-lock-fontify-block)))
9452 (let ((pos (move-marker (make-marker) (point)))
9453 (field (org-table-get-field))
9454 (cw (current-window-configuration))
9455 p)
9456 (org-switch-to-buffer-other-window "*Org tmp*")
9457 (erase-buffer)
9459 (let ((org-inhibit-startup t)) (org-mode))
9460 (goto-char (setq p (point-max)))
9461 (insert (org-trim field))
9462 (remove-text-properties p (point-max)
9463 '(invisible t org-cwidth t display t
9464 intangible t))
9465 (goto-char p)
9466 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9467 (org-set-local 'org-window-configuration cw)
9468 (org-set-local 'org-field-marker pos)
9469 (message "Edit and finish with C-c C-c"))))
9471 (defun org-table-finish-edit-field ()
9472 "Finish editing a table data field.
9473 Remove all newline characters, insert the result into the table, realign
9474 the table and kill the editing buffer."
9475 (let ((pos org-field-marker)
9476 (cw org-window-configuration)
9477 (cb (current-buffer))
9478 text)
9479 (goto-char (point-min))
9482 (replace-match " "))
9483 (setq text (org-trim (buffer-string)))
9484 (set-window-configuration cw)
9485 (kill-buffer cb)
9486 (select-window (get-buffer-window (marker-buffer pos)))
9487 (goto-char pos)
9488 (move-marker pos nil)
9489 (org-table-check-inside-data-field)
9490 (org-table-get-field nil text)
9491 (org-table-align)
9492 (message "New field value inserted")))
9494 (defun org-trim (s)
9495 "Remove whitespace at beginning and end of string."
9498 s)
9500 (defun org-wrap (string &optional width lines)
9501 "Wrap string to either a number of lines, or a width in characters.
9502 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9503 that costs. If there is a word longer than WIDTH, the text is actually
9504 wrapped to the length of that word.
9505 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9506 many lines, whatever width that takes.
9507 The return value is a list of lines, without newlines at the end."
9509 (maxword (apply 'max (mapcar 'org-string-width words)))
9510 w ll)
9511 (cond (width
9512 (org-do-wrap words (max maxword width)))
9513 (lines
9514 (setq w maxword)
9515 (setq ll (org-do-wrap words maxword))
9516 (if (<= (length ll) lines)
9517 ll
9518 (setq ll words)
9519 (while (> (length ll) lines)
9520 (setq w (1+ w))
9521 (setq ll (org-do-wrap words w)))
9522 ll))
9523 (t (error "Cannot wrap this")))))
9526 (defun org-do-wrap (words width)
9527 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9528 (let (lines line)
9529 (while words
9530 (setq line (pop words))
9531 (while (and words (< (+ (length line) (length (car words))) width))
9532 (setq line (concat line " " (pop words))))
9533 (setq lines (push line lines)))
9534 (nreverse lines)))
9536 (defun org-split-string (string &optional separators)
9537 "Splits STRING into substrings at SEPARATORS.
9538 No empty strings are returned if there are matches at the beginning
9539 and end of string."
9541 (start 0)
9542 notfirst
9543 (list nil))
9544 (while (and (string-match rexp string
9545 (if (and notfirst
9546 (= start (match-beginning 0))
9547 (< start (length string)))
9548 (1+ start) start))
9549 (< (match-beginning 0) (length string)))
9550 (setq notfirst t)
9551 (or (eq (match-beginning 0) 0)
9552 (and (eq (match-beginning 0) (match-end 0))
9553 (eq (match-beginning 0) start))
9554 (setq list
9555 (cons (substring string start (match-beginning 0))
9556 list)))
9557 (setq start (match-end 0)))
9558 (or (eq start (length string))
9559 (setq list
9560 (cons (substring string start)
9561 list)))
9562 (nreverse list)))
9564 (defun org-table-map-tables (function)
9565 "Apply FUNCTION to the start of all tables in the buffer."
9566 (save-excursion
9567 (save-restriction
9568 (widen)
9569 (goto-char (point-min))
9570 (while (re-search-forward org-table-any-line-regexp nil t)
9571 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9572 (beginning-of-line 1)
9573 (if (looking-at org-table-line-regexp)
9574 (save-excursion (funcall function)))
9575 (re-search-forward org-table-any-border-regexp nil 1))))
9576 (message "Mapping tables: done"))
9578 (defvar org-timecnt) ; dynamically scoped parameter
9580 (defun org-table-sum (&optional beg end nlast)
9581 "Sum numbers in region of current table column.
9582 The result will be displayed in the echo area, and will be available
9585 If there is an active region, it is interpreted as a rectangle and all
9586 numbers in that rectangle will be summed. If there is no active
9587 region and point is located in a table column, sum all numbers in that
9588 column.
9590 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9591 numbers are assumed to be times as well (in decimal hours) and the
9592 numbers are added as such.
9594 If NLAST is a number, only the NLAST fields will actually be summed."
9595 (interactive)
9596 (save-excursion
9597 (let (col (org-timecnt 0) diff h m s org-table-clip)
9598 (cond
9599 ((and beg end)) ; beg and end given explicitly
9600 ((org-region-active-p)
9601 (setq beg (region-beginning) end (region-end)))
9602 (t
9603 (setq col (org-table-current-column))
9604 (goto-char (org-table-begin))
9606 (error "No table data"))
9607 (org-table-goto-column col)
9608 (setq beg (point))
9609 (goto-char (org-table-end))
9611 (error "No table data"))
9612 (org-table-goto-column col)
9613 (setq end (point))))
9614 (let* ((items (apply 'append (org-table-copy-region beg end)))
9615 (items1 (cond ((not nlast) items)
9616 ((>= nlast (length items)) items)
9617 (t (setq items (reverse items))
9618 (setcdr (nthcdr (1- nlast) items) nil)
9619 (nreverse items))))
9620 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9621 items1)))
9622 (res (apply '+ numbers))
9623 (sres (if (= org-timecnt 0)
9624 (format "%g" res)
9625 (setq diff (* 3600 res)
9626 h (floor (/ diff 3600)) diff (mod diff 3600)
9627 m (floor (/ diff 60)) diff (mod diff 60)
9628 s diff)
9629 (format "%d:%02d:%02d" h m s))))
9630 (kill-new sres)
9631 (if (interactive-p)
9632 (message "%s"
9633 (substitute-command-keys
9635 (length numbers) sres))))
9636 sres))))
9638 (defun org-table-get-number-for-summing (s)
9639 (let (n)
9640 (if (string-match "^ *|? *" s)
9641 (setq s (replace-match "" nil nil s)))
9642 (if (string-match " *|? *$" s)
9643 (setq s (replace-match "" nil nil s)))
9644 (setq n (string-to-number s))
9645 (cond
9646 ((and (string-match "0" s)
9650 (let ((h (string-to-number (or (match-string 1 s) "0")))
9651 (m (string-to-number (or (match-string 2 s) "0")))
9652 (s (string-to-number (or (match-string 4 s) "0"))))
9653 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9654 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9655 ((equal n 0) nil)
9656 (t n))))
9658 (defun org-table-current-field-formula (&optional key noerror)
9659 "Return the formula active for the current field.
9660 Assumes that specials are in place.
9661 If KEY is given, return the key to this formula.
9663 (let* ((name (car (rassoc (list (org-current-line)
9664 (org-table-current-column))
9665 org-table-named-field-locations)))
9666 (col (org-table-current-column))
9667 (scol (int-to-string col))
9668 (ref (format "@%d$%d" (org-table-current-dline) col))
9669 (stored-list (org-table-get-stored-formulas noerror))
9670 (ass (or (assoc name stored-list)
9671 (assoc ref stored-list)
9672 (assoc scol stored-list))))
9673 (if key
9674 (car ass)
9675 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9676 (cdr ass))))))
9678 (defun org-table-get-formula (&optional equation named)
9679 "Read a formula from the minibuffer, offer stored formula as default.
9680 When NAMED is non-nil, look for a named equation."
9681 (let* ((stored-list (org-table-get-stored-formulas))
9682 (name (car (rassoc (list (org-current-line)
9683 (org-table-current-column))
9684 org-table-named-field-locations)))
9685 (ref (format "@%d$%d" (org-table-current-dline)
9686 (org-table-current-column)))
9687 (refass (assoc ref stored-list))
9688 (scol (if named
9689 (if name name ref)
9690 (int-to-string (org-table-current-column))))
9691 (dummy (and (or name refass) (not named)
9692 (not (y-or-n-p "Replace field formula with column formula? " ))
9693 (error "Abort")))
9694 (name (or name ref))
9695 (org-table-may-need-update nil)
9696 (stored (cdr (assoc scol stored-list)))
9697 (eq (cond
9698 ((and stored equation (string-match "^ *=? *$" equation))
9699 stored)
9700 ((stringp equation)
9701 equation)
9702 (t (org-table-formula-from-user
9703 (read-string
9704 (org-table-formula-to-user
9705 (format "%s formula %s%s="
9706 (if named "Field" "Column")
9707 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9708 scol))
9709 (if stored (org-table-formula-to-user stored) "")
9710 'org-table-formula-history
9711 )))))
9712 mustsave)
9714 ;; remove formula
9715 (setq stored-list (delq (assoc scol stored-list) stored-list))
9716 (org-table-store-formulas stored-list)
9717 (error "Formula removed"))
9718 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9719 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9720 (if (and name (not named))
9721 ;; We set the column equation, delete the named one.
9722 (setq stored-list (delq (assoc name stored-list) stored-list)
9723 mustsave t))
9724 (if stored
9725 (setcdr (assoc scol stored-list) eq)
9726 (setq stored-list (cons (cons scol eq) stored-list)))
9727 (if (or mustsave (not (equal stored eq)))
9728 (org-table-store-formulas stored-list))
9729 eq))
9731 (defun org-table-store-formulas (alist)
9732 "Store the list of formulas below the current table."
9733 (setq alist (sort alist 'org-table-formula-less-p))
9734 (save-excursion
9735 (goto-char (org-table-end))
9737 (progn
9738 ;; don't overwrite TBLFM, we might use text properties to store stuff
9739 (goto-char (match-beginning 2))
9740 (delete-region (match-beginning 2) (match-end 0)))
9741 (insert "#+TBLFM:"))
9742 (insert " "
9743 (mapconcat (lambda (x)
9744 (concat
9745 (if (equal (string-to-char (car x)) ?@) "" "$")
9746 (car x) "=" (cdr x)))
9747 alist "::")
9750 (defsubst org-table-formula-make-cmp-string (a)
9752 (concat
9753 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9754 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9755 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9757 (defun org-table-formula-less-p (a b)
9758 "Compare two formulas for sorting."
9759 (let ((as (org-table-formula-make-cmp-string (car a)))
9760 (bs (org-table-formula-make-cmp-string (car b))))
9761 (and as bs (string< as bs))))
9763 (defun org-table-get-stored-formulas (&optional noerror)
9764 "Return an alist with the stored formulas directly after current table."
9765 (interactive)
9766 (let (scol eq eq-alist strings string seen)
9767 (save-excursion
9768 (goto-char (org-table-end))
9770 (setq strings (org-split-string (match-string 2) " *:: *"))
9771 (while (setq string (pop strings))
9772 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9773 (setq scol (if (match-end 2)
9774 (match-string 2 string)
9775 (match-string 1 string))
9776 eq (match-string 3 string)
9777 eq-alist (cons (cons scol eq) eq-alist))
9778 (if (member scol seen)
9779 (if noerror
9780 (progn
9781 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9782 (ding)
9783 (sit-for 2))
9784 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9785 (push scol seen))))))
9786 (nreverse eq-alist)))
9788 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9789 "Modify the equations after the table structure has been edited.
9791 For all numbers larger than LIMIT, shift them by DELTA."
9792 (save-excursion
9793 (goto-char (org-table-end))
9796 (re2
9797 (when remove
9798 (if (equal key "$")
9801 s n a)
9802 (when remove
9803 (while (re-search-forward re2 (point-at-eol) t)
9804 (replace-match "")))
9805 (while (re-search-forward re (point-at-eol) t)
9806 (setq s (match-string 1) n (string-to-number s))
9807 (cond
9808 ((setq a (assoc s replace))
9809 (replace-match (concat key (cdr a)) t t))
9810 ((and limit (> n limit))
9811 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9813 (defun org-table-get-specials ()
9814 "Get the column names and local parameters for this table."
9815 (save-excursion
9816 (let ((beg (org-table-begin)) (end (org-table-end))
9817 names name fields fields1 field cnt
9818 c v l line col types dlines hlines)
9819 (setq org-table-column-names nil
9820 org-table-local-parameters nil
9821 org-table-named-field-locations nil
9822 org-table-current-begin-line nil
9823 org-table-current-begin-pos nil
9824 org-table-current-line-types nil)
9825 (goto-char beg)
9827 (setq names (org-split-string (match-string 1) " *| *")
9828 cnt 1)
9829 (while (setq name (pop names))
9830 (setq cnt (1+ cnt))
9831 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9832 (push (cons name (int-to-string cnt)) org-table-column-names))))
9833 (setq org-table-column-names (nreverse org-table-column-names))
9834 (setq org-table-column-name-regexp
9836 (goto-char beg)
9838 (setq fields (org-split-string (match-string 1) " *| *"))
9839 (while (setq field (pop fields))
9841 (push (cons (match-string 1 field) (match-string 2 field))
9842 org-table-local-parameters))))
9843 (goto-char beg)
9845 (setq c (match-string 1)
9846 fields (org-split-string (match-string 2) " *| *"))
9847 (save-excursion
9848 (beginning-of-line (if (equal c "_") 2 0))
9849 (setq line (org-current-line) col 1)
9851 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9852 (while (and fields1 (setq field (pop fields)))
9853 (setq v (pop fields1) col (1+ col))
9854 (when (and (stringp field) (stringp v)
9855 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9856 (push (cons field v) org-table-local-parameters)
9857 (push (list field line col) org-table-named-field-locations))))
9858 ;; Analyse the line types
9859 (goto-char beg)
9860 (setq org-table-current-begin-line (org-current-line)
9861 org-table-current-begin-pos (point)
9862 l org-table-current-begin-line)
9864 (push (if (match-end 1) 'hline 'dline) types)
9865 (if (match-end 1) (push l hlines) (push l dlines))
9866 (beginning-of-line 2)
9867 (setq l (1+ l)))
9868 (setq org-table-current-line-types (apply 'vector (nreverse types))
9869 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9870 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9872 (defun org-table-maybe-eval-formula ()
9874 If yes, store the formula and apply it."
9875 ;; We already know we are in a table. Get field will only return a formula
9876 ;; when appropriate. It might return a separator line, but no problem.
9877 (when org-table-formula-evaluate-inline
9878 (let* ((field (org-trim (or (org-table-get-field) "")))
9879 named eq)
9881 (setq named (equal (string-to-char field) ?:)
9882 eq (match-string 1 field))
9883 (if (or (fboundp 'calc-eval)
9884 (equal (substring eq 0 (min 2 (length eq))) "'("))
9885 (org-table-eval-formula (if named '(4) nil)
9886 (org-table-formula-from-user eq))
9887 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9889 (defvar org-recalc-commands nil
9890 "List of commands triggering the recalculation of a line.
9891 Will be filled automatically during use.")
9893 (defvar org-recalc-marks
9894 '((" " . "Unmarked: no special line, no automatic recalculation")
9895 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9896 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9897 ("!" . "Column name definition line. Reference in formula as $name.")
9898 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9899 ("_" . "Names for values in row below this one.")
9900 ("^" . "Names for values in row above this one.")))
9902 (defun org-table-rotate-recalc-marks (&optional newchar)
9903 "Rotate the recalculation mark in the first column.
9904 If in any row, the first field is not consistent with a mark,
9905 insert a new column for the markers.
9906 When there is an active region, change all the lines in the region,
9907 after prompting for the marking character.
9908 After each change, a message will be displayed indicating the meaning
9909 of the new mark."
9910 (interactive)
9911 (unless (org-at-table-p) (error "Not at a table"))
9912 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9913 (beg (org-table-begin))
9914 (end (org-table-end))
9915 (l (org-current-line))
9916 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9917 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9918 (have-col
9919 (save-excursion
9920 (goto-char beg)
9922 (col (org-table-current-column))
9923 (forcenew (car (assoc newchar org-recalc-marks)))
9924 epos new)
9925 (when l1
9926 (message "Change region to what mark? Type # * ! $ or SPC: ")
9927 (setq newchar (char-to-string (read-char-exclusive))
9928 forcenew (car (assoc newchar org-recalc-marks))))
9929 (if (and newchar (not forcenew))
9930 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9931 newchar))
9932 (if l1 (goto-line l1))
9933 (save-excursion
9934 (beginning-of-line 1)
9935 (unless (looking-at org-table-dataline-regexp)
9936 (error "Not at a table data line")))
9937 (unless have-col
9938 (org-table-goto-column 1)
9939 (org-table-insert-column)
9940 (org-table-goto-column (1+ col)))
9941 (setq epos (point-at-eol))
9942 (save-excursion
9943 (beginning-of-line 1)
9944 (org-table-get-field
9946 (concat " "
9947 (setq new (or forcenew
9948 (cadr (member (match-string 1) marks))))
9949 " ")
9950 " # ")))
9951 (if (and l1 l2)
9952 (progn
9953 (goto-line l1)
9954 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9955 (and (looking-at org-table-dataline-regexp)
9956 (org-table-get-field 1 (concat " " new " "))))
9957 (goto-line l1)))
9958 (if (not (= epos (point-at-eol))) (org-table-align))
9959 (goto-line l)
9960 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
9962 (defun org-table-maybe-recalculate-line ()
9963 "Recompute the current line if marked for it, and if we haven't just done it."
9964 (interactive)
9965 (and org-table-allow-automatic-line-recalculation
9966 (not (and (memq last-command org-recalc-commands)
9967 (equal org-last-recalc-line (org-current-line))))
9968 (save-excursion (beginning-of-line 1)
9969 (looking-at org-table-auto-recalculate-regexp))
9970 (org-table-recalculate) t))
9972 (defvar org-table-formula-debug nil
9973 "Non-nil means, debug table formulas.
9975 (make-variable-buffer-local 'org-table-formula-debug)
9977 (defvar modes)
9978 (defsubst org-set-calc-mode (var &optional value)
9979 (if (stringp var)
9980 (setq var (assoc var '(("D" calc-angle-mode deg)
9981 ("R" calc-angle-mode rad)
9982 ("F" calc-prefer-frac t)
9983 ("S" calc-symbolic-mode t)))
9984 value (nth 2 var) var (nth 1 var)))
9985 (if (memq var modes)
9986 (setcar (cdr (memq var modes)) value)
9987 (cons var (cons value modes)))
9988 modes)
9990 (defun org-table-eval-formula (&optional arg equation
9991 suppress-align suppress-const
9992 suppress-store suppress-analysis)
9993 "Replace the table field value at the cursor by the result of a calculation.
9995 This function makes use of Dave Gillespie's Calc package, in my view the
9996 most exciting program ever written for GNU Emacs. So you need to have Calc
9997 installed in order to use this function.
9999 In a table, this command replaces the value in the current field with the
10001 formula, by storing it in a special line below the table. When called
10002 with a `C-u' prefix, the current field must ba a named field, and the
10003 formula is installed as valid in only this specific field.
10005 When called with two `C-u' prefixes, insert the active equation
10006 for the field back into the current field, so that it can be
10008 to check the referenced fields.
10010 When called, the command first prompts for a formula, which is read in
10011 the minibuffer. Previously entered formulas are available through the
10012 history list, and the last used formula is offered as a default.
10013 These stored formulas are adapted correctly when moving, inserting, or
10014 deleting columns with the corresponding commands.
10016 The formula can be any algebraic expression understood by the Calc package.
10017 For details, see the Org-mode manual.
10019 This function can also be called from Lisp programs and offers
10020 additional arguments: EQUATION can be the formula to apply. If this
10021 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10022 used to speed-up recursive calls by by-passing unnecessary aligns.
10023 SUPPRESS-CONST suppresses the interpretation of constants in the
10024 formula, assuming that this has been done already outside the function.
10025 SUPPRESS-STORE means the formula should not be stored, either because
10026 it is already stored, or because it is a modified equation that should
10027 not overwrite the stored one."
10028 (interactive "P")
10029 (org-table-check-inside-data-field)
10030 (or suppress-analysis (org-table-get-specials))
10031 (if (equal arg '(16))
10032 (let ((eq (org-table-current-field-formula)))
10033 (or eq (error "No equation active for current field"))
10034 (org-table-get-field nil eq)
10035 (org-table-align)
10036 (setq org-table-may-need-update t))
10037 (let* (fields
10038 (ndown (if (integerp arg) arg 1))
10039 (org-table-automatic-realign nil)
10040 (case-fold-search nil)
10041 (down (> ndown 1))
10042 (formula (if (and equation suppress-store)
10043 equation
10044 (org-table-get-formula equation (equal arg '(4)))))
10045 (n0 (org-table-current-column))
10046 (modes (copy-sequence org-calc-default-modes))
10047 (numbers nil) ; was a variable, now fixed default
10048 (keep-empty nil)
10049 n form form0 bw fmt x ev orig c lispp literal)
10050 ;; Parse the format string. Since we have a lot of modes, this is
10051 ;; a lot of work. However, I think calc still uses most of the time.
10052 (if (string-match ";" formula)
10053 (let ((tmp (org-split-string formula ";")))
10054 (setq formula (car tmp)
10055 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10056 (nth 1 tmp)))
10058 (setq c (string-to-char (match-string 1 fmt))
10059 n (string-to-number (match-string 2 fmt)))
10060 (if (= c ?p)
10061 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10062 (setq modes (org-set-calc-mode
10063 'calc-float-format
10064 (list (cdr (assoc c '((?n . float) (?f . fix)
10065 (?s . sci) (?e . eng))))
10066 n))))
10067 (setq fmt (replace-match "" t t fmt)))
10068 (if (string-match "[NT]" fmt)
10069 (setq numbers (equal (match-string 0 fmt) "N")
10070 fmt (replace-match "" t t fmt)))
10071 (if (string-match "L" fmt)
10072 (setq literal t
10073 fmt (replace-match "" t t fmt)))
10074 (if (string-match "E" fmt)
10075 (setq keep-empty t
10076 fmt (replace-match "" t t fmt)))
10077 (while (string-match "[DRFS]" fmt)
10078 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10079 (setq fmt (replace-match "" t t fmt)))
10081 (setq fmt nil))))
10082 (if (and (not suppress-const) org-table-formula-use-constants)
10083 (setq formula (org-table-formula-substitute-names formula)))
10084 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10085 (while (> ndown 0)
10086 (setq fields (org-split-string
10087 (org-no-properties
10088 (buffer-substring (point-at-bol) (point-at-eol)))
10089 " *| *"))
10090 (if (eq numbers t)
10091 (setq fields (mapcar
10092 (lambda (x) (number-to-string (string-to-number x)))
10093 fields)))
10094 (setq ndown (1- ndown))
10095 (setq form (copy-sequence formula)
10096 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10097 (if (and lispp literal) (setq lispp 'literal))
10098 ;; Check for old vertical references
10099 (setq form (org-rewrite-old-row-references form))
10100 ;; Insert complex ranges
10101 (while (string-match org-table-range-regexp form)
10102 (setq form
10103 (replace-match
10104 (save-match-data
10105 (org-table-make-reference
10106 (org-table-get-range (match-string 0 form) nil n0)
10107 keep-empty numbers lispp))
10108 t t form)))
10109 ;; Insert simple ranges
10111 (setq form
10112 (replace-match
10113 (save-match-data
10114 (org-table-make-reference
10115 (org-sublist
10116 fields (string-to-number (match-string 1 form))
10117 (string-to-number (match-string 2 form)))
10118 keep-empty numbers lispp))
10119 t t form)))
10120 (setq form0 form)
10121 ;; Insert the references to fields in same row
10123 (setq n (string-to-number (match-string 1 form))
10124 x (nth (1- (if (= n 0) n0 n)) fields))
10126 (match-string 0 form)))
10127 (setq form (replace-match
10128 (save-match-data
10129 (org-table-make-reference x nil numbers lispp))
10130 t t form)))
10132 (if lispp
10133 (setq ev (condition-case nil
10134 (eval (eval (read form)))
10135 (error "#ERROR"))
10136 ev (if (numberp ev) (number-to-string ev) ev))
10137 (or (fboundp 'calc-eval)
10138 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10139 (setq ev (calc-eval (cons form modes)
10140 (if numbers 'num))))
10142 (when org-table-formula-debug
10143 (with-output-to-temp-buffer "*Substitution History*"
10144 (princ (format "Substitution history of formula
10145 Orig: %s
10146 $xyz-> %s
10147 @r$c-> %s
10149 (if (listp ev)
10151 (make-string (car ev) ?\-) (nth 1 ev)))
10153 ev (or fmt "NONE")
10154 (if fmt (format fmt (string-to-number ev)) ev)))))
10155 (setq bw (get-buffer-window "*Substitution History*"))
10156 (shrink-window-if-larger-than-buffer bw)
10157 (unless (and (interactive-p) (not ndown))
10158 (unless (let (inhibit-redisplay)
10159 (y-or-n-p "Debugging Formula. Continue to next? "))
10160 (org-table-align)
10161 (error "Abort"))
10162 (delete-window bw)
10163 (message "")))
10164 (if (listp ev) (setq fmt nil ev "#ERROR"))
10165 (org-table-justify-field-maybe
10166 (if fmt (format fmt (string-to-number ev)) ev))
10168 (call-interactively 'org-return)
10169 (setq ndown 0)))
10170 (and down (org-table-maybe-recalculate-line))
10171 (or suppress-align (and org-table-may-need-update
10172 (org-table-align))))))
10174 (defun org-table-put-field-property (prop value)
10175 (save-excursion
10176 (put-text-property (progn (skip-chars-backward "^|") (point))
10177 (progn (skip-chars-forward "^|") (point))
10178 prop value)))
10180 (defun org-table-get-range (desc &optional tbeg col highlight)
10181 "Get a calc vector from a column, accorting to descriptor DESC.
10182 Optional arguments TBEG and COL can give the beginning of the table and
10183 the current column, to avoid unnecessary parsing.
10184 HIGHLIGHT means, just highlight the range."
10185 (if (not (equal (string-to-char desc) ?@))
10186 (setq desc (concat "@" desc)))
10187 (save-excursion
10188 (or tbeg (setq tbeg (org-table-begin)))
10189 (or col (setq col (org-table-current-column)))
10190 (let ((thisline (org-current-line))
10191 beg end c1 c2 r1 r2 rangep tmp)
10192 (unless (string-match org-table-range-regexp desc)
10193 (error "Invalid table range specifier `%s'" desc))
10194 (setq rangep (match-end 3)
10195 r1 (and (match-end 1) (match-string 1 desc))
10196 r2 (and (match-end 4) (match-string 4 desc))
10197 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10198 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10200 (and c1 (setq c1 (+ (string-to-number c1)
10201 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10202 (and c2 (setq c2 (+ (string-to-number c2)
10203 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10204 (if (equal r1 "") (setq r1 nil))
10205 (if (equal r2 "") (setq r2 nil))
10206 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10207 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10208 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10209 (if (not r1) (setq r1 thisline))
10210 (if (not r2) (setq r2 thisline))
10211 (if (not c1) (setq c1 col))
10212 (if (not c2) (setq c2 col))
10213 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10214 ;; just one field
10215 (progn
10216 (goto-line r1)
10217 (while (not (looking-at org-table-dataline-regexp))
10218 (beginning-of-line 2))
10219 (prog1 (org-trim (org-table-get-field c1))
10220 (if highlight (org-table-highlight-rectangle (point) (point)))))
10221 ;; A range, return a vector
10222 ;; First sort the numbers to get a regular ractangle
10223 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10224 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10225 (goto-line r1)
10226 (while (not (looking-at org-table-dataline-regexp))
10227 (beginning-of-line 2))
10228 (org-table-goto-column c1)
10229 (setq beg (point))
10230 (goto-line r2)
10231 (while (not (looking-at org-table-dataline-regexp))
10232 (beginning-of-line 0))
10233 (org-table-goto-column c2)
10234 (setq end (point))
10235 (if highlight
10236 (org-table-highlight-rectangle
10238 ;; return string representation of calc vector
10239 (mapcar 'org-trim
10240 (apply 'append (org-table-copy-region beg end)))))))
10242 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10243 "Analyze descriptor DESC and retrieve the corresponding line number.
10244 The cursor is currently in line CLINE, the table begins in line BLINE,
10245 and TABLE is a vector with line types."
10246 (if (string-match "^[0-9]+$" desc)
10247 (aref org-table-dlines (string-to-number desc))
10248 (setq cline (or cline (org-current-line))
10249 bline (or bline org-table-current-begin-line)
10250 table (or table org-table-current-line-types))
10251 (if (or
10253 ;; 1 2 3 4 5 6
10254 (and (not (match-end 3)) (not (match-end 6)))
10255 (and (match-end 3) (match-end 6) (not (match-end 5))))
10256 (error "invalid row descriptor `%s'" desc))
10257 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10258 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10259 (odir (and (match-end 5) (match-string 5 desc)))
10260 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10261 (i (- cline bline))
10262 (rel (and (match-end 6)
10263 (or (and (match-end 1) (not (match-end 3)))
10264 (match-end 5)))))
10265 (if (and hn (not hdir))
10266 (progn
10267 (setq i 0 hdir "+")
10268 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10269 (if (and (not hn) on (not odir))
10270 (error "should never happen");;(aref org-table-dlines on)
10271 (if (and hn (> hn 0))
10272 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10273 (if on
10274 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10275 (+ bline i)))))
10277 (defun org-find-row-type (table i type backwards relative n)
10278 (let ((l (length table)))
10279 (while (> n 0)
10280 (while (and (setq i (+ i (if backwards -1 1)))
10281 (>= i 0) (< i l)
10282 (not (eq (aref table i) type))
10283 (if (and relative (eq (aref table i) 'hline))
10284 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10285 t)))
10286 (setq n (1- n)))
10287 (if (or (< i 0) (>= i l))
10288 (error "Row descriptior leads outside table")
10289 i)))
10291 (defun org-rewrite-old-row-references (s)
10292 (if (string-match "&[-+0-9I]" s)
10293 (error "Formula contains old &row reference, please rewrite using @-syntax")
10294 s))
10296 (defun org-table-make-reference (elements keep-empty numbers lispp)
10297 "Convert list ELEMENTS to something appropriate to insert into formula.
10298 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10299 NUMBERS indicates that everything should be converted to numbers.
10300 LISPP means to return something appropriate for a Lisp list."
10301 (if (stringp elements) ; just a single val
10302 (if lispp
10303 (if (eq lispp 'literal)
10304 elements
10305 (prin1-to-string (if numbers (string-to-number elements) elements)))
10306 (if (equal elements "") (setq elements "0"))
10307 (if numbers (number-to-string (string-to-number elements)) elements))
10308 (unless keep-empty
10309 (setq elements
10310 (delq nil
10312 elements))))
10313 (setq elements (or elements '("0")))
10314 (if lispp
10315 (mapconcat
10316 (lambda (x)
10317 (if (eq lispp 'literal)
10318 x
10319 (prin1-to-string (if numbers (string-to-number x) x))))
10320 elements " ")
10321 (concat "[" (mapconcat
10322 (lambda (x)
10323 (if numbers (number-to-string (string-to-number x)) x))
10324 elements
10325 ",") "]"))))
10327 (defun org-table-recalculate (&optional all noalign)
10328 "Recalculate the current table line by applying all stored formulas.
10329 With prefix arg ALL, do this for all lines in the table."
10330 (interactive "P")
10331 (or (memq this-command org-recalc-commands)
10332 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10333 (unless (org-at-table-p) (error "Not at a table"))
10334 (if (equal all '(16))
10335 (org-table-iterate)
10336 (org-table-get-specials)
10337 (let* ((eqlist (sort (org-table-get-stored-formulas)
10338 (lambda (a b) (string< (car a) (car b)))))
10339 (inhibit-redisplay (not debug-on-error))
10340 (line-re org-table-dataline-regexp)
10341 (thisline (org-current-line))
10342 (thiscol (org-table-current-column))
10343 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10344 ;; Insert constants in all formulas
10345 (setq eqlist
10346 (mapcar (lambda (x)
10347 (setcdr x (org-table-formula-substitute-names (cdr x)))
10348 x)
10349 eqlist))
10350 ;; Split the equation list
10351 (while (setq eq (pop eqlist))
10352 (if (<= (string-to-char (car eq)) ?9)
10353 (push eq eqlnum)
10354 (push eq eqlname)))
10355 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10356 (if all
10357 (progn
10358 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10359 (goto-char (setq beg (org-table-begin)))
10360 (if (re-search-forward org-table-calculate-mark-regexp end t)
10361 ;; This is a table with marked lines, compute selected lines
10362 (setq line-re org-table-recalculate-regexp)
10363 ;; Move forward to the first non-header line
10364 (if (and (re-search-forward org-table-dataline-regexp end t)
10365 (re-search-forward org-table-hline-regexp end t)
10366 (re-search-forward org-table-dataline-regexp end t))
10367 (setq beg (match-beginning 0))
10368 nil))) ;; just leave beg where it is
10369 (setq beg (point-at-bol)
10370 end (move-marker (make-marker) (1+ (point-at-eol)))))
10371 (goto-char beg)
10372 (and all (message "Re-applying formulas to full table..."))
10374 ;; First find the named fields, and mark them untouchanble
10375 (remove-text-properties beg end '(org-untouchable t))
10376 (while (setq eq (pop eqlname))
10377 (setq name (car eq)
10378 a (assoc name org-table-named-field-locations))
10379 (and (not a)
10381 (setq a (list name
10382 (aref org-table-dlines
10383 (string-to-number (match-string 1 name)))
10384 (string-to-number (match-string 2 name)))))
10385 (when (and a (or all (equal (nth 1 a) thisline)))
10386 (message "Re-applying formula to field: %s" name)
10387 (goto-line (nth 1 a))
10388 (org-table-goto-column (nth 2 a))
10389 (push (append a (list (cdr eq))) eqlname1)
10390 (org-table-put-field-property :org-untouchable t)))
10392 ;; Now evauluate the column formulas, but skip fields covered by
10393 ;; field formulas
10394 (goto-char beg)
10395 (while (re-search-forward line-re end t)
10396 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10397 ;; Unprotected line, recalculate
10398 (and all (message "Re-applying formulas to full table...(line %d)"
10399 (setq cnt (1+ cnt))))
10400 (setq org-last-recalc-line (org-current-line))
10401 (setq eql eqlnum)
10402 (while (setq entry (pop eql))
10403 (goto-line org-last-recalc-line)
10404 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10405 (unless (get-text-property (point) :org-untouchable)
10406 (org-table-eval-formula nil (cdr entry)
10407 'noalign 'nocst 'nostore 'noanalysis)))))
10409 ;; Now evaluate the field formulas
10410 (while (setq eq (pop eqlname1))
10411 (message "Re-applying formula to field: %s" (car eq))
10412 (goto-line (nth 1 eq))
10413 (org-table-goto-column (nth 2 eq))
10414 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10415 'nostore 'noanalysis))
10417 (goto-line thisline)
10418 (org-table-goto-column thiscol)
10419 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10420 (or noalign (and org-table-may-need-update (org-table-align))
10421 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10423 ;; back to initial position
10424 (message "Re-applying formulas...done")
10425 (goto-line thisline)
10426 (org-table-goto-column thiscol)
10427 (or noalign (and org-table-may-need-update (org-table-align))
10428 (and all (message "Re-applying formulas...done"))))))
10430 (defun org-table-iterate (&optional arg)
10431 "Recalculate the table until it does not change anymore."
10432 (interactive "P")
10433 (let ((imax (if arg (prefix-numeric-value arg) 10))
10434 (i 0)
10435 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10436 thistbl)
10437 (catch 'exit
10438 (while (< i imax)
10439 (setq i (1+ i))
10440 (org-table-recalculate 'all)
10441 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10442 (if (not (string= lasttbl thistbl))
10443 (setq lasttbl thistbl)
10444 (if (> i 1)
10445 (message "Convergence after %d iterations" i)
10446 (message "Table was already stable"))
10447 (throw 'exit t)))
10448 (error "No convergence after %d iterations" i))))
10450 (defun org-table-formula-substitute-names (f)
10451 "Replace $const with values in string F."
10452 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10453 ;; First, check for column names
10454 (while (setq start (string-match org-table-column-name-regexp f start))
10455 (setq start (1+ start))
10456 (setq a (assoc (match-string 1 f) org-table-column-names))
10457 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10458 ;; Parameters and constants
10459 (setq start 0)
10461 (setq start (1+ start))
10462 (if (setq a (save-match-data
10463 (org-table-get-constant (match-string 1 f))))
10464 (setq f (replace-match
10465 (concat (if pp "(") a (if pp ")")) t t f))))
10466 (if org-table-formula-debug
10467 (put-text-property 0 (length f) :orig-formula f1 f))
10468 f))
10470 (defun org-table-get-constant (const)
10471 "Find the value for a parameter or constant in a formula.
10472 Parameters get priority."
10473 (or (cdr (assoc const org-table-local-parameters))
10474 (cdr (assoc const org-table-formula-constants-local))
10475 (cdr (assoc const org-table-formula-constants))
10476 (and (fboundp 'constants-get) (constants-get const))
10477 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10478 (org-entry-get nil (substring const 5) 'inherit))
10479 "#UNDEFINED_NAME"))
10481 (defvar org-table-fedit-map
10482 (let ((map (make-sparse-keymap)))
10483 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10484 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10485 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10486 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10487 (org-defkey map "\C-c?" 'org-table-show-reference)
10488 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10489 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10490 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10491 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10492 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10493 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10494 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10495 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10496 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10497 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10498 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10499 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10500 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10501 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10502 map))
10504 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10505 '("Edit-Formulas"
10506 ["Finish and Install" org-table-fedit-finish t]
10507 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10508 ["Abort" org-table-fedit-abort t]
10509 "--"
10510 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10511 ["Complete Lisp Symbol" lisp-complete-symbol t]
10512 "--"
10513 "Shift Reference at Point"
10514 ["Up" org-table-fedit-ref-up t]
10515 ["Down" org-table-fedit-ref-down t]
10516 ["Left" org-table-fedit-ref-left t]
10517 ["Right" org-table-fedit-ref-right t]
10518 "-"
10519 "Change Test Row for Column Formulas"
10520 ["Up" org-table-fedit-line-up t]
10521 ["Down" org-table-fedit-line-down t]
10522 "--"
10523 ["Scroll Table Window" org-table-fedit-scroll t]
10524 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10525 ["Show Table Grid" org-table-fedit-toggle-coordinates
10526 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10527 org-table-overlay-coordinates)]
10528 "--"
10529 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10530 :style toggle :selected org-table-buffer-is-an]))
10532 (defvar org-pos)
10534 (defun org-table-edit-formulas ()
10535 "Edit the formulas of the current table in a separate buffer."
10536 (interactive)
10538 (beginning-of-line 0))
10539 (unless (org-at-table-p) (error "Not at a table"))
10540 (org-table-get-specials)
10541 (let ((key (org-table-current-field-formula 'key 'noerror))
10542 (eql (sort (org-table-get-stored-formulas 'noerror)
10543 'org-table-formula-less-p))
10544 (pos (move-marker (make-marker) (point)))
10545 (startline 1)
10546 (wc (current-window-configuration))
10550 entry s type title)
10551 (org-switch-to-buffer-other-window "*Edit Formulas*")
10552 (erase-buffer)
10553 ;; Keep global-font-lock-mode from turning on font-lock-mode
10554 (let ((font-lock-global-modes '(not fundamental-mode)))
10555 (fundamental-mode))
10556 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10557 (org-set-local 'org-pos pos)
10558 (org-set-local 'org-window-configuration wc)
10559 (use-local-map org-table-fedit-map)
10560 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10561 (easy-menu-add org-table-fedit-menu)
10562 (setq startline (org-current-line))
10563 (while (setq entry (pop eql))
10564 (setq type (cond
10565 ((equal (string-to-char (car entry)) ?@) 'field)
10566 ((string-match "^[0-9]" (car entry)) 'column)
10567 (t 'named)))
10568 (when (setq title (assq type titles))
10570 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10571 (setq titles (delq title titles)))
10572 (if (equal key (car entry)) (setq startline (org-current-line)))
10573 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10575 (remove-text-properties 0 (length s) '(face nil) s)
10576 (insert s))
10577 (if (eq org-table-use-standard-references t)
10578 (org-table-fedit-toggle-ref-type))
10579 (goto-line startline)
10580 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10582 (defun org-table-fedit-post-command ()
10583 (when (not (memq this-command '(lisp-complete-symbol)))
10584 (let ((win (selected-window)))
10585 (save-excursion
10586 (condition-case nil
10587 (org-table-show-reference)
10588 (error nil))
10589 (select-window win)))))
10591 (defun org-table-formula-to-user (s)
10592 "Convert a formula from internal to user representation."
10593 (if (eq org-table-use-standard-references t)
10594 (org-table-convert-refs-to-an s)
10595 s))
10597 (defun org-table-formula-from-user (s)
10598 "Convert a formula from user to internal representation."
10599 (if org-table-use-standard-references
10600 (org-table-convert-refs-to-rc s)
10601 s))
10603 (defun org-table-convert-refs-to-rc (s)
10604 "Convert spreadsheet references from AB7 to @7$28.
10605 Works for single references, but also for entire formulas and even the
10606 full TBLFM line."
10607 (let ((start 0))
10609 (cond
10610 ((match-end 3)
10611 ;; format match, just advance
10612 (setq start (match-end 0)))
10613 ((and (> (match-beginning 0) 0)
10614 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10615 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10616 ;; 3.e5 or something like this.
10617 (setq start (match-end 0)))
10618 (t
10619 (setq start (match-beginning 0)
10620 s (replace-match
10621 (if (equal (match-string 2 s) "&")
10622 (format "$%d" (org-letters-to-number (match-string 1 s)))
10623 (format "@%d$%d"
10624 (string-to-number (match-string 2 s))
10625 (org-letters-to-number (match-string 1 s))))
10626 t t s)))))
10627 s))
10629 (defun org-table-convert-refs-to-an (s)
10630 "Convert spreadsheet references from to @7$28 to AB7.
10631 Works for single references, but also for entire formulas and even the
10632 full TBLFM line."
10634 (setq s (replace-match
10635 (format "%s%d"
10636 (org-number-to-letters
10637 (string-to-number (match-string 2 s)))
10638 (string-to-number (match-string 1 s)))
10639 t t s)))
10642 (org-number-to-letters
10643 (string-to-number (match-string 2 s))) "&")
10644 t nil s)))
10645 s)
10647 (defun org-letters-to-number (s)
10648 "Convert a base 26 number represented by letters into an integer.
10649 For example: AB -> 28."
10650 (let ((n 0))
10651 (setq s (upcase s))
10652 (while (> (length s) 0)
10653 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10654 s (substring s 1)))
10655 n))
10657 (defun org-number-to-letters (n)
10658 "Convert an integer into a base 26 number represented by letters.
10659 For example: 28 -> AB."
10660 (let ((s ""))
10661 (while (> n 0)
10662 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10663 n (/ (1- n) 26)))
10664 s))
10666 (defun org-table-fedit-convert-buffer (function)
10667 "Convert all references in this buffer, using FUNTION."
10668 (let ((line (org-current-line)))
10669 (goto-char (point-min))
10670 (while (not (eobp))
10671 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10672 (delete-region (point) (point-at-eol))
10673 (or (eobp) (forward-char 1)))
10674 (goto-line line)))
10676 (defun org-table-fedit-toggle-ref-type ()
10677 "Convert all references in the buffer from B3 to @3$2 and back."
10678 (interactive)
10679 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10680 (org-table-fedit-convert-buffer
10681 (if org-table-buffer-is-an
10682 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10683 (message "Reference type switched to %s"
10684 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10686 (defun org-table-fedit-ref-up ()
10687 "Shift the reference at point one row/hline up."
10688 (interactive)
10689 (org-table-fedit-shift-reference 'up))
10690 (defun org-table-fedit-ref-down ()
10691 "Shift the reference at point one row/hline down."
10692 (interactive)
10693 (org-table-fedit-shift-reference 'down))
10694 (defun org-table-fedit-ref-left ()
10695 "Shift the reference at point one field to the left."
10696 (interactive)
10697 (org-table-fedit-shift-reference 'left))
10698 (defun org-table-fedit-ref-right ()
10699 "Shift the reference at point one field to the right."
10700 (interactive)
10701 (org-table-fedit-shift-reference 'right))
10703 (defun org-table-fedit-shift-reference (dir)
10704 (cond
10706 (if (memq dir '(left right))
10707 (org-rematch-and-replace 1 (eq dir 'left))
10708 (error "Cannot shift reference in this direction")))
10710 ;; A B3-like reference
10711 (if (memq dir '(up down))
10712 (org-rematch-and-replace 2 (eq dir 'up))
10713 (org-rematch-and-replace 1 (eq dir 'left))))
10714 ((org-at-regexp-p
10716 ;; An internal reference
10717 (if (memq dir '(up down))
10718 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10719 (org-rematch-and-replace 5 (eq dir 'left))))))
10721 (defun org-rematch-and-replace (n &optional decr hline)
10722 "Re-match the group N, and replace it with the shifted refrence."
10723 (or (match-end n) (error "Cannot shift reference in this direction"))
10724 (goto-char (match-beginning n))
10725 (and (looking-at (regexp-quote (match-string n)))
10726 (replace-match (org-shift-refpart (match-string 0) decr hline)
10727 t t)))
10729 (defun org-shift-refpart (ref &optional decr hline)
10730 "Shift a refrence part REF.
10731 If DECR is set, decrease the references row/column, else increase.
10732 If HLINE is set, this may be a hline reference, it certainly is not
10733 a translation reference."
10734 (save-match-data
10735 (let* ((sign (string-match "^[-+]" ref)) n)
10737 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10738 (cond
10739 ((and hline (string-match "^I+" ref))
10740 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10741 (setq n (+ n (if decr -1 1)))
10742 (if (= n 0) (setq n (+ n (if decr -1 1))))
10743 (if sign
10744 (setq sign (if (< n 0) "-" "+") n (abs n))
10745 (setq n (max 1 n)))
10746 (concat sign (make-string n ?I)))
10748 ((string-match "^[0-9]+" ref)
10749 (setq n (string-to-number (concat sign ref)))
10750 (setq n (+ n (if decr -1 1)))
10751 (if sign
10752 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10753 (number-to-string (max 1 n))))
10755 ((string-match "^[a-zA-Z]+" ref)
10756 (org-number-to-letters
10757 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10759 (t (error "Cannot shift reference"))))))
10761 (defun org-table-fedit-toggle-coordinates ()
10762 "Toggle the display of coordinates in the refrenced table."
10763 (interactive)
10764 (let ((pos (marker-position org-pos)))
10765 (with-current-buffer (marker-buffer org-pos)
10766 (save-excursion
10767 (goto-char pos)
10768 (org-table-toggle-coordinate-overlays)))))
10770 (defun org-table-fedit-finish (&optional arg)
10771 "Parse the buffer for formula definitions and install them.
10772 With prefix ARG, apply the new formulas to the table."
10773 (interactive "P")
10774 (org-table-remove-rectangle-highlight)
10775 (if org-table-use-standard-references
10776 (progn
10777 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10778 (setq org-table-buffer-is-an nil)))
10779 (let ((pos org-pos) eql var form)
10780 (goto-char (point-min))
10781 (while (re-search-forward
10783 nil t)
10784 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10785 form (match-string 3))
10786 (setq form (org-trim form))
10787 (when (not (equal form ""))
10789 (setq form (replace-match " " t t form)))
10790 (when (assoc var eql)
10791 (error "Double formulas for %s" var))
10792 (push (cons var form) eql)))
10793 (setq org-pos nil)
10794 (set-window-configuration org-window-configuration)
10795 (select-window (get-buffer-window (marker-buffer pos)))
10796 (goto-char pos)
10797 (unless (org-at-table-p)
10798 (error "Lost table position - cannot install formulae"))
10799 (org-table-store-formulas eql)
10800 (move-marker pos nil)
10801 (kill-buffer "*Edit Formulas*")
10802 (if arg
10803 (org-table-recalculate 'all)
10804 (message "New formulas installed - press C-u C-c C-c to apply."))))
10806 (defun org-table-fedit-abort ()
10807 "Abort editing formulas, without installing the changes."
10808 (interactive)
10809 (org-table-remove-rectangle-highlight)
10810 (let ((pos org-pos))
10811 (set-window-configuration org-window-configuration)
10812 (select-window (get-buffer-window (marker-buffer pos)))
10813 (goto-char pos)
10814 (move-marker pos nil)
10815 (message "Formula editing aborted without installing changes")))
10817 (defun org-table-fedit-lisp-indent ()
10818 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10819 (interactive)
10820 (let ((pos (point)) beg end ind)
10821 (beginning-of-line 1)
10822 (cond
10824 (goto-char pos)
10825 (call-interactively 'lisp-indent-line))
10827 ((not (fboundp 'pp-buffer))
10828 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10829 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10830 (goto-char (- (match-end 0) 2))
10831 (setq beg (point))
10832 (setq ind (make-string (current-column) ?\ ))
10833 (condition-case nil (forward-sexp 1)
10834 (error
10835 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10836 (setq end (point))
10837 (save-restriction
10838 (narrow-to-region beg end)
10839 (if (eq last-command this-command)
10840 (progn
10841 (goto-char (point-min))
10842 (setq this-command nil)
10844 (replace-match " ")))
10845 (pp-buffer)
10846 (untabify (point-min) (point-max))
10847 (goto-char (1+ (point-min)))
10848 (while (re-search-forward "^." nil t)
10849 (beginning-of-line 1)
10850 (insert ind))
10851 (goto-char (point-max))
10852 (backward-delete-char 1)))
10853 (goto-char beg))
10854 (t nil))))
10856 (defvar org-show-positions nil)
10858 (defun org-table-show-reference (&optional local)
10859 "Show the location/value of the $ expression at point."
10860 (interactive)
10861 (org-table-remove-rectangle-highlight)
10862 (catch 'exit
10863 (let ((pos (if local (point) org-pos))
10864 (face2 'highlight)
10865 (org-inhibit-highlight-removal t)
10866 (win (selected-window))
10867 (org-show-positions nil)
10868 var name e what match dest)
10869 (if local (org-table-get-specials))
10870 (setq what (cond
10871 ((or (org-at-regexp-p org-table-range-regexp2)
10872 (org-at-regexp-p org-table-translate-regexp)
10873 (org-at-regexp-p org-table-range-regexp))
10874 (setq match
10875 (save-match-data
10876 (org-table-convert-refs-to-rc (match-string 0))))
10877 'range)
10880 ((not local) nil)
10881 (t (error "No reference at point")))
10882 match (and what (or match (match-string 0))))
10883 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10884 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10885 'secondary-selection))
10886 (org-add-hook 'before-change-functions
10887 'org-table-remove-rectangle-highlight)
10888 (if (eq what 'name) (setq var (substring match 1)))
10889 (when (eq what 'range)
10890 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10891 (setq match (org-table-formula-substitute-names match)))
10892 (unless local
10893 (save-excursion
10894 (end-of-line 1)
10896 (beginning-of-line 1)
10898 (setq dest
10899 (save-match-data
10900 (org-table-convert-refs-to-rc (match-string 1))))
10901 (org-table-add-rectangle-overlay
10902 (match-beginning 1) (match-end 1) face2))))
10903 (if (and (markerp pos) (marker-buffer pos))
10904 (if (get-buffer-window (marker-buffer pos))
10905 (select-window (get-buffer-window (marker-buffer pos)))
10906 (org-switch-to-buffer-other-window (get-buffer-window
10907 (marker-buffer pos)))))
10908 (goto-char pos)
10909 (org-table-force-dataline)
10910 (when dest
10911 (setq name (substring dest 1))
10912 (cond
10914 (setq e (assoc name org-table-named-field-locations))
10915 (goto-line (nth 1 e))
10916 (org-table-goto-column (nth 2 e)))
10918 (let ((l (string-to-number (match-string 1 dest)))
10919 (c (string-to-number (match-string 2 dest))))
10920 (goto-line (aref org-table-dlines l))
10921 (org-table-goto-column c)))
10922 (t (org-table-goto-column (string-to-number name))))
10923 (move-marker pos (point))
10924 (org-table-highlight-rectangle nil nil face2))
10925 (cond
10926 ((equal dest match))
10927 ((not match))
10928 ((eq what 'range)
10929 (condition-case nil
10930 (save-excursion
10931 (org-table-get-range match nil nil 'highlight))
10932 (error nil)))
10933 ((setq e (assoc var org-table-named-field-locations))
10934 (goto-line (nth 1 e))
10935 (org-table-goto-column (nth 2 e))
10936 (org-table-highlight-rectangle (point) (point))
10937 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10938 ((setq e (assoc var org-table-column-names))
10939 (org-table-goto-column (string-to-number (cdr e)))
10940 (org-table-highlight-rectangle (point) (point))
10941 (goto-char (org-table-begin))
10943 (org-table-end) t)
10944 (progn
10945 (goto-char (match-beginning 1))
10946 (org-table-highlight-rectangle)
10947 (message "Named column (column %s)" (cdr e)))
10948 (error "Column name not found")))
10949 ((eq what 'column)
10950 ;; column number
10951 (org-table-goto-column (string-to-number (substring match 1)))
10952 (org-table-highlight-rectangle (point) (point))
10953 (message "Column %s" (substring match 1)))
10954 ((setq e (assoc var org-table-local-parameters))
10955 (goto-char (org-table-begin))
10957 (progn
10958 (goto-char (match-beginning 1))
10959 (org-table-highlight-rectangle)
10960 (message "Local parameter."))
10961 (error "Parameter not found")))
10962 (t
10963 (cond
10964 ((not var) (error "No reference at point"))
10965 ((setq e (assoc var org-table-formula-constants-local))
10966 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10967 var (cdr e)))
10968 ((setq e (assoc var org-table-formula-constants))
10969 (message "Constant: $%s=%s in `org-table-formula-constants'."
10970 var (cdr e)))
10971 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10972 (message "Constant: $%s=%s, from `constants.el'%s."
10973 var e (format " (%s units)" constants-unit-system)))
10974 (t (error "Undefined name $%s" var)))))
10975 (goto-char pos)
10976 (when (and org-show-positions
10977 (not (memq this-command '(org-table-fedit-scroll
10978 org-table-fedit-scroll-down))))
10979 (push pos org-show-positions)
10980 (push org-table-current-begin-pos org-show-positions)
10981 (let ((min (apply 'min org-show-positions))
10982 (max (apply 'max org-show-positions)))
10983 (goto-char min) (recenter 0)
10984 (goto-char max)
10985 (or (pos-visible-in-window-p max) (recenter -1))))
10986 (select-window win))))
10988 (defun org-table-force-dataline ()
10989 "Make sure the cursor is in a dataline in a table."
10990 (unless (save-excursion
10991 (beginning-of-line 1)
10992 (looking-at org-table-dataline-regexp))
10993 (let* ((re org-table-dataline-regexp)
10994 (p1 (save-excursion (re-search-forward re nil 'move)))
10995 (p2 (save-excursion (re-search-backward re nil 'move))))
10996 (cond ((and p1 p2)
10997 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10998 p1 p2)))
10999 ((or p1 p2) (goto-char (or p1 p2)))
11000 (t (error "No table dataline around here"))))))
11002 (defun org-table-fedit-line-up ()
11003 "Move cursor one line up in the window showing the table."
11004 (interactive)
11005 (org-table-fedit-move 'previous-line))
11007 (defun org-table-fedit-line-down ()
11008 "Move cursor one line down in the window showing the table."
11009 (interactive)
11010 (org-table-fedit-move 'next-line))
11012 (defun org-table-fedit-move (command)
11013 "Move the cursor in the window shoinw the table.
11014 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11015 (let ((org-table-allow-automatic-line-recalculation nil)
11016 (pos org-pos) (win (selected-window)) p)
11017 (select-window (get-buffer-window (marker-buffer org-pos)))
11018 (setq p (point))
11019 (call-interactively command)
11020 (while (and (org-at-table-p)
11021 (org-at-table-hline-p))
11022 (call-interactively command))
11023 (or (org-at-table-p) (goto-char p))
11024 (move-marker pos (point))
11025 (select-window win)))
11027 (defun org-table-fedit-scroll (N)
11028 (interactive "p")
11029 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11030 (scroll-other-window N)))
11032 (defun org-table-fedit-scroll-down (N)
11033 (interactive "p")
11034 (org-table-fedit-scroll (- N)))
11036 (defvar org-table-rectangle-overlays nil)
11038 (defun org-table-add-rectangle-overlay (beg end &optional face)
11039 "Add a new overlay."
11040 (let ((ov (org-make-overlay beg end)))
11041 (org-overlay-put ov 'face (or face 'secondary-selection))
11042 (push ov org-table-rectangle-overlays)))
11044 (defun org-table-highlight-rectangle (&optional beg end face)
11045 "Highlight rectangular region in a table."
11046 (setq beg (or beg (point)) end (or end (point)))
11047 (let ((b (min beg end))
11048 (e (max beg end))
11049 l1 c1 l2 c2 tmp)
11050 (and (boundp 'org-show-positions)
11051 (setq org-show-positions (cons b (cons e org-show-positions))))
11052 (goto-char (min beg end))
11053 (setq l1 (org-current-line)
11054 c1 (org-table-current-column))
11055 (goto-char (max beg end))
11056 (setq l2 (org-current-line)
11057 c2 (org-table-current-column))
11058 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11059 (goto-line l1)
11060 (beginning-of-line 1)
11061 (loop for line from l1 to l2 do
11062 (when (looking-at org-table-dataline-regexp)
11063 (org-table-goto-column c1)
11065 (org-table-goto-column c2)
11067 (org-table-add-rectangle-overlay beg end face))
11068 (beginning-of-line 2))
11069 (goto-char b))
11070 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11072 (defun org-table-remove-rectangle-highlight (&rest ignore)
11073 "Remove the rectangle overlays."
11074 (unless org-inhibit-highlight-removal
11075 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11076 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11077 (setq org-table-rectangle-overlays nil)))
11079 (defvar org-table-coordinate-overlays nil
11080 "Collects the cooordinate grid overlays, so that they can be removed.")
11081 (make-variable-buffer-local 'org-table-coordinate-overlays)
11083 (defun org-table-overlay-coordinates ()
11084 "Add overlays to the table at point, to show row/column coordinates."
11085 (interactive)
11086 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11087 (setq org-table-coordinate-overlays nil)
11088 (save-excursion
11089 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11090 (goto-char (org-table-begin))
11091 (while (org-at-table-p)
11092 (setq eol (point-at-eol))
11093 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11094 (push ov org-table-coordinate-overlays)
11095 (setq hline (looking-at org-table-hline-regexp))
11096 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11097 (format "%4d" (setq id (1+ id)))))
11098 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11099 (when hline
11100 (setq ic 0)
11102 (setq beg (1+ (match-beginning 0))
11103 ic (1+ ic)
11104 s1 (concat "$" (int-to-string ic))
11105 s2 (org-number-to-letters ic)
11106 str (if (eq org-table-use-standard-references t) s2 s1))
11107 (setq ov (org-make-overlay beg (+ beg (length str))))
11108 (push ov org-table-coordinate-overlays)
11109 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11110 (beginning-of-line 2)))))
11112 (defun org-table-toggle-coordinate-overlays ()
11113 "Toggle the display of Row/Column numbers in tables."
11114 (interactive)
11115 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11116 (message "Row/Column number display turned %s"
11117 (if org-table-overlay-coordinates "on" "off"))
11118 (if (and (org-at-table-p) org-table-overlay-coordinates)
11119 (org-table-align))
11120 (unless org-table-overlay-coordinates
11121 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11122 (setq org-table-coordinate-overlays nil)))
11124 (defun org-table-toggle-formula-debugger ()
11125 "Toggle the formula debugger in tables."
11126 (interactive)
11127 (setq org-table-formula-debug (not org-table-formula-debug))
11128 (message "Formula debugging has been turned %s"
11129 (if org-table-formula-debug "on" "off")))
11131 ;;; The orgtbl minor mode
11133 ;; Define a minor mode which can be used in other modes in order to
11134 ;; integrate the org-mode table editor.
11136 ;; This is really a hack, because the org-mode table editor uses several
11137 ;; keys which normally belong to the major mode, for example the TAB and
11138 ;; RET keys. Here is how it works: The minor mode defines all the keys
11139 ;; necessary to operate the table editor, but wraps the commands into a
11140 ;; function which tests if the cursor is currently inside a table. If that
11141 ;; is the case, the table editor command is executed. However, when any of
11142 ;; those keys is used outside a table, the function uses `key-binding' to
11143 ;; look up if the key has an associated command in another currently active
11144 ;; keymap (minor modes, major mode, global), and executes that command.
11145 ;; There might be problems if any of the keys used by the table editor is
11146 ;; otherwise used as a prefix key.
11148 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11149 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11150 ;; addresses this by checking explicitly for both bindings.
11152 ;; The optimized version (see variable `orgtbl-optimized') takes over
11153 ;; all keys which are bound to `self-insert-command' in the *global map*.
11154 ;; Some modes bind other commands to simple characters, for example
11155 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11156 ;; active, this binding is ignored inside tables and replaced with a
11157 ;; modified self-insert.
11159 (defvar orgtbl-mode nil
11160 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11161 table editor in arbitrary modes.")
11162 (make-variable-buffer-local 'orgtbl-mode)
11164 (defvar orgtbl-mode-map (make-keymap)
11165 "Keymap for `orgtbl-mode'.")
11167 ;;;###autoload
11168 (defun turn-on-orgtbl ()
11169 "Unconditionally turn on `orgtbl-mode'."
11170 (orgtbl-mode 1))
11172 (defvar org-old-auto-fill-inhibit-regexp nil
11173 "Local variable used by `orgtbl-mode'")
11176 "Matches a line belonging to an orgtbl.")
11178 (defconst orgtbl-extra-font-lock-keywords
11179 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11180 0 (quote 'org-table) 'prepend))
11181 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11183 ;;;###autoload
11184 (defun orgtbl-mode (&optional arg)
11185 "The `org-mode' table editor as a minor mode for use in other modes."
11186 (interactive)
11187 (if (org-mode-p)
11188 ;; Exit without error, in case some hook functions calls this
11189 ;; by accident in org-mode.
11190 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11191 (setq orgtbl-mode
11192 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11193 (if orgtbl-mode
11194 (progn
11195 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11196 ;; Make sure we are first in minor-mode-map-alist
11197 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11198 (and c (setq minor-mode-map-alist
11199 (cons c (delq c minor-mode-map-alist)))))
11200 (org-set-local (quote org-table-may-need-update) t)
11201 (org-add-hook 'before-change-functions 'org-before-change-function
11202 nil 'local)
11203 (org-set-local 'org-old-auto-fill-inhibit-regexp
11204 auto-fill-inhibit-regexp)
11205 (org-set-local 'auto-fill-inhibit-regexp
11206 (if auto-fill-inhibit-regexp
11208 auto-fill-inhibit-regexp)
11209 orgtbl-line-start-regexp))
11210 (org-add-to-invisibility-spec '(org-cwidth))
11211 (when (fboundp 'font-lock-add-keywords)
11212 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11213 (org-restart-font-lock))
11214 (easy-menu-add orgtbl-mode-menu)
11215 (run-hooks 'orgtbl-mode-hook))
11216 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11217 (org-cleanup-narrow-column-properties)
11218 (org-remove-from-invisibility-spec '(org-cwidth))
11219 (remove-hook 'before-change-functions 'org-before-change-function t)
11220 (when (fboundp 'font-lock-remove-keywords)
11221 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11222 (org-restart-font-lock))
11223 (easy-menu-remove orgtbl-mode-menu)
11224 (force-mode-line-update 'all))))
11226 (defun org-cleanup-narrow-column-properties ()
11227 "Remove all properties related to narrow-column invisibility."
11228 (let ((s 1))
11229 (while (setq s (text-property-any s (point-max)
11230 'display org-narrow-column-arrow))
11231 (remove-text-properties s (1+ s) '(display t)))
11232 (setq s 1)
11233 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11234 (remove-text-properties s (1+ s) '(org-cwidth t)))
11235 (setq s 1)
11236 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11237 (remove-text-properties s (1+ s) '(invisible t)))))
11239 ;; Install it as a minor mode.
11240 (put 'orgtbl-mode :included t)
11241 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11242 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11244 (defun orgtbl-make-binding (fun n &rest keys)
11245 "Create a function for binding in the table minor mode.
11246 FUN is the command to call inside a table. N is used to create a unique
11247 command name. KEYS are keys that should be checked in for a command
11248 to execute outside of tables."
11249 (eval
11250 (list 'defun
11251 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11252 '(arg)
11254 "Outside of tables, run the binding of `"
11255 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11256 "'.")
11257 '(interactive "p")
11258 (list 'if
11259 '(org-at-table-p)
11260 (list 'call-interactively (list 'quote fun))
11261 (list 'let '(orgtbl-mode)
11262 (list 'call-interactively
11263 (append '(or)
11264 (mapcar (lambda (k)
11265 (list 'key-binding k))
11266 keys)
11267 '('orgtbl-error))))))))
11269 (defun orgtbl-error ()
11270 "Error when there is no default binding for a table key."
11271 (interactive)
11272 (error "This key has no function outside tables"))
11274 (defun orgtbl-setup ()
11275 "Setup orgtbl keymaps."
11276 (let ((nfunc 0)
11277 (bindings
11278 (list
11279 '([(meta shift left)] org-table-delete-column)
11280 '([(meta left)] org-table-move-column-left)
11281 '([(meta right)] org-table-move-column-right)
11282 '([(meta shift right)] org-table-insert-column)
11283 '([(meta shift up)] org-table-kill-row)
11284 '([(meta shift down)] org-table-insert-row)
11285 '([(meta up)] org-table-move-row-up)
11286 '([(meta down)] org-table-move-row-down)
11287 '("\C-c\C-w" org-table-cut-region)
11288 '("\C-c\M-w" org-table-copy-region)
11289 '("\C-c\C-y" org-table-paste-rectangle)
11290 '("\C-c-" org-table-insert-hline)
11291 '("\C-c}" org-table-toggle-coordinate-overlays)
11292 '("\C-c{" org-table-toggle-formula-debugger)
11293 '("\C-m" org-table-next-row)
11294 '([(shift return)] org-table-copy-down)
11295 '("\C-c\C-q" org-table-wrap-region)
11296 '("\C-c?" org-table-field-info)
11297 '("\C-c " org-table-blank-field)
11298 '("\C-c+" org-table-sum)
11299 '("\C-c=" org-table-eval-formula)
11300 '("\C-c'" org-table-edit-formulas)
11301 '("\C-c`" org-table-edit-field)
11302 '("\C-c*" org-table-recalculate)
11303 '("\C-c|" org-table-create-or-convert-from-region)
11304 '("\C-c^" org-table-sort-lines)
11305 '([(control ?#)] org-table-rotate-recalc-marks)))
11306 elt key fun cmd)
11307 (while (setq elt (pop bindings))
11308 (setq nfunc (1+ nfunc))
11309 (setq key (org-key (car elt))
11310 fun (nth 1 elt)
11311 cmd (orgtbl-make-binding fun nfunc key))
11312 (org-defkey orgtbl-mode-map key cmd))
11314 ;; Special treatment needed for TAB and RET
11315 (org-defkey orgtbl-mode-map [(return)]
11316 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11317 (org-defkey orgtbl-mode-map "\C-m"
11318 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11320 (org-defkey orgtbl-mode-map [(tab)]
11321 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11322 (org-defkey orgtbl-mode-map "\C-i"
11323 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11325 (org-defkey orgtbl-mode-map [(shift tab)]
11326 (orgtbl-make-binding 'org-table-previous-field 104
11327 [(shift tab)] [(tab)] "\C-i"))
11329 (org-defkey orgtbl-mode-map "\M-\C-m"
11330 (orgtbl-make-binding 'org-table-wrap-region 105
11331 "\M-\C-m" [(meta return)]))
11332 (org-defkey orgtbl-mode-map [(meta return)]
11333 (orgtbl-make-binding 'org-table-wrap-region 106
11334 [(meta return)] "\M-\C-m"))
11336 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11337 (when orgtbl-optimized
11338 ;; If the user wants maximum table support, we need to hijack
11339 ;; some standard editing functions
11340 (org-remap orgtbl-mode-map
11341 'self-insert-command 'orgtbl-self-insert-command
11342 'delete-char 'org-delete-char
11343 'delete-backward-char 'org-delete-backward-char)
11344 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11345 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11346 '("OrgTbl"
11347 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11348 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11349 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11350 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11351 "--"
11352 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11353 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11354 ["Copy Field from Above"
11355 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11356 "--"
11357 ("Column"
11358 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11359 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11360 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11361 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11362 ("Row"
11363 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11364 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11365 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11366 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11367 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11368 "--"
11369 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11370 ("Rectangle"
11371 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11372 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11373 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11374 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11375 "--"
11376 ("Radio tables"
11377 ["Insert table template" orgtbl-insert-radio-table
11378 (assq major-mode orgtbl-radio-table-templates)]
11379 ["Comment/uncomment table" orgtbl-toggle-comment t])
11380 "--"
11381 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11382 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11383 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11384 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11385 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11386 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11387 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11388 ["Sum Column/Rectangle" org-table-sum
11389 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11390 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11391 ["Debug Formulas"
11392 org-table-toggle-formula-debugger :active (org-at-table-p)
11393 :keys "C-c {"
11394 :style toggle :selected org-table-formula-debug]
11395 ["Show Col/Row Numbers"
11396 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11397 :keys "C-c }"
11398 :style toggle :selected org-table-overlay-coordinates]
11399 ))
11400 t))
11402 (defun orgtbl-ctrl-c-ctrl-c (arg)
11403 "If the cursor is inside a table, realign the table.
11404 It it is a table to be sent away to a receiver, do it.
11405 With prefix arg, also recompute table."
11406 (interactive "P")
11407 (let ((pos (point)) action)
11408 (save-excursion
11409 (beginning-of-line 1)
11413 (cond
11414 ((integerp action)
11415 (goto-char action)
11416 (org-table-maybe-eval-formula)
11417 (if arg
11418 (call-interactively 'org-table-recalculate)
11419 (org-table-maybe-recalculate-line))
11420 (call-interactively 'org-table-align)
11421 (orgtbl-send-table 'maybe))
11422 ((eq action 'recalc)
11423 (save-excursion
11424 (beginning-of-line 1)
11426 (if (org-at-table-p)
11427 (org-call-with-arg 'org-table-recalculate t))))
11428 (t (let (orgtbl-mode)
11429 (call-interactively (key-binding "\C-c\C-c")))))))
11431 (defun orgtbl-tab (arg)
11432 "Justification and field motion for `orgtbl-mode'."
11433 (interactive "P")
11434 (if arg (org-table-edit-field t)
11435 (org-table-justify-field-maybe)
11436 (org-table-next-field)))
11438 (defun orgtbl-ret ()
11439 "Justification and field motion for `orgtbl-mode'."
11440 (interactive)
11441 (org-table-justify-field-maybe)
11442 (org-table-next-row))
11444 (defun orgtbl-self-insert-command (N)
11445 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11446 If the cursor is in a table looking at whitespace, the whitespace is
11447 overwritten, and the table is not marked as requiring realignment."
11448 (interactive "p")
11449 (if (and (org-at-table-p)
11450 (or
11451 (and org-table-auto-blank-field
11452 (member last-command
11453 '(orgtbl-hijacker-command-100
11454 orgtbl-hijacker-command-101
11455 orgtbl-hijacker-command-102
11456 orgtbl-hijacker-command-103
11457 orgtbl-hijacker-command-104
11458 orgtbl-hijacker-command-105))
11459 (org-table-blank-field))
11460 t)
11461 (eq N 1)
11463 (let (org-table-may-need-update)
11464 (goto-char (1- (match-end 0)))
11465 (delete-backward-char 1)
11466 (goto-char (match-beginning 0))
11467 (self-insert-command N))
11468 (setq org-table-may-need-update t)
11469 (let (orgtbl-mode)
11470 (call-interactively (key-binding (vector last-input-event))))))
11472 (defun org-force-self-insert (N)
11473 "Needed to enforce self-insert under remapping."
11474 (interactive "p")
11475 (self-insert-command N))
11478 "Regula expression matching exponentials as produced by calc.")
11480 (defvar org-table-clean-did-remove-column nil)
11482 (defun orgtbl-export (table target)
11483 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11485 org-table-last-alignment org-table-last-column-widths
11486 maxcol column)
11487 (if (not (fboundp func))
11488 (error "Cannot export orgtbl table to %s" target))
11489 (setq lines (org-table-clean-before-export lines))
11490 (setq table
11491 (mapcar
11492 (lambda (x)
11493 (if (string-match org-table-hline-regexp x)
11494 'hline
11496 lines))
11497 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11498 table)))
11499 (loop for i from (1- maxcol) downto 0 do
11500 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11501 (setq column (delq nil column))
11502 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11503 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
11504 (funcall func table nil)))
11506 (defun orgtbl-send-table (&optional maybe)
11507 "Send a tranformed version of this table to the receiver position.
11508 With argument MAYBE, fail quietly if no transformation is defined for
11509 this table."
11510 (interactive)
11511 (catch 'exit
11512 (unless (org-at-table-p) (error "Not at a table"))
11513 ;; when non-interactive, we assume align has just happened.
11514 (when (interactive-p) (org-table-align))
11515 (save-excursion
11516 (goto-char (org-table-begin))
11517 (beginning-of-line 0)
11519 (if maybe
11520 (throw 'exit nil)
11521 (error "Don't know how to transform this table."))))
11522 (let* ((name (match-string 1))
11523 beg
11524 (transform (intern (match-string 2)))
11525 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11526 (skip (plist-get params :skip))
11527 (skipcols (plist-get params :skipcols))
11528 (txt (buffer-substring-no-properties
11529 (org-table-begin) (org-table-end)))
11531 (lines (org-table-clean-before-export lines))
11532 (i0 (if org-table-clean-did-remove-column 2 1))
11533 (table (mapcar
11534 (lambda (x)
11535 (if (string-match org-table-hline-regexp x)
11536 'hline
11537 (org-remove-by-index
11539 skipcols i0)))
11540 lines))
11541 (fun (if (= i0 2) 'cdr 'identity))
11542 (org-table-last-alignment
11543 (org-remove-by-index (funcall fun org-table-last-alignment)
11544 skipcols i0))
11545 (org-table-last-column-widths
11546 (org-remove-by-index (funcall fun org-table-last-column-widths)
11547 skipcols i0)))
11549 (unless (fboundp transform)
11550 (error "No such transformation function %s" transform))
11551 (setq txt (funcall transform table params))
11552 ;; Find the insertion place
11553 (save-excursion
11554 (goto-char (point-min))
11555 (unless (re-search-forward
11557 (error "Don't know where to insert translated table"))
11558 (goto-char (match-beginning 0))
11559 (beginning-of-line 2)
11560 (setq beg (point))
11561 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11562 (error "Cannot find end of insertion region"))
11563 (beginning-of-line 1)
11564 (delete-region beg (point))
11565 (goto-char beg)
11567 (message "Table converted and installed at receiver location"))))
11569 (defun org-remove-by-index (list indices &optional i0)
11570 "Remove the elements in LIST with indices in INDICES.
11571 First element has index 0, or I0 if given."
11572 (if (not indices)
11573 list
11574 (if (integerp indices) (setq indices (list indices)))
11575 (setq i0 (1- (or i0 0)))
11576 (delq :rm (mapcar (lambda (x)
11577 (setq i0 (1+ i0))
11578 (if (memq i0 indices) :rm x))
11579 list))))
11581 (defun orgtbl-toggle-comment ()
11582 "Comment or uncomment the orgtbl at point."
11583 (interactive)
11584 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11585 (re2 (concat "^" orgtbl-line-start-regexp))
11586 (commented (save-excursion (beginning-of-line 1)
11587 (cond ((looking-at re1) t)
11588 ((looking-at re2) nil)
11589 (t (error "Not at an org table")))))
11590 (re (if commented re1 re2))
11591 beg end)
11592 (save-excursion
11593 (beginning-of-line 1)
11594 (while (looking-at re) (beginning-of-line 0))
11595 (beginning-of-line 2)
11596 (setq beg (point))
11597 (while (looking-at re) (beginning-of-line 2))
11598 (setq end (point)))
11599 (comment-region beg end (if commented '(4) nil))))
11601 (defun orgtbl-insert-radio-table ()
11602 "Insert a radio table template appropriate for this major mode."
11603 (interactive)
11604 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11605 (txt (nth 1 e))
11606 name pos)
11607 (unless e (error "No radio table setup defined for %s" major-mode))
11608 (setq name (read-string "Table name: "))
11609 (while (string-match "%n" txt)
11610 (setq txt (replace-match name t t txt)))
11612 (setq pos (point))
11613 (insert txt)
11614 (goto-char pos)))
11616 (defun org-get-param (params header i sym &optional hsym)
11617 "Get parameter value for symbol SYM.
11618 If this is a header line, actually get the value for the symbol with an
11620 If the value is a protperty list, get the element for the current column.
11621 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11622 (let ((val (plist-get params sym)))
11623 (and hsym header (setq val (or (plist-get params hsym) val)))
11624 (if (consp val) (plist-get val i) val)))
11626 (defun orgtbl-to-generic (table params)
11627 "Convert the orgtbl-mode TABLE to some other format.
11628 This generic routine can be used for many standard cases.
11629 TABLE is a list, each entry either the symbol `hline' for a horizontal
11630 separator line, or a list of fields for that line.
11631 PARAMS is a property list of parameters that can influence the conversion.
11632 For the generic converter, some parameters are obligatory: You need to
11633 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11634 :splice, you must have :tstart and :tend.
11636 Valid parameters are
11638 :tstart String to start the table. Ignored when :splice is t.
11639 :tend String to end the table. Ignored when :splice is t.
11641 :splice When set to t, return only table body lines, don't wrap
11642 them into :tstart and :tend. Default is nil.
11644 :hline String to be inserted on horizontal separation lines.
11645 May be nil to ignore hlines.
11647 :lstart String to start a new table line.
11648 :lend String to end a table line
11649 :sep Separator between two fields
11650 :lfmt Format for entire line, with enough %s to capture all fields.
11651 If this is present, :lstart, :lend, and :sep are ignored.
11652 :fmt A format to be used to wrap the field, should contain
11653 %s for the original field value. For example, to wrap
11655 This may also be a property list with column numbers and
11658 :hlstart :hlend :hlsep :hlfmt :hfmt
11659 Same as above, specific for the header lines in the table.
11660 All lines before the first hline are treated as header.
11661 If any of these is not present, the data line value is used.
11663 :efmt Use this format to print numbers with exponentials.
11664 The format should have %s twice for inserting mantissa
11666 may also be a property list with column numbers and
11667 formats. :fmt will still be applied after :efmt.
11669 In addition to this, the parameters :skip and :skipcols are always handled
11670 directly by `orgtbl-send-table'. See manual."
11671 (interactive)
11672 (let* ((p params)
11673 (splicep (plist-get p :splice))
11674 (hline (plist-get p :hline))
11675 rtn line i fm efm lfmt h)
11677 ;; Do we have a header?
11678 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11679 (setq h t))
11681 ;; Put header
11682 (unless splicep
11683 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11685 ;; Now loop over all lines
11686 (while (setq line (pop table))
11687 (if (eq line 'hline)
11688 ;; A horizontal separator line
11689 (progn (if hline (push hline rtn))
11690 (setq h nil)) ; no longer in header
11691 ;; A normal line. Convert the fields, push line onto the result list
11692 (setq i 0)
11693 (setq line
11694 (mapcar
11695 (lambda (f)
11696 (setq i (1+ i)
11697 fm (org-get-param p h i :fmt :hfmt)
11698 efm (org-get-param p h i :efmt))
11699 (if (and efm (string-match orgtbl-exp-regexp f))
11700 (setq f (format
11701 efm (match-string 1 f) (match-string 2 f))))
11702 (if fm (setq f (format fm f)))
11703 f)
11704 line))
11705 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11706 (push (apply 'format lfmt line) rtn)
11707 (push (concat
11708 (org-get-param p h i :lstart :hlstart)
11709 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11710 (org-get-param p h i :lend :hlend))
11711 rtn))))
11713 (unless splicep
11714 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11718 (defun orgtbl-to-latex (table params)
11719 "Convert the orgtbl-mode TABLE to LaTeX.
11720 TABLE is a list, each entry either the symbol `hline' for a horizontal
11721 separator line, or a list of fields for that line.
11722 PARAMS is a property list of parameters that can influence the conversion.
11723 Supports all parameters from `orgtbl-to-generic'. Most important for
11724 LaTeX are:
11726 :splice When set to t, return only table body lines, don't wrap
11727 them into a tabular environment. Default is nil.
11729 :fmt A format to be used to wrap the field, should contain %s for the
11730 original field value. For example, to wrap everything in dollars,
11734 :efmt Format for transforming numbers with exponentials. The format
11735 should have %s twice for inserting mantissa and exponent, for
11737 This may also be a property list with column numbers and formats.
11739 The general parameters :skip and :skipcols have already been applied when
11740 this function is called."
11741 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11742 org-table-last-alignment ""))
11743 (params2
11744 (list
11749 (orgtbl-to-generic table (org-combine-plists params2 params))))
11751 (defun orgtbl-to-html (table params)
11752 "Convert the orgtbl-mode TABLE to LaTeX.
11753 TABLE is a list, each entry either the symbol `hline' for a horizontal
11754 separator line, or a list of fields for that line.
11755 PARAMS is a property list of parameters that can influence the conversion.
11756 Currently this function recognizes the following parameters:
11758 :splice When set to t, return only table body lines, don't wrap
11759 them into a <table> environment. Default is nil.
11761 The general parameters :skip and :skipcols have already been applied when
11762 this function is called. The function does *not* use `orgtbl-to-generic',
11763 so you cannot specify parameters for it."
11764 (let* ((splicep (plist-get params :splice))
11765 html)
11766 ;; Just call the formatter we already have
11767 ;; We need to make text lines for it, so put the fields back together.
11768 (setq html (org-format-org-table-html
11769 (mapcar
11770 (lambda (x)
11771 (if (eq x 'hline)
11772 "|----+----|"
11773 (concat "| " (mapconcat 'identity x " | ") " |")))
11774 table)
11775 splicep))
11777 (setq html (replace-match "" t t html)))
11778 html))
11780 (defun orgtbl-to-texinfo (table params)
11781 "Convert the orgtbl-mode TABLE to TeXInfo.
11782 TABLE is a list, each entry either the symbol `hline' for a horizontal
11783 separator line, or a list of fields for that line.
11784 PARAMS is a property list of parameters that can influence the conversion.
11785 Supports all parameters from `orgtbl-to-generic'. Most important for
11786 TeXInfo are:
11788 :splice nil/t When set to t, return only table body lines, don't wrap
11789 them into a multitable environment. Default is nil.
11791 :fmt fmt A format to be used to wrap the field, should contain
11792 %s for the original field value. For example, to wrap
11794 This may also be a property list with column numbers and
11798 are computed automatically from the width of the columns
11799 under org-mode.
11801 The general parameters :skip and :skipcols have already been applied when
11802 this function is called."
11803 (let* ((total (float (apply '+ org-table-last-column-widths)))
11804 (colfrac (or (plist-get params :cf)
11805 (mapconcat
11806 (lambda (x) (format "%.3f" (/ (float x) total)))
11807 org-table-last-column-widths " ")))
11808 (params2
11809 (list
11810 :tstart (concat "@multitable @columnfractions " colfrac)
11811 :tend "@end multitable"
11812 :lstart "@item " :lend "" :sep " @tab "
11813 :hlstart "@headitem ")))
11814 (orgtbl-to-generic table (org-combine-plists params2 params))))
11816 ;;;; Link Stuff
11818 ;;; Link abbreviations
11820 (defun org-link-expand-abbrev (link)
11821 "Apply replacements as defined in `org-link-abbrev-alist."
11823 (let* ((key (match-string 1 link))
11824 (as (or (assoc key org-link-abbrev-alist-local)
11825 (assoc key org-link-abbrev-alist)))
11826 (tag (and (match-end 2) (match-string 3 link)))
11827 rpl)
11828 (if (not as)
11829 link
11830 (setq rpl (cdr as))
11831 (cond
11832 ((symbolp rpl) (funcall rpl tag))
11833 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11834 (t (concat rpl tag)))))
11835 link))
11837 ;;; Storing and inserting links
11839 (defvar org-insert-link-history nil
11840 "Minibuffer history for links inserted with `org-insert-link'.")
11842 (defvar org-stored-links nil
11843 "Contains the links stored with `org-store-link'.")
11845 (defvar org-store-link-plist nil
11846 "Plist with info about the most recently link created with `org-store-link'.")
11848 (defvar org-link-protocols nil
11849 "Link protocols added to Org-mode using `org-add-link-type'.")
11851 (defvar org-store-link-functions nil
11852 "List of functions that are called to create and store a link.
11853 Each function will be called in turn until one returns a non-nil
11854 value. Each function should check if it is responsible for creating
11855 this link (for example by looking at the major mode).
11856 If not, it must exit and return nil.
11857 If yes, it should return a non-nil value after a calling
11858 `org-store-link-props' with a list of properties and values.
11859 Special properties are:
11863 This is obligatory as well.
11864 :description Optional default description for the second pair
11865 of brackets in an Org-mode link. The user can still change
11866 this when inserting this link into an Org-mode buffer.
11868 In addition to these, any additional properties can be specified
11869 and then used in remember templates.")
11871 (defun org-add-link-type (type &optional follow publish)
11872 "Add TYPE to the list of `org-link-types'.
11873 Re-compute all regular expressions depending on `org-link-types'
11874 FOLLOW and PUBLISH are two functions. Both take the link path as
11875 an argument.
11876 FOLLOW should do whatever is necessary to follow the link, for example
11877 to find a file or display a mail message.
11879 PUBLISH takes the path and retuns the string that should be used when
11880 this document is published. FIMXE: This is actually not yet implemented."
11881 (add-to-list 'org-link-types type t)
11882 (org-make-link-regexps)
11883 (add-to-list 'org-link-protocols
11884 (list type follow publish)))
11886 (defun org-add-agenda-custom-command (entry)
11887 "Replace or add a command in `org-agenda-custom-commands'.
11888 This is mostly for hacking and trying a new command - once the command
11889 works you probably want to add it to `org-agenda-custom-commands' for good."
11890 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11891 (if ass
11892 (setcdr ass (cdr entry))
11893 (push entry org-agenda-custom-commands))))
11895 ;;;###autoload
11896 (defun org-store-link (arg)
11898 This link is added to `org-stored-links' and can later be inserted
11901 For some link types, a prefix arg is interpreted:
11902 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11903 For file links, arg negates `org-context-in-file-links'."
11904 (interactive "P")
11905 (setq org-store-link-plist nil) ; reset
11906 (let (link cpltxt desc description search txt)
11907 (cond
11909 ((run-hook-with-args-until-success 'org-store-link-functions)
11910 (setq link (plist-get org-store-link-plist :link)
11911 desc (or (plist-get org-store-link-plist :description) link)))
11913 ((eq major-mode 'bbdb-mode)
11914 (let ((name (bbdb-record-name (bbdb-current-record)))
11915 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11916 (setq cpltxt (concat "bbdb:" (or name company))
11917 link (org-make-link cpltxt))
11918 (org-store-link-props :type "bbdb" :name name :company company)))
11920 ((eq major-mode 'Info-mode)
11921 (setq link (org-make-link "info:"
11922 (file-name-nondirectory Info-current-file)
11923 ":" Info-current-node))
11924 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11925 ":" Info-current-node))
11926 (org-store-link-props :type "info" :file Info-current-file
11927 :node Info-current-node))
11929 ((eq major-mode 'calendar-mode)
11930 (let ((cd (calendar-cursor-to-date)))
11931 (setq link
11932 (format-time-string
11933 (car org-time-stamp-formats)
11934 (apply 'encode-time
11935 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11936 nil nil nil))))
11937 (org-store-link-props :type "calendar" :date cd)))
11939 ((or (eq major-mode 'vm-summary-mode)
11940 (eq major-mode 'vm-presentation-mode))
11941 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11942 (vm-follow-summary-cursor)
11943 (save-excursion
11944 (vm-select-folder-buffer)
11945 (let* ((message (car vm-message-pointer))
11946 (folder buffer-file-name)
11947 (subject (vm-su-subject message))
11948 (to (vm-get-header-contents message "To"))
11949 (from (vm-get-header-contents message "From"))
11950 (message-id (vm-su-message-id message)))
11951 (org-store-link-props :type "vm" :from from :to to :subject subject
11952 :message-id message-id)
11953 (setq message-id (org-remove-angle-brackets message-id))
11954 (setq folder (abbreviate-file-name folder))
11955 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11956 folder)
11957 (setq folder (replace-match "" t t folder)))
11958 (setq cpltxt (org-email-link-description))
11959 (setq link (org-make-link "vm:" folder "#" message-id)))))
11961 ((eq major-mode 'wl-summary-mode)
11962 (let* ((msgnum (wl-summary-message-number))
11963 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11964 msgnum 'message-id))
11965 (wl-message-entity
11966 (if (fboundp 'elmo-message-entity)
11967 (elmo-message-entity
11968 wl-summary-buffer-elmo-folder msgnum)
11969 (elmo-msgdb-overview-get-entity
11970 msgnum (wl-summary-buffer-msgdb))))
11971 (from (wl-summary-line-from))
11972 (to (car (elmo-message-entity-field wl-message-entity 'to)))
11973 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11974 (wl-summary-line-subject))))
11975 (org-store-link-props :type "wl" :from from :to to
11976 :subject subject :message-id message-id)
11977 (setq message-id (org-remove-angle-brackets message-id))
11978 (setq cpltxt (org-email-link-description))
11979 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11980 "#" message-id))))
11982 ((or (equal major-mode 'mh-folder-mode)
11983 (equal major-mode 'mh-show-mode))
11984 (let ((from (org-mhe-get-header "From:"))
11985 (to (org-mhe-get-header "To:"))
11986 (message-id (org-mhe-get-header "Message-Id:"))
11987 (subject (org-mhe-get-header "Subject:")))
11988 (org-store-link-props :type "mh" :from from :to to
11989 :subject subject :message-id message-id)
11990 (setq cpltxt (org-email-link-description))
11991 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11992 (org-remove-angle-brackets message-id)))))
11994 ((or (eq major-mode 'rmail-mode)
11995 (eq major-mode 'rmail-summary-mode))
11996 (save-window-excursion
11997 (save-restriction
11998 (when (eq major-mode 'rmail-summary-mode)
11999 (rmail-show-message rmail-current-message))
12000 (rmail-narrow-to-non-pruned-header)
12001 (let ((folder buffer-file-name)
12002 (message-id (mail-fetch-field "message-id"))
12003 (from (mail-fetch-field "from"))
12004 (to (mail-fetch-field "to"))
12005 (subject (mail-fetch-field "subject")))
12006 (org-store-link-props
12007 :type "rmail" :from from :to to
12008 :subject subject :message-id message-id)
12009 (setq message-id (org-remove-angle-brackets message-id))
12010 (setq cpltxt (org-email-link-description))
12011 (setq link (org-make-link "rmail:" folder "#" message-id)))
12012 (rmail-show-message rmail-current-message))))
12014 ((eq major-mode 'gnus-group-mode)
12015 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12016 (gnus-group-group-name)) ; version
12017 ((fboundp 'gnus-group-name)
12018 (gnus-group-name))
12019 (t "???"))))
12020 (unless group (error "Not on a group"))
12021 (org-store-link-props :type "gnus" :group group)
12022 (setq cpltxt (concat
12023 (if (org-xor arg org-usenet-links-prefer-google)
12024 "http://groups.google.com/groups?group="
12025 "gnus:")
12026 group)
12027 link (org-make-link cpltxt))))
12029 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12030 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12031 (let* ((group gnus-newsgroup-name)
12032 (article (gnus-summary-article-number))
12033 (header (gnus-summary-article-header article))
12034 (from (mail-header-from header))
12035 (message-id (mail-header-id header))
12036 (date (mail-header-date header))
12037 (subject (gnus-summary-subject-string)))
12038 (org-store-link-props :type "gnus" :from from :subject subject
12039 :message-id message-id :group group)
12040 (setq cpltxt (org-email-link-description))
12041 (if (org-xor arg org-usenet-links-prefer-google)
12042 (setq link
12043 (concat
12045 (format "http://groups.google.com/groups?as_umsgid=%s"
12046 (org-fixup-message-id-for-http message-id))))
12047 (setq link (org-make-link "gnus:" group
12048 "#" (number-to-string article))))))
12050 ((eq major-mode 'w3-mode)
12051 (setq cpltxt (url-view-url t)
12052 link (org-make-link cpltxt))
12053 (org-store-link-props :type "w3" :url (url-view-url t)))
12055 ((eq major-mode 'w3m-mode)
12056 (setq cpltxt (or w3m-current-title w3m-current-url)
12057 link (org-make-link w3m-current-url))
12058 (org-store-link-props :type "w3m" :url (url-view-url t)))
12060 ((setq search (run-hook-with-args-until-success
12061 'org-create-file-search-functions))
12062 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12063 "::" search))
12064 (setq cpltxt (or description link)))
12066 ((eq major-mode 'image-mode)
12067 (setq cpltxt (concat "file:"
12068 (abbreviate-file-name buffer-file-name))
12069 link (org-make-link cpltxt))
12070 (org-store-link-props :type "image" :file buffer-file-name))
12072 ((eq major-mode 'dired-mode)
12073 ;; link to the file in the current line
12074 (setq cpltxt (concat "file:"
12075 (abbreviate-file-name
12076 (expand-file-name
12077 (dired-get-filename nil t))))
12078 link (org-make-link cpltxt)))
12080 ((and buffer-file-name (org-mode-p))
12081 ;; Just link to current headline
12082 (setq cpltxt (concat "file:"
12083 (abbreviate-file-name buffer-file-name)))
12084 ;; Add a context search string
12085 (when (org-xor org-context-in-file-links arg)
12086 ;; Check if we are on a target
12088 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12089 (setq txt (cond
12090 ((org-on-heading-p) nil)
12091 ((org-region-active-p)
12092 (buffer-substring (region-beginning) (region-end)))
12093 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12095 (setq cpltxt
12096 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12097 desc "NONE"))))
12099 (setq cpltxt (substring cpltxt 0 -2)))
12100 (setq link (org-make-link cpltxt)))
12102 ((buffer-file-name (buffer-base-buffer))
12103 ;; Just link to this file here.
12104 (setq cpltxt (concat "file:"
12105 (abbreviate-file-name
12106 (buffer-file-name (buffer-base-buffer)))))
12107 ;; Add a context string
12108 (when (org-xor org-context-in-file-links arg)
12109 (setq txt (if (org-region-active-p)
12110 (buffer-substring (region-beginning) (region-end))
12111 (buffer-substring (point-at-bol) (point-at-eol))))
12112 ;; Only use search option if there is some text.
12114 (setq cpltxt
12115 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12116 desc "NONE")))
12117 (setq link (org-make-link cpltxt)))
12119 ((interactive-p)
12120 (error "Cannot link to a buffer which is not visiting a file"))
12122 (t (setq link nil)))
12124 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12125 (setq link (or link cpltxt)
12126 desc (or desc cpltxt))
12127 (if (equal desc "NONE") (setq desc nil))
12129 (if (and (interactive-p) link)
12130 (progn
12131 (setq org-stored-links
12132 (cons (list link desc) org-stored-links))
12133 (message "Stored: %s" (or desc link)))
12134 (and link (org-make-link-string link desc)))))
12136 (defun org-store-link-props (&rest plist)
12137 "Store link properties, extract names and addresses."
12138 (let (x adr)
12139 (when (setq x (plist-get plist :from))
12140 (setq adr (mail-extract-address-components x))
12141 (plist-put plist :fromname (car adr))
12142 (plist-put plist :fromaddress (nth 1 adr)))
12143 (when (setq x (plist-get plist :to))
12144 (setq adr (mail-extract-address-components x))
12145 (plist-put plist :toname (car adr))
12146 (plist-put plist :toaddress (nth 1 adr))))
12147 (let ((from (plist-get plist :from))
12148 (to (plist-get plist :to)))
12149 (when (and from to org-from-is-user-regexp)
12150 (plist-put plist :fromto
12151 (if (string-match org-from-is-user-regexp from)
12152 (concat "to %t")
12153 (concat "from %f")))))
12154 (setq org-store-link-plist plist))
12156 (defun org-email-link-description (&optional fmt)
12157 "Return the description part of an email link.
12158 This takes information from `org-store-link-plist' and formats it
12159 according to FMT (default from `org-email-link-description-format')."
12160 (setq fmt (or fmt org-email-link-description-format))
12161 (let* ((p org-store-link-plist)
12162 (to (plist-get p :toaddress))
12163 (from (plist-get p :fromaddress))
12164 (table
12165 (list
12166 (cons "%c" (plist-get p :fromto))
12167 (cons "%F" (plist-get p :from))
12168 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12169 (cons "%T" (plist-get p :to))
12170 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12171 (cons "%s" (plist-get p :subject))
12172 (cons "%m" (plist-get p :message-id)))))
12173 (when (string-match "%c" fmt)
12174 ;; Check if the user wrote this message
12175 (if (and org-from-is-user-regexp from to
12176 (save-match-data (string-match org-from-is-user-regexp from)))
12177 (setq fmt (replace-match "to %t" t t fmt))
12178 (setq fmt (replace-match "from %f" t t fmt))))
12179 (org-replace-escapes fmt table)))
12181 (defun org-make-org-heading-search-string (&optional string heading)
12182 "Make search string for STRING or current headline."
12183 (interactive)
12184 (let ((s (or string (org-get-heading))))
12185 (unless (and string (not heading))
12186 ;; We are using a headline, clean up garbage in there.
12187 (if (string-match org-todo-regexp s)
12188 (setq s (replace-match "" t t s)))
12190 (setq s (replace-match "" t t s)))
12191 (setq s (org-trim s))
12194 (setq s (replace-match "" t t s)))
12195 (while (string-match org-ts-regexp s)
12196 (setq s (replace-match "" t t s))))
12198 (setq s (replace-match " " t t s)))
12199 (or string (setq s (concat "*" s))) ; Add * for headlines
12202 (defun org-make-link (&rest strings)
12203 "Concatenate STRINGS."
12204 (apply 'concat strings))
12206 (defun org-make-link-string (link &optional description)
12207 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12209 (error "Empty link"))
12210 (when (stringp description)
12211 ;; Remove brackets from the description, they are fatal.
12213 (setq description (replace-match "{" t t description)))
12215 (setq description (replace-match "}" t t description))))
12216 (when (equal (org-link-escape link) description)
12217 ;; No description needed, it is identical
12218 (setq description nil))
12219 (when (and (not description)
12220 (not (equal link (org-link-escape link))))
12221 (setq description link))
12222 (concat "[[" (org-link-escape link) "]"
12223 (if description (concat "[" description "]") "")
12224 "]"))
12226 (defconst org-link-escape-chars
12227 '((?\ . "%20")
12228 (?\[ . "%5B")
12229 (?\] . "%5D")
12240 (?\; . "%3B")
12241 (?? . "%3F")
12242 (?= . "%3D")
12243 (?+ . "%2B")
12244 )
12245 "Association list of escapes for some characters problematic in links.
12246 This is the list that is used for internal purposes.")
12248 (defconst org-link-escape-chars-browser
12249 '((?\ . "%20")) ; 32 for the SPC char
12250 "Association list of escapes for some characters problematic in links.
12251 This is the list that is used before handing over to the browser.")
12253 (defun org-link-escape (text &optional table)
12254 "Escape charaters in TEXT that are problematic for links."
12255 (setq table (or table org-link-escape-chars))
12256 (when text
12257 (let ((re (mapconcat (lambda (x) (regexp-quote
12258 (char-to-string (car x))))
12260 (while (string-match re text)
12261 (setq text
12262 (replace-match
12263 (cdr (assoc (string-to-char (match-string 0 text))
12264 table))
12265 t t text)))
12266 text)))
12268 (defun org-link-unescape (text &optional table)
12269 "Reverse the action of `org-link-escape'."
12270 (setq table (or table org-link-escape-chars))
12271 (when text
12272 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12274 (while (string-match re text)
12275 (setq text
12276 (replace-match
12277 (char-to-string (car (rassoc (match-string 0 text) table)))
12278 t t text)))
12279 text)))
12281 (defun org-xor (a b)
12282 "Exclusive or."
12283 (if a (not b) b))
12285 (defun org-get-header (header)
12286 "Find a header field in the current buffer."
12287 (save-excursion
12288 (goto-char (point-min))
12289 (let ((case-fold-search t) s)
12290 (cond
12291 ((eq header 'from)
12293 (setq s (match-string 1)))
12295 (setq s (replace-match "" t t s)))
12296 (if (string-match "[<(].*" s)
12297 (setq s (replace-match "" t t s))))
12298 ((eq header 'message-id)
12300 (setq s (match-string 1))))
12301 ((eq header 'subject)
12303 (setq s (match-string 1)))))
12306 s)))
12309 (defun org-fixup-message-id-for-http (s)
12310 "Replace special characters in a message id, so it can be used in an http query."
12311 (while (string-match "<" s)
12312 (setq s (replace-match "%3C" t t s)))
12313 (while (string-match ">" s)
12314 (setq s (replace-match "%3E" t t s)))
12315 (while (string-match "@" s)
12316 (setq s (replace-match "%40" t t s)))
12317 s)
12319 ;;;###autoload
12320 (defun org-insert-link-global ()
12321 "Insert a link like Org-mode does.
12322 This command can be called in any mode to insert a link in Org-mode syntax."
12323 (interactive)
12324 (org-run-like-in-org-mode 'org-insert-link))
12326 (defun org-insert-link (&optional complete-file)
12327 "Insert a link. At the prompt, enter the link.
12329 Completion can be used to select a link previously stored with
12330 `org-store-link'. When the empty string is entered (i.e. if you just
12331 press RET at the prompt), the link defaults to the most recently
12332 stored link. As SPC triggers completion in the minibuffer, you need to
12333 use M-SPC or C-q SPC to force the insertion of a space character.
12335 You will also be prompted for a description, and if one is given, it will
12336 be displayed in the buffer instead of the link.
12338 If there is already a link at point, this command will allow you to edit link
12339 and description parts.
12342 selected using completion. The path to the file will be relative to
12343 the current directory if the file is in the current directory or a
12344 subdirectory. Otherwise, the link will be the absolute path as
12345 completed in the minibuffer (i.e. normally ~/path/to/file).
12348 is in the current directory or below.
12350 `org-keep-stored-link-after-insertion'."
12351 (interactive "P")
12352 (let* ((wcf (current-window-configuration))
12353 (region (if (org-region-active-p)
12354 (buffer-substring (region-beginning) (region-end))))
12355 (remove (and region (list (region-beginning) (region-end))))
12356 (desc region)
12357 tmphist ; byte-compile incorrectly complains about this
12358 link entry file)
12359 (cond
12360 ((org-in-regexp org-bracket-link-regexp 1)
12361 ;; We do have a link at point, and we are going to edit it.
12362 (setq remove (list (match-beginning 0) (match-end 0)))
12363 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12364 (setq link (read-string "Link: "
12365 (org-link-unescape
12366 (org-match-string-no-properties 1)))))
12367 ((or (org-in-regexp org-angle-link-re)
12368 (org-in-regexp org-plain-link-re))
12369 ;; Convert to bracket link
12370 (setq remove (list (match-beginning 0) (match-end 0))
12371 link (read-string "Link: "
12372 (org-remove-angle-brackets (match-string 0)))))
12373 ((equal complete-file '(4))
12374 ;; Completing read for file names.
12375 (setq file (read-file-name "File: "))
12376 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12377 (pwd1 (file-name-as-directory (abbreviate-file-name
12378 (expand-file-name ".")))))
12379 (cond
12380 ((equal complete-file '(16))
12381 (setq link (org-make-link
12382 "file:"
12383 (abbreviate-file-name (expand-file-name file)))))
12385 (setq link (org-make-link "file:" (match-string 1 file))))
12387 (expand-file-name file))
12388 (setq link (org-make-link
12389 "file:" (match-string 1 (expand-file-name file)))))
12390 (t (setq link (org-make-link "file:" file))))))
12391 (t
12392 ;; Read link, with completion for stored links.
12393 (with-output-to-temp-buffer "*Org Links*"
12395 (when org-stored-links
12397 (princ (mapconcat
12398 (lambda (x)
12399 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12401 (let ((cw (selected-window)))
12402 (select-window (get-buffer-window "*Org Links*"))
12403 (shrink-window-if-larger-than-buffer)
12404 (setq truncate-lines t)
12405 (select-window cw))
12406 ;; Fake a link history, containing the stored links.
12407 (setq tmphist (append (mapcar 'car org-stored-links)
12408 org-insert-link-history))
12409 (unwind-protect
12410 (setq link (org-completing-read
12411 "Link: "
12412 (append
12413 (mapcar (lambda (x) (list (concat (car x) ":")))
12414 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12415 (mapcar (lambda (x) (list (concat x ":")))
12416 org-link-types))
12417 nil nil nil
12418 'tmphist
12419 (or (car (car org-stored-links)))))
12420 (set-window-configuration wcf)
12421 (kill-buffer "*Org Links*"))
12422 (setq entry (assoc link org-stored-links))
12423 (or entry (push link org-insert-link-history))
12424 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12425 (not org-keep-stored-link-after-insertion))
12426 (setq org-stored-links (delq (assoc link org-stored-links)
12427 org-stored-links)))
12428 (setq desc (or desc (nth 1 entry)))))
12430 (if (string-match org-plain-link-re link)
12431 ;; URL-like link, normalize the use of angular brackets.
12432 (setq link (org-make-link (org-remove-angle-brackets link))))
12434 ;; Check if we are linking to the current file with a search option
12435 ;; If yes, simplify the link by using only the search option.
12436 (when (and buffer-file-name
12438 (let* ((path (match-string 1 link))
12439 (case-fold-search nil)
12440 (search (match-string 2 link)))
12441 (save-match-data
12442 (if (equal (file-truename buffer-file-name) (file-truename path))
12443 ;; We are linking to this same file, with a search option
12444 (setq link search)))))
12446 ;; Check if we can/should use a relative path. If yes, simplify the link
12448 (let* ((path (match-string 1 link))
12449 (origpath path)
12450 (desc-is-link (equal link desc))
12451 (case-fold-search nil))
12452 (cond
12453 ((eq org-link-file-path-type 'absolute)
12454 (setq path (abbreviate-file-name (expand-file-name path))))
12455 ((eq org-link-file-path-type 'noabbrev)
12456 (setq path (expand-file-name path)))
12457 ((eq org-link-file-path-type 'relative)
12458 (setq path (file-relative-name path)))
12459 (t
12460 (save-match-data
12461 (if (string-match (concat "^" (regexp-quote
12462 (file-name-as-directory
12463 (expand-file-name "."))))
12464 (expand-file-name path))
12465 ;; We are linking a file with relative path name.
12466 (setq path (substring (expand-file-name path)
12467 (match-end 0)))))))
12468 (setq link (concat "file:" path))
12469 (if (equal desc origpath)
12470 (setq desc path))))
12472 (setq desc (read-string "Description: " desc))
12474 (if remove (apply 'delete-region remove))
12475 (insert (org-make-link-string link desc))))
12477 (defun org-completing-read (&rest args)
12478 (let ((minibuffer-local-completion-map
12479 (copy-keymap minibuffer-local-completion-map)))
12480 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12481 (apply 'completing-read args)))
12483 ;;; Opening/following a link
12484 (defvar org-link-search-failed nil)
12486 (defun org-next-link ()
12487 "Move forward to the next link.
12488 If the link is in hidden text, expose it."
12489 (interactive)
12490 (when (and org-link-search-failed (eq this-command last-command))
12491 (goto-char (point-min))
12492 (message "Link search wrapped back to beginning of buffer"))
12493 (setq org-link-search-failed nil)
12494 (let* ((pos (point))
12495 (ct (org-context))
12496 (a (assoc :link ct)))
12497 (if a (goto-char (nth 2 a)))
12498 (if (re-search-forward org-any-link-re nil t)
12499 (progn
12500 (goto-char (match-beginning 0))
12501 (if (org-invisible-p) (org-show-context)))
12502 (goto-char pos)
12503 (setq org-link-search-failed t)
12504 (error "No further link found"))))
12506 (defun org-previous-link ()
12507 "Move backward to the previous link.
12508 If the link is in hidden text, expose it."
12509 (interactive)
12510 (when (and org-link-search-failed (eq this-command last-command))
12511 (goto-char (point-max))
12512 (message "Link search wrapped back to end of buffer"))
12513 (setq org-link-search-failed nil)
12514 (let* ((pos (point))
12515 (ct (org-context))
12516 (a (assoc :link ct)))
12517 (if a (goto-char (nth 1 a)))
12518 (if (re-search-backward org-any-link-re nil t)
12519 (progn
12520 (goto-char (match-beginning 0))
12521 (if (org-invisible-p) (org-show-context)))
12522 (goto-char pos)
12523 (setq org-link-search-failed t)
12524 (error "No further link found"))))
12526 (defun org-find-file-at-mouse (ev)
12527 "Open file link or URL at mouse."
12528 (interactive "e")
12529 (mouse-set-point ev)
12530 (org-open-at-point 'in-emacs))
12532 (defun org-open-at-mouse (ev)
12533 "Open file link or URL at mouse."
12534 (interactive "e")
12535 (mouse-set-point ev)
12536 (org-open-at-point))
12538 (defvar org-window-config-before-follow-link nil
12539 "The window configuration before following a link.
12540 This is saved in case the need arises to restore it.")
12542 (defvar org-open-link-marker (make-marker)
12543 "Marker pointing to the location where `org-open-at-point; was called.")
12545 ;;;###autoload
12546 (defun org-open-at-point-global ()
12547 "Follow a link like Org-mode does.
12548 This command can be called in any mode to follow a link that has
12549 Org-mode syntax."
12550 (interactive)
12551 (org-run-like-in-org-mode 'org-open-at-point))
12553 (defun org-open-at-point (&optional in-emacs)
12554 "Open link at or after point.
12555 If there is no link at point, this function will search forward up to
12556 the end of the current subtree.
12557 Normally, files will be opened by an appropriate application. If the
12558 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12559 (interactive "P")
12560 (catch 'abort
12561 (move-marker org-open-link-marker (point))
12562 (setq org-window-config-before-follow-link (current-window-configuration))
12563 (org-remove-occur-highlights nil nil t)
12564 (if (org-at-timestamp-p t)
12565 (org-follow-timestamp-link)
12566 (let (type path link line search (pos (point)))
12567 (catch 'match
12568 (save-excursion
12570 (when (org-in-regexp org-bracket-link-regexp)
12571 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12573 (setq link (replace-match " " t t link)))
12574 (setq link (org-link-expand-abbrev link))
12575 (if (string-match org-link-re-with-space2 link)
12576 (setq type (match-string 1 link) path (match-string 2 link))
12577 (setq type "thisfile" path link))
12578 (throw 'match t)))
12580 (when (get-text-property (point) 'org-linked-text)
12581 (setq type "thisfile"
12582 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12583 (1+ (point)) (point))
12584 path (buffer-substring
12585 (previous-single-property-change pos 'org-linked-text)
12586 (next-single-property-change pos 'org-linked-text)))
12587 (throw 'match t))
12589 (save-excursion
12590 (when (or (org-in-regexp org-angle-link-re)
12591 (org-in-regexp org-plain-link-re))
12592 (setq type (match-string 1) path (match-string 2))
12593 (throw 'match t)))
12595 (setq type "tree-match"
12596 path (match-string 1))
12597 (throw 'match t))
12598 (save-excursion
12600 (setq type "tags"
12601 path (match-string 1))
12602 (while (string-match ":" path)
12603 (setq path (replace-match "+" t t path)))
12604 (throw 'match t))))
12605 (unless path
12606 (error "No link found"))
12607 ;; Remove any trailing spaces in path
12609 (setq path (replace-match "" t t path)))
12611 (cond
12613 ((assoc type org-link-protocols)
12614 (funcall (nth 1 (assoc type org-link-protocols)) path))
12616 ((equal type "mailto")
12617 (let ((cmd (car org-link-mailto-program))
12618 (args (cdr org-link-mailto-program)) args1
12619 (address path) (subject "") a)
12621 (setq address (match-string 1 path)
12622 subject (org-link-escape (match-string 2 path))))
12623 (while args
12624 (cond
12625 ((not (stringp (car args))) (push (pop args) args1))
12626 (t (setq a (pop args))
12627 (if (string-match "%a" a)
12628 (setq a (replace-match address t t a)))
12629 (if (string-match "%s" a)
12630 (setq a (replace-match subject t t a)))
12631 (push a args1))))
12632 (apply cmd (nreverse args1))))
12634 ((member type '("http" "https" "ftp" "news"))
12635 (browse-url (concat type ":" (org-link-escape
12636 path org-link-escape-chars-browser))))
12638 ((member type '("message"))
12639 (browse-url (concat type ":" path)))
12641 ((string= type "tags")
12642 (org-tags-view in-emacs path))
12643 ((string= type "thisfile")
12644 (if in-emacs
12645 (switch-to-buffer-other-window
12646 (org-get-buffer-for-internal-link (current-buffer)))
12647 (org-mark-ring-push))
12648 (let ((cmd `(org-link-search
12649 ,path
12650 ,(cond ((equal in-emacs '(4)) 'occur)
12651 ((equal in-emacs '(16)) 'org-occur)
12652 (t nil))
12653 ,pos)))
12654 (condition-case nil (eval cmd)
12655 (error (progn (widen) (eval cmd))))))
12657 ((string= type "tree-match")
12660 ((string= type "file")
12662 (setq line (string-to-number (match-string 1 path))
12663 path (substring path 0 (match-beginning 0)))
12665 (setq search (match-string 1 path)
12666 path (substring path 0 (match-beginning 0)))))
12667 (if (string-match "[*?{]" (file-name-nondirectory path))
12668 (dired path)
12669 (org-open-file path in-emacs line search)))
12671 ((string= type "news")
12672 (org-follow-gnus-link path))
12674 ((string= type "bbdb")
12675 (org-follow-bbdb-link path))
12677 ((string= type "info")
12678 (org-follow-info-link path))
12680 ((string= type "gnus")
12681 (let (group article)
12683 (error "Error in Gnus link"))
12684 (setq group (match-string 1 path)
12685 article (match-string 3 path))
12686 (org-follow-gnus-link group article)))
12688 ((string= type "vm")
12689 (let (folder article)
12691 (error "Error in VM link"))
12692 (setq folder (match-string 1 path)
12693 article (match-string 3 path))
12694 ;; in-emacs is the prefix arg, will be interpreted as read-only
12695 (org-follow-vm-link folder article in-emacs)))
12697 ((string= type "wl")
12698 (let (folder article)
12700 (error "Error in Wanderlust link"))
12701 (setq folder (match-string 1 path)
12702 article (match-string 3 path))
12703 (org-follow-wl-link folder article)))
12705 ((string= type "mhe")
12706 (let (folder article)
12708 (error "Error in MHE link"))
12709 (setq folder (match-string 1 path)
12710 article (match-string 3 path))
12711 (org-follow-mhe-link folder article)))
12713 ((string= type "rmail")
12714 (let (folder article)
12716 (error "Error in RMAIL link"))
12717 (setq folder (match-string 1 path)
12718 article (match-string 3 path))
12719 (org-follow-rmail-link folder article)))
12721 ((string= type "shell")
12722 (let ((cmd path))
12723 (if (or (not org-confirm-shell-link-function)
12724 (funcall org-confirm-shell-link-function
12726 (org-add-props cmd nil
12727 'face 'org-warning))))
12728 (progn
12729 (message "Executing %s" cmd)
12730 (shell-command cmd))
12731 (error "Abort"))))
12733 ((string= type "elisp")
12734 (let ((cmd path))
12735 (if (or (not org-confirm-elisp-link-function)
12736 (funcall org-confirm-elisp-link-function
12738 (org-add-props cmd nil
12739 'face 'org-warning))))
12740 (message "%s => %s" cmd (eval (read cmd)))
12741 (error "Abort"))))
12743 (t
12744 (browse-url-at-point)))))
12745 (move-marker org-open-link-marker nil)))
12747 ;;; File search
12749 (defvar org-create-file-search-functions nil
12750 "List of functions to construct the right search string for a file link.
12751 These functions are called in turn with point at the location to
12752 which the link should point.
12754 A function in the hook should first test if it would like to
12755 handle this file type, for example by checking the major-mode or
12756 the file extension. If it decides not to handle this file, it
12757 should just return nil to give other functions a chance. If it
12758 does handle the file, it must return the search string to be used
12759 when following the link. The search string will be part of the
12760 file link, given after a double colon, and `org-open-at-point'
12761 will automatically search for it. If special measures must be
12762 taken to make the search successful, another function should be
12763 added to the companion hook `org-execute-file-search-functions',
12764 which see.
12766 A function in this hook may also use `setq' to set the variable
12767 `description' to provide a suggestion for the descriptive text to
12768 be used for this link when it gets inserted into an Org-mode
12771 (defvar org-execute-file-search-functions nil
12772 "List of functions to execute a file search triggered by a link.
12774 Functions added to this hook must accept a single argument, the
12775 search string that was part of the file link, the part after the
12776 double colon. The function must first check if it would like to
12777 handle this search, for example by checking the major-mode or the
12778 file extension. If it decides not to handle this search, it
12779 should just return nil to give other functions a chance. If it
12780 does handle the search, it must return a non-nil value to keep
12781 other functions from trying.
12783 Each function can access the current prefix argument through the
12784 variable `current-prefix-argument'. Note that a single prefix is
12785 used to force opening a link in Emacs, so it may be good to only
12786 use a numeric or double prefix to guide the search function.
12788 In case this is needed, a function in this hook can also restore
12789 the window configuration before `org-open-at-point' was called using:
12791 (set-window-configuration org-window-config-before-follow-link)")
12793 (defun org-link-search (s &optional type avoid-pos)
12794 "Search for a link search option.
12795 If S is surrounded by forward slashes, it is interpreted as a
12796 regular expression. In org-mode files, this will create an `org-occur'
12797 sparse tree. In ordinary files, `occur' will be used to list matches.
12798 If the current buffer is in `dired-mode', grep will be used to search
12799 in all files. If AVOID-POS is given, ignore matches near that position."
12800 (let ((case-fold-search t)
12804 org-emphasis-alist)
12806 (pos (point))
12807 (pre "") (post "")
12808 words re0 re1 re2 re3 re4 re5 re2a reall)
12809 (cond
12810 ;; First check if there are any special
12811 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12812 ;; Now try the builtin stuff
12813 ((save-excursion
12814 (goto-char (point-min))
12815 (and
12816 (re-search-forward
12817 (concat "<<" (regexp-quote s0) ">>") nil t)
12818 (setq pos (match-beginning 0))))
12819 ;; There is an exact target for this
12820 (goto-char pos))
12822 ;; A regular expression
12823 (cond
12824 ((org-mode-p)
12825 (org-occur (match-string 1 s)))
12826 ;;((eq major-mode 'dired-mode)
12827 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12828 (t (org-do-occur (match-string 1 s)))))
12829 (t
12830 ;; A normal search strings
12831 (when (equal (string-to-char s) ?*)
12832 ;; Anchor on headlines, post may include tags.
12835 s (substring s 1)))
12836 (remove-text-properties
12837 0 (length s)
12838 '(face nil mouse-face nil keymap nil fontified nil) s)
12839 ;; Make a series of regular expressions to find a match
12846 re1 (concat pre re2 post)
12847 re3 (concat pre re4 post)
12848 re5 (concat pre ".*" re4)
12849 re2 (concat pre re2)
12850 re2a (concat pre re2a)
12851 re4 (concat pre re4)
12855 ))
12856 (cond
12857 ((eq type 'org-occur) (org-occur reall))
12858 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12859 (t (goto-char (point-min))
12860 (if (or (org-search-not-self 1 re0 nil t)
12861 (org-search-not-self 1 re1 nil t)
12862 (org-search-not-self 1 re2 nil t)
12863 (org-search-not-self 1 re2a nil t)
12864 (org-search-not-self 1 re3 nil t)
12865 (org-search-not-self 1 re4 nil t)
12866 (org-search-not-self 1 re5 nil t)
12867 )
12868 (goto-char (match-beginning 1))
12869 (goto-char pos)
12870 (error "No match")))))
12871 (t
12872 ;; Normal string-search
12873 (goto-char (point-min))
12874 (if (search-forward s nil t)
12875 (goto-char (match-beginning 0))
12876 (error "No match"))))
12877 (and (org-mode-p) (org-show-context 'link-search))))
12879 (defun org-search-not-self (group &rest args)
12880 "Execute `re-search-forward', but only accept matches that do not
12881 enclose the position of `org-open-link-marker'."
12882 (let ((m org-open-link-marker))
12883 (catch 'exit
12884 (while (apply 're-search-forward args)
12885 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12886 (goto-char (match-end group))
12887 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12888 (> (match-beginning 0) (marker-position m))
12889 (< (match-end 0) (marker-position m)))
12890 (save-match-data
12891 (or (not (org-in-regexp
12892 org-bracket-link-analytic-regexp 1))
12893 (not (match-end 4)) ; no description
12894 (and (<= (match-beginning 4) (point))
12895 (>= (match-end 4) (point))))))
12896 (throw 'exit (point))))))))
12898 (defun org-get-buffer-for-internal-link (buffer)
12899 "Return a buffer to be used for displaying the link target of internal links."
12900 (cond
12901 ((not org-display-internal-link-with-indirect-buffer)
12902 buffer)
12903 ((string-match "(Clone)$" (buffer-name buffer))
12904 (message "Buffer is already a clone, not making another one")
12905 ;; we also do not modify visibility in this case
12906 buffer)
12907 (t ; make a new indirect buffer for displaying the link
12908 (let* ((bn (buffer-name buffer))
12909 (ibn (concat bn "(Clone)"))
12910 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12911 (with-current-buffer ib (org-overview))
12912 ib))))
12914 (defun org-do-occur (regexp &optional cleanup)
12915 "Call the Emacs command `occur'.
12916 If CLEANUP is non-nil, remove the printout of the regular expression
12917 in the *Occur* buffer. This is useful if the regex is long and not useful
12918 to read."
12919 (occur regexp)
12920 (when cleanup
12921 (let ((cwin (selected-window)) win beg end)
12922 (when (setq win (get-buffer-window "*Occur*"))
12923 (select-window win))
12924 (goto-char (point-min))
12925 (when (re-search-forward "match[a-z]+" nil t)
12926 (setq beg (match-end 0))
12928 (setq end (1- (match-beginning 0)))))
12929 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12930 (goto-char (point-min))
12931 (select-window cwin))))
12933 ;;; The mark ring for links jumps
12935 (defvar org-mark-ring nil
12936 "Mark ring for positions before jumps in Org-mode.")
12937 (defvar org-mark-ring-last-goto nil
12938 "Last position in the mark ring used to go back.")
12939 ;; Fill and close the ring
12940 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12941 (loop for i from 1 to org-mark-ring-length do
12942 (push (make-marker) org-mark-ring))
12943 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12944 org-mark-ring)
12946 (defun org-mark-ring-push (&optional pos buffer)
12947 "Put the current position or POS into the mark ring and rotate it."
12948 (interactive)
12949 (setq pos (or pos (point)))
12950 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12951 (move-marker (car org-mark-ring)
12952 (or pos (point))
12953 (or buffer (current-buffer)))
12954 (message "%s"
12955 (substitute-command-keys
12958 (defun org-mark-ring-goto (&optional n)
12959 "Jump to the previous position in the mark ring.
12960 With prefix arg N, jump back that many stored positions. When
12961 called several times in succession, walk through the entire ring.
12962 Org-mode commands jumping to a different position in the current file,
12963 or to another Org-mode file, automatically push the old position
12964 onto the ring."
12965 (interactive "p")
12966 (let (p m)
12967 (if (eq last-command this-command)
12968 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12969 (setq p org-mark-ring))
12970 (setq org-mark-ring-last-goto p)
12971 (setq m (car p))
12972 (switch-to-buffer (marker-buffer m))
12973 (goto-char m)
12974 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12976 (defun org-remove-angle-brackets (s)
12977 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12978 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12979 s)
12980 (defun org-add-angle-brackets (s)
12981 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12982 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12983 s)
12985 ;;; Following specific links
12987 (defun org-follow-timestamp-link ()
12988 (cond
12989 ((org-at-date-range-p t)
12990 (let ((org-agenda-start-on-weekday)
12991 (t1 (match-string 1))
12992 (t2 (match-string 2)))
12993 (setq t1 (time-to-days (org-time-string-to-time t1))
12994 t2 (time-to-days (org-time-string-to-time t2)))
12995 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12996 ((org-at-timestamp-p t)
12997 (org-agenda-list nil (time-to-days (org-time-string-to-time
12998 (substring (match-string 1) 0 10)))
12999 1))
13000 (t (error "This should not happen"))))
13003 (defun org-follow-bbdb-link (name)
13004 "Follow a BBDB link to NAME."
13005 (require 'bbdb)
13006 (let ((inhibit-redisplay (not debug-on-error))
13007 (bbdb-electric-p nil))
13008 (catch 'exit
13009 ;; Exact match on name
13011 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13012 ;; Exact match on name
13014 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13015 ;; Partial match on name
13016 (bbdb-name name nil)
13017 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13018 ;; Partial match on company
13019 (bbdb-company name nil)
13020 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13021 ;; General match including network address and notes
13022 (bbdb name nil)
13023 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13024 (delete-window (get-buffer-window "*BBDB*"))
13025 (error "No matching BBDB record")))))
13027 (defun org-follow-info-link (name)
13028 "Follow an info file & node link to NAME."
13031 (progn
13032 (require 'info)
13033 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13034 (Info-find-node (match-string 1 name) (match-string 2 name))
13035 (Info-find-node (match-string 1 name) "Top")))
13036 (message "Could not open: %s" name)))
13038 (defun org-follow-gnus-link (&optional group article)
13039 "Follow a Gnus link to GROUP and ARTICLE."
13040 (require 'gnus)
13041 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13042 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13043 (cond ((and group article)
13044 (gnus-group-read-group 1 nil group)
13045 (gnus-summary-goto-article (string-to-number article) nil t))
13046 (group (gnus-group-jump-to-group group))))
13048 (defun org-follow-vm-link (&optional folder article readonly)
13049 "Follow a VM link to FOLDER and ARTICLE."
13050 (require 'vm)
13051 (setq article (org-add-angle-brackets article))
13053 ;; ange-ftp or efs or tramp access
13054 (let ((user (or (match-string 1 folder) (user-login-name)))
13055 (host (match-string 2 folder))
13056 (file (match-string 3 folder)))
13057 (cond
13058 ((featurep 'tramp)
13059 ;; use tramp to access the file
13060 (if (featurep 'xemacs)
13061 (setq folder (format "[%s@%s]%s" user host file))
13062 (setq folder (format "/%s@%s:%s" user host file))))
13063 (t
13064 ;; use ange-ftp or efs
13065 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13066 (setq folder (format "/%s@%s:%s" user host file))))))
13067 (when folder
13068 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13069 (sit-for 0.1)
13070 (when article
13071 (vm-select-folder-buffer)
13072 (widen)
13073 (let ((case-fold-search t))
13074 (goto-char (point-min))
13075 (if (not (re-search-forward
13076 (concat "^" "message-id: *" (regexp-quote article))))
13077 (error "Could not find the specified message in this folder"))
13078 (vm-isearch-update)
13079 (vm-isearch-narrow)
13080 (vm-beginning-of-message)
13081 (vm-summarize)))))
13083 (defun org-follow-wl-link (folder article)
13084 "Follow a Wanderlust link to FOLDER and ARTICLE."
13085 (if (and (string= folder "%")
13086 article
13088 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13089 ;; Thus, we recompose folder and article ids.
13090 (setq folder (format "%s#%s" folder (match-string 1 article))
13091 article (match-string 3 article)))
13092 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13093 (error "No such folder: %s" folder))
13094 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13095 (and article
13096 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13097 (wl-summary-redisplay)))
13099 (defun org-follow-rmail-link (folder article)
13100 "Follow an RMAIL link to FOLDER and ARTICLE."
13101 (setq article (org-add-angle-brackets article))
13102 (let (message-number)
13103 (save-excursion
13104 (save-window-excursion
13105 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13106 (setq message-number
13107 (save-restriction
13108 (widen)
13109 (goto-char (point-max))
13110 (if (re-search-backward
13112 (or article "")))
13113 nil t)
13114 (rmail-what-message))))))
13115 (if message-number
13116 (progn
13117 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13118 (rmail-show-message message-number)
13119 message-number)
13120 (error "Message not found"))))
13122 ;;; mh-e integration based on planner-mode
13123 (defun org-mhe-get-message-real-folder ()
13124 "Return the name of the current message real folder, so if you use
13125 sequences, it will now work."
13126 (save-excursion
13127 (let* ((folder
13128 (if (equal major-mode 'mh-folder-mode)
13129 mh-current-folder
13130 ;; Refer to the show buffer
13131 mh-show-folder-buffer))
13132 (end-index
13133 (if (boundp 'mh-index-folder)
13134 (min (length mh-index-folder) (length folder))))
13135 )
13136 ;; a simple test on mh-index-data does not work, because
13137 ;; mh-index-data is always nil in a show buffer.
13138 (if (and (boundp 'mh-index-folder)
13139 (string= mh-index-folder (substring folder 0 end-index)))
13140 (if (equal major-mode 'mh-show-mode)
13141 (save-window-excursion
13142 (let (pop-up-frames)
13143 (when (buffer-live-p (get-buffer folder))
13144 (progn
13145 (pop-to-buffer folder)
13146 (org-mhe-get-message-folder-from-index)
13147 )
13148 )))
13149 (org-mhe-get-message-folder-from-index)
13150 )
13151 folder
13152 )
13153 )))
13155 (defun org-mhe-get-message-folder-from-index ()
13156 "Returns the name of the message folder in a index folder buffer."
13157 (save-excursion
13158 (mh-index-previous-folder)
13160 (message "%s" (match-string 1))))
13162 (defun org-mhe-get-message-folder ()
13163 "Return the name of the current message folder. Be careful if you
13164 use sequences."
13165 (save-excursion
13166 (if (equal major-mode 'mh-folder-mode)
13167 mh-current-folder
13168 ;; Refer to the show buffer
13169 mh-show-folder-buffer)))
13171 (defun org-mhe-get-message-num ()
13172 "Return the number of the current message. Be careful if you
13173 use sequences."
13174 (save-excursion
13175 (if (equal major-mode 'mh-folder-mode)
13176 (mh-get-msg-num nil)
13177 ;; Refer to the show buffer
13178 (mh-show-buffer-message-number))))
13180 (defun org-mhe-get-header (header)
13181 "Return a header of the message in folder mode. This will create a
13182 show buffer for the corresponding message. If you have a more clever
13183 idea..."
13184 (let* ((folder (org-mhe-get-message-folder))
13185 (num (org-mhe-get-message-num))
13186 (buffer (get-buffer-create (concat "show-" folder)))
13187 (header-field))
13188 (with-current-buffer buffer
13189 (mh-display-msg num folder)
13190 (if (equal major-mode 'mh-folder-mode)
13191 (mh-header-display)
13192 (mh-show-header-display))
13193 (set-buffer buffer)
13194 (setq header-field (mh-get-header-field header))
13195 (if (equal major-mode 'mh-folder-mode)
13196 (mh-show)
13197 (mh-show-show))
13198 header-field)))
13200 (defun org-follow-mhe-link (folder article)
13201 "Follow an MHE link to FOLDER and ARTICLE.
13202 If ARTICLE is nil FOLDER is shown. If the configuration variable
13203 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13204 ARTICLE is searched in all folders. Indexed searches (swish++,
13205 namazu, and others supported by MH-E) will always search in all
13206 folders."
13207 (require 'mh-e)
13208 (require 'mh-search)
13209 (require 'mh-utils)
13210 (mh-find-path)
13211 (if (not article)
13212 (mh-visit-folder (mh-normalize-folder-name folder))
13213 (setq article (org-add-angle-brackets article))
13214 (mh-search-choose)
13215 (if (equal mh-searcher 'pick)
13216 (progn
13217 (mh-search folder (list "--message-id" article))
13218 (when (and org-mhe-search-all-folders
13219 (not (org-mhe-get-message-real-folder)))
13220 (kill-this-buffer)
13221 (mh-search "+" (list "--message-id" article))))
13222 (mh-search "+" article))
13223 (if (org-mhe-get-message-real-folder)
13224 (mh-show-msg 1)
13225 (kill-this-buffer)
13226 (error "Message not found"))))
13228 ;;; BibTeX links
13230 ;; Use the custom search meachnism to construct and use search strings for
13231 ;; file links to BibTeX database entries.
13233 (defun org-create-file-search-in-bibtex ()
13234 "Create the search string and description for a BibTeX database entry."
13235 (when (eq major-mode 'bibtex-mode)
13236 ;; yes, we want to construct this search string.
13237 ;; Make a good description for this entry, using names, year and the title
13238 ;; Put it into the `description' variable which is dynamically scoped.
13239 (let ((bibtex-autokey-names 1)
13240 (bibtex-autokey-names-stretch 1)
13241 (bibtex-autokey-name-case-convert-function 'identity)
13242 (bibtex-autokey-name-separator " & ")
13243 (bibtex-autokey-additional-names " et al.")
13244 (bibtex-autokey-year-length 4)
13245 (bibtex-autokey-name-year-separator " ")
13246 (bibtex-autokey-titlewords 3)
13247 (bibtex-autokey-titleword-separator " ")
13248 (bibtex-autokey-titleword-case-convert-function 'identity)
13249 (bibtex-autokey-titleword-length 'infty)
13250 (bibtex-autokey-year-title-separator ": "))
13251 (setq description (bibtex-generate-autokey)))
13252 ;; Now parse the entry, get the key and return it.
13253 (save-excursion
13254 (bibtex-beginning-of-entry)
13255 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13257 (defun org-execute-file-search-in-bibtex (s)
13258 "Find the link search string S as a key for a database entry."
13259 (when (eq major-mode 'bibtex-mode)
13260 ;; Yes, we want to do the search in this file.
13261 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13262 (goto-char (point-min))
13265 (goto-char (match-beginning 0)))
13266 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13267 ;; Use double prefix to indicate that any web link should be browsed
13268 (let ((b (current-buffer)) (p (point)))
13269 ;; Restore the window configuration because we just use the web link
13270 (set-window-configuration org-window-config-before-follow-link)
13271 (save-excursion (set-buffer b) (goto-char p)
13272 (bibtex-url)))
13273 (recenter 0)) ; Move entry start to beginning of window
13274 ;; return t to indicate that the search is done.
13275 t))
13277 ;; Finally add the functions to the right hooks.
13278 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13279 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13281 ;; end of Bibtex link setup
13283 ;;; Following file links
13285 (defun org-open-file (path &optional in-emacs line search)
13286 "Open the file at PATH.
13287 First, this expands any special file name abbreviations. Then the
13288 configuration variable `org-file-apps' is checked if it contains an
13289 entry for this file type, and if yes, the corresponding command is launched.
13290 If no application is found, Emacs simply visits the file.
13291 With optional argument IN-EMACS, Emacs will visit the file.
13292 Optional LINE specifies a line to go to, optional SEARCH a string to
13293 search for. If LINE or SEARCH is given, the file will always be
13294 opened in Emacs.
13295 If the file does not exist, an error is thrown."
13296 (setq in-emacs (or in-emacs line search))
13297 (let* ((file (if (equal path "")
13298 buffer-file-name
13299 (substitute-in-file-name (expand-file-name path))))
13300 (apps (append org-file-apps (org-default-apps)))
13301 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13302 (dirp (if remp nil (file-directory-p file)))
13303 (dfile (downcase file))
13304 (old-buffer (current-buffer))
13305 (old-pos (point))
13306 (old-mode major-mode)
13307 ext cmd)
13309 (setq ext (match-string 1 dfile))
13311 (setq ext (match-string 1 dfile))))
13312 (if in-emacs
13313 (setq cmd 'emacs)
13314 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13315 (and dirp (cdr (assoc 'directory apps)))
13316 (cdr (assoc ext apps))
13317 (cdr (assoc t apps)))))
13318 (when (eq cmd 'mailcap)
13319 (require 'mailcap)
13320 (mailcap-parse-mailcaps)
13321 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13322 (command (mailcap-mime-info mime-type)))
13323 (if (stringp command)
13324 (setq cmd command)
13325 (setq cmd 'emacs))))
13326 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13327 (not (file-exists-p file))
13328 (not org-open-non-existing-files))
13329 (error "No such file: %s" file))
13330 (cond
13332 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13334 (setq cmd (replace-match "%s" t t cmd)))
13335 (while (string-match "%s" cmd)
13336 (setq cmd (replace-match
13337 (save-match-data (shell-quote-argument file))
13338 t t cmd)))
13339 (save-window-excursion
13340 (start-process-shell-command cmd nil cmd)))
13341 ((or (stringp cmd)
13342 (eq cmd 'emacs))
13343 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13344 (widen)
13345 (if line (goto-line line)
13346 (if search (org-link-search search))))
13347 ((consp cmd)
13348 (eval cmd))
13349 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13350 (and (org-mode-p) (eq old-mode 'org-mode)
13351 (or (not (equal old-buffer (current-buffer)))
13352 (not (equal old-pos (point))))
13353 (org-mark-ring-push old-pos old-buffer))))
13355 (defun org-default-apps ()
13356 "Return the default applications for this operating system."
13357 (cond
13358 ((eq system-type 'darwin)
13359 org-file-apps-defaults-macosx)
13360 ((eq system-type 'windows-nt)
13361 org-file-apps-defaults-windowsnt)
13362 (t org-file-apps-defaults-gnu)))
13364 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13365 (defun org-file-remote-p (file)
13366 "Test whether FILE specifies a location on a remote system.
13367 Return non-nil if the location is indeed remote.
13371 (cond ((fboundp 'file-remote-p)
13372 (file-remote-p file))
13373 ((fboundp 'tramp-handle-file-remote-p)
13374 (tramp-handle-file-remote-p file))
13375 ((and (boundp 'ange-ftp-name-format)
13376 (string-match (car ange-ftp-name-format) file))
13377 t)
13378 (t nil)))
13381 ;;;; Hooks for remember.el, and refiling
13383 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13384 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13386 ;;;###autoload
13387 (defun org-remember-insinuate ()
13388 "Setup remember.el for use wiht Org-mode."
13389 (require 'remember)
13390 (setq remember-annotation-functions '(org-remember-annotation))
13391 (setq remember-handler-functions '(org-remember-handler))
13392 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13394 ;;;###autoload
13395 (defun org-remember-annotation ()
13396 "Return a link to the current location as an annotation for remember.el.
13397 If you are using Org-mode files as target for data storage with
13398 remember.el, then the annotations should include a link compatible with the
13399 conventions in Org-mode. This function returns such a link."
13400 (org-store-link nil))
13402 (defconst org-remember-help
13403 "Select a destination location for the note.
13404 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13405 RET on headline -> Store as sublevel entry to current headline
13406 RET at beg-of-buf -> Append to file as level 2 headline
13407 <left>/<right> -> before/after current headline, same headings level")
13409 (defvar org-remember-previous-location nil)
13410 (defvar org-force-remember-template-char) ;; dynamically scoped
13412 (defun org-select-remember-template (&optional use-char)
13413 (when org-remember-templates
13414 (let* ((templates (mapcar (lambda (x)
13415 (if (stringp (car x))
13416 (append (list (nth 1 x) (car x)) (cddr x))
13417 (append (list (car x) "") (cdr x))))
13418 org-remember-templates))
13419 (char (or use-char
13420 (cond
13421 ((= (length templates) 1)
13422 (caar templates))
13423 ((and (boundp 'org-force-remember-template-char)
13424 org-force-remember-template-char)
13425 (if (stringp org-force-remember-template-char)
13426 (string-to-char org-force-remember-template-char)
13427 org-force-remember-template-char))
13428 (t
13429 (message "Select template: %s"
13430 (mapconcat
13431 (lambda (x)
13432 (cond
13434 (format "[%c]" (car x)))
13435 ((equal (downcase (car x))
13436 (downcase (aref (nth 1 x) 0)))
13437 (format "[%c]%s" (car x)
13438 (substring (nth 1 x) 1)))
13439 (t (format "[%c]%s" (car x) (nth 1 x)))))
13440 templates " "))
13441 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13442 (when (equal char0 ?\C-g)
13443 (jump-to-register remember-register)
13444 (kill-buffer remember-buffer))
13445 char0))))))
13446 (cddr (assoc char templates)))))
13448 (defvar x-last-selected-text)
13449 (defvar x-last-selected-text-primary)
13451 ;;;###autoload
13452 (defun org-remember-apply-template (&optional use-char skip-interactive)
13453 "Initialize *remember* buffer with template, invoke `org-mode'.
13454 This function should be placed into `remember-mode-hook' and in fact requires
13455 to be run from that hook to function properly."
13456 (if org-remember-templates
13457 (let* ((entry (org-select-remember-template use-char))
13458 (tpl (car entry))
13459 (plist-p (if org-store-link-plist t nil))
13460 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13462 (nth 1 entry)
13463 org-default-notes-file))
13464 (headline (nth 2 entry))
13465 (v-c (or (and (eq window-system 'x)
13466 (fboundp 'x-cut-buffer-or-selection-value)
13467 (x-cut-buffer-or-selection-value))
13468 (org-bound-and-true-p x-last-selected-text)
13469 (org-bound-and-true-p x-last-selected-text-primary)
13470 (and (> (length kill-ring) 0) (current-kill 0))))
13471 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13472 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13473 (v-u (concat "[" (substring v-t 1 -1) "]"))
13474 (v-U (concat "[" (substring v-T 1 -1) "]"))
13475 ;; `initial' and `annotation' are bound in `remember'
13476 (v-i (if (boundp 'initial) initial))
13477 (v-a (if (and (boundp 'annotation) annotation)
13478 (if (equal annotation "[[]]") "" annotation)
13479 ""))
13480 (v-A (if (and v-a
13483 v-a))
13484 (v-n user-full-name)
13485 (org-startup-folded nil)
13486 org-time-was-given org-end-time-was-given x
13487 prompt completions char time pos default histvar)
13488 (setq org-store-link-plist
13489 (append (list :annotation v-a :initial v-i)
13490 org-store-link-plist))
13491 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13492 (erase-buffer)
13493 (insert (substitute-command-keys
13494 (format
13495 "## Filing location: Select interactively, default, or last used:
13496 ## %s to select file and header location interactively.
13500 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13501 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13502 (abbreviate-file-name (or file org-default-notes-file))
13503 (or headline "")
13504 (or (car org-remember-previous-location) "???")
13505 (or (cdr org-remember-previous-location) "???"))))
13506 (insert tpl) (goto-char (point-min))
13507 ;; Simple %-escapes
13509 (when (and initial (equal (match-string 0) "%i"))
13510 (save-match-data
13511 (let* ((lead (buffer-substring
13512 (point-at-bol) (match-beginning 0))))
13513 (setq v-i (mapconcat 'identity
13516 (replace-match
13517 (or (eval (intern (concat "v-" (match-string 1)))) "")
13518 t t))
13520 ;; %[] Insert contents of a file.
13521 (goto-char (point-min))
13523 (let ((start (match-beginning 0))
13524 (end (match-end 0))
13525 (filename (expand-file-name (match-string 1))))
13526 (goto-char start)
13527 (delete-region start end)
13528 (condition-case error
13529 (insert-file-contents filename)
13530 (error (insert (format "%%![Couldn't insert %s: %s]"
13531 filename error))))))
13532 ;; %() embedded elisp
13533 (goto-char (point-min))
13535 (goto-char (match-beginning 0))
13536 (let ((template-start (point)))
13537 (forward-char 1)
13538 (let ((result
13539 (condition-case error
13540 (eval (read (current-buffer)))
13541 (error (format "%%![Error: %s]" error)))))
13542 (delete-region template-start (point))
13543 (insert result))))
13545 ;; From the property list
13546 (when plist-p
13547 (goto-char (point-min))
13549 (and (setq x (or (plist-get org-store-link-plist
13550 (intern (match-string 1))) ""))
13551 (replace-match x t t))))
13553 ;; Turn on org-mode in the remember buffer, set local variables
13554 (org-mode)
13555 (org-set-local 'org-finish-function 'org-remember-finalize)
13557 (org-set-local 'org-default-notes-file file))
13559 (org-set-local 'org-remember-default-headline headline))
13560 ;; Interactive template entries
13561 (goto-char (point-min))
13563 (setq char (if (match-end 3) (match-string 3))
13564 prompt (if (match-end 2) (match-string 2)))
13565 (goto-char (match-beginning 0))
13566 (replace-match "")
13567 (setq completions nil default nil)
13568 (when prompt
13569 (setq completions (org-split-string prompt "|")
13570 prompt (pop completions)
13571 default (car completions)
13572 histvar (intern (concat
13573 "org-remember-template-prompt-history::"
13574 (or prompt "")))
13575 completions (mapcar 'list completions)))
13576 (cond
13577 ((member char '("G" "g"))
13578 (let* ((org-last-tags-completion-table
13579 (org-global-tags-completion-table
13580 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13581 (org-add-colon-after-tag-completion t)
13582 (ins (completing-read
13583 (if prompt (concat prompt ": ") "Tags: ")
13584 'org-tags-completion-function nil nil nil
13585 'org-tags-history)))
13586 (setq ins (mapconcat 'identity
13587 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13588 ":"))
13590 (or (equal (char-before) ?:) (insert ":"))
13591 (insert ins)
13592 (or (equal (char-after) ?:) (insert ":")))))
13593 (char
13594 (setq org-time-was-given (equal (upcase char) char))
13595 (setq time (org-read-date (equal (upcase char) "U") t nil
13596 prompt))
13597 (org-insert-time-stamp time org-time-was-given
13598 (member char '("u" "U"))
13599 nil nil (list org-end-time-was-given)))
13600 (t
13601 (insert (org-completing-read
13602 (concat (if prompt prompt "Enter string")
13603 (if default (concat " [" default "]"))
13604 ": ")
13605 completions nil nil nil histvar default)))))
13606 (goto-char (point-min))
13608 (replace-match "")
13610 (org-mode)
13611 (org-set-local 'org-finish-function 'org-remember-finalize))
13612 (when (save-excursion
13613 (goto-char (point-min))
13614 (re-search-forward "%!" nil t))
13615 (replace-match "")
13616 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13618 (defun org-remember-finish-immediately ()
13619 "File remember note immediately.
13620 This should be run in `post-command-hook' and will remove itself
13621 from that hook."
13622 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13623 (when org-finish-function
13624 (funcall org-finish-function)))
13626 (defvar org-clock-marker) ; Defined below
13627 (defun org-remember-finalize ()
13628 "Finalize the remember process."
13629 (unless (fboundp 'remember-finalize)
13630 (defalias 'remember-finalize 'remember-buffer))
13631 (when (and org-clock-marker
13632 (equal (marker-buffer org-clock-marker) (current-buffer)))
13633 ;; FIXME: test this, this is w/o notetaking!
13634 (let (org-log-done) (org-clock-out)))
13635 (when buffer-file-name
13636 (save-buffer)
13637 (setq buffer-file-name nil))
13638 (remember-finalize))
13640 ;;;###autoload
13641 (defun org-remember (&optional goto org-force-remember-template-char)
13642 "Call `remember'. If this is already a remember buffer, re-apply template.
13643 If there is an active region, make sure remember uses it as initial content
13644 of the remember buffer.
13646 When called interactively with a `C-u' prefix argument GOTO, don't remember
13647 anything, just go to the file/headline where the selected template usually
13648 stores its notes. With a double prefix arg `C-u C-u', go to the last
13649 note stored by remember.
13651 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13652 associated with a template in `org-remember-templates'."
13653 (interactive "P")
13654 (cond
13655 ((equal goto '(4)) (org-go-to-remember-target))
13656 ((equal goto '(16)) (org-remember-goto-last-stored))
13657 (t
13658 (if (memq org-finish-function '(remember-buffer remember-finalize))
13659 (progn
13660 (when (< (length org-remember-templates) 2)
13661 (error "No other template available"))
13662 (erase-buffer)
13663 (let ((annotation (plist-get org-store-link-plist :annotation))
13664 (initial (plist-get org-store-link-plist :initial)))
13665 (org-remember-apply-template))
13666 (message "Press C-c C-c to remember data"))
13667 (if (org-region-active-p)
13668 (remember (buffer-substring (point) (mark)))
13669 (call-interactively 'remember))))))
13671 (defun org-remember-goto-last-stored ()
13672 "Go to the location where the last remember note was stored."
13673 (interactive)
13674 (bookmark-jump "org-remember-last-stored")
13675 (message "This is the last note stored by remember"))
13677 (defun org-go-to-remember-target (&optional template-key)
13678 "Go to the target location of a remember template.
13679 The user is queried for the template."
13680 (interactive)
13681 (let* ((entry (org-select-remember-template template-key))
13682 (file (nth 1 entry))
13683 (heading (nth 2 entry))
13684 visiting)
13686 (setq file org-default-notes-file))
13688 (setq heading org-remember-default-headline))
13689 (setq visiting (org-find-base-buffer-visiting file))
13690 (if (not visiting) (find-file-noselect file))
13691 (switch-to-buffer (or visiting (get-file-buffer file)))
13692 (widen)
13693 (goto-char (point-min))
13694 (if (re-search-forward
13697 nil t)
13698 (goto-char (match-beginning 0))
13699 (error "Target headline not found: %s" heading))))
13701 (defvar org-note-abort nil) ; dynamically scoped
13703 ;;;###autoload
13704 (defun org-remember-handler ()
13705 "Store stuff from remember.el into an org file.
13706 First prompts for an org file. If the user just presses return, the value
13707 of `org-default-notes-file' is used.
13708 Then the command offers the headings tree of the selected file in order to
13709 file the text at a specific location.
13710 You can either immediately press RET to get the note appended to the
13711 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13712 find a better place. Then press RET or <left> or <right> in insert the note.
13714 Key Cursor position Note gets inserted
13715 -----------------------------------------------------------------------------
13716 RET buffer-start as level 1 heading at end of file
13717 RET on headline as sublevel of the heading at cursor
13718 RET no heading at cursor position, level taken from context.
13719 Or use prefix arg to specify level manually.
13720 <left> on headline as same level, before current heading
13721 <right> on headline as same level, after current heading
13723 So the fastest way to store the note is to press RET RET to append it to
13724 the default file. This way your current train of thought is not
13725 interrupted, in accordance with the principles of remember.el.
13726 You can also get the fast execution without prompting by using
13727 C-u C-c C-c to exit the remember buffer. See also the variable
13728 `org-remember-store-without-prompt'.
13730 Before being stored away, the function ensures that the text has a
13732 is constructed from the current date and some additional data.
13734 If the variable `org-adapt-indentation' is non-nil, the entire text is
13735 also indented so that it starts in the same column as the headline
13736 \(i.e. after the stars).
13738 See also the variable `org-reverse-note-order'."
13739 (goto-char (point-min))
13741 (replace-match ""))
13742 (goto-char (point-max))
13743 (beginning-of-line 1)
13745 (delete-region (1- (point)) (point-max))
13746 (beginning-of-line 1))
13747 (catch 'quit
13748 (if org-note-abort (throw 'quit nil))
13749 (let* ((txt (buffer-substring (point-min) (point-max)))
13750 (fastp (org-xor (equal current-prefix-arg '(4))
13751 org-remember-store-without-prompt))
13752 (file (cond
13753 (fastp org-default-notes-file)
13754 ((and (eq org-remember-interactive-interface 'refile)
13755 org-refile-targets)
13756 org-default-notes-file)
13757 ((not (and (equal current-prefix-arg '(16))
13758 org-remember-previous-location))
13759 (org-get-org-file))))
13760 (heading org-remember-default-headline)
13761 (visiting (and file (org-find-base-buffer-visiting file)))
13762 (org-startup-folded nil)
13763 (org-startup-align-all-tables nil)
13764 (org-goto-start-pos 1)
13765 spos exitcmd level indent reversed)
13766 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13767 (setq file (car org-remember-previous-location)
13768 heading (cdr org-remember-previous-location)
13769 fastp t))
13770 (setq current-prefix-arg nil)
13772 (setq txt (replace-match "" t t txt)))
13773 ;; Modify text so that it becomes a nice subtree which can be inserted
13774 ;; into an org tree.
13776 first)
13777 (setq first (car lines) lines (cdr lines))
13779 ;; Is already a headline
13780 (setq indent nil)
13781 ;; We need to add a headline: Use time and first buffer line
13782 (setq lines (cons first lines)
13783 first (concat "* " (current-time-string)
13784 " (" (remember-buffer-desc) ")")
13785 indent " "))
13786 (if (and org-adapt-indentation indent)
13787 (setq lines (mapcar
13788 (lambda (x)
13790 (concat indent x) x))
13791 lines)))
13798 ;; Put the modified text back into the remember buffer, for refile.
13799 (erase-buffer)
13800 (insert txt)
13801 (goto-char (point-min))
13802 (when (and (eq org-remember-interactive-interface 'refile)
13803 (not fastp))
13804 (org-refile nil (or visiting (find-file-noselect file)))
13805 (throw 'quit t))
13806 ;; Find the file
13807 (if (not visiting) (find-file-noselect file))
13808 (with-current-buffer (or visiting (get-file-buffer file))
13809 (unless (org-mode-p)
13810 (error "Target files for remember notes must be in Org-mode"))
13811 (save-excursion
13812 (save-restriction
13813 (widen)
13814 (and (goto-char (point-min))
13817 (setq reversed (org-notes-order-reversed-p))
13819 ;; Find the default location
13821 (goto-char (point-min))
13822 (if (re-search-forward
13825 nil t)
13826 (setq org-goto-start-pos (match-beginning 0))
13827 (when fastp
13828 (goto-char (point-max))
13829 (unless (bolp) (newline))
13831 (setq org-goto-start-pos (point-at-bol 0)))))
13833 ;; Ask the User for a location, using the appropriate interface
13834 (cond
13835 (fastp (setq spos org-goto-start-pos
13836 exitcmd 'return))
13837 ((eq org-remember-interactive-interface 'outline)
13838 (setq spos (org-get-location (current-buffer)
13839 org-remember-help)
13840 exitcmd (cdr spos)
13841 spos (car spos)))
13842 ((eq org-remember-interactive-interface 'outline-path-completion)
13843 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13844 (org-refile-use-outline-path t))
13845 (setq spos (org-refile-get-location "Heading: ")
13846 exitcmd 'return
13847 spos (nth 3 spos))))
13848 (t (error "this should not hapen")))
13849 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13850 ; not handle this note
13851 (goto-char spos)
13852 (cond ((org-on-heading-p t)
13853 (org-back-to-heading t)
13854 (setq level (funcall outline-level))
13855 (cond
13856 ((eq exitcmd 'return)
13857 ;; sublevel of current
13858 (setq org-remember-previous-location
13859 (cons (abbreviate-file-name file)
13860 (org-get-heading 'notags)))
13861 (if reversed
13862 (outline-next-heading)
13863 (org-end-of-subtree t)
13864 (if (not (bolp))
13866 (beginning-of-line 2)
13867 (end-of-line 1)
13869 (bookmark-set "org-remember-last-stored")
13870 (org-paste-subtree (org-get-legal-level level 1) txt))
13871 ((eq exitcmd 'left)
13872 ;; before current
13873 (bookmark-set "org-remember-last-stored")
13874 (org-paste-subtree level txt))
13875 ((eq exitcmd 'right)
13876 ;; after current
13877 (org-end-of-subtree t)
13878 (bookmark-set "org-remember-last-stored")
13879 (org-paste-subtree level txt))
13880 (t (error "This should not happen"))))
13882 ((and (bobp) (not reversed))
13883 ;; Put it at the end, one level below level 1
13884 (save-restriction
13885 (widen)
13886 (goto-char (point-max))
13887 (if (not (bolp)) (newline))
13888 (bookmark-set "org-remember-last-stored")
13889 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13891 ((and (bobp) reversed)
13892 ;; Put it at the start, as level 1
13893 (save-restriction
13894 (widen)
13895 (goto-char (point-min))
13897 (beginning-of-line 1)
13898 (bookmark-set "org-remember-last-stored")
13899 (org-paste-subtree 1 txt)))
13900 (t
13901 ;; Put it right there, with automatic level determined by
13902 ;; org-paste-subtree or from prefix arg
13903 (bookmark-set "org-remember-last-stored")
13904 (org-paste-subtree
13905 (if (numberp current-prefix-arg) current-prefix-arg)
13906 txt)))
13907 (when remember-save-after-remembering
13908 (save-buffer)
13909 (if (not visiting) (kill-buffer (current-buffer)))))))))
13911 t) ;; return t to indicate that we took care of this note.
13913 (defun org-get-org-file ()
13914 "Read a filename, with default directory `org-directory'."
13915 (let ((default (or org-default-notes-file remember-data-file)))
13916 (read-file-name (format "File name [%s]: " default)
13917 (file-name-as-directory org-directory)
13918 default)))
13920 (defun org-notes-order-reversed-p ()
13921 "Check if the current file should receive notes in reversed order."
13922 (cond
13923 ((not org-reverse-note-order) nil)
13924 ((eq t org-reverse-note-order) t)
13925 ((not (listp org-reverse-note-order)) nil)
13926 (t (catch 'exit
13927 (let ((all org-reverse-note-order)
13928 entry)
13929 (while (setq entry (pop all))
13930 (if (string-match (car entry) buffer-file-name)
13931 (throw 'exit (cdr entry))))
13932 nil)))))
13934 ;;; Refiling
13936 (defvar org-refile-target-table nil
13937 "The list of refile targets, created by `org-refile'.")
13939 (defvar org-agenda-new-buffers nil
13940 "Buffers created to visit agenda files.")
13942 (defun org-get-refile-targets (&optional default-buffer)
13943 "Produce a table with refile targets."
13944 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13945 targets txt re files f desc descre)
13946 (with-current-buffer (or default-buffer (current-buffer))
13947 (while (setq entry (pop entries))
13948 (setq files (car entry) desc (cdr entry))
13949 (cond
13950 ((null files) (setq files (list (current-buffer))))
13951 ((eq files 'org-agenda-files)
13952 (setq files (org-agenda-files 'unrestricted)))
13953 ((and (symbolp files) (fboundp files))
13954 (setq files (funcall files)))
13955 ((and (symbolp files) (boundp files))
13956 (setq files (symbol-value files))))
13957 (if (stringp files) (setq files (list files)))
13958 (cond
13959 ((eq (car desc) :tag)
13961 ((eq (car desc) :todo)
13963 ((eq (car desc) :regexp)
13964 (setq descre (cdr desc)))
13965 ((eq (car desc) :level)
13967 (if org-odd-levels-only
13968 (1- (* 2 (cdr desc)))
13969 (cdr desc)))
13971 ((eq (car desc) :maxlevel)
13973 (if org-odd-levels-only
13974 (1- (* 2 (cdr desc)))
13975 (cdr desc)))
13977 (t (error "Bad refiling target description %s" desc)))
13978 (while (setq f (pop files))
13979 (save-excursion
13980 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
13981 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
13982 (save-excursion
13983 (save-restriction
13984 (widen)
13985 (goto-char (point-min))
13986 (while (re-search-forward descre nil t)
13987 (goto-char (point-at-bol))
13988 (when (looking-at org-complex-heading-regexp)
13989 (setq txt (match-string 4)
13990 re (concat "^" (regexp-quote
13991 (buffer-substring (match-beginning 1)
13992 (match-end 4)))))
13994 (regexp-quote
13995 (match-string 5)))))
13997 (when org-refile-use-outline-path
13998 (setq txt (mapconcat 'identity
13999 (append
14000 (if (eq org-refile-use-outline-path 'file)
14001 (list (file-name-nondirectory
14002 (buffer-file-name (buffer-base-buffer))))
14003 (if (eq org-refile-use-outline-path 'full-file-path)
14004 (list (buffer-file-name (buffer-base-buffer)))))
14005 (org-get-outline-path)
14006 (list txt))
14007 "/")))
14008 (push (list txt f re (point)) targets))
14009 (goto-char (point-at-eol))))))))
14010 (nreverse targets))))
14012 (defun org-get-outline-path ()
14013 "Return the outline path to the current entry, as a list."
14014 (let (rtn)
14015 (save-excursion
14016 (while (org-up-heading-safe)
14017 (when (looking-at org-complex-heading-regexp)
14018 (push (org-match-string-no-properties 4) rtn)))
14019 rtn)))
14021 (defvar org-refile-history nil
14022 "History for refiling operations.")
14024 (defun org-refile (&optional goto default-buffer)
14025 "Move the entry at point to another heading.
14026 The list of target headings is compiled using the information in
14027 `org-refile-targets', which see. This list is created upon first use, and
14028 you can update it by calling this command with a double prefix (`C-u C-u').
14029 FIXME: Can we find a better way of updating?
14031 At the target location, the entry is filed as a subitem of the target heading.
14032 Depending on `org-reverse-note-order', the new subitem will either be the
14033 first of the last subitem.
14035 With prefix arg GOTO, the command will only visit the target location,
14036 not actually move anything.
14037 With a double prefix `C-c C-c', go to the location where the last refiling
14038 operation has put the subtree.
14040 With a double prefix argument, the command can be used to jump to any
14041 heading in the current buffer."
14042 (interactive "P")
14043 (let* ((cbuf (current-buffer))
14044 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14045 (fname (and filename (file-truename filename)))
14046 pos it nbuf file re level reversed)
14047 (if (equal goto '(16))
14048 (org-refile-goto-last-stored)
14049 (when (setq it (org-refile-get-location
14050 (if goto "Goto: " "Refile to: ") default-buffer))
14051 (setq file (nth 1 it)
14052 re (nth 2 it)
14053 pos (nth 3 it))
14054 (setq nbuf (or (find-buffer-visiting file)
14055 (find-file-noselect file)))
14056 (if goto
14057 (progn
14058 (switch-to-buffer nbuf)
14059 (goto-char pos)
14060 (org-show-context 'org-goto))
14061 (org-copy-special)
14062 (save-excursion
14063 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14064 (find-file-noselect file))))
14065 (setq reversed (org-notes-order-reversed-p))
14066 (save-excursion
14067 (save-restriction
14068 (widen)
14069 (goto-char pos)
14070 (looking-at outline-regexp)
14071 (setq level (org-get-legal-level (funcall outline-level) 1))
14072 (goto-char
14073 (if reversed
14074 (outline-next-heading)
14075 (or (save-excursion (outline-get-next-sibling))
14076 (org-end-of-subtree t t)
14077 (point-max))))
14078 (bookmark-set "org-refile-last-stored")
14079 (org-paste-subtree level))))
14080 (org-cut-special)
14083 (defun org-refile-goto-last-stored ()
14084 "Go to the location where the last refile was stored."
14085 (interactive)
14086 (bookmark-jump "org-refile-last-stored")
14087 (message "This is the location of the last refile"))
14089 (defun org-refile-get-location (&optional prompt default-buffer)
14090 "Prompt the user for a refile location, using PROMPT."
14091 (let ((org-refile-targets org-refile-targets)
14092 (org-refile-use-outline-path org-refile-use-outline-path))
14093 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14094 (unless org-refile-target-table
14095 (error "No refile targets"))
14096 (let* ((cbuf (current-buffer))
14097 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14098 (fname (and filename (file-truename filename)))
14099 (tbl (mapcar
14100 (lambda (x)
14101 (if (not (equal fname (file-truename (nth 1 x))))
14102 (cons (concat (car x) " (" (file-name-nondirectory
14103 (nth 1 x)) ")")
14104 (cdr x))
14105 x))
14106 org-refile-target-table))
14107 (completion-ignore-case t)
14108 pos it nbuf file re level reversed)
14109 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14110 tbl)))
14112 ;;;; Dynamic blocks
14114 (defun org-find-dblock (name)
14115 "Find the first dynamic block with name NAME in the buffer.
14116 If not found, stay at current position and return nil."
14117 (let (pos)
14118 (save-excursion
14119 (goto-char (point-min))
14121 nil t)
14122 (match-beginning 0))))
14123 (if pos (goto-char pos))
14124 pos))
14126 (defconst org-dblock-start-re
14128 "Matches the startline of a dynamic block, with parameters.")
14131 "Matches the end of a dyhamic block.")
14133 (defun org-create-dblock (plist)
14134 "Create a dynamic block section, with parameters taken from PLIST.
14135 PLIST must containe a :name entry which is used as name of the block."
14136 (unless (bolp) (newline))
14137 (let ((name (plist-get plist :name)))
14138 (insert "#+BEGIN: " name)
14139 (while plist
14140 (if (eq (car plist) :name)
14141 (setq plist (cddr plist))
14142 (insert " " (prin1-to-string (pop plist)))))
14144 (beginning-of-line -2)))
14146 (defun org-prepare-dblock ()
14147 "Prepare dynamic block for refresh.
14148 This empties the block, puts the cursor at the insert position and returns
14149 the property list including an extra property :name with the block name."
14150 (unless (looking-at org-dblock-start-re)
14151 (error "Not at a dynamic block"))
14152 (let* ((begdel (1+ (match-end 0)))
14153 (name (org-no-properties (match-string 1)))
14154 (params (append (list :name name)
14155 (read (concat "(" (match-string 3) ")")))))
14156 (unless (re-search-forward org-dblock-end-re nil t)
14157 (error "Dynamic block not terminated"))
14158 (delete-region begdel (match-beginning 0))
14159 (goto-char begdel)
14160 (open-line 1)
14161 params))
14163 (defun org-map-dblocks (&optional command)
14164 "Apply COMMAND to all dynamic blocks in the current buffer.
14165 If COMMAND is not given, use `org-update-dblock'."
14166 (let ((cmd (or command 'org-update-dblock))
14167 pos)
14168 (save-excursion
14169 (goto-char (point-min))
14170 (while (re-search-forward org-dblock-start-re nil t)
14171 (goto-char (setq pos (match-beginning 0)))
14172 (condition-case nil
14173 (funcall cmd)
14174 (error (message "Error during update of dynamic block")))
14175 (goto-char pos)
14176 (unless (re-search-forward org-dblock-end-re nil t)
14177 (error "Dynamic block not terminated"))))))
14179 (defun org-dblock-update (&optional arg)
14180 "User command for updating dynamic blocks.
14181 Update the dynamic block at point. With prefix ARG, update all dynamic
14182 blocks in the buffer."
14183 (interactive "P")
14184 (if arg
14185 (org-update-all-dblocks)
14186 (or (looking-at org-dblock-start-re)
14187 (org-beginning-of-dblock))
14188 (org-update-dblock)))
14190 (defun org-update-dblock ()
14191 "Update the dynamic block at point
14192 This means to empty the block, parse for parameters and then call
14193 the correct writing function."
14194 (save-window-excursion
14195 (let* ((pos (point))
14196 (line (org-current-line))
14197 (params (org-prepare-dblock))
14198 (name (plist-get params :name))
14199 (cmd (intern (concat "org-dblock-write:" name))))
14200 (message "Updating dynamic block `%s' at line %d..." name line)
14201 (funcall cmd params)
14202 (message "Updating dynamic block `%s' at line %d...done" name line)
14203 (goto-char pos))))
14205 (defun org-beginning-of-dblock ()
14206 "Find the beginning of the dynamic block at point.
14207 Error if there is no scuh block at point."
14208 (let ((pos (point))
14209 beg)
14210 (end-of-line 1)
14211 (if (and (re-search-backward org-dblock-start-re nil t)
14212 (setq beg (match-beginning 0))
14213 (re-search-forward org-dblock-end-re nil t)
14214 (> (match-end 0) pos))
14215 (goto-char beg)
14216 (goto-char pos)
14217 (error "Not in a dynamic block"))))
14219 (defun org-update-all-dblocks ()
14220 "Update all dynamic blocks in the buffer.
14221 This function can be used in a hook."
14222 (when (org-mode-p)
14223 (org-map-dblocks 'org-update-dblock)))
14226 ;;;; Completion
14228 (defconst org-additional-option-like-keywords
14229 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14230 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14231 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14233 (defun org-complete (&optional arg)
14234 "Perform completion on word at point.
14235 At the beginning of a headline, this completes TODO keywords as given in
14236 `org-todo-keywords'.
14237 If the current word is preceded by a backslash, completes the TeX symbols
14238 that are supported for HTML support.
14240 setting file options.
14242 At all other locations, this simply calls the value of
14243 `org-completion-fallback-command'."
14244 (interactive "P")
14245 (org-without-partial-completion
14246 (catch 'exit
14247 (let* ((end (point))
14248 (beg1 (save-excursion
14249 (skip-chars-backward (org-re "[:alnum:]_@"))
14250 (point)))
14251 (beg (save-excursion
14252 (skip-chars-backward "a-zA-Z0-9_:$")
14253 (point)))
14254 (confirm (lambda (x) (stringp (car x))))
14255 (searchhead (equal (char-before beg) ?*))
14256 (tag (and (equal (char-before beg1) ?:)
14257 (equal (char-after (point-at-bol)) ?*)))
14258 (prop (and (equal (char-before beg1) ?:)
14259 (not (equal (char-after (point-at-bol)) ?*))))
14261 (link (equal (char-before beg) ?\[))
14262 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14263 beg)
14264 "#+"))
14266 (buffer-substring (point-at-bol) (point))))
14267 (completion-ignore-case opt)
14268 (type nil)
14269 (tbl nil)
14270 (table (cond
14271 (opt
14272 (setq type :opt)
14273 (append
14274 (mapcar
14275 (lambda (x)
14277 (cons (match-string 2 x) (match-string 1 x)))
14279 (mapcar 'list org-additional-option-like-keywords)))
14280 (startup
14281 (setq type :startup)
14282 org-startup-options)
14283 (link (append org-link-abbrev-alist-local
14284 org-link-abbrev-alist))
14285 (texp
14286 (setq type :tex)
14287 org-html-entities)
14289 (buffer-substring (point-at-bol) beg))
14290 (setq type :todo)
14291 (mapcar 'list org-todo-keywords-1))
14292 (searchhead
14293 (setq type :searchhead)
14294 (save-excursion
14295 (goto-char (point-min))
14296 (while (re-search-forward org-todo-line-regexp nil t)
14297 (push (list
14298 (org-make-org-heading-search-string
14299 (match-string 3) t))
14300 tbl)))
14301 tbl)
14302 (tag (setq type :tag beg beg1)
14303 (or org-tag-alist (org-get-buffer-tags)))
14304 (prop (setq type :prop beg beg1)
14305 (mapcar 'list (org-buffer-property-keys nil t t)))
14306 (t (progn
14307 (call-interactively org-completion-fallback-command)
14308 (throw 'exit nil)))))
14309 (pattern (buffer-substring-no-properties beg end))
14310 (completion (try-completion pattern table confirm)))
14311 (cond ((eq completion t)
14312 (if (not (assoc (upcase pattern) table))
14313 (message "Already complete")
14314 (if (equal type :opt)
14315 (insert (substring (cdr (assoc (upcase pattern) table))
14316 (length pattern)))
14317 (if (memq type '(:tag :prop)) (insert ":")))))
14318 ((null completion)
14320 (ding))
14321 ((not (string= pattern completion))
14322 (delete-region beg end)
14323 (if (string-match " +$" completion)
14324 (setq completion (replace-match "" t t completion)))
14325 (insert completion)
14326 (if (get-buffer-window "*Completions*")
14327 (delete-window (get-buffer-window "*Completions*")))
14328 (if (assoc completion table)
14329 (if (eq type :todo) (insert " ")
14330 (if (memq type '(:tag :prop)) (insert ":"))))
14331 (if (and (equal type :opt) (assoc completion table))
14332 (message "%s" (substitute-command-keys
14334 (t
14335 (message "Making completion list...")
14336 (let ((list (sort (all-completions pattern table confirm)
14337 'string<)))
14338 (with-output-to-temp-buffer "*Completions*"
14339 (condition-case nil
14340 ;; Protection needed for XEmacs and emacs 21
14341 (display-completion-list list pattern)
14342 (error (display-completion-list list)))))
14343 (message "Making completion list...%s" "done")))))))
14345 ;;;; TODO, DEADLINE, Comments
14347 (defun org-toggle-comment ()
14348 "Change the COMMENT state of an entry."
14349 (interactive)
14350 (save-excursion
14351 (org-back-to-heading)
14352 (let (case-fold-search)
14353 (if (looking-at (concat outline-regexp
14355 (replace-match "" t t nil 1)
14356 (if (looking-at outline-regexp)
14357 (progn
14358 (goto-char (match-end 0))
14359 (insert org-comment-string " ")))))))
14361 (defvar org-last-todo-state-is-todo nil
14362 "This is non-nil when the last TODO state change led to a TODO state.
14363 If the last change removed the TODO tag or switched to DONE, then
14364 this is nil.")
14366 (defvar org-setting-tags nil) ; dynamically skiped
14368 ;; FIXME: better place
14369 (defun org-property-or-variable-value (var &optional inherit)
14370 "Check if there is a property fixing the value of VAR.
14371 If yes, return this value. If not, return the current value of the variable."
14372 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14374 (read prop)
14375 (symbol-value var))))
14377 (defun org-parse-local-options (string var)
14378 "Parse STRING for startup setting relevant for variable VAR."
14379 (let ((rtn (symbol-value var))
14380 e opts)
14381 (save-match-data
14383 rtn
14384 (setq opts (delq nil (mapcar (lambda (x)
14385 (setq e (assoc x org-startup-options))
14386 (if (eq (nth 1 e) var) e nil))
14388 (if (not opts)
14389 rtn
14390 (setq rtn nil)
14391 (while (setq e (pop opts))
14392 (if (not (nth 3 e))
14393 (setq rtn (nth 2 e))
14394 (if (not (listp rtn)) (setq rtn nil))
14395 (push (nth 2 e) rtn)))
14396 rtn)))))
14398 (defvar org-blocker-hook nil
14399 "Hook for functions that are allowed to block a state change.
14401 Each function gets as its single argument a property list, see
14402 `org-trigger-hook' for more information about this list.
14404 If any of the functions in this hook returns nil, the state change
14405 is blocked.")
14407 (defvar org-trigger-hook nil
14408 "Hook for functions that are triggered by a state change.
14410 Each function gets as its single argument a property list with at least
14411 the following elements:
14413 (:type type-of-change :position pos-at-entry-start
14414 :from old-state :to new-state)
14416 Depending on the type, more properties may be present.
14418 This mechanism is currently implemented for:
14420 TODO state changes
14421 ------------------
14422 :type todo-state-change
14423 :from previous state (keyword as a string), or nil
14424 :to new state (keyword as a string), or nil")
14427 (defun org-todo (&optional arg)
14428 "Change the TODO state of an item.
14429 The state of an item is given by a keyword at the start of the heading,
14430 like
14431 *** TODO Write paper
14432 *** DONE Call mom
14434 The different keywords are specified in the variable `org-todo-keywords'.
14436 So for this example: when the item starts with TODO, it is changed to DONE.
14437 When it starts with DONE, the DONE is removed. And when neither TODO nor
14438 DONE are present, add TODO at the beginning of the heading.
14440 With C-u prefix arg, use completion to determine the new state.
14441 With numeric prefix arg, switch to that state.
14443 For calling through lisp, arg is also interpreted in the following way:
14444 'none -> empty state
14446 'done -> switch to DONE
14447 'nextset -> switch to the next set of keywords
14448 'previousset -> switch to the previous set of keywords
14450 really is a member of `org-todo-keywords'."
14451 (interactive "P")
14452 (save-excursion
14453 (catch 'exit
14454 (org-back-to-heading)
14455 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14456 (or (looking-at (concat " +" org-todo-regexp " *"))
14457 (looking-at " *"))
14458 (let* ((match-data (match-data))
14459 (startpos (point-at-bol))
14460 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14461 (org-log-done (org-parse-local-options logging 'org-log-done))
14462 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
14463 (this (match-string 1))
14464 (hl-pos (match-beginning 0))
14465 (head (org-get-todo-sequence-head this))
14466 (ass (assoc head org-todo-kwd-alist))
14467 (interpret (nth 1 ass))
14468 (done-word (nth 3 ass))
14469 (final-done-word (nth 4 ass))
14470 (last-state (or this ""))
14471 (completion-ignore-case t)
14472 (member (member this org-todo-keywords-1))
14473 (tail (cdr member))
14474 (state (cond
14475 ((and org-todo-key-trigger
14476 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14477 (and (not arg) org-use-fast-todo-selection
14478 (not (eq org-use-fast-todo-selection 'prefix)))))
14479 ;; Use fast selection
14480 (org-fast-todo-selection))
14481 ((and (equal arg '(4))
14482 (or (not org-use-fast-todo-selection)
14483 (not org-todo-key-trigger)))
14484 ;; Read a state with completion
14485 (completing-read "State: " (mapcar (lambda(x) (list x))
14486 org-todo-keywords-1)
14487 nil t))
14488 ((eq arg 'right)
14489 (if this
14490 (if tail (car tail) nil)
14491 (car org-todo-keywords-1)))
14492 ((eq arg 'left)
14493 (if (equal member org-todo-keywords-1)
14494 nil
14495 (if this
14496 (nth (- (length org-todo-keywords-1) (length tail) 2)
14497 org-todo-keywords-1)
14498 (org-last org-todo-keywords-1))))
14499 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14500 (setq arg nil))) ; hack to fall back to cycling
14501 (arg
14502 ;; user or caller requests a specific state
14503 (cond
14504 ((equal arg "") nil)
14505 ((eq arg 'none) nil)
14506 ((eq arg 'done) (or done-word (car org-done-keywords)))
14507 ((eq arg 'nextset)
14508 (or (car (cdr (member head org-todo-heads)))
14509 (car org-todo-heads)))
14510 ((eq arg 'previousset)
14511 (let ((org-todo-heads (reverse org-todo-heads)))
14512 (or (car (cdr (member head org-todo-heads)))
14513 (car org-todo-heads))))
14514 ((car (member arg org-todo-keywords-1)))
14515 ((nth (1- (prefix-numeric-value arg))
14516 org-todo-keywords-1))))
14517 ((null member) (or head (car org-todo-keywords-1)))
14518 ((equal this final-done-word) nil) ;; -> make empty
14519 ((null tail) nil) ;; -> first entry
14520 ((eq interpret 'sequence)
14521 (car tail))
14522 ((memq interpret '(type priority))
14523 (if (eq this-command last-command)
14524 (car tail)
14525 (if (> (length tail) 0)
14526 (or done-word (car org-done-keywords))
14527 nil)))
14528 (t nil)))
14529 (next (if state (concat " " state " ") " "))
14530 (change-plist (list :type 'todo-state-change :from this :to state
14531 :position startpos))
14532 dostates)
14533 (when org-blocker-hook
14534 (unless (save-excursion
14535 (save-match-data
14536 (run-hook-with-args-until-failure
14537 'org-blocker-hook change-plist)))
14538 (if (interactive-p)
14539 (error "TODO state change from %s to %s blocked" this state)
14540 ;; fail silently
14541 (message "TODO state change from %s to %s blocked" this state)
14542 (throw 'exit nil))))
14543 (store-match-data match-data)
14544 (replace-match next t t)
14545 (unless (pos-visible-in-window-p hl-pos)
14546 (message "TODO state changed to %s" (org-trim next)))
14547 (unless head
14548 (setq head (org-get-todo-sequence-head state)
14549 ass (assoc head org-todo-kwd-alist)
14550 interpret (nth 1 ass)
14551 done-word (nth 3 ass)
14552 final-done-word (nth 4 ass)))
14553 (when (memq arg '(nextset previousset))
14554 (message "Keyword-Set %d/%d: %s"
14555 (- (length org-todo-sets) -1
14556 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14557 (length org-todo-sets)
14558 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14559 (setq org-last-todo-state-is-todo
14560 (not (member state org-done-keywords)))
14561 (when (and org-log-done (not (memq arg '(nextset previousset))))
14562 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
14563 (or (not org-todo-log-states)
14564 (member state org-todo-log-states))))
14566 (cond
14567 ((and state (member state org-not-done-keywords)
14568 (not (member this org-not-done-keywords)))
14569 ;; This is now a todo state and was not one before
14570 ;; Remove any CLOSED timestamp, and possibly log the state change
14571 (org-add-planning-info nil nil 'closed)
14572 (and dostates (org-add-log-maybe 'state state 'findpos)))
14573 ((and state dostates)
14574 ;; This is a non-nil state, and we need to log it
14575 (org-add-log-maybe 'state state 'findpos))
14576 ((and (member state org-done-keywords)
14577 (not (member this org-done-keywords)))
14578 ;; It is now done, and it was not done before
14579 (org-add-planning-info 'closed (org-current-time))
14580 (org-add-log-maybe 'done state 'findpos))))
14581 ;; Fixup tag positioning
14582 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14583 (run-hooks 'org-after-todo-state-change-hook)
14584 (and (member state org-done-keywords) (org-auto-repeat-maybe))
14585 (if (and arg (not (member state org-done-keywords)))
14586 (setq head (org-get-todo-sequence-head state)))
14587 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14588 ;; Fixup cursor location if close to the keyword
14589 (if (and (outline-on-heading-p)
14590 (not (bolp))
14591 (save-excursion (beginning-of-line 1)
14592 (looking-at org-todo-line-regexp))
14593 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14594 (progn
14595 (goto-char (or (match-end 2) (match-end 1)))
14596 (just-one-space)))
14597 (when org-trigger-hook
14598 (save-excursion
14599 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14601 (defun org-get-todo-sequence-head (kwd)
14602 "Return the head of the TODO sequence to which KWD belongs.
14603 If KWD is not set, check if there is a text property remembering the
14604 right sequence."
14605 (let (p)
14606 (cond
14607 ((not kwd)
14608 (or (get-text-property (point-at-bol) 'org-todo-head)
14609 (progn
14610 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14611 nil (point-at-eol)))
14612 (get-text-property p 'org-todo-head))))
14613 ((not (member kwd org-todo-keywords-1))
14614 (car org-todo-keywords-1))
14615 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14617 (defun org-fast-todo-selection ()
14618 "Fast TODO keyword selection with single keys.
14619 Returns the new TODO keyword, or nil if no state change should occur."
14620 (let* ((fulltable org-todo-key-alist)
14621 (done-keywords org-done-keywords) ;; needed for the faces.
14622 (maxlen (apply 'max (mapcar
14623 (lambda (x)
14624 (if (stringp (car x)) (string-width (car x)) 0))
14625 fulltable)))
14626 (expert nil)
14627 (fwidth (+ maxlen 3 1 3))
14628 (ncol (/ (- (window-width) 4) fwidth))
14629 tg cnt e c tbl
14630 groups ingroup)
14631 (save-window-excursion
14632 (if expert
14633 (set-buffer (get-buffer-create " *Org todo*"))
14634 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14635 (erase-buffer)
14636 (org-set-local 'org-done-keywords done-keywords)
14637 (setq tbl fulltable cnt 0)
14638 (while (setq e (pop tbl))
14639 (cond
14640 ((equal e '(:startgroup))
14641 (push '() groups) (setq ingroup t)
14642 (when (not (= cnt 0))
14643 (setq cnt 0)
14645 (insert "{ "))
14646 ((equal e '(:endgroup))
14647 (setq ingroup nil cnt 0)
14649 (t
14650 (setq tg (car e) c (cdr e))
14651 (if ingroup (push tg (car groups)))
14652 (setq tg (org-add-props tg nil 'face
14653 (org-get-todo-face tg)))
14654 (if (and (= cnt 0) (not ingroup)) (insert " "))
14655 (insert "[" c "] " tg (make-string
14656 (- fwidth 4 (length tg)) ?\ ))
14657 (when (= (setq cnt (1+ cnt)) ncol)
14659 (if ingroup (insert " "))
14660 (setq cnt 0)))))
14662 (goto-char (point-min))
14663 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14664 (fit-window-to-buffer))
14665 (message "[a-z..]:Set [SPC]:clear")
14666 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14667 (cond
14668 ((or (= c ?\C-g)
14669 (and (= c ?q) (not (rassoc c fulltable))))
14670 (setq quit-flag t))
14671 ((= c ?\ ) nil)
14672 ((setq e (rassoc c fulltable) tg (car e))
14673 tg)
14674 (t (setq quit-flag t))))))
14676 (defun org-get-repeat ()
14677 "Check if tere is a deadline/schedule with repeater in this entry."
14678 (save-match-data
14679 (save-excursion
14680 (org-back-to-heading t)
14681 (if (re-search-forward
14682 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14683 (match-string 1)))))
14685 (defvar org-last-changed-timestamp)
14686 (defvar org-log-post-message)
14687 (defun org-auto-repeat-maybe ()
14688 "Check if the current headline contains a repeated deadline/schedule.
14689 If yes, set TODO state back to what it was and change the base date
14690 of repeating deadline/scheduled time stamps to new date.
14691 This function should be run in the `org-after-todo-state-change-hook'."
14692 ;; last-state is dynamically scoped into this function
14693 (let* ((repeat (org-get-repeat))
14694 (aa (assoc last-state org-todo-kwd-alist))
14695 (interpret (nth 1 aa))
14696 (head (nth 2 aa))
14697 (done-word (nth 3 aa))
14698 (whata '(("d" . day) ("m" . month) ("y" . year)))
14699 (msg "Entry repeats: ")
14700 (org-log-done)
14701 re type n what ts)
14702 (when repeat
14703 (org-todo (if (eq interpret 'type) last-state head))
14704 (when (and org-log-repeat
14705 (not (memq 'org-add-log-note
14706 (default-value 'post-command-hook))))
14707 ;; Make sure a note is taken
14708 (let ((org-log-done '(done)))
14709 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
14710 'findpos)))
14711 (org-back-to-heading t)
14712 (org-add-planning-info nil nil 'closed)
14716 (while (re-search-forward
14717 re (save-excursion (outline-next-heading) (point)) t)
14718 (setq type (if (match-end 1) org-scheduled-string
14719 (if (match-end 3) org-deadline-string "Plain:"))
14720 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14722 (setq n (string-to-number (match-string 1 ts))
14723 what (match-string 2 ts))
14724 (if (equal what "w") (setq n (* n 7) what "d"))
14725 (org-timestamp-change n (cdr (assoc what whata)))
14726 (setq msg (concat msg type org-last-changed-timestamp " "))))
14727 (setq org-log-post-message msg)
14728 (message "%s" msg))))
14730 (defun org-show-todo-tree (arg)
14731 "Make a compact tree which shows all headlines marked with TODO.
14732 The tree will show the lines where the regexp matches, and all higher
14733 headlines above the match.
14735 With a numeric prefix N, construct a sparse tree for the Nth element
14736 of `org-todo-keywords-1'."
14737 (interactive "P")
14738 (let ((case-fold-search nil)
14739 (kwd-re
14740 (cond ((null arg) org-not-done-regexp)
14741 ((equal arg '(4))
14742 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14743 (mapcar 'list org-todo-keywords-1))))
14747 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14748 (regexp-quote (nth (1- (prefix-numeric-value arg))
14749 org-todo-keywords-1)))
14750 (t (error "Invalid prefix argument: %s" arg)))))
14751 (message "%d TODO entries found"
14752 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14754 (defun org-deadline (&optional remove)
14756 With argument REMOVE, remove any deadline from the item."
14757 (interactive "P")
14758 (if remove
14759 (progn
14760 (org-remove-timestamp-with-keyword org-deadline-string)
14761 (message "Item no longer has a deadline."))
14762 (org-add-planning-info 'deadline nil 'closed)))
14764 (defun org-schedule (&optional remove)
14765 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14766 With argument REMOVE, remove any scheduling date from the item."
14767 (interactive "P")
14768 (if remove
14769 (progn
14770 (org-remove-timestamp-with-keyword org-scheduled-string)
14771 (message "Item is no longer scheduled."))
14772 (org-add-planning-info 'scheduled nil 'closed)))
14774 (defun org-remove-timestamp-with-keyword (keyword)
14775 "Remove all time stamps with KEYWORD in the current entry."
14777 beg)
14778 (save-excursion
14779 (org-back-to-heading t)
14780 (setq beg (point))
14781 (org-end-of-subtree t t)
14782 (while (re-search-backward re beg t)
14783 (replace-match "")
14785 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14787 (defun org-add-planning-info (what &optional time &rest remove)
14788 "Insert new timestamp with keyword in the line directly after the headline.
14789 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14790 If non is given, the user is prompted for a date.
14791 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14792 be removed."
14793 (interactive)
14794 (let (org-time-was-given org-end-time-was-given)
14795 (when what (setq time (or time (org-read-date nil 'to-time))))
14796 (when (and org-insert-labeled-timestamps-at-point
14797 (member what '(scheduled deadline)))
14798 (insert
14799 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14800 (org-insert-time-stamp time org-time-was-given
14801 nil nil nil (list org-end-time-was-given))
14802 (setq what nil))
14803 (save-excursion
14804 (save-restriction
14805 (let (col list elt ts buffer-invisibility-spec)
14806 (org-back-to-heading t)
14808 (goto-char (match-end 1))
14809 (setq col (current-column))
14810 (goto-char (match-end 0))
14812 (if (and (not (looking-at outline-regexp))
14815 (not (equal (match-string 1) org-clock-string)))
14816 (narrow-to-region (match-beginning 0) (match-end 0))
14818 (backward-char 1)
14819 (narrow-to-region (point) (point))
14820 (indent-to-column col))
14821 ;; Check if we have to remove something.
14822 (setq list (cons what remove))
14823 (while list
14824 (setq elt (pop list))
14825 (goto-char (point-min))
14826 (when (or (and (eq elt 'scheduled)
14827 (re-search-forward org-scheduled-time-regexp nil t))
14828 (and (eq elt 'deadline)
14829 (re-search-forward org-deadline-time-regexp nil t))
14830 (and (eq elt 'closed)
14831 (re-search-forward org-closed-time-regexp nil t)))
14832 (replace-match "")
14833 (if (looking-at "--+<[^>]+>") (replace-match ""))
14834 (if (looking-at " +") (replace-match ""))))
14835 (goto-char (point-max))
14836 (when what
14837 (insert
14838 (if (not (equal (char-before) ?\ )) " " "")
14839 (cond ((eq what 'scheduled) org-scheduled-string)
14840 ((eq what 'deadline) org-deadline-string)
14841 ((eq what 'closed) org-closed-string))
14842 " ")
14843 (setq ts (org-insert-time-stamp
14844 time
14845 (or org-time-was-given
14846 (and (eq what 'closed) org-log-done-with-time))
14847 (eq what 'closed)
14848 nil nil (list org-end-time-was-given)))
14849 (end-of-line 1))
14850 (goto-char (point-min))
14851 (widen)
14853 (replace-match ""))
14854 ts)))))
14856 (defvar org-log-note-marker (make-marker))
14857 (defvar org-log-note-purpose nil)
14858 (defvar org-log-note-state nil)
14859 (defvar org-log-note-window-configuration nil)
14860 (defvar org-log-note-return-to (make-marker))
14861 (defvar org-log-post-message nil
14862 "Message to be displayed after a log note has been stored.
14863 The auto-repeater uses this.")
14865 (defun org-add-log-maybe (&optional purpose state findpos)
14866 "Set up the post command hook to take a note."
14867 (save-excursion
14868 (when (and (listp org-log-done)
14869 (memq purpose org-log-done))
14870 (when findpos
14871 (org-back-to-heading t)
14875 (goto-char (match-end 0))
14876 (unless org-log-states-order-reversed
14878 (org-skip-over-state-notes)
14880 (move-marker org-log-note-marker (point))
14881 (setq org-log-note-purpose purpose)
14882 (setq org-log-note-state state)
14883 (add-hook 'post-command-hook 'org-add-log-note 'append))))
14885 (defun org-skip-over-state-notes ()
14886 "Skip past the list of State notes in an entry."
14889 (condition-case nil
14890 (org-next-item)
14891 (error (org-end-of-item)))))
14893 (defun org-add-log-note (&optional purpose)
14894 "Pop up a window for taking a note, and add this note later at point."
14895 (remove-hook 'post-command-hook 'org-add-log-note)
14896 (setq org-log-note-window-configuration (current-window-configuration))
14897 (delete-other-windows)
14898 (move-marker org-log-note-return-to (point))
14899 (switch-to-buffer (marker-buffer org-log-note-marker))
14900 (goto-char org-log-note-marker)
14901 (org-switch-to-buffer-other-window "*Org Note*")
14902 (erase-buffer)
14903 (let ((org-inhibit-startup t)) (org-mode))
14904 (insert (format "# Insert note for %s.
14906 (cond
14907 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14908 ((eq org-log-note-purpose 'done) "closed todo item")
14909 ((eq org-log-note-purpose 'state)
14911 (t (error "This should not happen")))))
14912 (org-set-local 'org-finish-function 'org-store-log-note))
14914 (defun org-store-log-note ()
14915 "Finish taking a log note, and insert it to where it belongs."
14916 (let ((txt (buffer-string))
14917 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14918 lines ind)
14919 (kill-buffer (current-buffer))
14921 (setq txt (replace-match "" t t txt)))
14923 (setq txt (replace-match "" t t txt)))
14926 (setq note
14927 (org-replace-escapes
14928 note
14929 (list (cons "%u" (user-login-name))
14930 (cons "%U" user-full-name)
14931 (cons "%t" (format-time-string
14932 (org-time-stamp-format 'long 'inactive)
14933 (current-time)))
14934 (cons "%s" (if org-log-note-state
14936 "")))))
14938 (push note lines))
14939 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14940 (when lines
14941 (save-excursion
14942 (set-buffer (marker-buffer org-log-note-marker))
14943 (save-excursion
14944 (goto-char org-log-note-marker)
14945 (move-marker org-log-note-marker nil)
14946 (end-of-line 1)
14948 (indent-relative nil)
14949 (insert "- " (pop lines))
14950 (org-indent-line-function)
14951 (beginning-of-line 1)
14953 (setq ind (concat (match-string 0) " "))
14954 (end-of-line 1)
14956 (set-window-configuration org-log-note-window-configuration)
14957 (with-current-buffer (marker-buffer org-log-note-return-to)
14958 (goto-char org-log-note-return-to))
14959 (move-marker org-log-note-return-to nil)
14960 (and org-log-post-message (message "%s" org-log-post-message)))
14962 ;; FIXME: what else would be useful?
14963 ;; - priority
14964 ;; - date
14966 (defun org-sparse-tree (&optional arg)
14967 "Create a sparse tree, prompt for the details.
14968 This command can create sparse trees. You first need to select the type
14969 of match used to create the tree:
14971 t Show entries with a specific TODO keyword.
14972 T Show entries selected by a tags match.
14973 p Enter a property name and its value (both with completion on existing
14974 names/values) and show entries with that property.
14975 r Show entries matching a regular expression
14976 d Show deadlines due within `org-deadline-warning-days'."
14977 (interactive "P")
14978 (let (ans kwd value)
14979 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
14980 (setq ans (read-char-exclusive))
14981 (cond
14982 ((equal ans ?d)
14983 (call-interactively 'org-check-deadlines))
14984 ((equal ans ?b)
14985 (call-interactively 'org-check-before-date))
14986 ((equal ans ?t)
14987 (org-show-todo-tree '(4)))
14988 ((equal ans ?T)
14989 (call-interactively 'org-tags-sparse-tree))
14990 ((member ans '(?p ?P))
14991 (setq kwd (completing-read "Property: "
14992 (mapcar 'list (org-buffer-property-keys))))
14993 (setq value (completing-read "Value: "
14994 (mapcar 'list (org-property-values kwd))))
14997 (org-tags-sparse-tree arg (concat kwd "=" value)))
14998 ((member ans '(?r ?R ?/))
14999 (call-interactively 'org-occur))
15002 (defvar org-occur-highlights nil)
15003 (make-variable-buffer-local 'org-occur-highlights)
15005 (defun org-occur (regexp &optional keep-previous callback)
15006 "Make a compact tree which shows all matches of REGEXP.
15007 The tree will show the lines where the regexp matches, and all higher
15008 headlines above the match. It will also show the heading after the match,
15009 to make sure editing the matching entry is easy.
15010 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15011 call to `org-occur' will be kept, to allow stacking of calls to this
15012 command.
15013 If CALLBACK is non-nil, it is a function which is called to confirm
15014 that the match should indeed be shown."
15016 (or keep-previous (org-remove-occur-highlights nil nil t))
15017 (let ((cnt 0))
15018 (save-excursion
15019 (goto-char (point-min))
15020 (if (or (not keep-previous) ; do not want to keep
15021 (not org-occur-highlights)) ; no previous matches
15022 ;; hide everything
15023 (org-overview))
15024 (while (re-search-forward regexp nil t)
15025 (when (or (not callback)
15026 (save-match-data (funcall callback)))
15027 (setq cnt (1+ cnt))
15028 (when org-highlight-sparse-tree-matches
15029 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15030 (org-show-context 'occur-tree))))
15031 (when org-remove-highlights-with-change
15032 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15033 nil 'local))
15034 (unless org-sparse-tree-open-archived-trees
15035 (org-hide-archived-subtrees (point-min) (point-max)))
15036 (run-hooks 'org-occur-hook)
15037 (if (interactive-p)
15038 (message "%d match(es) for regexp %s" cnt regexp))
15039 cnt))
15041 (defun org-show-context (&optional key)
15042 "Make sure point and context and visible.
15043 How much context is shown depends upon the variables
15044 `org-show-hierarchy-above', `org-show-following-heading'. and
15045 `org-show-siblings'."
15046 (let ((heading-p (org-on-heading-p t))
15047 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15048 (following-p (org-get-alist-option org-show-following-heading key))
15049 (entry-p (org-get-alist-option org-show-entry-below key))
15050 (siblings-p (org-get-alist-option org-show-siblings key)))
15051 (catch 'exit
15052 ;; Show heading or entry text
15053 (if (and heading-p (not entry-p))
15054 (org-flag-heading nil) ; only show the heading
15055 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15056 (org-show-hidden-entry))) ; show entire entry
15057 (when following-p
15058 ;; Show next sibling, or heading below text
15059 (save-excursion
15060 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15061 (org-flag-heading nil))))
15062 (when siblings-p (org-show-siblings))
15063 (when hierarchy-p
15064 ;; show all higher headings, possibly with siblings
15065 (save-excursion
15066 (while (and (condition-case nil
15067 (progn (org-up-heading-all 1) t)
15068 (error nil))
15069 (not (bobp)))
15070 (org-flag-heading nil)
15071 (when siblings-p (org-show-siblings))))))))
15073 (defun org-reveal (&optional siblings)
15074 "Show current entry, hierarchy above it, and the following headline.
15075 This can be used to show a consistent set of context around locations
15076 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15077 not t for the search context.
15079 With optional argument SIBLINGS, on each level of the hierarchy all
15080 siblings are shown. This repairs the tree structure to what it would
15081 look like when opened with hierarchical calls to `org-cycle'."
15082 (interactive "P")
15083 (let ((org-show-hierarchy-above t)
15084 (org-show-following-heading t)
15085 (org-show-siblings (if siblings t org-show-siblings)))
15086 (org-show-context nil)))
15088 (defun org-highlight-new-match (beg end)
15089 "Highlight from BEG to END and mark the highlight is an occur headline."
15090 (let ((ov (org-make-overlay beg end)))
15091 (org-overlay-put ov 'face 'secondary-selection)
15092 (push ov org-occur-highlights)))
15094 (defun org-remove-occur-highlights (&optional beg end noremove)
15095 "Remove the occur highlights from the buffer.
15096 BEG and END are ignored. If NOREMOVE is nil, remove this function
15097 from the `before-change-functions' in the current buffer."
15098 (interactive)
15099 (unless org-inhibit-highlight-removal
15100 (mapc 'org-delete-overlay org-occur-highlights)
15101 (setq org-occur-highlights nil)
15102 (unless noremove
15103 (remove-hook 'before-change-functions
15104 'org-remove-occur-highlights 'local))))
15106 ;;;; Priorities
15109 "Regular expression matching the priority indicator.")
15111 (defvar org-remove-priority-next-time nil)
15113 (defun org-priority-up ()
15114 "Increase the priority of the current item."
15115 (interactive)
15116 (org-priority 'up))
15118 (defun org-priority-down ()
15119 "Decrease the priority of the current item."
15120 (interactive)
15121 (org-priority 'down))
15123 (defun org-priority (&optional action)
15124 "Change the priority of an item by ARG.
15125 ACTION can be `set', `up', `down', or a character."
15126 (interactive)
15127 (setq action (or action 'set))
15128 (let (current new news have remove)
15129 (save-excursion
15130 (org-back-to-heading)
15131 (if (looking-at org-priority-regexp)
15132 (setq current (string-to-char (match-string 2))
15133 have t)
15134 (setq current org-default-priority))
15135 (cond
15136 ((or (eq action 'set) (integerp action))
15137 (if (integerp action)
15138 (setq new action)
15139 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15140 (setq new (read-char-exclusive)))
15141 (if (and (= (upcase org-highest-priority) org-highest-priority)
15142 (= (upcase org-lowest-priority) org-lowest-priority))
15143 (setq new (upcase new)))
15144 (cond ((equal new ?\ ) (setq remove t))
15145 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15146 (error "Priority must be between `%c' and `%c'"
15147 org-highest-priority org-lowest-priority))))
15148 ((eq action 'up)
15149 (if (and (not have) (eq last-command this-command))
15150 (setq new org-lowest-priority)
15151 (setq new (if (and org-priority-start-cycle-with-default (not have))
15152 org-default-priority (1- current)))))
15153 ((eq action 'down)
15154 (if (and (not have) (eq last-command this-command))
15155 (setq new org-highest-priority)
15156 (setq new (if (and org-priority-start-cycle-with-default (not have))
15157 org-default-priority (1+ current)))))
15158 (t (error "Invalid action")))
15159 (if (or (< (upcase new) org-highest-priority)
15160 (> (upcase new) org-lowest-priority))
15161 (setq remove t))
15162 (setq news (format "%c" new))
15163 (if have
15164 (if remove
15165 (replace-match "" t t nil 1)
15166 (replace-match news t t nil 2))
15167 (if remove
15168 (error "No priority cookie found in line")
15169 (looking-at org-todo-line-regexp)
15170 (if (match-end 2)
15171 (progn
15172 (goto-char (match-end 2))
15173 (insert " [#" news "]"))
15174 (goto-char (match-beginning 3))
15175 (insert "[#" news "] ")))))
15176 (org-preserve-lc (org-set-tags nil 'align))
15177 (if remove
15178 (message "Priority removed")
15179 (message "Priority of current item set to %s" news))))
15182 (defun org-get-priority (s)
15183 "Find priority cookie and return priority."
15184 (save-match-data
15185 (if (not (string-match org-priority-regexp s))
15186 (* 1000 (- org-lowest-priority org-default-priority))
15187 (* 1000 (- org-lowest-priority
15188 (string-to-char (match-string 2 s)))))))
15190 ;;;; Tags
15192 (defun org-scan-tags (action matcher &optional todo-only)
15193 "Scan headline tags with inheritance and produce output ACTION.
15194 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15195 evaluated, testing if a given set of tags qualifies a headline for
15196 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15197 are included in the output."
15200 (org-re
15202 (props (list 'face nil
15203 'done-face 'org-done
15204 'undone-face nil
15205 'mouse-face 'highlight
15206 'org-not-done-regexp org-not-done-regexp
15207 'org-todo-regexp org-todo-regexp
15208 'keymap org-agenda-keymap
15209 'help-echo
15210 (format "mouse-2 or RET jump to org file %s"
15211 (abbreviate-file-name
15212 (or (buffer-file-name (buffer-base-buffer))
15213 (buffer-name (buffer-base-buffer)))))))
15214 (case-fold-search nil)
15215 lspos
15216 tags tags-list tags-alist (llast 0) rtn level category i txt
15217 todo marker entry priority)
15218 (save-excursion
15219 (goto-char (point-min))
15220 (when (eq action 'sparse-tree)
15221 (org-overview)
15222 (org-remove-occur-highlights))
15223 (while (re-search-forward re nil t)
15224 (catch :skip
15225 (setq todo (if (match-end 1) (match-string 2))
15226 tags (if (match-end 4) (match-string 4)))
15227 (goto-char (setq lspos (1+ (match-beginning 0))))
15228 (setq level (org-reduced-level (funcall outline-level))
15229 category (org-get-category))
15230 (setq i llast llast level)
15231 ;; remove tag lists from same and sublevels
15232 (while (>= i level)
15233 (when (setq entry (assoc i tags-alist))
15234 (setq tags-alist (delete entry tags-alist)))
15235 (setq i (1- i)))
15236 ;; add the nex tags
15237 (when tags
15238 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15239 tags-alist
15240 (cons (cons level tags) tags-alist)))
15241 ;; compile tags for current headline
15242 (setq tags-list
15243 (if org-use-tag-inheritance
15244 (apply 'append (mapcar 'cdr tags-alist))
15245 tags))
15246 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15247 (eval matcher)
15248 (or (not org-agenda-skip-archived-trees)
15249 (not (member org-archive-tag tags-list))))
15250 (and (eq action 'agenda) (org-agenda-skip))
15251 ;; list this headline
15253 (if (eq action 'sparse-tree)
15254 (progn
15255 (and org-highlight-sparse-tree-matches
15256 (org-get-heading) (match-end 0)
15257 (org-highlight-new-match
15258 (match-beginning 0) (match-beginning 1)))
15259 (org-show-context 'tags-tree))
15260 (setq txt (org-format-agenda-item
15261 ""
15262 (concat
15263 (if org-tags-match-list-sublevels
15264 (make-string (1- level) ?.) "")
15265 (org-get-heading))
15266 category tags-list)
15267 priority (org-get-priority txt))
15268 (goto-char lspos)
15269 (setq marker (org-agenda-new-marker))
15270 (org-add-props txt props
15271 'org-marker marker 'org-hd-marker marker 'org-category category
15272 'priority priority 'type "tagsmatch")
15273 (push txt rtn))
15274 ;; if we are to skip sublevels, jump to end of subtree
15275 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15276 (when (and (eq action 'sparse-tree)
15277 (not org-sparse-tree-open-archived-trees))
15278 (org-hide-archived-subtrees (point-min) (point-max)))
15279 (nreverse rtn)))
15281 (defvar todo-only) ;; dynamically scoped
15283 (defun org-tags-sparse-tree (&optional todo-only match)
15284 "Create a sparse tree according to tags string MATCH.
15285 MATCH can contain positive and negative selection of tags, like
15287 If optional argument TODO_ONLY is non-nil, only select lines that are
15288 also TODO lines."
15289 (interactive "P")
15290 (org-prepare-agenda-buffers (list (current-buffer)))
15291 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15293 (defvar org-cached-props nil)
15294 (defun org-cached-entry-get (pom property)
15295 (if (or (eq t org-use-property-inheritance)
15296 (member property org-use-property-inheritance))
15297 ;; Caching is not possible, check it directly
15298 (org-entry-get pom property 'inherit)
15299 ;; Get all properties, so that we can do complicated checks easily
15300 (cdr (assoc property (or org-cached-props
15301 (setq org-cached-props
15302 (org-entry-properties pom)))))))
15304 (defun org-global-tags-completion-table (&optional files)
15305 "Return the list of all tags in all agenda buffer/files."
15306 (save-excursion
15307 (org-uniquify
15308 (delq nil
15309 (apply 'append
15310 (mapcar
15311 (lambda (file)
15312 (set-buffer (find-file-noselect file))
15313 (append (org-get-buffer-tags)
15314 (mapcar (lambda (x) (if (stringp (car-safe x))
15315 (list (car-safe x)) nil))
15316 org-tag-alist)))
15317 (if (and files (car files))
15318 files
15319 (org-agenda-files))))))))
15321 (defun org-make-tags-matcher (match)
15322 "Create the TAGS//TODO matcher form for the selection string MATCH."
15323 ;; todo-only is scoped dynamically into this function, and the function
15324 ;; may change it it the matcher asksk for it.
15325 (unless match
15326 ;; Get a new match request, with completion
15327 (let ((org-last-tags-completion-table
15328 (org-global-tags-completion-table)))
15329 (setq match (completing-read
15330 "Match: " 'org-tags-completion-function nil nil nil
15331 'org-tags-history))))
15333 ;; Parse the string and create a lisp form
15334 (let ((match0 match)
15335 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15336 minus tag mm
15337 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15338 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15339 (if (string-match "/+" match)
15340 ;; match contains also a todo-matching request
15341 (progn
15342 (setq tagsmatch (substring match 0 (match-beginning 0))
15343 todomatch (substring match (match-end 0)))
15344 (if (string-match "^!" todomatch)
15345 (setq todo-only t todomatch (substring todomatch 1)))
15347 (setq todomatch nil)))
15348 ;; only matching tags
15349 (setq tagsmatch match todomatch nil))
15351 ;; Make the tags matcher
15353 (setq tagsmatcher t)
15354 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15355 (while (setq term (pop orterms))
15357 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15358 (while (string-match re term)
15359 (setq minus (and (match-end 1)
15360 (equal (match-string 1 term) "-"))
15361 tag (match-string 2 term)
15362 re-p (equal (string-to-char tag) ?{)
15363 level-p (match-end 3)
15364 prop-p (match-end 4)
15365 mm (cond
15366 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15367 (level-p `(= level ,(string-to-number
15368 (match-string 3 term))))
15369 (prop-p
15370 (setq pn (match-string 4 term)
15371 pv (match-string 5 term)
15372 cat-p (equal pn "CATEGORY")
15373 re-p (equal (string-to-char pv) ?{)
15374 pv (substring pv 1 -1))
15375 (if (equal pn "CATEGORY")
15376 (setq gv '(get-text-property (point) 'org-category))
15377 (setq gv `(org-cached-entry-get nil ,pn)))
15378 (if re-p
15379 `(string-match ,pv (or ,gv ""))
15380 `(equal ,pv (or ,gv ""))))
15381 (t `(member ,(downcase tag) tags-list)))
15382 mm (if minus (list 'not mm) mm)
15383 term (substring term (match-end 0)))
15384 (push mm tagsmatcher))
15385 (push (if (> (length tagsmatcher) 1)
15386 (cons 'and tagsmatcher)
15387 (car tagsmatcher))
15388 orlist)
15389 (setq tagsmatcher nil))
15390 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15391 (setq tagsmatcher
15392 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15394 ;; Make the todo matcher
15396 (setq todomatcher t)
15397 (setq orterms (org-split-string todomatch "|") orlist nil)
15398 (while (setq term (pop orterms))
15399 (while (string-match re term)
15400 (setq minus (and (match-end 1)
15401 (equal (match-string 1 term) "-"))
15402 kwd (match-string 2 term)
15403 re-p (equal (string-to-char kwd) ?{)
15404 term (substring term (match-end 0))
15405 mm (if re-p
15406 `(string-match ,(substring kwd 1 -1) todo)
15407 (list 'equal 'todo kwd))
15408 mm (if minus (list 'not mm) mm))
15409 (push mm todomatcher))
15410 (push (if (> (length todomatcher) 1)
15411 (cons 'and todomatcher)
15412 (car todomatcher))
15413 orlist)
15414 (setq todomatcher nil))
15415 (setq todomatcher (if (> (length orlist) 1)
15416 (cons 'or orlist) (car orlist))))
15418 ;; Return the string and lisp forms of the matcher
15419 (setq matcher (if todomatcher
15420 (list 'and tagsmatcher todomatcher)
15421 tagsmatcher))
15422 (cons match0 matcher)))
15424 (defun org-match-any-p (re list)
15425 "Does re match any element of list?"
15426 (setq list (mapcar (lambda (x) (string-match re x)) list))
15427 (delq nil list))
15429 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15430 (defvar org-tags-overlay (org-make-overlay 1 1))
15431 (org-detach-overlay org-tags-overlay)
15433 (defun org-align-tags-here (to-col)
15434 ;; Assumes that this is a headline
15435 (let ((pos (point)) (col (current-column)) tags)
15436 (beginning-of-line 1)
15438 (< pos (match-beginning 2)))
15439 (progn
15440 (setq tags (match-string 2))
15441 (goto-char (match-beginning 1))
15442 (insert " ")
15443 (delete-region (point) (1+ (match-end 0)))
15444 (backward-char 1)
15445 (move-to-column
15446 (max (1+ (current-column))
15447 (1+ col)
15448 (if (> to-col 0)
15449 to-col
15450 (- (abs to-col) (length tags))))
15451 t)
15452 (insert tags)
15453 (move-to-column (min (current-column) col) t))
15454 (goto-char pos))))
15456 (defun org-set-tags (&optional arg just-align)
15457 "Set the tags for the current headline.
15458 With prefix ARG, realign all tags in headings in the current buffer."
15459 (interactive "P")
15460 (let* ((re (concat "^" outline-regexp))
15461 (current (org-get-tags-string))
15462 (col (current-column))
15463 (org-setting-tags t)
15464 table current-tags inherited-tags ; computed below when needed
15465 tags p0 c0 c1 rpl)
15466 (if arg
15467 (save-excursion
15468 (goto-char (point-min))
15469 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15470 (while (re-search-forward re nil t)
15471 (org-set-tags nil t)
15472 (end-of-line 1)))
15473 (message "All tags realigned to column %d" org-tags-column))
15474 (if just-align
15475 (setq tags current)
15476 ;; Get a new set of tags from the user
15477 (save-excursion
15478 (setq table (or org-tag-alist (org-get-buffer-tags))
15479 org-last-tags-completion-table table
15480 current-tags (org-split-string current ":")
15481 inherited-tags (nreverse
15482 (nthcdr (length current-tags)
15483 (nreverse (org-get-tags-at))))
15484 tags
15485 (if (or (eq t org-use-fast-tag-selection)
15486 (and org-use-fast-tag-selection
15487 (delq nil (mapcar 'cdr table))))
15488 (org-fast-tag-selection
15489 current-tags inherited-tags table
15490 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15491 (let ((org-add-colon-after-tag-completion t))
15492 (org-trim
15493 (org-without-partial-completion
15494 (completing-read "Tags: " 'org-tags-completion-function
15495 nil nil current 'org-tags-history)))))))
15496 (while (string-match "[-+&]+" tags)
15497 ;; No boolean logic, just a list
15498 (setq tags (replace-match ":" t t tags))))
15501 (setq tags "")
15502 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15503 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15505 ;; Insert new tags at the correct column
15506 (beginning-of-line 1)
15507 (cond
15508 ((and (equal current "") (equal tags "")))
15509 ((re-search-forward
15511 (point-at-eol) t)
15512 (if (equal tags "")
15513 (setq rpl "")
15514 (goto-char (match-beginning 0))
15515 (setq c0 (current-column) p0 (point)
15516 c1 (max (1+ c0) (if (> org-tags-column 0)
15517 org-tags-column
15518 (- (- org-tags-column) (length tags))))
15519 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15520 (replace-match rpl t t)
15521 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15522 tags)
15523 (t (error "Tags alignment failed")))
15524 (move-to-column col)
15525 (unless just-align
15526 (run-hooks 'org-after-tags-change-hook)))))
15528 (defun org-change-tag-in-region (beg end tag off)
15529 "Add or remove TAG for each entry in the region.
15530 This works in the agenda, and also in an org-mode buffer."
15531 (interactive
15532 (list (region-beginning) (region-end)
15533 (let ((org-last-tags-completion-table
15534 (if (org-mode-p)
15535 (org-get-buffer-tags)
15536 (org-global-tags-completion-table))))
15537 (completing-read
15538 "Tag: " 'org-tags-completion-function nil nil nil
15539 'org-tags-history))
15540 (progn
15541 (message "[s]et or [r]emove? ")
15542 (equal (read-char-exclusive) ?r))))
15543 (if (fboundp 'deactivate-mark) (deactivate-mark))
15544 (let ((agendap (equal major-mode 'org-agenda-mode))
15545 l1 l2 m buf pos newhead (cnt 0))
15546 (goto-char end)
15547 (setq l2 (1- (org-current-line)))
15548 (goto-char beg)
15549 (setq l1 (org-current-line))
15550 (loop for l from l1 to l2 do
15551 (goto-line l)
15552 (setq m (get-text-property (point) 'org-hd-marker))
15553 (when (or (and (org-mode-p) (org-on-heading-p))
15554 (and agendap m))
15555 (setq buf (if agendap (marker-buffer m) (current-buffer))
15556 pos (if agendap m (point)))
15557 (with-current-buffer buf
15558 (save-excursion
15559 (save-restriction
15560 (goto-char pos)
15561 (setq cnt (1+ cnt))
15562 (org-toggle-tag tag (if off 'off 'on))
15563 (setq newhead (org-get-heading)))))
15564 (and agendap (org-agenda-change-all-lines newhead m))))
15565 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15567 (defun org-tags-completion-function (string predicate &optional flag)
15568 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15569 (confirm (lambda (x) (stringp (car x)))))
15571 (setq s1 (match-string 1 string)
15572 s2 (match-string 2 string))
15573 (setq s1 "" s2 string))
15574 (cond
15575 ((eq flag nil)
15576 ;; try completion
15577 (setq rtn (try-completion s2 ctable confirm))
15578 (if (stringp rtn)
15579 (setq rtn
15580 (concat s1 s2 (substring rtn (length s2))
15581 (if (and org-add-colon-after-tag-completion
15582 (assoc rtn ctable))
15583 ":" ""))))
15584 rtn)
15585 ((eq flag t)
15586 ;; all-completions
15587 (all-completions s2 ctable confirm)
15588 )
15589 ((eq flag 'lambda)
15590 ;; exact match?
15591 (assoc s2 ctable)))
15592 ))
15594 (defun org-fast-tag-insert (kwd tags face &optional end)
15595 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15596 (insert (format "%-12s" (concat kwd ":"))
15597 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15598 (or end "")))
15600 (defun org-fast-tag-show-exit (flag)
15601 (save-excursion
15602 (goto-line 3)
15604 (replace-match ""))
15605 (when flag
15606 (end-of-line 1)
15607 (move-to-column (- (window-width) 19) t)
15608 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15610 (defun org-set-current-tags-overlay (current prefix)
15611 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15612 (if (featurep 'xemacs)
15613 (org-overlay-display org-tags-overlay (concat prefix s)
15614 'secondary-selection)
15615 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15616 (org-overlay-display org-tags-overlay (concat prefix s)))))
15618 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15619 "Fast tag selection with single keys.
15620 CURRENT is the current list of tags in the headline, INHERITED is the
15621 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15622 possibly with grouping information. TODO-TABLE is a similar table with
15623 TODO keywords, should these have keys assigned to them.
15624 If the keys are nil, a-z are automatically assigned.
15625 Returns the new tags string, or nil to not change the current settings."
15626 (let* ((fulltable (append table todo-table))
15627 (maxlen (apply 'max (mapcar
15628 (lambda (x)
15629 (if (stringp (car x)) (string-width (car x)) 0))
15630 fulltable)))
15631 (buf (current-buffer))
15632 (expert (eq org-fast-tag-selection-single-key 'expert))
15633 (buffer-tags nil)
15634 (fwidth (+ maxlen 3 1 3))
15635 (ncol (/ (- (window-width) 4) fwidth))
15636 (i-face 'org-done)
15637 (c-face 'org-todo)
15638 tg cnt e c char c1 c2 ntable tbl rtn
15639 ov-start ov-end ov-prefix
15640 (exit-after-next org-fast-tag-selection-single-key)
15641 (done-keywords org-done-keywords)
15642 groups ingroup)
15643 (save-excursion
15644 (beginning-of-line 1)
15645 (if (looking-at
15647 (setq ov-start (match-beginning 1)
15648 ov-end (match-end 1)
15649 ov-prefix "")
15650 (setq ov-start (1- (point-at-eol))
15651 ov-end (1+ ov-start))
15653 (setq ov-prefix
15654 (concat
15655 (buffer-substring (1- (point)) (point))
15656 (if (> (current-column) org-tags-column)
15657 " "
15658 (make-string (- org-tags-column (current-column)) ?\ ))))))
15659 (org-move-overlay org-tags-overlay ov-start ov-end)
15660 (save-window-excursion
15661 (if expert
15662 (set-buffer (get-buffer-create " *Org tags*"))
15663 (delete-other-windows)
15664 (split-window-vertically)
15665 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15666 (erase-buffer)
15667 (org-set-local 'org-done-keywords done-keywords)
15670 (org-fast-tag-show-exit exit-after-next)
15671 (org-set-current-tags-overlay current ov-prefix)
15672 (setq tbl fulltable char ?a cnt 0)
15673 (while (setq e (pop tbl))
15674 (cond
15675 ((equal e '(:startgroup))
15676 (push '() groups) (setq ingroup t)
15677 (when (not (= cnt 0))
15678 (setq cnt 0)
15680 (insert "{ "))
15681 ((equal e '(:endgroup))
15682 (setq ingroup nil cnt 0)
15684 (t
15685 (setq tg (car e) c2 nil)
15686 (if (cdr e)
15687 (setq c (cdr e))
15688 ;; automatically assign a character.
15689 (setq c1 (string-to-char
15690 (downcase (substring
15691 tg (if (= (string-to-char tg) ?@) 1 0)))))
15692 (if (or (rassoc c1 ntable) (rassoc c1 table))
15693 (while (or (rassoc char ntable) (rassoc char table))
15694 (setq char (1+ char)))
15695 (setq c2 c1))
15696 (setq c (or c2 char)))
15697 (if ingroup (push tg (car groups)))
15698 (setq tg (org-add-props tg nil 'face
15699 (cond
15700 ((not (assoc tg table))
15701 (org-get-todo-face tg))
15702 ((member tg current) c-face)
15703 ((member tg inherited) i-face)
15704 (t nil))))
15705 (if (and (= cnt 0) (not ingroup)) (insert " "))
15706 (insert "[" c "] " tg (make-string
15707 (- fwidth 4 (length tg)) ?\ ))
15708 (push (cons tg c) ntable)
15709 (when (= (setq cnt (1+ cnt)) ncol)
15711 (if ingroup (insert " "))
15712 (setq cnt 0)))))
15713 (setq ntable (nreverse ntable))
15715 (goto-char (point-min))
15716 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15717 (fit-window-to-buffer))
15718 (setq rtn
15719 (catch 'exit
15720 (while t
15721 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15722 (if groups " [!] no groups" " [!]groups")
15723 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15724 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15725 (cond
15727 ((= c ?!)
15728 (setq groups (not groups))
15729 (goto-char (point-min))
15730 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15731 ((= c ?\C-c)
15732 (if (not expert)
15733 (org-fast-tag-show-exit
15734 (setq exit-after-next (not exit-after-next)))
15735 (setq expert nil)
15736 (delete-other-windows)
15737 (split-window-vertically)
15738 (org-switch-to-buffer-other-window " *Org tags*")
15739 (and (fboundp 'fit-window-to-buffer)
15740 (fit-window-to-buffer))))
15741 ((or (= c ?\C-g)
15742 (and (= c ?q) (not (rassoc c ntable))))
15743 (org-detach-overlay org-tags-overlay)
15744 (setq quit-flag t))
15745 ((= c ?\ )
15746 (setq current nil)
15747 (if exit-after-next (setq exit-after-next 'now)))
15749 (condition-case nil
15750 (setq tg (completing-read
15751 "Tag: "
15752 (or buffer-tags
15753 (with-current-buffer buf
15754 (org-get-buffer-tags)))))
15755 (quit (setq tg "")))
15757 (add-to-list 'buffer-tags (list tg))
15758 (if (member tg current)
15759 (setq current (delete tg current))
15760 (push tg current)))
15761 (if exit-after-next (setq exit-after-next 'now)))
15762 ((setq e (rassoc c todo-table) tg (car e))
15763 (with-current-buffer buf
15764 (save-excursion (org-todo tg)))
15765 (if exit-after-next (setq exit-after-next 'now)))
15766 ((setq e (rassoc c ntable) tg (car e))
15767 (if (member tg current)
15768 (setq current (delete tg current))
15769 (loop for g in groups do
15770 (if (member tg g)
15771 (mapc (lambda (x)
15772 (setq current (delete x current)))
15773 g)))
15774 (push tg current))
15775 (if exit-after-next (setq exit-after-next 'now))))
15777 ;; Create a sorted list
15778 (setq current
15779 (sort current
15780 (lambda (a b)
15781 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15782 (if (eq exit-after-next 'now) (throw 'exit t))
15783 (goto-char (point-min))
15784 (beginning-of-line 2)
15785 (delete-region (point) (point-at-eol))
15786 (org-fast-tag-insert "Current" current c-face)
15787 (org-set-current-tags-overlay current ov-prefix)
15788 (while (re-search-forward
15790 (setq tg (match-string 1))
15791 (add-text-properties
15792 (match-beginning 1) (match-end 1)
15793 (list 'face
15794 (cond
15795 ((member tg current) c-face)
15796 ((member tg inherited) i-face)
15797 (t (get-text-property (match-beginning 1) 'face))))))
15798 (goto-char (point-min)))))
15799 (org-detach-overlay org-tags-overlay)
15800 (if rtn
15801 (mapconcat 'identity current ":")
15802 nil))))
15804 (defun org-get-tags-string ()
15805 "Get the TAGS string in the current headline."
15806 (unless (org-on-heading-p t)
15807 (error "Not on a heading"))
15808 (save-excursion
15809 (beginning-of-line 1)
15811 (org-match-string-no-properties 1)
15812 "")))
15814 (defun org-get-tags ()
15815 "Get the list of tags specified in the current headline."
15816 (org-split-string (org-get-tags-string) ":"))
15818 (defun org-get-buffer-tags ()
15819 "Get a table of all tags used in the buffer, for completion."
15820 (let (tags)
15821 (save-excursion
15822 (goto-char (point-min))
15823 (while (re-search-forward
15825 (when (equal (char-after (point-at-bol 0)) ?*)
15826 (mapc (lambda (x) (add-to-list 'tags x))
15827 (org-split-string (org-match-string-no-properties 1) ":")))))
15828 (mapcar 'list tags)))
15831 ;;;; Properties
15833 ;;; Setting and retrieving properties
15835 (defconst org-special-properties
15836 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15837 "TIMESTAMP" "TIMESTAMP_IA")
15838 "The special properties valid in Org-mode.
15840 These are properties that are not defined in the property drawer,
15841 but in some other way.")
15843 (defconst org-default-properties
15844 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15845 "LOCATION" "LOGGING" "COLUMNS")
15846 "Some properties that are used by Org-mode for various purposes.
15847 Being in this list makes sure that they are offered for completion.")
15850 "Regular expression matching the first line of a property drawer.")
15853 "Regular expression matching the first line of a property drawer.")
15855 (defun org-property-action ()
15856 "Do an action on properties."
15857 (interactive)
15858 (let (c)
15859 (org-at-property-p)
15860 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15861 (setq c (read-char-exclusive))
15862 (cond
15863 ((equal c ?s)
15864 (call-interactively 'org-set-property))
15865 ((equal c ?d)
15866 (call-interactively 'org-delete-property))
15867 ((equal c ?D)
15868 (call-interactively 'org-delete-property-globally))
15869 ((equal c ?c)
15870 (call-interactively 'org-compute-property-at-point))
15871 (t (error "No such property action %c" c)))))
15873 (defun org-at-property-p ()
15874 "Is the cursor in a property line?"
15875 ;; FIXME: Does not check if we are actually in the drawer.
15876 ;; FIXME: also returns true on any drawers.....
15877 ;; This is used by C-c C-c for property action.
15878 (save-excursion
15879 (beginning-of-line 1)
15882 (defmacro org-with-point-at (pom &rest body)
15883 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15884 (declare (indent 1) (debug t))
15885 `(save-excursion
15886 (if (markerp pom) (set-buffer (marker-buffer pom)))
15887 (save-excursion
15888 (goto-char (or pom (point)))
15889 ,@body)))
15891 (defun org-get-property-block (&optional beg end force)
15892 "Return the (beg . end) range of the body of the property drawer.
15893 BEG and END can be beginning and end of subtree, if not given
15894 they will be found.
15895 If the drawer does not exist and FORCE is non-nil, create the drawer."
15896 (catch 'exit
15897 (save-excursion
15898 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15899 (end (or end (progn (outline-next-heading) (point)))))
15900 (goto-char beg)
15901 (if (re-search-forward org-property-start-re end t)
15902 (setq beg (1+ (match-end 0)))
15903 (if force
15904 (save-excursion
15905 (org-insert-property-drawer)
15906 (setq end (progn (outline-next-heading) (point))))
15907 (throw 'exit nil))
15908 (goto-char beg)
15909 (if (re-search-forward org-property-start-re end t)
15910 (setq beg (1+ (match-end 0)))))
15911 (if (re-search-forward org-property-end-re end t)
15912 (setq end (match-beginning 0))
15913 (or force (throw 'exit nil))
15914 (goto-char beg)
15915 (setq end beg)
15916 (org-indent-line-function)
15918 (cons beg end)))))
15920 (defun org-entry-properties (&optional pom which)
15921 "Get all properties of the entry at point-or-marker POM.
15922 This includes the TODO keyword, the tags, time strings for deadline,
15923 scheduled, and clocking, and any additional properties defined in the
15924 entry. The return value is an alist, keys may occur multiple times
15925 if the property key was used several times.
15926 POM may also be nil, in which case the current entry is used.
15927 If WHICH is nil or `all', get all properties. If WHICH is
15928 `special' or `standard', only get that subclass."
15929 (setq which (or which 'all))
15930 (org-with-point-at pom
15931 (let ((clockstr (substring org-clock-string 0 -1))
15932 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15933 beg end range props sum-props key value string clocksum)
15934 (save-excursion
15935 (when (condition-case nil (org-back-to-heading t) (error nil))
15936 (setq beg (point))
15937 (setq sum-props (get-text-property (point) 'org-summaries))
15938 (setq clocksum (get-text-property (point) :org-clock-minutes))
15939 (outline-next-heading)
15940 (setq end (point))
15941 (when (memq which '(all special))
15942 ;; Get the special properties, like TODO and tags
15943 (goto-char beg)
15944 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15945 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15946 (when (looking-at org-priority-regexp)
15947 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15948 (when (and (setq value (org-get-tags-string))
15950 (push (cons "TAGS" value) props))
15951 (when (setq value (org-get-tags-at))
15952 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
15953 props))
15954 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15955 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
15956 string (if (equal key clockstr)
15957 (org-no-properties
15958 (org-trim
15959 (buffer-substring
15960 (match-beginning 3) (goto-char (point-at-eol)))))
15961 (substring (org-match-string-no-properties 3) 1 -1)))
15962 (unless key
15963 (if (= (char-after (match-beginning 3)) ?\[)
15964 (setq key "TIMESTAMP_IA")
15965 (setq key "TIMESTAMP")))
15966 (when (or (equal key clockstr) (not (assoc key props)))
15967 (push (cons key string) props)))
15969 )
15971 (when (memq which '(all standard))
15972 ;; Get the standard properties, like :PORP: ...
15973 (setq range (org-get-property-block beg end))
15974 (when range
15975 (goto-char (car range))
15976 (while (re-search-forward
15978 (cdr range) t)
15979 (setq key (org-match-string-no-properties 1)
15980 value (org-trim (or (org-match-string-no-properties 2) "")))
15981 (unless (member key excluded)
15982 (push (cons key (or value "")) props)))))
15983 (if clocksum
15984 (push (cons "CLOCKSUM"
15985 (org-column-number-to-string (/ (float clocksum) 60.)
15986 'add_times))
15987 props))
15988 (append sum-props (nreverse props)))))))
15990 (defun org-entry-get (pom property &optional inherit)
15991 "Get value of PROPERTY for entry at point-or-marker POM.
15992 If INHERIT is non-nil and the entry does not have the property,
15993 then also check higher levels of the hierarchy.
15994 If the property is present but empty, the return value is the empty string.
15995 If the property is not present at all, nil is returned."
15996 (org-with-point-at pom
15997 (if inherit
15998 (org-entry-get-with-inheritance property)
15999 (if (member property org-special-properties)
16000 ;; We need a special property. Use brute force, get all properties.
16001 (cdr (assoc property (org-entry-properties nil 'special)))
16002 (let ((range (org-get-property-block)))
16003 (if (and range
16004 (goto-char (car range))
16005 (re-search-forward
16007 (cdr range) t))
16008 ;; Found the property, return it.
16009 (if (match-end 1)
16010 (org-match-string-no-properties 1)
16011 "")))))))
16013 (defun org-entry-delete (pom property)
16014 "Delete the property PROPERTY from entry at point-or-marker POM."
16015 (org-with-point-at pom
16016 (if (member property org-special-properties)
16017 nil ; cannot delete these properties.
16018 (let ((range (org-get-property-block)))
16019 (if (and range
16020 (goto-char (car range))
16021 (re-search-forward
16023 (cdr range) t))
16024 (progn
16025 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16026 t)
16027 nil)))))
16029 ;; Multi-values properties are properties that contain multiple values
16030 ;; These values are assumed to be single words, separated by whitespace.
16031 (defun org-entry-add-to-multivalued-property (pom property value)
16032 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16033 (let* ((old (org-entry-get pom property))
16035 (unless (member value values)
16036 (setq values (cons value values))
16037 (org-entry-put pom property
16038 (mapconcat 'identity values " ")))))
16040 (defun org-entry-remove-from-multivalued-property (pom property value)
16041 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16042 (let* ((old (org-entry-get pom property))
16044 (when (member value values)
16045 (setq values (delete value values))
16046 (org-entry-put pom property
16047 (mapconcat 'identity values " ")))))
16049 (defun org-entry-member-in-multivalued-property (pom property value)
16050 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16051 (let* ((old (org-entry-get pom property))
16053 (member value values)))
16055 (defvar org-entry-property-inherited-from (make-marker))
16057 (defun org-entry-get-with-inheritance (property)
16058 "Get entry property, and search higher levels if not present."
16059 (let (tmp)
16060 (save-excursion
16061 (save-restriction
16062 (widen)
16063 (catch 'ex
16064 (while t
16065 (when (setq tmp (org-entry-get nil property))
16066 (org-back-to-heading t)
16067 (move-marker org-entry-property-inherited-from (point))
16068 (throw 'ex tmp))
16069 (or (org-up-heading-safe) (throw 'ex nil)))))
16070 (or tmp (cdr (assoc property org-local-properties))
16071 (cdr (assoc property org-global-properties))))))
16073 (defun org-entry-put (pom property value)
16074 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16075 (org-with-point-at pom
16076 (org-back-to-heading t)
16077 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16078 range)
16079 (cond
16080 ((equal property "TODO")
16082 (not (member value org-todo-keywords-1)))
16084 (if (or (not value)
16086 (setq value 'none))
16087 (org-todo value)
16088 (org-set-tags nil 'align))
16089 ((equal property "PRIORITY")
16091 (string-to-char value) ?\ ))
16092 (org-set-tags nil 'align))
16093 ((equal property "SCHEDULED")
16094 (if (re-search-forward org-scheduled-time-regexp end t)
16095 (cond
16096 ((eq value 'earlier) (org-timestamp-change -1 'day))
16097 ((eq value 'later) (org-timestamp-change 1 'day))
16098 (t (call-interactively 'org-schedule)))
16099 (call-interactively 'org-schedule)))
16100 ((equal property "DEADLINE")
16101 (if (re-search-forward org-deadline-time-regexp end t)
16102 (cond
16103 ((eq value 'earlier) (org-timestamp-change -1 'day))
16104 ((eq value 'later) (org-timestamp-change 1 'day))
16105 (t (call-interactively 'org-deadline)))
16106 (call-interactively 'org-deadline)))
16107 ((member property org-special-properties)
16108 (error "The %s property can not yet be set with `org-entry-put'"
16109 property))
16110 (t ; a non-special property
16111 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16112 (setq range (org-get-property-block beg end 'force))
16113 (goto-char (car range))
16114 (if (re-search-forward
16116 (progn
16117 (delete-region (match-beginning 1) (match-end 1))
16118 (goto-char (match-beginning 1)))
16119 (goto-char (cdr range))
16121 (backward-char 1)
16122 (org-indent-line-function)
16123 (insert ":" property ":"))
16124 (and value (insert " " value))
16125 (org-indent-line-function)))))))
16127 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16128 "Get all property keys in the current buffer.
16129 With INCLUDE-SPECIALS, also list the special properties that relect things
16130 like tags and TODO state.
16131 With INCLUDE-DEFAULTS, also include properties that has special meaning
16132 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16133 With INCLUDE-COLUMNS, also include property names given in COLUMN
16134 formats in the current buffer."
16135 (let (rtn range cfmt cols)
16136 (save-excursion
16137 (save-restriction
16138 (widen)
16139 (goto-char (point-min))
16140 (while (re-search-forward org-property-start-re nil t)
16141 (setq range (org-get-property-block))
16142 (goto-char (car range))
16143 (while (re-search-forward
16145 (cdr range) t)
16146 (add-to-list 'rtn (org-match-string-no-properties 1)))
16147 (outline-next-heading))))
16149 (when include-specials
16150 (setq rtn (append org-special-properties rtn)))
16152 (when include-defaults
16153 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16155 (when include-columns
16156 (save-excursion
16157 (save-restriction
16158 (widen)
16159 (goto-char (point-min))
16160 (while (re-search-forward
16162 nil t)
16163 (setq cfmt (match-string 2) s 0)
16165 cfmt s)
16166 (setq s (match-end 0)
16167 p (match-string 1 cfmt))
16168 (unless (or (equal p "ITEM")
16169 (member p org-special-properties))
16170 (add-to-list 'rtn (match-string 1 cfmt))))))))
16172 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16174 (defun org-property-values (key)
16175 "Return a list of all values of property KEY."
16176 (save-excursion
16177 (save-restriction
16178 (widen)
16179 (goto-char (point-min))
16181 values)
16182 (while (re-search-forward re nil t)
16183 (add-to-list 'values (org-trim (match-string 1))))
16184 (delete "" values)))))
16186 (defun org-insert-property-drawer ()
16187 "Insert a property drawer into the current entry."
16188 (interactive)
16189 (org-back-to-heading t)
16190 (looking-at outline-regexp)
16191 (let ((indent (- (match-end 0)(match-beginning 0)))
16192 (beg (point))
16194 end hiddenp)
16195 (outline-next-heading)
16196 (setq end (point))
16197 (goto-char beg)
16198 (while (re-search-forward re end t))
16199 (setq hiddenp (org-invisible-p))
16200 (end-of-line 1)
16202 (org-skip-over-state-notes)
16204 (if (eq (char-before) ?*) (forward-char 1))
16206 (beginning-of-line 0)
16207 (indent-to-column indent)
16208 (beginning-of-line 2)
16209 (indent-to-column indent)
16210 (beginning-of-line 0)
16211 (if hiddenp
16212 (save-excursion
16213 (org-back-to-heading t)
16214 (hide-entry))
16215 (org-flag-drawer t))))
16217 (defun org-set-property (property value)
16218 "In the current entry, set PROPERTY to VALUE.
16219 When called interactively, this will prompt for a property name, offering
16220 completion on existing and default properties. And then it will prompt
16221 for a value, offering competion either on allowed values (via an inherited
16222 xxx_ALL property) or on existing values in other instances of this property
16223 in the current file."
16224 (interactive
16225 (let* ((prop (completing-read
16226 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16227 (cur (org-entry-get nil prop))
16228 (allowed (org-property-get-allowed-values nil prop 'table))
16229 (existing (mapcar 'list (org-property-values prop)))
16230 (val (if allowed
16231 (completing-read "Value: " allowed nil 'req-match)
16232 (completing-read
16234 (concat "[" cur "]") "")
16235 ": ")
16236 existing nil nil "" nil cur))))
16237 (list prop (if (equal val "") cur val))))
16238 (unless (equal (org-entry-get nil property) value)
16239 (org-entry-put nil property value)))
16241 (defun org-delete-property (property)
16242 "In the current entry, delete PROPERTY."
16243 (interactive
16244 (let* ((prop (completing-read
16245 "Property: " (org-entry-properties nil 'standard))))
16246 (list prop)))
16247 (message "Property %s %s" property
16248 (if (org-entry-delete nil property)
16249 "deleted"
16250 "was not present in the entry")))
16252 (defun org-delete-property-globally (property)
16253 "Remove PROPERTY globally, from all entries."
16254 (interactive
16255 (let* ((prop (completing-read
16256 "Globally remove property: "
16257 (mapcar 'list (org-buffer-property-keys)))))
16258 (list prop)))
16259 (save-excursion
16260 (save-restriction
16261 (widen)
16262 (goto-char (point-min))
16263 (let ((cnt 0))
16264 (while (re-search-forward
16266 nil t)
16267 (setq cnt (1+ cnt))
16268 (replace-match ""))
16271 (defvar org-columns-current-fmt-compiled) ; defined below
16273 (defun org-compute-property-at-point ()
16274 "Compute the property at point.
16275 This looks for an enclosing column format, extracts the operator and
16276 then applies it to the proerty in the column format's scope."
16277 (interactive)
16278 (unless (org-at-property-p)
16279 (error "Not at a property"))
16280 (let ((prop (org-match-string-no-properties 2)))
16281 (org-columns-get-format-and-top-level)
16282 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16283 (error "No operator defined for property %s" prop))
16284 (org-columns-compute prop)))
16286 (defun org-property-get-allowed-values (pom property &optional table)
16287 "Get allowed values for the property PROPERTY.
16288 When TABLE is non-nil, return an alist that can directly be used for
16289 completion."
16290 (let (vals)
16291 (cond
16292 ((equal property "TODO")
16293 (setq vals (org-with-point-at pom
16294 (append org-todo-keywords-1 '("")))))
16295 ((equal property "PRIORITY")
16296 (let ((n org-lowest-priority))
16297 (while (>= n org-highest-priority)
16298 (push (char-to-string n) vals)
16299 (setq n (1- n)))))
16300 ((member property org-special-properties))
16301 (t
16302 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16305 (setq vals (car (read-from-string (concat "(" vals ")"))))
16306 (setq vals (mapcar (lambda (x)
16307 (cond ((stringp x) x)
16308 ((numberp x) (number-to-string x))
16309 ((symbolp x) (symbol-name x))
16310 (t "???")))
16311 vals)))))
16312 (if table (mapcar 'list vals) vals)))
16314 (defun org-property-previous-allowed-value (&optional previous)
16315 "Switch to the next allowed value for this property."
16316 (interactive)
16317 (org-property-next-allowed-value t))
16319 (defun org-property-next-allowed-value (&optional previous)
16320 "Switch to the next allowed value for this property."
16321 (interactive)
16322 (unless (org-at-property-p)
16323 (error "Not at a property"))
16324 (let* ((key (match-string 2))
16325 (value (match-string 3))
16326 (allowed (or (org-property-get-allowed-values (point) key)
16327 (and (member value '("[ ]" "[-]" "[X]"))
16328 '("[ ]" "[X]"))))
16329 nval)
16330 (unless allowed
16331 (error "Allowed values for this property have not been defined"))
16332 (if previous (setq allowed (reverse allowed)))
16333 (if (member value allowed)
16334 (setq nval (car (cdr (member value allowed)))))
16335 (setq nval (or nval (car allowed)))
16336 (if (equal nval value)
16337 (error "Only one allowed value for this property"))
16338 (org-at-property-p)
16339 (replace-match (concat " :" key ": " nval) t t)
16340 (org-indent-line-function)
16341 (beginning-of-line 1)
16344 (defun org-find-entry-with-id (ident)
16345 "Locate the entry that contains the ID property with exact value IDENT.
16346 IDENT can be a string, a symbol or a number, this function will search for
16347 the string representation of it.
16348 Return the position where this entry starts, or nil if there is no such entry."
16349 (let ((id (cond
16350 ((stringp ident) ident)
16351 ((symbol-name ident) (symbol-name ident))
16352 ((numberp ident) (number-to-string ident))
16353 (t (error "IDENT %s must be a string, symbol or number" ident))))
16354 (case-fold-search nil))
16355 (save-excursion
16356 (save-restriction
16357 (goto-char (point-min))
16358 (when (re-search-forward
16360 nil t)
16361 (org-back-to-heading)
16362 (point))))))
16364 ;;; Column View
16366 (defvar org-columns-overlays nil
16367 "Holds the list of current column overlays.")
16369 (defvar org-columns-current-fmt nil
16370 "Local variable, holds the currently active column format.")
16371 (defvar org-columns-current-fmt-compiled nil
16372 "Local variable, holds the currently active column format.
16373 This is the compiled version of the format.")
16374 (defvar org-columns-current-widths nil
16375 "Loval variable, holds the currently widths of fields.")
16376 (defvar org-columns-current-maxwidths nil
16377 "Loval variable, holds the currently active maximum column widths.")
16378 (defvar org-columns-begin-marker (make-marker)
16379 "Points to the position where last a column creation command was called.")
16380 (defvar org-columns-top-level-marker (make-marker)
16381 "Points to the position where current columns region starts.")
16383 (defvar org-columns-map (make-sparse-keymap)
16384 "The keymap valid in column display.")
16386 (defun org-columns-content ()
16387 "Switch to contents view while in columns view."
16388 (interactive)
16389 (org-overview)
16390 (org-content))
16392 (org-defkey org-columns-map "c" 'org-columns-content)
16393 (org-defkey org-columns-map "o" 'org-overview)
16394 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16395 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16396 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16397 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16398 (org-defkey org-columns-map "v" 'org-columns-show-value)
16399 (org-defkey org-columns-map "q" 'org-columns-quit)
16400 (org-defkey org-columns-map "r" 'org-columns-redo)
16401 (org-defkey org-columns-map "g" 'org-columns-redo)
16402 (org-defkey org-columns-map [left] 'backward-char)
16403 (org-defkey org-columns-map "\M-b" 'backward-char)
16404 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16405 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16406 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16407 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16408 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16409 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16410 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16411 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16412 (org-defkey org-columns-map "<" 'org-columns-narrow)
16413 (org-defkey org-columns-map ">" 'org-columns-widen)
16414 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16415 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16416 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16417 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16419 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16420 '("Column"
16421 ["Edit property" org-columns-edit-value t]
16422 ["Next allowed value" org-columns-next-allowed-value t]
16423 ["Previous allowed value" org-columns-previous-allowed-value t]
16424 ["Show full value" org-columns-show-value t]
16425 ["Edit allowed values" org-columns-edit-allowed t]
16426 "--"
16427 ["Edit column attributes" org-columns-edit-attributes t]
16428 ["Increase column width" org-columns-widen t]
16429 ["Decrease column width" org-columns-narrow t]
16430 "--"
16431 ["Move column right" org-columns-move-right t]
16432 ["Move column left" org-columns-move-left t]
16433 ["Add column" org-columns-new t]
16434 ["Delete column" org-columns-delete t]
16435 "--"
16436 ["CONTENTS" org-columns-content t]
16437 ["OVERVIEW" org-overview t]
16438 ["Refresh columns display" org-columns-redo t]
16439 "--"
16440 ["Open link" org-columns-open-link t]
16441 "--"
16442 ["Quit" org-columns-quit t]))
16444 (defun org-columns-new-overlay (beg end &optional string face)
16445 "Create a new column overlay and add it to the list."
16446 (let ((ov (org-make-overlay beg end)))
16447 (org-overlay-put ov 'face (or face 'secondary-selection))
16448 (org-overlay-display ov string face)
16449 (push ov org-columns-overlays)
16450 ov))
16452 (defun org-columns-display-here (&optional props)
16453 "Overlay the current line with column display."
16454 (interactive)
16455 (let* ((fmt org-columns-current-fmt-compiled)
16456 (beg (point-at-bol))
16457 (level-face (save-excursion
16458 (beginning-of-line 1)
16460 (org-get-level-face 2))))
16461 (color (list :foreground
16462 (face-attribute (or level-face 'default) :foreground)))
16463 props pom property ass width f string ov column val modval)
16464 ;; Check if the entry is in another buffer.
16465 (unless props
16466 (if (eq major-mode 'org-agenda-mode)
16467 (setq pom (or (get-text-property (point) 'org-hd-marker)
16468 (get-text-property (point) 'org-marker))
16469 props (if pom (org-entry-properties pom) nil))
16470 (setq props (org-entry-properties nil))))
16471 ;; Walk the format
16472 (while (setq column (pop fmt))
16473 (setq property (car column)
16474 ass (if (equal property "ITEM")
16475 (cons "ITEM"
16476 (save-match-data
16477 (org-no-properties
16478 (org-remove-tabs
16479 (buffer-substring-no-properties
16480 (point-at-bol) (point-at-eol))))))
16481 (assoc property props))
16482 width (or (cdr (assoc property org-columns-current-maxwidths))
16483 (nth 2 column)
16484 (length property))
16485 f (format "%%-%d.%ds | " width width)
16486 val (or (cdr ass) "")
16487 modval (if (equal property "ITEM")
16488 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16489 string (format f (or modval val)))
16490 ;; Create the overlay
16491 (org-unmodified
16492 (setq ov (org-columns-new-overlay
16493 beg (setq beg (1+ beg)) string
16494 (list color 'org-column)))
16495 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16496 (org-overlay-put ov 'keymap org-columns-map)
16497 (org-overlay-put ov 'org-columns-key property)
16498 (org-overlay-put ov 'org-columns-value (cdr ass))
16499 (org-overlay-put ov 'org-columns-value-modified modval)
16500 (org-overlay-put ov 'org-columns-pom pom)
16501 (org-overlay-put ov 'org-columns-format f))
16502 (if (or (not (char-after beg))
16504 (let ((inhibit-read-only t))
16505 (save-excursion
16506 (goto-char beg)
16507 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16508 ;; Make the rest of the line disappear.
16509 (org-unmodified
16510 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16511 (org-overlay-put ov 'invisible t)
16512 (org-overlay-put ov 'keymap org-columns-map)
16513 (org-overlay-put ov 'intangible t)
16514 (push ov org-columns-overlays)
16515 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16516 (org-overlay-put ov 'keymap org-columns-map)
16517 (push ov org-columns-overlays)
16518 (let ((inhibit-read-only t))
16519 (put-text-property (max (point-min) (1- (point-at-bol)))
16520 (min (point-max) (1+ (point-at-eol)))
16521 'read-only "Type `e' to edit property")))))
16523 (defvar org-previous-header-line-format nil
16524 "The header line format before column view was turned on.")
16525 (defvar org-columns-inhibit-recalculation nil
16526 "Inhibit recomputing of columns on column view startup.")
16529 (defvar header-line-format)
16530 (defun org-columns-display-here-title ()
16531 "Overlay the newline before the current line with the table title."
16532 (interactive)
16533 (let ((fmt org-columns-current-fmt-compiled)
16534 string (title "")
16535 property width f column str widths)
16536 (while (setq column (pop fmt))
16537 (setq property (car column)
16538 str (or (nth 1 column) property)
16539 width (or (cdr (assoc property org-columns-current-maxwidths))
16540 (nth 2 column)
16541 (length str))
16542 widths (push width widths)
16543 f (format "%%-%d.%ds | " width width)
16544 string (format f str)
16545 title (concat title string)))
16546 (setq title (concat
16547 (org-add-props " " nil 'display '(space :align-to 0))
16548 (org-add-props title nil 'face '(:weight bold :underline t))))
16549 (org-set-local 'org-previous-header-line-format header-line-format)
16550 (org-set-local 'org-columns-current-widths (nreverse widths))
16551 (setq header-line-format title)))
16553 (defun org-columns-remove-overlays ()
16554 "Remove all currently active column overlays."
16555 (interactive)
16556 (when (marker-buffer org-columns-begin-marker)
16557 (with-current-buffer (marker-buffer org-columns-begin-marker)
16558 (when (local-variable-p 'org-previous-header-line-format)
16559 (setq header-line-format org-previous-header-line-format)
16560 (kill-local-variable 'org-previous-header-line-format))
16561 (move-marker org-columns-begin-marker nil)
16562 (move-marker org-columns-top-level-marker nil)
16563 (org-unmodified
16564 (mapc 'org-delete-overlay org-columns-overlays)
16565 (setq org-columns-overlays nil)
16566 (let ((inhibit-read-only t))
16567 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16569 (defun org-columns-cleanup-item (item fmt)
16570 "Remove from ITEM what is a column in the format FMT."
16571 (if (not org-complex-heading-regexp)
16572 item
16573 (when (string-match org-complex-heading-regexp item)
16574 (concat
16575 (org-add-props (concat (match-string 1 item) " ") nil
16576 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16577 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16578 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16579 " " (match-string 4 item)
16580 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16582 (defun org-columns-show-value ()
16583 "Show the full value of the property."
16584 (interactive)
16585 (let ((value (get-char-property (point) 'org-columns-value)))
16586 (message "Value is: %s" (or value ""))))
16588 (defun org-columns-quit ()
16589 "Remove the column overlays and in this way exit column editing."
16590 (interactive)
16591 (org-unmodified
16592 (org-columns-remove-overlays)
16593 (let ((inhibit-read-only t))
16594 (remove-text-properties (point-min) (point-max) '(read-only t))))
16595 (when (eq major-mode 'org-agenda-mode)
16596 (message
16597 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16599 (defun org-columns-check-computed ()
16600 "Check if this column value is computed.
16601 If yes, throw an error indicating that changing it does not make sense."
16602 (let ((val (get-char-property (point) 'org-columns-value)))
16603 (when (and (stringp val)
16604 (get-char-property 0 'org-computed val))
16605 (error "This value is computed from the entry's children"))))
16607 (defun org-columns-todo (&optional arg)
16608 "Change the TODO state during column view."
16609 (interactive "P")
16610 (org-columns-edit-value "TODO"))
16612 (defun org-columns-set-tags-or-toggle (&optional arg)
16613 "Toggle checkbox at point, or set tags for current headline."
16614 (interactive "P")
16616 (get-char-property (point) 'org-columns-value))
16617 (org-columns-next-allowed-value)
16618 (org-columns-edit-value "TAGS")))
16620 (defun org-columns-edit-value (&optional key)
16621 "Edit the value of the property at point in column view.
16622 Where possible, use the standard interface for changing this line."
16623 (interactive)
16624 (org-columns-check-computed)
16625 (let* ((external-key key)
16626 (col (current-column))
16627 (key (or key (get-char-property (point) 'org-columns-key)))
16628 (value (get-char-property (point) 'org-columns-value))
16629 (bol (point-at-bol)) (eol (point-at-eol))
16630 (pom (or (get-text-property bol 'org-hd-marker)
16631 (point))) ; keep despite of compiler waring
16632 (line-overlays
16633 (delq nil (mapcar (lambda (x)
16634 (and (eq (overlay-buffer x) (current-buffer))
16635 (>= (overlay-start x) bol)
16636 (<= (overlay-start x) eol)
16637 x))
16638 org-columns-overlays)))
16639 nval eval allowed)
16640 (cond
16641 ((equal key "CLOCKSUM")
16642 (error "This special column cannot be edited"))
16643 ((equal key "ITEM")
16644 (setq eval '(org-with-point-at pom
16645 (org-edit-headline))))
16646 ((equal key "TODO")
16647 (setq eval '(org-with-point-at pom
16648 (let ((current-prefix-arg
16649 (if external-key current-prefix-arg '(4))))
16650 (call-interactively 'org-todo)))))
16651 ((equal key "PRIORITY")
16652 (setq eval '(org-with-point-at pom
16653 (call-interactively 'org-priority))))
16654 ((equal key "TAGS")
16655 (setq eval '(org-with-point-at pom
16656 (let ((org-fast-tag-selection-single-key
16657 (if (eq org-fast-tag-selection-single-key 'expert)
16658 t org-fast-tag-selection-single-key)))
16659 (call-interactively 'org-set-tags)))))
16660 ((equal key "DEADLINE")
16661 (setq eval '(org-with-point-at pom
16662 (call-interactively 'org-deadline))))
16663 ((equal key "SCHEDULED")
16664 (setq eval '(org-with-point-at pom
16665 (call-interactively 'org-schedule))))
16666 (t
16667 (setq allowed (org-property-get-allowed-values pom key 'table))
16668 (if allowed
16669 (setq nval (completing-read "Value: " allowed nil t))
16670 (setq nval (read-string "Edit: " value)))
16671 (setq nval (org-trim nval))
16672 (when (not (equal nval value))
16673 (setq eval '(org-entry-put pom key nval)))))
16674 (when eval
16675 (let ((inhibit-read-only t))
16676 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16677 (unwind-protect
16678 (progn
16679 (setq org-columns-overlays
16680 (org-delete-all line-overlays org-columns-overlays))
16681 (mapc 'org-delete-overlay line-overlays)
16682 (org-columns-eval eval))
16683 (org-columns-display-here))))
16684 (move-to-column col)
16685 (if (and (org-mode-p)
16686 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16687 (org-columns-update key))))
16689 (defun org-edit-headline () ; FIXME: this is not columns specific
16690 "Edit the current headline, the part without TODO keyword, TAGS."
16691 (org-back-to-heading)
16692 (when (looking-at org-todo-line-regexp)
16693 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16694 (txt (match-string 3))
16695 (post "")
16696 txt2)
16698 (setq post (match-string 0 txt)
16699 txt (substring txt 0 (match-beginning 0))))
16700 (setq txt2 (read-string "Edit: " txt))
16701 (when (not (equal txt txt2))
16702 (beginning-of-line 1)
16703 (insert pre txt2 post)
16704 (delete-region (point) (point-at-eol))
16705 (org-set-tags nil t)))))
16707 (defun org-columns-edit-allowed ()
16708 "Edit the list of allowed values for the current property."
16709 (interactive)
16710 (let* ((key (get-char-property (point) 'org-columns-key))
16711 (key1 (concat key "_ALL"))
16712 (allowed (org-entry-get (point) key1 t))
16713 nval)
16714 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16715 (setq nval (read-string "Allowed: " allowed))
16716 (org-entry-put
16717 (cond ((marker-position org-entry-property-inherited-from)
16718 org-entry-property-inherited-from)
16719 ((marker-position org-columns-top-level-marker)
16720 org-columns-top-level-marker))
16721 key1 nval)))
16723 (defmacro org-no-warnings (&rest body)
16724 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16726 (defun org-columns-eval (form)
16727 (let (hidep)
16728 (save-excursion
16729 (beginning-of-line 1)
16730 ;; `next-line' is needed here, because it skips invisible line.
16731 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16732 (setq hidep (org-on-heading-p 1)))
16733 (eval form)
16734 (and hidep (hide-entry))))
16736 (defun org-columns-previous-allowed-value ()
16737 "Switch to the previous allowed value for this column."
16738 (interactive)
16739 (org-columns-next-allowed-value t))
16741 (defun org-columns-next-allowed-value (&optional previous)
16742 "Switch to the next allowed value for this column."
16743 (interactive)
16744 (org-columns-check-computed)
16745 (let* ((col (current-column))
16746 (key (get-char-property (point) 'org-columns-key))
16747 (value (get-char-property (point) 'org-columns-value))
16748 (bol (point-at-bol)) (eol (point-at-eol))
16749 (pom (or (get-text-property bol 'org-hd-marker)
16750 (point))) ; keep despite of compiler waring
16751 (line-overlays
16752 (delq nil (mapcar (lambda (x)
16753 (and (eq (overlay-buffer x) (current-buffer))
16754 (>= (overlay-start x) bol)
16755 (<= (overlay-start x) eol)
16756 x))
16757 org-columns-overlays)))
16758 (allowed (or (org-property-get-allowed-values pom key)
16759 (and (equal
16760 (nth 4 (assoc key org-columns-current-fmt-compiled))
16761 'checkbox) '("[ ]" "[X]"))))
16762 nval)
16763 (when (equal key "ITEM")
16764 (error "Cannot edit item headline from here"))
16765 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16766 (error "Allowed values for this property have not been defined"))
16767 (if (member key '("SCHEDULED" "DEADLINE"))
16768 (setq nval (if previous 'earlier 'later))
16769 (if previous (setq allowed (reverse allowed)))
16770 (if (member value allowed)
16771 (setq nval (car (cdr (member value allowed)))))
16772 (setq nval (or nval (car allowed)))
16773 (if (equal nval value)
16774 (error "Only one allowed value for this property")))
16775 (let ((inhibit-read-only t))
16776 (remove-text-properties (1- bol) eol '(read-only t))
16777 (unwind-protect
16778 (progn
16779 (setq org-columns-overlays
16780 (org-delete-all line-overlays org-columns-overlays))
16781 (mapc 'org-delete-overlay line-overlays)
16782 (org-columns-eval '(org-entry-put pom key nval)))
16783 (org-columns-display-here)))
16784 (move-to-column col)
16785 (if (and (org-mode-p)
16786 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16787 (org-columns-update key))))
16789 (defun org-verify-version (task)
16790 (cond
16791 ((eq task 'columns)
16792 (if (or (featurep 'xemacs)
16793 (< emacs-major-version 22))
16794 (error "Emacs 22 is required for the columns feature")))))
16796 (defun org-columns-open-link (&optional arg)
16797 (interactive "P")
16798 (let ((key (get-char-property (point) 'org-columns-key))
16799 (value (get-char-property (point) 'org-columns-value)))
16800 (org-open-link-from-string arg)))
16802 (defun org-open-link-from-string (s &optional arg)
16803 "Open a link in the string S, as if it was in Org-mode."
16804 (interactive)
16805 (with-temp-buffer
16806 (let ((org-inhibit-startup t))
16807 (org-mode)
16808 (insert s)
16809 (goto-char (point-min))
16810 (org-open-at-point arg))))
16812 (defun org-columns-get-format-and-top-level ()
16813 (let (fmt)
16814 (when (condition-case nil (org-back-to-heading) (error nil))
16815 (move-marker org-entry-property-inherited-from nil)
16816 (setq fmt (org-entry-get nil "COLUMNS" t)))
16817 (setq fmt (or fmt org-columns-default-format))
16818 (org-set-local 'org-columns-current-fmt fmt)
16819 (org-columns-compile-format fmt)
16820 (if (marker-position org-entry-property-inherited-from)
16821 (move-marker org-columns-top-level-marker
16822 org-entry-property-inherited-from)
16823 (move-marker org-columns-top-level-marker (point)))
16824 fmt))
16826 (defun org-columns ()
16827 "Turn on column view on an org-mode file."
16828 (interactive)
16829 (org-verify-version 'columns)
16830 (org-columns-remove-overlays)
16831 (move-marker org-columns-begin-marker (point))
16832 (let (beg end fmt cache maxwidths clocksump)
16833 (setq fmt (org-columns-get-format-and-top-level))
16834 (save-excursion
16835 (goto-char org-columns-top-level-marker)
16836 (setq beg (point))
16837 (unless org-columns-inhibit-recalculation
16838 (org-columns-compute-all))
16839 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16840 (point-max)))
16841 ;; Get and cache the properties
16842 (goto-char beg)
16843 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16844 (setq clocksump t)
16845 (save-excursion
16846 (save-restriction
16847 (narrow-to-region beg end)
16848 (org-clock-sum))))
16849 (while (re-search-forward (concat "^" outline-regexp) end t)
16850 (push (cons (org-current-line) (org-entry-properties)) cache))
16851 (when cache
16852 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16853 (org-set-local 'org-columns-current-maxwidths maxwidths)
16854 (org-columns-display-here-title)
16855 (mapc (lambda (x)
16856 (goto-line (car x))
16857 (org-columns-display-here (cdr x)))
16858 cache)))))
16860 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16861 "Insert a new column, to the leeft o the current column."
16862 (interactive)
16863 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16864 cell)
16865 (setq prop (completing-read
16866 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
16867 nil nil prop))
16868 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16869 (setq width (read-string "Column width: " (if width (number-to-string width))))
16871 (setq width (string-to-number width))
16872 (setq width nil))
16873 (setq fmt (completing-read "Summary [none]: "
16874 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox"))
16875 nil t))
16877 (setq fmt (intern fmt))
16878 (setq fmt nil))
16879 (if (eq fmt 'none) (setq fmt nil))
16880 (if editp
16881 (progn
16882 (setcar editp prop)
16883 (setcdr editp (list title width nil fmt)))
16884 (setq cell (nthcdr (1- (current-column))
16885 org-columns-current-fmt-compiled))
16886 (setcdr cell (cons (list prop title width nil fmt)
16887 (cdr cell))))
16888 (org-columns-store-format)
16889 (org-columns-redo)))
16891 (defun org-columns-delete ()
16892 "Delete the column at point from columns view."
16893 (interactive)
16894 (let* ((n (current-column))
16895 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16896 (when (y-or-n-p
16898 (setq org-columns-current-fmt-compiled
16899 (delq (nth n org-columns-current-fmt-compiled)
16900 org-columns-current-fmt-compiled))
16901 (org-columns-store-format)
16902 (org-columns-redo)
16903 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16904 (backward-char 1)))))
16906 (defun org-columns-edit-attributes ()
16907 "Edit the attributes of the current column."
16908 (interactive)
16909 (let* ((n (current-column))
16910 (info (nth n org-columns-current-fmt-compiled)))
16911 (apply 'org-columns-new info)))
16913 (defun org-columns-widen (arg)
16914 "Make the column wider by ARG characters."
16915 (interactive "p")
16916 (let* ((n (current-column))
16917 (entry (nth n org-columns-current-fmt-compiled))
16918 (width (or (nth 2 entry)
16919 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16920 (setq width (max 1 (+ width arg)))
16921 (setcar (nthcdr 2 entry) width)
16922 (org-columns-store-format)
16923 (org-columns-redo)))
16925 (defun org-columns-narrow (arg)
16926 "Make the column nrrower by ARG characters."
16927 (interactive "p")
16928 (org-columns-widen (- arg)))
16930 (defun org-columns-move-right ()
16931 "Swap this column with the one to the right."
16932 (interactive)
16933 (let* ((n (current-column))
16934 (cell (nthcdr n org-columns-current-fmt-compiled))
16935 e)
16936 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16937 (error "Cannot shift this column further to the right"))
16938 (setq e (car cell))
16939 (setcar cell (car (cdr cell)))
16940 (setcdr cell (cons e (cdr (cdr cell))))
16941 (org-columns-store-format)
16942 (org-columns-redo)
16943 (forward-char 1)))
16945 (defun org-columns-move-left ()
16946 "Swap this column with the one to the left."
16947 (interactive)
16948 (let* ((n (current-column)))
16949 (when (= n 0)
16950 (error "Cannot shift this column further to the left"))
16951 (backward-char 1)
16952 (org-columns-move-right)
16953 (backward-char 1)))
16955 (defun org-columns-store-format ()
16956 "Store the text version of the current columns format in appropriate place.
16957 This is either in the COLUMNS property of the node starting the current column
16958 display, or in the #+COLUMNS line of the current buffer."
16959 (let (fmt (cnt 0))
16960 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
16961 (org-set-local 'org-columns-current-fmt fmt)
16962 (if (marker-position org-columns-top-level-marker)
16963 (save-excursion
16964 (goto-char org-columns-top-level-marker)
16965 (if (and (org-at-heading-p)
16966 (org-entry-get nil "COLUMNS"))
16967 (org-entry-put nil "COLUMNS" fmt)
16968 (goto-char (point-min))
16969 ;; Overwrite all #+COLUMNS lines....
16971 (setq cnt (1+ cnt))
16972 (replace-match (concat "#+COLUMNS: " fmt) t t))
16973 (unless (> cnt 0)
16974 (goto-char (point-min))
16975 (or (org-on-heading-p t) (outline-next-heading))
16976 (let ((inhibit-read-only t))
16978 (org-set-local 'org-columns-default-format fmt))))))
16980 (defvar org-overriding-columns-format nil
16981 "When set, overrides any other definition.")
16982 (defvar org-agenda-view-columns-initially nil
16983 "When set, switch to columns view immediately after creating the agenda.")
16985 (defun org-agenda-columns ()
16986 "Turn on column view in the agenda."
16987 (interactive)
16988 (org-verify-version 'columns)
16989 (org-columns-remove-overlays)
16990 (move-marker org-columns-begin-marker (point))
16991 (let (fmt cache maxwidths m)
16992 (cond
16993 ((and (local-variable-p 'org-overriding-columns-format)
16994 org-overriding-columns-format)
16995 (setq fmt org-overriding-columns-format))
16996 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
16997 (setq fmt (org-entry-get m "COLUMNS" t)))
16998 ((and (boundp 'org-columns-current-fmt)
16999 (local-variable-p 'org-columns-current-fmt)
17000 org-columns-current-fmt)
17001 (setq fmt org-columns-current-fmt))
17002 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17003 (setq m (get-text-property m 'org-hd-marker))
17004 (setq fmt (org-entry-get m "COLUMNS" t))))
17005 (setq fmt (or fmt org-columns-default-format))
17006 (org-set-local 'org-columns-current-fmt fmt)
17007 (org-columns-compile-format fmt)
17008 (save-excursion
17009 ;; Get and cache the properties
17010 (goto-char (point-min))
17011 (while (not (eobp))
17012 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17013 (get-text-property (point) 'org-marker)))
17014 (push (cons (org-current-line) (org-entry-properties m)) cache))
17015 (beginning-of-line 2))
17016 (when cache
17017 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17018 (org-set-local 'org-columns-current-maxwidths maxwidths)
17019 (org-columns-display-here-title)
17020 (mapc (lambda (x)
17021 (goto-line (car x))
17022 (org-columns-display-here (cdr x)))
17023 cache)))))
17025 (defun org-columns-get-autowidth-alist (s cache)
17026 "Derive the maximum column widths from the format and the cache."
17027 (let ((start 0) rtn)
17029 (push (cons (match-string 1 s) 1) rtn)
17030 (setq start (match-end 0)))
17031 (mapc (lambda (x)
17032 (setcdr x (apply 'max
17033 (mapcar
17034 (lambda (y)
17035 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17036 cache))))
17037 rtn)
17038 rtn))
17040 (defun org-columns-compute-all ()
17041 "Compute all columns that have operators defined."
17042 (org-unmodified
17043 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17044 (let ((columns org-columns-current-fmt-compiled) col)
17045 (while (setq col (pop columns))
17046 (when (nth 3 col)
17047 (save-excursion
17048 (org-columns-compute (car col)))))))
17050 (defun org-columns-update (property)
17051 "Recompute PROPERTY, and update the columns display for it."
17052 (org-columns-compute property)
17053 (let (fmt val pos)
17054 (save-excursion
17055 (mapc (lambda (ov)
17056 (when (equal (org-overlay-get ov 'org-columns-key) property)
17057 (setq pos (org-overlay-start ov))
17058 (goto-char pos)
17059 (when (setq val (cdr (assoc property
17060 (get-text-property
17061 (point-at-bol) 'org-summaries))))
17062 (setq fmt (org-overlay-get ov 'org-columns-format))
17063 (org-overlay-put ov 'org-columns-value val)
17064 (org-overlay-put ov 'display (format fmt val)))))
17065 org-columns-overlays))))
17067 (defun org-columns-compute (property)
17068 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17069 (interactive)
17070 (let* ((re (concat "^" outline-regexp))
17071 (lmax 30) ; Does anyone use deeper levels???
17072 (lsum (make-vector lmax 0))
17073 (lflag (make-vector lmax nil))
17074 (level 0)
17075 (ass (assoc property org-columns-current-fmt-compiled))
17076 (format (nth 4 ass))
17077 (printf (nth 5 ass))
17078 (beg org-columns-top-level-marker)
17079 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17080 (save-excursion
17081 ;; Find the region to compute
17082 (goto-char beg)
17083 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17084 (goto-char end)
17085 ;; Walk the tree from the back and do the computations
17086 (while (re-search-backward re beg t)
17087 (setq sumpos (match-beginning 0)
17088 last-level level
17089 level (org-outline-level)
17090 val (org-entry-get nil property)
17092 (cond
17093 ((< level last-level)
17094 ;; put the sum of lower levels here as a property
17095 (setq sum (aref lsum last-level) ; current sum
17096 flag (aref lflag last-level) ; any valid entries from children?
17097 str (org-column-number-to-string sum format printf)
17098 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17099 useval (if flag str1 (if valflag val ""))
17100 sum-alist (get-text-property sumpos 'org-summaries))
17101 (if (assoc property sum-alist)
17102 (setcdr (assoc property sum-alist) useval)
17103 (push (cons property useval) sum-alist)
17104 (org-unmodified
17105 (add-text-properties sumpos (1+ sumpos)
17106 (list 'org-summaries sum-alist))))
17107 (when val
17108 (org-entry-put nil property (if flag str val)))
17109 ;; add current to current level accumulator
17110 (when (or flag valflag)
17111 (aset lsum level (+ (aref lsum level)
17112 (if flag sum (org-column-string-to-number
17113 (if flag str val) format))))
17114 (aset lflag level t))
17115 ;; clear accumulators for deeper levels
17116 (loop for l from (1+ level) to (1- lmax) do
17117 (aset lsum l 0)
17118 (aset lflag l nil)))
17119 ((>= level last-level)
17120 ;; add what we have here to the accumulator for this level
17121 (aset lsum level (+ (aref lsum level)
17122 (org-column-string-to-number (or val "0") format)))
17123 (and valflag (aset lflag level t)))
17124 (t (error "This should not happen")))))))
17126 (defun org-columns-redo ()
17127 "Construct the column display again."
17128 (interactive)
17129 (message "Recomputing columns...")
17130 (save-excursion
17131 (if (marker-position org-columns-begin-marker)
17132 (goto-char org-columns-begin-marker))
17133 (org-columns-remove-overlays)
17134 (if (org-mode-p)
17135 (call-interactively 'org-columns)
17136 (call-interactively 'org-agenda-columns)))
17137 (message "Recomputing columns...done"))
17139 (defun org-columns-not-in-agenda ()
17140 (if (eq major-mode 'org-agenda-mode)
17141 (error "This command is only allowed in Org-mode buffers")))
17144 (defun org-string-to-number (s)
17145 "Convert string to number, and interpret hh:mm:ss."
17146 (if (not (string-match ":" s))
17147 (string-to-number s)
17148 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17149 (while l
17150 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17151 sum)))
17153 (defun org-column-number-to-string (n fmt &optional printf)
17154 "Convert a computed column number to a string value, according to FMT."
17155 (cond
17156 ((eq fmt 'add_times)
17157 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17158 (format "%d:%02d" h m)))
17159 ((eq fmt 'checkbox)
17160 (cond ((= n (floor n)) "[X]")
17161 ((> n 1.) "[-]")
17162 (t "[ ]")))
17163 (printf (format printf n))
17164 ((eq fmt 'currency)
17165 (format "%.2f" n))
17166 (t (number-to-string n))))
17168 (defun org-column-string-to-number (s fmt)
17169 "Convert a column value to a number that can be used for column computing."
17170 (cond
17171 ((string-match ":" s)
17172 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17173 (while l
17174 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17175 sum))
17176 ((eq fmt 'checkbox)
17177 (if (equal s "[X]") 1. 0.000001))
17178 (t (string-to-number s))))
17180 (defun org-columns-uncompile-format (cfmt)
17181 "Turn the compiled columns format back into a string representation."
17182 (let ((rtn "") e s prop title op width fmt printf)
17183 (while (setq e (pop cfmt))
17184 (setq prop (car e)
17185 title (nth 1 e)
17186 width (nth 2 e)
17187 op (nth 3 e)
17188 fmt (nth 4 e)
17189 printf (nth 5 e))
17190 (cond
17191 ((eq fmt 'add_times) (setq op ":"))
17192 ((eq fmt 'checkbox) (setq op "X"))
17193 ((eq fmt 'add_numbers) (setq op "+"))
17194 ((eq fmt 'currency) (setq op "$")))
17195 (if (and op printf) (setq op (concat op ";" printf)))
17196 (if (equal title prop) (setq title nil))
17197 (setq s (concat "%" (if width (number-to-string width))
17198 prop
17199 (if title (concat "(" title ")"))
17200 (if op (concat "{" op "}"))))
17201 (setq rtn (concat rtn " " s)))
17202 (org-trim rtn)))
17204 (defun org-columns-compile-format (fmt)
17205 "Turn a column format string into an alist of specifications.
17206 The alist has one entry for each column in the format. The elements of
17207 that list are:
17208 property the property
17209 title the title field for the columns
17210 width the column width in characters, can be nil for automatic
17211 operator the operator if any
17212 format the output format for computed results, derived from operator
17213 printf a printf format for computed values"
17214 (let ((start 0) width prop title op f printf)
17215 (setq org-columns-current-fmt-compiled nil)
17216 (while (string-match
17217 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17218 fmt start)
17219 (setq start (match-end 0)
17220 width (match-string 1 fmt)
17221 prop (match-string 2 fmt)
17222 title (or (match-string 3 fmt) prop)
17223 op (match-string 4 fmt)
17224 f nil
17225 printf nil)
17226 (if width (setq width (string-to-number width)))
17227 (when (and op (string-match ";" op))
17228 (setq printf (substring op (match-end 0))
17229 op (substring op 0 (match-beginning 0))))
17230 (cond
17231 ((equal op "+") (setq f 'add_numbers))
17232 ((equal op "$") (setq f 'currency))
17233 ((equal op ":") (setq f 'add_times))
17234 ((equal op "X") (setq f 'checkbox)))
17235 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17236 (setq org-columns-current-fmt-compiled
17237 (nreverse org-columns-current-fmt-compiled))))
17240 ;;; Dynamic block for Column view
17242 (defun org-columns-capture-view ()
17243 "Get the column view of the current buffer and return it as a list.
17244 The list will contains the title row and all other rows. Each row is
17245 a list of fields."
17246 (save-excursion
17247 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17248 (n (length title)) row tbl)
17249 (goto-char (point-min))
17251 (when (get-char-property (match-beginning 0) 'org-columns-key)
17252 (setq row nil)
17253 (loop for i from 0 to (1- n) do
17254 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17255 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17256 "")
17257 row))
17258 (setq row (nreverse row))
17259 (push row tbl)))
17260 (append (list title 'hline) (nreverse tbl)))))
17262 (defun org-dblock-write:columnview (params)
17263 "Write the column view table.
17264 PARAMS is a property list of parameters:
17266 :width enforce same column widths with <N> specifiers.
17267 :id the :ID: property of the entry where the columns view
17268 should be built, as a string. When `local', call locally.
17269 When `global' call column view with the cursor at the beginning
17270 of the buffer (usually this means that the whole buffer switches
17271 to column view).
17272 :hlines When t, insert a hline before each item. When a number, insert
17273 a hline before each level <= that number.
17274 :vlines When t, make each column a colgroup to enforce vertical lines."
17275 (let ((pos (move-marker (make-marker) (point)))
17276 (hlines (plist-get params :hlines))
17277 (vlines (plist-get params :vlines))
17278 tbl id idpos nfields tmp)
17279 (save-excursion
17280 (save-restriction
17281 (when (setq id (plist-get params :id))
17282 (cond ((not id) nil)
17283 ((eq id 'global) (goto-char (point-min)))
17284 ((eq id 'local) nil)
17285 ((setq idpos (org-find-entry-with-id id))
17286 (goto-char idpos))
17287 (t (error "Cannot find entry with :ID: %s" id))))
17288 (org-columns)
17289 (setq tbl (org-columns-capture-view))
17290 (setq nfields (length (car tbl)))
17291 (org-columns-quit)))
17292 (goto-char pos)
17293 (move-marker pos nil)
17294 (when tbl
17295 (when (plist-get params :hlines)
17296 (setq tmp nil)
17297 (while tbl
17298 (if (eq (car tbl) 'hline)
17299 (push (pop tbl) tmp)
17301 (if (and (not (eq (car tmp) 'hline))
17302 (or (eq hlines t)
17303 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17304 (push 'hline tmp)))
17305 (push (pop tbl) tmp)))
17306 (setq tbl (nreverse tmp)))
17307 (when vlines
17308 (setq tbl (mapcar (lambda (x)
17309 (if (eq 'hline x) x (cons "" x)))
17310 tbl))
17311 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17312 (setq pos (point))
17313 (insert (org-listtable-to-string tbl))
17314 (when (plist-get params :width)
17316 org-columns-current-widths "|")))
17317 (goto-char pos)
17318 (org-table-align))))
17320 (defun org-listtable-to-string (tbl)
17321 "Convert a listtable TBL to a string that contains the Org-mode table.
17322 The table still need to be alligned. The resulting string has no leading
17323 and tailing newline characters."
17324 (mapconcat
17325 (lambda (x)
17326 (cond
17327 ((listp x)
17328 (concat "|" (mapconcat 'identity x "|") "|"))
17329 ((eq x 'hline) "|-|")
17330 (t (error "Garbage in listtable: %s" x))))
17333 (defun org-insert-columns-dblock ()
17334 "Create a dynamic block capturing a column view table."
17335 (interactive)
17336 (let ((defaults '(:name "columnview" :hlines 1))
17337 (id (completing-read
17338 "Capture columns (local, global, entry with :ID: property) [local]: "
17339 (append '(("global") ("local"))
17340 (mapcar 'list (org-property-values "ID"))))))
17341 (if (equal id "") (setq id 'local))
17342 (if (equal id "global") (setq id 'global))
17343 (setq defaults (append defaults (list :id id)))
17344 (org-create-dblock defaults)
17345 (org-update-dblock)))
17347 ;;;; Timestamps
17349 (defvar org-last-changed-timestamp nil)
17350 (defvar org-time-was-given) ; dynamically scoped parameter
17351 (defvar org-end-time-was-given) ; dynamically scoped parameter
17352 (defvar org-ts-what) ; dynamically scoped parameter
17354 (defun org-time-stamp (arg)
17355 "Prompt for a date/time and insert a time stamp.
17356 If the user specifies a time like HH:MM, or if this command is called
17357 with a prefix argument, the time stamp will contain date and time.
17358 Otherwise, only the date will be included. All parts of a date not
17359 specified by the user will be filled in from the current date/time.
17360 So if you press just return without typing anything, the time stamp
17361 will represent the current date/time. If there is already a timestamp
17362 at the cursor, it will be modified."
17363 (interactive "P")
17364 (let* ((ts nil)
17365 (default-time
17366 ;; Default time is either today, or, when entering a range,
17367 ;; the range start.
17368 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17369 (save-excursion
17370 (re-search-backward
17372 (- (point) 20) t)))
17373 (apply 'encode-time (org-parse-time-string (match-string 1)))
17374 (current-time)))
17375 (default-input (and ts (org-get-compact-tod ts)))
17376 org-time-was-given org-end-time-was-given time)
17377 (cond
17378 ((and (org-at-timestamp-p)
17379 (eq last-command 'org-time-stamp)
17380 (eq this-command 'org-time-stamp))
17381 (insert "--")
17382 (setq time (let ((this-command this-command))
17383 (org-read-date arg 'totime nil nil default-time default-input)))
17384 (org-insert-time-stamp time (or org-time-was-given arg)))
17385 ((org-at-timestamp-p)
17386 (setq time (let ((this-command this-command))
17387 (org-read-date arg 'totime nil nil default-time default-input)))
17388 (when (org-at-timestamp-p) ; just to get the match data
17389 (replace-match "")
17390 (setq org-last-changed-timestamp
17391 (org-insert-time-stamp
17392 time (or org-time-was-given arg)
17393 nil nil nil (list org-end-time-was-given))))
17394 (message "Timestamp updated"))
17395 (t
17396 (setq time (let ((this-command this-command))
17397 (org-read-date arg 'totime nil nil default-time default-input)))
17398 (org-insert-time-stamp time (or org-time-was-given arg)
17399 nil nil nil (list org-end-time-was-given))))))
17401 ;; FIXME: can we use this for something else????
17402 ;; like computing time differences?????
17403 (defun org-get-compact-tod (s)
17404 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17405 (let* ((t1 (match-string 1 s))
17406 (h1 (string-to-number (match-string 2 s)))
17407 (m1 (string-to-number (match-string 3 s)))
17408 (t2 (and (match-end 4) (match-string 5 s)))
17409 (h2 (and t2 (string-to-number (match-string 6 s))))
17410 (m2 (and t2 (string-to-number (match-string 7 s))))
17411 dh dm)
17412 (if (not t2)
17413 t1
17414 (setq dh (- h2 h1) dm (- m2 m1))
17415 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17416 (concat t1 "+" (number-to-string dh)
17417 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17419 (defun org-time-stamp-inactive (&optional arg)
17420 "Insert an inactive time stamp.
17421 An inactive time stamp is enclosed in square brackets instead of angle
17422 brackets. It is inactive in the sense that it does not trigger agenda entries,
17423 does not link to the calendar and cannot be changed with the S-cursor keys.
17424 So these are more for recording a certain time/date."
17425 (interactive "P")
17426 (let (org-time-was-given org-end-time-was-given time)
17427 (setq time (org-read-date arg 'totime))
17428 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17429 nil nil (list org-end-time-was-given))))
17431 (defvar org-date-ovl (org-make-overlay 1 1))
17432 (org-overlay-put org-date-ovl 'face 'org-warning)
17433 (org-detach-overlay org-date-ovl)
17435 (defvar org-ans1) ; dynamically scoped parameter
17436 (defvar org-ans2) ; dynamically scoped parameter
17438 (defvar org-plain-time-of-day-regexp) ; defined below
17440 (defvar org-read-date-overlay nil)
17441 (defvar org-dcst nil) ; dynamically scoped
17443 (defun org-read-date (&optional with-time to-time from-string prompt
17444 default-time default-input)
17445 "Read a date, possibly a time, and make things smooth for the user.
17446 The prompt will suggest to enter an ISO date, but you can also enter anything
17447 which will at least partially be understood by `parse-time-string'.
17448 Unrecognized parts of the date will default to the current day, month, year,
17449 hour and minute. If this command is called to replace a timestamp at point,
17450 of to enter the second timestamp of a range, the default time is taken from the
17451 existing stamp. For example,
17452 3-2-5 --> 2003-02-05
17453 feb 15 --> currentyear-02-15
17454 sep 12 9 --> 2009-09-12
17455 12:45 --> today 12:45
17456 22 sept 0:34 --> currentyear-09-22 0:34
17457 12 --> currentyear-currentmonth-12
17458 Fri --> nearest Friday (today or later)
17459 etc.
17461 Furthermore you can specify a relative date by giving, as the *first* thing
17462 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17463 change in days weeks, months, years.
17464 With a single plus or minus, the date is relative to today. With a double
17465 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17466 +4d --> four days from today
17467 +4 --> same as above
17468 +2w --> two weeks from today
17469 ++5 --> five days from default date
17471 The function understands only English month and weekday abbreviations,
17472 but this can be configured with the variables `parse-time-months' and
17473 `parse-time-weekdays'.
17475 While prompting, a calendar is popped up - you can also select the
17476 date with the mouse (button 1). The calendar shows a period of three
17477 months. To scroll it to other months, use the keys `>' and `<'.
17478 If you don't like the calendar, turn it off with
17479 \(setq org-read-date-popup-calendar nil)
17481 With optional argument TO-TIME, the date will immediately be converted
17482 to an internal time.
17483 With an optional argument WITH-TIME, the prompt will suggest to also
17484 insert a time. Note that when WITH-TIME is not set, you can still
17485 enter a time, and this function will inform the calling routine about
17486 this change. The calling routine may then choose to change the format
17487 used to insert the time stamp into the buffer to include the time.
17488 With optional argument FROM-STRING, read from this string instead from
17489 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17490 the time/date that is used for everything that is not specified by the
17491 user."
17492 (require 'parse-time)
17493 (let* ((org-time-stamp-rounding-minutes
17494 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17495 (org-dcst org-display-custom-times)
17496 (ct (org-current-time))
17497 (def (or default-time ct))
17498 (defdecode (decode-time def))
17499 (dummy (progn
17500 (when (< (nth 2 defdecode) org-extend-today-until)
17501 (setcar (nthcdr 2 defdecode) -1)
17502 (setcar (nthcdr 1 defdecode) 59)
17503 (setq def (apply 'encode-time defdecode)
17504 defdecode (decode-time def)))))
17505 (calendar-move-hook nil)
17506 (view-diary-entries-initially nil)
17507 (view-calendar-holidays-initially nil)
17508 (timestr (format-time-string
17509 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17510 (prompt (concat (if prompt (concat prompt " ") "")
17511 (format "Date+time [%s]: " timestr)))
17512 ans (org-ans0 "") org-ans1 org-ans2 final)
17514 (cond
17515 (from-string (setq ans from-string))
17516 (org-read-date-popup-calendar
17517 (save-excursion
17518 (save-window-excursion
17519 (calendar)
17520 (calendar-forward-day (- (time-to-days def)
17521 (calendar-absolute-from-gregorian
17522 (calendar-current-date))))
17523 (org-eval-in-calendar nil t)
17524 (let* ((old-map (current-local-map))
17525 (map (copy-keymap calendar-mode-map))
17526 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17527 (org-defkey map (kbd "RET") 'org-calendar-select)
17528 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17529 'org-calendar-select-mouse)
17567 ;; org-ans0: from prompt
17568 ;; org-ans1: from mouse click
17569 ;; org-ans2: from calendar motion
17597 "Display the currrent date prompt interpretation in the minibuffer."
17613 org-time-stamp-custom-formats
17614 org-time-stamp-formats))
17623 org-end-time-was-given
17630 "Analyze the combined answer of the date prompt."
17631 ;; FIXME: cleanup and comment
17633 hour minute second wday pm h2 m2 tl wday1)
17641 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17651 t nil ans)))
17652 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17653 ;; If there is a time with am/pm, and *no* time without it, we convert
17654 ;; so that matching will be successful.
17668 t t ans))))
17670 ;; Check if a time range is given as a duration
17671 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17679 ;; Check if there is a time range
17713 ;; Weekday was given, but no day, so pick that day in the week
17714 ;; on or after the derived date.
17728 "Check string S for special relative date string.
17729 TODAY and DEFAULT are internal times, for today and for a default.
17730 Return shift list (N what def-flag)
17732 N is the number of WHATs to shift.
17733 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17734 the DEFAULT date rather than TODAY."
17743 ?+))
17750 delta)
17760 "Eval FORM in the calendar window and return to current window.
17761 Also, store the cursor date in variable org-ans2."
17772 ; ;; Update the prompt to show new default date
17773 ; (save-excursion
17774 ; (goto-char (point-min))
17775 ; (when (and org-ans2
17776 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17777 ; (get-text-property (match-end 0) 'field))
17778 ; (let ((inhibit-read-only t))
17779 ; (replace-match (concat "[" org-ans2 "]") t t)
17780 ; (add-text-properties (point-min) (1+ (match-end 0))
17781 ; (text-properties-at (1+ (point-min)))))))))
17784 "Return to `org-read-date' with the date currently selected.
17785 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17794 "Insert a date stamp for the date given by the internal TIME.
17795 WITH-HM means, use the stamp format that includes the time of the day.
17796 INACTIVE means use square brackets instead of angular ones, so that the
17797 stamp will not contribute to the agenda.
17798 PRE and POST are optional strings to be inserted before and after the
17799 stamp.
17800 The command returns the inserted time stamp."
17802 stamp)
17819 stamp))
17822 "Toggle the use of custom time stamp formats."
17843 "Overlay modified time stamp format over timestamp between BED and END."
17870 "Translate all timestamps in STRING to custom format.
17871 But do this only if the variable `org-display-custom-times' is set."
17876 t1 with-hm inactive tf time str beg end)
17885 org-time-stamp-custom-formats)
17894 string)
17897 "Set 0 instead of nil for the first 6 elements of time.
17898 Don't touch the rest."
17903 "Difference between TIMESTAMP-STRING and now in days."
17908 "Is the time in TIMESTAMP-STRING close to the current date?"
17914 "Get the deadline lead time appropriate for timestring TS."
17917 ;; 0 or negative, enforce this value no matter what
17920 ;; lead time is specified.
17925 ;; go for the default.
17929 "Return to `org-read-date' with the date currently selected.
17930 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17940 "Check if there are any deadlines due or past due.
17941 A deadline is considered due if it happens within `org-deadline-warning-days'
17942 days from today's date. If the deadline appears in an entry marked DONE,
17943 it is not shown. The prefix arg NDAYS can be used to test that many
17958 org-warn-days)))
17961 "Check if there are deadlines or scheduled entries before DATE."
17975 "Evaluate a time range by computing the difference between start and end.
17976 Normally the result is just printed in the echo area, but with prefix arg
17977 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17978 If the time range is actually in a table, the result is inserted into the
17979 next column.
17980 For time difference computation, a year is assumed to be exactly 365
17981 days in order to avoid rounding problems."
18001 ;; (ys (floor (* 365 24 60 60)))
18009 y d h m align)
18012 y 0
18017 y 0
18055 "Convert a time stamp to an absolute day number.
18056 If there is a specifyer for a cyclic time stamp, get the closest date to
18057 DAYNR."
18061 daynr
18066 prefer))
18070 "Return the time corresponding to date D.
18071 D may be an absolute day number, or a calendar-type list (month day year)."
18076 "List of holidays, for Diary display in Org-mode."
18084 "Process a SEXP diary ENTRY for DATE."
18104 "Get iCalendar entries from diary entries in buffer FROMBUF.
18105 This uses the icalendar.el library."
18108 temporary-file-directory))
18111 buf rtn b e)
18127 rtn))
18130 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18131 When PREFER is `past' return a date that is either CURRENT or past.
18132 When PREFER is `future', return a date that is either CURRENT or future."
18133 ;; Make the proper lists from the dates
18136 dn dw sday cday n1 n2
18137 d m y y1 y2 date1 date2 nmonths nm ny m2)
18142 current
18166 ;; approx number of month between the tow dates
18168 ;; How often does dn fit in there?
18197 "Turn any specification of DATE into a gregorian date for the calendar."
18207 "Parse the standard Org-mode time string.
18208 This should be a lot faster than the normal `parse-time-string'.
18209 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18210 hour and minute fields will be nil if not given."
18220 nil nil nil)
18224 "Increase the date item at the cursor by one.
18225 If the cursor is on the year, change the year. If it is on the month or
18226 the day, change that.
18227 With prefix ARG, change by that many units."
18232 "Decrease the date item at the cursor by one.
18233 If the cursor is on the year, change the year. If it is on the month or
18234 the day, change that.
18235 With prefix ARG, change by that many units."
18240 "Increase the date in the time stamp by one day.
18241 With prefix ARG, change that many days."
18249 "Decrease the date in the time stamp by one day.
18250 With prefix ARG, change that many days."
18263 "Determine if the cursor is in or at a timestamp."
18289 ans))
18292 ""
18304 "Change the date in the time stamp at point.
18305 The date will be changed by N times WHAT. WHAT can be `day', `month',
18306 `year', `minute', `second'. If WHAT is not given, the cursor position
18307 in the timestamp determines what will be changed."
18309 with-hm inactive
18310 org-ts-what
18311 extra
18312 ts time time0)
18318 org-display-custom-times
18328 ts)
18356 ;; Try to recenter the calendar window, if any
18362 ;; FIXME: does not yet work for lead times
18364 "Change the different parts of the lead-time and repeat fields in timestamp."
18366 ng h m new)
18367 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18388 new
18390 s))
18393 "If the calendar is visible, recenter it to DATE."
18404 "Go to the Emacs calendar at the current date.
18405 If there is a time stamp in the current line, go to that date.
18406 A prefix ARG can be used to force the current date."
18425 "Return a list (month day year) of date at point in calendar."
18431 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18432 If there is already a time stamp at the cursor position, update it."
18440 ;; Make appt aware of appointments from the agenda
18441 ;;;###autoload
18443 "Activate appointments found in `org-agenda-files'.
18444 When prefixed, prompt for a regular expression and use it as a
18445 filter: only add entries if they match this regular expression.
18447 FILTER can be a string. In this case, use this string as a
18448 regular expression to filter results.
18450 FILTER can also be an alist, with the car of each cell being
18451 either 'headline or 'category. For example:
18456 will only add headlines containing IMPORTANT or headlines
18467 ;; Get all entries which may contain an appt
18472 file today
18475 ;; Map thru entries and find if they pass thru the filter
18488 ;; FIXME: Shall we remove text-properties for the appt text?
18489 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18501 ;;; The clock for measuring work time.
18526 "Start the clock on the current item.
18527 If necessary, clock-out of the currently active clock."
18535 org-clock-in-switch-to-state
18562 "Find the location where the next clock line should be inserted."
18568 first last)
18572 ;; we seem to have a CLOCK drawer, so go there.
18575 ;; Lets count the CLOCK lines
18583 ;; Wrap current entries into a new drawer
18601 ;; Planning info, skip to after it
18613 "Stop the currently running clock.
18614 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18653 "Cancel the running clock be removing the start timestamp."
18667 "Go to the currently clocked-in entry."
18684 "Sum the times for each subtree.
18685 Puts the resulting times in minutes as a text property on each headline."
18689 org-clock-string
18695 ts te dt
18696 time)
18703 ;; Two time stamps
18715 ;; A naket time
18732 "Show subtree times in the entire buffer.
18733 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18734 in the echo area."
18751 ;; Arrange to remove the overlays upon next change.
18761 "Put an overlays on the current line, displaying TIME.
18762 If LEVEL is given, prefix time with a corresponding number of stars.
18763 This creates a new overlay and stores it in `org-clock-overlays', so that it
18764 will be easy to remove."
18768 ov tx)
18787 "Remove the occur highlights from the buffer.
18788 BEG and END are ignored. If NOREMOVE is nil, remove this function
18789 from the `before-change-functions' in the current buffer."
18799 "Clock out if the current entry contains the running clock.
18800 This is used to stop the clock after a TODO entry is marked DONE,
18801 and is only done if the variable `org-clock-out-when-done' is not nil."
18807 org-clock-marker))
18808 ;; Clock out, but don't accept a logging message for this.
18812 org-log-done)))
18819 "Check if the current buffer contains the running clock.
18820 If yes, offer to stop it and to save the buffer with the changes."
18829 "Create a table containing a report about clocked time.
18830 If the cursor is inside an existing clocktable block, then the table
18831 will be updated. If not, a new clocktable will be inserted.
18832 When called with a prefix argument, move to the first clock table in the
18833 buffer and update it."
18846 "Check if the cursor is in a clocktable."
18854 start))))
18857 "If this is a CLOCK line, update it and return t.
18858 Otherwise, return nil."
18867 ts te h m s)
18869 nil
18883 t)))))
18886 "Return two times bordering a special time range.
18887 Key is a symbol specifying the range and can be one of `today', `yesterday',
18888 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18889 A week starts Monday 0:00 and ends Sunday 24:00.
18890 The range is determined relative to TIME. TIME defaults to the current time.
18891 The return value is a cons cell with two internal times like the ones
18892 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18893 the returned times will be formatted strings."
18898 s1 m1 h1 d1 month1 y1 diff ts te fm)
18928 "Write the standard clocktable."
18943 ipos time h m p level hlc hdl
18944 cc beg end pos tbl)
18958 ;; Get the right scope
18981 file)
18991 org-clock-file-total-minutes)))))))
19002 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19023 "Clock summary at ["
19027 "]."
19040 "|"
19041 "*Total time*| "
19063 cc)
19097 x))
19098 lines)
19101 ;; FIXME: I don't think anybody uses this, ask David
19103 "Return an internal list with clocking information.
19104 This list has one entry for each CLOCK interval.
19105 FIXME: describe the elements."
19109 rtn beg end next cont level title total closedp leafp
19110 clockpos titlepos h m donep)
19135 total title titlepos level leafp)
19136 rtn)
19140 ;;;; Agenda, and Diary Integration
19142 ;;; Define the Org-agenda-mode
19156 "Mode for time-sorted view on action items in Org-mode files.
19158 The following commands are available:
19164 org-agenda-pending-undo-list nil)
19166 ;; Keep global-font-lock-mode from turning on font-lock-mode
19174 ;; Make sure properties are removed when copying text
19179 buffer-substring-filters)))
19182 org-agenda-show-log nil))
19189 "Restricted to single file"
19201 org-agenda-mode-map global-map)
19299 "--"
19306 "--"
19310 "--"
19315 "--"
19320 "--"
19325 "--"
19342 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19346 "--"
19348 "--"
19358 "--"
19360 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19364 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19368 "--"
19370 "--"
19373 ))
19375 ;;; Agenda undo
19387 "Execute BODY if there is no `org-protected' text property at point."
19393 "Execute BODY while recording undo information in two buffers."
19401 _c1 _c2)
19402 ,@_body
19409 ;; make sure there are undo boundaries
19412 ;; remember which buffer to undo
19414 org-agenda-undo-list)))))
19417 "Undo a remote editing step in the agenda.
19418 This undoes changes both in the agenda buffer and in the remote buffer
19419 that have been changed along."
19425 org-agenda-pending-undo-list org-agenda-undo-list))
19429 buf line cmd rembuf)
19451 "Verify that a real change occurred between the undo lists L1 and L2."
19456 ;;; Agenda dispatch
19464 ;;;###autoload
19466 "Dispatch agenda commands to collect entries to the agenda buffer.
19467 Prompts for a command to execute. Any prefix arg will be passed
19468 on to the selected command. The default selections are:
19470 a Call `org-agenda-list' to display the agenda for current day or week.
19471 t Call `org-todo-list' to display the global todo list.
19472 T Call `org-todo-list' to display the global todo list, select only
19473 entries with a specific TODO keyword (the user gets a prompt).
19474 m Call `org-tags-view' to display headlines with tags matching
19475 a condition (the user is prompted for the condition).
19476 M Like `m', but select only TODO entries, no ordinary headlines.
19477 L Create a timeline for the current buffer.
19478 e Export views to associated files.
19480 More commands can be added by configuring the variable
19481 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19482 searches can be pre-defined in this way.
19484 If the current buffer is in Org-mode and visiting a file, you can also
19485 first press `<' once to indicate that the agenda should be temporarily
19487 Pressing `<' twice means to restrict to the current subtree or region
19488 \(if active)."
19494 ;; normalize different versions
19500 nil)
19504 org-agenda-custom-commands)))
19507 entry key type match lprops ans)
19508 ;; Turn off restriction unless there is an overriding one
19514 ;; Delete old local properties
19516 ;; Remember where this call originated
19522 ;; Estabish the restriction, if any
19539 ;; For example the todo list should not need it (but does...)
19553 current-prefix-arg)))
19605 cmds)))
19608 "The user interface for selecting an agenda command."
19615 restriction second-time
19616 c entry key type match prefixes rmheader header-end custom1 desc)
19623 "
19624 Press key for an agenda command: < Buffer,subtree/region restriction
19625 -------------------------------- > Remove restriction
19626 a Agenda for current week or day e Export agenda views
19627 t List of all TODO entries T Entries with special TODO kwd
19628 m Match a TAGS query M Like m, but only TODO entries
19629 L Timeline for current buffer # List stuck projects (!=configure)
19630 / Multi-occur C Configure custom agenda commands
19635 header start)
19639 header)))
19691 prefix-descriptions))
19693 prefixes))
19704 " (restriction lock active)"
19717 prefixes nil
19723 nil
19725 custom))))
19742 nil)
19762 match ;; The byte compiler incorrectly complains about this. Keep it!
19763 cmd type lprops)
19794 ;;;###autoload
19796 "Run an agenda command in batch mode and send the result to STDOUT.
19797 If CMD-KEY is a string of length 1, it is used as a key in
19798 `org-agenda-custom-commands' and triggers this command. If it is a
19799 longer string it is used as a tags/todo match string.
19800 Paramters are alternating variable names and values that will be bound
19801 before running the agenda command."
19815 string))
19819 ;;;###autoload
19821 "Run an agenda command in batch mode and send the result to STDOUT.
19822 If CMD-KEY is a string of length 1, it is used as a key in
19823 `org-agenda-custom-commands' and triggers this command. If it is a
19824 longer string it is used as a tags/todo match string.
19825 Paramters are alternating variable names and values that will be bound
19826 before running the agenda command.
19828 The output gives a line for each selected agenda item. Each
19829 item is a list of comma-separated values, like this:
19831 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19833 category The category of the item
19834 head The headline, without TODO kwd, TAGS and PRIORITY
19835 type The type of the agenda entry, can be
19836 todo selected in TODO match
19837 tagsmatch selected in tags match
19838 diary imported from diary
19839 deadline a deadline on given date
19840 scheduled scheduled on given date
19841 timestamp entry has timestamp on given date
19842 closed entry was closed on given date
19843 upcoming-deadline warning about deadline
19844 past-scheduled forwarded scheduled item
19845 block entry has date block including g. date
19846 todo The todo keyword, if any
19847 tags All tags including inherited ones, separated by colons
19848 date The relevant date, like 2007-2-14
19849 time The time, like 15:00-16:50
19850 extra Sting with extra planning info
19851 priority-l The priority letter if any was given
19852 priority-n The computed numerical priority
19853 agenda-day The day in the agenda where this is listed"
19865 line)
19875 priority-letter priority agenda-day)
19880 "Make sure all properties on an agenda item have a canonical form,
19881 so the export commands can easily use it."
19908 props)
19922 ;;;###autoload
19927 ;; FIXME, why is this a macro?????
19928 ;;;###autoload
19930 "Run all custom agenda commands that have a file argument."
19934 pars cmd thiscmdkey files opts)
19957 "Write the current buffer (an agenda view) as a file.
19958 Depending on the extension of the file name, plain text (.txt),
19959 HTML (.html or .htm) or Postscript (.ps) is produced.
19960 If NOSETTINGS is given, do not scope the settings of
19961 `org-agenda-exporter-settings' into the export commands. This is used when
19962 the settings have already been scoped and we do not wish to overrule other,
19963 higher priority settings."
19979 ;; replace <style> section with org-agenda-export-html-style
20000 "Inhibit read-only for BODY."
20004 "Make sure current buffer is in org-mode. Error if not."
20007 major-mode)))
20010 "Fit the window to the buffer size."
20014 nil
20018 ;;; Agenda file list
20021 "Get the list of agenda files.
20022 Optional UNRESTRICTED means return the full list even if a restriction
20023 is currently in place."
20034 org-agenda-file-regexp)
20036 files)))
20042 files))
20046 "Edit the list of agenda files.
20047 Depending on setup, this either uses customize to edit the variable
20048 `org-agenda-files', or it visits the file that is holding the list. In the
20049 latter case, the buffer is set up in a way that saving it automatically kills
20050 the buffer and restores the previous window configuration."
20069 "Set new value for the agenda file list and save it correcly."
20080 "Read the list of agenda files from a file."
20087 ;;;###autoload
20089 "Cycle through the files in `org-agenda-files'.
20090 If the current buffer visits an agenda file, find the next one in the list.
20091 If the current buffer does not, find the first agenda file."
20096 file)
20108 "Move/add the current file to the top of the agenda file list.
20109 If the file is not present in the list, it is added to the front. If it is
20110 present, it is moved there. With optional argument TO-END, add/move to the
20111 end of the list."
20118 x had)
20131 "Remove current file from the list of files in variable `org-agenda-files'.
20132 These are the files which are being checked for agenda entries.
20133 Optional argument FILE means, use this file instead of the current."
20143 nil x))
20156 "Make sure FILE exists. If not, ask user what to do."
20167 ;;; Agenda prepare and finalize
20212 "Finishing touch for the agenda buffer, called just before displaying it."
20224 org-overriding-columns-format)
20226 org-overriding-columns-format))
20228 org-agenda-view-columns-initially)
20234 )))
20237 "Make highest priority lines bold, and lowest italic."
20244 b e p ov h l)
20248 org-highest-priority)
20250 org-lowest-priority)
20255 ov 'face
20263 "Create buffers for all agenda files, protect archived trees and comments."
20270 bmp file re)
20300 "Function to be called at each match during agenda construction.
20301 If this function returns nil, the current match should not be skipped.
20302 Otherwise, the function must return a position from where the search
20303 should be continued.
20304 This may also be a Lisp form, it will be evaluated.
20305 Never set this variable using `setq' or so, because then it will apply
20306 to all future agenda commands. Instead, bind it with `let' to scope
20307 it dynamically into the agenda-constructing command. A good way to set
20311 "Throw to `:skip' in places that should be skipped.
20312 Also moves point to the end of the skipped region, so that search can
20313 continue from there."
20339 "Return a new agenda marker.
20340 Org-mode keeps a list of these markers and resets them when they are
20341 no longer in use."
20345 m))
20348 "Reset markers created by `org-agenda'. But only if they are old enough."
20351 org-agenda-last-marker-time)
20357 "Get a buffer visiting FILE. If the buffer needs to be created, add
20358 it to the list of buffers which might be released later."
20361 buf ; just return it
20362 ;; Make a new buffer and remember it
20365 buf)))
20368 "Release all buffers in list, asking the user for confirmation when needed.
20369 When a buffer is unmodified, it is just killed. When modified, it is saved
20370 \(if the user agrees) and then killed."
20375 file
20381 "Get the category applying to position POS."
20384 ;;; Agenda timeline
20389 "Show a time-sorted view of the entries in the current org file.
20390 Only entries with a time stamp of today or later will be listed. With
20392 under the current date.
20393 If the buffer contains an active region, only check the region for
20394 dates."
20407 t doclosed ; always include today
20408 org-timeline-show-empty-dates))
20413 args
20414 s e rtn d emptyp)
20420 ;; Remove past dates from the list of dates.
20423 day-numbers))))
20440 dopast
20441 past)
20449 date args)))
20472 "Return a list of all relevant day numbers from BEG to END buffer positions.
20473 If NO-RANGES is non-nil, include only the start and end dates of a range,
20474 not every single day in the range. If FORCE-TODAY is non-nil, make
20475 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20476 inactive time stamps (those in square brackets) are included.
20477 When EMPTY is non-nil, also include days without any entries."
20481 dates dates1 date day day1 day2 ts1 ts2)
20511 dates)))
20513 ;;; Agenda Daily/Weekly
20524 ;;;###autoload
20526 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20527 The view will be for the current day or week, but from the overview buffer
20528 you will be able to go to other days/weeks.
20531 all unfinished TODO items will also be shown, before the agenda.
20532 This feature is considered obsolete, please use the TODO list or a block
20533 agenda instead.
20535 With a numeric prefix argument in an interactive call, the agenda will
20536 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20537 the number of days. NDAYS defaults to `org-agenda-ndays'.
20539 START-DAY defaults to TODAY, or to the most recent match for the weekday
20540 given in `org-agenda-start-on-weekday'."
20551 ;; Convert to an absolute day number
20559 org-agenda-start-on-weekday nil))
20568 sd
20577 s e rtn rtnall file date d start-pos end-pos todayp nd)
20580 ;; Make the list of days
20582 nd ndays)
20595 rtnall nil)
20623 rtnall nil)
20629 file date
20632 file date
20656 rtnall nd todayp))
20679 ;;; Agenda TODO list
20684 ;;;###autoload
20686 "Show all TODO entries from all agenda file in a single list.
20687 The prefix arg can be used to select a specific TODO keyword and limit
20689 for a keyword. A numeric prefix directly selects the Nth keyword in
20690 `org-todo-keywords-1'."
20704 rtn rtnall files file pos)
20714 rtnall nil)
20738 kwds))
20749 ;;; Agenda tags match
20751 ;;;###autoload
20753 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20754 The prefix arg TODO-ONLY limits the search to TODO entries."
20761 rtn rtnall files file pos matcher
20762 buffer)
20770 rtnall nil)
20778 ;; If file does not exist, merror message to agenda
20789 org-agenda-restrict-end)
20814 ;;; Agenda Finding stuck projects
20817 "Regular expression used in skipping subtrees for the agenda.
20818 This is basically a temporary global variable that can be set and then
20825 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20826 If yes, it returns the end position of this tree, causing agenda commands
20827 to skip this subtree. This is a function that can be put into
20828 `org-agenda-skip-function' for the duration of a command."
20830 skip)
20836 "Skip entry if any of CONDITIONS is true.
20837 See `org-agenda-skip-if' for details."
20841 "Skip entry if any of CONDITIONS is true.
20842 See `org-agenda-skip-if' for details."
20846 "Checks current entity for CONDITIONS.
20847 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20848 the entry, i.e. the text before the next heading is checked.
20850 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20851 from different tests. Valid conditions are:
20853 scheduled Check if there is a scheduled cookie
20854 notscheduled Check if there is no scheduled cookie
20855 deadline Check if there is a deadline
20856 notdeadline Check if there is no deadline
20857 regexp Check if regexp matches
20858 notregexp Check if regexp does not match.
20860 The regexp is taken from the conditions list, it must come right after
20861 the `regexp' or `notregexp' element.
20863 If any of these conditions is met, this function returns the end point of
20864 the entity, causing the search to continue from there. This is a function
20865 that can be put into `org-agenda-skip-function' for the duration of a command."
20889 end)))
20891 ;;;###autoload
20893 "Create agenda view for projects that are stuck.
20894 Stuck projects are project that have no next actions. For the definitions
20895 of what a project is and how to check if it stuck, customize the variable
20896 `org-stuck-projects'.
20897 MATCH is being ignored."
20900 ;; FIXME: we could have used org-agenda-skip-if here.
20908 org-done-keywords-for-agenda
20910 todo))
20927 gen-re)))))
20938 ;;; Diary integration
20943 "Get the (Emacs Calendar) diary entries for DATE."
20951 entries
20963 ;; No entries
20965 ;; Omit the date and other unnecessary stuff
20967 ;; Add prefix to each line and extend the text properties
20979 ;; Extend the text properties to the beginning of the line
20982 entries)))))
20985 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
20986 This gets rid of the date, the underline under the date, and
20987 the dummy entry installed by `org-mode' to ensure non-empty diary for each
20988 date. It also removes lines that contain only whitespace."
21005 ;; Make sure entries from the diary have the right text properties.
21008 ;; We can rely on the hook, nothing to do
21009 nil
21010 ;; Hook not avaiable, must use advice to make this work
21012 "Make the position visible."
21015 buffer-file-name)
21019 "Add text properties to string, allowing org-mode to act on it."
21022 'keymap org-agenda-keymap
21027 'org-agenda-diary-link t
21031 "Add a dummy entry to the diary.
21032 Needed to avoid empty dates which mess up holiday display."
21033 ;; Catch the error if dealing with the new add-to-diary-alist
21040 ;;;###autoload
21042 "Return diary information from org-files.
21044 It accesses org files and extracts information from those files to be
21045 listed in the diary. The function accepts arguments specifying what
21046 items should be listed. The following arguments are allowed:
21048 :timestamp List the headlines of items containing a date stamp or
21049 date range matching the selected date. Deadlines will
21050 also be listed, on the expiration day.
21052 :sexp List entries resulting from diary-like sexps.
21054 :deadline List any deadlines past due, or due within
21055 `org-deadline-warning-days'. The listing occurs only
21056 in the diary for *today*, not at any other date. If
21057 an entry is marked DONE, it is no longer listed.
21059 :scheduled List all items which are scheduled for the given date.
21060 The diary for *today* also contains items which were
21061 scheduled earlier and are not yet marked DONE.
21063 :todo List all TODO items from the org-file. This may be a
21064 long list - so this is not turned on by default.
21065 Like deadlines, these entries only show up in the
21066 diary for *today*, not at any other date.
21068 The call in the diary file should look like this:
21070 &%%(org-diary) ~/path/to/some/orgfile.org
21072 Use a separate line for each org file to check. Or, if you omit the file name,
21073 all files listed in `org-agenda-files' will be checked automatically:
21075 &%%(org-diary)
21077 If you don't give any arguments (as in the example above), the default
21078 arguments (:deadline :scheduled :timestamp :sexp) are used.
21079 So the example above may also be written as
21081 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21083 The function expects the lisp variables `entry' and `date' to be provided
21084 by the caller, because this is how the calendar works. Don't use this
21085 function from a program - use `org-agenda-get-day-entries' instead."
21093 file rtn results)
21095 ;; If this is called during org-agenda, don't return any entries to
21096 ;; the calendar. Org Agenda will list these entries itself.
21104 ;;; Agenda entry finders
21107 "Does the work for `org-diary' and `org-agenda'.
21108 FILE is the path to a file to be checked for entries. DATE is date like
21109 the one returned by `calendar-current-date'. ARGS are symbols indicating
21110 which kind of entries should be extracted. For details about these, see
21111 the documentation of `org-diary'."
21118 arg results rtn)
21120 ;; If file does not exist, make sure an error message ends up in diary
21130 org-agenda-restrict-end)
21132 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21156 results))))
21172 "Is the cursor inside a date range?"
21187 nil)))
21190 "Return the TODO information for agenda display."
21193 'org-not-done-regexp org-not-done-regexp
21194 'org-todo-regexp org-todo-regexp
21196 'keymap org-agenda-keymap
21197 'help-echo
21200 ;; FIXME: get rid of the \n at some point but watch out
21204 org-todo-regexp
21208 org-not-done-regexp)
21210 marker priority category tags
21211 ee txt beg end)
21250 "Return the date stamp information for agenda display."
21252 'org-not-done-regexp org-not-done-regexp
21253 'org-todo-regexp org-todo-regexp
21255 'keymap org-agenda-keymap
21256 'help-echo
21264 "<%Y-%m-%d"
21278 marker hdmarker deadlinep scheduledp donep tmp priority category
21279 ee txt timestr tags b0 b3 e3 head)
21297 b0)
21304 ;; substring should only run to end of time stamp
21316 nil head category tags timestr nil
21317 remove-re)))
21330 "Return the sexp information for agenda display."
21334 'keymap org-agenda-keymap
21335 'help-echo
21339 marker category ee txt tags entry result beg b sexp sexp-entry)
21371 "Return the logged TODO entries for agenda display."
21373 'org-not-done-regexp org-not-done-regexp
21374 'org-todo-regexp org-todo-regexp
21375 'keymap org-agenda-keymap
21376 'help-echo
21388 marker hdmarker priority category tags closedp
21389 ee txt timestr)
21398 ;; donep (org-entry-is-done-p)
21399 )
21401 ;; substring should only run to end of time stamp
21425 "Return the deadline information for agenda display."
21427 'org-not-done-regexp org-not-done-regexp
21428 'org-todo-regexp org-todo-regexp
21429 'keymap org-agenda-keymap
21430 'help-echo
21436 d2 diff dfrac wdays pos pos1 category tags
21437 ee txt head face s upcomingp donep timestr)
21449 ;; When to show a deadline in the calendar:
21450 ;; If the expiration is within wdays warning time.
21451 ;; Past-due deadlines are only shown on the current date
21479 diff))
21480 head category tags timestr))))
21489 'org-category category
21498 "Return the face to displaying a deadline item.
21499 FRACTION is what fraction of the head-warning time has passed."
21506 "Return the scheduled information for agenda display."
21508 'org-todo-regexp org-todo-regexp
21511 'keymap org-agenda-keymap
21512 'help-echo
21518 d2 diff pos pos1 category tags
21519 ee txt head pastschedp donep face timestr s)
21527 ;;; is this right?
21528 ;;; do we need to do this for deadleine too????
21529 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21532 ;; When to show a scheduled item in the calendar:
21533 ;; If it is on or past the date.
21561 head category tags timestr))))
21565 'org-scheduled-previously
21568 'undone-face face
21580 "Return the date-range information for agenda display."
21582 'org-not-done-regexp org-not-done-regexp
21583 'org-todo-regexp org-todo-regexp
21585 'keymap org-agenda-keymap
21586 'help-echo
21591 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21592 donep head)
21604 ;; Only allow days between the limits, because the normal
21605 ;; date stamps will catch the limits.
21622 head category tags
21631 ;; Sort the entries by expiration date.
21634 ;;; Agenda presentation and sorting
21644 "Regular expression to match a plain time or time range.
21645 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21646 groups carry important information:
21647 0 the full match
21648 1 the first time, range or not
21656 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21657 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21658 groups carry important information:
21659 0 the full match
21660 7 hours of duration
21669 "Regular expression to match a timestamp time or time range.
21670 After a match, the following groups carry important information:
21671 0 the full match
21672 1 date plus weekday, for backreferencing to make sure both times on same day
21673 2 the first time, range or not
21677 "A flag, set by `org-compile-prefix-format'.
21680 "A flag, set by `org-compile-prefix-format'.
21684 noprefix remove-re)
21685 "Format TXT to be inserted into the agenda buffer.
21686 In particular, it adds the prefix and corresponding text properties. EXTRA
21687 must be a string and replaces the `%s' specifier in the prefix format.
21688 CATEGORY (string, symbol or nil) may be used to overrule the default
21689 category taken from local variable or file name. It will replace the `%c'
21690 specifier in the format. DOTIME, when non-nil, indicates that a
21691 time-of-day should be extracted from TXT for sorting of this entry, and for
21692 the `%t' specifier in the format. When DOTIME is a string, this string is
21693 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21694 only the correctly processes TXT should be returned - this is used by
21695 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21696 Any match of REMOVE-RE will be removed from TXT."
21698 ;; Diary entries sometimes have extra whitespace at the beginning
21701 org-category
21707 time ; time and tag are needed for the eval of the prefix format
21710 stamp plain s0 s1 s2 rtn srp)
21712 ;; Extract starting and ending time and move them to prefix
21720 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21721 ;; them, we might want to remove them there to avoid duplication.
21722 ;; The user can turn this off with a variable.
21728 t))
21730 ;; Normalize the time(s) to 24 hour
21738 org-agenda-default-appointment-duration))
21739 h)
21744 txt)
21745 ;; Tags are in the string
21748 org-prefix-has-tag))
21753 t t txt))))
21759 ;; Create the final string
21762 ;; Prepare the variables needed in the eval of the compiled format
21768 ;; Evaluate the compiled format
21771 ;; And finally add the text properties
21774 'org-highest-priority org-highest-priority
21775 'org-lowest-priority org-lowest-priority
21777 'time-of-day time-of-day
21778 'txt txt
21779 'time time
21780 'extra extra
21795 list)))
21800 new time)
21802 ;; don't show empty grid
21808 nil string "" nil
21810 new)
21818 "Compile the prefix format into a Lisp form that can be evaluated.
21819 The resulting form is returned and stored in the variable
21820 `org-prefix-format-compiled'."
21824 org-agenda-prefix-format)
21829 varform vars var e c f opt)
21831 s start)
21844 ""
21854 ;; the old format
21862 "Check string S for a time of day.
21863 If found, return it as a military time number between 0 and 2400.
21864 If not found, return nil.
21865 The optional STRING argument forces conversion into a 5 character wide string
21866 HH:MM."
21888 "Sort and concatenate the agenda items."
21891 list
21910 ; (and re (equal (string-match (concat "\\(\\.*\\)" re) x (or pl 0)) pl)
21911 ; (add-text-properties
21912 ; (or (match-end 1) (match-end 0)) (match-end 0)
21913 ; (list 'face (org-get-todo-face (match-string 2 x)))
21914 ; x))
21921 x)
21925 " "
21927 x)))
21930 "Compare the priorities of string A and B."
21938 "Compare the string values of categories of strings A and B."
21946 "Compare the string values of categories of strings A and B."
21956 "Compare the time-of-day values of strings A and B."
21965 "Predicate for sorting agenda entries."
21966 ;; The following variables will be used when the form is evaluated.
21967 ;; So even though the compiler complains, keep them.
21981 ;;; Agenda restriction lock
21999 "Set restriction lock for agenda, to current subtree or file.
22000 Restriction will be the file if TYPE is `file', or if type is the
22001 universal prefix '(4), or if the cursor is before the first headline
22002 in the file. Otherwise, restriction will be to the current subtree."
22034 "Remove the agenda restriction lock."
22048 "If there is any window showing the agenda view, update it."
22057 org-agenda-overriding-restriction)
22060 ;;; Agenda commands
22063 "Check if agenda buffer is of allowed type.
22064 If ERROR is non-nil, throw an error, otherwise just return nil."
22066 t
22069 nil)))
22072 "Exit agenda by removing the window or the buffer."
22079 ;; Maybe restore the pre-agenda window configuration.
22082 org-pre-agenda-window-conf
22086 "Exit agenda by removing the window or the buffer.
22087 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22088 Org-mode buffers visited directly by the user will not be touched."
22102 "Save all Org-mode buffers without user confirmation."
22109 "Rebuild Agenda.
22110 When this is the global TODO list, a prefix argument will be interpreted."
22119 org-agenda-pending-undo-list nil)
22125 "Jump to DATE in agenda."
22130 "Go to today."
22156 "Go forward in time by thee current span.
22157 With prefix ARG, go forward that many times the current span."
22164 greg2 nd)
22186 "Go backward in time by the current span.
22187 With prefix ARG, go backward that many times the current span."
22192 "Switch to daily view for agenda."
22197 "Switch to daily view for agenda."
22202 "Switch to daily view for agenda."
22206 "Switch to daily view for agenda."
22213 "Change the agenda view to SPAN.
22214 SPAN may be `day', `week', `month', `year'."
22219 org-starting-day))
22230 "Compute starting date and number of days for agenda.
22231 SPAN may be `day', `week', `month', `year'. The return value
22232 is a cons cell with the starting date and the number of days,
22233 so that the date SD will be in that range."
22235 nd)
22252 sd)))
22258 sd))))
22261 ;; FIXME: does not work if user makes date format that starts with a blank
22263 "Jump to the next line indicating a date in agenda buffer."
22275 "Jump to the previous line indicating a date in agenda buffer."
22282 ;; Initialize the highlight
22287 "Highlight a region with overlay."
22292 "Detach overlay INDEX."
22295 ;; FIXME this is currently not used.
22304 "Toggle follow mode in an agenda buffer."
22312 "Toggle log mode in an agenda buffer."
22322 "Toggle diary inclusion in an agenda buffer."
22332 "Toggle time grid in an agenda buffer."
22342 "Set the mode name to indicate all the small mode settings."
22361 "Show the priority of the current item.
22362 This priority is composed of the main priority given with the [#A] cookies,
22363 and by additional input from the age of a schedules or deadline entry."
22369 "Show the tags applicable to the current item."
22378 "Go to the Org-mode file which contains the item at point."
22397 "Normal hook run after an item has been shown from the agenda.
22401 "Kill the entry or subtree belonging to the current agenda entry."
22434 "Kill the entry or subtree belonging to the current agenda entry."
22452 "Remove all lines in the agenda that correspond to a given subtree.
22453 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22454 If this information is not given, the function uses the tree at point."
22477 "Follow the link in the current line, if any."
22486 "Get a variable from a referenced buffer and install it here."
22493 "Go to the Org-mode file which contains the item at point."
22510 "Go to the Org-mode file which contains the item at the mouse click."
22516 "Display the Org-mode file which contains the item at point."
22523 "Display the Org-mode file which contains the item at point and recenter."
22531 "Display the Org-mode file which contains the item at the mouse click."
22537 "Check if the entry is a diary link and abort if yes."
22545 "Show the subtree corresponding to the current entry in an indirect buffer.
22546 This calls the command `org-tree-to-indirect-buffer' from the original
22547 Org-mode buffer.
22548 With numerical prefix arg ARG, go up to this level and then take that tree.
22549 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22550 dedicated frame)."
22563 "Marker pointing to the headline that last changed its TODO state
22567 "Switch TODO entry to next sequence."
22572 "Switch TODO entry to previous sequence."
22577 "Cycle TODO state of line at point, also in Org-mode file.
22578 This changes the line at point, all other lines in the agenda referring to
22579 the same tree node, and the headline of the tree node in the Org-mode file."
22589 newhead)
22610 "Change all lines in the agenda buffer which match HDMARKER.
22611 The new content of the line will be NEWHEAD (as modified by
22612 `org-format-agenda-item'). HDMARKER is checked with
22613 `equal' against all `org-hd-marker' text properties in the file.
22614 If FIXFACE is non-nil, the face of each item is modified acording to
22615 the new TODO state."
22617 props m pl undone-face done-face finish new dotime cat tags)
22647 undone-face done-face))))
22655 "Align all tags in agenda items to `org-agenda-tags-column'."
22668 org-agenda-tags-column))
22676 "Increase the priority of line at point, also in Org-mode file."
22681 "Decrease the priority of line at point, also in Org-mode file."
22686 "Set the priority of line at point, also in Org-mode file.
22687 This changes the line at point, all other lines in the agenda referring to
22688 the same tree node, and the headline of the tree node in the Org-mode file."
22697 newhead)
22713 "Get a list of all headline tags applicable at POS.
22714 POS defaults to point. If tags are inherited, the list contains
22715 the targets in the same sequence as the headlines appear, i.e.
22716 the tags of the current headline come last."
22731 tags)))
22735 tags)))
22737 ;; FIXME: should fix the tags property of the agenda line.
22739 "Set tags for the current headline."
22750 newhead)
22768 "Toggle the archive tag for the current entry."
22777 newhead)
22793 "Change the date of this item to one day later."
22812 "Change the date of this item to one day earlier."
22817 "Show new date stamp via text properties."
22818 ;; We use text properties to make this undoable
22827 ;; Use `duplicable' property to trigger undo recording
22842 "Change the date of this item. Date is prompted for, with default today.
22843 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22844 be used to request time specification in the time stamp."
22862 "Schedule the item at point."
22871 ts)
22881 "Schedule the item at point."
22890 ts)
22900 "Return the heading of the current entry, without the stars."
22910 "Start the clock on the currently selected item."
22923 "Stop the currently running clock."
22931 "Cancel the currently running clock."
22939 "Make a diary entry, like the `i' command from the calendar.
22940 All the standard commands work: block, weekly etc."
22956 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
22965 ;; We implement this by hacking the `calendar-cursor-to-date' function
22966 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
22982 "Execute a calendar command from the agenda, with the date associated to
22983 the cursor position."
22992 ;; the following 3 vars are needed in the calendar
23006 "Display the phases of the moon for the 3 months around the cursor date."
23011 "Display the holidays for the 3 months around the cursor date."
23016 "Display sunrise and sunset for the cursor date.
23017 Latitude and longitude can be specified with the variables
23018 `calendar-latitude' and `calendar-longitude'. When called with prefix
23019 argument, latitude and longitude will be prompted for."
23028 "Open the Emacs calendar with the date at the cursor."
23041 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23042 This is a command that has to be installed in `calendar-mode-map'."
23046 nil))
23052 date s)
23078 ;;;; Embedded LaTeX
23093 "Toggle the minor `org-cdlatex-mode'.
23094 This mode supports entering LaTeX environment and math in LaTeX fragments
23095 in Org-mode.
23097 nil " OCDL" nil
23102 "Always return t in org-mode buffers.
23103 This is because we want to insert math symbols without dollars even outside
23104 the LaTeX math segments. If Orgmode thinks that point is actually inside
23105 en embedded LaTeX fragement, let texmathp do its job.
23122 "Unconditionally turn on `org-cdlatex-mode'."
23126 "Test if point is inside a LaTeX fragment.
23128 sequence appearing also before point.
23129 Even though the matchers for math are configurable, this function assumes
23131 delimiters are skipped when they have been removed by customization.
23132 The return value is nil, or a cons cell with the delimiter and
23133 and the position of this delimiter.
23135 This function does a reasonably good job, but can locally be fooled by
23136 for example currency specifications. For example it will assume being in
23138 fragments that are properly closed, but during editing, we have to live
23139 with the uncertainty caused by missing closing delimiters. This function
23140 looks only before point, not after."
23159 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23163 ;; count $$
23171 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23172 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23173 - inside a LaTeX fragment, or
23174 - after the first word in a line, where an abbreviation expansion could
23175 insert a LaTeX environment."
23188 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23189 Revert to the normal definition outside of these fragments."
23197 "Execute `cdlatex-math-modify' in LaTeX fragments.
23198 Revert to the normal definition outside of these fragments."
23210 "Remove all overlays with LaTeX fragment images in current buffer."
23215 "Preview the LaTeX fragment at point, or all locally or globally.
23216 If the cursor is in a LaTeX fragment, create the image and overlay
23217 it over the source code. If there is no fragment at point, display
23218 all fragments in the current text, from one headline to the next. With
23219 prefix SUBTREE, display all fragments in the current subtree. With a
23220 double prefix `C-u C-u', or when the cursor is before the first headline,
23221 display all fragments in the buffer.
23251 buffer-file-name)))
23257 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23258 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23259 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23266 "Replace LaTeX fragments with links to an image, and produce images."
23275 m n block linkfile movefile ov)
23276 ;; Check if there are old images files with this prefix, and remove them
23280 todir 'full
23282 ;; Check the different regular expressions
23302 txt movefile opt forbuffer)
23310 ov 'end-glyph
23313 ov 'display
23320 ;; This function borrows from Ganesh Swami's latex2png.el
23324 temporary-file-directory))
23353 "-D" dpi
23354 ;;"-x" scale "-y" scale
23356 "-o" pngfile
23357 dvifile)
23360 ;; Use the requested file name and clean up
23364 pngfile))))
23367 "Return an rgb color specification for dvipng."
23373 "Return string to be used as color value for an RGB component."
23376 ;;;; Exporting
23378 ;;; Variables, constants, and parameter plists
23434 "Return the property list with default settings for the export variables."
23438 rtn))
23441 "Return the property list with file-local settings for export."
23448 p key val text options)
23481 o)
23485 options)
23489 p))))
23495 val)))
23496 dir))
23503 rtn line level)
23508 ;; Beginning of a COMMENT subtree. Skip it.
23514 ;; an ordinary comment line
23515 )
23521 ;; a special table line that should be removed
23522 )
23529 \[v] limit export to visible part of outline tree
23531 \[a] export as ASCII
23533 \[h] export as HTML
23534 \[H] export as HTML to temporary buffer
23535 \[R] export region as HTML
23536 \[b] export as HTML and browse immediately
23537 \[x] export as XOXO
23539 \[l] export as LaTeX
23540 \[L] export as LaTeX to temporary buffer
23542 \[i] export current file as iCalendar file
23543 \[I] export all agenda files as iCalendar files
23544 \[c] export agenda files into combined iCalendar file
23546 \[F] publish current file
23547 \[P] publish current project
23548 \[X] publish... (project will be prompted for)
23568 r1 r2 ass)
23871 )
23872 "Entities for TeX->HTML translation.
23876 The list contains HTML entities for Latin-1, Greek and other symbols.
23877 It is supplemented by a number of commonly used TeX macros with appropriate
23880 ;;; General functions for all backends
23883 "Cleanup a buffer STRING so that links can be created safely."
23901 a b xx
23902 rtn p)
23906 ;; Remove license-to-kill stuff
23914 ;; Get rid of drawers
23919 'identity
23927 ;; Get the correct stuff before the first headline
23938 ;; Get rid of archived trees
23950 ;; Find targets in comments and move them out of comments,
23951 ;; but mark them as targets that should be invisible
23956 ;; Protect backend specific stuff, throw away the others.
23961 fmt)
23992 ;; Protect quoted subtrees
24000 ;; Protect verbatim elements
24007 ;; Remove subtrees that are commented
24013 ;; Remove special table lines
24025 ;; Specific LaTeX stuff
24033 ;; Specific HTML stuff
24035 ;; Convert LaTeX fragments to images
24040 org-current-export-file)))
24044 ;; Remove or replace comments
24053 ;; Find matches for radio targets and turn them into internal links
24060 ;; Find all links that contain a newline and put them into a single line
24062 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24068 ;; Normalize links: Convert angle and plain links into bracket links
24069 ;; Expand link abbreviations
24076 ;; added 'org-link face to links
24092 "]"
24100 ;; Find multiline emphasis and put them into single line
24114 rtn))
24117 "Get a title for the current document, from looking at the buffer."
24123 ;; Mark the line so that it will not be exported as normal text.
24127 ;; Return the title string
24131 "Return subtree title and exclude it from export."
24137 ;; This is a subtree, we take the title from the first heading
24144 title))
24147 "Take link text and make a safe target out of it."
24151 'identity
24157 "Get the minimum level in LINES."
24165 ;; Variable holding the vector with section numbers
24169 "Initialize the vector for the section numbers."
24186 "Return a string with the current section number.
24187 When LEVEL is non-nil, increase section numbers on that level."
24209 string))
24211 ;;; ASCII export
24219 "Export the outline as a pretty ASCII file.
24220 If there is an active region, export only the region.
24221 The prefix ARG specifies how many levels of the outline should become
24222 underlined headlines. The default is 3."
24251 filename))
24267 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24276 region
24277 :for-ascii t
24278 :skip-before-1st-heading
24281 :verbatim-multiline t
24282 :archived-trees
24286 thetoc have-headings first-heading-pos
24287 table-open table-buffer)
24305 ;; create local variables for all options, to make sure all called
24306 ;; functions get the correct information
24310 org-export-plist-vars)
24313 org-export-headline-levels))
24316 umax))
24318 ;; File header
24322 org-export-author-info)
24344 line)
24345 ;; This is a headline
24351 todo
24355 org-done-keywords)))
24356 ; TODO, not DONE
24360 line lines level))))
24367 t t txt)))
24372 txt))
24387 thetoc)
24389 ))))
24390 lines)
24395 ;; Remove the quoted HTML tags.
24397 ;; Remove targets
24400 ;; Replace internal links
24404 t nil line)))
24409 ;; a Headline
24418 ;; New table starts
24420 ;; Accumulate lines
24441 ;; insert the table of contents
24453 ;; Convert whitespace place holders
24463 ;; remove display and invisible chars
24479 "Do extra work for ASCII export"
24489 "Search the subtree below LINE for any TODO entries."
24492 line lv todo)
24500 org-done-keywords))))
24501 ; TODO, not DONE
24506 "Handle quoted HTML for ASCII export."
24509 ;; We just remove the tags for now.
24511 line)
24514 "Insert the string S centered and underline it with character UNDERLINE."
24523 "Insert a new level in ASCII export."
24529 org-export-ascii-bullets))
24531 ;; find the indentation of the next non-empty line
24552 "Create a copy of the visible part of the current buffer, and export it.
24553 The copy is created in a temporary buffer and removed after use.
24554 TYPE is the final key (as a string) that also select the export command in
24555 the `C-c C-e' export dispatcher.
24556 As a special case, if the you type SPC at the prompt, the temporary
24557 org-mode file will not be removed but presented to you so that you can
24558 continue to use it. The prefix arg ARG is passed through to the exporting
24559 command."
24562 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24564 current-prefix-arg))
24579 s e)
24580 ;; Need to hack the drawers here.
24596 ;; Copy all comment lines to the end, to make sure #+ settings are
24597 ;; still available for the second export step. Kind of a hack, but
24598 ;; does do the trick.
24619 s))
24624 s))
24626 ;;; HTML export
24629 "Return a string with current options as keyword options.
24630 Does include HTML export options as well as TODO and CATEGORY stuff."
24632 "#+TITLE: %s
24633 #+AUTHOR: %s
24634 #+EMAIL: %s
24635 #+LANGUAGE: %s
24636 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24637 #+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
24638 #+CATEGORY: %s
24639 #+SEQ_TODO: %s
24640 #+TYP_TODO: %s
24641 #+PRIORITIES: %c %c %c
24642 #+DRAWERS: %s
24643 #+STARTUP: %s %s %s %s %s
24644 #+TAGS: %s
24645 #+ARCHIVE: %s
24646 #+LINK: %s
24647 "
24649 org-export-headline-levels
24650 org-export-with-section-numbers
24651 org-export-with-toc
24652 org-export-preserve-breaks
24653 org-export-html-expand
24654 org-export-with-fixed-width
24655 org-export-with-tables
24656 org-export-with-sub-superscripts
24657 org-export-with-special-strings
24658 org-export-with-footnotes
24659 org-export-with-emphasize
24660 org-export-with-TeX-macros
24661 org-export-with-LaTeX-fragments
24662 org-export-skip-text-before-1st-heading
24663 org-export-with-drawers
24664 org-export-with-tags
24666 "TODO FEEDBACK VERIFY DONE"
24667 "Me Jason Marie DONE"
24668 org-highest-priority org-lowest-priority org-default-priority
24687 org-archive-location
24688 "org file:~/org/%s.org"
24689 ))
24692 "Insert into the buffer a template with information for exporting."
24701 "Toggle the fixed-width export.
24702 If there is no active region, the QUOTE keyword at the current headline is
24703 inserted or removed. When present, it causes the text between this headline
24704 and the next to be exported as fixed-width text, and unmodified.
24705 If there is an active region, this command adds or removes a colon as the
24706 first character of this line. If the first character of a line is a colon,
24707 this line is also exported in fixed-width font."
24716 off)
24746 "Export the outline as HTML and immediately open it with a browser.
24747 If there is an active region, export only the region.
24748 The prefix ARG specifies how many levels of the outline should become
24749 headlines. The default is 3. Lower levels will become bulleted lists."
24755 "Call `org-export-as-html', may be used in batch processing as
24756 emacs --batch
24757 --load=$HOME/lib/emacs/org.el
24759 --visit=MyFile --funcall org-export-as-html-batch"
24763 "Call `org-exort-as-html` with output to a temporary buffer.
24764 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24770 "Assume the current region has org-mode syntax, and convert it to HTML.
24771 This can be used in any buffer. For example, you could write an
24772 itemized list in org-mode syntax in an HTML buffer and then use this
24773 command to convert it."
24793 "Convert region from BEG to END in org-mode buffer to HTML.
24794 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24795 contents, and only produce the region of converted text, useful for
24796 cut-and-paste operations.
24797 If BUFFER is a buffer or a string, use/create that buffer as a target
24798 of the converted HTML. If BUFFER is the symbol `string', return the
24799 produced HTML as a string and leave not buffer behind. For example,
24800 a Lisp program could call this function in the following way:
24802 (setq html (org-export-region-as-html beg end t 'string))
24804 When called interactively, the output buffer is selected, and shown
24805 in a window. A non-interactive call will only retunr the buffer."
24810 rtn)
24815 nil nil nil
24816 buffer body-only))
24820 rtn)))
24824 to-buffer body-only)
24825 "Export the outline as a pretty HTML file.
24826 If there is an active region, export only the region. The prefix
24827 ARG specifies how many levels of the outline should become
24828 headlines. The default is 3. Lower levels will become bulleted
24829 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24830 EXT-PLIST is a property list with external parameters overriding
24831 org-mode's default settings, but still inferior to file-local
24832 settings. When TO-BUFFER is non-nil, create a buffer with that
24833 name and export to that buffer. If TO-BUFFER is the symbol `string',
24834 don't leave any buffer behind but just return the resulting HTML as
24835 a string. When BODY-ONLY is set, don't produce the file header and footer,
24836 simply return the content of <body>...</body>, without even
24837 the body tags themselves."
24840 ;; Make sure we have a file name when we need it.
24846 buffer-file-name))
24855 ext-plist
24861 valid thetoc have-headings first-heading-pos
24870 ;; The following two are dynamically scoped into other
24871 ;; routines below.
24890 default-directory))
24924 buffer-file-coding-system))
24926 coding-system))
24928 coding-system))
24940 region
24941 :emph-multiline t
24942 :for-html t
24943 :skip-before-1st-heading
24946 :archived-trees
24948 :add-text
24950 :LaTeX-fragments
24953 table-open type
24954 table-buffer table-orig-buffer
24955 ind start-is-num starter didclose
24956 rpl path desc descp desc1 desc2 link
24957 )
24976 ;; Get the language-dependent settings
24980 ;; Switch to the output buffer
24990 ;; create local variables for all options, to make sure all called
24991 ;; functions get the correct information
24995 org-export-plist-vars)
24997 org-export-headline-levels))
25000 umax))
25002 ;; File header
25008 <head>
25009 <title>%s</title>
25014 %s
25015 </head><body>
25016 "
25029 org-export-html-toplevel-hlevel
25031 org-export-html-toplevel-hlevel)
25032 thetoc)
25037 ;; This is a headline
25046 todo
25050 org-done-keywords)))
25051 ; TODO, not DONE
25055 line lines level))))
25080 ;; Check for targets
25085 t t line))
25088 target-alist))
25099 )))
25100 line)
25101 lines))
25113 ;; end of quote section?
25117 ;; inside a quote section?
25122 ;; verbatim lines
25136 ;; Protected HTML
25151 ;; Horizontal line
25156 ;; make targets to anchors
25164 t t line)))
25168 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25169 t t line)))
25175 t t line)))))
25179 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25180 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25181 ;; Also handle sub_superscripts and checkboxes
25185 ;; Format the links
25195 ;; Make an image out of the description if that is so wanted
25201 ;; FIXME: do we need to unescape here somewhere?
25211 ;; standard URL, just check if we need to inline an image
25219 ;; standard URL
25223 ;; FILE link
25226 thefile file-is-image-p search)
25234 t))
25243 ;; make sure this is can be used as target search
25268 ;; TODO items
25276 org-done-keywords)
25281 ;; Does this contain a reference to a footnote?
25293 t t line))))))
25297 ;; This is a headline
25305 ;; Close any local lists before inserting a new header line
25311 in-local-list nil))
25315 head-count)
25316 ;; QUOTES
25324 ;; New table starts
25326 ;; Accumulate lines
25338 ;; Normal lines
25341 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25342 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25345 line)
25352 ;; empty line. Pretend indentation is large.
25354 0
25370 ;; Start new (level of) list
25377 ;; continue current list
25381 ;; we did close a list, normal text follows: need <p>
25387 "<b>[X]</b>"
25389 t t line))))
25391 ;; Empty lines start a new paragraph. If hand-formatted lists
25392 ;; are not fully interpreted, lines starting with "-", "+", "*"
25393 ;; also start a new paragraph.
25396 ;; Is this the start of a footnote?
25402 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25404 ;; Check if the line break needs to be conserved
25413 ;; Properly close all local lists and other lists
25416 ;; Close any local lists before inserting a new header line
25422 in-local-list nil))
25425 head-count)
25456 ;; insert the table of contents
25473 ;; remove empty paragraphs and lists
25480 ;; Convert whitespace place holders
25501 "Format a table for ascii export."
25505 ;; Table made by table.el - test for spanning
25506 lines
25508 ;; A normal org table
25509 ;; Get rid of hlines at beginning and end
25515 ;; Check if the table has a marking column. If yes remove the
25516 ;; column and the special lines
25518 ;; Get rid of the vertical lines except for grouping
25520 rtn line vl1 start)
25542 vl))
25545 "Find out which HTML converter to use and return the HTML code."
25549 ;; A normal org table
25551 ;; Table made by table.el - test for spanning
25555 nil))
25556 lines)))
25562 hlines))))
25565 ;; We can use my own converter with HTML conversions
25567 ;; Need to use the code generator in table.el, with the original text.
25571 "Format a table into HTML."
25572 ;; Get rid of hlines at beginning and end
25578 ;; Check if the table has a marking column. If yes remove the
25579 ;; column and the special lines
25587 tbopen line fields html gr colgropen)
25599 ;; ignore this line
25601 ;; Break the line into fields
25619 html)))
25624 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25640 html)
25646 "Check if the table has a marking column.
25647 If yes remove the column and the special lines."
25653 lines))
25668 nil)
25670 lines)))
25684 nil)
25689 ;; remove the first column
25691 lines))))
25694 "Format a table generated by table.el into HTML.
25695 This conversion does *not* use `table-generate-source' from table.el.
25696 This has the advantage that Org-mode's HTML conversions can be used.
25697 But it has the disadvantage, that no cell- or row-spanning is allowed."
25700 fields html empty)
25710 html
25712 html
25713 "<tr>"
25726 ;; Ignore this line
25728 ;; Break the line into fields and store the fields
25734 field-buffer))
25737 html))
25740 "Format a table into html, using `table-generate-source' from table.el.
25741 This has the advantage that cell- or row-spanning is allowed.
25742 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25757 "Format time stamps in string S, or remove them."
25762 ;; never export CLOCK
25777 ;; Line break if line started and ended with time stamp stuff
25779 s
25783 r))))
25786 ;; convert & to &, < to < and > to >
25795 s)
25798 "Remove tags and time staps from lines going into the toc."
25807 t t s)))
25808 s)
25811 "Prepare STRING for HTML export. Applies all active conversions.
25812 If there are links in the string, don't modify these."
25815 m s l res)
25826 "Apply all active conversions to translate special ASCII to HTML."
25847 t t s))
25849 s)
25852 "Create a regular expression which will match a balanced sexp.
25853 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25854 as single character strings.
25855 The regexp returned will match the entire expression including the
25856 delimiters. It will also define a single group which contains the
25857 match except for the outermost delimiters. The maximum depth of
25858 stacked delimiters is N. Escaping delimiters is not possible."
25894 "Convert special characters in STRING to HTML."
25896 e a re rpl start)
25903 string))
25906 "Convert sub- and superscripts in STRING to HTML."
25922 t t string)))))
25925 string))
25928 "Apply emphasis."
25935 rpl
25941 org-emphasis-alist))
25946 string))
25950 "Insert <p>, but first close previous paragraph if any."
25955 "Close paragraph if there is one open."
25960 "Close <li> if necessary."
25966 "Insert a new level in HTML export.
25967 When TITLE is nil, just close all open levels."
25977 ;; If title is nil, this means this function is called to close
25978 ;; all levels, so the rest is done only if title is given
25990 t t title)))
26006 level level head-count title level))
26011 "Terminate one level in HTML export."
26017 ;;; iCalendar export
26019 ;;;###autoload
26021 "Export current file as an iCalendar file.
26022 The iCalendar file will be located in the same directory as the Org-mode
26023 file, but with extension `.ics'."
26027 ;;;###autoload
26029 "Export all files in `org-agenda-files' to iCalendar .ics files.
26030 Each iCalendar file will be located in the same directory as the Org-mode
26031 file, but with extension `.ics'."
26035 ;;;###autoload
26037 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26038 The file is stored under the name `org-combined-agenda-icalendar-file'."
26043 "Create iCalendar files for all elements of FILES.
26044 If COMBINE is non-nil, combine all calendar entries into a single large
26045 file and store it under the name `org-combined-agenda-icalendar-file'."
26050 org-export-publishing-directory)))
26051 file ical-file ical-buffer category started org-agenda-new-buffers)
26057 org-combined-agenda-icalendar-file
26090 "Hook run after an iCalendar file has been saved.
26091 The iCalendar buffer is still current when this hook is run.
26092 A good way to use this is to tell a desktop calenndar application to re-read
26096 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26097 When COMBINE is non nil, add the category to each line."
26104 scheduledp deadlinep tmp pri category entry location summary desc
26114 inc t
26121 t org-icalendar-include-body)
26131 pos)
26136 ts)
26139 ;; donep (org-entry-is-done-p)
26140 ))
26159 t t summary)))
26166 %s
26167 %s%s
26168 SUMMARY:%s%s%s
26169 CATEGORIES:%s
26173 rrule summary
26178 category)))))
26183 ;; Get all the literal sexps
26209 )
26216 t org-icalendar-include-body)
26222 t t hd)))
26232 %s
26233 SUMMARY:%s%s%s
26234 CATEGORIES:%s
26235 SEQUENCE:1
26236 PRIORITY:%d
26237 STATUS:%s
26239 dts
26245 category pri status)))))))))
26248 "Take out stuff and quote what needs to be quoted.
26249 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26250 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26251 characters."
26253 nil
26272 s))
26275 "Clean-up description string."
26281 "Start an iCalendar file by inserting the header."
26287 VERSION:2.0
26288 X-WR-CALNAME:%s
26289 PRODID:-//%s//Emacs with Org-mode//EN
26290 X-WR-TIMEZONE:%s
26294 "Finish an iCalendar file by inserting the END statement."
26298 "Take a time string S and convert it to iCalendar format.
26299 KEYWORD is added in front, to make a complete line like DTSTART....
26300 When INC is non-nil, increase the hour by two (if time string contains
26301 a time), or the day by one (if it does not contain a time)."
26303 t2 fmt have-time time)
26319 ;;; XOXO export
26327 "Export the org buffer as XOXO.
26328 The XOXO buffer is named *xoxo-<source buffer name>*"
26330 ;; A quickie abstraction
26332 ;; Output everything as XOXO
26346 ;; Check the output buffer is empty.
26348 ;; Kick off the output
26365 ;; Handle level rendering
26382 )
26386 ;; And output the new li
26392 ;; Finally finish off the ol
26399 ;; Finish the buffer off and clean it up.
26404 )))
26407 ;;;; Key bindings
26409 ;; Make `C-c C-x' a prefix key
26412 ;; TAB key with modifiers
26419 ;; The following line is necessary under Suse GNU/Linux
26425 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26426 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26427 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26429 ;; Cursor keys with modifiers
26430 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26431 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26432 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26433 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26435 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26436 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26437 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26438 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26440 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26441 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26442 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26443 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26445 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26446 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26448 ;;; Extra keys for tty access.
26449 ;; We only set them when really needed because otherwise the
26450 ;; menus don't show the simple keys
26452 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26453 (not window-system))
26454 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26455 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26456 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26457 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26458 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26459 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26460 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26461 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26462 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26463 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26464 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26465 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26466 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26467 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26468 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26469 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26470 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26471 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26472 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26473 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26474 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26475 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26477 ;; All the other keys
26479 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26480 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26481 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26482 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26483 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26484 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26485 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26486 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26487 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26488 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26489 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26490 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26491 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26492 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26493 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26495 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26496 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26497 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26498 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26499 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26500 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26501 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26502 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26503 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26504 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26505 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26506 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26507 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26508 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26509 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26510 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26511 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26513 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26514 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26515 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26516 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26517 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26518 (org-defkey org-mode-map "\C-c^" 'org-sort)
26519 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26520 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26521 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26522 (org-defkey org-mode-map "\C-m" 'org-return)
26523 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26524 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26525 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26526 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26527 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26528 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26529 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26530 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26531 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26532 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26533 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26534 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26535 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26536 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26537 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26538 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26539 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26541 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26542 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26543 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26544 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26546 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26547 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26548 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26549 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26550 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26551 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26552 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26553 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26554 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26555 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26556 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26557 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26559 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26561 (when (featurep 'xemacs)
26562 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26564 (defsubst org-table-p () (org-at-table-p))
26566 (defun org-self-insert-command (N)
26567 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26568 If the cursor is in a table looking at whitespace, the whitespace is
26569 overwritten, and the table is not marked as requiring realignment."
26570 (interactive "p")
26571 (if (and (org-table-p)
26572 (progn
26573 ;; check if we blank the field, and if that triggers align
26574 (and org-table-auto-blank-field
26575 (member last-command
26576 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26578 ;; got extra space, this field does not determine column width
26579 (let (org-table-may-need-update) (org-table-blank-field))
26580 ;; no extra space, this field may determine column width
26581 (org-table-blank-field)))
26582 t)
26583 (eq N 1)
26585 (let (org-table-may-need-update)
26586 (goto-char (1- (match-end 0)))
26587 (delete-backward-char 1)
26588 (goto-char (match-beginning 0))
26589 (self-insert-command N))
26590 (setq org-table-may-need-update t)
26591 (self-insert-command N)
26592 (org-fix-tags-on-the-fly)))
26594 (defun org-fix-tags-on-the-fly ()
26595 (when (and (equal (char-after (point-at-bol)) ?*)
26596 (org-on-heading-p))
26597 (org-align-tags-here org-tags-column)))
26599 (defun org-delete-backward-char (N)
26600 "Like `delete-backward-char', insert whitespace at field end in tables.
26601 When deleting backwards, in tables this function will insert whitespace in
26603 still be marked for re-alignment if the field did fill the entire column,
26604 because, in this case the deletion might narrow the column."
26605 (interactive "p")
26606 (if (and (org-table-p)
26607 (eq N 1)
26608 (string-match "|" (buffer-substring (point-at-bol) (point)))
26609 (looking-at ".*?|"))
26610 (let ((pos (point))
26612 (c org-table-may-need-update))
26613 (backward-delete-char N)
26614 (skip-chars-forward "^|")
26615 (insert " ")
26616 (goto-char (1- pos))
26617 ;; noalign: if there were two spaces at the end, this field
26618 ;; does not determine the width of the column.
26619 (if noalign (setq org-table-may-need-update c)))
26620 (backward-delete-char N)
26621 (org-fix-tags-on-the-fly)))
26623 (defun org-delete-char (N)
26624 "Like `delete-char', but insert whitespace at field end in tables.
26625 When deleting characters, in tables this function will insert whitespace in
26627 still be marked for re-alignment if the field did fill the entire column,
26628 because, in this case the deletion might narrow the column."
26629 (interactive "p")
26630 (if (and (org-table-p)
26631 (not (bolp))
26632 (not (= (char-after) ?|))
26633 (eq N 1))
26634 (if (looking-at ".*?|")
26635 (let ((pos (point))
26637 (c org-table-may-need-update))
26638 (replace-match (concat
26639 (substring (match-string 0) 1 -1)
26640 " |"))
26641 (goto-char pos)
26642 ;; noalign: if there were two spaces at the end, this field
26643 ;; does not determine the width of the column.
26644 (if noalign (setq org-table-may-need-update c)))
26645 (delete-char N))
26646 (delete-char N)
26647 (org-fix-tags-on-the-fly)))
26649 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26650 (put 'org-self-insert-command 'delete-selection t)
26651 (put 'orgtbl-self-insert-command 'delete-selection t)
26652 (put 'org-delete-char 'delete-selection 'supersede)
26653 (put 'org-delete-backward-char 'delete-selection 'supersede)
26655 ;; Make `flyspell-mode' delay after some commands
26656 (put 'org-self-insert-command 'flyspell-delayed t)
26657 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26658 (put 'org-delete-char 'flyspell-delayed t)
26659 (put 'org-delete-backward-char 'flyspell-delayed t)
26661 ;; Make pabbrev-mode expand after org-mode commands
26662 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26663 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26665 ;; How to do this: Measure non-white length of current string
26666 ;; If equal to column width, we should realign.
26668 (defun org-remap (map &rest commands)
26669 "In MAP, remap the functions given in COMMANDS.
26670 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26671 (let (new old)
26672 (while commands
26673 (setq old (pop commands) new (pop commands))
26674 (if (fboundp 'command-remapping)
26675 (org-defkey map (vector 'remap old) new)
26676 (substitute-key-definition old new map global-map)))))
26678 (when (eq org-enable-table-editor 'optimized)
26679 ;; If the user wants maximum table support, we need to hijack
26680 ;; some standard editing functions
26681 (org-remap org-mode-map
26682 'self-insert-command 'org-self-insert-command
26683 'delete-char 'org-delete-char
26684 'delete-backward-char 'org-delete-backward-char)
26685 (org-defkey org-mode-map "|" 'org-force-self-insert))
26687 (defun org-shiftcursor-error ()
26688 "Throw an error because Shift-Cursor command was applied in wrong context."
26689 (error "This command is active in special context like tables, headlines or timestamps"))
26691 (defun org-shifttab (&optional arg)
26692 "Global visibility cycling or move to previous table field.
26693 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26694 on context.
26695 See the individual commands for more information."
26696 (interactive "P")
26697 (cond
26698 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26699 (arg (message "Content view to level: ")
26700 (org-content (prefix-numeric-value arg))
26701 (setq org-cycle-global-status 'overview))
26702 (t (call-interactively 'org-global-cycle))))
26704 (defun org-shiftmetaleft ()
26705 "Promote subtree or delete table column.
26706 Calls `org-promote-subtree', `org-outdent-item',
26707 or `org-table-delete-column', depending on context.
26708 See the individual commands for more information."
26709 (interactive)
26710 (cond
26711 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26712 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26713 ((org-at-item-p) (call-interactively 'org-outdent-item))
26714 (t (org-shiftcursor-error))))
26716 (defun org-shiftmetaright ()
26717 "Demote subtree or insert table column.
26718 Calls `org-demote-subtree', `org-indent-item',
26719 or `org-table-insert-column', depending on context.
26720 See the individual commands for more information."
26721 (interactive)
26722 (cond
26723 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26724 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26725 ((org-at-item-p) (call-interactively 'org-indent-item))
26726 (t (org-shiftcursor-error))))
26728 (defun org-shiftmetaup (&optional arg)
26729 "Move subtree up or kill table row.
26730 Calls `org-move-subtree-up' or `org-table-kill-row' or
26731 `org-move-item-up' depending on context. See the individual commands
26732 for more information."
26733 (interactive "P")
26734 (cond
26735 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26736 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26737 ((org-at-item-p) (call-interactively 'org-move-item-up))
26738 (t (org-shiftcursor-error))))
26739 (defun org-shiftmetadown (&optional arg)
26740 "Move subtree down or insert table row.
26741 Calls `org-move-subtree-down' or `org-table-insert-row' or
26742 `org-move-item-down', depending on context. See the individual
26743 commands for more information."
26744 (interactive "P")
26745 (cond
26746 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26747 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26748 ((org-at-item-p) (call-interactively 'org-move-item-down))
26749 (t (org-shiftcursor-error))))
26751 (defun org-metaleft (&optional arg)
26752 "Promote heading or move table column to left.
26753 Calls `org-do-promote' or `org-table-move-column', depending on context.
26754 With no specific context, calls the Emacs default `backward-word'.
26755 See the individual commands for more information."
26756 (interactive "P")
26757 (cond
26758 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26759 ((or (org-on-heading-p) (org-region-active-p))
26760 (call-interactively 'org-do-promote))
26761 ((org-at-item-p) (call-interactively 'org-outdent-item))
26762 (t (call-interactively 'backward-word))))
26764 (defun org-metaright (&optional arg)
26765 "Demote subtree or move table column to right.
26766 Calls `org-do-demote' or `org-table-move-column', depending on context.
26767 With no specific context, calls the Emacs default `forward-word'.
26768 See the individual commands for more information."
26769 (interactive "P")
26770 (cond
26771 ((org-at-table-p) (call-interactively 'org-table-move-column))
26772 ((or (org-on-heading-p) (org-region-active-p))
26773 (call-interactively 'org-do-demote))
26774 ((org-at-item-p) (call-interactively 'org-indent-item))
26775 (t (call-interactively 'forward-word))))
26777 (defun org-metaup (&optional arg)
26778 "Move subtree up or move table row up.
26779 Calls `org-move-subtree-up' or `org-table-move-row' or
26780 `org-move-item-up', depending on context. See the individual commands
26781 for more information."
26782 (interactive "P")
26783 (cond
26784 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26785 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26786 ((org-at-item-p) (call-interactively 'org-move-item-up))
26787 (t (transpose-lines 1) (beginning-of-line -1))))
26789 (defun org-metadown (&optional arg)
26790 "Move subtree down or move table row down.
26791 Calls `org-move-subtree-down' or `org-table-move-row' or
26792 `org-move-item-down', depending on context. See the individual
26793 commands for more information."
26794 (interactive "P")
26795 (cond
26796 ((org-at-table-p) (call-interactively 'org-table-move-row))
26797 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26798 ((org-at-item-p) (call-interactively 'org-move-item-down))
26799 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26801 (defun org-shiftup (&optional arg)
26802 "Increase item in timestamp or increase priority of current headline.
26803 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26804 depending on context. See the individual commands for more information."
26805 (interactive "P")
26806 (cond
26807 ((org-at-timestamp-p t)
26808 (call-interactively (if org-edit-timestamp-down-means-later
26809 'org-timestamp-down 'org-timestamp-up)))
26810 ((org-on-heading-p) (call-interactively 'org-priority-up))
26811 ((org-at-item-p) (call-interactively 'org-previous-item))
26812 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26814 (defun org-shiftdown (&optional arg)
26815 "Decrease item in timestamp or decrease priority of current headline.
26816 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26817 depending on context. See the individual commands for more information."
26818 (interactive "P")
26819 (cond
26820 ((org-at-timestamp-p t)
26821 (call-interactively (if org-edit-timestamp-down-means-later
26822 'org-timestamp-up 'org-timestamp-down)))
26823 ((org-on-heading-p) (call-interactively 'org-priority-down))
26824 (t (call-interactively 'org-next-item))))
26826 (defun org-shiftright ()
26827 "Next TODO keyword or timestamp one day later, depending on context."
26828 (interactive)
26829 (cond
26830 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26831 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26832 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26833 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26834 (t (org-shiftcursor-error))))
26836 (defun org-shiftleft ()
26837 "Previous TODO keyword or timestamp one day earlier, depending on context."
26838 (interactive)
26839 (cond
26840 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26841 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26842 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26843 ((org-at-property-p)
26844 (call-interactively 'org-property-previous-allowed-value))
26845 (t (org-shiftcursor-error))))
26847 (defun org-shiftcontrolright ()
26848 "Switch to next TODO set."
26849 (interactive)
26850 (cond
26851 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26852 (t (org-shiftcursor-error))))
26854 (defun org-shiftcontrolleft ()
26855 "Switch to previous TODO set."
26856 (interactive)
26857 (cond
26858 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26859 (t (org-shiftcursor-error))))
26861 (defun org-ctrl-c-ret ()
26862 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26863 (interactive)
26864 (cond
26865 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26866 (t (call-interactively 'org-insert-heading))))
26868 (defun org-copy-special ()
26869 "Copy region in table or copy current subtree.
26870 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26871 See the individual commands for more information."
26872 (interactive)
26873 (call-interactively
26874 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26876 (defun org-cut-special ()
26877 "Cut region in table or cut current subtree.
26878 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26879 See the individual commands for more information."
26880 (interactive)
26881 (call-interactively
26882 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26884 (defun org-paste-special (arg)
26885 "Paste rectangular region into table, or past subtree relative to level.
26886 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26887 See the individual commands for more information."
26888 (interactive "P")
26889 (if (org-at-table-p)
26890 (org-table-paste-rectangle)
26891 (org-paste-subtree arg)))
26893 (defun org-ctrl-c-ctrl-c (&optional arg)
26894 "Set tags in headline, or update according to changed information at point.
26896 This command does many different things, depending on context:
26898 - If the cursor is in a headline, prompt for tags and insert them
26899 into the current line, aligned to `org-tags-column'. When called
26900 with prefix arg, realign all tags in the current buffer.
26902 - If the cursor is in one of the special #+KEYWORD lines, this
26903 triggers scanning the buffer for these lines and updating the
26904 information.
26906 - If the cursor is inside a table, realign the table. This command
26907 works even if the automatic table editor has been turned off.
26909 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26910 the entire table.
26912 - If the cursor is a the beginning of a dynamic block, update it.
26914 - If the cursor is inside a table created by the table.el package,
26915 activate that table.
26917 - If the current buffer is a remember buffer, close note and file it.
26918 with a prefix argument, file it without further interaction to the default
26919 location.
26921 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26922 links in this buffer.
26924 - If the cursor is on a numbered item in a plain list, renumber the
26925 ordered list.
26927 - If the cursor is on a checkbox, toggle it."
26928 (interactive "P")
26929 (let ((org-enable-table-editor t))
26930 (cond
26931 ((or org-clock-overlays
26932 org-occur-highlights
26933 org-latex-fragment-image-overlays)
26934 (org-remove-clock-overlays)
26935 (org-remove-occur-highlights)
26936 (org-remove-latex-fragment-image-overlays)
26937 (message "Temporary highlights/overlays removed from current buffer"))
26938 ((and (local-variable-p 'org-finish-function (current-buffer))
26939 (fboundp org-finish-function))
26940 (funcall org-finish-function))
26941 ((org-at-property-p)
26942 (call-interactively 'org-property-action))
26943 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
26944 ((org-on-heading-p) (call-interactively 'org-set-tags))
26945 ((org-at-table.el-p)
26946 (require 'table)
26947 (beginning-of-line 1)
26948 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
26949 (call-interactively 'table-recognize-table))
26950 ((org-at-table-p)
26951 (org-table-maybe-eval-formula)
26952 (if arg
26953 (call-interactively 'org-table-recalculate)
26954 (org-table-maybe-recalculate-line))
26955 (call-interactively 'org-table-align))
26956 ((org-at-item-checkbox-p)
26957 (call-interactively 'org-toggle-checkbox))
26958 ((org-at-item-p)
26959 (call-interactively 'org-maybe-renumber-ordered-list))
26961 ;; Dynamic block
26962 (beginning-of-line 1)
26963 (org-update-dblock))
26965 (cond
26966 ((equal (match-string 1) "TBLFM")
26967 ;; Recalculate the table before this line
26968 (save-excursion
26969 (beginning-of-line 1)
26971 (if (org-at-table-p)
26972 (org-call-with-arg 'org-table-recalculate t))))
26973 (t
26974 (call-interactively 'org-mode-restart))))
26975 (t (error "C-c C-c can do nothing useful at this location.")))))
26977 (defun org-mode-restart ()
26978 "Restart Org-mode, to scan again for special lines.
26979 Also updates the keyword regular expressions."
26980 (interactive)
26981 (let ((org-inhibit-startup t)) (org-mode))
26982 (message "Org-mode restarted to refresh keyword and special line setup"))
26984 (defun org-kill-note-or-show-branches ()
26985 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
26986 (interactive)
26987 (if (not org-finish-function)
26988 (call-interactively 'show-branches)
26989 (let ((org-note-abort t))
26990 (funcall org-finish-function))))
26992 (defun org-return (&optional indent)
26993 "Goto next table row or insert a newline.
26994 Calls `org-table-next-row' or `newline', depending on context.
26995 See the individual commands for more information."
26996 (interactive)
26997 (cond
26998 ((bobp) (if indent (newline-and-indent) (newline)))
26999 ((and (org-at-heading-p)
27000 (looking-at
27002 (org-show-entry)
27003 (end-of-line 1)
27004 (newline))
27005 ((org-at-table-p)
27006 (org-table-justify-field-maybe)
27007 (call-interactively 'org-table-next-row))
27008 (t (if indent (newline-and-indent) (newline)))))
27010 (defun org-return-indent ()
27011 (interactive)
27012 "Goto next table row or insert a newline and indent.
27013 Calls `org-table-next-row' or `newline-and-indent', depending on
27014 context. See the individual commands for more information."
27015 (org-return t))
27017 (defun org-ctrl-c-minus ()
27018 "Insert separator line in table or modify bullet type in list.
27019 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
27020 depending on context."
27021 (interactive)
27022 (cond
27023 ((org-at-table-p)
27024 (call-interactively 'org-table-insert-hline))
27025 ((org-on-heading-p)
27026 ;; Convert to item
27027 (save-excursion
27028 (beginning-of-line 1)
27030 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27031 ((org-in-item-p)
27032 (call-interactively 'org-cycle-list-bullet))
27033 (t (error "`C-c -' does have no function here."))))
27035 (defun org-meta-return (&optional arg)
27036 "Insert a new heading or wrap a region in a table.
27037 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27038 See the individual commands for more information."
27039 (interactive "P")
27040 (cond
27041 ((org-at-table-p)
27042 (call-interactively 'org-table-wrap-region))
27043 (t (call-interactively 'org-insert-heading))))
27045 ;;; Menu entries
27047 ;; Define the Org-mode menus
27048 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27049 '("Tbl"
27050 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27051 ["Next Field" org-cycle (org-at-table-p)]
27052 ["Previous Field" org-shifttab (org-at-table-p)]
27053 ["Next Row" org-return (org-at-table-p)]
27054 "--"
27055 ["Blank Field" org-table-blank-field (org-at-table-p)]
27056 ["Edit Field" org-table-edit-field (org-at-table-p)]
27057 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27058 "--"
27059 ("Column"
27060 ["Move Column Left" org-metaleft (org-at-table-p)]
27061 ["Move Column Right" org-metaright (org-at-table-p)]
27062 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27063 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27064 ("Row"
27065 ["Move Row Up" org-metaup (org-at-table-p)]
27066 ["Move Row Down" org-metadown (org-at-table-p)]
27067 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27068 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27069 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27070 "--"
27071 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27072 ("Rectangle"
27073 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27074 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27075 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27076 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27077 "--"
27078 ("Calculate"
27079 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27080 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27081 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27082 "--"
27083 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27084 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27085 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27086 "--"
27087 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27088 "--"
27089 ["Sum Column/Rectangle" org-table-sum
27090 (or (org-at-table-p) (org-region-active-p))]
27091 ["Which Column?" org-table-current-column (org-at-table-p)])
27092 ["Debug Formulas"
27093 org-table-toggle-formula-debugger
27094 :style toggle :selected org-table-formula-debug]
27095 ["Show Col/Row Numbers"
27096 org-table-toggle-coordinate-overlays
27097 :style toggle :selected org-table-overlay-coordinates]
27098 "--"
27099 ["Create" org-table-create (and (not (org-at-table-p))
27100 org-enable-table-editor)]
27101 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27102 ["Import from File" org-table-import (not (org-at-table-p))]
27103 ["Export to File" org-table-export (org-at-table-p)]
27104 "--"
27105 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27107 (easy-menu-define org-org-menu org-mode-map "Org menu"
27108 '("Org"
27109 ("Show/Hide"
27110 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27111 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27112 ["Sparse Tree" org-occur t]
27113 ["Reveal Context" org-reveal t]
27114 ["Show All" show-all t]
27115 "--"
27116 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27117 "--"
27118 ["New Heading" org-insert-heading t]
27119 ("Navigate Headings"
27120 ["Up" outline-up-heading t]
27121 ["Next" outline-next-visible-heading t]
27122 ["Previous" outline-previous-visible-heading t]
27123 ["Next Same Level" outline-forward-same-level t]
27124 ["Previous Same Level" outline-backward-same-level t]
27125 "--"
27126 ["Jump" org-goto t])
27127 ("Edit Structure"
27128 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27129 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27130 "--"
27131 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27132 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27133 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27134 "--"
27135 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27136 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27137 ["Demote Heading" org-metaright (not (org-at-table-p))]
27138 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27139 "--"
27140 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27141 "--"
27142 ["Convert to odd levels" org-convert-to-odd-levels t]
27143 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27144 ("Editing"
27145 ["Emphasis..." org-emphasize t])
27146 ("Archive"
27147 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27148 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27149 ; :active t :keys "C-u C-c C-x C-a"]
27150 ["Sparse trees open ARCHIVE trees"
27151 (setq org-sparse-tree-open-archived-trees
27152 (not org-sparse-tree-open-archived-trees))
27153 :style toggle :selected org-sparse-tree-open-archived-trees]
27154 ["Cycling opens ARCHIVE trees"
27155 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27156 :style toggle :selected org-cycle-open-archived-trees]
27157 ["Agenda includes ARCHIVE trees"
27158 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27159 :style toggle :selected (not org-agenda-skip-archived-trees)]
27160 "--"
27161 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27162 ; ["Check and Move Children" (org-archive-subtree '(4))
27163 ; :active t :keys "C-u C-c C-x C-s"]
27164 )
27165 "--"
27166 ("TODO Lists"
27167 ["TODO/DONE/-" org-todo t]
27168 ("Select keyword"
27169 ["Next keyword" org-shiftright (org-on-heading-p)]
27170 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27171 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27172 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27173 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27174 ["Show TODO Tree" org-show-todo-tree t]
27175 ["Global TODO list" org-todo-list t]
27176 "--"
27177 ["Set Priority" org-priority t]
27178 ["Priority Up" org-shiftup t]
27179 ["Priority Down" org-shiftdown t])
27180 ("TAGS and Properties"
27181 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27182 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27183 "--"
27184 ["Set property" 'org-set-property t]
27185 ["Column view of properties" org-columns t]
27186 ["Insert Column View DBlock" org-insert-columns-dblock t])
27187 ("Dates and Scheduling"
27188 ["Timestamp" org-time-stamp t]
27189 ["Timestamp (inactive)" org-time-stamp-inactive t]
27190 ("Change Date"
27191 ["1 Day Later" org-shiftright t]
27192 ["1 Day Earlier" org-shiftleft t]
27193 ["1 ... Later" org-shiftup t]
27194 ["1 ... Earlier" org-shiftdown t])
27195 ["Compute Time Range" org-evaluate-time-range t]
27196 ["Schedule Item" org-schedule t]
27197 ["Deadline" org-deadline t]
27198 "--"
27199 ["Custom time format" org-toggle-time-stamp-overlays
27200 :style radio :selected org-display-custom-times]
27201 "--"
27202 ["Goto Calendar" org-goto-calendar t]
27203 ["Date from Calendar" org-date-from-calendar t])
27204 ("Logging work"
27205 ["Clock in" org-clock-in t]
27206 ["Clock out" org-clock-out t]
27207 ["Clock cancel" org-clock-cancel t]
27208 ["Goto running clock" org-clock-goto t]
27209 ["Display times" org-clock-display t]
27210 ["Create clock table" org-clock-report t]
27211 "--"
27212 ["Record DONE time"
27213 (progn (setq org-log-done (not org-log-done))
27214 (message "Switching to %s will %s record a timestamp"
27215 (car org-done-keywords)
27216 (if org-log-done "automatically" "not")))
27217 :style toggle :selected org-log-done])
27218 "--"
27219 ["Agenda Command..." org-agenda t]
27220 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27221 ("File List for Agenda")
27222 ("Special views current file"
27223 ["TODO Tree" org-show-todo-tree t]
27224 ["Check Deadlines" org-check-deadlines t]
27225 ["Timeline" org-timeline t]
27226 ["Tags Tree" org-tags-sparse-tree t])
27227 "--"
27228 ("Hyperlinks"
27229 ["Store Link (Global)" org-store-link t]
27230 ["Insert Link" org-insert-link t]
27231 ["Follow Link" org-open-at-point t]
27232 "--"
27233 ["Next link" org-next-link t]
27234 ["Previous link" org-previous-link t]
27235 "--"
27236 ["Descriptive Links"
27237 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27238 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27239 ["Literal Links"
27240 (progn
27241 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27242 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27243 "--"
27244 ["Export/Publish..." org-export t]
27245 ("LaTeX"
27246 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27247 :selected org-cdlatex-mode]
27248 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27249 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27250 ["Modify math symbol" org-cdlatex-math-modify
27251 (org-inside-LaTeX-fragment-p)]
27252 ["Export LaTeX fragments as images"
27253 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27254 :style toggle :selected org-export-with-LaTeX-fragments])
27255 "--"
27256 ("Documentation"
27257 ["Show Version" org-version t]
27258 ["Info Documentation" org-info t])
27259 ("Customize"
27260 ["Browse Org Group" org-customize t]
27261 "--"
27262 ["Expand This Menu" org-create-customize-menu
27263 (fboundp 'customize-menu-create)])
27264 "--"
27265 ["Refresh setup" org-mode-restart t]
27266 ))
27268 (defun org-info (&optional node)
27269 "Read documentation for Org-mode in the info system.
27270 With optional NODE, go directly to that node."
27271 (interactive)
27272 (require 'info)
27273 (Info-goto-node (format "(org)%s" (or node ""))))
27275 (defun org-install-agenda-files-menu ()
27276 (let ((bl (buffer-list)))
27277 (save-excursion
27278 (while bl
27279 (set-buffer (pop bl))
27280 (if (org-mode-p) (setq bl nil)))
27281 (when (org-mode-p)
27282 (easy-menu-change
27283 '("Org") "File List for Agenda"
27284 (append
27285 (list
27286 ["Edit File List" (org-edit-agenda-file-list) t]
27287 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27288 ["Remove Current File from List" org-remove-file t]
27289 ["Cycle through agenda files" org-cycle-agenda-files t]
27290 ["Occur in all agenda files" org-occur-in-agenda-files t]
27291 "--")
27292 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27294 ;;;; Documentation
27296 (defun org-customize ()
27297 "Call the customize function with org as argument."
27298 (interactive)
27299 (customize-browse 'org))
27301 (defun org-create-customize-menu ()
27302 "Create a full customization menu for Org-mode, insert it into the menu."
27303 (interactive)
27304 (if (fboundp 'customize-menu-create)
27305 (progn
27306 (easy-menu-change
27307 '("Org") "Customize"
27308 `(["Browse Org group" org-customize t]
27309 "--"
27310 ,(customize-menu-create 'org)
27311 ["Set" Custom-set t]
27312 ["Save" Custom-save t]
27313 ["Reset to Current" Custom-reset-current t]
27314 ["Reset to Saved" Custom-reset-saved t]
27315 ["Reset to Standard Settings" Custom-reset-standard t]))
27317 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27319 ;;;; Miscellaneous stuff
27322 ;;; Generally useful functions
27324 (defun org-context ()
27325 "Return a list of contexts of the current cursor position.
27326 If several contexts apply, all are returned.
27327 Each context entry is a list with a symbol naming the context, and
27328 two positions indicating start and end of the context. Possible
27329 contexts are:
27331 :headline anywhere in a headline
27332 :headline-stars on the leading stars in a headline
27333 :todo-keyword on a TODO keyword (including DONE) in a headline
27334 :tags on the TAGS in a headline
27335 :priority on the priority cookie in a headline
27336 :item on the first line of a plain list item
27337 :item-bullet on the bullet/number of a plain list item
27338 :checkbox on the checkbox in a plain list item
27339 :table in an org-mode table
27340 :table-special on a special filed in a table
27341 :table-table in a table.el table
27342 :link on a hyperlink
27343 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27344 :target on a <<target>>
27345 :radio-target on a <<<radio-target>>>
27346 :latex-fragment on a LaTeX fragment
27347 :latex-preview on a LaTeX fragment with overlayed preview image
27349 This function expects the position to be visible because it uses font-lock
27350 faces as a help to recognize the following contexts: :table-special, :link,
27351 and :keyword."
27352 (let* ((f (get-text-property (point) 'face))
27353 (faces (if (listp f) f (list f)))
27354 (p (point)) clist o)
27355 ;; First the large context
27356 (cond
27357 ((org-on-heading-p t)
27358 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27359 (when (progn
27360 (beginning-of-line 1)
27361 (looking-at org-todo-line-tags-regexp))
27362 (push (org-point-in-group p 1 :headline-stars) clist)
27363 (push (org-point-in-group p 2 :todo-keyword) clist)
27364 (push (org-point-in-group p 4 :tags) clist))
27365 (goto-char p)
27368 (push (org-point-in-group p 0 :priority) clist)))
27370 ((org-at-item-p)
27371 (push (org-point-in-group p 2 :item-bullet) clist)
27372 (push (list :item (point-at-bol)
27373 (save-excursion (org-end-of-item) (point)))
27374 clist)
27375 (and (org-at-item-checkbox-p)
27376 (push (org-point-in-group p 0 :checkbox) clist)))
27378 ((org-at-table-p)
27379 (push (list :table (org-table-begin) (org-table-end)) clist)
27380 (if (memq 'org-formula faces)
27381 (push (list :table-special
27382 (previous-single-property-change p 'face)
27383 (next-single-property-change p 'face)) clist)))
27384 ((org-at-table-p 'any)
27385 (push (list :table-table) clist)))
27386 (goto-char p)
27388 ;; Now the small context
27389 (cond
27390 ((org-at-timestamp-p)
27391 (push (org-point-in-group p 0 :timestamp) clist))
27392 ((memq 'org-link faces)
27393 (push (list :link
27394 (previous-single-property-change p 'face)
27395 (next-single-property-change p 'face)) clist))
27396 ((memq 'org-special-keyword faces)
27397 (push (list :keyword
27398 (previous-single-property-change p 'face)
27399 (next-single-property-change p 'face)) clist))
27400 ((org-on-target-p)
27401 (push (org-point-in-group p 0 :target) clist)
27402 (goto-char (1- (match-beginning 0)))
27403 (if (looking-at org-radio-target-regexp)
27404 (push (org-point-in-group p 0 :radio-target) clist))
27405 (goto-char p))
27406 ((setq o (car (delq nil
27407 (mapcar
27408 (lambda (x)
27409 (if (memq x org-latex-fragment-image-overlays) x))
27410 (org-overlays-at (point))))))
27411 (push (list :latex-fragment
27412 (org-overlay-start o) (org-overlay-end o)) clist)
27413 (push (list :latex-preview
27414 (org-overlay-start o) (org-overlay-end o)) clist))
27415 ((org-inside-LaTeX-fragment-p)
27416 ;; FIXME: positions wrong.
27417 (push (list :latex-fragment (point) (point)) clist)))
27419 (setq clist (nreverse (delq nil clist)))
27420 clist))
27422 ;; FIXME: Compare with at-regexp-p Do we need both?
27423 (defun org-in-regexp (re &optional nlines visually)
27424 "Check if point is inside a match of regexp.
27425 Normally only the current line is checked, but you can include NLINES extra
27426 lines both before and after point into the search.
27427 If VISUALLY is set, require that the cursor is not after the match but
27428 really on, so that the block visually is on the match."
27429 (catch 'exit
27430 (let ((pos (point))
27431 (eol (point-at-eol (+ 1 (or nlines 0))))
27432 (inc (if visually 1 0)))
27433 (save-excursion
27434 (beginning-of-line (- 1 (or nlines 0)))
27435 (while (re-search-forward re eol t)
27436 (if (and (<= (match-beginning 0) pos)
27437 (>= (+ inc (match-end 0)) pos))
27438 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27440 (defun org-at-regexp-p (regexp)
27441 "Is point inside a match of REGEXP in the current line?"
27442 (catch 'exit
27443 (save-excursion
27444 (let ((pos (point)) (end (point-at-eol)))
27445 (beginning-of-line 1)
27446 (while (re-search-forward regexp end t)
27447 (if (and (<= (match-beginning 0) pos)
27448 (>= (match-end 0) pos))
27449 (throw 'exit t)))
27450 nil))))
27452 (defun org-occur-in-agenda-files (regexp &optional nlines)
27453 "Call `multi-occur' with buffers for all agenda files."
27455 (let* ((files (org-agenda-files))
27456 (tnames (mapcar 'file-truename files))
27457 (extra org-agenda-multi-occur-extra-files)
27458 f)
27459 (while (setq f (pop extra))
27460 (unless (member (file-truename f) tnames)
27461 (add-to-list 'files f 'append)
27462 (add-to-list 'tnames (file-truename f) 'append)))
27463 (multi-occur
27464 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27465 regexp)))
27467 (if (boundp 'occur-mode-find-occurrence-hook)
27468 ;; Emacs 23
27469 (add-hook 'occur-mode-find-occurrence-hook
27470 (lambda ()
27471 (when (org-mode-p)
27472 (org-reveal))))
27473 ;; Emacs 22
27474 (defadvice occur-mode-goto-occurrence
27475 (after org-occur-reveal activate)
27476 (and (org-mode-p) (org-reveal)))
27477 (defadvice occur-mode-goto-occurrence-other-window
27478 (after org-occur-reveal activate)
27479 (and (org-mode-p) (org-reveal)))
27480 (defadvice occur-mode-display-occurrence
27481 (after org-occur-reveal activate)
27482 (when (org-mode-p)
27483 (let ((pos (occur-mode-find-occurrence)))
27484 (with-current-buffer (marker-buffer pos)
27485 (save-excursion
27486 (goto-char pos)
27487 (org-reveal)))))))
27489 (defun org-uniquify (list)
27490 "Remove duplicate elements from LIST."
27491 (let (res)
27492 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27493 res))
27495 (defun org-delete-all (elts list)
27496 "Remove all elements in ELTS from LIST."
27497 (while elts
27498 (setq list (delete (pop elts) list)))
27499 list)
27501 (defun org-back-over-empty-lines ()
27502 "Move backwards over witespace, to the beginning of the first empty line.
27503 Returns the number o empty lines passed."
27504 (let ((pos (point)))
27506 (beginning-of-line 2)
27507 (goto-char (min (point) pos))
27508 (count-lines (point) pos)))
27510 (defun org-skip-whitespace ()
27513 (defun org-point-in-group (point group &optional context)
27514 "Check if POINT is in match-group GROUP.
27515 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27516 match. If the match group does ot exist or point is not inside it,
27517 return nil."
27518 (and (match-beginning group)
27519 (>= point (match-beginning group))
27520 (<= point (match-end group))
27521 (if context
27522 (list context (match-beginning group) (match-end group))
27523 t)))
27525 (defun org-switch-to-buffer-other-window (&rest args)
27526 "Switch to buffer in a second window on the current frame.
27527 In particular, do not allow pop-up frames."
27528 (let (pop-up-frames special-display-buffer-names special-display-regexps
27529 special-display-function)
27530 (apply 'switch-to-buffer-other-window args)))
27532 (defun org-combine-plists (&rest plists)
27533 "Create a single property list from all plists in PLISTS.
27534 The process starts by copying the first list, and then setting properties
27535 from the other lists. Settings in the last list are the most significant
27536 ones and overrule settings in the other lists."
27537 (let ((rtn (copy-sequence (pop plists)))
27538 p v ls)
27539 (while plists
27540 (setq ls (pop plists))
27541 (while ls
27542 (setq p (pop ls) v (pop ls))
27543 (setq rtn (plist-put rtn p v))))
27544 rtn))
27546 (defun org-move-line-down (arg)
27547 "Move the current line down. With prefix argument, move it past ARG lines."
27548 (interactive "p")
27549 (let ((col (current-column))
27550 beg end pos)
27551 (beginning-of-line 1) (setq beg (point))
27552 (beginning-of-line 2) (setq end (point))
27553 (beginning-of-line (+ 1 arg))
27554 (setq pos (move-marker (make-marker) (point)))
27555 (insert (delete-and-extract-region beg end))
27556 (goto-char pos)
27557 (move-to-column col)))
27559 (defun org-move-line-up (arg)
27560 "Move the current line up. With prefix argument, move it past ARG lines."
27561 (interactive "p")
27562 (let ((col (current-column))
27563 beg end pos)
27564 (beginning-of-line 1) (setq beg (point))
27565 (beginning-of-line 2) (setq end (point))
27566 (beginning-of-line (- arg))
27567 (setq pos (move-marker (make-marker) (point)))
27568 (insert (delete-and-extract-region beg end))
27569 (goto-char pos)
27570 (move-to-column col)))
27572 (defun org-replace-escapes (string table)
27573 "Replace %-escapes in STRING with values in TABLE.
27575 The sequences in STRING may contain normal field width and padding information,
27577 so values can contain further %-escapes if they are define later in TABLE."
27578 (let ((case-fold-search nil)
27579 e re rpl)
27580 (while (setq e (pop table))
27581 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27582 (while (string-match re string)
27583 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27584 (cdr e)))
27585 (setq string (replace-match rpl t t string))))
27586 string))
27589 (defun org-sublist (list start end)
27590 "Return a section of LIST, from START to END.
27591 Counting starts at 1."
27592 (let (rtn (c start))
27593 (setq list (nthcdr (1- start) list))
27594 (while (and list (<= c end))
27595 (push (pop list) rtn)
27596 (setq c (1+ c)))
27597 (nreverse rtn)))
27599 (defun org-find-base-buffer-visiting (file)
27600 "Like `find-buffer-visiting' but alway return the base buffer and
27601 not an indirect buffer"
27602 (let ((buf (find-buffer-visiting file)))
27603 (if buf
27604 (or (buffer-base-buffer buf) buf)
27605 nil)))
27607 (defun org-image-file-name-regexp ()
27608 "Return regexp matching the file names of images."
27609 (if (fboundp 'image-file-name-regexp)
27610 (image-file-name-regexp)
27611 (let ((image-file-name-extensions
27612 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27613 "xbm" "xpm" "pbm" "pgm" "ppm")))
27615 (regexp-opt (nconc (mapcar 'upcase
27616 image-file-name-extensions)
27617 image-file-name-extensions)
27618 t)
27621 (defun org-file-image-p (file)
27622 "Return non-nil if FILE is an image."
27623 (save-match-data
27624 (string-match (org-image-file-name-regexp) file)))
27626 ;;; Paragraph filling stuff.
27627 ;; We want this to be just right, so use the full arsenal.
27629 (defun org-indent-line-function ()
27630 "Indent line like previous, but further if previous was headline or item."
27631 (interactive)
27632 (let* ((pos (point))
27633 (itemp (org-at-item-p))
27634 column bpos bcol tpos tcol bullet btype bullet-type)
27635 ;; Find the previous relevant line
27636 (beginning-of-line 1)
27637 (cond
27638 ((looking-at "#") (setq column 0))
27640 (t
27641 (beginning-of-line 0)
27643 (beginning-of-line 0))
27644 (cond
27646 (goto-char (match-end 0))
27647 (setq column (current-column)))
27648 ((org-in-item-p)
27649 (org-beginning-of-item)
27652 (setq bpos (match-beginning 1) tpos (match-end 0)
27653 bcol (progn (goto-char bpos) (current-column))
27654 tcol (progn (goto-char tpos) (current-column))
27655 bullet (match-string 1)
27656 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27657 (if (not itemp)
27658 (setq column tcol)
27659 (goto-char pos)
27660 (beginning-of-line 1)
27662 (progn
27664 (setq bullet (match-string 1)
27665 btype (if (string-match "[0-9]" bullet) "n" bullet))
27666 (setq column (if (equal btype bullet-type) bcol tcol)))
27667 (setq column (org-get-indentation)))))
27668 (t (setq column (org-get-indentation))))))
27669 (goto-char pos)
27670 (if (<= (current-column) (current-indentation))
27671 (indent-line-to column)
27672 (save-excursion (indent-line-to column)))
27673 (setq column (current-column))
27674 (beginning-of-line 1)
27675 (if (looking-at
27678 (match-string 2) (match-string 3)))
27679 t nil))
27680 (move-to-column column)))
27682 (defun org-set-autofill-regexps ()
27683 (interactive)
27684 ;; In the paragraph separator we include headlines, because filling
27685 ;; text in a line directly attached to a headline would otherwise
27686 ;; fill the headline as well.
27689 ;; The paragraph starter includes hand-formatted lists.
27690 (org-set-local 'paragraph-start
27692 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27693 ;; But only if the user has not turned off tables or fixed-width regions
27694 (org-set-local
27695 'auto-fill-inhibit-regexp
27698 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27699 (concat
27701 (if org-enable-table-editor "|" "")
27702 (if org-enable-fixed-width-editor ":" "")
27703 "]"))))
27704 ;; We use our own fill-paragraph function, to make sure that tables
27705 ;; and fixed-width regions are not wrapped. That function will pass
27706 ;; through to `fill-paragraph' when appropriate.
27707 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27708 ; Adaptive filling: To get full control, first make sure that
27709 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27711 (org-set-local 'adaptive-fill-function
27712 'org-adaptive-fill-function)
27713 (org-set-local
27714 'align-mode-rules-list
27715 '((org-in-buffer-settings
27717 (modes . '(org-mode))))))
27719 (defun org-fill-paragraph (&optional justify)
27720 "Re-align a table, pass through to fill-paragraph if no table."
27721 (let ((table-p (org-at-table-p))
27722 (table.el-p (org-at-table.el-p)))
27723 (cond ((and (equal (char-after (point-at-bol)) ?*)
27724 (save-excursion (goto-char (point-at-bol))
27725 (looking-at outline-regexp)))
27726 t) ; skip headlines
27727 (table.el-p t) ; skip table.el tables
27728 (table-p (org-table-align) t) ; align org-mode tables
27729 (t nil)))) ; call paragraph-fill
27731 ;; For reference, this is the default value of adaptive-fill-regexp
27734 (defun org-adaptive-fill-function ()
27735 "Return a fill prefix for org-mode files.
27736 In particular, this makes sure hanging paragraphs for hand-formatted lists
27737 work correctly."
27739 (match-string 0))
27741 (save-excursion
27742 (goto-char (match-end 0))
27743 (make-string (current-column) ?\ )))
27744 (t nil)))
27746 ;;;; Functions extending outline functionality
27749 (defun org-beginning-of-line (&optional arg)
27750 "Go to the beginning of the current line. If that is invisible, continue
27751 to a visible line beginning. This makes the function of C-a more intuitive.
27752 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27753 first attempt, and only move to after the tags when the cursor is already
27754 beyond the end of the headline."
27755 (interactive "P")
27756 (let ((pos (point)))
27757 (beginning-of-line 1)
27758 (if (bobp)
27759 nil
27760 (backward-char 1)
27761 (if (org-invisible-p)
27762 (while (and (not (bobp)) (org-invisible-p))
27763 (backward-char 1)
27764 (beginning-of-line 1))
27765 (forward-char 1)))
27766 (when org-special-ctrl-a/e
27767 (cond
27768 ((and (looking-at org-todo-line-regexp)
27769 (= (char-after (match-end 1)) ?\ ))
27770 (goto-char
27771 (if (eq org-special-ctrl-a/e t)
27772 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27773 ((= pos (point)) (match-beginning 3))
27774 (t (point)))
27775 (cond ((> pos (point)) (point))
27776 ((not (eq last-command this-command)) (point))
27777 (t (match-beginning 3))))))
27778 ((org-at-item-p)
27779 (goto-char
27780 (if (eq org-special-ctrl-a/e t)
27781 (cond ((> pos (match-end 4)) (match-end 4))
27782 ((= pos (point)) (match-end 4))
27783 (t (point)))
27784 (cond ((> pos (point)) (point))
27785 ((not (eq last-command this-command)) (point))
27786 (t (match-end 4))))))))))
27788 (defun org-end-of-line (&optional arg)
27789 "Go to the end of the line.
27790 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27791 first attempt, and only move to after the tags when the cursor is already
27792 beyond the end of the headline."
27793 (interactive "P")
27794 (if (or (not org-special-ctrl-a/e)
27795 (not (org-on-heading-p)))
27796 (end-of-line arg)
27797 (let ((pos (point)))
27798 (beginning-of-line 1)
27800 (if (eq org-special-ctrl-a/e t)
27801 (if (or (< pos (match-beginning 1))
27802 (= pos (match-end 0)))
27803 (goto-char (match-beginning 1))
27804 (goto-char (match-end 0)))
27805 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27806 (goto-char (match-end 0))
27807 (goto-char (match-beginning 1))))
27808 (end-of-line arg)))))
27810 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27811 (define-key org-mode-map "\C-e" 'org-end-of-line)
27813 (defun org-kill-line (&optional arg)
27814 "Kill line, to tags or end of line."
27815 (interactive "P")
27816 (cond
27817 ((or (not org-special-ctrl-k)
27818 (bolp)
27819 (not (org-on-heading-p)))
27820 (call-interactively 'kill-line))
27822 (kill-region (point) (match-beginning 1))
27823 (org-set-tags nil t))
27824 (t (kill-region (point) (point-at-eol)))))
27826 (define-key org-mode-map "\C-k" 'org-kill-line)
27828 (defun org-invisible-p ()
27829 "Check if point is at a character currently not visible."
27830 ;; Early versions of noutline don't have `outline-invisible-p'.
27831 (if (fboundp 'outline-invisible-p)
27832 (outline-invisible-p)
27833 (get-char-property (point) 'invisible)))
27835 (defun org-invisible-p2 ()
27836 "Check if point is at a character currently not visible."
27837 (save-excursion
27838 (if (and (eolp) (not (bobp))) (backward-char 1))
27839 ;; Early versions of noutline don't have `outline-invisible-p'.
27840 (if (fboundp 'outline-invisible-p)
27841 (outline-invisible-p)
27842 (get-char-property (point) 'invisible))))
27844 (defalias 'org-back-to-heading 'outline-back-to-heading)
27845 (defalias 'org-on-heading-p 'outline-on-heading-p)
27846 (defalias 'org-at-heading-p 'outline-on-heading-p)
27847 (defun org-at-heading-or-item-p ()
27848 (or (org-on-heading-p) (org-at-item-p)))
27850 (defun org-on-target-p ()
27851 (or (org-in-regexp org-radio-target-regexp)
27852 (org-in-regexp org-target-regexp)))
27854 (defun org-up-heading-all (arg)
27855 "Move to the heading line of which the present line is a subheading.
27856 This function considers both visible and invisible heading lines.
27857 With argument, move up ARG levels."
27858 (if (fboundp 'outline-up-heading-all)
27859 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27860 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27862 (defun org-up-heading-safe ()
27863 "Move to the heading line of which the present line is a subheading.
27864 This version will not throw an error. It will return the level of the
27865 headline found, or nil if no higher level is found."
27866 (let ((pos (point)) start-level level
27867 (re (concat "^" outline-regexp)))
27868 (catch 'exit
27869 (outline-back-to-heading t)
27870 (setq start-level (funcall outline-level))
27871 (if (equal start-level 1) (throw 'exit nil))
27872 (while (re-search-backward re nil t)
27873 (setq level (funcall outline-level))
27874 (if (< level start-level) (throw 'exit level)))
27875 nil)))
27877 (defun org-first-sibling-p ()
27878 "Is this heading the first child of its parents?"
27879 (interactive)
27880 (let ((re (concat "^" outline-regexp))
27881 level l)
27882 (unless (org-at-heading-p t)
27883 (error "Not at a heading"))
27884 (setq level (funcall outline-level))
27885 (save-excursion
27886 (if (not (re-search-backward re nil t))
27887 t
27888 (setq l (funcall outline-level))
27889 (< l level)))))
27891 (defun org-goto-sibling (&optional previous)
27892 "Goto the next sibling, even if it is invisible.
27893 When PREVIOUS is set, go to the previous sibling instead. Returns t
27894 when a sibling was found. When none is found, return nil and don't
27895 move point."
27896 (let ((fun (if previous 're-search-backward 're-search-forward))
27897 (pos (point))
27898 (re (concat "^" outline-regexp))
27899 level l)
27900 (when (condition-case nil (org-back-to-heading t) (error nil))
27901 (setq level (funcall outline-level))
27902 (catch 'exit
27903 (or previous (forward-char 1))
27904 (while (funcall fun re nil t)
27905 (setq l (funcall outline-level))
27906 (when (< l level) (goto-char pos) (throw 'exit nil))
27907 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27908 (goto-char pos)
27909 nil))))
27911 (defun org-show-siblings ()
27912 "Show all siblings of the current headline."
27913 (save-excursion
27914 (while (org-goto-sibling) (org-flag-heading nil)))
27915 (save-excursion
27916 (while (org-goto-sibling 'previous)
27917 (org-flag-heading nil))))
27919 (defun org-show-hidden-entry ()
27920 "Show an entry where even the heading is hidden."
27921 (save-excursion
27922 (org-show-entry)))
27924 (defun org-flag-heading (flag &optional entry)
27925 "Flag the current heading. FLAG non-nil means make invisible.
27926 When ENTRY is non-nil, show the entire entry."
27927 (save-excursion
27928 (org-back-to-heading t)
27929 ;; Check if we should show the entire entry
27930 (if entry
27931 (progn
27932 (org-show-entry)
27933 (save-excursion
27934 (and (outline-next-heading)
27935 (org-flag-heading nil))))
27936 (outline-flag-region (max (point-min) (1- (point)))
27937 (save-excursion (outline-end-of-heading) (point))
27938 flag))))
27940 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27941 ;; This is an exact copy of the original function, but it uses
27942 ;; `org-back-to-heading', to make it work also in invisible
27943 ;; trees. And is uses an invisible-OK argument.
27944 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
27945 (org-back-to-heading invisible-OK)
27946 (let ((first t)
27947 (level (funcall outline-level)))
27948 (while (and (not (eobp))
27949 (or first (> (funcall outline-level) level)))
27950 (setq first nil)
27951 (outline-next-heading))
27952 (unless to-heading
27954 (progn
27955 ;; Go to end of line before heading
27956 (forward-char -1)
27958 ;; leave blank line before heading
27959 (forward-char -1))))))
27960 (point))
27962 (defun org-show-subtree ()
27963 "Show everything after this heading at deeper levels."
27964 (outline-flag-region
27965 (point)
27966 (save-excursion
27967 (outline-end-of-subtree) (outline-next-heading) (point))
27968 nil))
27970 (defun org-show-entry ()
27971 "Show the body directly following this heading.
27972 Show the heading too, if it is currently invisible."
27973 (interactive)
27974 (save-excursion
27975 (condition-case nil
27976 (progn
27977 (org-back-to-heading t)
27978 (outline-flag-region
27979 (max (point-min) (1- (point)))
27980 (save-excursion
27981 (re-search-forward
27983 (or (match-beginning 1) (point-max)))
27984 nil))
27985 (error nil))))
27987 (defun org-make-options-regexp (kwds)
27988 "Make a regular expression for keyword lines."
27989 (concat
27990 "^"
27996 ;; Make isearch reveal the necessary context
27997 (defun org-isearch-end ()
27998 "Reveal context after isearch exits."
27999 (when isearch-success ; only if search was successful
28000 (if (featurep 'xemacs)
28001 ;; Under XEmacs, the hook is run in the correct place,
28002 ;; we directly show the context.
28003 (org-show-context 'isearch)
28004 ;; In Emacs the hook runs *before* restoring the overlays.
28005 ;; So we have to use a one-time post-command-hook to do this.
28006 ;; (Emacs 22 has a special variable, see function `org-mode')
28007 (unless (and (boundp 'isearch-mode-end-hook-quit)
28008 isearch-mode-end-hook-quit)
28009 ;; Only when the isearch was not quitted.
28010 (org-add-hook 'post-command-hook 'org-isearch-post-command
28011 'append 'local)))))
28013 (defun org-isearch-post-command ()
28014 "Remove self from hook, and show context."
28015 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28016 (org-show-context 'isearch))
28019 ;;;; Integration with and fixes for other packages
28021 ;;; Imenu support
28023 (defvar org-imenu-markers nil
28024 "All markers currently used by Imenu.")
28025 (make-variable-buffer-local 'org-imenu-markers)
28027 (defun org-imenu-new-marker (&optional pos)
28028 "Return a new marker for use by Imenu, and remember the marker."
28029 (let ((m (make-marker)))
28030 (move-marker m (or pos (point)))
28031 (push m org-imenu-markers)
28032 m))
28034 (defun org-imenu-get-tree ()
28035 "Produce the index for Imenu."
28036 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28037 (setq org-imenu-markers nil)
28038 (let* ((n org-imenu-depth)
28039 (re (concat "^" outline-regexp))
28040 (subs (make-vector (1+ n) nil))
28041 (last-level 0)
28042 m tree level head)
28043 (save-excursion
28044 (save-restriction
28045 (widen)
28046 (goto-char (point-max))
28047 (while (re-search-backward re nil t)
28048 (setq level (org-reduced-level (funcall outline-level)))
28049 (when (<= level n)
28050 (looking-at org-complex-heading-regexp)
28051 (setq head (org-match-string-no-properties 4)
28052 m (org-imenu-new-marker))
28053 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28054 (if (>= level last-level)
28055 (push (cons head m) (aref subs level))
28056 (push (cons head (aref subs (1+ level))) (aref subs level))
28057 (loop for i from (1+ level) to n do (aset subs i nil)))
28058 (setq last-level level)))))
28059 (aref subs 1)))
28061 (eval-after-load "imenu"
28062 '(progn
28063 (add-hook 'imenu-after-jump-hook
28064 (lambda () (org-show-context 'org-goto)))))
28066 ;; Speedbar support
28068 (defun org-speedbar-set-agenda-restriction ()
28069 "Restrict future agenda commands to the location at point in speedbar.
28071 (interactive)
28072 (let (p m tp np dir txt w)
28073 (cond
28074 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28075 'org-imenu t))
28076 (setq m (get-text-property p 'org-imenu-marker))
28077 (save-excursion
28078 (save-restriction
28079 (set-buffer (marker-buffer m))
28080 (goto-char m)
28081 (org-agenda-set-restriction-lock 'subtree))))
28082 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28083 'speedbar-function 'speedbar-find-file))
28084 (setq tp (previous-single-property-change
28085 (1+ p) 'speedbar-function)
28086 np (next-single-property-change
28087 tp 'speedbar-function)
28088 dir (speedbar-line-directory)
28089 txt (buffer-substring-no-properties (or tp (point-min))
28090 (or np (point-max))))
28091 (save-excursion
28092 (save-restriction
28093 (set-buffer (find-file-noselect
28094 (let ((default-directory dir))
28095 (expand-file-name txt))))
28096 (unless (org-mode-p)
28097 (error "Cannot restrict to non-Org-mode file"))
28098 (org-agenda-set-restriction-lock 'file))))
28099 (t (error "Don't know how to restrict Org-mode's agenda")))
28100 (org-move-overlay org-speedbar-restriction-lock-overlay
28101 (point-at-bol) (point-at-eol))
28102 (setq current-prefix-arg nil)
28103 (org-agenda-maybe-redo)))
28105 (eval-after-load "speedbar"
28106 '(progn
28107 (speedbar-add-supported-extension ".org")
28108 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28109 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28110 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28111 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28112 (add-hook 'speedbar-visiting-tag-hook
28113 (lambda () (org-show-context 'org-goto)))))
28116 ;;; Fixes and Hacks
28118 ;; Make flyspell not check words in links, to not mess up our keymap
28119 (defun org-mode-flyspell-verify ()
28120 "Don't let flyspell put overlays at active buttons."
28121 (not (get-text-property (point) 'keymap)))
28123 ;; Make `bookmark-jump' show the jump location if it was hidden.
28124 (eval-after-load "bookmark"
28125 '(if (boundp 'bookmark-after-jump-hook)
28126 ;; We can use the hook
28127 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28128 ;; Hook not available, use advice
28129 (defadvice bookmark-jump (after org-make-visible activate)
28130 "Make the position visible."
28131 (org-bookmark-jump-unhide))))
28133 (defun org-bookmark-jump-unhide ()
28134 "Unhide the current position, to show the bookmark location."
28135 (and (org-mode-p)
28136 (or (org-invisible-p)
28137 (save-excursion (goto-char (max (point-min) (1- (point))))
28138 (org-invisible-p)))
28139 (org-show-context 'bookmark-jump)))
28141 ;; Fix a bug in htmlize where there are text properties (face nil)
28142 (eval-after-load "htmlize"
28143 '(progn
28144 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28145 "Make sure there are no nil faces"
28146 (setq ad-return-value (delq nil ad-return-value)))))
28148 ;; Make session.el ignore our circular variable
28149 (eval-after-load "session"
28150 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28152 ;;;; Experimental code
28154 (defun org-closed-in-range ()
28155 "Sparse tree of items closed in a certain time range.
28156 Still experimental, may disappear in the future."
28157 (interactive)
28158 ;; Get the time interval from the user.
28159 (let* ((time1 (time-to-seconds
28160 (org-read-date nil 'to-time nil "Starting date: ")))
28161 (time2 (time-to-seconds
28162 (org-read-date nil 'to-time nil "End date:")))
28163 ;; callback function
28164 (callback (lambda ()
28165 (let ((time
28166 (time-to-seconds
28167 (apply 'encode-time
28168 (org-parse-time-string
28169 (match-string 1))))))
28170 ;; check if time in interval
28171 (and (>= time time1) (<= time time2))))))
28172 ;; make tree, check each match with the callback
28175 ;;;; Finish up
28177 (provide 'org)
28179 (run-hooks 'org-load-hook)
28181 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28182 ;;; org.el ends here