| blob | 08ee515778c0635029a4a5543b8d55349a7898d3 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 5.22a
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
67 ;;;; Require other packages
73 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
74 ;; the file noutline.el being loaded.
76 ;; We require noutline, which might be provided in outline.el
78 ;; Other stuff we need.
83 ;;;; Customization variables
85 ;;; Version
91 "Show the org-mode version in the echo area.
92 With prefix arg HERE, insert it at point."
99 ;;; Compatibility constants
108 "Return the value of symbol VAR if it is bound, else nil."
112 "Execute body without changing `buffer-modified-p'."
117 "Replace posix classes in regular expression."
125 ss))
126 s))
138 partial-completion-mode)))
145 ;;; The custom variables
148 "Outline-based notes management and organizer."
154 ;; FIXME: Needs a separate group...
157 Normal means, no org-mode-specific context."
162 "Options concerning startup of Org-mode."
167 "Non-nil means, entering Org-mode will switch to OVERVIEW.
168 This can also be configured on a per-file basis by adding one of
169 the following lines anywhere in the buffer:
171 #+STARTUP: fold
172 #+STARTUP: nofold
173 #+STARTUP: content"
181 "Non-nil means, entering Org-mode will set `truncate-lines'.
182 This is useful since some lines containing links can be very long and
183 uninteresting. Also tables look terrible when wrapped."
188 "Non-nil means, align all tables when visiting a file.
189 This is useful when the column width in tables is forced with <N> cookies
190 in table fields. Such tables will look correct only after the first re-align.
191 This can also be configured on a per-file basis by adding one of
192 the following lines anywhere in the buffer:
193 #+STARTUP: align
194 #+STARTUP: noalign"
199 "Non-nil means insert the first line setting Org-mode in empty files.
200 When the function `org-mode' is called interactively in an empty file, this
201 normally means that the file name does not automatically trigger Org-mode.
202 To ensure that the file will always be in Org-mode in the future, a
203 line enforcing Org-mode will be inserted into the buffer, if this option
204 has been set."
209 "Non-nil means use alternative key bindings for some keys.
210 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
211 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
212 If you want to use Org-mode together with one of these other modes,
213 or more generally if you would like to move some Org-mode commands to
214 other keys, set this variable and configure the keys with the variable
215 `org-disputed-keys'.
217 This option is only relevant at load-time of Org-mode, and must be set
218 *before* org.el is loaded. Changing it requires a restart of Emacs to
219 become effective."
233 "Keys for which Org-mode and other modes compete.
234 This is an alist, cars are the default keys, second element specifies
235 the alternative to use when `org-replace-disputed-keys' is t.
237 Keys can be specified in any syntax supported by `define-key'.
238 The value of this option takes effect only at Org-mode's startup,
239 therefore you'll have to restart Emacs to apply it after changing."
244 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
245 Or return the original if not disputed."
250 org-disputed-keys)))
252 key))
262 "Define a key, possibly translated, as returned by `org-key'."
266 "The ellipsis to use in the Org-mode outline.
267 When nil, just use the standard three dots. When a string, use that instead,
268 When a face, use the standart 3 dots, but with the specified face.
269 The change affects only Org-mode (which will then use its own display table).
270 Changing this requires executing `M-x org-mode' in a buffer to become
271 effective."
281 "Keywords in Org-mode."
286 "String to mark deadline entries.
287 A deadline is this string, followed by a time stamp. Should be a word,
288 terminated by a colon. You can insert a schedule keyword and
290 Changes become only effective after restarting Emacs."
295 "String to mark scheduled TODO entries.
296 A schedule is this string, followed by a time stamp. Should be a word,
297 terminated by a colon. You can insert a schedule keyword and
299 Changes become only effective after restarting Emacs."
304 "String used as the prefix for timestamps logging closing a TODO entry."
309 "String used as prefix for timestamps clocking work hours on an item."
314 "Entries starting with this keyword will never be exported.
315 An entry can be toggled between COMMENT and normal with
317 Changes become only effective after restarting Emacs."
322 "Entries starting with this keyword will be exported in fixed-width font.
323 Quoting applies only to the text in the entry following the headline, and does
324 not extend beyond the next headline, even if that is lower level.
325 An entry can be toggled between QUOTE and normal with
331 ; (concat "\\(?:\\<\\(?:" org-scheduled-string "\\|" org-deadline-string "\\)"
332 ; " +<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\)\\(\\+[0-9]+[dwmy]\\)")
334 "Regular expression for specifying repeated events.
338 "Options concerning the general structure of Org-mode files."
343 "Options about how to make context of a location visible."
367 "Non-nil means, show full hierarchy when revealing a location.
368 Org-mode often shows locations in an org-mode file which might have
369 been invisible before. When this is set, the hierarchy of headings
370 above the exposed location is shown.
371 Turning this off for example for sparse trees makes them very compact.
372 Instead of t, this can also be an alist specifying this option for different
373 contexts. Valid contexts are
374 agenda when exposing an entry from the agenda
375 org-goto when using the command `org-goto' on key C-c C-j
376 occur-tree when using the command `org-occur' on key C-c /
377 tags-tree when constructing a sparse tree based on tags matches
378 link-search when exposing search matches associated with a link
379 mark-goto when exposing the jump goal of a mark
380 bookmark-jump when exposing a bookmark location
381 isearch when exiting from an incremental search
382 default default for all contexts not set explicitly"
387 "Non-nil means, show following heading when revealing a location.
388 Org-mode often shows locations in an org-mode file which might have
389 been invisible before. When this is set, the heading following the
390 match is shown.
391 Turning this off for example for sparse trees makes them very compact,
392 but makes it harder to edit the location of the match. In such a case,
394 Instead of t, this can also be an alist specifying this option for different
395 contexts. See `org-show-hierarchy-above' for valid contexts."
400 "Non-nil means, show all sibling heading when revealing a location.
401 Org-mode often shows locations in an org-mode file which might have
402 been invisible before. When this is set, the sibling of the current entry
403 heading are all made visible. If `org-show-hierarchy-above' is t,
404 the same happens on each level of the hierarchy above the current entry.
406 By default this is on for the isearch context, off for all other contexts.
407 Turning this off for example for sparse trees makes them very compact,
408 but makes it harder to edit the location of the match. In such a case,
410 Instead of t, this can also be an alist specifying this option for different
411 contexts. See `org-show-hierarchy-above' for valid contexts."
416 "Non-nil means, show the entry below a headline when revealing a location.
417 Org-mode often shows locations in an org-mode file which might have
418 been invisible before. When this is set, the text below the headline that is
419 exposed is also shown.
421 By default this is off for all contexts.
422 Instead of t, this can also be an alist specifying this option for different
423 contexts. See `org-show-hierarchy-above' for valid contexts."
428 "Options concerning visibility cycling in Org-mode."
433 "Names of drawers. Drawers are not opened by cycling on the headline above.
434 Drawers only open with a TAB on the drawer line itself. A drawer looks like
435 this:
436 :DRAWERNAME:
437 .....
438 :END:
440 the property API.
442 Drawers can be defined on the per-file basis with a line like:
444 #+DRAWERS: HIDDEN STATE PROPERTIES"
449 "Cycle globally if cursor is at beginning of buffer and not at a headline.
450 This makes it possible to do global cycling without having to use S-TAB or
451 C-u TAB. For this special case to work, the first line of the buffer
452 must not be a headline - it may be empty ot some other text. When used in
453 this way, `org-cycle-hook' is disables temporarily, to make sure the
454 cursor stays at the beginning of the buffer.
455 When this option is nil, don't do anything special at the beginning
456 of the buffer."
461 "Where should `org-cycle' emulate TAB.
462 nil Never
463 white Only in completely white lines
464 whitestart Only at the beginning of lines, before the first non-white char
465 t Everywhere except in headlines
466 exc-hl-bol Everywhere except at the start of a headline
467 If TAB is used in a place where it does not emulate TAB, the current subtree
468 visibility is cycled."
475 ))
478 "Number of empty lines needed to keep an empty line between collapsed trees.
479 If you leave an empty line between the end of a subtree and the following
480 headline, this empty line is hidden when the subtree is folded.
481 Org-mode will leave (exactly) one empty line visible if the number of
482 empty lines is equal or larger to the number given in this variable.
483 So the default 2 means, at least 2 empty lines after the end of a subtree
484 are needed to produce free space between a collapsed subtree and the
485 following headline.
487 Special case: when 0, never leave empty lines in collapsed view."
492 org-cycle-hide-drawers
493 org-cycle-show-empty-lines
494 org-optimize-window-after-visibility-change)
495 "Hook that is run after `org-cycle' has changed the buffer visibility.
496 The function(s) in this hook must accept a single argument which indicates
497 the new state that was set by the most recent `org-cycle' command. The
498 argument is a symbol. After a global state change, it can have the values
499 `overview', `content', or `all'. After a local state change, it can have
500 the values `folded', `children', or `subtree'."
505 "Options concerning structure editing in Org-mode."
510 "Non-nil means `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 Each keyword can optionally specify a character for fast state selection
1645 \(in combination with the variable `org-use-fast-todo-selection')
1646 and specifiers for state change logging, using the same syntax
1649 indicates to record a time stamp each time this state is selected.
1652 entering and when leaving this state.
1654 For backward compatibility, this variable may also be just a list
1655 of keywords - in this case the interptetation (sequence or type) will be
1656 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1694 "Controls how TODO keywords are interpreted.
1695 This variable is in principle obsolete and is only used for
1696 backward compatibility, if the interpretation of todo keywords is
1697 not given already in `org-todo-keywords'. See that variable for
1698 more information."
1705 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1706 This variable describes if and under what circumstances the cycling
1707 mechanism for TODO keywords will be replaced by a single-key, direct
1708 selection scheme.
1710 When nil, fast selection is never used.
1712 When the symbol `prefix', it will be used when `org-todo' is called with
1713 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1714 in an agenda buffer.
1716 When t, fast selection is used by default. In this case, the prefix
1717 argument forces cycling instead.
1719 In all cases, the special interface is only used if access keys have actually
1720 been assigned by the user, i.e. if keywords in the configuration are followed
1721 by a letter in parenthesis, like TODO(t)."
1729 "Hook which is run after the state of a TODO item was changed.
1730 The new state (a string with a TODO keyword, or nil) is available in the
1731 Lisp variable `state'."
1736 "Non-nil means, record a CLOSED timestamp when moving an entry to DONE.
1737 When equal to the list (done), also prompt for a closing note.
1738 This can also be configured on a per-file basis by adding one of
1739 the following lines anywhere in the buffer:
1741 #+STARTUP: logdone
1742 #+STARTUP: lognotedone
1743 #+STARTUP: nologdone"
1751 ;; Normalize old uses of org-log-done.
1757 ;; FIXME: document
1759 "Non-nil means, recored a note when clocking out of an item.
1760 This can also be configured on a per-file basis by adding one of
1761 the following lines anywhere in the buffer:
1763 #+STARTUP: lognoteclock-out
1764 #+STARTUP: nolognoteclock-out"
1770 "Non-nil means, the CLOSED time stamp will contain date and time.
1771 When nil, only the date will be recorded."
1779 "Headings for notes added when clocking out or closing TODO items.
1780 The value is an alist, with the car being a symbol indicating the note
1781 context, and the cdr is the heading to be used. The heading may also be the
1782 empty string.
1783 %t in the heading will be replaced by a time stamp.
1784 %s will be replaced by the new TODO state, in double quotes.
1785 %u will be replaced by the user name.
1786 %U will be replaced by the full user name."
1792 "Heading when changing todo state (todo sequence only)"
1797 "Non-nil means, the latest state change note will be directly after heading.
1798 When nil, the notes will be orderer according to time."
1804 "Non-nil means, record moving through the DONE state when triggering repeat.
1805 An auto-repeating tasks is immediately switched back to TODO when marked
1807 the TODO keyword definition, or recording a cloing note by setting
1808 `org-log-done', there will be no record of the task moving trhough DONE.
1809 This variable forces taking a note anyway. Possible values are:
1811 nil Don't force a record
1812 time Record a time stamp
1813 note Record a note
1815 This option can also be set with on a per-file-basis with
1817 #+STARTUP: logrepeat
1818 #+STARTUP: lognoterepeat
1819 #+STARTUP: nologrepeat
1821 You can have local logging settings for a subtree by setting the LOGGING
1822 property to one or more of these keywords."
1831 "Should clocking info be wrapped into a drawer?
1832 When t, clocking info will always be inserted into a :CLOCK: drawer.
1833 If necessary, the drawer will be created.
1834 When nil, the drawer will not be created, but used when present.
1835 When an integer and the number of clocking entries in an item
1836 reaches or exceeds this number, a drawer will be created."
1845 "When t, the clock will be stopped when the relevant entry is marked DONE.
1846 Nil means, clock will keep running until stopped explicitly with
1847 `C-c C-x C-o', or until the clock is started in a different item."
1852 "Set task to a special todo state while clocking it.
1853 The value should be the state to which the entry should be switched."
1861 "Priorities in Org-mode."
1866 "The highest priority of TODO items. A character like ?A, ?B etc.
1867 Must have a smaller ASCII number than `org-lowest-priority'."
1872 "The lowest priority of TODO items. A character like ?A, ?B etc.
1873 Must have a larger ASCII number than `org-highest-priority'."
1878 "The default priority of TODO items.
1879 This is the priority an item get if no explicit priority is given."
1884 "Non-nil means, start with default priority when starting to cycle.
1885 When this is nil, the first step in the cycle will be (depending on the
1886 command used) one higher or lower that the default priority."
1891 "Options concerning time stamps and deadlines in Org-mode."
1896 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1897 When nil, these labeled time stamps are forces into the second line of an
1898 entry, just after the headline. When scheduling from the global TODO list,
1899 the time stamp will always be forced into the second line."
1904 "Formats for `format-time-string' which are used for time stamps.
1908 "Number of minutes to round time stamps to upon insertion.
1909 When zero, insert the time unmodified. Useful rounding numbers
1910 should be factors of 60, so for example 5, 10, 15.
1911 When this is not zero, you can still force an exact time-stamp by using
1912 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1917 "Non-nil means, overlay custom formats over all time stamps.
1918 The formats are defined through the variable `org-time-stamp-custom-formats'.
1919 To turn this on on a per-file basis, insert anywhere in the file:
1920 #+STARTUP: customtime"
1928 "Custom formats for time stamps. See `format-time-string' for the syntax.
1929 These are overlayed over the default ISO format if the variable
1930 `org-display-custom-times' is set. Time like %H:%M should be at the
1931 end of the second format."
1936 "Get the right format for a time string."
1941 f)))
1944 "Non-nil means, assume future for incomplete date input from user.
1945 This affects the following situations:
1946 1. The user gives a day, but no month.
1949 it will be considered as *this* month.
1950 2. The user gives a month but not a year.
1954 When this option is nil, the current month and year will always be used
1955 as defaults."
1960 "Non-nil means, display current interpretation of date prompt live.
1961 This display will be in an overlay, in the minibuffer."
1966 "Non-nil means, pop up a calendar when prompting for a date.
1967 In the calendar, the date can be selected with mouse-1. However, the
1968 minibuffer will also be active, and you can simply enter the date as well.
1969 When nil, only the minibuffer will be available."
1977 "The hour when your day really ends.
1978 This has influence for the following applications:
1980 the time given here, the day recognized as TODAY is actually yesterday.
1981 - When a date is read from the user and it is still before the time given
1982 here, the current date and time will be assumed to be yesterday, 23:59.
1984 FIXME:
1985 IMPORTANT: This is still a very experimental feature, it may disappear
1986 again or it may be extended to mean more things."
1991 "Non-nil means, S-down will increase the time in a time stamp.
1992 When nil, S-up will increase."
1997 "Non-nil means, make the calendar window follow timestamp changes.
1998 When a timestamp is modified and the calendar window is visible, it will be
1999 moved to the new date."
2004 "When non-nil, should be a function to create `org-clock-heading'.
2005 This is the string shown in the mode line when a clock is running.
2006 The function is called with point at the beginning of the headline."
2011 "Options concerning tags in Org-mode."
2016 "List of tags allowed in Org-mode files.
2017 When this list is nil, Org-mode will base TAG input on what is already in the
2018 buffer.
2019 The value of this variable is an alist, the car of each entry must be a
2020 keyword as a string, the cdr may be a character that is used to select
2021 that tag through the fast-tag-selection interface.
2022 See the manual for details."
2032 "Non-nil means, use fast tag selection scheme.
2033 This is a special interface to select and deselect tags with single keys.
2034 When nil, fast selection is never used.
2035 When the symbol `auto', fast selection is used if and only if selection
2036 characters for tags have been configured, either through the variable
2037 `org-tag-alist' or through a #+TAGS line in the buffer.
2038 When t, fast selection is always used and selection keys are assigned
2039 automatically if necessary."
2047 "Non-nil means, fast tag selection exits after first change.
2048 When nil, you have to press RET to exit it.
2049 During fast tag selection, you can toggle this flag with `C-c'.
2050 This variable can also have the value `expert'. In this case, the window
2051 displaying the tags menu is not even shown, until you press C-c again."
2059 "Non-nil means, fast tags selection interface will also offer TODO states.
2063 "The column to which tags should be indented in a headline.
2064 If this number is positive, it specifies the column. If it is negative,
2065 it means that the tags should be flushright to that column. For example,
2066 -80 works well for a normal 80 character screen."
2071 "Non-nil means, realign tags after pro/demotion of TODO state change.
2072 These operations change the length of a headline and therefore shift
2073 the tags around. With this options turned on, after each such operation
2074 the tags are again aligned to `org-tags-column'."
2079 "Non-nil means, tags in levels apply also for sublevels.
2080 When nil, only the tags directly given in a specific line apply there.
2081 If you turn off this option, you very likely want to turn on the
2082 companion option `org-tags-match-list-sublevels'."
2087 "Non-nil means list also sublevels of headlines matching tag search.
2088 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2089 the sublevels of a headline matching a tag search often also match
2090 the same search. Listing all of them can create very long lists.
2091 Setting this variable to nil causes subtrees of a match to be skipped.
2092 This option is off by default, because inheritance in on. If you turn
2093 inheritance off, you very likely want to turn this option on.
2095 As a special case, if the tag search is restricted to TODO items, the
2096 value of this variable is ignored and sublevels are always checked, to
2097 make sure all corresponding TODO items find their way into the list."
2109 "Options concerning properties in Org-mode."
2114 "How property key/value pairs should be formatted by `indent-line'.
2115 When `indent-line' hits a property definition, it will format the line
2116 according to this format, mainly to make sure that the values are
2117 lined-up with respect to each other."
2122 "Non-nil means, properties apply also for sublevels.
2123 This setting is only relevant during property searches, not when querying
2124 an entry with `org-entry-get'. To retrieve a property with inheritance,
2125 you need to call `org-entry-get' with the inheritance flag.
2126 Turning this on can cause significant overhead when doing a search, so
2127 this is turned off by default.
2128 When nil, only the properties directly given in the current entry count.
2129 The value may also be a list of properties that shouldhave inheritance.
2131 However, note that some special properties use inheritance under special
2132 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2134 for valid values of a property."
2142 "The default column format, if no other format has been defined.
2143 This variable can be set on the per-file basis by inserting a line
2145 #+COLUMNS: %25ITEM ....."
2150 "List of property/value pairs that can be inherited by any entry.
2151 You can set buffer-local values for this by adding lines like
2153 #+PROPERTY: NAME VALUE"
2160 "List of property/value pairs that can be inherited by any entry.
2161 Valid for the current buffer.
2165 "Options concerning agenda views in Org-mode."
2170 "Variable used by org files to set a category for agenda display.
2171 Such files should use a file variable to set it, for example
2175 or contain a special line
2177 #+CATEGORY: ELisp
2179 If the file does not specify a category, then file's base name
2184 "The files to be used for agenda display.
2188 If an entry is a directory, all files in that directory that are matched by
2189 `org-agenda-file-regexp' will be part of the file list.
2191 If the value of the variable is not a list but a single file name, then
2192 the list of agenda files is actually stored and maintained in that file, one
2193 agenda file per line."
2200 "Regular expression to match files for `org-agenda-files'.
2201 If any element in the list in that variable contains a directory instead
2202 of a normal file, all files in that directory that are matched by this
2203 regular expression will be included."
2208 "t means to just skip non-reachable files in `org-agenda-files'.
2209 Nil means to remove them, after a query, from the list."
2214 "List of extra files to be searched by `org-occur-in-agenda-files'.
2215 The files in `org-agenda-files' are always searched."
2220 "When set, remote killing from the agenda buffer needs confirmation.
2221 When t, a confirmation is always needed. When a number N, confirmation is
2222 only needed when the text to be killed contains more than N non-white lines."
2230 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2231 The command `org-calendar-goto-agenda' will be bound to this key. The
2232 default is the character `c' because then `c' can be used to switch back and
2233 forth between agenda and calendar."
2238 "Non-nil means, make the block agenda more compact.
2239 This is done by leaving out unnecessary lines."
2244 "Options concerning exporting agenda views in Org-mode."
2249 "Non-nil means, use colors in agenda views."
2254 "Alist of variable/value pairs that should be active during agenda export.
2255 This is a good place to set uptions for ps-print and for htmlize."
2263 "The style specification for exported HTML Agenda files.
2264 If this variable contains a string, it will replace the default <style>
2265 section as produced by `htmlize'.
2266 Since there are different ways of setting style information, this variable
2267 needs to contain the full HTML structure to provide a style, including the
2268 surrounding HTML tags. The style specifications should include definitions
2269 the fonts used by the agenda, here is an example:
2272 p { font-weight: normal; color: gray; }
2273 .org-agenda-structure {
2274 font-size: 110%;
2275 color: #003399;
2276 font-weight: 600;
2277 }
2278 .org-todo {
2279 color: #cc6666;Week-agenda:
2280 font-weight: bold;
2281 }
2282 .org-done {
2283 color: #339933;
2284 }
2285 .title { text-align: center; }
2286 .todo, .deadline { color: red; }
2287 .done { color: green; }
2288 </style>
2290 or, if you want to keep the style in a file,
2294 As the value of this option simply gets inserted into the HTML <head> header,
2296 <style>...</style> is required, if not present the variable will be ignored."
2302 "Options concerning agenda views in Org-mode."
2307 "Custom commands for the agenda.
2308 These commands will be offered on the splash screen displayed by the
2311 (key desc type match options files)
2313 key The key (one or more characters as a string) to be associated
2314 with the command.
2315 desc A description of the commend, when omitted or nil, a default
2316 description is built using MATCH.
2317 type The command type, any of the following symbols:
2318 todo Entries with a specific TODO keyword, in all agenda files.
2319 tags Tags match in all agenda files.
2320 tags-todo Tags match in all agenda files, TODO entries only.
2321 todo-tree Sparse tree of specific TODO keyword in *current* file.
2322 tags-tree Sparse tree with all tags matches in *current* file.
2323 occur-tree Occur sparse tree for *current* file.
2324 ... A user-defined function.
2325 match What to search for:
2326 - a single keyword for TODO keyword searches
2327 - a tags match expression for tags searches
2328 - a regular expression for occur searches
2329 options A list of option settings, similar to that in a let form, so like
2330 this: ((opt1 val1) (opt2 val2) ...)
2331 files A list of files file to write the produced agenda buffer to
2332 with the command `org-store-agenda-views'.
2335 produced. Otherwide, only the plain text is written to the file.
2337 You can also define a set of commands, to create a composite agenda buffer.
2338 In this case, an entry looks like this:
2340 (key desc (cmd1 cmd2 ...) general-options file)
2342 where
2344 desc A description string to be displayed in the dispatcher menu.
2345 cmd An agenda command, similar to the above. However, tree commands
2346 are no allowed, but instead you can get agenda and global todo list.
2347 So valid commands for a set are:
2348 (agenda)
2349 (alltodo)
2350 (stuck)
2355 Each command can carry a list of options, and another set of options can be
2356 given for the whole set of commands. Individual command options take
2357 precedence over the general options.
2359 When using several characters as key to a command, the first characters
2360 are prefix commands. For the dispatcher to display useful information, you
2361 should provide a description for the prefix, like
2363 (setq org-agenda-custom-commands
2435 "How to identify stuck projects.
2436 This is a list of four items:
2437 1. A tags/todo matcher string that is used to identify a project.
2438 The entire tree below a headline matched by this is considered one project.
2439 2. A list of TODO keywords identifying non-stuck projects.
2440 If the project subtree contains any headline with one of these todo
2441 keywords, the project is considered to be not stuck. If you specify
2443 3. A list of tags identifying non-stuck projects.
2444 If the project subtree contains any headline with one of these tags,
2446 a tag, any tag will mark the project unstuck.
2447 4. An arbitrary regular expression matching non-stuck projects.
2450 or `C-c a #' to produce the list."
2454 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2460 "Options concerning skipping parts of agenda files."
2465 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2466 When nil, the sublevels of a TODO entry are not checked, resulting in
2467 potentially much shorter TODO lists."
2473 "Non-nil means, don't show entries with a date in the global todo list.
2474 You can use this if you prefer to mark mere appointments with a TODO keyword,
2475 but don't want them to show up in the TODO list.
2476 When this is set, it also covers deadlines and scheduled items, the settings
2477 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2478 will be ignored."
2484 "Non-nil means, don't show scheduled entries in the global todo list.
2485 The idea behind this is that by scheduling it, you have already taken care
2486 of this item.
2487 See also `org-agenda-todo-ignore-with-date'."
2493 "Non-nil means, don't show near deadline entries in the global todo list.
2494 Near means closer than `org-deadline-warning-days' days.
2495 The idea behind this is that such items will appear in the agenda anyway.
2496 See also `org-agenda-todo-ignore-with-date'."
2502 "Non-nil means don't show scheduled items in agenda when they are done.
2503 This is relevant for the daily/weekly agenda, not for the TODO list. And
2504 it applies only to the actual date of the scheduling. Warnings about
2505 an item with a past scheduling dates are always turned off when the item
2506 is DONE."
2511 "Non-nil means don't show deadines when the corresponding item is done.
2512 When nil, the deadline is still shown and should give you a happy feeling.
2513 This is relevant for the daily/weekly agenda. And it applied only to the
2514 actualy date of the deadline. Warnings about approching and past-due
2515 deadlines are always turned off when the item is DONE."
2520 "Non-nil means don't select item by timestamp or -range if it is DONE."
2525 "Non-nil means, `org-timeline' also shows dates without an entry.
2526 When nil, only the days which actually have entries are shown.
2527 When t, all days between the first and the last date are shown.
2528 When an integer, show also empty dates, but if there is a gap of more than
2529 N days, just insert a special line indicating the size of the gap."
2538 "Options concerning initial settings in the Agenda in Org Mode."
2543 "Hook run just before displaying an agenda buffer."
2548 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2549 A longer mouse click will still set point. Does not wortk on XEmacs.
2550 Needs to be set before org.el is loaded."
2555 "The initial value of follow-mode in a newly created agenda window."
2560 "Options concerning the windows used by the Agenda in Org Mode."
2565 "How the agenda buffer should be displayed.
2566 Possible values for this option are:
2568 current-window Show agenda in the current window, keeping all other windows.
2569 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2570 other-window Use `switch-to-buffer-other-window' to display agenda.
2571 reorganize-frame Show only two windows on the current frame, the current
2572 window and the agenda.
2573 See also the variable `org-agenda-restore-windows-after-quit'."
2582 "The min and max height of the agenda window as a fraction of frame height.
2583 The value of the variable is a cons cell with two numbers between 0 and 1.
2584 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2589 "Non-nil means, restore window configuration open exiting agenda.
2590 Before the window configuration is changed for displaying the agenda,
2591 the current status is recorded. When the agenda is exited with
2592 `q' or `x' and this option is set, the old state is restored. If
2593 `org-agenda-window-setup' is `other-frame', the value of this
2594 option will be ignored.."
2599 "How should indirect tree buffers be displayed?
2600 This applies to indirect buffers created with the commands
2602 Valid values are:
2603 current-window Display in the current window
2604 other-window Just display in another window.
2605 dedicated-frame Create one new frame, and re-use it each time.
2606 new-frame Make a new frame each time. Note that in this case
2607 previously-made indirect buffers are kept, and you need to
2608 kill these buffers yourself."
2618 "Options concerning the daily/weekly agenda."
2623 "Number of days to include in overview display.
2624 Should be 1 or 7."
2629 "Non-nil means, start the overview always on the specified weekday.
2630 0 denotes Sunday, 1 denotes Monday etc.
2631 When nil, always start on the current day."
2637 "Non-nil means, `org-agenda' shows every day in the selected range.
2638 When nil, only the days which actually have entries are shown."
2643 "Format string for displaying dates in the agenda.
2644 Used by the daily/weekly agenda and by the timeline. This should be
2645 a format string understood by `format-time-string', or a function returning
2646 the formatted date as a string. The function must take a single argument,
2647 a calendar-style date list like (month day year)."
2654 "Format a date string for display in the daily/weekly agenda, or timeline.
2655 This function makes sure that dates are aligned for easy reading."
2663 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2668 "Set means weekly/daily agenda will always contain all TODO entries.
2669 The TODO entries will be listed at the top of the agenda, before
2670 the entries for specific days."
2675 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2676 When nil, only one occurence is shown, either today or the
2677 nearest into the future."
2682 "No. of days before expiration during which a deadline becomes active.
2683 This variable governs the display in sparse trees and in the agenda.
2684 When negative, it means use this number (the absolute value of it)
2685 even if a deadline has a different individual lead time specified."
2691 "No. of days to continue listing scheduled items that are not marked DONE.
2692 When an item is scheduled on a date, it shows up in the agenda on this
2693 day and will be listed until it is marked done for the number of days
2694 given here."
2699 "Options concerning the time grid in the Org-mode Agenda."
2704 "Non-nil means, show a time grid in the agenda schedule.
2705 A time grid is a set of lines for specific times (like every two hours between
2706 8:00 and 20:00). The items scheduled for a day at specific times are
2707 sorted in between these lines.
2708 For details about when the grid will be shown, and what it will look like, see
2709 the variable `org-agenda-time-grid'."
2715 "----------------"
2718 "The settings for time grid for agenda display.
2719 This is a list of three items. The first item is again a list. It contains
2720 symbols specifying conditions when the grid should be displayed:
2722 daily if the agenda shows a single day
2723 weekly if the agenda shows an entire week
2724 today show grid on current date, independent of daily/weekly display
2725 require-timed show grid only if at least one item has a time specification
2727 The second item is a string which will be places behing the grid time.
2729 The third item is a list of integers, indicating the times that should have
2730 a grid line."
2732 :type
2739 require-timed)
2741 remove-match))
2746 "Options concerning sorting in the Org-mode Agenda."
2762 "Sorting structure for the agenda items of a single day.
2763 This is a list of symbols which will be used in sequence to determine
2764 if an entry should be listed before another entry. The following
2765 symbols are recognized:
2767 time-up Put entries with time-of-day indications first, early first
2768 time-down Put entries with time-of-day indications first, late first
2769 category-keep Keep the default order of categories, corresponding to the
2770 sequence in `org-agenda-files'.
2771 category-up Sort alphabetically by category, A-Z.
2772 category-down Sort alphabetically by category, Z-A.
2773 tag-up Sort alphabetically by last tag, A-Z.
2774 tag-down Sort alphabetically by last tag, Z-A.
2775 priority-up Sort numerically by priority, high priority last.
2776 priority-down Sort numerically by priority, high priority first.
2778 The different possibilities will be tried in sequence, and testing stops
2780 '(time-up category-keep priority-down)
2781 means: Pull out all entries having a specified time of day and sort them,
2782 in order to make a time schedule for the current day the first thing in the
2783 agenda listing for the day. Of the entries without a time indication, keep
2784 the grouped in categories, don't sort the categories, but keep them in
2785 the sequence given in `org-agenda-files'. Within each category sort by
2786 priority.
2788 Leaving out `category-keep' would mean that items will be sorted across
2789 categories by priority.
2791 Instead of a single list, this can also be a set of list for specific
2792 contents, with a context symbol in the car of the list, any of
2793 `agenda', `todo', `tags' for the corresponding agenda views."
2806 "Non-nil means, items without time are considered late.
2807 This is only relevant for sorting. When t, items which have no explicit
2808 time like 15:30 will be considered as 99:01, i.e. later than any items which
2809 do have a time. When nil, the default time is before 0:00. You can use this
2810 option to decide if the schedule for today should come before or after timeless
2811 agenda entries."
2816 "Options concerning the entry prefix in the Org-mode agenda display."
2825 "Format specifications for the prefix of items in the agenda views.
2826 An alist with four entries, for the different agenda types. The keys to the
2827 sublists are `agenda', `timeline', `todo', and `tags'. The values
2828 are format strings.
2829 This format works similar to a printf format, with the following meaning:
2832 as given by the CATEGORY keyword or derived from the file name.
2833 %T the *last* tag of the item. Last because inherited tags come
2834 first in the list.
2835 %t the time-of-day specification if one applies to the entry, in the
2836 format HH:MM
2837 %s Scheduling/Deadline information, a short string
2839 All specifiers work basically like the standard `%s' of printf, but may
2840 contain two additional characters: A question mark just after the `%' and
2841 a whitespace/punctuation character just before the final letter.
2843 If the first character after `%' is a question mark, the entire field
2844 will only be included if the corresponding value applies to the
2845 current entry. This is useful for fields which should have fixed
2846 width when present, but zero width when absent. For example,
2848 day is specified, but will completely disappear in entries which do
2849 not contain a time.
2851 If there is punctuation or whitespace character just before the final
2852 format letter, this character will be appended to the field value if
2855 empty, no additional colon would be interted.
2858 - Indent the line with two space characters
2859 - Give the category in a 12 chars wide field, padded with whitespace on
2860 the right (because of `-'). Append a colon if there is a category
2861 (because of `:').
2862 - If there is a time-of-day, put it into a 12 chars wide field. If no
2863 time, don't put in an empty field, just skip it (because of '?').
2864 - Finally, put the scheduling information and append a whitespace.
2866 As another example, if you don't want the time-of-day of entries in
2867 the prefix, you could use:
2871 See also the variables `org-agenda-remove-times-when-in-prefix' and
2872 `org-agenda-remove-tags'."
2883 "The compiled version of the most recently used prefix format.
2887 "Format for the TODO keyword in agenda lines.
2889 to occupy a fixed space in the agenda display."
2894 "Text preceeding scheduled items in the agenda view.
2895 This is a list with two strings. The first applies when the item is
2896 scheduled on the current day. The second applies when it has been scheduled
2897 previously, it may contain a %d to capture how many days ago the item was
2898 scheduled."
2905 "Text preceeding deadline items in the agenda view.
2906 This is a list with two strings. The first applies when the item has its
2907 deadline on the current day. The second applies when it is in the past or
2908 in the future, it may contain %d to capture how many days away the deadline
2909 is (was)."
2916 "Non-nil means, remove duplicate time specifications in agenda items.
2917 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2918 time-of-day specification in a headline or diary entry is extracted and
2919 placed into the prefix. If this option is non-nil, the original specification
2920 \(a timestamp or -range, or just a plain time(range) specification like
2921 11:30-4pm) will be removed for agenda display. This makes the agenda less
2922 cluttered.
2923 The option can be t or nil. It may also be the symbol `beg', indicating
2924 that the time should only be removed what it is located at the beginning of
2925 the headline/diary entry."
2934 "Default duration for appointments that only have a starting time.
2935 When nil, no duration is specified in such cases.
2936 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2944 "Non-nil means, remove the tags from the headline copy in the agenda.
2945 When this is the symbol `prefix', only remove tags when
2946 `org-agenda-prefix-format' contains a `%T' specifier."
2958 "Shift tags in agenda items to this column.
2959 If this number is positive, it specifies the column. If it is negative,
2960 it means that the tags should be flushright to that column. For example,
2961 -80 works well for a normal 80 character screen."
2969 "Non-nil means, highlight low and high priorities in agenda.
2970 When t, the highest priority entries are bold, lowest priority italic.
2971 This may also be an association list of priority faces. The face may be
2982 "Options for embedding LaTeX code into Org-mode"
2990 "Options for creating images from LaTeX fragments.
2991 This is a property list with the following properties:
2993 `default' means use the forground of the default face.
2995 `default' means use the background of the default face.
2996 :scale a scaling factor for the size of the images
2997 :html-foreground, :html-background, :html-scale
2998 The same numbers for HTML export.
2999 :matchers a list indicating which matchers should be used to
3000 find LaTeX fragments. Valid members of this list are:
3017 "The document header used for processing LaTeX fragments."
3022 "Options for exporting org-listings."
3027 "General options for exporting Org-mode files."
3031 ;; FIXME
3036 When this option is turned on, these strings will be exported as:
3038 Org HTML LaTeX
3039 -----+----------+--------
3041 -- – --
3042 --- — ---
3043 ... … \ldots
3060 "Terms used in export text, translated to different languages.
3061 Use the variable `org-export-default-language' to set the language,
3062 or use the +OPTION lines for a per-file setting."
3072 "The default language of HTML export, as a string.
3073 This should have an association in `org-export-language-setup'."
3078 "Non-nil means, skip all text before the first headline when exporting.
3079 When nil, that text is exported as well."
3084 "The last level which is still exported as a headline.
3085 Inferior levels will produce itemize lists when exported.
3086 Note that a numeric prefix argument to an exporter function overrides
3087 this setting.
3094 "Non-nil means, add section numbers to headlines when exporting.
3101 "Non-nil means, create a table of contents in exported files.
3102 The TOC contains headlines with levels up to`org-export-headline-levels'.
3103 When an integer, include levels up to N in the toc, this may then be
3104 different from `org-export-headline-levels', but it will not be allowed
3105 to be larger than the number of headline levels.
3106 When nil, no table of contents is made.
3109 ASCII export, and with red color in HTML output, if the option
3110 `org-export-mark-todo-in-toc' is set.
3112 In HTML output, the TOC will be clickable.
3123 "Non-nil means, mark TOC lines that contain any open TODO items."
3128 "Non-nil means, preserve all line breaks when exporting.
3129 Normally, in HTML output paragraphs will be reformatted. In ASCII
3130 export, line breaks will always be preserved, regardless of this variable.
3137 "Whether subtrees with the ARCHIVE tag should be exported.
3138 This can have three different values
3139 nil Do not export, pretend this tree is not present
3140 t Do export the entire tree
3141 headline Only export the headline, but skip the tree below it."
3150 "Non-nil means, insert author name and email into the exported file.
3152 This option can also be set with the +OPTIONS line,
3158 "Non-nil means, insert a time stamp into the exported file.
3159 The time stamp shows when the file was created.
3161 This option can also be set with the +OPTIONS line,
3167 "If nil, do not export time stamps and associated keywords."
3172 "If nil, remove timestamps from the table of contents entries."
3177 "If nil, do not export tags, just remove them from headlines.
3178 If this is the symbol `not-in-toc', tags will be removed from table of
3179 contents entries, but still be shown in the headlines of the document.
3189 "Non-nil means, export with drawers like the property drawer.
3190 When t, all drawers are exported. This may also be a list of
3191 drawer names to export."
3200 "Options for translating special ascii sequences for the export backends."
3205 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
3206 If the export target supports emphasizing text, the word will be
3207 typeset in bold, italic, or underlined, respectively. Works only for
3208 single words, but you can say: I *really* *mean* *this*.
3209 Not all export backends support this.
3216 "If nil, export [1] as a footnote marker.
3217 Lines starting with [1] will be formatted as footnotes.
3225 When this option is turned on, you can use TeX-like syntax for sub- and
3227 considered as a single item - so grouping with {} is normally not
3228 needed. For example, the following things will be parsed as single
3229 sub- or superscripts.
3231 10^24 or 10^tau several digits will be considered 1 item.
3232 10^-12 or 10^-tau a leading sign with digits or a word
3233 x^2-y^3 will be read as x^2 - y^3, because items are
3234 terminated by almost any nonword/nondigit char.
3235 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3237 Still, ambiguity is possible - so when in doubt use {} to enclose the
3238 sub/superscript. If you set this variable to the symbol `{}',
3239 the braces are *required* in order to trigger interpretations as
3241 frequently in plain text.
3243 Not all export backends support this, but HTML does.
3254 When this option is turned on, these strings will be exported as:
3257 -- : –
3258 --- : —
3260 Not all export backends support this, but HTML does.
3267 "Non-nil means, interpret simple TeX-like macros when exporting.
3269 No only real TeX macros will work here, but the standard HTML entities
3270 for math can be used as macro names as well. For a list of supported
3271 names in HTML export, see the constant `org-html-entities'.
3272 Not all export backends support this.
3280 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3282 the first non-white thing on a line. It will also find the math delimiters
3284 display math.
3293 This can be used to have pre-formatted text, fragments of code etc. For
3294 example:
3295 : ;; Some Lisp examples
3296 : (while (defc cnt)
3297 : (ding))
3298 will be looking just like this in also HTML. See also the QUOTE keyword.
3299 Not all export backends support this.
3306 "Number of stacked braces for sub/superscript matching.
3307 This has to be set before loading org.el to be effective."
3312 "Options for exporting tables in Org-mode."
3318 For example:
3320 | Name | Address | Birthday |
3321 |-------------+----------+-----------|
3322 | Arthur Dent | England | 29.2.2100 |
3324 Not all export backends support this.
3331 "Non-nil means, highlight the first table line.
3332 In HTML export, this means use <th> instead of <td>.
3333 In tables created with table.el, this applies to the first table line.
3334 In Org-mode tables, all lines before the first horizontal separator
3335 line will be formatted with <th> tags."
3340 "Remove special lines and marking characters in calculating tables.
3341 This removes the special marking character column from tables that are set
3342 up for spreadsheet calculations. It also removes the entire lines
3343 marked with `!', `_', or `^'. The lines with `$' are kept, because
3344 the values of constants may be useful to have."
3349 "Non-nil means, always export tables created with table.el natively.
3350 Natively means, use the HTML code generator in table.el.
3351 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3352 the table does not use row- or column-spanning). This has the
3353 advantage, that the automatic HTML conversions for math symbols and
3354 sub/superscripts can be applied. Org-mode's HTML generator is also
3355 much faster."
3360 "Options specific for ASCII export of Org-mode files."
3365 "Characters for underlining headings in ASCII export.
3366 In the given sequence, these characters will be used for level 1, 2, ..."
3371 "Bullet characters for headlines converted to lists in ASCII export.
3372 The first character is used for the first lest level generated in this
3373 way, and so on. If there are more levels than characters given here,
3374 the list will be repeated.
3375 Note that plain lists will keep the same bullets as the have in the
3376 Org-mode file."
3381 "Options specific for XML export of Org-mode files."
3386 "Options specific for HTML export of Org-mode files."
3391 ""
3396 "The extension for exported HTML files."
3402 html {
3403 font-family: Times, serif;
3404 font-size: 12pt;
3405 }
3406 .title { text-align: center; }
3407 .todo { color: red; }
3408 .done { color: green; }
3409 .timestamp { color: grey }
3410 .timestamp-kwd { color: CadetBlue }
3411 .tag { background-color:lightblue; font-weight:normal }
3412 .target { background-color: lavender; }
3413 pre {
3414 border: 1pt solid #AEBDCC;
3415 background-color: #F3F5F7;
3416 padding: 5pt;
3417 font-family: courier, monospace;
3418 }
3419 table { border-collapse: collapse; }
3420 td, th {
3421 vertical-align: top;
3422 <!--border: 1pt solid #ADB9CC;-->
3423 }
3424 </style>"
3425 "The default style specification for exported HTML files.
3426 Since there are different ways of setting style information, this variable
3427 needs to contain the full HTML structure to provide a style, including the
3428 surrounding HTML tags. The style specifications should include definitions
3429 for new classes todo, done, title, and deadline. For example, legal values
3430 would be:
3433 p { font-weight: normal; color: gray; }
3434 h1 { color: black; }
3435 .title { text-align: center; }
3436 .todo, .deadline { color: red; }
3437 .done { color: green; }
3438 </style>
3440 or, if you want to keep the style in a file,
3444 As the value of this option simply gets inserted into the HTML <head> header,
3451 "Format for typesetting the document title in HTML export."
3456 "The <H> level for level 1 headings in HTML export."
3461 "Non-nil means, make file links to `file.org' point to `file.html'.
3462 When org-mode is exporting an org-mode file to HTML, links to
3463 non-html files are directly put into a href tag in HTML.
3464 However, links to other Org-mode files (recognized by the
3465 extension `.org.) should become links to the corresponding html
3466 file, assuming that the linked org-mode file will also be
3467 converted to HTML.
3468 When nil, the links still point to the plain `.org' file."
3473 "Non-nil means, inline images into exported HTML pages.
3474 This is done using an <img> tag. When nil, an anchor with href is used to
3475 link to the image. If this option is `maybe', then images in links with
3476 an empty description will be inlined, while images with a description will
3477 be linked only."
3483 ;; FIXME: rename
3485 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3486 When nil, these tags will be exported as plain text and therefore
3487 not be interpreted by a browser.
3495 "The HTML tag that is used to start a table.
3496 This must be a <table> tag, but you may change the options like
3497 borders and spacing."
3502 "The opening tag for table header fields.
3503 This is customizable so that alignment options can be specified."
3508 "The opening tag for table data fields.
3509 This is customizable so that alignment options can be specified."
3514 "If non-nil, write `org-export-html-html-helper-timestamp'
3515 into the exported HTML text. Otherwise, the buffer will just be saved
3516 to a file."
3522 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3527 "Options specific for iCalendar export of Org-mode files."
3532 "The file name for the iCalendar file covering all agenda files.
3534 The file name should be absolute, the file will be overwritten without warning."
3539 "Non-nil means, export to iCalendar files should also cover TODO items."
3547 "Non-nil means, export to iCalendar files should also cover sexp entries.
3548 These are entries like in the diary, but directly in an Org-mode file."
3553 "Amount of text below headline to be included in iCalendar export.
3554 This is a number of characters that should maximally be included.
3555 Properties, scheduling and clocking lines will always be removed.
3556 The text will be inserted into the DESCRIPTION field."
3564 "Calendar name for the combined iCalendar representing all agenda files."
3569 "Font-lock settings for highlighting in Org-mode."
3574 "Non-nil means fontify only the stars in each headline.
3575 When nil, the entire headline is fontified.
3576 Changing it requires restart of `font-lock-mode' to become effective
3577 also in regions already fontified."
3582 "Non-nil means, hide the first N-1 stars in a headline.
3583 This works by using the face `org-hide' for these stars. This
3584 face is white for a light background, and black for a dark
3585 background. You may have to customize the face `org-hide' to
3586 make this work.
3587 Changing it requires restart of `font-lock-mode' to become effective
3588 also in regions already fontified.
3589 You may also set this on a per-file basis by adding one of the following
3590 lines to the buffer:
3592 #+STARTUP: hidestars
3593 #+STARTUP: showstars"
3598 "Non-nil means, change the face of a headline if it is marked DONE.
3599 Normally, only the TODO/DONE keyword indicates the state of a headline.
3600 When this is non-nil, the headline after the keyword is set to the
3601 `org-headline-done' as an additional indication."
3606 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3607 Changing this variable requires a restart of Emacs to take effect."
3612 "Non-nil means, fontify what is treated specially by the exporters."
3617 "Non-nil mean font-lock should hide the emphasis marker characters."
3628 "Set variable and compute the emphasis regular expression."
3632 org-emphasis-alist org-emphasis-regexp-components)
3645 ;; make sure special characters appear at the right position in the class
3657 ;; Make the regexp
3665 body1
3677 body1
3685 "Components used to build the regular expression for emphasis.
3686 This is a list with 6 entries. Terminology: In an emphasis string
3690 specify what is allowed/forbidden in each part:
3692 pre Chars allowed as prematch. Beginning of line will be allowed too.
3693 post Chars allowed as postmatch. End of line will be allowed too.
3694 border The chars *forbidden* as border characters.
3696 non-shy groups here, and don't allow newline here.
3697 newline The maximum number of newlines allowed in an emphasis exp.
3699 Use customize to modify this, or restart Emacs after changing it."
3717 )
3718 "Special syntax for emphasized text.
3719 Text starting and ending with a special character will be emphasized, for
3720 example *bold*, _underlined_ and /italic/. This variable sets the marker
3721 characters, the face to be used by font-lock for highlighting in Org-mode
3722 Emacs buffers, and the HTML tags to be used for this.
3723 Use customize to modify this, or restart Emacs after changing it."
3736 ;;; The faces
3739 "Faces in Org-mode."
3744 "Make a compatible face specification.
3745 If INHERITS is an existing face and if the Emacs version supports it,
3746 just inherit the face. If not, use SPECS to define the face.
3747 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3748 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3749 to the top of the list. The `min-colors' attribute will be removed from
3750 any other entries, and any resulting duplicates will be removed entirely."
3754 ;; In Emacs 23, we use inheritance where possible.
3755 ;; We only do this in Emacs 23, because only there the outline
3756 ;; faces have been changed to the original org-mode-level-faces.
3759 ;; These do not understand the `min-colors' attribute.
3778 "Face used to hide leading stars in headlines.
3779 The forground color of this face should be equal to the background
3780 color of the frame."
3791 "Face used for level 1 headlines."
3801 "Face used for level 2 headlines."
3813 "Face used for level 3 headlines."
3825 "Face used for level 4 headlines."
3833 "Face used for level 5 headlines."
3841 "Face used for level 6 headlines."
3849 "Face used for level 7 headlines."
3857 "Face used for level 8 headlines."
3865 "Face used for special keywords."
3876 "Face used for drawers."
3880 "Face used for the value of a property."
3892 "Face for column display of entry properties."
3896 ;; Make sure that a fixed-width face is used when we have a column table.
3908 "Face for deadlines and TODO keywords."
3921 "Face for headline with the ARCHIVE tag."
3928 "Face for links."
3935 "Face for the ellipsis in folded text."
3942 "Face for links."
3949 "Face for links."
3956 "Face for links."
3961 "Face for tags."
3971 "Face for TODO keywords."
3980 "Face used for todo keywords that indicate DONE items."
3988 "Face used to indicate that a headline is DONE.
3989 This face is only used if `org-fontify-done-headline' is set. If applies
3990 to the part of the headline after the DONE keyword."
3994 "Faces for specific TODO keywords.
3995 This is a list of cons cells, with TODO keywords in the car
3996 and faces in the cdr. The face can be a symbol, or a property
4013 "Face used for tables."
4023 "Face for formulas."
4036 "Face for fixed-with text like code snippets."
4050 "Face for fixed-with text like code snippets."
4062 "Face used in agenda for captions and dates."
4071 "Face for items scheduled for a certain day."
4081 "Face for items scheduled previously, and not yet done."
4091 "Face for items scheduled previously, and not yet done."
4098 "Faces for showing deadlines in the agenda.
4099 This is a list of cons cells. The cdr of each cell is a face to be used,
4101 Each car is a fraction of the head-warning time that must have passed for
4102 this the face in the cdr to be used for display. The numbers must be
4103 given in descending order. The head-warning time is normally taken
4104 from `org-deadline-warning-days', but can also be specified in the deadline
4105 timestamp itself, like this:
4107 DEADLINE: <2007-08-13 Mon -8d>
4109 You may use d for days, w for weeks, m for months and y for years. Months
4110 and years will only be treated in an approximate fashion (30.4 days for a
4111 month and 365.24 days for a year)."
4119 ;; FIXME: this is not a good face yet.
4128 "Face for showing the agenda restriction lock."
4136 "Face used for time grids."
4141 org-level-5 org-level-6 org-level-7 org-level-8
4142 ))
4145 "The number different faces to be used for headlines.
4146 Org-mode defines 8 different headline faces, so this can be at most 8.
4147 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
4151 ;;; Functions and variables from ther packages
4152 ;; Declared here to avoid compiler warnings
4158 ;; XEmacs only
4164 ;; Emacs only
4167 ;; Various packages
4168 ;; FIXME: get the argument lists for the UNKNOWN stuff
4224 (declare-function mh-normalize-folder-name "mh-utils" (folder &optional empty-string-okay dont-remove-trailing-slash return-nil-if-folder-empty))
4225 (declare-function mh-search "mh-search" (folder search-regexp &optional redo-search-flag window-config))
4256 (declare-function vm-get-header-contents "ext:vm-summary" (message header-name-regexp &optional clump-sep))
4267 ;; backward compatibility to old version of wl
4270 (declare-function wl-summary-goto-folder-subr "ext:wl-summary" (&optional name scan-type other-window sticky interactive scoring force-exit))
4283 ;;; Variables for pre-computed regular expressions, all buffer local
4298 "Matches a headline and puts everything into groups:
4299 group 1: the stars
4300 group 2: The todo keyword, maybe
4301 group 3: Priority cookie
4302 group 4: True headline
4306 "Matches a headline and puts TODO state into group 2 if present.
4351 rear-nonsticky t mouse-map t fontified t)
4358 s)
4365 s)
4374 "Modified `buffer-invisibility-spec' for Emacs 21.
4375 Some ops with invisible text do not work correctly on Emacs 21. For these
4376 we turn off invisibility temporarily. Use this in a `let' form."
4380 "Make VAR local in current buffer and set it to VALUE."
4384 "Check if the current buffer is in Org-mode."
4388 "Return the last element of LIST."
4421 "Variable associated with STARTUP options for org-mode.
4422 Each element is a list of three items: The startup options as written
4423 in the #+STARTUP line, the corresponding variable, and the value to
4424 set this variable to if the option is found. An optional forth element PUSH
4428 "Precompute regular expressions for current buffer."
4443 kwds kws0 kwsa key log value cat arch tags const links hw dws
4444 tail sep kws1 prio props drawers)
4468 links)))
4474 props)))
4481 l var val)
4496 )))
4510 ;; Process the TODO keywords
4512 ;; Use the global values as if they had been given locally.
4523 kwsa nil
4526 ;; 1 2
4534 kw)
4536 kws0)
4553 ;; Process the constants
4561 ;; Process the tags.
4571 tgs))
4579 ;; Compute the regular expressions and other local variables
4584 org-drawer-regexp
4588 org-not-done-keywords
4590 org-todo-regexp
4593 org-not-done-regexp
4597 org-todo-line-regexp
4601 org-complex-heading-regexp
4606 org-nl-done-regexp
4610 org-todo-line-tags-regexp
4615 org-looking-at-done-regexp
4620 org-deadline-time-regexp
4622 org-deadline-line-regexp
4624 org-scheduled-regexp
4626 org-scheduled-time-regexp
4628 org-closed-time-regexp
4630 org-keyword-time-regexp
4636 org-keyword-time-not-clock-regexp
4642 org-maybe-keyword-time-regexp
4648 org-planning-or-clock-line-re
4653 )
4658 "Extract the log state setting from a TODO keyword string.
4675 x))
4676 list))
4678 ;; FIXME: this could be done much better, using second characters etc.
4680 "Assign fast keys to a keyword-key alist.
4681 Respect keys that are already there."
4691 ;; automatically assign a character.
4703 ;;; Some variables ujsed in various places
4708 "Function to be called when `C-c C-c' is used.
4712 ;; FIXME: Occasionally check by commenting these, to make sure
4713 ;; no other functions uses these, forgetting to let-bind them.
4720 ;; Defined somewhere in this file, but used before definition.
4733 ;;;; Emacs/XEmacs compatibility
4735 ;; Overlay compatibility functions
4753 "Make overlay OVL display TEXT with face FACE."
4763 "Make overlay OVL display TEXT with face FACE."
4786 "Find all overlays specifying PROP at POS or point.
4787 If DELETE is non-nil, delete all those overlays."
4789 ov found)
4793 found))
4795 ;; Region compatibility
4798 "Add-hook, compatible with both Emacsen."
4807 "Is `transient-mark-mode' on and the region active?
4808 Works on both Emacs and XEmacs."
4810 nil
4817 ;; Invisibility compatibility
4820 "Add elements to `buffer-invisibility-spec'.
4821 See documentation for `buffer-invisibility-spec' for the kind of elements
4822 that can be added."
4833 "Remove elements from `buffer-invisibility-spec'."
4841 "Is ARG a member of `buffer-invisibility-spec'?"
4844 nil))
4846 ;;;; Define the Org-mode
4849 (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."))
4852 ;; We use a before-change function to check if a table might need
4853 ;; an update.
4855 "Indicates that a table might need an update.
4856 This variable is set by `org-before-change-function'.
4865 ;;;###autoload
4867 "Outline-based notes management and organizer, alias
4870 Org-mode develops organizational tasks around a NOTES file which
4871 contains information about projects as plain text. Org-mode is
4872 implemented on top of outline-mode, which is ideal to keep the content
4873 of large files well structured. It supports ToDo items, deadlines and
4874 time stamps, which magically appear in the diary listing of the Emacs
4875 calendar. Tables are easily created with a built-in table editor.
4876 Plain text URL-like links connect to websites, emails (VM), Usenet
4877 messages (Gnus), BBDB entries, and any files related to the project.
4878 For printing and sharing of notes, an Org-mode file (or a part of it)
4879 can be exported as a structured ASCII or HTML file.
4881 The following commands are available:
4885 ;; Get rid of Outline menus, they are not needed
4886 ;; Need to do this here because define-derived-mode sets up
4887 ;; the keymap so late. Still, it is a waste to call this each time
4888 ;; we switch another buffer into org-mode.
4891 ;; Assume this is Greg's port, it used easymenu
4914 org-display-table 4
4917 org-ellipsis)))
4921 ;; Calc embedded
4928 ;; Activate before-change-function
4932 ;; Check for running clock before killing a buffer
4934 ;; Paragraphs and auto-filling
4939 ;; Comment characters
4940 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4943 ;; Align options lines
4945 'align-mode-rules-list
4950 ;; Imenu
4954 ;; Make isearch reveal context
4957 ;; Emacs 21 and XEmacs make use of the hook
4959 ;; Emacs 22 deals with this through a special variable
4963 ;; If empty file that did not turn on org-mode automatically, make it to.
4985 "Call COMMAND interactively, but pretend prefix are was ARG."
4991 ;; works also in narrowed buffer, because we start at 1, not point-min
4995 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5005 "Add text properties to entire string, from beginning to end.
5006 PLIST may be a list of properties, PROPS are individual properties and values
5007 that will be added to PLIST. Returns the string that was modified."
5010 string)
5014 ;;;; Font-Lock stuff, including the activators
5019 (org-defkey org-mouse-map
5020 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
5021 (when org-mouse-1-follows-link
5022 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5023 (when org-tab-follows-link
5024 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5025 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5026 (when org-return-follows-link
5027 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
5028 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
5030 (require 'font-lock)
5033 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
5034 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp" "message"))
5035 (defvar org-link-re-with-space nil
5036 "Matches a link with spaces, optional angular brackets around it.")
5037 (defvar org-link-re-with-space2 nil
5038 "Matches a link with spaces, optional angular brackets around it.")
5039 (defvar org-angle-link-re nil
5040 "Matches link with angular brackets, spaces are allowed.")
5041 (defvar org-plain-link-re nil
5042 "Matches plain link, without spaces.")
5043 (defvar org-bracket-link-regexp nil
5044 "Matches a link in double brackets.")
5045 (defvar org-bracket-link-analytic-regexp nil
5046 "Regular expression used to analyze links.
5047 Here is what the match groups contain after a match:
5048 1: http:
5049 2: http
5050 3: path
5051 4: [desc]
5052 5: desc")
5053 (defvar org-any-link-re nil
5054 "Regular expression matching any link.")
5056 (defun org-make-link-regexps ()
5057 "Update the link regular expressions.
5058 This should be called after the variable `org-link-types' has changed."
5059 (setq org-link-re-with-space
5060 (concat
5063 "[^" org-non-link-chars "]*"
5065 org-link-re-with-space2
5066 (concat
5071 org-angle-link-re
5072 (concat
5075 "[^" org-non-link-chars "]*"
5077 org-plain-link-re
5078 (concat
5081 org-bracket-link-regexp
5083 org-bracket-link-analytic-regexp
5084 (concat
5091 org-any-link-re
5096 (org-make-link-regexps)
5099 "Regular expression for fast time stamp matching.")
5101 "Regular expression for fast time stamp matching.")
5102 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5103 "Regular expression matching time strings for analysis.
5104 This one does not require the space after the date.")
5105 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5106 "Regular expression matching time strings for analysis.")
5108 "Regular expression matching time stamps, with groups.")
5110 "Regular expression matching time stamps (also [..]), with groups.")
5111 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5112 "Regular expression matching a time stamp range.")
5113 (defconst org-tr-regexp-both
5114 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5115 "Regular expression matching a time stamp range.")
5118 "Regular expression matching a time stamp or time stamp range.")
5121 "Regular expression matching a time stamp or time stamp range.
5122 The time stamps may be either active or inactive.")
5124 (defvar org-emph-face nil)
5126 (defun org-do-emphasis-faces (limit)
5127 "Run through the buffer and add overlays to links."
5128 (let (rtn)
5129 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5130 (if (not (= (char-after (match-beginning 3))
5131 (char-after (match-beginning 4))))
5132 (progn
5133 (setq rtn t)
5134 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5135 'face
5136 (nth 1 (assoc (match-string 3)
5137 org-emphasis-alist)))
5138 (add-text-properties (match-beginning 2) (match-end 2)
5139 '(font-lock-multiline t))
5140 (when org-hide-emphasis-markers
5141 (add-text-properties (match-end 4) (match-beginning 5)
5142 '(invisible org-link))
5143 (add-text-properties (match-beginning 3) (match-end 3)
5144 '(invisible org-link)))))
5145 (backward-char 1))
5146 rtn))
5148 (defun org-emphasize (&optional char)
5149 "Insert or change an emphasis, i.e. a font like bold or italic.
5150 If there is an active region, change that region to a new emphasis.
5151 If there is no region, just insert the marker characters and position
5152 the cursor between them.
5153 CHAR should be either the marker character, or the first character of the
5154 HTML tag associated with that emphasis. If CHAR is a space, the means
5155 to remove the emphasis of the selected region.
5156 If char is not given (for example in an interactive call) it
5157 will be prompted for."
5158 (interactive)
5159 (let ((eal org-emphasis-alist) e det
5160 (erc org-emphasis-regexp-components)
5161 (prompt "")
5162 (string "") beg end move tag c s)
5163 (if (org-region-active-p)
5164 (setq beg (region-beginning) end (region-end)
5165 string (buffer-substring beg end))
5166 (setq move t))
5168 (while (setq e (pop eal))
5169 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
5170 c (aref tag 0))
5171 (push (cons c (string-to-char (car e))) det)
5172 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
5173 (substring tag 1)))))
5174 (unless char
5175 (message "%s" (concat "Emphasis marker or tag:" prompt))
5176 (setq char (read-char-exclusive)))
5177 (setq char (or (cdr (assoc char det)) char))
5178 (if (equal char ?\ )
5179 (setq s "" move nil)
5180 (unless (assoc (char-to-string char) org-emphasis-alist)
5182 (setq s (char-to-string char)))
5183 (while (and (> (length string) 1)
5184 (equal (substring string 0 1) (substring string -1))
5185 (assoc (substring string 0 1) org-emphasis-alist))
5186 (setq string (substring string 1 -1)))
5187 (setq string (concat s string s))
5188 (if beg (delete-region beg end))
5189 (unless (or (bolp)
5191 (char-to-string (char-before (point)))))
5192 (insert " "))
5194 (char-to-string (char-after (point))))
5195 (insert " ") (backward-char 1))
5196 (insert string)
5197 (and move (backward-char 1))))
5199 (defconst org-nonsticky-props
5200 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
5203 (defun org-activate-plain-links (limit)
5204 "Run through the buffer and add overlays to links."
5205 (catch 'exit
5206 (let (f)
5207 (while (re-search-forward org-plain-link-re limit t)
5208 (setq f (get-text-property (match-beginning 0) 'face))
5209 (if (or (eq f 'org-tag)
5210 (and (listp f) (memq 'org-tag f)))
5211 nil
5212 (add-text-properties (match-beginning 0) (match-end 0)
5213 (list 'mouse-face 'highlight
5214 'rear-nonsticky org-nonsticky-props
5215 'keymap org-mouse-map
5216 ))
5217 (throw 'exit t))))))
5219 (defun org-activate-code (limit)
5221 (unless (get-text-property (match-beginning 1) 'face)
5222 (remove-text-properties (match-beginning 0) (match-end 0)
5223 '(display t invisible t intangible t))
5224 t)))
5226 (defun org-activate-angle-links (limit)
5227 "Run through the buffer and add overlays to links."
5228 (if (re-search-forward org-angle-link-re limit t)
5229 (progn
5230 (add-text-properties (match-beginning 0) (match-end 0)
5231 (list 'mouse-face 'highlight
5232 'rear-nonsticky org-nonsticky-props
5233 'keymap org-mouse-map
5234 ))
5235 t)))
5237 (defmacro org-maybe-intangible (props)
5238 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
5239 In emacs 21, invisible text is not avoided by the command loop, so the
5240 intangible property is needed to make sure point skips this text.
5241 In Emacs 22, this is not necessary. The intangible text property has
5242 led to problems with flyspell. These problems are fixed in flyspell.el,
5243 but we still avoid setting the property in Emacs 22 and later.
5244 We use a macro so that the test can happen at compilation time."
5245 (if (< emacs-major-version 22)
5246 `(append '(intangible t) ,props)
5247 props))
5249 (defun org-activate-bracket-links (limit)
5250 "Run through the buffer and add overlays to bracketed links."
5251 (if (re-search-forward org-bracket-link-regexp limit t)
5252 (let* ((help (concat "LINK: "
5253 (org-match-string-no-properties 1)))
5254 ;; FIXME: above we should remove the escapes.
5255 ;; but that requires another match, protecting match data,
5256 ;; a lot of overhead for font-lock.
5257 (ip (org-maybe-intangible
5258 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
5259 'keymap org-mouse-map 'mouse-face 'highlight
5260 'font-lock-multiline t 'help-echo help)))
5261 (vp (list 'rear-nonsticky org-nonsticky-props
5262 'keymap org-mouse-map 'mouse-face 'highlight
5263 ' font-lock-multiline t 'help-echo help)))
5264 ;; We need to remove the invisible property here. Table narrowing
5265 ;; may have made some of this invisible.
5266 (remove-text-properties (match-beginning 0) (match-end 0)
5267 '(invisible nil))
5268 (if (match-end 3)
5269 (progn
5270 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5271 (add-text-properties (match-beginning 3) (match-end 3) vp)
5272 (add-text-properties (match-end 3) (match-end 0) ip))
5273 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5274 (add-text-properties (match-beginning 1) (match-end 1) vp)
5275 (add-text-properties (match-end 1) (match-end 0) ip))
5276 t)))
5278 (defun org-activate-dates (limit)
5279 "Run through the buffer and add overlays to dates."
5280 (if (re-search-forward org-tsr-regexp-both limit t)
5281 (progn
5282 (add-text-properties (match-beginning 0) (match-end 0)
5283 (list 'mouse-face 'highlight
5284 'rear-nonsticky org-nonsticky-props
5285 'keymap org-mouse-map))
5286 (when org-display-custom-times
5287 (if (match-end 3)
5288 (org-display-custom-time (match-beginning 3) (match-end 3)))
5289 (org-display-custom-time (match-beginning 1) (match-end 1)))
5290 t)))
5292 (defvar org-target-link-regexp nil
5293 "Regular expression matching radio targets in plain text.")
5295 "Regular expression matching a link target.")
5297 "Regular expression matching a radio target.")
5298 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5299 "Regular expression matching any target.")
5301 (defun org-activate-target-links (limit)
5302 "Run through the buffer and add overlays to target matches."
5303 (when org-target-link-regexp
5304 (let ((case-fold-search t))
5305 (if (re-search-forward org-target-link-regexp limit t)
5306 (progn
5307 (add-text-properties (match-beginning 0) (match-end 0)
5308 (list 'mouse-face 'highlight
5309 'rear-nonsticky org-nonsticky-props
5310 'keymap org-mouse-map
5311 'help-echo "Radio target link"
5312 'org-linked-text t))
5313 t)))))
5315 (defun org-update-radio-target-regexp ()
5316 "Find all radio targets in this file and update the regular expression."
5317 (interactive)
5318 (when (memq 'radio org-activate-links)
5319 (setq org-target-link-regexp
5320 (org-make-target-link-regexp (org-all-targets 'radio)))
5321 (org-restart-font-lock)))
5323 (defun org-hide-wide-columns (limit)
5324 (let (s e)
5325 (setq s (text-property-any (point) (or limit (point-max))
5326 'org-cwidth t))
5327 (when s
5328 (setq e (next-single-property-change s 'org-cwidth))
5329 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
5330 (goto-char e)
5331 t)))
5333 (defvar org-latex-and-specials-regexp nil
5334 "Regular expression for highlighting export special stuff.")
5335 (defvar org-match-substring-regexp)
5336 (defvar org-match-substring-with-braces-regexp)
5337 (defvar org-export-html-special-string-regexps)
5339 (defun org-compute-latex-and-specials-regexp ()
5340 "Compute regular expression for stuff treated specially by exporters."
5341 (if (not org-highlight-latex-fragments-and-specials)
5342 (org-set-local 'org-latex-and-specials-regexp nil)
5343 (let*
5344 ((matchers (plist-get org-format-latex-options :matchers))
5345 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
5346 org-latex-regexps)))
5347 (options (org-combine-plists (org-default-export-plist)
5348 (org-infile-export-plist)))
5349 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
5350 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
5351 (org-export-with-TeX-macros (plist-get options :TeX-macros))
5352 (org-export-html-expand (plist-get options :expand-quoted-html))
5353 (org-export-with-special-strings (plist-get options :special-strings))
5354 (re-sub
5355 (cond
5356 ((equal org-export-with-sub-superscripts '{})
5357 (list org-match-substring-with-braces-regexp))
5358 (org-export-with-sub-superscripts
5359 (list org-match-substring-regexp))
5360 (t nil)))
5361 (re-latex
5362 (if org-export-with-LaTeX-fragments
5363 (mapcar (lambda (x) (nth 1 x)) latexs)))
5364 (re-macros
5365 (if org-export-with-TeX-macros
5367 (regexp-opt
5368 (append (mapcar 'car org-html-entities)
5369 (if (boundp 'org-latex-entities)
5370 org-latex-entities nil))
5371 'words))) ; FIXME
5372 ))
5374 (re-special (if org-export-with-special-strings
5375 (mapcar (lambda (x) (car x))
5376 org-export-html-special-string-regexps)))
5377 (re-rest
5378 (delq nil
5379 (list
5381 ))))
5382 (org-set-local
5383 'org-latex-and-specials-regexp
5384 (mapconcat 'identity (append re-latex re-sub re-macros re-special
5387 (defface org-latex-and-export-specials
5388 (let ((font (cond ((assq :inherit custom-face-attributes)
5389 '(:inherit underline))
5390 (t '(:underline t)))))
5391 `((((class grayscale) (background light))
5392 (:foreground "DimGray" ,@font))
5393 (((class grayscale) (background dark))
5394 (:foreground "LightGray" ,@font))
5395 (((class color) (background light))
5396 (:foreground "SaddleBrown"))
5397 (((class color) (background dark))
5398 (:foreground "burlywood"))
5399 (t (,@font))))
5400 "Face used to highlight math latex and other special exporter stuff."
5401 :group 'org-faces)
5403 (defun org-do-latex-and-special-faces (limit)
5404 "Run through the buffer and add overlays to links."
5405 (when org-latex-and-specials-regexp
5406 (let (rtn d)
5407 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
5408 limit t))
5409 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5410 'face))
5411 '(org-code org-verbatim underline)))
5412 (progn
5413 (setq rtn t
5414 d (cond ((member (char-after (1+ (match-beginning 0)))
5415 '(?_ ?^)) 1)
5416 (t 0)))
5417 (font-lock-prepend-text-property
5418 (+ d (match-beginning 0)) (match-end 0)
5419 'face 'org-latex-and-export-specials)
5420 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
5421 '(font-lock-multiline t)))))
5422 rtn)))
5424 (defun org-restart-font-lock ()
5425 "Restart font-lock-mode, to force refontification."
5426 (when (and (boundp 'font-lock-mode) font-lock-mode)
5427 (font-lock-mode -1)
5428 (font-lock-mode 1)))
5430 (defun org-all-targets (&optional radio)
5431 "Return a list of all targets in this file.
5432 With optional argument RADIO, only find radio targets."
5433 (let ((re (if radio org-radio-target-regexp org-target-regexp))
5434 rtn)
5435 (save-excursion
5436 (goto-char (point-min))
5437 (while (re-search-forward re nil t)
5438 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
5439 rtn)))
5441 (defun org-make-target-link-regexp (targets)
5442 "Make regular expression matching all strings in TARGETS.
5443 The regular expression finds the targets also if there is a line break
5444 between words."
5445 (and targets
5446 (concat
5448 (mapconcat
5449 (lambda (x)
5450 (while (string-match " +" x)
5452 x)
5453 targets
5457 (defun org-activate-tags (limit)
5459 (progn
5460 (add-text-properties (match-beginning 1) (match-end 1)
5461 (list 'mouse-face 'highlight
5462 'rear-nonsticky org-nonsticky-props
5463 'keymap org-mouse-map))
5464 t)))
5466 (defun org-outline-level ()
5467 (save-excursion
5468 (looking-at outline-regexp)
5469 (if (match-beginning 1)
5470 (+ (org-get-string-indentation (match-string 1)) 1000)
5471 (1- (- (match-end 0) (match-beginning 0))))))
5473 (defvar org-font-lock-keywords nil)
5476 "Regular expression matching a property line.")
5478 (defun org-set-font-lock-defaults ()
5479 (let* ((em org-fontify-emphasized-text)
5480 (lk org-activate-links)
5481 (org-font-lock-extra-keywords
5482 (list
5483 ;; Headlines
5485 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
5486 ;; Table lines
5488 (1 'org-table t))
5489 ;; Table internals
5493 ;; Drawers
5494 (list org-drawer-regexp '(0 'org-special-keyword t))
5496 ;; Properties
5497 (list org-property-re
5498 '(1 'org-special-keyword t)
5499 '(3 'org-property-value t))
5500 (if org-format-transports-properties-p
5502 ;; Links
5503 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5504 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5505 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5506 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5507 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5508 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5510 '(org-hide-wide-columns (0 nil append))
5511 ;; TODO lines
5513 '(1 (org-get-todo-face 1) t))
5514 ;; DONE
5515 (if org-fontify-done-headline
5519 '(2 'org-headline-done t))
5520 nil)
5521 ;; Priorities
5523 ;; Special keywords
5528 ;; Emphasis
5529 (if em
5530 (if (featurep 'xemacs)
5531 '(org-do-emphasis-faces (0 nil append))
5532 '(org-do-emphasis-faces)))
5533 ;; Checkboxes
5535 2 'bold prepend)
5536 (if org-provide-checkbox-statistics
5538 (0 (org-get-checkbox-statistics-face) t)))
5540 '(1 'org-archived prepend))
5541 ;; Specials
5542 '(org-do-latex-and-special-faces)
5543 ;; Code
5544 '(org-activate-code (1 'org-code t))
5545 ;; COMMENT
5548 '(1 'org-special-keyword t))
5549 '("^#.*" (0 'font-lock-comment-face t))
5550 )))
5551 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5552 ;; Now set the full font-lock-keywords
5553 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5554 (org-set-local 'font-lock-defaults
5555 '(org-font-lock-keywords t nil nil backward-paragraph))
5556 (kill-local-variable 'font-lock-keywords) nil))
5558 (defvar org-m nil)
5559 (defvar org-l nil)
5560 (defvar org-f nil)
5561 (defun org-get-level-face (n)
5562 "Get the right face for match N in font-lock matching of healdines."
5563 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5564 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5565 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5566 (cond
5567 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5568 ((eq n 2) org-f)
5569 (t (if org-level-color-stars-only nil org-f))))
5571 (defun org-get-todo-face (kwd)
5572 "Get the right face for a TODO keyword KWD.
5573 If KWD is a number, get the corresponding match group."
5574 (if (numberp kwd) (setq kwd (match-string kwd)))
5575 (or (cdr (assoc kwd org-todo-keyword-faces))
5576 (and (member kwd org-done-keywords) 'org-done)
5577 'org-todo))
5579 (defun org-unfontify-region (beg end &optional maybe_loudly)
5580 "Remove fontification and activation overlays from links."
5581 (font-lock-default-unfontify-region beg end)
5582 (let* ((buffer-undo-list t)
5583 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5584 (inhibit-modification-hooks t)
5585 deactivate-mark buffer-file-name buffer-file-truename)
5586 (remove-text-properties beg end
5587 '(mouse-face t keymap t org-linked-text t
5588 invisible t intangible t))))
5590 ;;;; Visibility cycling, including org-goto and indirect buffer
5592 ;;; Cycling
5594 (defvar org-cycle-global-status nil)
5595 (make-variable-buffer-local 'org-cycle-global-status)
5596 (defvar org-cycle-subtree-status nil)
5597 (make-variable-buffer-local 'org-cycle-subtree-status)
5599 ;;;###autoload
5600 (defun org-cycle (&optional arg)
5601 "Visibility cycling for Org-mode.
5603 - When this function is called with a prefix argument, rotate the entire
5604 buffer through 3 states (global cycling)
5605 1. OVERVIEW: Show only top-level headlines.
5606 2. CONTENTS: Show all headlines of all levels, but no body text.
5607 3. SHOW ALL: Show everything.
5609 - When point is at the beginning of a headline, rotate the subtree started
5610 by this line through 3 different states (local cycling)
5611 1. FOLDED: Only the main headline is shown.
5612 2. CHILDREN: The main headline and the direct children are shown.
5613 From this state, you can move to one of the children
5614 and zoom in further.
5615 3. SUBTREE: Show the entire subtree, including body text.
5617 - When there is a numeric prefix, go up to a heading with level ARG, do
5618 a `show-subtree' and return to the previous cursor position. If ARG
5619 is negative, go up that many levels.
5621 - When point is not at the beginning of a headline, execute
5622 `indent-relative', like TAB normally does. See the option
5623 `org-cycle-emulate-tab' for details.
5625 - Special case: if point is at the beginning of the buffer and there is
5626 no headline in line 1, this function will act as if called with prefix arg.
5627 But only if also the variable `org-cycle-global-at-bob' is t."
5628 (interactive "P")
5629 (let* ((outline-regexp
5630 (if (and (org-mode-p) org-cycle-include-plain-lists)
5632 outline-regexp))
5633 (bob-special (and org-cycle-global-at-bob (bobp)
5634 (not (looking-at outline-regexp))))
5635 (org-cycle-hook
5636 (if bob-special
5637 (delq 'org-optimize-window-after-visibility-change
5638 (copy-sequence org-cycle-hook))
5639 org-cycle-hook))
5640 (pos (point)))
5642 (if (or bob-special (equal arg '(4)))
5643 ;; special case: use global cycling
5644 (setq arg t))
5646 (cond
5648 ((org-at-table-p 'any)
5649 ;; Enter the table or move to the next field in the table
5650 (or (org-table-recognize-table.el)
5651 (progn
5652 (if arg (org-table-edit-field t)
5653 (org-table-justify-field-maybe)
5654 (call-interactively 'org-table-next-field)))))
5656 ((eq arg t) ;; Global cycling
5658 (cond
5659 ((and (eq last-command this-command)
5660 (eq org-cycle-global-status 'overview))
5661 ;; We just created the overview - now do table of contents
5662 ;; This can be slow in very large buffers, so indicate action
5663 (message "CONTENTS...")
5664 (org-content)
5665 (message "CONTENTS...done")
5666 (setq org-cycle-global-status 'contents)
5667 (run-hook-with-args 'org-cycle-hook 'contents))
5669 ((and (eq last-command this-command)
5670 (eq org-cycle-global-status 'contents))
5671 ;; We just showed the table of contents - now show everything
5672 (show-all)
5673 (message "SHOW ALL")
5674 (setq org-cycle-global-status 'all)
5675 (run-hook-with-args 'org-cycle-hook 'all))
5677 (t
5678 ;; Default action: go to overview
5679 (org-overview)
5680 (message "OVERVIEW")
5681 (setq org-cycle-global-status 'overview)
5682 (run-hook-with-args 'org-cycle-hook 'overview))))
5684 ((and org-drawers org-drawer-regexp
5685 (save-excursion
5686 (beginning-of-line 1)
5687 (looking-at org-drawer-regexp)))
5688 ;; Toggle block visibility
5689 (org-flag-drawer
5690 (not (get-char-property (match-end 0) 'invisible))))
5692 ((integerp arg)
5693 ;; Show-subtree, ARG levels up from here.
5694 (save-excursion
5695 (org-back-to-heading)
5696 (outline-up-heading (if (< arg 0) (- arg)
5697 (- (funcall outline-level) arg)))
5698 (org-show-subtree)))
5700 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5701 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5702 ;; At a heading: rotate between three different views
5703 (org-back-to-heading)
5704 (let ((goal-column 0) eoh eol eos)
5705 ;; First, some boundaries
5706 (save-excursion
5707 (org-back-to-heading)
5708 (save-excursion
5709 (beginning-of-line 2)
5710 (while (and (not (eobp)) ;; this is like `next-line'
5711 (get-char-property (1- (point)) 'invisible))
5712 (beginning-of-line 2)) (setq eol (point)))
5713 (outline-end-of-heading) (setq eoh (point))
5714 (org-end-of-subtree t)
5715 (unless (eobp)
5717 (beginning-of-line 1) ; in case this is an item
5718 )
5719 (setq eos (1- (point))))
5720 ;; Find out what to do next and set `this-command'
5721 (cond
5722 ((= eos eoh)
5723 ;; Nothing is hidden behind this heading
5724 (message "EMPTY ENTRY")
5725 (setq org-cycle-subtree-status nil)
5726 (save-excursion
5727 (goto-char eos)
5728 (outline-next-heading)
5729 (if (org-invisible-p) (org-flag-heading nil))))
5730 ((or (>= eol eos)
5732 ;; Entire subtree is hidden in one line: open it
5733 (org-show-entry)
5734 (show-children)
5735 (message "CHILDREN")
5736 (save-excursion
5737 (goto-char eos)
5738 (outline-next-heading)
5739 (if (org-invisible-p) (org-flag-heading nil)))
5740 (setq org-cycle-subtree-status 'children)
5741 (run-hook-with-args 'org-cycle-hook 'children))
5742 ((and (eq last-command this-command)
5743 (eq org-cycle-subtree-status 'children))
5744 ;; We just showed the children, now show everything.
5745 (org-show-subtree)
5746 (message "SUBTREE")
5747 (setq org-cycle-subtree-status 'subtree)
5748 (run-hook-with-args 'org-cycle-hook 'subtree))
5749 (t
5750 ;; Default action: hide the subtree.
5751 (hide-subtree)
5752 (message "FOLDED")
5753 (setq org-cycle-subtree-status 'folded)
5754 (run-hook-with-args 'org-cycle-hook 'folded)))))
5756 ;; TAB emulation
5757 (buffer-read-only (org-back-to-heading))
5759 ((org-try-cdlatex-tab))
5761 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5762 (or (not (bolp))
5763 (not (looking-at outline-regexp))))
5766 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5768 (or (and (eq org-cycle-emulate-tab 'white)
5769 (= (match-end 0) (point-at-eol)))
5770 (and (eq org-cycle-emulate-tab 'whitestart)
5771 (>= (match-end 0) pos))))
5772 t
5773 (eq org-cycle-emulate-tab t))
5776 ; (point-at-bol) (point))))
5777 ; (progn
5778 ; (beginning-of-line 1)
5782 (t (save-excursion
5783 (org-back-to-heading)
5784 (org-cycle))))))
5786 ;;;###autoload
5787 (defun org-global-cycle (&optional arg)
5788 "Cycle the global visibility. For details see `org-cycle'."
5789 (interactive "P")
5790 (let ((org-cycle-include-plain-lists
5791 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5792 (if (integerp arg)
5793 (progn
5794 (show-all)
5795 (hide-sublevels arg)
5796 (setq org-cycle-global-status 'contents))
5797 (org-cycle '(4)))))
5799 (defun org-overview ()
5800 "Switch to overview mode, shoing only top-level headlines.
5801 Really, this shows all headlines with level equal or greater than the level
5802 of the first headline in the buffer. This is important, because if the
5803 first headline is not level one, then (hide-sublevels 1) gives confusing
5804 results."
5805 (interactive)
5806 (let ((level (save-excursion
5807 (goto-char (point-min))
5808 (if (re-search-forward (concat "^" outline-regexp) nil t)
5809 (progn
5810 (goto-char (match-beginning 0))
5811 (funcall outline-level))))))
5812 (and level (hide-sublevels level))))
5814 (defun org-content (&optional arg)
5815 "Show all headlines in the buffer, like a table of contents.
5816 With numerical argument N, show content up to level N."
5817 (interactive "P")
5818 (save-excursion
5819 ;; Visit all headings and show their offspring
5820 (and (integerp arg) (org-overview))
5821 (goto-char (point-max))
5822 (catch 'exit
5823 (while (and (progn (condition-case nil
5824 (outline-previous-visible-heading 1)
5825 (error (goto-char (point-min))))
5826 t)
5827 (looking-at outline-regexp))
5828 (if (integerp arg)
5829 (show-children (1- arg))
5830 (show-branches))
5831 (if (bobp) (throw 'exit nil))))))
5834 (defun org-optimize-window-after-visibility-change (state)
5835 "Adjust the window after a change in outline visibility.
5836 This function is the default value of the hook `org-cycle-hook'."
5837 (when (get-buffer-window (current-buffer))
5838 (cond
5839 ; ((eq state 'overview) (org-first-headline-recenter 1))
5840 ; ((eq state 'overview) (org-beginning-of-line))
5841 ((eq state 'content) nil)
5842 ((eq state 'all) nil)
5843 ((eq state 'folded) nil)
5844 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5845 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5847 (defun org-compact-display-after-subtree-move ()
5848 (let (beg end)
5849 (save-excursion
5850 (if (org-up-heading-safe)
5851 (progn
5852 (hide-subtree)
5853 (show-entry)
5854 (show-children)
5855 (org-cycle-show-empty-lines 'children)
5856 (org-cycle-hide-drawers 'children))
5857 (org-overview)))))
5859 (defun org-cycle-show-empty-lines (state)
5860 "Show empty lines above all visible headlines.
5861 The region to be covered depends on STATE when called through
5862 `org-cycle-hook'. Lisp program can use t for STATE to get the
5863 entire buffer covered. Note that an empty line is only shown if there
5864 are at least `org-cycle-separator-lines' empty lines before the headeline."
5865 (when (> org-cycle-separator-lines 0)
5866 (save-excursion
5867 (let* ((n org-cycle-separator-lines)
5868 (re (cond
5871 (t (let ((ns (number-to-string (- n 2))))
5874 beg end)
5875 (cond
5876 ((memq state '(overview contents t))
5877 (setq beg (point-min) end (point-max)))
5878 ((memq state '(children folded))
5879 (setq beg (point) end (progn (org-end-of-subtree t t)
5880 (beginning-of-line 2)
5881 (point)))))
5882 (when beg
5883 (goto-char beg)
5884 (while (re-search-forward re end t)
5885 (if (not (get-char-property (match-end 1) 'invisible))
5886 (outline-flag-region
5887 (match-beginning 1) (match-end 1) nil)))))))
5888 ;; Never hide empty lines at the end of the file.
5889 (save-excursion
5890 (goto-char (point-max))
5891 (outline-previous-heading)
5892 (outline-end-of-heading)
5894 (= (match-end 0) (point-max)))
5895 (outline-flag-region (point) (match-end 0) nil))))
5897 (defun org-subtree-end-visible-p ()
5898 "Is the end of the current subtree visible?"
5899 (pos-visible-in-window-p
5900 (save-excursion (org-end-of-subtree t) (point))))
5902 (defun org-first-headline-recenter (&optional N)
5903 "Move cursor to the first headline and recenter the headline.
5904 Optional argument N means, put the headline into the Nth line of the window."
5905 (goto-char (point-min))
5907 (beginning-of-line)
5908 (recenter (prefix-numeric-value N))))
5910 ;;; Org-goto
5912 (defvar org-goto-window-configuration nil)
5913 (defvar org-goto-marker nil)
5914 (defvar org-goto-map
5915 (let ((map (make-sparse-keymap)))
5916 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5917 (while (setq cmd (pop cmds))
5918 (substitute-key-definition cmd cmd map global-map)))
5919 (suppress-keymap map)
5920 (org-defkey map "\C-m" 'org-goto-ret)
5921 (org-defkey map [(return)] 'org-goto-ret)
5922 (org-defkey map [(left)] 'org-goto-left)
5923 (org-defkey map [(right)] 'org-goto-right)
5924 (org-defkey map [(control ?g)] 'org-goto-quit)
5925 (org-defkey map "\C-i" 'org-cycle)
5926 (org-defkey map [(tab)] 'org-cycle)
5927 (org-defkey map [(down)] 'outline-next-visible-heading)
5928 (org-defkey map [(up)] 'outline-previous-visible-heading)
5929 (if org-goto-auto-isearch
5930 (if (fboundp 'define-key-after)
5931 (define-key-after map [t] 'org-goto-local-auto-isearch)
5932 nil)
5933 (org-defkey map "q" 'org-goto-quit)
5934 (org-defkey map "n" 'outline-next-visible-heading)
5935 (org-defkey map "p" 'outline-previous-visible-heading)
5936 (org-defkey map "f" 'outline-forward-same-level)
5937 (org-defkey map "b" 'outline-backward-same-level)
5938 (org-defkey map "u" 'outline-up-heading))
5939 (org-defkey map "/" 'org-occur)
5940 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5941 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5942 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5943 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5944 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5945 map))
5947 (defconst org-goto-help
5948 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5949 RET=jump to location [Q]uit and return to previous location
5950 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5952 (defvar org-goto-start-pos) ; dynamically scoped parameter
5954 (defun org-goto (&optional alternative-interface)
5955 "Look up a different location in the current file, keeping current visibility.
5957 When you want look-up or go to a different location in a document, the
5958 fastest way is often to fold the entire buffer and then dive into the tree.
5959 This method has the disadvantage, that the previous location will be folded,
5960 which may not be what you want.
5962 This command works around this by showing a copy of the current buffer
5963 in an indirect buffer, in overview mode. You can dive into the tree in
5964 that copy, use org-occur and incremental search to find a location.
5965 When pressing RET or `Q', the command returns to the original buffer in
5966 which the visibility is still unchanged. After RET is will also jump to
5967 the location selected in the indirect buffer and expose the
5968 the headline hierarchy above."
5969 (interactive "P")
5970 (let* ((org-refile-targets '((nil . (:maxlevel . 10))))
5971 (org-refile-use-outline-path t)
5972 (interface
5973 (if (not alternative-interface)
5974 org-goto-interface
5975 (if (eq org-goto-interface 'outline)
5976 'outline-path-completion
5977 'outline)))
5978 (org-goto-start-pos (point))
5979 (selected-point
5980 (if (eq interface 'outline)
5981 (car (org-get-location (current-buffer) org-goto-help))
5982 (nth 3 (org-refile-get-location "Goto: ")))))
5983 (if selected-point
5984 (progn
5985 (org-mark-ring-push org-goto-start-pos)
5986 (goto-char selected-point)
5987 (if (or (org-invisible-p) (org-invisible-p2))
5988 (org-show-context 'org-goto)))
5989 (message "Quit"))))
5991 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5992 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5993 (defvar org-goto-local-auto-isearch-map) ; defined below
5995 (defun org-get-location (buf help)
5996 "Let the user select a location in the Org-mode buffer BUF.
5997 This function uses a recursive edit. It returns the selected position
5998 or nil."
5999 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6000 (isearch-hide-immediately nil)
6001 (isearch-search-fun-function
6002 (lambda () 'org-goto-local-search-forward-headings))
6003 (org-goto-selected-point org-goto-exit-command))
6004 (save-excursion
6005 (save-window-excursion
6006 (delete-other-windows)
6007 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6008 (switch-to-buffer
6009 (condition-case nil
6010 (make-indirect-buffer (current-buffer) "*org-goto*")
6011 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6012 (with-output-to-temp-buffer "*Help*"
6013 (princ help))
6014 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
6015 (setq buffer-read-only nil)
6016 (let ((org-startup-truncated t)
6017 (org-startup-folded nil)
6018 (org-startup-align-all-tables nil))
6019 (org-mode)
6020 (org-overview))
6021 (setq buffer-read-only t)
6022 (if (and (boundp 'org-goto-start-pos)
6023 (integer-or-marker-p org-goto-start-pos))
6024 (let ((org-show-hierarchy-above t)
6025 (org-show-siblings t)
6026 (org-show-following-heading t))
6027 (goto-char org-goto-start-pos)
6028 (and (org-invisible-p) (org-show-context)))
6029 (goto-char (point-min)))
6030 (org-beginning-of-line)
6031 (message "Select location and press RET")
6032 (use-local-map org-goto-map)
6033 (recursive-edit)
6034 ))
6035 (kill-buffer "*org-goto*")
6036 (cons org-goto-selected-point org-goto-exit-command)))
6038 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6039 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6040 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6041 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6043 (defun org-goto-local-search-forward-headings (string bound noerror)
6044 "Search and make sure that anu matches are in headlines."
6045 (catch 'return
6046 (while (search-forward string bound noerror)
6047 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6048 (and (member :headline context)
6049 (not (member :tags context))))
6050 (throw 'return (point))))))
6052 (defun org-goto-local-auto-isearch ()
6053 "Start isearch."
6054 (interactive)
6055 (goto-char (point-min))
6056 (let ((keys (this-command-keys)))
6057 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6058 (isearch-mode t)
6059 (isearch-process-search-char (string-to-char keys)))))
6061 (defun org-goto-ret (&optional arg)
6062 "Finish `org-goto' by going to the new location."
6063 (interactive "P")
6064 (setq org-goto-selected-point (point)
6065 org-goto-exit-command 'return)
6066 (throw 'exit nil))
6068 (defun org-goto-left ()
6069 "Finish `org-goto' by going to the new location."
6070 (interactive)
6071 (if (org-on-heading-p)
6072 (progn
6073 (beginning-of-line 1)
6074 (setq org-goto-selected-point (point)
6075 org-goto-exit-command 'left)
6076 (throw 'exit nil))
6077 (error "Not on a heading")))
6079 (defun org-goto-right ()
6080 "Finish `org-goto' by going to the new location."
6081 (interactive)
6082 (if (org-on-heading-p)
6083 (progn
6084 (setq org-goto-selected-point (point)
6085 org-goto-exit-command 'right)
6086 (throw 'exit nil))
6087 (error "Not on a heading")))
6089 (defun org-goto-quit ()
6090 "Finish `org-goto' without cursor motion."
6091 (interactive)
6092 (setq org-goto-selected-point nil)
6093 (setq org-goto-exit-command 'quit)
6094 (throw 'exit nil))
6096 ;;; Indirect buffer display of subtrees
6098 (defvar org-indirect-dedicated-frame nil
6099 "This is the frame being used for indirect tree display.")
6100 (defvar org-last-indirect-buffer nil)
6102 (defun org-tree-to-indirect-buffer (&optional arg)
6103 "Create indirect buffer and narrow it to current subtree.
6104 With numerical prefix ARG, go up to this level and then take that tree.
6105 If ARG is negative, go up that many levels.
6106 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6107 indirect buffer previously made with this command, to avoid proliferation of
6108 indirect buffers. However, when you call the command with a `C-u' prefix, or
6109 when `org-indirect-buffer-display' is `new-frame', the last buffer
6110 is kept so that you can work with several indirect buffers at the same time.
6111 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6112 requests that a new frame be made for the new buffer, so that the dedicated
6113 frame is not changed."
6114 (interactive "P")
6115 (let ((cbuf (current-buffer))
6116 (cwin (selected-window))
6117 (pos (point))
6118 beg end level heading ibuf)
6119 (save-excursion
6120 (org-back-to-heading t)
6121 (when (numberp arg)
6122 (setq level (org-outline-level))
6123 (if (< arg 0) (setq arg (+ level arg)))
6124 (while (> (setq level (org-outline-level)) arg)
6125 (outline-up-heading 1 t)))
6126 (setq beg (point)
6127 heading (org-get-heading))
6128 (org-end-of-subtree t) (setq end (point)))
6129 (if (and (buffer-live-p org-last-indirect-buffer)
6130 (not (eq org-indirect-buffer-display 'new-frame))
6131 (not arg))
6132 (kill-buffer org-last-indirect-buffer))
6133 (setq ibuf (org-get-indirect-buffer cbuf)
6134 org-last-indirect-buffer ibuf)
6135 (cond
6136 ((or (eq org-indirect-buffer-display 'new-frame)
6137 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6138 (select-frame (make-frame))
6139 (delete-other-windows)
6140 (switch-to-buffer ibuf)
6141 (org-set-frame-title heading))
6142 ((eq org-indirect-buffer-display 'dedicated-frame)
6143 (raise-frame
6144 (select-frame (or (and org-indirect-dedicated-frame
6145 (frame-live-p org-indirect-dedicated-frame)
6146 org-indirect-dedicated-frame)
6147 (setq org-indirect-dedicated-frame (make-frame)))))
6148 (delete-other-windows)
6149 (switch-to-buffer ibuf)
6150 (org-set-frame-title (concat "Indirect: " heading)))
6151 ((eq org-indirect-buffer-display 'current-window)
6152 (switch-to-buffer ibuf))
6153 ((eq org-indirect-buffer-display 'other-window)
6154 (pop-to-buffer ibuf))
6155 (t (error "Invalid value.")))
6156 (if (featurep 'xemacs)
6157 (save-excursion (org-mode) (turn-on-font-lock)))
6158 (narrow-to-region beg end)
6159 (show-all)
6160 (goto-char pos)
6161 (and (window-live-p cwin) (select-window cwin))))
6163 (defun org-get-indirect-buffer (&optional buffer)
6164 (setq buffer (or buffer (current-buffer)))
6165 (let ((n 1) (base (buffer-name buffer)) bname)
6166 (while (buffer-live-p
6167 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6168 (setq n (1+ n)))
6169 (condition-case nil
6170 (make-indirect-buffer buffer bname 'clone)
6171 (error (make-indirect-buffer buffer bname)))))
6173 (defun org-set-frame-title (title)
6174 "Set the title of the current frame to the string TITLE."
6175 ;; FIXME: how to name a single frame in XEmacs???
6176 (unless (featurep 'xemacs)
6177 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6179 ;;;; Structure editing
6181 ;;; Inserting headlines
6183 (defun org-insert-heading (&optional force-heading)
6184 "Insert a new heading or item with same depth at point.
6185 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6186 If point is at the beginning of a headline, insert a sibling before the
6187 current headline. If point is not at the beginning, do not split the line,
6188 but create the new hedline after the current line."
6189 (interactive "P")
6190 (if (= (buffer-size) 0)
6192 (when (or force-heading (not (org-insert-item)))
6193 (let* ((head (save-excursion
6194 (condition-case nil
6195 (progn
6196 (org-back-to-heading)
6197 (match-string 0))
6198 (error "*"))))
6199 (blank (cdr (assq 'heading org-blank-before-new-entry)))
6200 pos)
6201 (cond
6202 ((and (org-on-heading-p) (bolp)
6203 (or (bobp)
6204 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6205 ;; insert before the current line
6206 (open-line (if blank 2 1)))
6207 ((and (bolp)
6208 (or (bobp)
6209 (save-excursion
6210 (backward-char 1) (not (org-invisible-p)))))
6211 ;; insert right here
6212 nil)
6213 (t
6214 ;; in the middle of the line
6215 (org-show-entry)
6216 (if (and (org-on-heading-p)
6218 ;; protect the tags
6219 (let ((tags (match-string 2)) pos)
6220 (delete-region (match-beginning 1) (match-end 1))
6221 (setq pos (point-at-bol))
6222 (newline (if blank 2 1))
6223 (save-excursion
6224 (goto-char pos)
6225 (end-of-line 1)
6226 (insert " " tags)
6227 (org-set-tags nil 'align)))
6228 (newline (if blank 2 1)))))
6229 (insert head) (just-one-space)
6230 (setq pos (point))
6231 (end-of-line 1)
6232 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6233 (run-hooks 'org-insert-heading-hook)))))
6235 (defun org-insert-heading-after-current ()
6236 "Insert a new heading with same level as current, after current subtree."
6237 (interactive)
6238 (org-back-to-heading)
6239 (org-insert-heading)
6240 (org-move-subtree-down)
6241 (end-of-line 1))
6243 (defun org-insert-todo-heading (arg)
6244 "Insert a new heading with the same level and TODO state as current heading.
6245 If the heading has no TODO state, or if the state is DONE, use the first
6246 state (TODO by default). Also with prefix arg, force first state."
6247 (interactive "P")
6248 (when (not (org-insert-item 'checkbox))
6249 (org-insert-heading)
6250 (save-excursion
6251 (org-back-to-heading)
6252 (outline-previous-heading)
6253 (looking-at org-todo-line-regexp))
6254 (if (or arg
6255 (not (match-beginning 2))
6256 (member (match-string 2) org-done-keywords))
6257 (insert (car org-todo-keywords-1) " ")
6258 (insert (match-string 2) " "))))
6260 (defun org-insert-subheading (arg)
6261 "Insert a new subheading and demote it.
6262 Works for outline headings and for plain lists alike."
6263 (interactive "P")
6264 (org-insert-heading arg)
6265 (cond
6266 ((org-on-heading-p) (org-do-demote))
6267 ((org-at-item-p) (org-indent-item 1))))
6269 (defun org-insert-todo-subheading (arg)
6270 "Insert a new subheading with TODO keyword or checkbox and demote it.
6271 Works for outline headings and for plain lists alike."
6272 (interactive "P")
6273 (org-insert-todo-heading arg)
6274 (cond
6275 ((org-on-heading-p) (org-do-demote))
6276 ((org-at-item-p) (org-indent-item 1))))
6278 ;;; Promotion and Demotion
6280 (defun org-promote-subtree ()
6281 "Promote the entire subtree.
6282 See also `org-promote'."
6283 (interactive)
6284 (save-excursion
6285 (org-map-tree 'org-promote))
6286 (org-fix-position-after-promote))
6288 (defun org-demote-subtree ()
6289 "Demote the entire subtree. See `org-demote'.
6290 See also `org-promote'."
6291 (interactive)
6292 (save-excursion
6293 (org-map-tree 'org-demote))
6294 (org-fix-position-after-promote))
6297 (defun org-do-promote ()
6298 "Promote the current heading higher up the tree.
6299 If the region is active in `transient-mark-mode', promote all headings
6300 in the region."
6301 (interactive)
6302 (save-excursion
6303 (if (org-region-active-p)
6304 (org-map-region 'org-promote (region-beginning) (region-end))
6305 (org-promote)))
6306 (org-fix-position-after-promote))
6308 (defun org-do-demote ()
6309 "Demote the current heading lower down the tree.
6310 If the region is active in `transient-mark-mode', demote all headings
6311 in the region."
6312 (interactive)
6313 (save-excursion
6314 (if (org-region-active-p)
6315 (org-map-region 'org-demote (region-beginning) (region-end))
6316 (org-demote)))
6317 (org-fix-position-after-promote))
6319 (defun org-fix-position-after-promote ()
6320 "Make sure that after pro/demotion cursor position is right."
6321 (let ((pos (point)))
6322 (when (save-excursion
6323 (beginning-of-line 1)
6324 (looking-at org-todo-line-regexp)
6325 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6326 (cond ((eobp) (insert " "))
6327 ((eolp) (insert " "))
6328 ((equal (char-after) ?\ ) (forward-char 1))))))
6330 (defun org-reduced-level (l)
6331 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6333 (defun org-get-legal-level (level &optional change)
6334 "Rectify a level change under the influence of `org-odd-levels-only'
6335 LEVEL is a current level, CHANGE is by how much the level should be
6336 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6337 even level numbers will become the next higher odd number."
6338 (if org-odd-levels-only
6339 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6340 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6341 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6342 (max 1 (+ level change))))
6344 (defun org-promote ()
6345 "Promote the current heading higher up the tree.
6346 If the region is active in `transient-mark-mode', promote all headings
6347 in the region."
6348 (org-back-to-heading t)
6349 (let* ((level (save-match-data (funcall outline-level)))
6350 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6351 (diff (abs (- level (length up-head) -1))))
6352 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6353 (replace-match up-head nil t)
6354 ;; Fixup tag positioning
6355 (and org-auto-align-tags (org-set-tags nil t))
6356 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6358 (defun org-demote ()
6359 "Demote the current heading lower down the tree.
6360 If the region is active in `transient-mark-mode', demote all headings
6361 in the region."
6362 (org-back-to-heading t)
6363 (let* ((level (save-match-data (funcall outline-level)))
6364 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6365 (diff (abs (- level (length down-head) -1))))
6366 (replace-match down-head nil t)
6367 ;; Fixup tag positioning
6368 (and org-auto-align-tags (org-set-tags nil t))
6369 (if org-adapt-indentation (org-fixup-indentation diff))))
6371 (defun org-map-tree (fun)
6372 "Call FUN for every heading underneath the current one."
6373 (org-back-to-heading)
6374 (let ((level (funcall outline-level)))
6375 (save-excursion
6376 (funcall fun)
6377 (while (and (progn
6378 (outline-next-heading)
6379 (> (funcall outline-level) level))
6380 (not (eobp)))
6381 (funcall fun)))))
6383 (defun org-map-region (fun beg end)
6384 "Call FUN for every heading between BEG and END."
6385 (let ((org-ignore-region t))
6386 (save-excursion
6387 (setq end (copy-marker end))
6388 (goto-char beg)
6389 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6390 (< (point) end))
6391 (funcall fun))
6392 (while (and (progn
6393 (outline-next-heading)
6394 (< (point) end))
6395 (not (eobp)))
6396 (funcall fun)))))
6398 (defun org-fixup-indentation (diff)
6399 "Change the indentation in the current entry by DIFF
6400 However, if any line in the current entry has no indentation, or if it
6401 would end up with no indentation after the change, nothing at all is done."
6402 (save-excursion
6403 (let ((end (save-excursion (outline-next-heading)
6404 (point-marker)))
6405 (prohibit (if (> diff 0)
6408 col)
6409 (unless (save-excursion (end-of-line 1)
6410 (re-search-forward prohibit end t))
6411 (while (and (< (point) end)
6413 (goto-char (match-end 0))
6414 (setq col (current-column))
6415 (if (< diff 0) (replace-match ""))
6416 (indent-to (+ diff col))))
6417 (move-marker end nil))))
6419 (defun org-convert-to-odd-levels ()
6420 "Convert an org-mode file with all levels allowed to one with odd levels.
6421 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6422 level 5 etc."
6423 (interactive)
6424 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6425 (let ((org-odd-levels-only nil) n)
6426 (save-excursion
6427 (goto-char (point-min))
6429 (setq n (- (length (match-string 0)) 2))
6430 (while (>= (setq n (1- n)) 0)
6431 (org-demote))
6432 (end-of-line 1))))))
6435 (defun org-convert-to-oddeven-levels ()
6436 "Convert an org-mode file with only odd levels to one with odd and even levels.
6437 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6438 section with an even level, conversion would destroy the structure of the file. An error
6439 is signaled in this case."
6440 (interactive)
6441 (goto-char (point-min))
6442 ;; First check if there are no even levels
6444 (org-show-context t)
6445 (error "Not all levels are odd in this file. Conversion not possible."))
6446 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6447 (let ((org-odd-levels-only nil) n)
6448 (save-excursion
6449 (goto-char (point-min))
6451 (setq n (/ (1- (length (match-string 0))) 2))
6452 (while (>= (setq n (1- n)) 0)
6453 (org-promote))
6454 (end-of-line 1))))))
6456 (defun org-tr-level (n)
6457 "Make N odd if required."
6458 (if org-odd-levels-only (1+ (/ n 2)) n))
6460 ;;; Vertical tree motion, cutting and pasting of subtrees
6462 (defun org-move-subtree-up (&optional arg)
6463 "Move the current subtree up past ARG headlines of the same level."
6464 (interactive "p")
6465 (org-move-subtree-down (- (prefix-numeric-value arg))))
6467 (defun org-move-subtree-down (&optional arg)
6468 "Move the current subtree down past ARG headlines of the same level."
6469 (interactive "p")
6470 (setq arg (prefix-numeric-value arg))
6471 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6472 'outline-get-last-sibling))
6473 (ins-point (make-marker))
6474 (cnt (abs arg))
6475 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6476 ;; Select the tree
6477 (org-back-to-heading)
6478 (setq beg0 (point))
6479 (save-excursion
6480 (setq ne-beg (org-back-over-empty-lines))
6481 (setq beg (point)))
6482 (save-match-data
6483 (save-excursion (outline-end-of-heading)
6484 (setq folded (org-invisible-p)))
6485 (outline-end-of-subtree))
6486 (outline-next-heading)
6487 (setq ne-end (org-back-over-empty-lines))
6488 (setq end (point))
6489 (goto-char beg0)
6490 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6491 ;; include less whitespace
6492 (save-excursion
6493 (goto-char beg)
6494 (forward-line (- ne-beg ne-end))
6495 (setq beg (point))))
6496 ;; Find insertion point, with error handling
6497 (while (> cnt 0)
6498 (or (and (funcall movfunc) (looking-at outline-regexp))
6499 (progn (goto-char beg0)
6500 (error "Cannot move past superior level or buffer limit")))
6501 (setq cnt (1- cnt)))
6502 (if (> arg 0)
6503 ;; Moving forward - still need to move over subtree
6504 (progn (org-end-of-subtree t t)
6505 (save-excursion
6506 (org-back-over-empty-lines)
6507 (or (bolp) (newline)))))
6508 (setq ne-ins (org-back-over-empty-lines))
6509 (move-marker ins-point (point))
6510 (setq txt (buffer-substring beg end))
6511 (delete-region beg end)
6512 (outline-flag-region (1- beg) beg nil)
6513 (outline-flag-region (1- (point)) (point) nil)
6514 (insert txt)
6516 (setq ins-end (point))
6517 (goto-char ins-point)
6518 (org-skip-whitespace)
6519 (when (and (< arg 0)
6520 (org-first-sibling-p)
6521 (> ne-ins ne-beg))
6522 ;; Move whitespace back to beginning
6523 (save-excursion
6524 (goto-char ins-end)
6525 (let ((kill-whole-line t))
6526 (kill-line (- ne-ins ne-beg)) (point)))
6528 (move-marker ins-point nil)
6529 (org-compact-display-after-subtree-move)
6530 (unless folded
6531 (org-show-entry)
6532 (show-children)
6533 (org-cycle-hide-drawers 'children))))
6535 (defvar org-subtree-clip ""
6536 "Clipboard for cut and paste of subtrees.
6537 This is actually only a copy of the kill, because we use the normal kill
6538 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6540 (defvar org-subtree-clip-folded nil
6541 "Was the last copied subtree folded?
6542 This is used to fold the tree back after pasting.")
6544 (defun org-cut-subtree (&optional n)
6545 "Cut the current subtree into the clipboard.
6546 With prefix arg N, cut this many sequential subtrees.
6547 This is a short-hand for marking the subtree and then cutting it."
6548 (interactive "p")
6549 (org-copy-subtree n 'cut))
6551 (defun org-copy-subtree (&optional n cut)
6552 "Cut the current subtree into the clipboard.
6553 With prefix arg N, cut this many sequential subtrees.
6554 This is a short-hand for marking the subtree and then copying it.
6555 If CUT is non-nil, actually cut the subtree."
6556 (interactive "p")
6557 (let (beg end folded (beg0 (point)))
6558 (if (interactive-p)
6559 (org-back-to-heading nil) ; take what looks like a subtree
6560 (org-back-to-heading t)) ; take what is really there
6561 (org-back-over-empty-lines)
6562 (setq beg (point))
6564 (save-match-data
6565 (save-excursion (outline-end-of-heading)
6566 (setq folded (org-invisible-p)))
6567 (condition-case nil
6568 (outline-forward-same-level (1- n))
6569 (error nil))
6570 (org-end-of-subtree t t))
6571 (org-back-over-empty-lines)
6572 (setq end (point))
6573 (goto-char beg0)
6574 (when (> end beg)
6575 (setq org-subtree-clip-folded folded)
6576 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6577 (setq org-subtree-clip (current-kill 0))
6578 (message "%s: Subtree(s) with %d characters"
6579 (if cut "Cut" "Copied")
6580 (length org-subtree-clip)))))
6582 (defun org-paste-subtree (&optional level tree)
6583 "Paste the clipboard as a subtree, with modification of headline level.
6584 The entire subtree is promoted or demoted in order to match a new headline
6585 level. By default, the new level is derived from the visible headings
6586 before and after the insertion point, and taken to be the inferior headline
6587 level of the two. So if the previous visible heading is level 3 and the
6588 next is level 4 (or vice versa), level 4 will be used for insertion.
6589 This makes sure that the subtree remains an independent subtree and does
6590 not swallow low level entries.
6592 You can also force a different level, either by using a numeric prefix
6593 argument, or by inserting the heading marker by hand. For example, if the
6598 If optional TREE is given, use this text instead of the kill ring."
6599 (interactive "P")
6600 (unless (org-kill-is-subtree-p tree)
6601 (error "%s"
6602 (substitute-command-keys
6604 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6609 (old-level (if (string-match ^re txt)
6610 (- (match-end 0) (match-beginning 0) 1)
6611 -1))
6612 (force-level (cond (level (prefix-numeric-value level))
6613 ((string-match
6614 ^re_ (buffer-substring (point-at-bol) (point)))
6615 (- (match-end 1) (match-beginning 1)))
6616 (t nil)))
6617 (previous-level (save-excursion
6618 (condition-case nil
6619 (progn
6620 (outline-previous-visible-heading 1)
6621 (if (looking-at re)
6622 (- (match-end 0) (match-beginning 0) 1)
6623 1))
6624 (error 1))))
6625 (next-level (save-excursion
6626 (condition-case nil
6627 (progn
6628 (or (looking-at outline-regexp)
6629 (outline-next-visible-heading 1))
6630 (if (looking-at re)
6631 (- (match-end 0) (match-beginning 0) 1)
6632 1))
6633 (error 1))))
6634 (new-level (or force-level (max previous-level next-level)))
6635 (shift (if (or (= old-level -1)
6636 (= new-level -1)
6637 (= old-level new-level))
6638 0
6639 (- new-level old-level)))
6640 (delta (if (> shift 0) -1 1))
6641 (func (if (> shift 0) 'org-demote 'org-promote))
6642 (org-odd-levels-only nil)
6643 beg end)
6644 ;; Remove the forced level indicator
6645 (if force-level
6646 (delete-region (point-at-bol) (point)))
6647 ;; Paste
6648 (beginning-of-line 1)
6649 (org-back-over-empty-lines) ;; FIXME: correct fix????
6650 (setq beg (point))
6651 (insert-before-markers txt) ;; FIXME: correct fix????
6653 (setq end (point))
6654 (goto-char beg)
6656 (setq beg (point))
6657 ;; Shift if necessary
6658 (unless (= shift 0)
6659 (save-restriction
6660 (narrow-to-region beg end)
6661 (while (not (= shift 0))
6662 (org-map-region func (point-min) (point-max))
6663 (setq shift (+ delta shift)))
6664 (goto-char (point-min))))
6665 (when (interactive-p)
6666 (message "Clipboard pasted as level %d subtree" new-level))
6667 (if (and kill-ring
6668 (eq org-subtree-clip (current-kill 0))
6669 org-subtree-clip-folded)
6670 ;; The tree was folded before it was killed/copied
6671 (hide-subtree))))
6673 (defun org-kill-is-subtree-p (&optional txt)
6674 "Check if the current kill is an outline subtree, or a set of trees.
6675 Returns nil if kill does not start with a headline, or if the first
6676 headline level is not the largest headline level in the tree.
6677 So this will actually accept several entries of equal levels as well,
6678 which is OK for `org-paste-subtree'.
6679 If optional TXT is given, check this string instead of the current kill."
6680 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6681 (start-level (and kill
6684 kill)
6685 (- (match-end 2) (match-beginning 2) 1)))
6686 (re (concat "^" org-outline-regexp))
6687 (start (1+ (match-beginning 2))))
6688 (if (not start-level)
6689 (progn
6690 nil) ;; does not even start with a heading
6691 (catch 'exit
6692 (while (setq start (string-match re kill (1+ start)))
6693 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6694 (throw 'exit nil)))
6695 t))))
6697 (defun org-narrow-to-subtree ()
6698 "Narrow buffer to the current subtree."
6699 (interactive)
6700 (save-excursion
6701 (save-match-data
6702 (narrow-to-region
6703 (progn (org-back-to-heading) (point))
6704 (progn (org-end-of-subtree t t) (point))))))
6707 ;;; Outline Sorting
6709 (defun org-sort (with-case)
6710 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6711 Optional argument WITH-CASE means sort case-sensitively."
6712 (interactive "P")
6713 (if (org-at-table-p)
6714 (org-call-with-arg 'org-table-sort-lines with-case)
6715 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6717 (defvar org-priority-regexp) ; defined later in the file
6719 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6720 "Sort entries on a certain level of an outline tree.
6721 If there is an active region, the entries in the region are sorted.
6722 Else, if the cursor is before the first entry, sort the top-level items.
6723 Else, the children of the entry at point are sorted.
6725 Sorting can be alphabetically, numerically, and by date/time as given by
6726 the first time stamp in the entry. The command prompts for the sorting
6727 type unless it has been given to the function through the SORTING-TYPE
6728 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6729 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6730 called with point at the beginning of the record. It must return either
6731 a string or a number that should serve as the sorting key for that record.
6733 Comparing entries ignores case by default. However, with an optional argument
6734 WITH-CASE, the sorting considers case as well."
6735 (interactive "P")
6736 (let ((case-func (if with-case 'identity 'downcase))
6737 start beg end stars re re2
6738 txt what tmp plain-list-p)
6739 ;; Find beginning and end of region to sort
6740 (cond
6741 ((org-region-active-p)
6742 ;; we will sort the region
6743 (setq end (region-end)
6744 what "region")
6745 (goto-char (region-beginning))
6746 (if (not (org-on-heading-p)) (outline-next-heading))
6747 (setq start (point)))
6748 ((org-at-item-p)
6749 ;; we will sort this plain list
6750 (org-beginning-of-item-list) (setq start (point))
6751 (org-end-of-item-list) (setq end (point))
6752 (goto-char start)
6753 (setq plain-list-p t
6754 what "plain list"))
6755 ((or (org-on-heading-p)
6756 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6757 ;; we will sort the children of the current headline
6758 (org-back-to-heading)
6759 (setq start (point)
6760 end (progn (org-end-of-subtree t t)
6761 (org-back-over-empty-lines)
6762 (point))
6763 what "children")
6764 (goto-char start)
6765 (show-subtree)
6766 (outline-next-heading))
6767 (t
6768 ;; we will sort the top-level entries in this file
6769 (goto-char (point-min))
6770 (or (org-on-heading-p) (outline-next-heading))
6771 (setq start (point) end (point-max) what "top-level")
6772 (goto-char start)
6773 (show-all)))
6775 (setq beg (point))
6776 (if (>= beg end) (error "Nothing to sort"))
6778 (unless plain-list-p
6780 (setq stars (match-string 1)
6781 re (concat "^" (regexp-quote stars) " +")
6782 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6783 txt (buffer-substring beg end))
6785 (if (and (not (equal stars "*")) (string-match re2 txt))
6786 (error "Region to sort contains a level above the first entry")))
6788 (unless sorting-type
6789 (message
6790 (if plain-list-p
6791 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6792 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6793 what)
6794 (setq sorting-type (read-char-exclusive))
6796 (and (= (downcase sorting-type) ?f)
6797 (setq getkey-func
6798 (completing-read "Sort using function: "
6799 obarray 'fboundp t nil nil))
6800 (setq getkey-func (intern getkey-func)))
6802 (and (= (downcase sorting-type) ?r)
6803 (setq property
6804 (completing-read "Property: "
6805 (mapcar 'list (org-buffer-property-keys t))
6806 nil t))))
6808 (message "Sorting entries...")
6810 (save-restriction
6811 (narrow-to-region start end)
6813 (let ((dcst (downcase sorting-type))
6814 (now (current-time)))
6815 (sort-subr
6816 (/= dcst sorting-type)
6817 ;; This function moves to the beginning character of the "record" to
6818 ;; be sorted.
6819 (if plain-list-p
6820 (lambda nil
6821 (if (org-at-item-p) t (goto-char (point-max))))
6822 (lambda nil
6823 (if (re-search-forward re nil t)
6824 (goto-char (match-beginning 0))
6825 (goto-char (point-max)))))
6826 ;; This function moves to the last character of the "record" being
6827 ;; sorted.
6828 (if plain-list-p
6829 'org-end-of-item
6830 (lambda nil
6831 (save-match-data
6832 (condition-case nil
6833 (outline-forward-same-level 1)
6834 (error
6835 (goto-char (point-max)))))))
6837 ;; This function returns the value that gets sorted against.
6838 (if plain-list-p
6839 (lambda nil
6841 (cond
6842 ((= dcst ?n)
6843 (string-to-number (buffer-substring (match-end 0)
6844 (point-at-eol))))
6845 ((= dcst ?a)
6846 (buffer-substring (match-end 0) (point-at-eol)))
6847 ((= dcst ?t)
6848 (if (re-search-forward org-ts-regexp
6849 (point-at-eol) t)
6850 (org-time-string-to-time (match-string 0))
6851 now))
6852 ((= dcst ?f)
6853 (if getkey-func
6854 (progn
6855 (setq tmp (funcall getkey-func))
6856 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6857 tmp)
6858 (error "Invalid key function `%s'" getkey-func)))
6859 (t (error "Invalid sorting type `%c'" sorting-type)))))
6860 (lambda nil
6861 (cond
6862 ((= dcst ?n)
6863 (if (looking-at outline-regexp)
6864 (string-to-number (buffer-substring (match-end 0)
6865 (point-at-eol)))
6866 nil))
6867 ((= dcst ?a)
6868 (funcall case-func (buffer-substring (point-at-bol)
6869 (point-at-eol))))
6870 ((= dcst ?t)
6871 (if (re-search-forward org-ts-regexp
6872 (save-excursion
6873 (forward-line 2)
6874 (point)) t)
6875 (org-time-string-to-time (match-string 0))
6876 now))
6877 ((= dcst ?p)
6878 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6879 (string-to-char (match-string 2))
6880 org-default-priority))
6881 ((= dcst ?r)
6882 (or (org-entry-get nil property) ""))
6883 ((= dcst ?f)
6884 (if getkey-func
6885 (progn
6886 (setq tmp (funcall getkey-func))
6887 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6888 tmp)
6889 (error "Invalid key function `%s'" getkey-func)))
6890 (t (error "Invalid sorting type `%c'" sorting-type)))))
6891 nil
6892 (cond
6893 ((= dcst ?a) 'string<)
6894 ((= dcst ?t) 'time-less-p)
6895 (t nil)))))
6896 (message "Sorting entries...done")))
6898 (defun org-do-sort (table what &optional with-case sorting-type)
6899 "Sort TABLE of WHAT according to SORTING-TYPE.
6900 The user will be prompted for the SORTING-TYPE if the call to this
6901 function does not specify it. WHAT is only for the prompt, to indicate
6902 what is being sorted. The sorting key will be extracted from
6903 the car of the elements of the table.
6904 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6905 (unless sorting-type
6906 (message
6907 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6908 what)
6909 (setq sorting-type (read-char-exclusive)))
6910 (let ((dcst (downcase sorting-type))
6911 extractfun comparefun)
6912 ;; Define the appropriate functions
6913 (cond
6914 ((= dcst ?n)
6915 (setq extractfun 'string-to-number
6916 comparefun (if (= dcst sorting-type) '< '>)))
6917 ((= dcst ?a)
6918 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6919 (lambda(x) (downcase (org-sort-remove-invisible x))))
6920 comparefun (if (= dcst sorting-type)
6921 'string<
6922 (lambda (a b) (and (not (string< a b))
6923 (not (string= a b)))))))
6924 ((= dcst ?t)
6925 (setq extractfun
6926 (lambda (x)
6927 (if (string-match org-ts-regexp x)
6928 (time-to-seconds
6929 (org-time-string-to-time (match-string 0 x)))
6930 0))
6931 comparefun (if (= dcst sorting-type) '< '>)))
6932 (t (error "Invalid sorting type `%c'" sorting-type)))
6934 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6935 table)
6936 (lambda (a b) (funcall comparefun (car a) (car b))))))
6938 ;;;; Plain list items, including checkboxes
6940 ;;; Plain list items
6942 (defun org-at-item-p ()
6943 "Is point in a line starting a hand-formatted item?"
6944 (let ((llt org-plain-list-ordered-item-terminator))
6945 (save-excursion
6946 (goto-char (point-at-bol))
6947 (looking-at
6948 (cond
6952 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6954 (defun org-in-item-p ()
6955 "It the cursor inside a plain list item.
6956 Does not have to be the first line."
6957 (save-excursion
6958 (condition-case nil
6959 (progn
6960 (org-beginning-of-item)
6961 (org-at-item-p)
6962 t)
6963 (error nil))))
6965 (defun org-insert-item (&optional checkbox)
6966 "Insert a new item at the current level.
6967 Return t when things worked, nil when we are not in an item."
6968 (when (save-excursion
6969 (condition-case nil
6970 (progn
6971 (org-beginning-of-item)
6972 (org-at-item-p)
6973 (if (org-invisible-p) (error "Invisible item"))
6974 t)
6975 (error nil)))
6976 (let* ((bul (match-string 0))
6978 (match-end 0)))
6979 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6980 pos)
6981 (cond
6982 ((and (org-at-item-p) (<= (point) eow))
6983 ;; before the bullet
6984 (beginning-of-line 1)
6985 (open-line (if blank 2 1)))
6986 ((<= (point) eow)
6987 (beginning-of-line 1))
6988 (t (newline (if blank 2 1))))
6989 (insert bul (if checkbox "[ ]" ""))
6990 (just-one-space)
6991 (setq pos (point))
6992 (end-of-line 1)
6993 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6994 (org-maybe-renumber-ordered-list)
6995 (and checkbox (org-update-checkbox-count-maybe))
6996 t))
6998 ;;; Checkboxes
7000 (defun org-at-item-checkbox-p ()
7001 "Is point at a line starting a plain-list item with a checklet?"
7002 (and (org-at-item-p)
7003 (save-excursion
7004 (goto-char (match-end 0))
7008 (defun org-toggle-checkbox (&optional arg)
7009 "Toggle the checkbox in the current line."
7010 (interactive "P")
7011 (catch 'exit
7012 (let (beg end status (firstnew 'unknown))
7013 (cond
7014 ((org-region-active-p)
7015 (setq beg (region-beginning) end (region-end)))
7016 ((org-on-heading-p)
7017 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7018 ((org-at-item-checkbox-p)
7019 (let ((pos (point)))
7020 (replace-match
7021 (cond (arg "[-]")
7022 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7023 (t "[ ]"))
7024 t t)
7025 (goto-char pos))
7026 (throw 'exit t))
7027 (t (error "Not at a checkbox or heading, and no active region")))
7028 (save-excursion
7029 (goto-char beg)
7030 (while (< (point) end)
7031 (when (org-at-item-checkbox-p)
7032 (setq status (equal (match-string 0) "[X]"))
7033 (when (eq firstnew 'unknown)
7034 (setq firstnew (not status)))
7035 (replace-match
7036 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7037 (beginning-of-line 2)))))
7038 (org-update-checkbox-count-maybe))
7040 (defun org-update-checkbox-count-maybe ()
7041 "Update checkbox statistics unless turned off by user."
7042 (when org-provide-checkbox-statistics
7043 (org-update-checkbox-count)))
7045 (defun org-update-checkbox-count (&optional all)
7046 "Update the checkbox statistics in the current section.
7047 This will find all statistic cookies like [57%] and [6/12] and update them
7048 with the current numbers. With optional prefix argument ALL, do this for
7049 the whole buffer."
7050 (interactive "P")
7051 (save-excursion
7052 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7053 (beg (condition-case nil
7054 (progn (outline-back-to-heading) (point))
7055 (error (point-min))))
7056 (end (move-marker (make-marker)
7057 (progn (outline-next-heading) (point))))
7061 beg-cookie end-cookie is-percent c-on c-off lim
7062 eline curr-ind next-ind continue-from startsearch
7063 (cstat 0)
7064 )
7065 (when all
7066 (goto-char (point-min))
7067 (outline-next-heading)
7068 (setq beg (point) end (point-max)))
7069 (goto-char end)
7070 ;; find each statistic cookie
7071 (while (re-search-backward re-find beg t)
7072 (setq beg-cookie (match-beginning 1)
7073 end-cookie (match-end 1)
7074 cstat (+ cstat (if end-cookie 1 0))
7075 startsearch (point-at-eol)
7076 continue-from (point-at-bol)
7077 is-percent (match-beginning 2)
7078 lim (cond
7079 ((org-on-heading-p) (outline-next-heading) (point))
7080 ((org-at-item-p) (org-end-of-item) (point))
7081 (t nil))
7082 c-on 0
7083 c-off 0)
7084 (when lim
7085 ;; find first checkbox for this cookie and gather
7086 ;; statistics from all that are at this indentation level
7087 (goto-char startsearch)
7088 (if (re-search-forward re-box lim t)
7089 (progn
7090 (org-beginning-of-item)
7091 (setq curr-ind (org-get-indentation))
7092 (setq next-ind curr-ind)
7093 (while (= curr-ind next-ind)
7094 (save-excursion (end-of-line) (setq eline (point)))
7095 (if (re-search-forward re-box eline t)
7096 (if (member (match-string 2) '("[ ]" "[-]"))
7097 (setq c-off (1+ c-off))
7098 (setq c-on (1+ c-on))
7099 )
7100 )
7101 (org-end-of-item)
7102 (setq next-ind (org-get-indentation))
7103 )))
7104 (goto-char continue-from)
7105 ;; update cookie
7106 (when end-cookie
7107 (delete-region beg-cookie end-cookie)
7108 (goto-char beg-cookie)
7109 (insert
7110 (if is-percent
7111 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7112 (format "[%d/%d]" c-on (+ c-on c-off)))))
7113 ;; update items checkbox if it has one
7114 (when (org-at-item-p)
7115 (org-beginning-of-item)
7116 (when (and (> (+ c-on c-off) 0)
7117 (re-search-forward re-box (point-at-eol) t))
7118 (setq beg-cookie (match-beginning 2)
7119 end-cookie (match-end 2))
7120 (delete-region beg-cookie end-cookie)
7121 (goto-char beg-cookie)
7122 (cond ((= c-off 0) (insert "[X]"))
7123 ((= c-on 0) (insert "[ ]"))
7124 (t (insert "[-]")))
7125 )))
7126 (goto-char continue-from))
7127 (when (interactive-p)
7128 (message "Checkbox satistics updated %s (%d places)"
7129 (if all "in entire file" "in current outline entry") cstat)))))
7131 (defun org-get-checkbox-statistics-face ()
7132 "Select the face for checkbox statistics.
7133 The face will be `org-done' when all relevant boxes are checked. Otherwise
7134 it will be `org-todo'."
7135 (if (match-end 1)
7136 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7137 (if (and (> (match-end 2) (match-beginning 2))
7138 (equal (match-string 2) (match-string 3)))
7139 'org-done
7140 'org-todo)))
7142 (defun org-get-indentation (&optional line)
7143 "Get the indentation of the current line, interpreting tabs.
7144 When LINE is given, assume it represents a line and compute its indentation."
7145 (if line
7146 (if (string-match "^ *" (org-remove-tabs line))
7147 (match-end 0))
7148 (save-excursion
7149 (beginning-of-line 1)
7151 (current-column))))
7153 (defun org-remove-tabs (s &optional width)
7154 "Replace tabulators in S with spaces.
7155 Assumes that s is a single line, starting in column 0."
7156 (setq width (or width tab-width))
7158 (setq s (replace-match
7159 (make-string
7160 (- (* width (/ (+ (match-beginning 0) width) width))
7161 (match-beginning 0)) ?\ )
7162 t t s)))
7163 s)
7165 (defun org-fix-indentation (line ind)
7166 "Fix indentation in LINE.
7167 IND is a cons cell with target and minimum indentation.
7168 If the current indenation in LINE is smaller than the minimum,
7169 leave it alone. If it is larger than ind, set it to the target."
7170 (let* ((l (org-remove-tabs line))
7171 (i (org-get-indentation l))
7172 (i1 (car ind)) (i2 (cdr ind)))
7173 (if (>= i i2) (setq l (substring line i2)))
7174 (if (> i1 0)
7175 (concat (make-string i1 ?\ ) l)
7176 l)))
7178 (defcustom org-empty-line-terminates-plain-lists nil
7179 "Non-nil means, an empty line ends all plain list levels.
7180 When nil, empty lines are part of the preceeding item."
7181 :group 'org-plain-lists
7182 :type 'boolean)
7184 (defun org-beginning-of-item ()
7185 "Go to the beginning of the current hand-formatted item.
7186 If the cursor is not in an item, throw an error."
7187 (interactive)
7188 (let ((pos (point))
7189 (limit (save-excursion
7190 (condition-case nil
7191 (progn
7192 (org-back-to-heading)
7193 (beginning-of-line 2) (point))
7194 (error (point-min)))))
7195 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7196 ind ind1)
7197 (if (org-at-item-p)
7198 (beginning-of-line 1)
7199 (beginning-of-line 1)
7201 (setq ind (current-column))
7202 (if (catch 'exit
7203 (while t
7204 (beginning-of-line 0)
7205 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7208 (setq ind1 ind-empty)
7210 (setq ind1 (current-column)))
7211 (if (< ind1 ind)
7212 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7213 nil
7214 (goto-char pos)
7215 (error "Not in an item")))))
7217 (defun org-end-of-item ()
7218 "Go to the end of the current hand-formatted item.
7219 If the cursor is not in an item, throw an error."
7220 (interactive)
7221 (let* ((pos (point))
7222 ind1
7223 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7224 (limit (save-excursion (outline-next-heading) (point)))
7225 (ind (save-excursion
7226 (org-beginning-of-item)
7228 (current-column)))
7229 (end (catch 'exit
7230 (while t
7231 (beginning-of-line 2)
7232 (if (eobp) (throw 'exit (point)))
7233 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7235 (setq ind1 ind-empty)
7237 (setq ind1 (current-column)))
7238 (if (<= ind1 ind)
7239 (throw 'exit (point-at-bol)))))))
7240 (if end
7241 (goto-char end)
7242 (goto-char pos)
7243 (error "Not in an item"))))
7245 (defun org-next-item ()
7246 "Move to the beginning of the next item in the current plain list.
7247 Error if not at a plain list, or if this is the last item in the list."
7248 (interactive)
7249 (let (ind ind1 (pos (point)))
7250 (org-beginning-of-item)
7251 (setq ind (org-get-indentation))
7252 (org-end-of-item)
7253 (setq ind1 (org-get-indentation))
7254 (unless (and (org-at-item-p) (= ind ind1))
7255 (goto-char pos)
7256 (error "On last item"))))
7258 (defun org-previous-item ()
7259 "Move to the beginning of the previous item in the current plain list.
7260 Error if not at a plain list, or if this is the first item in the list."
7261 (interactive)
7262 (let (beg ind ind1 (pos (point)))
7263 (org-beginning-of-item)
7264 (setq beg (point))
7265 (setq ind (org-get-indentation))
7266 (goto-char beg)
7267 (catch 'exit
7268 (while t
7269 (beginning-of-line 0)
7271 nil
7272 (if (<= (setq ind1 (org-get-indentation)) ind)
7273 (throw 'exit t)))))
7274 (condition-case nil
7275 (if (or (not (org-at-item-p))
7276 (< ind1 (1- ind)))
7277 (error "")
7278 (org-beginning-of-item))
7279 (error (goto-char pos)
7280 (error "On first item")))))
7282 (defun org-first-list-item-p ()
7283 "Is this heading the item in a plain list?"
7284 (unless (org-at-item-p)
7285 (error "Not at a plain list item"))
7286 (org-beginning-of-item)
7287 (= (point) (save-excursion (org-beginning-of-item-list))))
7289 (defun org-move-item-down ()
7290 "Move the plain list item at point down, i.e. swap with following item.
7291 Subitems (items with larger indentation) are considered part of the item,
7292 so this really moves item trees."
7293 (interactive)
7294 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7295 (org-beginning-of-item)
7296 (setq beg0 (point))
7297 (save-excursion
7298 (setq ne-beg (org-back-over-empty-lines))
7299 (setq beg (point)))
7300 (goto-char beg0)
7301 (setq ind (org-get-indentation))
7302 (org-end-of-item)
7303 (setq end0 (point))
7304 (setq ind1 (org-get-indentation))
7305 (setq ne-end (org-back-over-empty-lines))
7306 (setq end (point))
7307 (goto-char beg0)
7308 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7309 ;; include less whitespace
7310 (save-excursion
7311 (goto-char beg)
7312 (forward-line (- ne-beg ne-end))
7313 (setq beg (point))))
7314 (goto-char end0)
7315 (if (and (org-at-item-p) (= ind ind1))
7316 (progn
7317 (org-end-of-item)
7318 (org-back-over-empty-lines)
7319 (setq txt (buffer-substring beg end))
7320 (save-excursion
7321 (delete-region beg end))
7322 (setq pos (point))
7323 (insert txt)
7324 (goto-char pos) (org-skip-whitespace)
7325 (org-maybe-renumber-ordered-list))
7326 (goto-char pos)
7327 (error "Cannot move this item further down"))))
7329 (defun org-move-item-up (arg)
7330 "Move the plain list item at point up, i.e. swap with previous item.
7331 Subitems (items with larger indentation) are considered part of the item,
7332 so this really moves item trees."
7333 (interactive "p")
7334 (let (beg beg0 end ind ind1 (pos (point)) txt
7335 ne-beg ne-ins ins-end)
7336 (org-beginning-of-item)
7337 (setq beg0 (point))
7338 (setq ind (org-get-indentation))
7339 (save-excursion
7340 (setq ne-beg (org-back-over-empty-lines))
7341 (setq beg (point)))
7342 (goto-char beg0)
7343 (org-end-of-item)
7344 (setq end (point))
7345 (goto-char beg0)
7346 (catch 'exit
7347 (while t
7348 (beginning-of-line 0)
7350 (if org-empty-line-terminates-plain-lists
7351 (progn
7352 (goto-char pos)
7353 (error "Cannot move this item further up"))
7354 nil)
7355 (if (<= (setq ind1 (org-get-indentation)) ind)
7356 (throw 'exit t)))))
7357 (condition-case nil
7358 (org-beginning-of-item)
7359 (error (goto-char beg)
7360 (error "Cannot move this item further up")))
7361 (setq ind1 (org-get-indentation))
7362 (if (and (org-at-item-p) (= ind ind1))
7363 (progn
7364 (setq ne-ins (org-back-over-empty-lines))
7365 (setq txt (buffer-substring beg end))
7366 (save-excursion
7367 (delete-region beg end))
7368 (setq pos (point))
7369 (insert txt)
7370 (setq ins-end (point))
7371 (goto-char pos) (org-skip-whitespace)
7373 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7374 ;; Move whitespace back to beginning
7375 (save-excursion
7376 (goto-char ins-end)
7377 (let ((kill-whole-line t))
7378 (kill-line (- ne-ins ne-beg)) (point)))
7381 (org-maybe-renumber-ordered-list))
7382 (goto-char pos)
7383 (error "Cannot move this item further up"))))
7385 (defun org-maybe-renumber-ordered-list ()
7386 "Renumber the ordered list at point if setup allows it.
7387 This tests the user option `org-auto-renumber-ordered-lists' before
7388 doing the renumbering."
7389 (interactive)
7390 (when (and org-auto-renumber-ordered-lists
7391 (org-at-item-p))
7392 (if (match-beginning 3)
7393 (org-renumber-ordered-list 1)
7394 (org-fix-bullet-type))))
7396 (defun org-maybe-renumber-ordered-list-safe ()
7397 (condition-case nil
7398 (save-excursion
7399 (org-maybe-renumber-ordered-list))
7400 (error nil)))
7402 (defun org-cycle-list-bullet (&optional which)
7403 "Cycle through the different itemize/enumerate bullets.
7404 This cycle the entire list level through the sequence:
7406 `-' -> `+' -> `*' -> `1.' -> `1)'
7408 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7409 0 meand `-', 1 means `+' etc."
7410 (interactive "P")
7411 (org-preserve-lc
7412 (org-beginning-of-item-list)
7413 (org-at-item-p)
7414 (beginning-of-line 1)
7415 (let ((current (match-string 0))
7416 (prevp (eq which 'previous))
7417 new)
7418 (setq new (cond
7419 ((and (numberp which)
7420 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7421 ((string-match "-" current) (if prevp "1)" "+"))
7426 ((string-match ")" current) (if prevp "1." "-"))
7427 (t (error "This should not happen"))))
7429 (org-fix-bullet-type)
7430 (org-maybe-renumber-ordered-list))))
7432 (defun org-get-string-indentation (s)
7433 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7434 (let ((n -1) (i 0) (w tab-width) c)
7435 (catch 'exit
7436 (while (< (setq n (1+ n)) (length s))
7437 (setq c (aref s n))
7438 (cond ((= c ?\ ) (setq i (1+ i)))
7440 (t (throw 'exit t)))))
7441 i))
7443 (defun org-renumber-ordered-list (arg)
7444 "Renumber an ordered plain list.
7445 Cursor needs to be in the first line of an item, the line that starts
7447 (interactive "p")
7448 (unless (and (org-at-item-p)
7449 (match-beginning 3))
7450 (error "This is not an ordered list"))
7451 (let ((line (org-current-line))
7452 (col (current-column))
7453 (ind (org-get-string-indentation
7454 (buffer-substring (point-at-bol) (match-beginning 3))))
7455 ;; (term (substring (match-string 3) -1))
7456 ind1 (n (1- arg))
7457 fmt)
7458 ;; find where this list begins
7459 (org-beginning-of-item-list)
7461 (setq fmt (concat "%d" (match-string 1)))
7462 (beginning-of-line 0)
7463 ;; walk forward and replace these numbers
7464 (catch 'exit
7465 (while t
7466 (catch 'next
7467 (beginning-of-line 2)
7468 (if (eobp) (throw 'exit nil))
7471 (if (> ind1 ind) (throw 'next t))
7472 (if (< ind1 ind) (throw 'exit t))
7473 (if (not (org-at-item-p)) (throw 'exit nil))
7474 (delete-region (match-beginning 2) (match-end 2))
7475 (goto-char (match-beginning 2))
7476 (insert (format fmt (setq n (1+ n)))))))
7477 (goto-line line)
7478 (move-to-column col)))
7480 (defun org-fix-bullet-type ()
7481 "Make sure all items in this list have the same bullet as the firsst item."
7482 (interactive)
7483 (unless (org-at-item-p) (error "This is not a list"))
7484 (let ((line (org-current-line))
7485 (col (current-column))
7486 (ind (current-indentation))
7487 ind1 bullet)
7488 ;; find where this list begins
7489 (org-beginning-of-item-list)
7490 (beginning-of-line 1)
7491 ;; find out what the bullet type is
7493 (setq bullet (match-string 1))
7494 ;; walk forward and replace these numbers
7495 (beginning-of-line 0)
7496 (catch 'exit
7497 (while t
7498 (catch 'next
7499 (beginning-of-line 2)
7500 (if (eobp) (throw 'exit nil))
7503 (if (> ind1 ind) (throw 'next t))
7504 (if (< ind1 ind) (throw 'exit t))
7505 (if (not (org-at-item-p)) (throw 'exit nil))
7508 (replace-match bullet))))
7509 (goto-line line)
7510 (move-to-column col)
7511 (if (string-match "[0-9]" bullet)
7512 (org-renumber-ordered-list 1))))
7514 (defun org-beginning-of-item-list ()
7515 "Go to the beginning of the current item list.
7516 I.e. to the first item in this list."
7517 (interactive)
7518 (org-beginning-of-item)
7519 (let ((pos (point-at-bol))
7520 (ind (org-get-indentation))
7521 ind1)
7522 ;; find where this list begins
7523 (catch 'exit
7524 (while t
7525 (catch 'next
7526 (beginning-of-line 0)
7528 (throw (if (bobp) 'exit 'next) t))
7530 (if (or (< ind1 ind)
7531 (and (= ind1 ind)
7532 (not (org-at-item-p)))
7533 (bobp))
7534 (throw 'exit t)
7535 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7536 (goto-char pos)))
7539 (defun org-end-of-item-list ()
7540 "Go to the end of the current item list.
7541 I.e. to the text after the last item."
7542 (interactive)
7543 (org-beginning-of-item)
7544 (let ((pos (point-at-bol))
7545 (ind (org-get-indentation))
7546 ind1)
7547 ;; find where this list begins
7548 (catch 'exit
7549 (while t
7550 (catch 'next
7551 (beginning-of-line 2)
7553 (throw (if (eobp) 'exit 'next) t))
7555 (if (or (< ind1 ind)
7556 (and (= ind1 ind)
7557 (not (org-at-item-p)))
7558 (eobp))
7559 (progn
7560 (setq pos (point-at-bol))
7561 (throw 'exit t))))))
7562 (goto-char pos)))
7565 (defvar org-last-indent-begin-marker (make-marker))
7566 (defvar org-last-indent-end-marker (make-marker))
7568 (defun org-outdent-item (arg)
7569 "Outdent a local list item."
7570 (interactive "p")
7571 (org-indent-item (- arg)))
7573 (defun org-indent-item (arg)
7574 "Indent a local list item."
7575 (interactive "p")
7576 (unless (org-at-item-p)
7577 (error "Not on an item"))
7578 (save-excursion
7579 (let (beg end ind ind1 tmp delta ind-down ind-up)
7580 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7581 (setq beg org-last-indent-begin-marker
7582 end org-last-indent-end-marker)
7583 (org-beginning-of-item)
7584 (setq beg (move-marker org-last-indent-begin-marker (point)))
7585 (org-end-of-item)
7586 (setq end (move-marker org-last-indent-end-marker (point))))
7587 (goto-char beg)
7588 (setq tmp (org-item-indent-positions)
7589 ind (car tmp)
7590 ind-down (nth 2 tmp)
7591 ind-up (nth 1 tmp)
7592 delta (if (> arg 0)
7593 (if ind-down (- ind-down ind) 2)
7594 (if ind-up (- ind-up ind) -2)))
7595 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7596 (while (< (point) end)
7597 (beginning-of-line 1)
7599 (delete-region (point-at-bol) (point))
7600 (or (eolp) (indent-to-column (+ ind1 delta)))
7601 (beginning-of-line 2))))
7602 (org-fix-bullet-type)
7603 (org-maybe-renumber-ordered-list-safe)
7604 (save-excursion
7605 (beginning-of-line 0)
7606 (condition-case nil (org-beginning-of-item) (error nil))
7607 (org-maybe-renumber-ordered-list-safe)))
7609 (defun org-item-indent-positions ()
7610 "Return indentation for plain list items.
7611 This returns a list with three values: The current indentation, the
7612 parent indentation and the indentation a child should habe.
7613 Assumes cursor in item line."
7614 (let* ((bolpos (point-at-bol))
7615 (ind (org-get-indentation))
7616 ind-down ind-up pos)
7617 (save-excursion
7618 (org-beginning-of-item-list)
7620 (when (org-in-item-p)
7621 (org-beginning-of-item)
7622 (setq ind-up (org-get-indentation))))
7623 (setq pos (point))
7624 (save-excursion
7625 (cond
7626 ((and (condition-case nil (progn (org-previous-item) t)
7627 (error nil))
7628 (or (forward-char 1) t)
7629 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7630 (setq ind-down (org-get-indentation)))
7631 ((and (goto-char pos)
7632 (org-at-item-p))
7633 (goto-char (match-end 0))
7635 (setq ind-down (current-column)))))
7636 (list ind ind-up ind-down)))
7638 ;;; The orgstruct minor mode
7640 ;; Define a minor mode which can be used in other modes in order to
7641 ;; integrate the org-mode structure editing commands.
7643 ;; This is really a hack, because the org-mode structure commands use
7644 ;; keys which normally belong to the major mode. Here is how it
7645 ;; works: The minor mode defines all the keys necessary to operate the
7646 ;; structure commands, but wraps the commands into a function which
7647 ;; tests if the cursor is currently at a headline or a plain list
7648 ;; item. If that is the case, the structure command is used,
7649 ;; temporarily setting many Org-mode variables like regular
7650 ;; expressions for filling etc. However, when any of those keys is
7651 ;; used at a different location, function uses `key-binding' to look
7652 ;; up if the key has an associated command in another currently active
7653 ;; keymap (minor modes, major mode, global), and executes that
7654 ;; command. There might be problems if any of the keys is otherwise
7655 ;; used as a prefix key.
7657 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7658 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7659 ;; addresses this by checking explicitly for both bindings.
7661 (defvar orgstruct-mode-map (make-sparse-keymap)
7662 "Keymap for the minor `orgstruct-mode'.")
7664 (defvar org-local-vars nil
7665 "List of local variables, for use by `orgstruct-mode'")
7667 ;;;###autoload
7668 (define-minor-mode orgstruct-mode
7669 "Toggle the minor more `orgstruct-mode'.
7670 This mode is for using Org-mode structure commands in other modes.
7671 The following key behave as if Org-mode was active, if the cursor
7672 is on a headline, or on a plain list item (both in the definition
7673 of Org-mode).
7675 M-up Move entry/item up
7676 M-down Move entry/item down
7677 M-left Promote
7678 M-right Demote
7679 M-S-up Move entry/item up
7680 M-S-down Move entry/item down
7681 M-S-left Promote subtree
7682 M-S-right Demote subtree
7683 M-q Fill paragraph and items like in Org-mode
7684 C-c ^ Sort entries
7685 C-c - Cycle list bullet
7686 TAB Cycle item visibility
7687 M-RET Insert new heading/item
7688 S-M-RET Insert new TODO heading / Chekbox item
7689 C-c C-c Set tags / toggle checkbox"
7690 nil " OrgStruct" nil
7691 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7693 ;;;###autoload
7694 (defun turn-on-orgstruct ()
7695 "Unconditionally turn on `orgstruct-mode'."
7696 (orgstruct-mode 1))
7698 ;;;###autoload
7699 (defun turn-on-orgstruct++ ()
7700 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7701 In addition to setting orgstruct-mode, this also exports all indentation and
7702 autofilling variables from org-mode into the buffer. Note that turning
7703 off orgstruct-mode will *not* remove these additional settings."
7704 (orgstruct-mode 1)
7705 (let (var val)
7706 (mapc
7707 (lambda (x)
7708 (when (string-match
7710 (symbol-name (car x)))
7711 (setq var (car x) val (nth 1 x))
7712 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7713 org-local-vars)))
7715 (defun orgstruct-error ()
7716 "Error when there is no default binding for a structure key."
7717 (interactive)
7718 (error "This key has no function outside structure elements"))
7720 (defun orgstruct-setup ()
7721 "Setup orgstruct keymaps."
7722 (let ((nfunc 0)
7723 (bindings
7724 (list
7725 '([(meta up)] org-metaup)
7726 '([(meta down)] org-metadown)
7727 '([(meta left)] org-metaleft)
7728 '([(meta right)] org-metaright)
7729 '([(meta shift up)] org-shiftmetaup)
7730 '([(meta shift down)] org-shiftmetadown)
7731 '([(meta shift left)] org-shiftmetaleft)
7732 '([(meta shift right)] org-shiftmetaright)
7733 '([(shift up)] org-shiftup)
7734 '([(shift down)] org-shiftdown)
7735 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7736 '("\M-q" fill-paragraph)
7737 '("\C-c^" org-sort)
7738 '("\C-c-" org-cycle-list-bullet)))
7739 elt key fun cmd)
7740 (while (setq elt (pop bindings))
7741 (setq nfunc (1+ nfunc))
7742 (setq key (org-key (car elt))
7743 fun (nth 1 elt)
7744 cmd (orgstruct-make-binding fun nfunc key))
7745 (org-defkey orgstruct-mode-map key cmd))
7747 ;; Special treatment needed for TAB and RET
7748 (org-defkey orgstruct-mode-map [(tab)]
7749 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7750 (org-defkey orgstruct-mode-map "\C-i"
7751 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7753 (org-defkey orgstruct-mode-map "\M-\C-m"
7754 (orgstruct-make-binding 'org-insert-heading 105
7755 "\M-\C-m" [(meta return)]))
7756 (org-defkey orgstruct-mode-map [(meta return)]
7757 (orgstruct-make-binding 'org-insert-heading 106
7758 [(meta return)] "\M-\C-m"))
7760 (org-defkey orgstruct-mode-map [(shift meta return)]
7761 (orgstruct-make-binding 'org-insert-todo-heading 107
7762 [(meta return)] "\M-\C-m"))
7764 (unless org-local-vars
7765 (setq org-local-vars (org-get-local-variables)))
7767 t))
7769 (defun orgstruct-make-binding (fun n &rest keys)
7770 "Create a function for binding in the structure minor mode.
7771 FUN is the command to call inside a table. N is used to create a unique
7772 command name. KEYS are keys that should be checked in for a command
7773 to execute outside of tables."
7774 (eval
7775 (list 'defun
7776 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7777 '(arg)
7779 "Outside of structure, run the binding of `"
7780 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7781 "'.")
7782 '(interactive "p")
7783 (list 'if
7784 '(org-context-p 'headline 'item)
7785 (list 'org-run-like-in-org-mode (list 'quote fun))
7786 (list 'let '(orgstruct-mode)
7787 (list 'call-interactively
7788 (append '(or)
7789 (mapcar (lambda (k)
7790 (list 'key-binding k))
7791 keys)
7792 '('orgstruct-error))))))))
7794 (defun org-context-p (&rest contexts)
7795 "Check if local context is and of CONTEXTS.
7796 Possible values in the list of contexts are `table', `headline', and `item'."
7797 (let ((pos (point)))
7798 (goto-char (point-at-bol))
7799 (prog1 (or (and (memq 'table contexts)
7801 (and (memq 'headline contexts)
7803 (and (memq 'item contexts)
7805 (goto-char pos))))
7807 (defun org-get-local-variables ()
7808 "Return a list of all local variables in an org-mode buffer."
7809 (let (varlist)
7810 (with-current-buffer (get-buffer-create "*Org tmp*")
7811 (erase-buffer)
7812 (org-mode)
7813 (setq varlist (buffer-local-variables)))
7814 (kill-buffer "*Org tmp*")
7815 (delq nil
7816 (mapcar
7817 (lambda (x)
7818 (setq x
7819 (if (symbolp x)
7820 (list x)
7821 (list (car x) (list 'quote (cdr x)))))
7822 (if (string-match
7823 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7824 (symbol-name (car x)))
7825 x nil))
7826 varlist))))
7828 ;;;###autoload
7829 (defun org-run-like-in-org-mode (cmd)
7830 (unless org-local-vars
7831 (setq org-local-vars (org-get-local-variables)))
7832 (eval (list 'let org-local-vars
7833 (list 'call-interactively (list 'quote cmd)))))
7835 ;;;; Archiving
7837 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7839 (defun org-archive-subtree (&optional find-done)
7840 "Move the current subtree to the archive.
7841 The archive can be a certain top-level heading in the current file, or in
7842 a different file. The tree will be moved to that location, the subtree
7843 heading be marked DONE, and the current time will be added.
7845 When called with prefix argument FIND-DONE, find whole trees without any
7846 open TODO items and archive them (after getting confirmation from the user).
7847 If the cursor is not at a headline when this comand is called, try all level
7848 1 trees. If the cursor is on a headline, only try the direct children of
7849 this heading."
7850 (interactive "P")
7851 (if find-done
7852 (org-archive-all-done)
7853 ;; Save all relevant TODO keyword-relatex variables
7855 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7856 (tr-org-todo-keywords-1 org-todo-keywords-1)
7857 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7858 (tr-org-done-keywords org-done-keywords)
7859 (tr-org-todo-regexp org-todo-regexp)
7860 (tr-org-todo-line-regexp org-todo-line-regexp)
7861 (tr-org-odd-levels-only org-odd-levels-only)
7862 (this-buffer (current-buffer))
7863 (org-archive-location org-archive-location)
7865 ;; start of variables that will be used for saving context
7866 ;; The compiler complains about them - keep them anyway!
7867 (file (abbreviate-file-name (buffer-file-name)))
7868 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7869 (time (format-time-string
7870 (substring (cdr org-time-stamp-formats) 1 -1)
7871 (current-time)))
7872 afile heading buffer level newfile-p
7873 category todo priority
7874 ;; start of variables that will be used for savind context
7875 ltags itags prop)
7877 ;; Try to find a local archive location
7878 (save-excursion
7879 (save-restriction
7880 (widen)
7881 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7883 (setq org-archive-location prop)
7884 (if (or (re-search-backward re nil t)
7885 (re-search-forward re nil t))
7886 (setq org-archive-location (match-string 1))))))
7889 (progn
7890 (setq afile (format (match-string 1 org-archive-location)
7891 (file-name-nondirectory buffer-file-name))
7892 heading (match-string 2 org-archive-location)))
7893 (error "Invalid `org-archive-location'"))
7894 (if (> (length afile) 0)
7895 (setq newfile-p (not (file-exists-p afile))
7896 buffer (find-file-noselect afile))
7897 (setq buffer (current-buffer)))
7898 (unless buffer
7900 (if (and (> (length heading) 0)
7902 (setq level (match-end 0))
7903 (setq heading nil level 0))
7904 (save-excursion
7905 (org-back-to-heading t)
7906 ;; Get context information that will be lost by moving the tree
7907 (org-refresh-category-properties)
7908 (setq category (org-get-category)
7909 todo (and (looking-at org-todo-line-regexp)
7910 (match-string 2))
7911 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7912 ltags (org-get-tags)
7913 itags (org-delete-all ltags (org-get-tags-at)))
7914 (setq ltags (mapconcat 'identity ltags " ")
7915 itags (mapconcat 'identity itags " "))
7916 ;; We first only copy, in case something goes wrong
7917 ;; we need to protect this-command, to avoid kill-region sets it,
7918 ;; which would lead to duplication of subtrees
7919 (let (this-command) (org-copy-subtree))
7920 (set-buffer buffer)
7921 ;; Enforce org-mode for the archive buffer
7922 (if (not (org-mode-p))
7923 ;; Force the mode for future visits.
7924 (let ((org-insert-mode-line-in-empty-file t)
7925 (org-inhibit-startup t))
7926 (call-interactively 'org-mode)))
7927 (when newfile-p
7928 (goto-char (point-max))
7930 (buffer-file-name this-buffer))))
7931 ;; Force the TODO keywords of the original buffer
7932 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7933 (org-todo-keywords-1 tr-org-todo-keywords-1)
7934 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7935 (org-done-keywords tr-org-done-keywords)
7936 (org-todo-regexp tr-org-todo-regexp)
7937 (org-todo-line-regexp tr-org-todo-line-regexp)
7938 (org-odd-levels-only
7939 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7940 org-odd-levels-only
7941 tr-org-odd-levels-only)))
7942 (goto-char (point-min))
7943 (if heading
7944 (progn
7945 (if (re-search-forward
7946 (concat "^" (regexp-quote heading)
7948 nil t)
7949 (goto-char (match-end 0))
7950 ;; Heading not found, just insert it at the end
7951 (goto-char (point-max))
7954 (end-of-line 0))
7955 ;; Make the subtree visible
7956 (show-subtree)
7957 (org-end-of-subtree t)
7961 ;; No specific heading, just go to end of file.
7963 ;; Paste
7964 (org-paste-subtree (org-get-legal-level level 1))
7966 ;; Mark the entry as done
7967 (when (and org-archive-mark-done
7968 (looking-at org-todo-line-regexp)
7969 (or (not (match-end 2))
7970 (not (member (match-string 2) org-done-keywords))))
7971 (let (org-log-done org-todo-log-states)
7972 (org-todo
7973 (car (or (member org-archive-mark-done org-done-keywords)
7974 org-done-keywords)))))
7976 ;; Add the context info
7977 (when org-archive-save-context-info
7978 (let ((l org-archive-save-context-info) e n v)
7979 (while (setq e (pop l))
7980 (when (and (setq v (symbol-value e))
7982 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7983 (org-entry-put (point) n v)))))
7985 ;; Save the buffer, if it is not the same buffer.
7986 (if (not (eq this-buffer buffer)) (save-buffer))))
7987 ;; Here we are back in the original buffer. Everything seems to have
7988 ;; worked. So now cut the tree and finish up.
7989 (let (this-command) (org-cut-subtree))
7991 (message "Subtree archived %s"
7992 (if (eq this-buffer buffer)
7993 (concat "under heading: " heading)
7994 (concat "in file: " (abbreviate-file-name afile)))))))
7996 (defun org-refresh-category-properties ()
7997 "Refresh category text properties in teh buffer."
7998 (let ((def-cat (cond
7999 ((null org-category)
8000 (if buffer-file-name
8001 (file-name-sans-extension
8002 (file-name-nondirectory buffer-file-name))
8003 "???"))
8004 ((symbolp org-category) (symbol-name org-category))
8005 (t org-category)))
8006 beg end cat pos optionp)
8007 (org-unmodified
8008 (save-excursion
8009 (save-restriction
8010 (widen)
8011 (goto-char (point-min))
8012 (put-text-property (point) (point-max) 'org-category def-cat)
8013 (while (re-search-forward
8015 (setq pos (match-end 0)
8016 optionp (equal (char-after (match-beginning 0)) ?#)
8017 cat (org-trim (match-string 2)))
8018 (if optionp
8019 (setq beg (point-at-bol) end (point-max))
8020 (org-back-to-heading t)
8021 (setq beg (point) end (org-end-of-subtree t t)))
8022 (put-text-property beg end 'org-category cat)
8023 (goto-char pos)))))))
8025 (defun org-archive-all-done (&optional tag)
8026 "Archive sublevels of the current tree without open TODO items.
8027 If the cursor is not on a headline, try all level 1 trees. If
8028 it is on a headline, try all direct children.
8029 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8031 (rea (concat ".*:" org-archive-tag ":"))
8032 (begm (make-marker))
8033 (endm (make-marker))
8034 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8035 "Move subtree to archive (no open TODO items)? "))
8036 beg end (cntarch 0))
8037 (if (org-on-heading-p)
8038 (progn
8039 (setq re1 (concat "^" (regexp-quote
8040 (make-string
8041 (1+ (- (match-end 0) (match-beginning 0) 1))
8042 ?*))
8043 " "))
8044 (move-marker begm (point))
8045 (move-marker endm (org-end-of-subtree t)))
8046 (setq re1 "^* ")
8047 (move-marker begm (point-min))
8048 (move-marker endm (point-max)))
8049 (save-excursion
8050 (goto-char begm)
8051 (while (re-search-forward re1 endm t)
8052 (setq beg (match-beginning 0)
8053 end (save-excursion (org-end-of-subtree t) (point)))
8054 (goto-char beg)
8055 (if (re-search-forward re end t)
8056 (goto-char end)
8057 (goto-char beg)
8058 (if (and (or (not tag) (not (looking-at rea)))
8059 (y-or-n-p question))
8060 (progn
8061 (if tag
8062 (org-toggle-tag org-archive-tag 'on)
8063 (org-archive-subtree))
8064 (setq cntarch (1+ cntarch)))
8065 (goto-char end)))))
8066 (message "%d trees archived" cntarch)))
8068 (defun org-cycle-hide-drawers (state)
8069 "Re-hide all drawers after a visibility state change."
8070 (when (and (org-mode-p)
8071 (not (memq state '(overview folded))))
8072 (save-excursion
8073 (let* ((globalp (memq state '(contents all)))
8074 (beg (if globalp (point-min) (point)))
8075 (end (if globalp (point-max) (org-end-of-subtree t))))
8076 (goto-char beg)
8077 (while (re-search-forward org-drawer-regexp end t)
8078 (org-flag-drawer t))))))
8080 (defun org-flag-drawer (flag)
8081 (save-excursion
8082 (beginning-of-line 1)
8084 (let ((b (match-end 0))
8085 (outline-regexp org-outline-regexp))
8086 (if (re-search-forward
8088 (save-excursion (outline-next-heading) (point)) t)
8089 (outline-flag-region b (point-at-eol) flag)
8090 (error ":END: line missing"))))))
8092 (defun org-cycle-hide-archived-subtrees (state)
8093 "Re-hide all archived subtrees after a visibility state change."
8094 (when (and (not org-cycle-open-archived-trees)
8095 (not (memq state '(overview folded))))
8096 (save-excursion
8097 (let* ((globalp (memq state '(contents all)))
8098 (beg (if globalp (point-min) (point)))
8099 (end (if globalp (point-max) (org-end-of-subtree t))))
8100 (org-hide-archived-subtrees beg end)
8101 (goto-char beg)
8102 (if (looking-at (concat ".*:" org-archive-tag ":"))
8103 (message "%s" (substitute-command-keys
8104 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8106 (defun org-force-cycle-archived ()
8107 "Cycle subtree even if it is archived."
8108 (interactive)
8109 (setq this-command 'org-cycle)
8110 (let ((org-cycle-open-archived-trees t))
8111 (call-interactively 'org-cycle)))
8113 (defun org-hide-archived-subtrees (beg end)
8114 "Re-hide all archived subtrees after a visibility state change."
8115 (save-excursion
8116 (let* ((re (concat ":" org-archive-tag ":")))
8117 (goto-char beg)
8118 (while (re-search-forward re end t)
8119 (and (org-on-heading-p) (hide-subtree))
8120 (org-end-of-subtree t)))))
8122 (defun org-toggle-tag (tag &optional onoff)
8123 "Toggle the tag TAG for the current line.
8124 If ONOFF is `on' or `off', don't toggle but set to this state."
8125 (unless (org-on-heading-p t) (error "Not on headling"))
8126 (let (res current)
8127 (save-excursion
8128 (beginning-of-line)
8130 (point-at-eol) t)
8131 (progn
8132 (setq current (match-string 1))
8133 (replace-match ""))
8134 (setq current ""))
8135 (setq current (nreverse (org-split-string current ":")))
8136 (cond
8137 ((eq onoff 'on)
8138 (setq res t)
8139 (or (member tag current) (push tag current)))
8140 ((eq onoff 'off)
8141 (or (not (member tag current)) (setq current (delete tag current))))
8142 (t (if (member tag current)
8143 (setq current (delete tag current))
8144 (setq res t)
8145 (push tag current))))
8146 (end-of-line 1)
8147 (if current
8148 (progn
8149 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8150 (org-set-tags nil t))
8151 (delete-horizontal-space))
8152 (run-hooks 'org-after-tags-change-hook))
8153 res))
8155 (defun org-toggle-archive-tag (&optional arg)
8156 "Toggle the archive tag for the current headline.
8157 With prefix ARG, check all children of current headline and offer tagging
8158 the children that do not contain any open TODO items."
8159 (interactive "P")
8160 (if arg
8161 (org-archive-all-done 'tag)
8162 (let (set)
8163 (save-excursion
8164 (org-back-to-heading t)
8165 (setq set (org-toggle-tag org-archive-tag))
8166 (when set (hide-subtree)))
8167 (and set (beginning-of-line 1))
8168 (message "Subtree %s" (if set "archived" "unarchived")))))
8171 ;;;; Tables
8173 ;;; The table editor
8175 ;; Watch out: Here we are talking about two different kind of tables.
8176 ;; Most of the code is for the tables created with the Org-mode table editor.
8177 ;; Sometimes, we talk about tables created and edited with the table.el
8178 ;; Emacs package. We call the former org-type tables, and the latter
8179 ;; table.el-type tables.
8181 (defun org-before-change-function (beg end)
8182 "Every change indicates that a table might need an update."
8183 (setq org-table-may-need-update t))
8186 "Detects an org-type table line.")
8188 "Detects an org-type table line.")
8190 "Detects a table line marked for automatic recalculation.")
8192 "Detects a table line marked for automatic recalculation.")
8194 "Detects a table line marked for automatic recalculation.")
8196 "Detects an org-type table hline.")
8198 "Detects a table-type table hline.")
8200 "Detects an org-type or table-type table.")
8202 "Searching from within a table (any type) this finds the first line
8203 outside the table.")
8205 "Searching from within a table (any type) this finds the first line
8206 outside the table.")
8208 (defvar org-table-last-highlighted-reference nil)
8209 (defvar org-table-formula-history nil)
8211 (defvar org-table-column-names nil
8212 "Alist with column names, derived from the `!' line.")
8213 (defvar org-table-column-name-regexp nil
8214 "Regular expression matching the current column names.")
8215 (defvar org-table-local-parameters nil
8216 "Alist with parameter names, derived from the `$' line.")
8217 (defvar org-table-named-field-locations nil
8218 "Alist with locations of named fields.")
8220 (defvar org-table-current-line-types nil
8221 "Table row types, non-nil only for the duration of a comand.")
8222 (defvar org-table-current-begin-line nil
8223 "Table begin line, non-nil only for the duration of a comand.")
8224 (defvar org-table-current-begin-pos nil
8225 "Table begin position, non-nil only for the duration of a comand.")
8226 (defvar org-table-dlines nil
8227 "Vector of data line line numbers in the current table.")
8228 (defvar org-table-hlines nil
8229 "Vector of hline line numbers in the current table.")
8231 (defconst org-table-range-regexp
8232 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8233 ;; 1 2 3 4 5
8234 "Regular expression for matching ranges in formulas.")
8236 (defconst org-table-range-regexp2
8237 (concat
8241 "Match a range for reference display.")
8243 (defconst org-table-translate-regexp
8245 "Match a reference that needs translation, for reference display.")
8247 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8249 (defun org-table-create-with-table.el ()
8250 "Use the table.el package to insert a new table.
8251 If there is already a table at point, convert between Org-mode tables
8252 and table.el tables."
8253 (interactive)
8254 (require 'table)
8255 (cond
8256 ((org-at-table.el-p)
8257 (if (y-or-n-p "Convert table to Org-mode table? ")
8258 (org-table-convert)))
8259 ((org-at-table-p)
8260 (if (y-or-n-p "Convert table to table.el table? ")
8261 (org-table-convert)))
8262 (t (call-interactively 'table-insert))))
8264 (defun org-table-create-or-convert-from-region (arg)
8265 "Convert region to table, or create an empty table.
8266 If there is an active region, convert it to a table, using the function
8267 `org-table-convert-region'. See the documentation of that function
8268 to learn how the prefix argument is interpreted to determine the field
8269 separator.
8270 If there is no such region, create an empty table with `org-table-create'."
8271 (interactive "P")
8272 (if (org-region-active-p)
8273 (org-table-convert-region (region-beginning) (region-end) arg)
8274 (org-table-create arg)))
8276 (defun org-table-create (&optional size)
8277 "Query for a size and insert a table skeleton.
8279 (interactive "P")
8280 (unless size
8281 (setq size (read-string
8282 (concat "Table size Columns x Rows [e.g. "
8283 org-table-default-size "]: ")
8284 "" nil org-table-default-size)))
8286 (let* ((pos (point))
8287 (indent (make-string (current-column) ?\ ))
8288 (split (org-split-string size " *x *"))
8289 (rows (string-to-number (nth 1 split)))
8290 (columns (string-to-number (car split)))
8291 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8294 (point-at-bol) (point)))
8295 (beginning-of-line 1)
8296 (newline))
8297 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8298 (dotimes (i rows) (insert line))
8299 (goto-char pos)
8300 (if (> rows 1)
8301 ;; Insert a hline after the first row.
8302 (progn
8303 (end-of-line 1)
8305 (goto-char pos)))
8306 (org-table-align)))
8308 (defun org-table-convert-region (beg0 end0 &optional separator)
8309 "Convert region to a table.
8310 The region goes from BEG0 to END0, but these borders will be moved
8311 slightly, to make sure a beginning of line in the first line is included.
8313 SEPARATOR specifies the field separator in the lines. It can have the
8314 following values:
8316 '(4) Use the comma as a field separator
8317 '(16) Use a TAB as field separator
8318 integer When a number, use that many spaces as field separator
8319 nil When nil, the command tries to be smart and figure out the
8320 separator in the following way:
8321 - when each line contains a TAB, assume TAB-separated material
8322 - when each line contains a comme, assume CSV material
8323 - else, assume one or more SPACE charcters as separator."
8324 (interactive "rP")
8325 (let* ((beg (min beg0 end0))
8326 (end (max beg0 end0))
8327 re)
8328 (goto-char beg)
8329 (beginning-of-line 1)
8330 (setq beg (move-marker (make-marker) (point)))
8331 (goto-char end)
8332 (if (bolp) (backward-char 1) (end-of-line 1))
8333 (setq end (move-marker (make-marker) (point)))
8334 ;; Get the right field separator
8335 (unless separator
8336 (goto-char beg)
8337 (setq separator
8338 (cond
8341 (t 1))))
8342 (setq re (cond
8345 ((integerp separator)
8347 (t (error "This should not happen"))))
8348 (goto-char beg)
8349 (while (re-search-forward re end t)
8350 (replace-match "| " t t))
8351 (goto-char beg)
8352 (insert " ")
8353 (org-table-align)))
8355 (defun org-table-import (file arg)
8356 "Import FILE as a table.
8357 The file is assumed to be tab-separated. Such files can be produced by most
8358 spreadsheet and database applications. If no tabs (at least one per line)
8359 are found, lines will be split on whitespace into fields."
8361 (or (bolp) (newline))
8362 (let ((beg (point))
8363 (pm (point-max)))
8364 (insert-file-contents file)
8365 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8367 (defun org-table-export ()
8368 "Export table as a tab-separated file.
8369 Such a file can be imported into a spreadsheet program like Excel."
8370 (interactive)
8371 (let* ((beg (org-table-begin))
8372 (end (org-table-end))
8373 (table (buffer-substring beg end))
8374 (file (read-file-name "Export table to: "))
8375 buf)
8376 (unless (or (not (file-exists-p file))
8377 (y-or-n-p (format "Overwrite file %s? " file)))
8378 (error "Abort"))
8379 (with-current-buffer (find-file-noselect file)
8380 (setq buf (current-buffer))
8381 (erase-buffer)
8382 (fundamental-mode)
8383 (insert table)
8384 (goto-char (point-min))
8386 (replace-match "" t t)
8387 (end-of-line 1))
8388 (goto-char (point-min))
8390 (replace-match "" t t)
8391 (goto-char (min (1+ (point)) (point-max))))
8392 (goto-char (point-min))
8393 (while (re-search-forward "^-[-+]*$" nil t)
8394 (replace-match "")
8396 (delete-char 1)))
8397 (goto-char (point-min))
8400 (save-buffer))
8401 (kill-buffer buf)))
8403 (defvar org-table-aligned-begin-marker (make-marker)
8404 "Marker at the beginning of the table last aligned.
8405 Used to check if cursor still is in that table, to minimize realignment.")
8406 (defvar org-table-aligned-end-marker (make-marker)
8407 "Marker at the end of the table last aligned.
8408 Used to check if cursor still is in that table, to minimize realignment.")
8409 (defvar org-table-last-alignment nil
8410 "List of flags for flushright alignment, from the last re-alignment.
8411 This is being used to correctly align a single field after TAB or RET.")
8412 (defvar org-table-last-column-widths nil
8413 "List of max width of fields in each column.
8414 This is being used to correctly align a single field after TAB or RET.")
8415 (defvar org-table-overlay-coordinates nil
8416 "Overlay coordinates after each align of a table.")
8417 (make-variable-buffer-local 'org-table-overlay-coordinates)
8419 (defvar org-last-recalc-line nil)
8420 (defconst org-narrow-column-arrow "=>"
8421 "Used as display property in narrowed table columns.")
8423 (defun org-table-align ()
8424 "Align the table at point by aligning all vertical bars."
8425 (interactive)
8426 (let* (
8427 ;; Limits of table
8428 (beg (org-table-begin))
8429 (end (org-table-end))
8430 ;; Current cursor position
8431 (linepos (org-current-line))
8432 (colpos (org-table-current-column))
8433 (winstart (window-start))
8434 (winstartline (org-current-line (min winstart (1- (point-max)))))
8435 lines (new "") lengths l typenums ty fields maxfields i
8436 column
8437 (indent "") cnt frac
8438 rfmt hfmt
8439 (spaces '(1 . 1))
8440 (sp1 (car spaces))
8441 (sp2 (cdr spaces))
8442 (rfmt1 (concat
8443 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8444 (hfmt1 (concat
8445 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8446 emptystrings links dates emph narrow fmax f1 len c e)
8447 (untabify beg end)
8448 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8449 ;; Check if we have links or dates
8450 (goto-char beg)
8451 (setq links (re-search-forward org-bracket-link-regexp end t))
8452 (goto-char beg)
8453 (setq emph (and org-hide-emphasis-markers
8454 (re-search-forward org-emph-re end t)))
8455 (goto-char beg)
8456 (setq dates (and org-display-custom-times
8457 (re-search-forward org-ts-regexp-both end t)))
8458 ;; Make sure the link properties are right
8459 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8460 ;; Make sure the date properties are right
8461 (when dates (goto-char beg) (while (org-activate-dates end)))
8462 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8464 ;; Check if we are narrowing any columns
8465 (goto-char beg)
8466 (setq narrow (and org-format-transports-properties-p
8467 (re-search-forward "<[0-9]+>" end t)))
8468 ;; Get the rows
8469 (setq lines (org-split-string
8471 ;; Store the indentation of the first line
8472 (if (string-match "^ *" (car lines))
8473 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8474 ;; Mark the hlines by setting the corresponding element to nil
8475 ;; At the same time, we remove trailing space.
8476 (setq lines (mapcar (lambda (l)
8477 (if (string-match "^ *|-" l)
8478 nil
8480 (substring l 0 (match-beginning 0))
8481 l)))
8482 lines))
8483 ;; Get the data fields by splitting the lines.
8484 (setq fields (mapcar
8485 (lambda (l)
8486 (org-split-string l " *| *"))
8487 (delq nil (copy-sequence lines))))
8488 ;; How many fields in the longest line?
8489 (condition-case nil
8490 (setq maxfields (apply 'max (mapcar 'length fields)))
8491 (error
8492 (kill-region beg end)
8493 (org-table-create org-table-default-size)
8494 (error "Empty table - created default table")))
8495 ;; A list of empty strings to fill any short rows on output
8496 (setq emptystrings (make-list maxfields ""))
8497 ;; Check for special formatting.
8498 (setq i -1)
8499 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8500 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8501 ;; Check if there is an explicit width specified
8502 (when narrow
8503 (setq c column fmax nil)
8504 (while c
8505 (setq e (pop c))
8507 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8508 ;; Find fields that are wider than fmax, and shorten them
8509 (when fmax
8510 (loop for xx in column do
8511 (when (and (stringp xx)
8512 (> (org-string-width xx) fmax))
8513 (org-add-props xx nil
8514 'help-echo
8515 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8516 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8517 (unless (> f1 1)
8519 (match-string 0 xx)))
8520 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8521 (add-text-properties (- f1 2) f1
8522 (list 'display org-narrow-column-arrow)
8523 xx)))))
8524 ;; Get the maximum width for each column
8525 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8526 ;; Get the fraction of numbers, to decide about alignment of the column
8527 (setq cnt 0 frac 0.0)
8528 (loop for x in column do
8529 (if (equal x "")
8530 nil
8531 (setq frac ( / (+ (* frac cnt)
8532 (if (string-match org-table-number-regexp x) 1 0))
8533 (setq cnt (1+ cnt))))))
8534 (push (>= frac org-table-number-fraction) typenums))
8535 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8537 ;; Store the alignment of this table, for later editing of single fields
8538 (setq org-table-last-alignment typenums
8539 org-table-last-column-widths lengths)
8541 ;; With invisible characters, `format' does not get the field width right
8542 ;; So we need to make these fields wide by hand.
8543 (when (or links emph)
8544 (loop for i from 0 upto (1- maxfields) do
8545 (setq len (nth i lengths))
8546 (loop for j from 0 upto (1- (length fields)) do
8547 (setq c (nthcdr i (car (nthcdr j fields))))
8548 (if (and (stringp (car c))
8549 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8550 ; (string-match org-bracket-link-regexp (car c))
8551 (< (org-string-width (car c)) len))
8552 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8554 ;; Compute the formats needed for output of the table
8555 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8556 (while (setq l (pop lengths))
8557 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8558 (setq rfmt (concat rfmt (format rfmt1 ty l))
8559 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8563 (setq new (mapconcat
8564 (lambda (l)
8565 (if l (apply 'format rfmt
8566 (append (pop fields) emptystrings))
8567 hfmt))
8568 lines ""))
8569 ;; Replace the old one
8570 (delete-region beg end)
8571 (move-marker end nil)
8572 (move-marker org-table-aligned-begin-marker (point))
8573 (insert new)
8574 (move-marker org-table-aligned-end-marker (point))
8575 (when (and orgtbl-mode (not (org-mode-p)))
8576 (goto-char org-table-aligned-begin-marker)
8577 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8578 ;; Try to move to the old location
8579 (goto-line winstartline)
8580 (setq winstart (point-at-bol))
8581 (goto-line linepos)
8582 (set-window-start (selected-window) winstart 'noforce)
8583 (org-table-goto-column colpos)
8584 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8585 (setq org-table-may-need-update nil)
8586 ))
8588 (defun org-string-width (s)
8589 "Compute width of string, ignoring invisible characters.
8590 This ignores character with invisibility property `org-link', and also
8591 characters with property `org-cwidth', because these will become invisible
8592 upon the next fontification round."
8593 (let (b l)
8594 (when (or (eq t buffer-invisibility-spec)
8595 (assq 'org-link buffer-invisibility-spec))
8596 (while (setq b (text-property-any 0 (length s)
8597 'invisible 'org-link s))
8598 (setq s (concat (substring s 0 b)
8599 (substring s (or (next-single-property-change
8600 b 'invisible s) (length s)))))))
8601 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8602 (setq s (concat (substring s 0 b)
8603 (substring s (or (next-single-property-change
8604 b 'org-cwidth s) (length s))))))
8605 (setq l (string-width s) b -1)
8606 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8607 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8608 l))
8610 (defun org-table-begin (&optional table-type)
8611 "Find the beginning of the table and return its position.
8612 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8613 (save-excursion
8614 (if (not (re-search-backward
8615 (if table-type org-table-any-border-regexp
8616 org-table-border-regexp)
8617 nil t))
8618 (progn (goto-char (point-min)) (point))
8619 (goto-char (match-beginning 0))
8620 (beginning-of-line 2)
8621 (point))))
8623 (defun org-table-end (&optional table-type)
8624 "Find the end of the table and return its position.
8625 With argument TABLE-TYPE, go to the end of a table.el-type table."
8626 (save-excursion
8627 (if (not (re-search-forward
8628 (if table-type org-table-any-border-regexp
8629 org-table-border-regexp)
8630 nil t))
8631 (goto-char (point-max))
8632 (goto-char (match-beginning 0)))
8633 (point-marker)))
8635 (defun org-table-justify-field-maybe (&optional new)
8636 "Justify the current field, text to left, number to right.
8637 Optional argument NEW may specify text to replace the current field content."
8638 (cond
8639 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8640 ((org-at-table-hline-p))
8641 ((and (not new)
8642 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8643 (current-buffer)))
8644 (< (point) org-table-aligned-begin-marker)
8645 (>= (point) org-table-aligned-end-marker)))
8646 ;; This is not the same table, force a full re-align
8647 (setq org-table-may-need-update t))
8648 (t ;; realign the current field, based on previous full realign
8649 (let* ((pos (point)) s
8650 (col (org-table-current-column))
8651 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8652 l f n o e)
8653 (when (> col 0)
8656 (progn
8657 (setq s (match-string 1)
8658 o (match-string 0)
8659 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8660 e (not (= (match-beginning 2) (match-end 2))))
8661 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8662 l (if e "|" (setq org-table-may-need-update t) ""))
8663 n (format f s))
8664 (if new
8665 (if (<= (length new) l) ;; FIXME: length -> str-width?
8666 (setq n (format f new))
8667 (setq n (concat new "|") org-table-may-need-update t)))
8668 (or (equal n o)
8669 (let (org-table-may-need-update)
8670 (replace-match n t t))))
8671 (setq org-table-may-need-update t))
8672 (goto-char pos))))))
8674 (defun org-table-next-field ()
8675 "Go to the next field in the current table, creating new lines as needed.
8676 Before doing so, re-align the table if necessary."
8677 (interactive)
8678 (org-table-maybe-eval-formula)
8679 (org-table-maybe-recalculate-line)
8680 (if (and org-table-automatic-realign
8681 org-table-may-need-update)
8682 (org-table-align))
8683 (let ((end (org-table-end)))
8684 (if (org-at-table-hline-p)
8685 (end-of-line 1))
8686 (condition-case nil
8687 (progn
8688 (re-search-forward "|" end)
8690 (re-search-forward "|" end))
8691 (if (and (looking-at "-")
8692 org-table-tab-jumps-over-hlines
8694 (goto-char (match-beginning 1)))
8695 (if (looking-at "-")
8696 (progn
8697 (beginning-of-line 0)
8698 (org-table-insert-row 'below))
8699 (if (looking-at " ") (forward-char 1))))
8700 (error
8701 (org-table-insert-row 'below)))))
8703 (defun org-table-previous-field ()
8704 "Go to the previous field in the table.
8705 Before doing so, re-align the table if necessary."
8706 (interactive)
8707 (org-table-justify-field-maybe)
8708 (org-table-maybe-recalculate-line)
8709 (if (and org-table-automatic-realign
8710 org-table-may-need-update)
8711 (org-table-align))
8712 (if (org-at-table-hline-p)
8713 (end-of-line 1))
8714 (re-search-backward "|" (org-table-begin))
8715 (re-search-backward "|" (org-table-begin))
8717 (re-search-backward "|" (org-table-begin)))
8718 (if (looking-at "| ?")
8719 (goto-char (match-end 0))))
8721 (defun org-table-next-row ()
8722 "Go to the next row (same column) in the current table.
8723 Before doing so, re-align the table if necessary."
8724 (interactive)
8725 (org-table-maybe-eval-formula)
8726 (org-table-maybe-recalculate-line)
8729 (newline)
8730 (if (and org-table-automatic-realign
8731 org-table-may-need-update)
8732 (org-table-align))
8733 (let ((col (org-table-current-column)))
8734 (beginning-of-line 2)
8735 (if (or (not (org-at-table-p))
8736 (org-at-table-hline-p))
8737 (progn
8738 (beginning-of-line 0)
8739 (org-table-insert-row 'below)))
8740 (org-table-goto-column col)
8742 (if (looking-at " ") (forward-char 1)))))
8744 (defun org-table-copy-down (n)
8745 "Copy a field down in the current column.
8746 If the field at the cursor is empty, copy into it the content of the nearest
8747 non-empty field above. With argument N, use the Nth non-empty field.
8748 If the current field is not empty, it is copied down to the next row, and
8749 the cursor is moved with it. Therefore, repeating this command causes the
8750 column to be filled row-by-row.
8751 If the variable `org-table-copy-increment' is non-nil and the field is an
8752 integer or a timestamp, it will be incremented while copying. In the case of
8753 a timestamp, if the cursor is on the year, change the year. If it is on the
8754 month or the day, change that. Point will stay on the current date field
8755 in order to easily repeat the interval."
8756 (interactive "p")
8757 (let* ((colpos (org-table-current-column))
8758 (col (current-column))
8759 (field (org-table-get-field))
8761 (beg (org-table-begin))
8762 txt)
8763 (org-table-check-inside-data-field)
8764 (if non-empty
8765 (progn
8766 (setq txt (org-trim field))
8767 (org-table-next-row)
8768 (org-table-blank-field))
8769 (save-excursion
8770 (setq txt
8771 (catch 'exit
8772 (while (progn (beginning-of-line 1)
8773 (re-search-backward org-table-dataline-regexp
8774 beg t))
8775 (org-table-goto-column colpos t)
8776 (if (and (looking-at
8778 (= (setq n (1- n)) 0))
8779 (throw 'exit (match-string 1))))))))
8780 (if txt
8781 (progn
8782 (if (and org-table-copy-increment
8783 (string-match "^[0-9]+$" txt))
8784 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8785 (insert txt)
8786 (move-to-column col)
8787 (if (and org-table-copy-increment (org-at-timestamp-p t))
8788 (org-timestamp-up 1)
8789 (org-table-maybe-recalculate-line))
8790 (org-table-align)
8791 (move-to-column col))
8792 (error "No non-empty field found"))))
8794 (defun org-table-check-inside-data-field ()
8795 "Is point inside a table data field?
8796 I.e. not on a hline or before the first or after the last column?
8797 This actually throws an error, so it aborts the current command."
8798 (if (or (not (org-at-table-p))
8799 (= (org-table-current-column) 0)
8800 (org-at-table-hline-p)
8802 (error "Not in table data field")))
8804 (defvar org-table-clip nil
8805 "Clipboard for table regions.")
8807 (defun org-table-blank-field ()
8808 "Blank the current table field or active region."
8809 (interactive)
8810 (org-table-check-inside-data-field)
8811 (if (and (interactive-p) (org-region-active-p))
8812 (let (org-table-clip)
8813 (org-table-cut-region (region-beginning) (region-end)))
8814 (skip-chars-backward "^|")
8815 (backward-char 1)
8817 (let* ((pos (match-beginning 0))
8818 (match (match-string 0))
8819 (len (org-string-width match)))
8820 (replace-match (concat "|" (make-string (1- len) ?\ )))
8821 (goto-char (+ 2 pos))
8822 (substring match 1)))))
8824 (defun org-table-get-field (&optional n replace)
8825 "Return the value of the field in column N of current row.
8826 N defaults to current field.
8827 If REPLACE is a string, replace field with this value. The return value
8828 is always the old value."
8829 (and n (org-table-goto-column n))
8831 (backward-char 1)
8833 (let* ((pos (match-beginning 0))
8834 (val (buffer-substring (1+ pos) (match-end 0))))
8835 (if replace
8836 (replace-match (concat "|" replace) t t))
8837 (goto-char (min (point-at-eol) (+ 2 pos)))
8838 val)
8839 (forward-char 1) ""))
8841 (defun org-table-field-info (arg)
8842 "Show info about the current field, and highlight any reference at point."
8843 (interactive "P")
8844 (org-table-get-specials)
8845 (save-excursion
8846 (let* ((pos (point))
8847 (col (org-table-current-column))
8848 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8849 (name (car (rassoc (list (org-current-line) col)
8850 org-table-named-field-locations)))
8851 (eql (org-table-get-stored-formulas))
8852 (dline (org-table-current-dline))
8853 (ref (format "@%d$%d" dline col))
8854 (ref1 (org-table-convert-refs-to-an ref))
8855 (fequation (or (assoc name eql) (assoc ref eql)))
8856 (cequation (assoc (int-to-string col) eql))
8857 (eqn (or fequation cequation)))
8858 (goto-char pos)
8859 (condition-case nil
8860 (org-table-show-reference 'local)
8861 (error nil))
8862 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8863 dline col
8864 (if cname (concat " or $" cname) "")
8865 dline col ref1
8866 (if name (concat " or $" name) "")
8867 ;; FIXME: formula info not correct if special table line
8868 (if eqn
8869 (concat ", formula: "
8870 (org-table-formula-to-user
8871 (concat
8872 (if (string-match "^[$@]"(car eqn)) "" "$")
8873 (car eqn) "=" (cdr eqn))))
8874 "")))))
8876 (defun org-table-current-column ()
8877 "Find out which column we are in.
8878 When called interactively, column is also displayed in echo area."
8879 (interactive)
8880 (if (interactive-p) (org-table-check-inside-data-field))
8881 (save-excursion
8882 (let ((cnt 0) (pos (point)))
8883 (beginning-of-line 1)
8884 (while (search-forward "|" pos t)
8885 (setq cnt (1+ cnt)))
8886 (if (interactive-p) (message "This is table column %d" cnt))
8887 cnt)))
8889 (defun org-table-current-dline ()
8890 "Find out what table data line we are in.
8891 Only datalins count for this."
8892 (interactive)
8893 (if (interactive-p) (org-table-check-inside-data-field))
8894 (save-excursion
8895 (let ((cnt 0) (pos (point)))
8896 (goto-char (org-table-begin))
8897 (while (<= (point) pos)
8898 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8899 (beginning-of-line 2))
8900 (if (interactive-p) (message "This is table line %d" cnt))
8901 cnt)))
8903 (defun org-table-goto-column (n &optional on-delim force)
8904 "Move the cursor to the Nth column in the current table line.
8905 With optional argument ON-DELIM, stop with point before the left delimiter
8906 of the field.
8907 If there are less than N fields, just go to after the last delimiter.
8908 However, when FORCE is non-nil, create new columns if necessary."
8909 (interactive "p")
8910 (let ((pos (point-at-eol)))
8911 (beginning-of-line 1)
8912 (when (> n 0)
8913 (while (and (> (setq n (1- n)) -1)
8914 (or (search-forward "|" pos t)
8915 (and force
8916 (progn (end-of-line 1)
8917 (skip-chars-backward "^|")
8918 (insert " | "))))))
8919 ; (backward-char 2) t)))))
8920 (when (and force (not (looking-at ".*|")))
8921 (save-excursion (end-of-line 1) (insert " | ")))
8922 (if on-delim
8923 (backward-char 1)
8924 (if (looking-at " ") (forward-char 1))))))
8926 (defun org-at-table-p (&optional table-type)
8927 "Return t if the cursor is inside an org-type table.
8928 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8929 (if org-enable-table-editor
8930 (save-excursion
8931 (beginning-of-line 1)
8932 (looking-at (if table-type org-table-any-line-regexp
8933 org-table-line-regexp)))
8934 nil))
8936 (defun org-at-table.el-p ()
8937 "Return t if and only if we are at a table.el table."
8938 (and (org-at-table-p 'any)
8939 (save-excursion
8940 (goto-char (org-table-begin 'any))
8941 (looking-at org-table1-hline-regexp))))
8943 (defun org-table-recognize-table.el ()
8944 "If there is a table.el table nearby, recognize it and move into it."
8945 (if org-table-tab-recognizes-table.el
8946 (if (org-at-table.el-p)
8947 (progn
8948 (beginning-of-line 1)
8949 (if (looking-at org-table-dataline-regexp)
8950 nil
8951 (if (looking-at org-table1-hline-regexp)
8952 (progn
8953 (beginning-of-line 2)
8954 (if (looking-at org-table-any-border-regexp)
8955 (beginning-of-line -1)))))
8956 (if (re-search-forward "|" (org-table-end t) t)
8957 (progn
8958 (require 'table)
8959 (if (table--at-cell-p (point))
8960 t
8961 (message "recognizing table.el table...")
8962 (table-recognize-table)
8963 (message "recognizing table.el table...done")))
8964 (error "This should not happen..."))
8965 t)
8966 nil)
8967 nil))
8969 (defun org-at-table-hline-p ()
8970 "Return t if the cursor is inside a hline in a table."
8971 (if org-enable-table-editor
8972 (save-excursion
8973 (beginning-of-line 1)
8974 (looking-at org-table-hline-regexp))
8975 nil))
8977 (defun org-table-insert-column ()
8978 "Insert a new column into the table."
8979 (interactive)
8980 (if (not (org-at-table-p))
8981 (error "Not at a table"))
8982 (org-table-find-dataline)
8983 (let* ((col (max 1 (org-table-current-column)))
8984 (beg (org-table-begin))
8985 (end (org-table-end))
8986 ;; Current cursor position
8987 (linepos (org-current-line))
8988 (colpos col))
8989 (goto-char beg)
8990 (while (< (point) end)
8991 (if (org-at-table-hline-p)
8992 nil
8993 (org-table-goto-column col t)
8994 (insert "| "))
8995 (beginning-of-line 2))
8996 (move-marker end nil)
8997 (goto-line linepos)
8998 (org-table-goto-column colpos)
8999 (org-table-align)
9000 (org-table-fix-formulas "$" nil (1- col) 1)))
9002 (defun org-table-find-dataline ()
9003 "Find a dataline in the current table, which is needed for column commands."
9004 (if (and (org-at-table-p)
9005 (not (org-at-table-hline-p)))
9006 t
9007 (let ((col (current-column))
9008 (end (org-table-end)))
9009 (move-to-column col)
9010 (while (and (< (point) end)
9011 (or (not (= (current-column) col))
9012 (org-at-table-hline-p)))
9013 (beginning-of-line 2)
9014 (move-to-column col))
9015 (if (and (org-at-table-p)
9016 (not (org-at-table-hline-p)))
9017 t
9018 (error
9019 "Please position cursor in a data line for column operations")))))
9021 (defun org-table-delete-column ()
9022 "Delete a column from the table."
9023 (interactive)
9024 (if (not (org-at-table-p))
9025 (error "Not at a table"))
9026 (org-table-find-dataline)
9027 (org-table-check-inside-data-field)
9028 (let* ((col (org-table-current-column))
9029 (beg (org-table-begin))
9030 (end (org-table-end))
9031 ;; Current cursor position
9032 (linepos (org-current-line))
9033 (colpos col))
9034 (goto-char beg)
9035 (while (< (point) end)
9036 (if (org-at-table-hline-p)
9037 nil
9038 (org-table-goto-column col t)
9040 (replace-match "|")))
9041 (beginning-of-line 2))
9042 (move-marker end nil)
9043 (goto-line linepos)
9044 (org-table-goto-column colpos)
9045 (org-table-align)
9046 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9047 col -1 col)))
9049 (defun org-table-move-column-right ()
9050 "Move column to the right."
9051 (interactive)
9052 (org-table-move-column nil))
9053 (defun org-table-move-column-left ()
9054 "Move column to the left."
9055 (interactive)
9056 (org-table-move-column 'left))
9058 (defun org-table-move-column (&optional left)
9059 "Move the current column to the right. With arg LEFT, move to the left."
9060 (interactive "P")
9061 (if (not (org-at-table-p))
9062 (error "Not at a table"))
9063 (org-table-find-dataline)
9064 (org-table-check-inside-data-field)
9065 (let* ((col (org-table-current-column))
9066 (col1 (if left (1- col) col))
9067 (beg (org-table-begin))
9068 (end (org-table-end))
9069 ;; Current cursor position
9070 (linepos (org-current-line))
9071 (colpos (if left (1- col) (1+ col))))
9072 (if (and left (= col 1))
9073 (error "Cannot move column further left"))
9075 (error "Cannot move column further right"))
9076 (goto-char beg)
9077 (while (< (point) end)
9078 (if (org-at-table-hline-p)
9079 nil
9080 (org-table-goto-column col1 t)
9083 (beginning-of-line 2))
9084 (move-marker end nil)
9085 (goto-line linepos)
9086 (org-table-goto-column colpos)
9087 (org-table-align)
9088 (org-table-fix-formulas
9089 "$" (list (cons (number-to-string col) (number-to-string colpos))
9090 (cons (number-to-string colpos) (number-to-string col))))))
9092 (defun org-table-move-row-down ()
9093 "Move table row down."
9094 (interactive)
9095 (org-table-move-row nil))
9096 (defun org-table-move-row-up ()
9097 "Move table row up."
9098 (interactive)
9099 (org-table-move-row 'up))
9101 (defun org-table-move-row (&optional up)
9102 "Move the current table line down. With arg UP, move it up."
9103 (interactive "P")
9104 (let* ((col (current-column))
9105 (pos (point))
9106 (hline1p (save-excursion (beginning-of-line 1)
9107 (looking-at org-table-hline-regexp)))
9108 (dline1 (org-table-current-dline))
9109 (dline2 (+ dline1 (if up -1 1)))
9110 (tonew (if up 0 2))
9111 txt hline2p)
9112 (beginning-of-line tonew)
9113 (unless (org-at-table-p)
9114 (goto-char pos)
9115 (error "Cannot move row further"))
9116 (setq hline2p (looking-at org-table-hline-regexp))
9117 (goto-char pos)
9118 (beginning-of-line 1)
9119 (setq pos (point))
9120 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9121 (delete-region (point) (1+ (point-at-eol)))
9122 (beginning-of-line tonew)
9123 (insert txt)
9124 (beginning-of-line 0)
9125 (move-to-column col)
9126 (unless (or hline1p hline2p)
9127 (org-table-fix-formulas
9128 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9129 (cons (number-to-string dline2) (number-to-string dline1)))))))
9131 (defun org-table-insert-row (&optional arg)
9132 "Insert a new row above the current line into the table.
9133 With prefix ARG, insert below the current line."
9134 (interactive "P")
9135 (if (not (org-at-table-p))
9136 (error "Not at a table"))
9137 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9138 (new (org-table-clean-line line)))
9139 ;; Fix the first field if necessary
9141 (setq new (replace-match (match-string 0 line) t t new)))
9142 (beginning-of-line (if arg 2 1))
9144 (beginning-of-line 0)
9145 (re-search-forward "| ?" (point-at-eol) t)
9146 (and (or org-table-may-need-update org-table-overlay-coordinates)
9147 (org-table-align))
9148 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9150 (defun org-table-insert-hline (&optional above)
9151 "Insert a horizontal-line below the current line into the table.
9152 With prefix ABOVE, insert above the current line."
9153 (interactive "P")
9154 (if (not (org-at-table-p))
9155 (error "Not at a table"))
9156 (let ((line (org-table-clean-line
9157 (buffer-substring (point-at-bol) (point-at-eol))))
9158 (col (current-column)))
9160 (setq line (replace-match
9161 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9162 ?-) "|") t t line)))
9164 (beginning-of-line (if above 1 2))
9166 (beginning-of-line (if above 1 -1))
9167 (move-to-column col)
9168 (and org-table-overlay-coordinates (org-table-align))))
9170 (defun org-table-hline-and-move (&optional same-column)
9171 "Insert a hline and move to the row below that line."
9172 (interactive "P")
9173 (let ((col (org-table-current-column)))
9174 (org-table-maybe-eval-formula)
9175 (org-table-maybe-recalculate-line)
9176 (org-table-insert-hline)
9177 (end-of-line 2)
9180 (org-table-next-field))
9181 (if same-column (org-table-goto-column col))))
9183 (defun org-table-clean-line (s)
9185 In particular, this does handle wide and invisible characters."
9187 ;; It's a hline, just map the characters
9188 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9190 (setq s (replace-match
9191 (concat "|" (make-string (org-string-width (match-string 1 s))
9192 ?\ ) "|")
9193 t t s)))
9194 s))
9196 (defun org-table-kill-row ()
9197 "Delete the current row or horizontal line from the table."
9198 (interactive)
9199 (if (not (org-at-table-p))
9200 (error "Not at a table"))
9201 (let ((col (current-column))
9202 (dline (org-table-current-dline)))
9203 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9204 (if (not (org-at-table-p)) (beginning-of-line 0))
9205 (move-to-column col)
9206 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9207 dline -1 dline)))
9209 (defun org-table-sort-lines (with-case &optional sorting-type)
9210 "Sort table lines according to the column at point.
9212 The position of point indicates the column to be used for
9213 sorting, and the range of lines is the range between the nearest
9214 horizontal separator lines, or the entire table of no such lines
9215 exist. If point is before the first column, you will be prompted
9216 for the sorting column. If there is an active region, the mark
9217 specifies the first line and the sorting column, while point
9218 should be in the last line to be included into the sorting.
9220 The command then prompts for the sorting type which can be
9221 alphabetically, numerically, or by time (as given in a time stamp
9222 in the field). Sorting in reverse order is also possible.
9224 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9226 If SORTING-TYPE is specified when this function is called from a Lisp
9227 program, no prompting will take place. SORTING-TYPE must be a character,
9228 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9229 should be done in reverse order."
9230 (interactive "P")
9231 (let* ((thisline (org-current-line))
9232 (thiscol (org-table-current-column))
9233 beg end bcol ecol tend tbeg column lns pos)
9234 (when (equal thiscol 0)
9235 (if (interactive-p)
9236 (setq thiscol
9237 (string-to-number
9238 (read-string "Use column N for sorting: ")))
9239 (setq thiscol 1))
9240 (org-table-goto-column thiscol))
9241 (org-table-check-inside-data-field)
9242 (if (org-region-active-p)
9243 (progn
9244 (setq beg (region-beginning) end (region-end))
9245 (goto-char beg)
9246 (setq column (org-table-current-column)
9247 beg (point-at-bol))
9248 (goto-char end)
9249 (setq end (point-at-bol 2)))
9250 (setq column (org-table-current-column)
9251 pos (point)
9252 tbeg (org-table-begin)
9253 tend (org-table-end))
9254 (if (re-search-backward org-table-hline-regexp tbeg t)
9255 (setq beg (point-at-bol 2))
9256 (goto-char tbeg)
9257 (setq beg (point-at-bol 1)))
9258 (goto-char pos)
9259 (if (re-search-forward org-table-hline-regexp tend t)
9260 (setq end (point-at-bol 1))
9261 (goto-char tend)
9262 (setq end (point-at-bol))))
9263 (setq beg (move-marker (make-marker) beg)
9264 end (move-marker (make-marker) end))
9265 (untabify beg end)
9266 (goto-char beg)
9267 (org-table-goto-column column)
9268 (skip-chars-backward "^|")
9269 (setq bcol (current-column))
9270 (org-table-goto-column (1+ column))
9271 (skip-chars-backward "^|")
9272 (setq ecol (1- (current-column)))
9273 (org-table-goto-column column)
9274 (setq lns (mapcar (lambda(x) (cons
9275 (org-sort-remove-invisible
9276 (nth (1- column)
9278 x))
9280 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9281 (delete-region beg end)
9282 (move-marker beg nil)
9283 (move-marker end nil)
9285 (goto-line thisline)
9286 (org-table-goto-column thiscol)
9287 (message "%d lines sorted, based on column %d" (length lns) column)))
9289 ;; FIXME: maybe we will not need this? Table sorting is broken....
9290 (defun org-sort-remove-invisible (s)
9291 (remove-text-properties 0 (length s) org-rm-props s)
9292 (while (string-match org-bracket-link-regexp s)
9293 (setq s (replace-match (if (match-end 2)
9294 (match-string 3 s)
9295 (match-string 1 s)) t t s)))
9296 s)
9298 (defun org-table-cut-region (beg end)
9299 "Copy region in table to the clipboard and blank all relevant fields."
9300 (interactive "r")
9301 (org-table-copy-region beg end 'cut))
9303 (defun org-table-copy-region (beg end &optional cut)
9304 "Copy rectangular region in table to clipboard.
9305 A special clipboard is used which can only be accessed
9306 with `org-table-paste-rectangle'."
9307 (interactive "rP")
9308 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9309 region cols
9310 (rpl (if cut " " nil)))
9311 (goto-char beg)
9312 (org-table-check-inside-data-field)
9313 (setq l01 (org-current-line)
9314 c01 (org-table-current-column))
9315 (goto-char end)
9316 (org-table-check-inside-data-field)
9317 (setq l02 (org-current-line)
9318 c02 (org-table-current-column))
9319 (setq l1 (min l01 l02) l2 (max l01 l02)
9320 c1 (min c01 c02) c2 (max c01 c02))
9321 (catch 'exit
9322 (while t
9323 (catch 'nextline
9324 (if (> l1 l2) (throw 'exit t))
9325 (goto-line l1)
9326 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9327 (setq cols nil ic1 c1 ic2 c2)
9328 (while (< ic1 (1+ ic2))
9329 (push (org-table-get-field ic1 rpl) cols)
9330 (setq ic1 (1+ ic1)))
9331 (push (nreverse cols) region)
9332 (setq l1 (1+ l1)))))
9333 (setq org-table-clip (nreverse region))
9334 (if cut (org-table-align))
9335 org-table-clip))
9337 (defun org-table-paste-rectangle ()
9338 "Paste a rectangular region into a table.
9339 The upper right corner ends up in the current field. All involved fields
9340 will be overwritten. If the rectangle does not fit into the present table,
9341 the table is enlarged as needed. The process ignores horizontal separator
9342 lines."
9343 (interactive)
9344 (unless (and org-table-clip (listp org-table-clip))
9345 (error "First cut/copy a region to paste!"))
9346 (org-table-check-inside-data-field)
9347 (let* ((clip org-table-clip)
9348 (line (org-current-line))
9349 (col (org-table-current-column))
9350 (org-enable-table-editor t)
9351 (org-table-automatic-realign nil)
9352 c cols field)
9353 (while (setq cols (pop clip))
9354 (while (org-at-table-hline-p) (beginning-of-line 2))
9355 (if (not (org-at-table-p))
9356 (progn (end-of-line 0) (org-table-next-field)))
9357 (setq c col)
9358 (while (setq field (pop cols))
9359 (org-table-goto-column c nil 'force)
9360 (org-table-get-field nil field)
9361 (setq c (1+ c)))
9362 (beginning-of-line 2))
9363 (goto-line line)
9364 (org-table-goto-column col)
9365 (org-table-align)))
9367 (defun org-table-convert ()
9368 "Convert from `org-mode' table to table.el and back.
9369 Obviously, this only works within limits. When an Org-mode table is
9370 converted to table.el, all horizontal separator lines get lost, because
9371 table.el uses these as cell boundaries and has no notion of horizontal lines.
9372 A table.el table can be converted to an Org-mode table only if it does not
9373 do row or column spanning. Multiline cells will become multiple cells.
9374 Beware, Org-mode does not test if the table can be successfully converted - it
9375 blindly applies a recipe that works for simple tables."
9376 (interactive)
9377 (require 'table)
9378 (if (org-at-table.el-p)
9379 ;; convert to Org-mode table
9380 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9381 (end (move-marker (make-marker) (org-table-end t))))
9382 (table-unrecognize-region beg end)
9383 (goto-char beg)
9385 (replace-match ""))
9386 (goto-char beg))
9387 (if (org-at-table-p)
9388 ;; convert to table.el table
9389 (let ((beg (move-marker (make-marker) (org-table-begin)))
9390 (end (move-marker (make-marker) (org-table-end))))
9391 ;; first, get rid of all horizontal lines
9392 (goto-char beg)
9394 (replace-match ""))
9395 ;; insert a hline before first
9396 (goto-char beg)
9397 (org-table-insert-hline 'above)
9398 (beginning-of-line -1)
9399 ;; insert a hline after each line
9400 (while (progn (beginning-of-line 3) (< (point) end))
9401 (org-table-insert-hline))
9402 (goto-char beg)
9403 (setq end (move-marker end (org-table-end)))
9404 ;; replace "+" at beginning and ending of hlines
9407 (goto-char beg)
9409 (replace-match "-+"))
9410 (goto-char beg)))))
9412 (defun org-table-wrap-region (arg)
9413 "Wrap several fields in a column like a paragraph.
9414 This is useful if you'd like to spread the contents of a field over several
9415 lines, in order to keep the table compact.
9417 If there is an active region, and both point and mark are in the same column,
9418 the text in the column is wrapped to minimum width for the given number of
9419 lines. Generally, this makes the table more compact. A prefix ARG may be
9421 formats the selected text to two lines. If the region was longer than two
9422 lines, the remaining lines remain empty. A negative prefix argument reduces
9423 the current number of lines by that amount. The wrapped text is pasted back
9424 into the table. If you formatted it to more lines than it was before, fields
9425 further down in the table get overwritten - so you might need to make space in
9426 the table first.
9428 If there is no region, the current field is split at the cursor position and
9429 the text fragment to the right of the cursor is prepended to the field one
9430 line down.
9432 If there is no region, but you specify a prefix ARG, the current field gets
9433 blank, and the content is appended to the field above."
9434 (interactive "P")
9435 (org-table-check-inside-data-field)
9436 (if (org-region-active-p)
9437 ;; There is a region: fill as a paragraph
9438 (let* ((beg (region-beginning))
9439 (cline (save-excursion (goto-char beg) (org-current-line)))
9440 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9441 nlines)
9442 (org-table-cut-region (region-beginning) (region-end))
9443 (if (> (length (car org-table-clip)) 1)
9444 (error "Region must be limited to single column"))
9445 (setq nlines (if arg
9446 (if (< arg 1)
9447 (+ (length org-table-clip) arg)
9448 arg)
9449 (length org-table-clip)))
9450 (setq org-table-clip
9451 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9452 nil nlines)))
9453 (goto-line cline)
9454 (org-table-goto-column ccol)
9455 (org-table-paste-rectangle))
9456 ;; No region, split the current field at point
9457 (if arg
9458 ;; combine with field above
9459 (let ((s (org-table-blank-field))
9460 (col (org-table-current-column)))
9461 (beginning-of-line 0)
9462 (while (org-at-table-hline-p) (beginning-of-line 0))
9463 (org-table-goto-column col)
9464 (skip-chars-forward "^|")
9465 (skip-chars-backward " ")
9466 (insert " " (org-trim s))
9467 (org-table-align))
9468 ;; split field
9470 (let ((s (match-string 1)))
9471 (replace-match " |")
9472 (goto-char (match-beginning 0))
9473 (org-table-next-row)
9474 (insert (org-trim s) " ")
9475 (org-table-align))))))
9477 (defvar org-field-marker nil)
9479 (defun org-table-edit-field (arg)
9480 "Edit table field in a different window.
9481 This is mainly useful for fields that contain hidden parts.
9483 it can be edited in place."
9484 (interactive "P")
9485 (if arg
9486 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9488 (remove-text-properties b e '(org-cwidth t invisible t
9489 display t intangible t))
9490 (if (and (boundp 'font-lock-mode) font-lock-mode)
9491 (font-lock-fontify-block)))
9492 (let ((pos (move-marker (make-marker) (point)))
9493 (field (org-table-get-field))
9494 (cw (current-window-configuration))
9495 p)
9496 (org-switch-to-buffer-other-window "*Org tmp*")
9497 (erase-buffer)
9499 (let ((org-inhibit-startup t)) (org-mode))
9500 (goto-char (setq p (point-max)))
9501 (insert (org-trim field))
9502 (remove-text-properties p (point-max)
9503 '(invisible t org-cwidth t display t
9504 intangible t))
9505 (goto-char p)
9506 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9507 (org-set-local 'org-window-configuration cw)
9508 (org-set-local 'org-field-marker pos)
9509 (message "Edit and finish with C-c C-c"))))
9511 (defun org-table-finish-edit-field ()
9512 "Finish editing a table data field.
9513 Remove all newline characters, insert the result into the table, realign
9514 the table and kill the editing buffer."
9515 (let ((pos org-field-marker)
9516 (cw org-window-configuration)
9517 (cb (current-buffer))
9518 text)
9519 (goto-char (point-min))
9522 (replace-match " "))
9523 (setq text (org-trim (buffer-string)))
9524 (set-window-configuration cw)
9525 (kill-buffer cb)
9526 (select-window (get-buffer-window (marker-buffer pos)))
9527 (goto-char pos)
9528 (move-marker pos nil)
9529 (org-table-check-inside-data-field)
9530 (org-table-get-field nil text)
9531 (org-table-align)
9532 (message "New field value inserted")))
9534 (defun org-trim (s)
9535 "Remove whitespace at beginning and end of string."
9538 s)
9540 (defun org-wrap (string &optional width lines)
9541 "Wrap string to either a number of lines, or a width in characters.
9542 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9543 that costs. If there is a word longer than WIDTH, the text is actually
9544 wrapped to the length of that word.
9545 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9546 many lines, whatever width that takes.
9547 The return value is a list of lines, without newlines at the end."
9549 (maxword (apply 'max (mapcar 'org-string-width words)))
9550 w ll)
9551 (cond (width
9552 (org-do-wrap words (max maxword width)))
9553 (lines
9554 (setq w maxword)
9555 (setq ll (org-do-wrap words maxword))
9556 (if (<= (length ll) lines)
9557 ll
9558 (setq ll words)
9559 (while (> (length ll) lines)
9560 (setq w (1+ w))
9561 (setq ll (org-do-wrap words w)))
9562 ll))
9563 (t (error "Cannot wrap this")))))
9566 (defun org-do-wrap (words width)
9567 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9568 (let (lines line)
9569 (while words
9570 (setq line (pop words))
9571 (while (and words (< (+ (length line) (length (car words))) width))
9572 (setq line (concat line " " (pop words))))
9573 (setq lines (push line lines)))
9574 (nreverse lines)))
9576 (defun org-split-string (string &optional separators)
9577 "Splits STRING into substrings at SEPARATORS.
9578 No empty strings are returned if there are matches at the beginning
9579 and end of string."
9581 (start 0)
9582 notfirst
9583 (list nil))
9584 (while (and (string-match rexp string
9585 (if (and notfirst
9586 (= start (match-beginning 0))
9587 (< start (length string)))
9588 (1+ start) start))
9589 (< (match-beginning 0) (length string)))
9590 (setq notfirst t)
9591 (or (eq (match-beginning 0) 0)
9592 (and (eq (match-beginning 0) (match-end 0))
9593 (eq (match-beginning 0) start))
9594 (setq list
9595 (cons (substring string start (match-beginning 0))
9596 list)))
9597 (setq start (match-end 0)))
9598 (or (eq start (length string))
9599 (setq list
9600 (cons (substring string start)
9601 list)))
9602 (nreverse list)))
9604 (defun org-table-map-tables (function)
9605 "Apply FUNCTION to the start of all tables in the buffer."
9606 (save-excursion
9607 (save-restriction
9608 (widen)
9609 (goto-char (point-min))
9610 (while (re-search-forward org-table-any-line-regexp nil t)
9611 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9612 (beginning-of-line 1)
9613 (if (looking-at org-table-line-regexp)
9614 (save-excursion (funcall function)))
9615 (re-search-forward org-table-any-border-regexp nil 1))))
9616 (message "Mapping tables: done"))
9618 (defvar org-timecnt) ; dynamically scoped parameter
9620 (defun org-table-sum (&optional beg end nlast)
9621 "Sum numbers in region of current table column.
9622 The result will be displayed in the echo area, and will be available
9625 If there is an active region, it is interpreted as a rectangle and all
9626 numbers in that rectangle will be summed. If there is no active
9627 region and point is located in a table column, sum all numbers in that
9628 column.
9630 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9631 numbers are assumed to be times as well (in decimal hours) and the
9632 numbers are added as such.
9634 If NLAST is a number, only the NLAST fields will actually be summed."
9635 (interactive)
9636 (save-excursion
9637 (let (col (org-timecnt 0) diff h m s org-table-clip)
9638 (cond
9639 ((and beg end)) ; beg and end given explicitly
9640 ((org-region-active-p)
9641 (setq beg (region-beginning) end (region-end)))
9642 (t
9643 (setq col (org-table-current-column))
9644 (goto-char (org-table-begin))
9646 (error "No table data"))
9647 (org-table-goto-column col)
9648 (setq beg (point))
9649 (goto-char (org-table-end))
9651 (error "No table data"))
9652 (org-table-goto-column col)
9653 (setq end (point))))
9654 (let* ((items (apply 'append (org-table-copy-region beg end)))
9655 (items1 (cond ((not nlast) items)
9656 ((>= nlast (length items)) items)
9657 (t (setq items (reverse items))
9658 (setcdr (nthcdr (1- nlast) items) nil)
9659 (nreverse items))))
9660 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9661 items1)))
9662 (res (apply '+ numbers))
9663 (sres (if (= org-timecnt 0)
9664 (format "%g" res)
9665 (setq diff (* 3600 res)
9666 h (floor (/ diff 3600)) diff (mod diff 3600)
9667 m (floor (/ diff 60)) diff (mod diff 60)
9668 s diff)
9669 (format "%d:%02d:%02d" h m s))))
9670 (kill-new sres)
9671 (if (interactive-p)
9672 (message "%s"
9673 (substitute-command-keys
9675 (length numbers) sres))))
9676 sres))))
9678 (defun org-table-get-number-for-summing (s)
9679 (let (n)
9680 (if (string-match "^ *|? *" s)
9681 (setq s (replace-match "" nil nil s)))
9682 (if (string-match " *|? *$" s)
9683 (setq s (replace-match "" nil nil s)))
9684 (setq n (string-to-number s))
9685 (cond
9686 ((and (string-match "0" s)
9690 (let ((h (string-to-number (or (match-string 1 s) "0")))
9691 (m (string-to-number (or (match-string 2 s) "0")))
9692 (s (string-to-number (or (match-string 4 s) "0"))))
9693 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9694 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9695 ((equal n 0) nil)
9696 (t n))))
9698 (defun org-table-current-field-formula (&optional key noerror)
9699 "Return the formula active for the current field.
9700 Assumes that specials are in place.
9701 If KEY is given, return the key to this formula.
9703 (let* ((name (car (rassoc (list (org-current-line)
9704 (org-table-current-column))
9705 org-table-named-field-locations)))
9706 (col (org-table-current-column))
9707 (scol (int-to-string col))
9708 (ref (format "@%d$%d" (org-table-current-dline) col))
9709 (stored-list (org-table-get-stored-formulas noerror))
9710 (ass (or (assoc name stored-list)
9711 (assoc ref stored-list)
9712 (assoc scol stored-list))))
9713 (if key
9714 (car ass)
9715 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9716 (cdr ass))))))
9718 (defun org-table-get-formula (&optional equation named)
9719 "Read a formula from the minibuffer, offer stored formula as default.
9720 When NAMED is non-nil, look for a named equation."
9721 (let* ((stored-list (org-table-get-stored-formulas))
9722 (name (car (rassoc (list (org-current-line)
9723 (org-table-current-column))
9724 org-table-named-field-locations)))
9725 (ref (format "@%d$%d" (org-table-current-dline)
9726 (org-table-current-column)))
9727 (refass (assoc ref stored-list))
9728 (scol (if named
9729 (if name name ref)
9730 (int-to-string (org-table-current-column))))
9731 (dummy (and (or name refass) (not named)
9732 (not (y-or-n-p "Replace field formula with column formula? " ))
9733 (error "Abort")))
9734 (name (or name ref))
9735 (org-table-may-need-update nil)
9736 (stored (cdr (assoc scol stored-list)))
9737 (eq (cond
9738 ((and stored equation (string-match "^ *=? *$" equation))
9739 stored)
9740 ((stringp equation)
9741 equation)
9742 (t (org-table-formula-from-user
9743 (read-string
9744 (org-table-formula-to-user
9745 (format "%s formula %s%s="
9746 (if named "Field" "Column")
9747 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9748 scol))
9749 (if stored (org-table-formula-to-user stored) "")
9750 'org-table-formula-history
9751 )))))
9752 mustsave)
9754 ;; remove formula
9755 (setq stored-list (delq (assoc scol stored-list) stored-list))
9756 (org-table-store-formulas stored-list)
9757 (error "Formula removed"))
9758 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9759 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9760 (if (and name (not named))
9761 ;; We set the column equation, delete the named one.
9762 (setq stored-list (delq (assoc name stored-list) stored-list)
9763 mustsave t))
9764 (if stored
9765 (setcdr (assoc scol stored-list) eq)
9766 (setq stored-list (cons (cons scol eq) stored-list)))
9767 (if (or mustsave (not (equal stored eq)))
9768 (org-table-store-formulas stored-list))
9769 eq))
9771 (defun org-table-store-formulas (alist)
9772 "Store the list of formulas below the current table."
9773 (setq alist (sort alist 'org-table-formula-less-p))
9774 (save-excursion
9775 (goto-char (org-table-end))
9777 (progn
9778 ;; don't overwrite TBLFM, we might use text properties to store stuff
9779 (goto-char (match-beginning 2))
9780 (delete-region (match-beginning 2) (match-end 0)))
9781 (insert "#+TBLFM:"))
9782 (insert " "
9783 (mapconcat (lambda (x)
9784 (concat
9785 (if (equal (string-to-char (car x)) ?@) "" "$")
9786 (car x) "=" (cdr x)))
9787 alist "::")
9790 (defsubst org-table-formula-make-cmp-string (a)
9792 (concat
9793 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9794 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9795 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9797 (defun org-table-formula-less-p (a b)
9798 "Compare two formulas for sorting."
9799 (let ((as (org-table-formula-make-cmp-string (car a)))
9800 (bs (org-table-formula-make-cmp-string (car b))))
9801 (and as bs (string< as bs))))
9803 (defun org-table-get-stored-formulas (&optional noerror)
9804 "Return an alist with the stored formulas directly after current table."
9805 (interactive)
9806 (let (scol eq eq-alist strings string seen)
9807 (save-excursion
9808 (goto-char (org-table-end))
9810 (setq strings (org-split-string (match-string 2) " *:: *"))
9811 (while (setq string (pop strings))
9812 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9813 (setq scol (if (match-end 2)
9814 (match-string 2 string)
9815 (match-string 1 string))
9816 eq (match-string 3 string)
9817 eq-alist (cons (cons scol eq) eq-alist))
9818 (if (member scol seen)
9819 (if noerror
9820 (progn
9821 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9822 (ding)
9823 (sit-for 2))
9824 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9825 (push scol seen))))))
9826 (nreverse eq-alist)))
9828 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9829 "Modify the equations after the table structure has been edited.
9831 For all numbers larger than LIMIT, shift them by DELTA."
9832 (save-excursion
9833 (goto-char (org-table-end))
9836 (re2
9837 (when remove
9838 (if (equal key "$")
9841 s n a)
9842 (when remove
9843 (while (re-search-forward re2 (point-at-eol) t)
9844 (replace-match "")))
9845 (while (re-search-forward re (point-at-eol) t)
9846 (setq s (match-string 1) n (string-to-number s))
9847 (cond
9848 ((setq a (assoc s replace))
9849 (replace-match (concat key (cdr a)) t t))
9850 ((and limit (> n limit))
9851 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9853 (defun org-table-get-specials ()
9854 "Get the column names and local parameters for this table."
9855 (save-excursion
9856 (let ((beg (org-table-begin)) (end (org-table-end))
9857 names name fields fields1 field cnt
9858 c v l line col types dlines hlines)
9859 (setq org-table-column-names nil
9860 org-table-local-parameters nil
9861 org-table-named-field-locations nil
9862 org-table-current-begin-line nil
9863 org-table-current-begin-pos nil
9864 org-table-current-line-types nil)
9865 (goto-char beg)
9867 (setq names (org-split-string (match-string 1) " *| *")
9868 cnt 1)
9869 (while (setq name (pop names))
9870 (setq cnt (1+ cnt))
9871 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9872 (push (cons name (int-to-string cnt)) org-table-column-names))))
9873 (setq org-table-column-names (nreverse org-table-column-names))
9874 (setq org-table-column-name-regexp
9876 (goto-char beg)
9878 (setq fields (org-split-string (match-string 1) " *| *"))
9879 (while (setq field (pop fields))
9881 (push (cons (match-string 1 field) (match-string 2 field))
9882 org-table-local-parameters))))
9883 (goto-char beg)
9885 (setq c (match-string 1)
9886 fields (org-split-string (match-string 2) " *| *"))
9887 (save-excursion
9888 (beginning-of-line (if (equal c "_") 2 0))
9889 (setq line (org-current-line) col 1)
9891 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9892 (while (and fields1 (setq field (pop fields)))
9893 (setq v (pop fields1) col (1+ col))
9894 (when (and (stringp field) (stringp v)
9895 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9896 (push (cons field v) org-table-local-parameters)
9897 (push (list field line col) org-table-named-field-locations))))
9898 ;; Analyse the line types
9899 (goto-char beg)
9900 (setq org-table-current-begin-line (org-current-line)
9901 org-table-current-begin-pos (point)
9902 l org-table-current-begin-line)
9904 (push (if (match-end 1) 'hline 'dline) types)
9905 (if (match-end 1) (push l hlines) (push l dlines))
9906 (beginning-of-line 2)
9907 (setq l (1+ l)))
9908 (setq org-table-current-line-types (apply 'vector (nreverse types))
9909 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9910 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9912 (defun org-table-maybe-eval-formula ()
9914 If yes, store the formula and apply it."
9915 ;; We already know we are in a table. Get field will only return a formula
9916 ;; when appropriate. It might return a separator line, but no problem.
9917 (when org-table-formula-evaluate-inline
9918 (let* ((field (org-trim (or (org-table-get-field) "")))
9919 named eq)
9921 (setq named (equal (string-to-char field) ?:)
9922 eq (match-string 1 field))
9923 (if (or (fboundp 'calc-eval)
9924 (equal (substring eq 0 (min 2 (length eq))) "'("))
9925 (org-table-eval-formula (if named '(4) nil)
9926 (org-table-formula-from-user eq))
9927 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9929 (defvar org-recalc-commands nil
9930 "List of commands triggering the recalculation of a line.
9931 Will be filled automatically during use.")
9933 (defvar org-recalc-marks
9934 '((" " . "Unmarked: no special line, no automatic recalculation")
9935 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9936 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9937 ("!" . "Column name definition line. Reference in formula as $name.")
9938 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9939 ("_" . "Names for values in row below this one.")
9940 ("^" . "Names for values in row above this one.")))
9942 (defun org-table-rotate-recalc-marks (&optional newchar)
9943 "Rotate the recalculation mark in the first column.
9944 If in any row, the first field is not consistent with a mark,
9945 insert a new column for the markers.
9946 When there is an active region, change all the lines in the region,
9947 after prompting for the marking character.
9948 After each change, a message will be displayed indicating the meaning
9949 of the new mark."
9950 (interactive)
9951 (unless (org-at-table-p) (error "Not at a table"))
9952 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9953 (beg (org-table-begin))
9954 (end (org-table-end))
9955 (l (org-current-line))
9956 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9957 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9958 (have-col
9959 (save-excursion
9960 (goto-char beg)
9962 (col (org-table-current-column))
9963 (forcenew (car (assoc newchar org-recalc-marks)))
9964 epos new)
9965 (when l1
9966 (message "Change region to what mark? Type # * ! $ or SPC: ")
9967 (setq newchar (char-to-string (read-char-exclusive))
9968 forcenew (car (assoc newchar org-recalc-marks))))
9969 (if (and newchar (not forcenew))
9970 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9971 newchar))
9972 (if l1 (goto-line l1))
9973 (save-excursion
9974 (beginning-of-line 1)
9975 (unless (looking-at org-table-dataline-regexp)
9976 (error "Not at a table data line")))
9977 (unless have-col
9978 (org-table-goto-column 1)
9979 (org-table-insert-column)
9980 (org-table-goto-column (1+ col)))
9981 (setq epos (point-at-eol))
9982 (save-excursion
9983 (beginning-of-line 1)
9984 (org-table-get-field
9986 (concat " "
9987 (setq new (or forcenew
9988 (cadr (member (match-string 1) marks))))
9989 " ")
9990 " # ")))
9991 (if (and l1 l2)
9992 (progn
9993 (goto-line l1)
9994 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9995 (and (looking-at org-table-dataline-regexp)
9996 (org-table-get-field 1 (concat " " new " "))))
9997 (goto-line l1)))
9998 (if (not (= epos (point-at-eol))) (org-table-align))
9999 (goto-line l)
10000 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
10002 (defun org-table-maybe-recalculate-line ()
10003 "Recompute the current line if marked for it, and if we haven't just done it."
10004 (interactive)
10005 (and org-table-allow-automatic-line-recalculation
10006 (not (and (memq last-command org-recalc-commands)
10007 (equal org-last-recalc-line (org-current-line))))
10008 (save-excursion (beginning-of-line 1)
10009 (looking-at org-table-auto-recalculate-regexp))
10010 (org-table-recalculate) t))
10012 (defvar org-table-formula-debug nil
10013 "Non-nil means, debug table formulas.
10015 (make-variable-buffer-local 'org-table-formula-debug)
10017 (defvar modes)
10018 (defsubst org-set-calc-mode (var &optional value)
10019 (if (stringp var)
10020 (setq var (assoc var '(("D" calc-angle-mode deg)
10021 ("R" calc-angle-mode rad)
10022 ("F" calc-prefer-frac t)
10023 ("S" calc-symbolic-mode t)))
10024 value (nth 2 var) var (nth 1 var)))
10025 (if (memq var modes)
10026 (setcar (cdr (memq var modes)) value)
10027 (cons var (cons value modes)))
10028 modes)
10030 (defun org-table-eval-formula (&optional arg equation
10031 suppress-align suppress-const
10032 suppress-store suppress-analysis)
10033 "Replace the table field value at the cursor by the result of a calculation.
10035 This function makes use of Dave Gillespie's Calc package, in my view the
10036 most exciting program ever written for GNU Emacs. So you need to have Calc
10037 installed in order to use this function.
10039 In a table, this command replaces the value in the current field with the
10041 formula, by storing it in a special line below the table. When called
10042 with a `C-u' prefix, the current field must ba a named field, and the
10043 formula is installed as valid in only this specific field.
10045 When called with two `C-u' prefixes, insert the active equation
10046 for the field back into the current field, so that it can be
10048 to check the referenced fields.
10050 When called, the command first prompts for a formula, which is read in
10051 the minibuffer. Previously entered formulas are available through the
10052 history list, and the last used formula is offered as a default.
10053 These stored formulas are adapted correctly when moving, inserting, or
10054 deleting columns with the corresponding commands.
10056 The formula can be any algebraic expression understood by the Calc package.
10057 For details, see the Org-mode manual.
10059 This function can also be called from Lisp programs and offers
10060 additional arguments: EQUATION can be the formula to apply. If this
10061 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10062 used to speed-up recursive calls by by-passing unnecessary aligns.
10063 SUPPRESS-CONST suppresses the interpretation of constants in the
10064 formula, assuming that this has been done already outside the function.
10065 SUPPRESS-STORE means the formula should not be stored, either because
10066 it is already stored, or because it is a modified equation that should
10067 not overwrite the stored one."
10068 (interactive "P")
10069 (org-table-check-inside-data-field)
10070 (or suppress-analysis (org-table-get-specials))
10071 (if (equal arg '(16))
10072 (let ((eq (org-table-current-field-formula)))
10073 (or eq (error "No equation active for current field"))
10074 (org-table-get-field nil eq)
10075 (org-table-align)
10076 (setq org-table-may-need-update t))
10077 (let* (fields
10078 (ndown (if (integerp arg) arg 1))
10079 (org-table-automatic-realign nil)
10080 (case-fold-search nil)
10081 (down (> ndown 1))
10082 (formula (if (and equation suppress-store)
10083 equation
10084 (org-table-get-formula equation (equal arg '(4)))))
10085 (n0 (org-table-current-column))
10086 (modes (copy-sequence org-calc-default-modes))
10087 (numbers nil) ; was a variable, now fixed default
10088 (keep-empty nil)
10089 n form form0 bw fmt x ev orig c lispp literal)
10090 ;; Parse the format string. Since we have a lot of modes, this is
10091 ;; a lot of work. However, I think calc still uses most of the time.
10092 (if (string-match ";" formula)
10093 (let ((tmp (org-split-string formula ";")))
10094 (setq formula (car tmp)
10095 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10096 (nth 1 tmp)))
10098 (setq c (string-to-char (match-string 1 fmt))
10099 n (string-to-number (match-string 2 fmt)))
10100 (if (= c ?p)
10101 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10102 (setq modes (org-set-calc-mode
10103 'calc-float-format
10104 (list (cdr (assoc c '((?n . float) (?f . fix)
10105 (?s . sci) (?e . eng))))
10106 n))))
10107 (setq fmt (replace-match "" t t fmt)))
10108 (if (string-match "[NT]" fmt)
10109 (setq numbers (equal (match-string 0 fmt) "N")
10110 fmt (replace-match "" t t fmt)))
10111 (if (string-match "L" fmt)
10112 (setq literal t
10113 fmt (replace-match "" t t fmt)))
10114 (if (string-match "E" fmt)
10115 (setq keep-empty t
10116 fmt (replace-match "" t t fmt)))
10117 (while (string-match "[DRFS]" fmt)
10118 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10119 (setq fmt (replace-match "" t t fmt)))
10121 (setq fmt nil))))
10122 (if (and (not suppress-const) org-table-formula-use-constants)
10123 (setq formula (org-table-formula-substitute-names formula)))
10124 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10125 (while (> ndown 0)
10126 (setq fields (org-split-string
10127 (org-no-properties
10128 (buffer-substring (point-at-bol) (point-at-eol)))
10129 " *| *"))
10130 (if (eq numbers t)
10131 (setq fields (mapcar
10132 (lambda (x) (number-to-string (string-to-number x)))
10133 fields)))
10134 (setq ndown (1- ndown))
10135 (setq form (copy-sequence formula)
10136 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10137 (if (and lispp literal) (setq lispp 'literal))
10138 ;; Check for old vertical references
10139 (setq form (org-rewrite-old-row-references form))
10140 ;; Insert complex ranges
10141 (while (string-match org-table-range-regexp form)
10142 (setq form
10143 (replace-match
10144 (save-match-data
10145 (org-table-make-reference
10146 (org-table-get-range (match-string 0 form) nil n0)
10147 keep-empty numbers lispp))
10148 t t form)))
10149 ;; Insert simple ranges
10151 (setq form
10152 (replace-match
10153 (save-match-data
10154 (org-table-make-reference
10155 (org-sublist
10156 fields (string-to-number (match-string 1 form))
10157 (string-to-number (match-string 2 form)))
10158 keep-empty numbers lispp))
10159 t t form)))
10160 (setq form0 form)
10161 ;; Insert the references to fields in same row
10163 (setq n (string-to-number (match-string 1 form))
10164 x (nth (1- (if (= n 0) n0 n)) fields))
10166 (match-string 0 form)))
10167 (setq form (replace-match
10168 (save-match-data
10169 (org-table-make-reference x nil numbers lispp))
10170 t t form)))
10172 (if lispp
10173 (setq ev (condition-case nil
10174 (eval (eval (read form)))
10175 (error "#ERROR"))
10176 ev (if (numberp ev) (number-to-string ev) ev))
10177 (or (fboundp 'calc-eval)
10178 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10179 (setq ev (calc-eval (cons form modes)
10180 (if numbers 'num))))
10182 (when org-table-formula-debug
10183 (with-output-to-temp-buffer "*Substitution History*"
10184 (princ (format "Substitution history of formula
10185 Orig: %s
10186 $xyz-> %s
10187 @r$c-> %s
10189 (if (listp ev)
10191 (make-string (car ev) ?\-) (nth 1 ev)))
10193 ev (or fmt "NONE")
10194 (if fmt (format fmt (string-to-number ev)) ev)))))
10195 (setq bw (get-buffer-window "*Substitution History*"))
10196 (shrink-window-if-larger-than-buffer bw)
10197 (unless (and (interactive-p) (not ndown))
10198 (unless (let (inhibit-redisplay)
10199 (y-or-n-p "Debugging Formula. Continue to next? "))
10200 (org-table-align)
10201 (error "Abort"))
10202 (delete-window bw)
10203 (message "")))
10204 (if (listp ev) (setq fmt nil ev "#ERROR"))
10205 (org-table-justify-field-maybe
10206 (if fmt (format fmt (string-to-number ev)) ev))
10208 (call-interactively 'org-return)
10209 (setq ndown 0)))
10210 (and down (org-table-maybe-recalculate-line))
10211 (or suppress-align (and org-table-may-need-update
10212 (org-table-align))))))
10214 (defun org-table-put-field-property (prop value)
10215 (save-excursion
10216 (put-text-property (progn (skip-chars-backward "^|") (point))
10217 (progn (skip-chars-forward "^|") (point))
10218 prop value)))
10220 (defun org-table-get-range (desc &optional tbeg col highlight)
10221 "Get a calc vector from a column, accorting to descriptor DESC.
10222 Optional arguments TBEG and COL can give the beginning of the table and
10223 the current column, to avoid unnecessary parsing.
10224 HIGHLIGHT means, just highlight the range."
10225 (if (not (equal (string-to-char desc) ?@))
10226 (setq desc (concat "@" desc)))
10227 (save-excursion
10228 (or tbeg (setq tbeg (org-table-begin)))
10229 (or col (setq col (org-table-current-column)))
10230 (let ((thisline (org-current-line))
10231 beg end c1 c2 r1 r2 rangep tmp)
10232 (unless (string-match org-table-range-regexp desc)
10233 (error "Invalid table range specifier `%s'" desc))
10234 (setq rangep (match-end 3)
10235 r1 (and (match-end 1) (match-string 1 desc))
10236 r2 (and (match-end 4) (match-string 4 desc))
10237 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10238 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10240 (and c1 (setq c1 (+ (string-to-number c1)
10241 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10242 (and c2 (setq c2 (+ (string-to-number c2)
10243 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10244 (if (equal r1 "") (setq r1 nil))
10245 (if (equal r2 "") (setq r2 nil))
10246 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10247 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10248 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10249 (if (not r1) (setq r1 thisline))
10250 (if (not r2) (setq r2 thisline))
10251 (if (not c1) (setq c1 col))
10252 (if (not c2) (setq c2 col))
10253 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10254 ;; just one field
10255 (progn
10256 (goto-line r1)
10257 (while (not (looking-at org-table-dataline-regexp))
10258 (beginning-of-line 2))
10259 (prog1 (org-trim (org-table-get-field c1))
10260 (if highlight (org-table-highlight-rectangle (point) (point)))))
10261 ;; A range, return a vector
10262 ;; First sort the numbers to get a regular ractangle
10263 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10264 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10265 (goto-line r1)
10266 (while (not (looking-at org-table-dataline-regexp))
10267 (beginning-of-line 2))
10268 (org-table-goto-column c1)
10269 (setq beg (point))
10270 (goto-line r2)
10271 (while (not (looking-at org-table-dataline-regexp))
10272 (beginning-of-line 0))
10273 (org-table-goto-column c2)
10274 (setq end (point))
10275 (if highlight
10276 (org-table-highlight-rectangle
10278 ;; return string representation of calc vector
10279 (mapcar 'org-trim
10280 (apply 'append (org-table-copy-region beg end)))))))
10282 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10283 "Analyze descriptor DESC and retrieve the corresponding line number.
10284 The cursor is currently in line CLINE, the table begins in line BLINE,
10285 and TABLE is a vector with line types."
10286 (if (string-match "^[0-9]+$" desc)
10287 (aref org-table-dlines (string-to-number desc))
10288 (setq cline (or cline (org-current-line))
10289 bline (or bline org-table-current-begin-line)
10290 table (or table org-table-current-line-types))
10291 (if (or
10293 ;; 1 2 3 4 5 6
10294 (and (not (match-end 3)) (not (match-end 6)))
10295 (and (match-end 3) (match-end 6) (not (match-end 5))))
10296 (error "invalid row descriptor `%s'" desc))
10297 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10298 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10299 (odir (and (match-end 5) (match-string 5 desc)))
10300 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10301 (i (- cline bline))
10302 (rel (and (match-end 6)
10303 (or (and (match-end 1) (not (match-end 3)))
10304 (match-end 5)))))
10305 (if (and hn (not hdir))
10306 (progn
10307 (setq i 0 hdir "+")
10308 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10309 (if (and (not hn) on (not odir))
10310 (error "should never happen");;(aref org-table-dlines on)
10311 (if (and hn (> hn 0))
10312 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10313 (if on
10314 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10315 (+ bline i)))))
10317 (defun org-find-row-type (table i type backwards relative n)
10318 (let ((l (length table)))
10319 (while (> n 0)
10320 (while (and (setq i (+ i (if backwards -1 1)))
10321 (>= i 0) (< i l)
10322 (not (eq (aref table i) type))
10323 (if (and relative (eq (aref table i) 'hline))
10324 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10325 t)))
10326 (setq n (1- n)))
10327 (if (or (< i 0) (>= i l))
10328 (error "Row descriptior leads outside table")
10329 i)))
10331 (defun org-rewrite-old-row-references (s)
10332 (if (string-match "&[-+0-9I]" s)
10333 (error "Formula contains old &row reference, please rewrite using @-syntax")
10334 s))
10336 (defun org-table-make-reference (elements keep-empty numbers lispp)
10337 "Convert list ELEMENTS to something appropriate to insert into formula.
10338 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10339 NUMBERS indicates that everything should be converted to numbers.
10340 LISPP means to return something appropriate for a Lisp list."
10341 (if (stringp elements) ; just a single val
10342 (if lispp
10343 (if (eq lispp 'literal)
10344 elements
10345 (prin1-to-string (if numbers (string-to-number elements) elements)))
10346 (if (equal elements "") (setq elements "0"))
10347 (if numbers (number-to-string (string-to-number elements)) elements))
10348 (unless keep-empty
10349 (setq elements
10350 (delq nil
10352 elements))))
10353 (setq elements (or elements '("0")))
10354 (if lispp
10355 (mapconcat
10356 (lambda (x)
10357 (if (eq lispp 'literal)
10358 x
10359 (prin1-to-string (if numbers (string-to-number x) x))))
10360 elements " ")
10361 (concat "[" (mapconcat
10362 (lambda (x)
10363 (if numbers (number-to-string (string-to-number x)) x))
10364 elements
10365 ",") "]"))))
10367 (defun org-table-recalculate (&optional all noalign)
10368 "Recalculate the current table line by applying all stored formulas.
10369 With prefix arg ALL, do this for all lines in the table."
10370 (interactive "P")
10371 (or (memq this-command org-recalc-commands)
10372 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10373 (unless (org-at-table-p) (error "Not at a table"))
10374 (if (equal all '(16))
10375 (org-table-iterate)
10376 (org-table-get-specials)
10377 (let* ((eqlist (sort (org-table-get-stored-formulas)
10378 (lambda (a b) (string< (car a) (car b)))))
10379 (inhibit-redisplay (not debug-on-error))
10380 (line-re org-table-dataline-regexp)
10381 (thisline (org-current-line))
10382 (thiscol (org-table-current-column))
10383 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10384 ;; Insert constants in all formulas
10385 (setq eqlist
10386 (mapcar (lambda (x)
10387 (setcdr x (org-table-formula-substitute-names (cdr x)))
10388 x)
10389 eqlist))
10390 ;; Split the equation list
10391 (while (setq eq (pop eqlist))
10392 (if (<= (string-to-char (car eq)) ?9)
10393 (push eq eqlnum)
10394 (push eq eqlname)))
10395 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10396 (if all
10397 (progn
10398 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10399 (goto-char (setq beg (org-table-begin)))
10400 (if (re-search-forward org-table-calculate-mark-regexp end t)
10401 ;; This is a table with marked lines, compute selected lines
10402 (setq line-re org-table-recalculate-regexp)
10403 ;; Move forward to the first non-header line
10404 (if (and (re-search-forward org-table-dataline-regexp end t)
10405 (re-search-forward org-table-hline-regexp end t)
10406 (re-search-forward org-table-dataline-regexp end t))
10407 (setq beg (match-beginning 0))
10408 nil))) ;; just leave beg where it is
10409 (setq beg (point-at-bol)
10410 end (move-marker (make-marker) (1+ (point-at-eol)))))
10411 (goto-char beg)
10412 (and all (message "Re-applying formulas to full table..."))
10414 ;; First find the named fields, and mark them untouchanble
10415 (remove-text-properties beg end '(org-untouchable t))
10416 (while (setq eq (pop eqlname))
10417 (setq name (car eq)
10418 a (assoc name org-table-named-field-locations))
10419 (and (not a)
10421 (setq a (list name
10422 (aref org-table-dlines
10423 (string-to-number (match-string 1 name)))
10424 (string-to-number (match-string 2 name)))))
10425 (when (and a (or all (equal (nth 1 a) thisline)))
10426 (message "Re-applying formula to field: %s" name)
10427 (goto-line (nth 1 a))
10428 (org-table-goto-column (nth 2 a))
10429 (push (append a (list (cdr eq))) eqlname1)
10430 (org-table-put-field-property :org-untouchable t)))
10432 ;; Now evauluate the column formulas, but skip fields covered by
10433 ;; field formulas
10434 (goto-char beg)
10435 (while (re-search-forward line-re end t)
10436 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10437 ;; Unprotected line, recalculate
10438 (and all (message "Re-applying formulas to full table...(line %d)"
10439 (setq cnt (1+ cnt))))
10440 (setq org-last-recalc-line (org-current-line))
10441 (setq eql eqlnum)
10442 (while (setq entry (pop eql))
10443 (goto-line org-last-recalc-line)
10444 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10445 (unless (get-text-property (point) :org-untouchable)
10446 (org-table-eval-formula nil (cdr entry)
10447 'noalign 'nocst 'nostore 'noanalysis)))))
10449 ;; Now evaluate the field formulas
10450 (while (setq eq (pop eqlname1))
10451 (message "Re-applying formula to field: %s" (car eq))
10452 (goto-line (nth 1 eq))
10453 (org-table-goto-column (nth 2 eq))
10454 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10455 'nostore 'noanalysis))
10457 (goto-line thisline)
10458 (org-table-goto-column thiscol)
10459 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10460 (or noalign (and org-table-may-need-update (org-table-align))
10461 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10463 ;; back to initial position
10464 (message "Re-applying formulas...done")
10465 (goto-line thisline)
10466 (org-table-goto-column thiscol)
10467 (or noalign (and org-table-may-need-update (org-table-align))
10468 (and all (message "Re-applying formulas...done"))))))
10470 (defun org-table-iterate (&optional arg)
10471 "Recalculate the table until it does not change anymore."
10472 (interactive "P")
10473 (let ((imax (if arg (prefix-numeric-value arg) 10))
10474 (i 0)
10475 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10476 thistbl)
10477 (catch 'exit
10478 (while (< i imax)
10479 (setq i (1+ i))
10480 (org-table-recalculate 'all)
10481 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10482 (if (not (string= lasttbl thistbl))
10483 (setq lasttbl thistbl)
10484 (if (> i 1)
10485 (message "Convergence after %d iterations" i)
10486 (message "Table was already stable"))
10487 (throw 'exit t)))
10488 (error "No convergence after %d iterations" i))))
10490 (defun org-table-formula-substitute-names (f)
10491 "Replace $const with values in string F."
10492 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10493 ;; First, check for column names
10494 (while (setq start (string-match org-table-column-name-regexp f start))
10495 (setq start (1+ start))
10496 (setq a (assoc (match-string 1 f) org-table-column-names))
10497 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10498 ;; Parameters and constants
10499 (setq start 0)
10501 (setq start (1+ start))
10502 (if (setq a (save-match-data
10503 (org-table-get-constant (match-string 1 f))))
10504 (setq f (replace-match
10505 (concat (if pp "(") a (if pp ")")) t t f))))
10506 (if org-table-formula-debug
10507 (put-text-property 0 (length f) :orig-formula f1 f))
10508 f))
10510 (defun org-table-get-constant (const)
10511 "Find the value for a parameter or constant in a formula.
10512 Parameters get priority."
10513 (or (cdr (assoc const org-table-local-parameters))
10514 (cdr (assoc const org-table-formula-constants-local))
10515 (cdr (assoc const org-table-formula-constants))
10516 (and (fboundp 'constants-get) (constants-get const))
10517 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10518 (org-entry-get nil (substring const 5) 'inherit))
10519 "#UNDEFINED_NAME"))
10521 (defvar org-table-fedit-map
10522 (let ((map (make-sparse-keymap)))
10523 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10524 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10525 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10526 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10527 (org-defkey map "\C-c?" 'org-table-show-reference)
10528 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10529 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10530 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10531 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10532 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10533 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10534 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10535 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10536 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10537 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10538 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10539 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10540 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10541 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10542 map))
10544 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10545 '("Edit-Formulas"
10546 ["Finish and Install" org-table-fedit-finish t]
10547 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10548 ["Abort" org-table-fedit-abort t]
10549 "--"
10550 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10551 ["Complete Lisp Symbol" lisp-complete-symbol t]
10552 "--"
10553 "Shift Reference at Point"
10554 ["Up" org-table-fedit-ref-up t]
10555 ["Down" org-table-fedit-ref-down t]
10556 ["Left" org-table-fedit-ref-left t]
10557 ["Right" org-table-fedit-ref-right t]
10558 "-"
10559 "Change Test Row for Column Formulas"
10560 ["Up" org-table-fedit-line-up t]
10561 ["Down" org-table-fedit-line-down t]
10562 "--"
10563 ["Scroll Table Window" org-table-fedit-scroll t]
10564 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10565 ["Show Table Grid" org-table-fedit-toggle-coordinates
10566 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10567 org-table-overlay-coordinates)]
10568 "--"
10569 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10570 :style toggle :selected org-table-buffer-is-an]))
10572 (defvar org-pos)
10574 (defun org-table-edit-formulas ()
10575 "Edit the formulas of the current table in a separate buffer."
10576 (interactive)
10578 (beginning-of-line 0))
10579 (unless (org-at-table-p) (error "Not at a table"))
10580 (org-table-get-specials)
10581 (let ((key (org-table-current-field-formula 'key 'noerror))
10582 (eql (sort (org-table-get-stored-formulas 'noerror)
10583 'org-table-formula-less-p))
10584 (pos (move-marker (make-marker) (point)))
10585 (startline 1)
10586 (wc (current-window-configuration))
10590 entry s type title)
10591 (org-switch-to-buffer-other-window "*Edit Formulas*")
10592 (erase-buffer)
10593 ;; Keep global-font-lock-mode from turning on font-lock-mode
10594 (let ((font-lock-global-modes '(not fundamental-mode)))
10595 (fundamental-mode))
10596 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10597 (org-set-local 'org-pos pos)
10598 (org-set-local 'org-window-configuration wc)
10599 (use-local-map org-table-fedit-map)
10600 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10601 (easy-menu-add org-table-fedit-menu)
10602 (setq startline (org-current-line))
10603 (while (setq entry (pop eql))
10604 (setq type (cond
10605 ((equal (string-to-char (car entry)) ?@) 'field)
10606 ((string-match "^[0-9]" (car entry)) 'column)
10607 (t 'named)))
10608 (when (setq title (assq type titles))
10610 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10611 (setq titles (delq title titles)))
10612 (if (equal key (car entry)) (setq startline (org-current-line)))
10613 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10615 (remove-text-properties 0 (length s) '(face nil) s)
10616 (insert s))
10617 (if (eq org-table-use-standard-references t)
10618 (org-table-fedit-toggle-ref-type))
10619 (goto-line startline)
10620 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10622 (defun org-table-fedit-post-command ()
10623 (when (not (memq this-command '(lisp-complete-symbol)))
10624 (let ((win (selected-window)))
10625 (save-excursion
10626 (condition-case nil
10627 (org-table-show-reference)
10628 (error nil))
10629 (select-window win)))))
10631 (defun org-table-formula-to-user (s)
10632 "Convert a formula from internal to user representation."
10633 (if (eq org-table-use-standard-references t)
10634 (org-table-convert-refs-to-an s)
10635 s))
10637 (defun org-table-formula-from-user (s)
10638 "Convert a formula from user to internal representation."
10639 (if org-table-use-standard-references
10640 (org-table-convert-refs-to-rc s)
10641 s))
10643 (defun org-table-convert-refs-to-rc (s)
10644 "Convert spreadsheet references from AB7 to @7$28.
10645 Works for single references, but also for entire formulas and even the
10646 full TBLFM line."
10647 (let ((start 0))
10649 (cond
10650 ((match-end 3)
10651 ;; format match, just advance
10652 (setq start (match-end 0)))
10653 ((and (> (match-beginning 0) 0)
10654 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10655 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10656 ;; 3.e5 or something like this.
10657 (setq start (match-end 0)))
10658 (t
10659 (setq start (match-beginning 0)
10660 s (replace-match
10661 (if (equal (match-string 2 s) "&")
10662 (format "$%d" (org-letters-to-number (match-string 1 s)))
10663 (format "@%d$%d"
10664 (string-to-number (match-string 2 s))
10665 (org-letters-to-number (match-string 1 s))))
10666 t t s)))))
10667 s))
10669 (defun org-table-convert-refs-to-an (s)
10670 "Convert spreadsheet references from to @7$28 to AB7.
10671 Works for single references, but also for entire formulas and even the
10672 full TBLFM line."
10674 (setq s (replace-match
10675 (format "%s%d"
10676 (org-number-to-letters
10677 (string-to-number (match-string 2 s)))
10678 (string-to-number (match-string 1 s)))
10679 t t s)))
10682 (org-number-to-letters
10683 (string-to-number (match-string 2 s))) "&")
10684 t nil s)))
10685 s)
10687 (defun org-letters-to-number (s)
10688 "Convert a base 26 number represented by letters into an integer.
10689 For example: AB -> 28."
10690 (let ((n 0))
10691 (setq s (upcase s))
10692 (while (> (length s) 0)
10693 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10694 s (substring s 1)))
10695 n))
10697 (defun org-number-to-letters (n)
10698 "Convert an integer into a base 26 number represented by letters.
10699 For example: 28 -> AB."
10700 (let ((s ""))
10701 (while (> n 0)
10702 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10703 n (/ (1- n) 26)))
10704 s))
10706 (defun org-table-fedit-convert-buffer (function)
10707 "Convert all references in this buffer, using FUNTION."
10708 (let ((line (org-current-line)))
10709 (goto-char (point-min))
10710 (while (not (eobp))
10711 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10712 (delete-region (point) (point-at-eol))
10713 (or (eobp) (forward-char 1)))
10714 (goto-line line)))
10716 (defun org-table-fedit-toggle-ref-type ()
10717 "Convert all references in the buffer from B3 to @3$2 and back."
10718 (interactive)
10719 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10720 (org-table-fedit-convert-buffer
10721 (if org-table-buffer-is-an
10722 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10723 (message "Reference type switched to %s"
10724 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10726 (defun org-table-fedit-ref-up ()
10727 "Shift the reference at point one row/hline up."
10728 (interactive)
10729 (org-table-fedit-shift-reference 'up))
10730 (defun org-table-fedit-ref-down ()
10731 "Shift the reference at point one row/hline down."
10732 (interactive)
10733 (org-table-fedit-shift-reference 'down))
10734 (defun org-table-fedit-ref-left ()
10735 "Shift the reference at point one field to the left."
10736 (interactive)
10737 (org-table-fedit-shift-reference 'left))
10738 (defun org-table-fedit-ref-right ()
10739 "Shift the reference at point one field to the right."
10740 (interactive)
10741 (org-table-fedit-shift-reference 'right))
10743 (defun org-table-fedit-shift-reference (dir)
10744 (cond
10746 (if (memq dir '(left right))
10747 (org-rematch-and-replace 1 (eq dir 'left))
10748 (error "Cannot shift reference in this direction")))
10750 ;; A B3-like reference
10751 (if (memq dir '(up down))
10752 (org-rematch-and-replace 2 (eq dir 'up))
10753 (org-rematch-and-replace 1 (eq dir 'left))))
10754 ((org-at-regexp-p
10756 ;; An internal reference
10757 (if (memq dir '(up down))
10758 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10759 (org-rematch-and-replace 5 (eq dir 'left))))))
10761 (defun org-rematch-and-replace (n &optional decr hline)
10762 "Re-match the group N, and replace it with the shifted refrence."
10763 (or (match-end n) (error "Cannot shift reference in this direction"))
10764 (goto-char (match-beginning n))
10765 (and (looking-at (regexp-quote (match-string n)))
10766 (replace-match (org-shift-refpart (match-string 0) decr hline)
10767 t t)))
10769 (defun org-shift-refpart (ref &optional decr hline)
10770 "Shift a refrence part REF.
10771 If DECR is set, decrease the references row/column, else increase.
10772 If HLINE is set, this may be a hline reference, it certainly is not
10773 a translation reference."
10774 (save-match-data
10775 (let* ((sign (string-match "^[-+]" ref)) n)
10777 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10778 (cond
10779 ((and hline (string-match "^I+" ref))
10780 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10781 (setq n (+ n (if decr -1 1)))
10782 (if (= n 0) (setq n (+ n (if decr -1 1))))
10783 (if sign
10784 (setq sign (if (< n 0) "-" "+") n (abs n))
10785 (setq n (max 1 n)))
10786 (concat sign (make-string n ?I)))
10788 ((string-match "^[0-9]+" ref)
10789 (setq n (string-to-number (concat sign ref)))
10790 (setq n (+ n (if decr -1 1)))
10791 (if sign
10792 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10793 (number-to-string (max 1 n))))
10795 ((string-match "^[a-zA-Z]+" ref)
10796 (org-number-to-letters
10797 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10799 (t (error "Cannot shift reference"))))))
10801 (defun org-table-fedit-toggle-coordinates ()
10802 "Toggle the display of coordinates in the refrenced table."
10803 (interactive)
10804 (let ((pos (marker-position org-pos)))
10805 (with-current-buffer (marker-buffer org-pos)
10806 (save-excursion
10807 (goto-char pos)
10808 (org-table-toggle-coordinate-overlays)))))
10810 (defun org-table-fedit-finish (&optional arg)
10811 "Parse the buffer for formula definitions and install them.
10812 With prefix ARG, apply the new formulas to the table."
10813 (interactive "P")
10814 (org-table-remove-rectangle-highlight)
10815 (if org-table-use-standard-references
10816 (progn
10817 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10818 (setq org-table-buffer-is-an nil)))
10819 (let ((pos org-pos) eql var form)
10820 (goto-char (point-min))
10821 (while (re-search-forward
10823 nil t)
10824 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10825 form (match-string 3))
10826 (setq form (org-trim form))
10827 (when (not (equal form ""))
10829 (setq form (replace-match " " t t form)))
10830 (when (assoc var eql)
10831 (error "Double formulas for %s" var))
10832 (push (cons var form) eql)))
10833 (setq org-pos nil)
10834 (set-window-configuration org-window-configuration)
10835 (select-window (get-buffer-window (marker-buffer pos)))
10836 (goto-char pos)
10837 (unless (org-at-table-p)
10838 (error "Lost table position - cannot install formulae"))
10839 (org-table-store-formulas eql)
10840 (move-marker pos nil)
10841 (kill-buffer "*Edit Formulas*")
10842 (if arg
10843 (org-table-recalculate 'all)
10844 (message "New formulas installed - press C-u C-c C-c to apply."))))
10846 (defun org-table-fedit-abort ()
10847 "Abort editing formulas, without installing the changes."
10848 (interactive)
10849 (org-table-remove-rectangle-highlight)
10850 (let ((pos org-pos))
10851 (set-window-configuration org-window-configuration)
10852 (select-window (get-buffer-window (marker-buffer pos)))
10853 (goto-char pos)
10854 (move-marker pos nil)
10855 (message "Formula editing aborted without installing changes")))
10857 (defun org-table-fedit-lisp-indent ()
10858 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10859 (interactive)
10860 (let ((pos (point)) beg end ind)
10861 (beginning-of-line 1)
10862 (cond
10864 (goto-char pos)
10865 (call-interactively 'lisp-indent-line))
10867 ((not (fboundp 'pp-buffer))
10868 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10869 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10870 (goto-char (- (match-end 0) 2))
10871 (setq beg (point))
10872 (setq ind (make-string (current-column) ?\ ))
10873 (condition-case nil (forward-sexp 1)
10874 (error
10875 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10876 (setq end (point))
10877 (save-restriction
10878 (narrow-to-region beg end)
10879 (if (eq last-command this-command)
10880 (progn
10881 (goto-char (point-min))
10882 (setq this-command nil)
10884 (replace-match " ")))
10885 (pp-buffer)
10886 (untabify (point-min) (point-max))
10887 (goto-char (1+ (point-min)))
10888 (while (re-search-forward "^." nil t)
10889 (beginning-of-line 1)
10890 (insert ind))
10891 (goto-char (point-max))
10892 (backward-delete-char 1)))
10893 (goto-char beg))
10894 (t nil))))
10896 (defvar org-show-positions nil)
10898 (defun org-table-show-reference (&optional local)
10899 "Show the location/value of the $ expression at point."
10900 (interactive)
10901 (org-table-remove-rectangle-highlight)
10902 (catch 'exit
10903 (let ((pos (if local (point) org-pos))
10904 (face2 'highlight)
10905 (org-inhibit-highlight-removal t)
10906 (win (selected-window))
10907 (org-show-positions nil)
10908 var name e what match dest)
10909 (if local (org-table-get-specials))
10910 (setq what (cond
10911 ((or (org-at-regexp-p org-table-range-regexp2)
10912 (org-at-regexp-p org-table-translate-regexp)
10913 (org-at-regexp-p org-table-range-regexp))
10914 (setq match
10915 (save-match-data
10916 (org-table-convert-refs-to-rc (match-string 0))))
10917 'range)
10920 ((not local) nil)
10921 (t (error "No reference at point")))
10922 match (and what (or match (match-string 0))))
10923 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10924 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10925 'secondary-selection))
10926 (org-add-hook 'before-change-functions
10927 'org-table-remove-rectangle-highlight)
10928 (if (eq what 'name) (setq var (substring match 1)))
10929 (when (eq what 'range)
10930 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10931 (setq match (org-table-formula-substitute-names match)))
10932 (unless local
10933 (save-excursion
10934 (end-of-line 1)
10936 (beginning-of-line 1)
10938 (setq dest
10939 (save-match-data
10940 (org-table-convert-refs-to-rc (match-string 1))))
10941 (org-table-add-rectangle-overlay
10942 (match-beginning 1) (match-end 1) face2))))
10943 (if (and (markerp pos) (marker-buffer pos))
10944 (if (get-buffer-window (marker-buffer pos))
10945 (select-window (get-buffer-window (marker-buffer pos)))
10946 (org-switch-to-buffer-other-window (get-buffer-window
10947 (marker-buffer pos)))))
10948 (goto-char pos)
10949 (org-table-force-dataline)
10950 (when dest
10951 (setq name (substring dest 1))
10952 (cond
10954 (setq e (assoc name org-table-named-field-locations))
10955 (goto-line (nth 1 e))
10956 (org-table-goto-column (nth 2 e)))
10958 (let ((l (string-to-number (match-string 1 dest)))
10959 (c (string-to-number (match-string 2 dest))))
10960 (goto-line (aref org-table-dlines l))
10961 (org-table-goto-column c)))
10962 (t (org-table-goto-column (string-to-number name))))
10963 (move-marker pos (point))
10964 (org-table-highlight-rectangle nil nil face2))
10965 (cond
10966 ((equal dest match))
10967 ((not match))
10968 ((eq what 'range)
10969 (condition-case nil
10970 (save-excursion
10971 (org-table-get-range match nil nil 'highlight))
10972 (error nil)))
10973 ((setq e (assoc var org-table-named-field-locations))
10974 (goto-line (nth 1 e))
10975 (org-table-goto-column (nth 2 e))
10976 (org-table-highlight-rectangle (point) (point))
10977 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10978 ((setq e (assoc var org-table-column-names))
10979 (org-table-goto-column (string-to-number (cdr e)))
10980 (org-table-highlight-rectangle (point) (point))
10981 (goto-char (org-table-begin))
10983 (org-table-end) t)
10984 (progn
10985 (goto-char (match-beginning 1))
10986 (org-table-highlight-rectangle)
10987 (message "Named column (column %s)" (cdr e)))
10988 (error "Column name not found")))
10989 ((eq what 'column)
10990 ;; column number
10991 (org-table-goto-column (string-to-number (substring match 1)))
10992 (org-table-highlight-rectangle (point) (point))
10993 (message "Column %s" (substring match 1)))
10994 ((setq e (assoc var org-table-local-parameters))
10995 (goto-char (org-table-begin))
10997 (progn
10998 (goto-char (match-beginning 1))
10999 (org-table-highlight-rectangle)
11000 (message "Local parameter."))
11001 (error "Parameter not found")))
11002 (t
11003 (cond
11004 ((not var) (error "No reference at point"))
11005 ((setq e (assoc var org-table-formula-constants-local))
11006 (message "Local Constant: $%s=%s in #+CONSTANTS line."
11007 var (cdr e)))
11008 ((setq e (assoc var org-table-formula-constants))
11009 (message "Constant: $%s=%s in `org-table-formula-constants'."
11010 var (cdr e)))
11011 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11012 (message "Constant: $%s=%s, from `constants.el'%s."
11013 var e (format " (%s units)" constants-unit-system)))
11014 (t (error "Undefined name $%s" var)))))
11015 (goto-char pos)
11016 (when (and org-show-positions
11017 (not (memq this-command '(org-table-fedit-scroll
11018 org-table-fedit-scroll-down))))
11019 (push pos org-show-positions)
11020 (push org-table-current-begin-pos org-show-positions)
11021 (let ((min (apply 'min org-show-positions))
11022 (max (apply 'max org-show-positions)))
11023 (goto-char min) (recenter 0)
11024 (goto-char max)
11025 (or (pos-visible-in-window-p max) (recenter -1))))
11026 (select-window win))))
11028 (defun org-table-force-dataline ()
11029 "Make sure the cursor is in a dataline in a table."
11030 (unless (save-excursion
11031 (beginning-of-line 1)
11032 (looking-at org-table-dataline-regexp))
11033 (let* ((re org-table-dataline-regexp)
11034 (p1 (save-excursion (re-search-forward re nil 'move)))
11035 (p2 (save-excursion (re-search-backward re nil 'move))))
11036 (cond ((and p1 p2)
11037 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11038 p1 p2)))
11039 ((or p1 p2) (goto-char (or p1 p2)))
11040 (t (error "No table dataline around here"))))))
11042 (defun org-table-fedit-line-up ()
11043 "Move cursor one line up in the window showing the table."
11044 (interactive)
11045 (org-table-fedit-move 'previous-line))
11047 (defun org-table-fedit-line-down ()
11048 "Move cursor one line down in the window showing the table."
11049 (interactive)
11050 (org-table-fedit-move 'next-line))
11052 (defun org-table-fedit-move (command)
11053 "Move the cursor in the window shoinw the table.
11054 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11055 (let ((org-table-allow-automatic-line-recalculation nil)
11056 (pos org-pos) (win (selected-window)) p)
11057 (select-window (get-buffer-window (marker-buffer org-pos)))
11058 (setq p (point))
11059 (call-interactively command)
11060 (while (and (org-at-table-p)
11061 (org-at-table-hline-p))
11062 (call-interactively command))
11063 (or (org-at-table-p) (goto-char p))
11064 (move-marker pos (point))
11065 (select-window win)))
11067 (defun org-table-fedit-scroll (N)
11068 (interactive "p")
11069 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11070 (scroll-other-window N)))
11072 (defun org-table-fedit-scroll-down (N)
11073 (interactive "p")
11074 (org-table-fedit-scroll (- N)))
11076 (defvar org-table-rectangle-overlays nil)
11078 (defun org-table-add-rectangle-overlay (beg end &optional face)
11079 "Add a new overlay."
11080 (let ((ov (org-make-overlay beg end)))
11081 (org-overlay-put ov 'face (or face 'secondary-selection))
11082 (push ov org-table-rectangle-overlays)))
11084 (defun org-table-highlight-rectangle (&optional beg end face)
11085 "Highlight rectangular region in a table."
11086 (setq beg (or beg (point)) end (or end (point)))
11087 (let ((b (min beg end))
11088 (e (max beg end))
11089 l1 c1 l2 c2 tmp)
11090 (and (boundp 'org-show-positions)
11091 (setq org-show-positions (cons b (cons e org-show-positions))))
11092 (goto-char (min beg end))
11093 (setq l1 (org-current-line)
11094 c1 (org-table-current-column))
11095 (goto-char (max beg end))
11096 (setq l2 (org-current-line)
11097 c2 (org-table-current-column))
11098 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11099 (goto-line l1)
11100 (beginning-of-line 1)
11101 (loop for line from l1 to l2 do
11102 (when (looking-at org-table-dataline-regexp)
11103 (org-table-goto-column c1)
11105 (org-table-goto-column c2)
11107 (org-table-add-rectangle-overlay beg end face))
11108 (beginning-of-line 2))
11109 (goto-char b))
11110 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11112 (defun org-table-remove-rectangle-highlight (&rest ignore)
11113 "Remove the rectangle overlays."
11114 (unless org-inhibit-highlight-removal
11115 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11116 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11117 (setq org-table-rectangle-overlays nil)))
11119 (defvar org-table-coordinate-overlays nil
11120 "Collects the cooordinate grid overlays, so that they can be removed.")
11121 (make-variable-buffer-local 'org-table-coordinate-overlays)
11123 (defun org-table-overlay-coordinates ()
11124 "Add overlays to the table at point, to show row/column coordinates."
11125 (interactive)
11126 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11127 (setq org-table-coordinate-overlays nil)
11128 (save-excursion
11129 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11130 (goto-char (org-table-begin))
11131 (while (org-at-table-p)
11132 (setq eol (point-at-eol))
11133 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11134 (push ov org-table-coordinate-overlays)
11135 (setq hline (looking-at org-table-hline-regexp))
11136 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11137 (format "%4d" (setq id (1+ id)))))
11138 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11139 (when hline
11140 (setq ic 0)
11142 (setq beg (1+ (match-beginning 0))
11143 ic (1+ ic)
11144 s1 (concat "$" (int-to-string ic))
11145 s2 (org-number-to-letters ic)
11146 str (if (eq org-table-use-standard-references t) s2 s1))
11147 (setq ov (org-make-overlay beg (+ beg (length str))))
11148 (push ov org-table-coordinate-overlays)
11149 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11150 (beginning-of-line 2)))))
11152 (defun org-table-toggle-coordinate-overlays ()
11153 "Toggle the display of Row/Column numbers in tables."
11154 (interactive)
11155 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11156 (message "Row/Column number display turned %s"
11157 (if org-table-overlay-coordinates "on" "off"))
11158 (if (and (org-at-table-p) org-table-overlay-coordinates)
11159 (org-table-align))
11160 (unless org-table-overlay-coordinates
11161 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11162 (setq org-table-coordinate-overlays nil)))
11164 (defun org-table-toggle-formula-debugger ()
11165 "Toggle the formula debugger in tables."
11166 (interactive)
11167 (setq org-table-formula-debug (not org-table-formula-debug))
11168 (message "Formula debugging has been turned %s"
11169 (if org-table-formula-debug "on" "off")))
11171 ;;; The orgtbl minor mode
11173 ;; Define a minor mode which can be used in other modes in order to
11174 ;; integrate the org-mode table editor.
11176 ;; This is really a hack, because the org-mode table editor uses several
11177 ;; keys which normally belong to the major mode, for example the TAB and
11178 ;; RET keys. Here is how it works: The minor mode defines all the keys
11179 ;; necessary to operate the table editor, but wraps the commands into a
11180 ;; function which tests if the cursor is currently inside a table. If that
11181 ;; is the case, the table editor command is executed. However, when any of
11182 ;; those keys is used outside a table, the function uses `key-binding' to
11183 ;; look up if the key has an associated command in another currently active
11184 ;; keymap (minor modes, major mode, global), and executes that command.
11185 ;; There might be problems if any of the keys used by the table editor is
11186 ;; otherwise used as a prefix key.
11188 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11189 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11190 ;; addresses this by checking explicitly for both bindings.
11192 ;; The optimized version (see variable `orgtbl-optimized') takes over
11193 ;; all keys which are bound to `self-insert-command' in the *global map*.
11194 ;; Some modes bind other commands to simple characters, for example
11195 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11196 ;; active, this binding is ignored inside tables and replaced with a
11197 ;; modified self-insert.
11199 (defvar orgtbl-mode nil
11200 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11201 table editor in arbitrary modes.")
11202 (make-variable-buffer-local 'orgtbl-mode)
11204 (defvar orgtbl-mode-map (make-keymap)
11205 "Keymap for `orgtbl-mode'.")
11207 ;;;###autoload
11208 (defun turn-on-orgtbl ()
11209 "Unconditionally turn on `orgtbl-mode'."
11210 (orgtbl-mode 1))
11212 (defvar org-old-auto-fill-inhibit-regexp nil
11213 "Local variable used by `orgtbl-mode'")
11216 "Matches a line belonging to an orgtbl.")
11218 (defconst orgtbl-extra-font-lock-keywords
11219 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11220 0 (quote 'org-table) 'prepend))
11221 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11223 ;;;###autoload
11224 (defun orgtbl-mode (&optional arg)
11225 "The `org-mode' table editor as a minor mode for use in other modes."
11226 (interactive)
11227 (if (org-mode-p)
11228 ;; Exit without error, in case some hook functions calls this
11229 ;; by accident in org-mode.
11230 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11231 (setq orgtbl-mode
11232 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11233 (if orgtbl-mode
11234 (progn
11235 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11236 ;; Make sure we are first in minor-mode-map-alist
11237 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11238 (and c (setq minor-mode-map-alist
11239 (cons c (delq c minor-mode-map-alist)))))
11240 (org-set-local (quote org-table-may-need-update) t)
11241 (org-add-hook 'before-change-functions 'org-before-change-function
11242 nil 'local)
11243 (org-set-local 'org-old-auto-fill-inhibit-regexp
11244 auto-fill-inhibit-regexp)
11245 (org-set-local 'auto-fill-inhibit-regexp
11246 (if auto-fill-inhibit-regexp
11248 auto-fill-inhibit-regexp)
11249 orgtbl-line-start-regexp))
11250 (org-add-to-invisibility-spec '(org-cwidth))
11251 (when (fboundp 'font-lock-add-keywords)
11252 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11253 (org-restart-font-lock))
11254 (easy-menu-add orgtbl-mode-menu)
11255 (run-hooks 'orgtbl-mode-hook))
11256 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11257 (org-cleanup-narrow-column-properties)
11258 (org-remove-from-invisibility-spec '(org-cwidth))
11259 (remove-hook 'before-change-functions 'org-before-change-function t)
11260 (when (fboundp 'font-lock-remove-keywords)
11261 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11262 (org-restart-font-lock))
11263 (easy-menu-remove orgtbl-mode-menu)
11264 (force-mode-line-update 'all))))
11266 (defun org-cleanup-narrow-column-properties ()
11267 "Remove all properties related to narrow-column invisibility."
11268 (let ((s 1))
11269 (while (setq s (text-property-any s (point-max)
11270 'display org-narrow-column-arrow))
11271 (remove-text-properties s (1+ s) '(display t)))
11272 (setq s 1)
11273 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11274 (remove-text-properties s (1+ s) '(org-cwidth t)))
11275 (setq s 1)
11276 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11277 (remove-text-properties s (1+ s) '(invisible t)))))
11279 ;; Install it as a minor mode.
11280 (put 'orgtbl-mode :included t)
11281 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11282 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11284 (defun orgtbl-make-binding (fun n &rest keys)
11285 "Create a function for binding in the table minor mode.
11286 FUN is the command to call inside a table. N is used to create a unique
11287 command name. KEYS are keys that should be checked in for a command
11288 to execute outside of tables."
11289 (eval
11290 (list 'defun
11291 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11292 '(arg)
11294 "Outside of tables, run the binding of `"
11295 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11296 "'.")
11297 '(interactive "p")
11298 (list 'if
11299 '(org-at-table-p)
11300 (list 'call-interactively (list 'quote fun))
11301 (list 'let '(orgtbl-mode)
11302 (list 'call-interactively
11303 (append '(or)
11304 (mapcar (lambda (k)
11305 (list 'key-binding k))
11306 keys)
11307 '('orgtbl-error))))))))
11309 (defun orgtbl-error ()
11310 "Error when there is no default binding for a table key."
11311 (interactive)
11312 (error "This key has no function outside tables"))
11314 (defun orgtbl-setup ()
11315 "Setup orgtbl keymaps."
11316 (let ((nfunc 0)
11317 (bindings
11318 (list
11319 '([(meta shift left)] org-table-delete-column)
11320 '([(meta left)] org-table-move-column-left)
11321 '([(meta right)] org-table-move-column-right)
11322 '([(meta shift right)] org-table-insert-column)
11323 '([(meta shift up)] org-table-kill-row)
11324 '([(meta shift down)] org-table-insert-row)
11325 '([(meta up)] org-table-move-row-up)
11326 '([(meta down)] org-table-move-row-down)
11327 '("\C-c\C-w" org-table-cut-region)
11328 '("\C-c\M-w" org-table-copy-region)
11329 '("\C-c\C-y" org-table-paste-rectangle)
11330 '("\C-c-" org-table-insert-hline)
11331 '("\C-c}" org-table-toggle-coordinate-overlays)
11332 '("\C-c{" org-table-toggle-formula-debugger)
11333 '("\C-m" org-table-next-row)
11334 '([(shift return)] org-table-copy-down)
11335 '("\C-c\C-q" org-table-wrap-region)
11336 '("\C-c?" org-table-field-info)
11337 '("\C-c " org-table-blank-field)
11338 '("\C-c+" org-table-sum)
11339 '("\C-c=" org-table-eval-formula)
11340 '("\C-c'" org-table-edit-formulas)
11341 '("\C-c`" org-table-edit-field)
11342 '("\C-c*" org-table-recalculate)
11343 '("\C-c|" org-table-create-or-convert-from-region)
11344 '("\C-c^" org-table-sort-lines)
11345 '([(control ?#)] org-table-rotate-recalc-marks)))
11346 elt key fun cmd)
11347 (while (setq elt (pop bindings))
11348 (setq nfunc (1+ nfunc))
11349 (setq key (org-key (car elt))
11350 fun (nth 1 elt)
11351 cmd (orgtbl-make-binding fun nfunc key))
11352 (org-defkey orgtbl-mode-map key cmd))
11354 ;; Special treatment needed for TAB and RET
11355 (org-defkey orgtbl-mode-map [(return)]
11356 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11357 (org-defkey orgtbl-mode-map "\C-m"
11358 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11360 (org-defkey orgtbl-mode-map [(tab)]
11361 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11362 (org-defkey orgtbl-mode-map "\C-i"
11363 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11365 (org-defkey orgtbl-mode-map [(shift tab)]
11366 (orgtbl-make-binding 'org-table-previous-field 104
11367 [(shift tab)] [(tab)] "\C-i"))
11369 (org-defkey orgtbl-mode-map "\M-\C-m"
11370 (orgtbl-make-binding 'org-table-wrap-region 105
11371 "\M-\C-m" [(meta return)]))
11372 (org-defkey orgtbl-mode-map [(meta return)]
11373 (orgtbl-make-binding 'org-table-wrap-region 106
11374 [(meta return)] "\M-\C-m"))
11376 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11377 (when orgtbl-optimized
11378 ;; If the user wants maximum table support, we need to hijack
11379 ;; some standard editing functions
11380 (org-remap orgtbl-mode-map
11381 'self-insert-command 'orgtbl-self-insert-command
11382 'delete-char 'org-delete-char
11383 'delete-backward-char 'org-delete-backward-char)
11384 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11385 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11386 '("OrgTbl"
11387 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11388 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11389 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11390 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11391 "--"
11392 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11393 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11394 ["Copy Field from Above"
11395 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11396 "--"
11397 ("Column"
11398 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11399 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11400 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11401 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11402 ("Row"
11403 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11404 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11405 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11406 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11407 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11408 "--"
11409 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11410 ("Rectangle"
11411 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11412 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11413 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11414 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11415 "--"
11416 ("Radio tables"
11417 ["Insert table template" orgtbl-insert-radio-table
11418 (assq major-mode orgtbl-radio-table-templates)]
11419 ["Comment/uncomment table" orgtbl-toggle-comment t])
11420 "--"
11421 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11422 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11423 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11424 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11425 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11426 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11427 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11428 ["Sum Column/Rectangle" org-table-sum
11429 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11430 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11431 ["Debug Formulas"
11432 org-table-toggle-formula-debugger :active (org-at-table-p)
11433 :keys "C-c {"
11434 :style toggle :selected org-table-formula-debug]
11435 ["Show Col/Row Numbers"
11436 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11437 :keys "C-c }"
11438 :style toggle :selected org-table-overlay-coordinates]
11439 ))
11440 t))
11442 (defun orgtbl-ctrl-c-ctrl-c (arg)
11443 "If the cursor is inside a table, realign the table.
11444 It it is a table to be sent away to a receiver, do it.
11445 With prefix arg, also recompute table."
11446 (interactive "P")
11447 (let ((pos (point)) action)
11448 (save-excursion
11449 (beginning-of-line 1)
11453 (cond
11454 ((integerp action)
11455 (goto-char action)
11456 (org-table-maybe-eval-formula)
11457 (if arg
11458 (call-interactively 'org-table-recalculate)
11459 (org-table-maybe-recalculate-line))
11460 (call-interactively 'org-table-align)
11461 (orgtbl-send-table 'maybe))
11462 ((eq action 'recalc)
11463 (save-excursion
11464 (beginning-of-line 1)
11466 (if (org-at-table-p)
11467 (org-call-with-arg 'org-table-recalculate t))))
11468 (t (let (orgtbl-mode)
11469 (call-interactively (key-binding "\C-c\C-c")))))))
11471 (defun orgtbl-tab (arg)
11472 "Justification and field motion for `orgtbl-mode'."
11473 (interactive "P")
11474 (if arg (org-table-edit-field t)
11475 (org-table-justify-field-maybe)
11476 (org-table-next-field)))
11478 (defun orgtbl-ret ()
11479 "Justification and field motion for `orgtbl-mode'."
11480 (interactive)
11481 (org-table-justify-field-maybe)
11482 (org-table-next-row))
11484 (defun orgtbl-self-insert-command (N)
11485 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11486 If the cursor is in a table looking at whitespace, the whitespace is
11487 overwritten, and the table is not marked as requiring realignment."
11488 (interactive "p")
11489 (if (and (org-at-table-p)
11490 (or
11491 (and org-table-auto-blank-field
11492 (member last-command
11493 '(orgtbl-hijacker-command-100
11494 orgtbl-hijacker-command-101
11495 orgtbl-hijacker-command-102
11496 orgtbl-hijacker-command-103
11497 orgtbl-hijacker-command-104
11498 orgtbl-hijacker-command-105))
11499 (org-table-blank-field))
11500 t)
11501 (eq N 1)
11503 (let (org-table-may-need-update)
11504 (goto-char (1- (match-end 0)))
11505 (delete-backward-char 1)
11506 (goto-char (match-beginning 0))
11507 (self-insert-command N))
11508 (setq org-table-may-need-update t)
11509 (let (orgtbl-mode)
11510 (call-interactively (key-binding (vector last-input-event))))))
11512 (defun org-force-self-insert (N)
11513 "Needed to enforce self-insert under remapping."
11514 (interactive "p")
11515 (self-insert-command N))
11518 "Regula expression matching exponentials as produced by calc.")
11520 (defvar org-table-clean-did-remove-column nil)
11522 (defun orgtbl-export (table target)
11523 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11525 org-table-last-alignment org-table-last-column-widths
11526 maxcol column)
11527 (if (not (fboundp func))
11528 (error "Cannot export orgtbl table to %s" target))
11529 (setq lines (org-table-clean-before-export lines))
11530 (setq table
11531 (mapcar
11532 (lambda (x)
11533 (if (string-match org-table-hline-regexp x)
11534 'hline
11536 lines))
11537 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11538 table)))
11539 (loop for i from (1- maxcol) downto 0 do
11540 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11541 (setq column (delq nil column))
11542 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11543 (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))
11544 (funcall func table nil)))
11546 (defun orgtbl-send-table (&optional maybe)
11547 "Send a tranformed version of this table to the receiver position.
11548 With argument MAYBE, fail quietly if no transformation is defined for
11549 this table."
11550 (interactive)
11551 (catch 'exit
11552 (unless (org-at-table-p) (error "Not at a table"))
11553 ;; when non-interactive, we assume align has just happened.
11554 (when (interactive-p) (org-table-align))
11555 (save-excursion
11556 (goto-char (org-table-begin))
11557 (beginning-of-line 0)
11559 (if maybe
11560 (throw 'exit nil)
11561 (error "Don't know how to transform this table."))))
11562 (let* ((name (match-string 1))
11563 beg
11564 (transform (intern (match-string 2)))
11565 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11566 (skip (plist-get params :skip))
11567 (skipcols (plist-get params :skipcols))
11568 (txt (buffer-substring-no-properties
11569 (org-table-begin) (org-table-end)))
11571 (lines (org-table-clean-before-export lines))
11572 (i0 (if org-table-clean-did-remove-column 2 1))
11573 (table (mapcar
11574 (lambda (x)
11575 (if (string-match org-table-hline-regexp x)
11576 'hline
11577 (org-remove-by-index
11579 skipcols i0)))
11580 lines))
11581 (fun (if (= i0 2) 'cdr 'identity))
11582 (org-table-last-alignment
11583 (org-remove-by-index (funcall fun org-table-last-alignment)
11584 skipcols i0))
11585 (org-table-last-column-widths
11586 (org-remove-by-index (funcall fun org-table-last-column-widths)
11587 skipcols i0)))
11589 (unless (fboundp transform)
11590 (error "No such transformation function %s" transform))
11591 (setq txt (funcall transform table params))
11592 ;; Find the insertion place
11593 (save-excursion
11594 (goto-char (point-min))
11595 (unless (re-search-forward
11597 (error "Don't know where to insert translated table"))
11598 (goto-char (match-beginning 0))
11599 (beginning-of-line 2)
11600 (setq beg (point))
11601 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11602 (error "Cannot find end of insertion region"))
11603 (beginning-of-line 1)
11604 (delete-region beg (point))
11605 (goto-char beg)
11607 (message "Table converted and installed at receiver location"))))
11609 (defun org-remove-by-index (list indices &optional i0)
11610 "Remove the elements in LIST with indices in INDICES.
11611 First element has index 0, or I0 if given."
11612 (if (not indices)
11613 list
11614 (if (integerp indices) (setq indices (list indices)))
11615 (setq i0 (1- (or i0 0)))
11616 (delq :rm (mapcar (lambda (x)
11617 (setq i0 (1+ i0))
11618 (if (memq i0 indices) :rm x))
11619 list))))
11621 (defun orgtbl-toggle-comment ()
11622 "Comment or uncomment the orgtbl at point."
11623 (interactive)
11624 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11625 (re2 (concat "^" orgtbl-line-start-regexp))
11626 (commented (save-excursion (beginning-of-line 1)
11627 (cond ((looking-at re1) t)
11628 ((looking-at re2) nil)
11629 (t (error "Not at an org table")))))
11630 (re (if commented re1 re2))
11631 beg end)
11632 (save-excursion
11633 (beginning-of-line 1)
11634 (while (looking-at re) (beginning-of-line 0))
11635 (beginning-of-line 2)
11636 (setq beg (point))
11637 (while (looking-at re) (beginning-of-line 2))
11638 (setq end (point)))
11639 (comment-region beg end (if commented '(4) nil))))
11641 (defun orgtbl-insert-radio-table ()
11642 "Insert a radio table template appropriate for this major mode."
11643 (interactive)
11644 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11645 (txt (nth 1 e))
11646 name pos)
11647 (unless e (error "No radio table setup defined for %s" major-mode))
11648 (setq name (read-string "Table name: "))
11649 (while (string-match "%n" txt)
11650 (setq txt (replace-match name t t txt)))
11652 (setq pos (point))
11653 (insert txt)
11654 (goto-char pos)))
11656 (defun org-get-param (params header i sym &optional hsym)
11657 "Get parameter value for symbol SYM.
11658 If this is a header line, actually get the value for the symbol with an
11660 If the value is a protperty list, get the element for the current column.
11661 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11662 (let ((val (plist-get params sym)))
11663 (and hsym header (setq val (or (plist-get params hsym) val)))
11664 (if (consp val) (plist-get val i) val)))
11666 (defun orgtbl-to-generic (table params)
11667 "Convert the orgtbl-mode TABLE to some other format.
11668 This generic routine can be used for many standard cases.
11669 TABLE is a list, each entry either the symbol `hline' for a horizontal
11670 separator line, or a list of fields for that line.
11671 PARAMS is a property list of parameters that can influence the conversion.
11672 For the generic converter, some parameters are obligatory: You need to
11673 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11674 :splice, you must have :tstart and :tend.
11676 Valid parameters are
11678 :tstart String to start the table. Ignored when :splice is t.
11679 :tend String to end the table. Ignored when :splice is t.
11681 :splice When set to t, return only table body lines, don't wrap
11682 them into :tstart and :tend. Default is nil.
11684 :hline String to be inserted on horizontal separation lines.
11685 May be nil to ignore hlines.
11687 :lstart String to start a new table line.
11688 :lend String to end a table line
11689 :sep Separator between two fields
11690 :lfmt Format for entire line, with enough %s to capture all fields.
11691 If this is present, :lstart, :lend, and :sep are ignored.
11692 :fmt A format to be used to wrap the field, should contain
11693 %s for the original field value. For example, to wrap
11695 This may also be a property list with column numbers and
11698 :hlstart :hlend :hlsep :hlfmt :hfmt
11699 Same as above, specific for the header lines in the table.
11700 All lines before the first hline are treated as header.
11701 If any of these is not present, the data line value is used.
11703 :efmt Use this format to print numbers with exponentials.
11704 The format should have %s twice for inserting mantissa
11706 may also be a property list with column numbers and
11707 formats. :fmt will still be applied after :efmt.
11709 In addition to this, the parameters :skip and :skipcols are always handled
11710 directly by `orgtbl-send-table'. See manual."
11711 (interactive)
11712 (let* ((p params)
11713 (splicep (plist-get p :splice))
11714 (hline (plist-get p :hline))
11715 rtn line i fm efm lfmt h)
11717 ;; Do we have a header?
11718 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11719 (setq h t))
11721 ;; Put header
11722 (unless splicep
11723 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11725 ;; Now loop over all lines
11726 (while (setq line (pop table))
11727 (if (eq line 'hline)
11728 ;; A horizontal separator line
11729 (progn (if hline (push hline rtn))
11730 (setq h nil)) ; no longer in header
11731 ;; A normal line. Convert the fields, push line onto the result list
11732 (setq i 0)
11733 (setq line
11734 (mapcar
11735 (lambda (f)
11736 (setq i (1+ i)
11737 fm (org-get-param p h i :fmt :hfmt)
11738 efm (org-get-param p h i :efmt))
11739 (if (and efm (string-match orgtbl-exp-regexp f))
11740 (setq f (format
11741 efm (match-string 1 f) (match-string 2 f))))
11742 (if fm (setq f (format fm f)))
11743 f)
11744 line))
11745 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11746 (push (apply 'format lfmt line) rtn)
11747 (push (concat
11748 (org-get-param p h i :lstart :hlstart)
11749 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11750 (org-get-param p h i :lend :hlend))
11751 rtn))))
11753 (unless splicep
11754 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11758 (defun orgtbl-to-latex (table params)
11759 "Convert the orgtbl-mode TABLE to LaTeX.
11760 TABLE is a list, each entry either the symbol `hline' for a horizontal
11761 separator line, or a list of fields for that line.
11762 PARAMS is a property list of parameters that can influence the conversion.
11763 Supports all parameters from `orgtbl-to-generic'. Most important for
11764 LaTeX are:
11766 :splice When set to t, return only table body lines, don't wrap
11767 them into a tabular environment. Default is nil.
11769 :fmt A format to be used to wrap the field, should contain %s for the
11770 original field value. For example, to wrap everything in dollars,
11774 :efmt Format for transforming numbers with exponentials. The format
11775 should have %s twice for inserting mantissa and exponent, for
11777 This may also be a property list with column numbers and formats.
11779 The general parameters :skip and :skipcols have already been applied when
11780 this function is called."
11781 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11782 org-table-last-alignment ""))
11783 (params2
11784 (list
11789 (orgtbl-to-generic table (org-combine-plists params2 params))))
11791 (defun orgtbl-to-html (table params)
11792 "Convert the orgtbl-mode TABLE to LaTeX.
11793 TABLE is a list, each entry either the symbol `hline' for a horizontal
11794 separator line, or a list of fields for that line.
11795 PARAMS is a property list of parameters that can influence the conversion.
11796 Currently this function recognizes the following parameters:
11798 :splice When set to t, return only table body lines, don't wrap
11799 them into a <table> environment. Default is nil.
11801 The general parameters :skip and :skipcols have already been applied when
11802 this function is called. The function does *not* use `orgtbl-to-generic',
11803 so you cannot specify parameters for it."
11804 (let* ((splicep (plist-get params :splice))
11805 html)
11806 ;; Just call the formatter we already have
11807 ;; We need to make text lines for it, so put the fields back together.
11808 (setq html (org-format-org-table-html
11809 (mapcar
11810 (lambda (x)
11811 (if (eq x 'hline)
11812 "|----+----|"
11813 (concat "| " (mapconcat 'identity x " | ") " |")))
11814 table)
11815 splicep))
11817 (setq html (replace-match "" t t html)))
11818 html))
11820 (defun orgtbl-to-texinfo (table params)
11821 "Convert the orgtbl-mode TABLE to TeXInfo.
11822 TABLE is a list, each entry either the symbol `hline' for a horizontal
11823 separator line, or a list of fields for that line.
11824 PARAMS is a property list of parameters that can influence the conversion.
11825 Supports all parameters from `orgtbl-to-generic'. Most important for
11826 TeXInfo are:
11828 :splice nil/t When set to t, return only table body lines, don't wrap
11829 them into a multitable environment. Default is nil.
11831 :fmt fmt A format to be used to wrap the field, should contain
11832 %s for the original field value. For example, to wrap
11834 This may also be a property list with column numbers and
11838 are computed automatically from the width of the columns
11839 under org-mode.
11841 The general parameters :skip and :skipcols have already been applied when
11842 this function is called."
11843 (let* ((total (float (apply '+ org-table-last-column-widths)))
11844 (colfrac (or (plist-get params :cf)
11845 (mapconcat
11846 (lambda (x) (format "%.3f" (/ (float x) total)))
11847 org-table-last-column-widths " ")))
11848 (params2
11849 (list
11850 :tstart (concat "@multitable @columnfractions " colfrac)
11851 :tend "@end multitable"
11852 :lstart "@item " :lend "" :sep " @tab "
11853 :hlstart "@headitem ")))
11854 (orgtbl-to-generic table (org-combine-plists params2 params))))
11856 ;;;; Link Stuff
11858 ;;; Link abbreviations
11860 (defun org-link-expand-abbrev (link)
11861 "Apply replacements as defined in `org-link-abbrev-alist."
11863 (let* ((key (match-string 1 link))
11864 (as (or (assoc key org-link-abbrev-alist-local)
11865 (assoc key org-link-abbrev-alist)))
11866 (tag (and (match-end 2) (match-string 3 link)))
11867 rpl)
11868 (if (not as)
11869 link
11870 (setq rpl (cdr as))
11871 (cond
11872 ((symbolp rpl) (funcall rpl tag))
11873 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11874 (t (concat rpl tag)))))
11875 link))
11877 ;;; Storing and inserting links
11879 (defvar org-insert-link-history nil
11880 "Minibuffer history for links inserted with `org-insert-link'.")
11882 (defvar org-stored-links nil
11883 "Contains the links stored with `org-store-link'.")
11885 (defvar org-store-link-plist nil
11886 "Plist with info about the most recently link created with `org-store-link'.")
11888 (defvar org-link-protocols nil
11889 "Link protocols added to Org-mode using `org-add-link-type'.")
11891 (defvar org-store-link-functions nil
11892 "List of functions that are called to create and store a link.
11893 Each function will be called in turn until one returns a non-nil
11894 value. Each function should check if it is responsible for creating
11895 this link (for example by looking at the major mode).
11896 If not, it must exit and return nil.
11897 If yes, it should return a non-nil value after a calling
11898 `org-store-link-props' with a list of properties and values.
11899 Special properties are:
11903 This is obligatory as well.
11904 :description Optional default description for the second pair
11905 of brackets in an Org-mode link. The user can still change
11906 this when inserting this link into an Org-mode buffer.
11908 In addition to these, any additional properties can be specified
11909 and then used in remember templates.")
11911 (defun org-add-link-type (type &optional follow publish)
11912 "Add TYPE to the list of `org-link-types'.
11913 Re-compute all regular expressions depending on `org-link-types'
11914 FOLLOW and PUBLISH are two functions. Both take the link path as
11915 an argument.
11916 FOLLOW should do whatever is necessary to follow the link, for example
11917 to find a file or display a mail message.
11919 PUBLISH takes the path and retuns the string that should be used when
11920 this document is published. FIMXE: This is actually not yet implemented."
11921 (add-to-list 'org-link-types type t)
11922 (org-make-link-regexps)
11923 (add-to-list 'org-link-protocols
11924 (list type follow publish)))
11926 (defun org-add-agenda-custom-command (entry)
11927 "Replace or add a command in `org-agenda-custom-commands'.
11928 This is mostly for hacking and trying a new command - once the command
11929 works you probably want to add it to `org-agenda-custom-commands' for good."
11930 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11931 (if ass
11932 (setcdr ass (cdr entry))
11933 (push entry org-agenda-custom-commands))))
11935 ;;;###autoload
11936 (defun org-store-link (arg)
11938 This link is added to `org-stored-links' and can later be inserted
11941 For some link types, a prefix arg is interpreted:
11942 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11943 For file links, arg negates `org-context-in-file-links'."
11944 (interactive "P")
11945 (setq org-store-link-plist nil) ; reset
11946 (require 'org-irc)
11947 (let (link cpltxt desc description search txt)
11948 (cond
11950 ((run-hook-with-args-until-success 'org-store-link-functions)
11951 (setq link (plist-get org-store-link-plist :link)
11952 desc (or (plist-get org-store-link-plist :description) link)))
11954 ((eq major-mode 'bbdb-mode)
11955 (let ((name (bbdb-record-name (bbdb-current-record)))
11956 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11957 (setq cpltxt (concat "bbdb:" (or name company))
11958 link (org-make-link cpltxt))
11959 (org-store-link-props :type "bbdb" :name name :company company)))
11961 ((eq major-mode 'Info-mode)
11962 (setq link (org-make-link "info:"
11963 (file-name-nondirectory Info-current-file)
11964 ":" Info-current-node))
11965 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11966 ":" Info-current-node))
11967 (org-store-link-props :type "info" :file Info-current-file
11968 :node Info-current-node))
11970 ((eq major-mode 'calendar-mode)
11971 (let ((cd (calendar-cursor-to-date)))
11972 (setq link
11973 (format-time-string
11974 (car org-time-stamp-formats)
11975 (apply 'encode-time
11976 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11977 nil nil nil))))
11978 (org-store-link-props :type "calendar" :date cd)))
11980 ((or (eq major-mode 'vm-summary-mode)
11981 (eq major-mode 'vm-presentation-mode))
11982 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11983 (vm-follow-summary-cursor)
11984 (save-excursion
11985 (vm-select-folder-buffer)
11986 (let* ((message (car vm-message-pointer))
11987 (folder buffer-file-name)
11988 (subject (vm-su-subject message))
11989 (to (vm-get-header-contents message "To"))
11990 (from (vm-get-header-contents message "From"))
11991 (message-id (vm-su-message-id message)))
11992 (org-store-link-props :type "vm" :from from :to to :subject subject
11993 :message-id message-id)
11994 (setq message-id (org-remove-angle-brackets message-id))
11995 (setq folder (abbreviate-file-name folder))
11996 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11997 folder)
11998 (setq folder (replace-match "" t t folder)))
11999 (setq cpltxt (org-email-link-description))
12000 (setq link (org-make-link "vm:" folder "#" message-id)))))
12002 ((eq major-mode 'wl-summary-mode)
12003 (let* ((msgnum (wl-summary-message-number))
12004 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
12005 msgnum 'message-id))
12006 (wl-message-entity
12007 (if (fboundp 'elmo-message-entity)
12008 (elmo-message-entity
12009 wl-summary-buffer-elmo-folder msgnum)
12010 (elmo-msgdb-overview-get-entity
12011 msgnum (wl-summary-buffer-msgdb))))
12012 (from (wl-summary-line-from))
12013 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12014 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12015 (wl-summary-line-subject))))
12016 (org-store-link-props :type "wl" :from from :to to
12017 :subject subject :message-id message-id)
12018 (setq message-id (org-remove-angle-brackets message-id))
12019 (setq cpltxt (org-email-link-description))
12020 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12021 "#" message-id))))
12023 ((or (equal major-mode 'mh-folder-mode)
12024 (equal major-mode 'mh-show-mode))
12025 (let ((from (org-mhe-get-header "From:"))
12026 (to (org-mhe-get-header "To:"))
12027 (message-id (org-mhe-get-header "Message-Id:"))
12028 (subject (org-mhe-get-header "Subject:")))
12029 (org-store-link-props :type "mh" :from from :to to
12030 :subject subject :message-id message-id)
12031 (setq cpltxt (org-email-link-description))
12032 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12033 (org-remove-angle-brackets message-id)))))
12035 ((or (eq major-mode 'rmail-mode)
12036 (eq major-mode 'rmail-summary-mode))
12037 (save-window-excursion
12038 (save-restriction
12039 (when (eq major-mode 'rmail-summary-mode)
12040 (rmail-show-message rmail-current-message))
12041 (rmail-narrow-to-non-pruned-header)
12042 (let ((folder buffer-file-name)
12043 (message-id (mail-fetch-field "message-id"))
12044 (from (mail-fetch-field "from"))
12045 (to (mail-fetch-field "to"))
12046 (subject (mail-fetch-field "subject")))
12047 (org-store-link-props
12048 :type "rmail" :from from :to to
12049 :subject subject :message-id message-id)
12050 (setq message-id (org-remove-angle-brackets message-id))
12051 (setq cpltxt (org-email-link-description))
12052 (setq link (org-make-link "rmail:" folder "#" message-id)))
12053 (rmail-show-message rmail-current-message))))
12055 ((eq major-mode 'gnus-group-mode)
12056 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12057 (gnus-group-group-name)) ; version
12058 ((fboundp 'gnus-group-name)
12059 (gnus-group-name))
12060 (t "???"))))
12061 (unless group (error "Not on a group"))
12062 (org-store-link-props :type "gnus" :group group)
12063 (setq cpltxt (concat
12064 (if (org-xor arg org-usenet-links-prefer-google)
12065 "http://groups.google.com/groups?group="
12066 "gnus:")
12067 group)
12068 link (org-make-link cpltxt))))
12070 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12071 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12072 (let* ((group gnus-newsgroup-name)
12073 (article (gnus-summary-article-number))
12074 (header (gnus-summary-article-header article))
12075 (from (mail-header-from header))
12076 (message-id (mail-header-id header))
12077 (date (mail-header-date header))
12078 (subject (gnus-summary-subject-string)))
12079 (org-store-link-props :type "gnus" :from from :subject subject
12080 :message-id message-id :group group)
12081 (setq cpltxt (org-email-link-description))
12082 (if (org-xor arg org-usenet-links-prefer-google)
12083 (setq link
12084 (concat
12086 (format "http://groups.google.com/groups?as_umsgid=%s"
12087 (org-fixup-message-id-for-http message-id))))
12088 (setq link (org-make-link "gnus:" group
12089 "#" (number-to-string article))))))
12091 ((eq major-mode 'w3-mode)
12092 (setq cpltxt (url-view-url t)
12093 link (org-make-link cpltxt))
12094 (org-store-link-props :type "w3" :url (url-view-url t)))
12096 ((eq major-mode 'w3m-mode)
12097 (setq cpltxt (or w3m-current-title w3m-current-url)
12098 link (org-make-link w3m-current-url))
12099 (org-store-link-props :type "w3m" :url (url-view-url t)))
12101 ((setq search (run-hook-with-args-until-success
12102 'org-create-file-search-functions))
12103 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12104 "::" search))
12105 (setq cpltxt (or description link)))
12107 ((eq major-mode 'image-mode)
12108 (setq cpltxt (concat "file:"
12109 (abbreviate-file-name buffer-file-name))
12110 link (org-make-link cpltxt))
12111 (org-store-link-props :type "image" :file buffer-file-name))
12113 ((eq major-mode 'dired-mode)
12114 ;; link to the file in the current line
12115 (setq cpltxt (concat "file:"
12116 (abbreviate-file-name
12117 (expand-file-name
12118 (dired-get-filename nil t))))
12119 link (org-make-link cpltxt)))
12121 ((and buffer-file-name (org-mode-p))
12122 ;; Just link to current headline
12123 (setq cpltxt (concat "file:"
12124 (abbreviate-file-name buffer-file-name)))
12125 ;; Add a context search string
12126 (when (org-xor org-context-in-file-links arg)
12127 ;; Check if we are on a target
12129 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12130 (setq txt (cond
12131 ((org-on-heading-p) nil)
12132 ((org-region-active-p)
12133 (buffer-substring (region-beginning) (region-end)))
12134 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12136 (setq cpltxt
12137 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12138 desc "NONE"))))
12140 (setq cpltxt (substring cpltxt 0 -2)))
12141 (setq link (org-make-link cpltxt)))
12143 ((buffer-file-name (buffer-base-buffer))
12144 ;; Just link to this file here.
12145 (setq cpltxt (concat "file:"
12146 (abbreviate-file-name
12147 (buffer-file-name (buffer-base-buffer)))))
12148 ;; Add a context string
12149 (when (org-xor org-context-in-file-links arg)
12150 (setq txt (if (org-region-active-p)
12151 (buffer-substring (region-beginning) (region-end))
12152 (buffer-substring (point-at-bol) (point-at-eol))))
12153 ;; Only use search option if there is some text.
12155 (setq cpltxt
12156 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12157 desc "NONE")))
12158 (setq link (org-make-link cpltxt)))
12160 ((interactive-p)
12161 (error "Cannot link to a buffer which is not visiting a file"))
12163 (t (setq link nil)))
12165 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12166 (setq link (or link cpltxt)
12167 desc (or desc cpltxt))
12168 (if (equal desc "NONE") (setq desc nil))
12170 (if (and (interactive-p) link)
12171 (progn
12172 (setq org-stored-links
12173 (cons (list link desc) org-stored-links))
12174 (message "Stored: %s" (or desc link)))
12175 (and link (org-make-link-string link desc)))))
12177 (defun org-store-link-props (&rest plist)
12178 "Store link properties, extract names and addresses."
12179 (let (x adr)
12180 (when (setq x (plist-get plist :from))
12181 (setq adr (mail-extract-address-components x))
12182 (plist-put plist :fromname (car adr))
12183 (plist-put plist :fromaddress (nth 1 adr)))
12184 (when (setq x (plist-get plist :to))
12185 (setq adr (mail-extract-address-components x))
12186 (plist-put plist :toname (car adr))
12187 (plist-put plist :toaddress (nth 1 adr))))
12188 (let ((from (plist-get plist :from))
12189 (to (plist-get plist :to)))
12190 (when (and from to org-from-is-user-regexp)
12191 (plist-put plist :fromto
12192 (if (string-match org-from-is-user-regexp from)
12193 (concat "to %t")
12194 (concat "from %f")))))
12195 (setq org-store-link-plist plist))
12197 (defun org-email-link-description (&optional fmt)
12198 "Return the description part of an email link.
12199 This takes information from `org-store-link-plist' and formats it
12200 according to FMT (default from `org-email-link-description-format')."
12201 (setq fmt (or fmt org-email-link-description-format))
12202 (let* ((p org-store-link-plist)
12203 (to (plist-get p :toaddress))
12204 (from (plist-get p :fromaddress))
12205 (table
12206 (list
12207 (cons "%c" (plist-get p :fromto))
12208 (cons "%F" (plist-get p :from))
12209 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12210 (cons "%T" (plist-get p :to))
12211 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12212 (cons "%s" (plist-get p :subject))
12213 (cons "%m" (plist-get p :message-id)))))
12214 (when (string-match "%c" fmt)
12215 ;; Check if the user wrote this message
12216 (if (and org-from-is-user-regexp from to
12217 (save-match-data (string-match org-from-is-user-regexp from)))
12218 (setq fmt (replace-match "to %t" t t fmt))
12219 (setq fmt (replace-match "from %f" t t fmt))))
12220 (org-replace-escapes fmt table)))
12222 (defun org-make-org-heading-search-string (&optional string heading)
12223 "Make search string for STRING or current headline."
12224 (interactive)
12225 (let ((s (or string (org-get-heading))))
12226 (unless (and string (not heading))
12227 ;; We are using a headline, clean up garbage in there.
12228 (if (string-match org-todo-regexp s)
12229 (setq s (replace-match "" t t s)))
12231 (setq s (replace-match "" t t s)))
12232 (setq s (org-trim s))
12235 (setq s (replace-match "" t t s)))
12236 (while (string-match org-ts-regexp s)
12237 (setq s (replace-match "" t t s))))
12239 (setq s (replace-match " " t t s)))
12240 (or string (setq s (concat "*" s))) ; Add * for headlines
12243 (defun org-make-link (&rest strings)
12244 "Concatenate STRINGS."
12245 (apply 'concat strings))
12247 (defun org-make-link-string (link &optional description)
12248 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12250 (error "Empty link"))
12251 (when (stringp description)
12252 ;; Remove brackets from the description, they are fatal.
12254 (setq description (replace-match "{" t t description)))
12256 (setq description (replace-match "}" t t description))))
12257 (when (equal (org-link-escape link) description)
12258 ;; No description needed, it is identical
12259 (setq description nil))
12260 (when (and (not description)
12261 (not (equal link (org-link-escape link))))
12262 (setq description link))
12263 (concat "[[" (org-link-escape link) "]"
12264 (if description (concat "[" description "]") "")
12265 "]"))
12267 (defconst org-link-escape-chars
12268 '((?\ . "%20")
12269 (?\[ . "%5B")
12270 (?\] . "%5D")
12281 (?\; . "%3B")
12282 (?? . "%3F")
12283 (?= . "%3D")
12284 (?+ . "%2B")
12285 )
12286 "Association list of escapes for some characters problematic in links.
12287 This is the list that is used for internal purposes.")
12289 (defconst org-link-escape-chars-browser
12290 '((?\ . "%20")) ; 32 for the SPC char
12291 "Association list of escapes for some characters problematic in links.
12292 This is the list that is used before handing over to the browser.")
12294 (defun org-link-escape (text &optional table)
12295 "Escape charaters in TEXT that are problematic for links."
12296 (setq table (or table org-link-escape-chars))
12297 (when text
12298 (let ((re (mapconcat (lambda (x) (regexp-quote
12299 (char-to-string (car x))))
12301 (while (string-match re text)
12302 (setq text
12303 (replace-match
12304 (cdr (assoc (string-to-char (match-string 0 text))
12305 table))
12306 t t text)))
12307 text)))
12309 (defun org-link-unescape (text &optional table)
12310 "Reverse the action of `org-link-escape'."
12311 (setq table (or table org-link-escape-chars))
12312 (when text
12313 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12315 (while (string-match re text)
12316 (setq text
12317 (replace-match
12318 (char-to-string (car (rassoc (match-string 0 text) table)))
12319 t t text)))
12320 text)))
12322 (defun org-xor (a b)
12323 "Exclusive or."
12324 (if a (not b) b))
12326 (defun org-get-header (header)
12327 "Find a header field in the current buffer."
12328 (save-excursion
12329 (goto-char (point-min))
12330 (let ((case-fold-search t) s)
12331 (cond
12332 ((eq header 'from)
12334 (setq s (match-string 1)))
12336 (setq s (replace-match "" t t s)))
12337 (if (string-match "[<(].*" s)
12338 (setq s (replace-match "" t t s))))
12339 ((eq header 'message-id)
12341 (setq s (match-string 1))))
12342 ((eq header 'subject)
12344 (setq s (match-string 1)))))
12347 s)))
12350 (defun org-fixup-message-id-for-http (s)
12351 "Replace special characters in a message id, so it can be used in an http query."
12352 (while (string-match "<" s)
12353 (setq s (replace-match "%3C" t t s)))
12354 (while (string-match ">" s)
12355 (setq s (replace-match "%3E" t t s)))
12356 (while (string-match "@" s)
12357 (setq s (replace-match "%40" t t s)))
12358 s)
12360 ;;;###autoload
12361 (defun org-insert-link-global ()
12362 "Insert a link like Org-mode does.
12363 This command can be called in any mode to insert a link in Org-mode syntax."
12364 (interactive)
12365 (org-run-like-in-org-mode 'org-insert-link))
12367 (defun org-insert-link (&optional complete-file)
12368 "Insert a link. At the prompt, enter the link.
12370 Completion can be used to select a link previously stored with
12371 `org-store-link'. When the empty string is entered (i.e. if you just
12372 press RET at the prompt), the link defaults to the most recently
12373 stored link. As SPC triggers completion in the minibuffer, you need to
12374 use M-SPC or C-q SPC to force the insertion of a space character.
12376 You will also be prompted for a description, and if one is given, it will
12377 be displayed in the buffer instead of the link.
12379 If there is already a link at point, this command will allow you to edit link
12380 and description parts.
12383 selected using completion. The path to the file will be relative to
12384 the current directory if the file is in the current directory or a
12385 subdirectory. Otherwise, the link will be the absolute path as
12386 completed in the minibuffer (i.e. normally ~/path/to/file).
12389 is in the current directory or below.
12391 `org-keep-stored-link-after-insertion'."
12392 (interactive "P")
12393 (let* ((wcf (current-window-configuration))
12394 (region (if (org-region-active-p)
12395 (buffer-substring (region-beginning) (region-end))))
12396 (remove (and region (list (region-beginning) (region-end))))
12397 (desc region)
12398 tmphist ; byte-compile incorrectly complains about this
12399 link entry file)
12400 (cond
12401 ((org-in-regexp org-bracket-link-regexp 1)
12402 ;; We do have a link at point, and we are going to edit it.
12403 (setq remove (list (match-beginning 0) (match-end 0)))
12404 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12405 (setq link (read-string "Link: "
12406 (org-link-unescape
12407 (org-match-string-no-properties 1)))))
12408 ((or (org-in-regexp org-angle-link-re)
12409 (org-in-regexp org-plain-link-re))
12410 ;; Convert to bracket link
12411 (setq remove (list (match-beginning 0) (match-end 0))
12412 link (read-string "Link: "
12413 (org-remove-angle-brackets (match-string 0)))))
12414 ((equal complete-file '(4))
12415 ;; Completing read for file names.
12416 (setq file (read-file-name "File: "))
12417 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12418 (pwd1 (file-name-as-directory (abbreviate-file-name
12419 (expand-file-name ".")))))
12420 (cond
12421 ((equal complete-file '(16))
12422 (setq link (org-make-link
12423 "file:"
12424 (abbreviate-file-name (expand-file-name file)))))
12426 (setq link (org-make-link "file:" (match-string 1 file))))
12428 (expand-file-name file))
12429 (setq link (org-make-link
12430 "file:" (match-string 1 (expand-file-name file)))))
12431 (t (setq link (org-make-link "file:" file))))))
12432 (t
12433 ;; Read link, with completion for stored links.
12434 (with-output-to-temp-buffer "*Org Links*"
12436 (when org-stored-links
12438 (princ (mapconcat
12439 (lambda (x)
12440 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12442 (let ((cw (selected-window)))
12443 (select-window (get-buffer-window "*Org Links*"))
12444 (shrink-window-if-larger-than-buffer)
12445 (setq truncate-lines t)
12446 (select-window cw))
12447 ;; Fake a link history, containing the stored links.
12448 (setq tmphist (append (mapcar 'car org-stored-links)
12449 org-insert-link-history))
12450 (unwind-protect
12451 (setq link (org-completing-read
12452 "Link: "
12453 (append
12454 (mapcar (lambda (x) (list (concat (car x) ":")))
12455 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12456 (mapcar (lambda (x) (list (concat x ":")))
12457 org-link-types))
12458 nil nil nil
12459 'tmphist
12460 (or (car (car org-stored-links)))))
12461 (set-window-configuration wcf)
12462 (kill-buffer "*Org Links*"))
12463 (setq entry (assoc link org-stored-links))
12464 (or entry (push link org-insert-link-history))
12465 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12466 (not org-keep-stored-link-after-insertion))
12467 (setq org-stored-links (delq (assoc link org-stored-links)
12468 org-stored-links)))
12469 (setq desc (or desc (nth 1 entry)))))
12471 (if (string-match org-plain-link-re link)
12472 ;; URL-like link, normalize the use of angular brackets.
12473 (setq link (org-make-link (org-remove-angle-brackets link))))
12475 ;; Check if we are linking to the current file with a search option
12476 ;; If yes, simplify the link by using only the search option.
12477 (when (and buffer-file-name
12479 (let* ((path (match-string 1 link))
12480 (case-fold-search nil)
12481 (search (match-string 2 link)))
12482 (save-match-data
12483 (if (equal (file-truename buffer-file-name) (file-truename path))
12484 ;; We are linking to this same file, with a search option
12485 (setq link search)))))
12487 ;; Check if we can/should use a relative path. If yes, simplify the link
12489 (let* ((path (match-string 1 link))
12490 (origpath path)
12491 (case-fold-search nil))
12492 (cond
12493 ((eq org-link-file-path-type 'absolute)
12494 (setq path (abbreviate-file-name (expand-file-name path))))
12495 ((eq org-link-file-path-type 'noabbrev)
12496 (setq path (expand-file-name path)))
12497 ((eq org-link-file-path-type 'relative)
12498 (setq path (file-relative-name path)))
12499 (t
12500 (save-match-data
12501 (if (string-match (concat "^" (regexp-quote
12502 (file-name-as-directory
12503 (expand-file-name "."))))
12504 (expand-file-name path))
12505 ;; We are linking a file with relative path name.
12506 (setq path (substring (expand-file-name path)
12507 (match-end 0)))))))
12508 (setq link (concat "file:" path))
12509 (if (equal desc origpath)
12510 (setq desc path))))
12512 (setq desc (read-string "Description: " desc))
12514 (if remove (apply 'delete-region remove))
12515 (insert (org-make-link-string link desc))))
12517 (defun org-completing-read (&rest args)
12518 (let ((minibuffer-local-completion-map
12519 (copy-keymap minibuffer-local-completion-map)))
12520 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12521 (apply 'completing-read args)))
12523 ;;; Opening/following a link
12524 (defvar org-link-search-failed nil)
12526 (defun org-next-link ()
12527 "Move forward to the next link.
12528 If the link is in hidden text, expose it."
12529 (interactive)
12530 (when (and org-link-search-failed (eq this-command last-command))
12531 (goto-char (point-min))
12532 (message "Link search wrapped back to beginning of buffer"))
12533 (setq org-link-search-failed nil)
12534 (let* ((pos (point))
12535 (ct (org-context))
12536 (a (assoc :link ct)))
12537 (if a (goto-char (nth 2 a)))
12538 (if (re-search-forward org-any-link-re nil t)
12539 (progn
12540 (goto-char (match-beginning 0))
12541 (if (org-invisible-p) (org-show-context)))
12542 (goto-char pos)
12543 (setq org-link-search-failed t)
12544 (error "No further link found"))))
12546 (defun org-previous-link ()
12547 "Move backward to the previous link.
12548 If the link is in hidden text, expose it."
12549 (interactive)
12550 (when (and org-link-search-failed (eq this-command last-command))
12551 (goto-char (point-max))
12552 (message "Link search wrapped back to end of buffer"))
12553 (setq org-link-search-failed nil)
12554 (let* ((pos (point))
12555 (ct (org-context))
12556 (a (assoc :link ct)))
12557 (if a (goto-char (nth 1 a)))
12558 (if (re-search-backward org-any-link-re nil t)
12559 (progn
12560 (goto-char (match-beginning 0))
12561 (if (org-invisible-p) (org-show-context)))
12562 (goto-char pos)
12563 (setq org-link-search-failed t)
12564 (error "No further link found"))))
12566 (defun org-find-file-at-mouse (ev)
12567 "Open file link or URL at mouse."
12568 (interactive "e")
12569 (mouse-set-point ev)
12570 (org-open-at-point 'in-emacs))
12572 (defun org-open-at-mouse (ev)
12573 "Open file link or URL at mouse."
12574 (interactive "e")
12575 (mouse-set-point ev)
12576 (org-open-at-point))
12578 (defvar org-window-config-before-follow-link nil
12579 "The window configuration before following a link.
12580 This is saved in case the need arises to restore it.")
12582 (defvar org-open-link-marker (make-marker)
12583 "Marker pointing to the location where `org-open-at-point; was called.")
12585 ;;;###autoload
12586 (defun org-open-at-point-global ()
12587 "Follow a link like Org-mode does.
12588 This command can be called in any mode to follow a link that has
12589 Org-mode syntax."
12590 (interactive)
12591 (org-run-like-in-org-mode 'org-open-at-point))
12593 (defun org-open-at-point (&optional in-emacs)
12594 "Open link at or after point.
12595 If there is no link at point, this function will search forward up to
12596 the end of the current subtree.
12597 Normally, files will be opened by an appropriate application. If the
12598 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12599 (interactive "P")
12600 (catch 'abort
12601 (move-marker org-open-link-marker (point))
12602 (setq org-window-config-before-follow-link (current-window-configuration))
12603 (org-remove-occur-highlights nil nil t)
12604 (if (org-at-timestamp-p t)
12605 (org-follow-timestamp-link)
12606 (let (type path link line search (pos (point)))
12607 (catch 'match
12608 (save-excursion
12610 (when (org-in-regexp org-bracket-link-regexp)
12611 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12613 (setq link (replace-match " " t t link)))
12614 (setq link (org-link-expand-abbrev link))
12615 (if (string-match org-link-re-with-space2 link)
12616 (setq type (match-string 1 link) path (match-string 2 link))
12617 (setq type "thisfile" path link))
12618 (throw 'match t)))
12620 (when (get-text-property (point) 'org-linked-text)
12621 (setq type "thisfile"
12622 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12623 (1+ (point)) (point))
12624 path (buffer-substring
12625 (previous-single-property-change pos 'org-linked-text)
12626 (next-single-property-change pos 'org-linked-text)))
12627 (throw 'match t))
12629 (save-excursion
12630 (when (or (org-in-regexp org-angle-link-re)
12631 (org-in-regexp org-plain-link-re))
12632 (setq type (match-string 1) path (match-string 2))
12633 (throw 'match t)))
12635 (setq type "tree-match"
12636 path (match-string 1))
12637 (throw 'match t))
12638 (save-excursion
12640 (setq type "tags"
12641 path (match-string 1))
12642 (while (string-match ":" path)
12643 (setq path (replace-match "+" t t path)))
12644 (throw 'match t))))
12645 (unless path
12646 (error "No link found"))
12647 ;; Remove any trailing spaces in path
12649 (setq path (replace-match "" t t path)))
12651 (cond
12653 ((assoc type org-link-protocols)
12654 (funcall (nth 1 (assoc type org-link-protocols)) path))
12656 ((equal type "mailto")
12657 (let ((cmd (car org-link-mailto-program))
12658 (args (cdr org-link-mailto-program)) args1
12659 (address path) (subject "") a)
12661 (setq address (match-string 1 path)
12662 subject (org-link-escape (match-string 2 path))))
12663 (while args
12664 (cond
12665 ((not (stringp (car args))) (push (pop args) args1))
12666 (t (setq a (pop args))
12667 (if (string-match "%a" a)
12668 (setq a (replace-match address t t a)))
12669 (if (string-match "%s" a)
12670 (setq a (replace-match subject t t a)))
12671 (push a args1))))
12672 (apply cmd (nreverse args1))))
12674 ((member type '("http" "https" "ftp" "news"))
12675 (browse-url (concat type ":" (org-link-escape
12676 path org-link-escape-chars-browser))))
12678 ((member type '("message"))
12679 (browse-url (concat type ":" path)))
12681 ((string= type "tags")
12682 (org-tags-view in-emacs path))
12683 ((string= type "thisfile")
12684 (if in-emacs
12685 (switch-to-buffer-other-window
12686 (org-get-buffer-for-internal-link (current-buffer)))
12687 (org-mark-ring-push))
12688 (let ((cmd `(org-link-search
12689 ,path
12690 ,(cond ((equal in-emacs '(4)) 'occur)
12691 ((equal in-emacs '(16)) 'org-occur)
12692 (t nil))
12693 ,pos)))
12694 (condition-case nil (eval cmd)
12695 (error (progn (widen) (eval cmd))))))
12697 ((string= type "tree-match")
12700 ((string= type "file")
12702 (setq line (string-to-number (match-string 1 path))
12703 path (substring path 0 (match-beginning 0)))
12705 (setq search (match-string 1 path)
12706 path (substring path 0 (match-beginning 0)))))
12707 (if (string-match "[*?{]" (file-name-nondirectory path))
12708 (dired path)
12709 (org-open-file path in-emacs line search)))
12711 ((string= type "news")
12712 (org-follow-gnus-link path))
12714 ((string= type "bbdb")
12715 (org-follow-bbdb-link path))
12717 ((string= type "info")
12718 (org-follow-info-link path))
12720 ((string= type "gnus")
12721 (let (group article)
12723 (error "Error in Gnus link"))
12724 (setq group (match-string 1 path)
12725 article (match-string 3 path))
12726 (org-follow-gnus-link group article)))
12728 ((string= type "vm")
12729 (let (folder article)
12731 (error "Error in VM link"))
12732 (setq folder (match-string 1 path)
12733 article (match-string 3 path))
12734 ;; in-emacs is the prefix arg, will be interpreted as read-only
12735 (org-follow-vm-link folder article in-emacs)))
12737 ((string= type "wl")
12738 (let (folder article)
12740 (error "Error in Wanderlust link"))
12741 (setq folder (match-string 1 path)
12742 article (match-string 3 path))
12743 (org-follow-wl-link folder article)))
12745 ((string= type "mhe")
12746 (let (folder article)
12748 (error "Error in MHE link"))
12749 (setq folder (match-string 1 path)
12750 article (match-string 3 path))
12751 (org-follow-mhe-link folder article)))
12753 ((string= type "rmail")
12754 (let (folder article)
12756 (error "Error in RMAIL link"))
12757 (setq folder (match-string 1 path)
12758 article (match-string 3 path))
12759 (org-follow-rmail-link folder article)))
12761 ((string= type "shell")
12762 (let ((cmd path))
12763 (if (or (not org-confirm-shell-link-function)
12764 (funcall org-confirm-shell-link-function
12766 (org-add-props cmd nil
12767 'face 'org-warning))))
12768 (progn
12769 (message "Executing %s" cmd)
12770 (shell-command cmd))
12771 (error "Abort"))))
12773 ((string= type "elisp")
12774 (let ((cmd path))
12775 (if (or (not org-confirm-elisp-link-function)
12776 (funcall org-confirm-elisp-link-function
12778 (org-add-props cmd nil
12779 'face 'org-warning))))
12780 (message "%s => %s" cmd (eval (read cmd)))
12781 (error "Abort"))))
12783 (t
12784 (browse-url-at-point)))))
12785 (move-marker org-open-link-marker nil)))
12787 ;;; File search
12789 (defvar org-create-file-search-functions nil
12790 "List of functions to construct the right search string for a file link.
12791 These functions are called in turn with point at the location to
12792 which the link should point.
12794 A function in the hook should first test if it would like to
12795 handle this file type, for example by checking the major-mode or
12796 the file extension. If it decides not to handle this file, it
12797 should just return nil to give other functions a chance. If it
12798 does handle the file, it must return the search string to be used
12799 when following the link. The search string will be part of the
12800 file link, given after a double colon, and `org-open-at-point'
12801 will automatically search for it. If special measures must be
12802 taken to make the search successful, another function should be
12803 added to the companion hook `org-execute-file-search-functions',
12804 which see.
12806 A function in this hook may also use `setq' to set the variable
12807 `description' to provide a suggestion for the descriptive text to
12808 be used for this link when it gets inserted into an Org-mode
12811 (defvar org-execute-file-search-functions nil
12812 "List of functions to execute a file search triggered by a link.
12814 Functions added to this hook must accept a single argument, the
12815 search string that was part of the file link, the part after the
12816 double colon. The function must first check if it would like to
12817 handle this search, for example by checking the major-mode or the
12818 file extension. If it decides not to handle this search, it
12819 should just return nil to give other functions a chance. If it
12820 does handle the search, it must return a non-nil value to keep
12821 other functions from trying.
12823 Each function can access the current prefix argument through the
12824 variable `current-prefix-argument'. Note that a single prefix is
12825 used to force opening a link in Emacs, so it may be good to only
12826 use a numeric or double prefix to guide the search function.
12828 In case this is needed, a function in this hook can also restore
12829 the window configuration before `org-open-at-point' was called using:
12831 (set-window-configuration org-window-config-before-follow-link)")
12833 (defun org-link-search (s &optional type avoid-pos)
12834 "Search for a link search option.
12835 If S is surrounded by forward slashes, it is interpreted as a
12836 regular expression. In org-mode files, this will create an `org-occur'
12837 sparse tree. In ordinary files, `occur' will be used to list matches.
12838 If the current buffer is in `dired-mode', grep will be used to search
12839 in all files. If AVOID-POS is given, ignore matches near that position."
12840 (let ((case-fold-search t)
12844 org-emphasis-alist)
12846 (pos (point))
12847 (pre "") (post "")
12848 words re0 re1 re2 re3 re4 re5 re2a reall)
12849 (cond
12850 ;; First check if there are any special
12851 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12852 ;; Now try the builtin stuff
12853 ((save-excursion
12854 (goto-char (point-min))
12855 (and
12856 (re-search-forward
12857 (concat "<<" (regexp-quote s0) ">>") nil t)
12858 (setq pos (match-beginning 0))))
12859 ;; There is an exact target for this
12860 (goto-char pos))
12862 ;; A regular expression
12863 (cond
12864 ((org-mode-p)
12865 (org-occur (match-string 1 s)))
12866 ;;((eq major-mode 'dired-mode)
12867 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12868 (t (org-do-occur (match-string 1 s)))))
12869 (t
12870 ;; A normal search strings
12871 (when (equal (string-to-char s) ?*)
12872 ;; Anchor on headlines, post may include tags.
12875 s (substring s 1)))
12876 (remove-text-properties
12877 0 (length s)
12878 '(face nil mouse-face nil keymap nil fontified nil) s)
12879 ;; Make a series of regular expressions to find a match
12886 re1 (concat pre re2 post)
12887 re3 (concat pre re4 post)
12888 re5 (concat pre ".*" re4)
12889 re2 (concat pre re2)
12890 re2a (concat pre re2a)
12891 re4 (concat pre re4)
12895 ))
12896 (cond
12897 ((eq type 'org-occur) (org-occur reall))
12898 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12899 (t (goto-char (point-min))
12900 (if (or (org-search-not-self 1 re0 nil t)
12901 (org-search-not-self 1 re1 nil t)
12902 (org-search-not-self 1 re2 nil t)
12903 (org-search-not-self 1 re2a nil t)
12904 (org-search-not-self 1 re3 nil t)
12905 (org-search-not-self 1 re4 nil t)
12906 (org-search-not-self 1 re5 nil t)
12907 )
12908 (goto-char (match-beginning 1))
12909 (goto-char pos)
12910 (error "No match")))))
12911 (t
12912 ;; Normal string-search
12913 (goto-char (point-min))
12914 (if (search-forward s nil t)
12915 (goto-char (match-beginning 0))
12916 (error "No match"))))
12917 (and (org-mode-p) (org-show-context 'link-search))))
12919 (defun org-search-not-self (group &rest args)
12920 "Execute `re-search-forward', but only accept matches that do not
12921 enclose the position of `org-open-link-marker'."
12922 (let ((m org-open-link-marker))
12923 (catch 'exit
12924 (while (apply 're-search-forward args)
12925 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12926 (goto-char (match-end group))
12927 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12928 (> (match-beginning 0) (marker-position m))
12929 (< (match-end 0) (marker-position m)))
12930 (save-match-data
12931 (or (not (org-in-regexp
12932 org-bracket-link-analytic-regexp 1))
12933 (not (match-end 4)) ; no description
12934 (and (<= (match-beginning 4) (point))
12935 (>= (match-end 4) (point))))))
12936 (throw 'exit (point))))))))
12938 (defun org-get-buffer-for-internal-link (buffer)
12939 "Return a buffer to be used for displaying the link target of internal links."
12940 (cond
12941 ((not org-display-internal-link-with-indirect-buffer)
12942 buffer)
12943 ((string-match "(Clone)$" (buffer-name buffer))
12944 (message "Buffer is already a clone, not making another one")
12945 ;; we also do not modify visibility in this case
12946 buffer)
12947 (t ; make a new indirect buffer for displaying the link
12948 (let* ((bn (buffer-name buffer))
12949 (ibn (concat bn "(Clone)"))
12950 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12951 (with-current-buffer ib (org-overview))
12952 ib))))
12954 (defun org-do-occur (regexp &optional cleanup)
12955 "Call the Emacs command `occur'.
12956 If CLEANUP is non-nil, remove the printout of the regular expression
12957 in the *Occur* buffer. This is useful if the regex is long and not useful
12958 to read."
12959 (occur regexp)
12960 (when cleanup
12961 (let ((cwin (selected-window)) win beg end)
12962 (when (setq win (get-buffer-window "*Occur*"))
12963 (select-window win))
12964 (goto-char (point-min))
12965 (when (re-search-forward "match[a-z]+" nil t)
12966 (setq beg (match-end 0))
12968 (setq end (1- (match-beginning 0)))))
12969 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12970 (goto-char (point-min))
12971 (select-window cwin))))
12973 ;;; The mark ring for links jumps
12975 (defvar org-mark-ring nil
12976 "Mark ring for positions before jumps in Org-mode.")
12977 (defvar org-mark-ring-last-goto nil
12978 "Last position in the mark ring used to go back.")
12979 ;; Fill and close the ring
12980 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12981 (loop for i from 1 to org-mark-ring-length do
12982 (push (make-marker) org-mark-ring))
12983 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12984 org-mark-ring)
12986 (defun org-mark-ring-push (&optional pos buffer)
12987 "Put the current position or POS into the mark ring and rotate it."
12988 (interactive)
12989 (setq pos (or pos (point)))
12990 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12991 (move-marker (car org-mark-ring)
12992 (or pos (point))
12993 (or buffer (current-buffer)))
12994 (message "%s"
12995 (substitute-command-keys
12998 (defun org-mark-ring-goto (&optional n)
12999 "Jump to the previous position in the mark ring.
13000 With prefix arg N, jump back that many stored positions. When
13001 called several times in succession, walk through the entire ring.
13002 Org-mode commands jumping to a different position in the current file,
13003 or to another Org-mode file, automatically push the old position
13004 onto the ring."
13005 (interactive "p")
13006 (let (p m)
13007 (if (eq last-command this-command)
13008 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
13009 (setq p org-mark-ring))
13010 (setq org-mark-ring-last-goto p)
13011 (setq m (car p))
13012 (switch-to-buffer (marker-buffer m))
13013 (goto-char m)
13014 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13016 (defun org-remove-angle-brackets (s)
13017 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13018 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13019 s)
13020 (defun org-add-angle-brackets (s)
13021 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13022 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13023 s)
13025 ;;; Following specific links
13027 (defun org-follow-timestamp-link ()
13028 (cond
13029 ((org-at-date-range-p t)
13030 (let ((org-agenda-start-on-weekday)
13031 (t1 (match-string 1))
13032 (t2 (match-string 2)))
13033 (setq t1 (time-to-days (org-time-string-to-time t1))
13034 t2 (time-to-days (org-time-string-to-time t2)))
13035 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13036 ((org-at-timestamp-p t)
13037 (org-agenda-list nil (time-to-days (org-time-string-to-time
13038 (substring (match-string 1) 0 10)))
13039 1))
13040 (t (error "This should not happen"))))
13043 (defun org-follow-bbdb-link (name)
13044 "Follow a BBDB link to NAME."
13045 (require 'bbdb)
13046 (let ((inhibit-redisplay (not debug-on-error))
13047 (bbdb-electric-p nil))
13048 (catch 'exit
13049 ;; Exact match on name
13051 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13052 ;; Exact match on name
13054 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13055 ;; Partial match on name
13056 (bbdb-name name nil)
13057 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13058 ;; Partial match on company
13059 (bbdb-company name nil)
13060 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13061 ;; General match including network address and notes
13062 (bbdb name nil)
13063 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13064 (delete-window (get-buffer-window "*BBDB*"))
13065 (error "No matching BBDB record")))))
13067 (defun org-follow-info-link (name)
13068 "Follow an info file & node link to NAME."
13071 (progn
13072 (require 'info)
13073 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13074 (Info-find-node (match-string 1 name) (match-string 2 name))
13075 (Info-find-node (match-string 1 name) "Top")))
13076 (message "Could not open: %s" name)))
13078 (defun org-follow-gnus-link (&optional group article)
13079 "Follow a Gnus link to GROUP and ARTICLE."
13080 (require 'gnus)
13081 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13082 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13083 (cond ((and group article)
13084 (gnus-group-read-group 1 nil group)
13085 (gnus-summary-goto-article (string-to-number article) nil t))
13086 (group (gnus-group-jump-to-group group))))
13088 (defun org-follow-vm-link (&optional folder article readonly)
13089 "Follow a VM link to FOLDER and ARTICLE."
13090 (require 'vm)
13091 (setq article (org-add-angle-brackets article))
13093 ;; ange-ftp or efs or tramp access
13094 (let ((user (or (match-string 1 folder) (user-login-name)))
13095 (host (match-string 2 folder))
13096 (file (match-string 3 folder)))
13097 (cond
13098 ((featurep 'tramp)
13099 ;; use tramp to access the file
13100 (if (featurep 'xemacs)
13101 (setq folder (format "[%s@%s]%s" user host file))
13102 (setq folder (format "/%s@%s:%s" user host file))))
13103 (t
13104 ;; use ange-ftp or efs
13105 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13106 (setq folder (format "/%s@%s:%s" user host file))))))
13107 (when folder
13108 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13109 (sit-for 0.1)
13110 (when article
13111 (vm-select-folder-buffer)
13112 (widen)
13113 (let ((case-fold-search t))
13114 (goto-char (point-min))
13115 (if (not (re-search-forward
13116 (concat "^" "message-id: *" (regexp-quote article))))
13117 (error "Could not find the specified message in this folder"))
13118 (vm-isearch-update)
13119 (vm-isearch-narrow)
13120 (vm-beginning-of-message)
13121 (vm-summarize)))))
13123 (defun org-follow-wl-link (folder article)
13124 "Follow a Wanderlust link to FOLDER and ARTICLE."
13125 (if (and (string= folder "%")
13126 article
13128 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13129 ;; Thus, we recompose folder and article ids.
13130 (setq folder (format "%s#%s" folder (match-string 1 article))
13131 article (match-string 3 article)))
13132 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13133 (error "No such folder: %s" folder))
13134 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13135 (and article
13136 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13137 (wl-summary-redisplay)))
13139 (defun org-follow-rmail-link (folder article)
13140 "Follow an RMAIL link to FOLDER and ARTICLE."
13141 (setq article (org-add-angle-brackets article))
13142 (let (message-number)
13143 (save-excursion
13144 (save-window-excursion
13145 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13146 (setq message-number
13147 (save-restriction
13148 (widen)
13149 (goto-char (point-max))
13150 (if (re-search-backward
13152 (or article "")))
13153 nil t)
13154 (rmail-what-message))))))
13155 (if message-number
13156 (progn
13157 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13158 (rmail-show-message message-number)
13159 message-number)
13160 (error "Message not found"))))
13162 ;;; mh-e integration based on planner-mode
13163 (defun org-mhe-get-message-real-folder ()
13164 "Return the name of the current message real folder, so if you use
13165 sequences, it will now work."
13166 (save-excursion
13167 (let* ((folder
13168 (if (equal major-mode 'mh-folder-mode)
13169 mh-current-folder
13170 ;; Refer to the show buffer
13171 mh-show-folder-buffer))
13172 (end-index
13173 (if (boundp 'mh-index-folder)
13174 (min (length mh-index-folder) (length folder))))
13175 )
13176 ;; a simple test on mh-index-data does not work, because
13177 ;; mh-index-data is always nil in a show buffer.
13178 (if (and (boundp 'mh-index-folder)
13179 (string= mh-index-folder (substring folder 0 end-index)))
13180 (if (equal major-mode 'mh-show-mode)
13181 (save-window-excursion
13182 (let (pop-up-frames)
13183 (when (buffer-live-p (get-buffer folder))
13184 (progn
13185 (pop-to-buffer folder)
13186 (org-mhe-get-message-folder-from-index)
13187 )
13188 )))
13189 (org-mhe-get-message-folder-from-index)
13190 )
13191 folder
13192 )
13193 )))
13195 (defun org-mhe-get-message-folder-from-index ()
13196 "Returns the name of the message folder in a index folder buffer."
13197 (save-excursion
13198 (mh-index-previous-folder)
13200 (message "%s" (match-string 1))))
13202 (defun org-mhe-get-message-folder ()
13203 "Return the name of the current message folder. Be careful if you
13204 use sequences."
13205 (save-excursion
13206 (if (equal major-mode 'mh-folder-mode)
13207 mh-current-folder
13208 ;; Refer to the show buffer
13209 mh-show-folder-buffer)))
13211 (defun org-mhe-get-message-num ()
13212 "Return the number of the current message. Be careful if you
13213 use sequences."
13214 (save-excursion
13215 (if (equal major-mode 'mh-folder-mode)
13216 (mh-get-msg-num nil)
13217 ;; Refer to the show buffer
13218 (mh-show-buffer-message-number))))
13220 (defun org-mhe-get-header (header)
13221 "Return a header of the message in folder mode. This will create a
13222 show buffer for the corresponding message. If you have a more clever
13223 idea..."
13224 (let* ((folder (org-mhe-get-message-folder))
13225 (num (org-mhe-get-message-num))
13226 (buffer (get-buffer-create (concat "show-" folder)))
13227 (header-field))
13228 (with-current-buffer buffer
13229 (mh-display-msg num folder)
13230 (if (equal major-mode 'mh-folder-mode)
13231 (mh-header-display)
13232 (mh-show-header-display))
13233 (set-buffer buffer)
13234 (setq header-field (mh-get-header-field header))
13235 (if (equal major-mode 'mh-folder-mode)
13236 (mh-show)
13237 (mh-show-show))
13238 header-field)))
13240 (defun org-follow-mhe-link (folder article)
13241 "Follow an MHE link to FOLDER and ARTICLE.
13242 If ARTICLE is nil FOLDER is shown. If the configuration variable
13243 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13244 ARTICLE is searched in all folders. Indexed searches (swish++,
13245 namazu, and others supported by MH-E) will always search in all
13246 folders."
13247 (require 'mh-e)
13248 (require 'mh-search)
13249 (require 'mh-utils)
13250 (mh-find-path)
13251 (if (not article)
13252 (mh-visit-folder (mh-normalize-folder-name folder))
13253 (setq article (org-add-angle-brackets article))
13254 (mh-search-choose)
13255 (if (equal mh-searcher 'pick)
13256 (progn
13257 (mh-search folder (list "--message-id" article))
13258 (when (and org-mhe-search-all-folders
13259 (not (org-mhe-get-message-real-folder)))
13260 (kill-this-buffer)
13261 (mh-search "+" (list "--message-id" article))))
13262 (mh-search "+" article))
13263 (if (org-mhe-get-message-real-folder)
13264 (mh-show-msg 1)
13265 (kill-this-buffer)
13266 (error "Message not found"))))
13268 ;;; BibTeX links
13270 ;; Use the custom search meachnism to construct and use search strings for
13271 ;; file links to BibTeX database entries.
13273 (defun org-create-file-search-in-bibtex ()
13274 "Create the search string and description for a BibTeX database entry."
13275 (when (eq major-mode 'bibtex-mode)
13276 ;; yes, we want to construct this search string.
13277 ;; Make a good description for this entry, using names, year and the title
13278 ;; Put it into the `description' variable which is dynamically scoped.
13279 (let ((bibtex-autokey-names 1)
13280 (bibtex-autokey-names-stretch 1)
13281 (bibtex-autokey-name-case-convert-function 'identity)
13282 (bibtex-autokey-name-separator " & ")
13283 (bibtex-autokey-additional-names " et al.")
13284 (bibtex-autokey-year-length 4)
13285 (bibtex-autokey-name-year-separator " ")
13286 (bibtex-autokey-titlewords 3)
13287 (bibtex-autokey-titleword-separator " ")
13288 (bibtex-autokey-titleword-case-convert-function 'identity)
13289 (bibtex-autokey-titleword-length 'infty)
13290 (bibtex-autokey-year-title-separator ": "))
13291 (setq description (bibtex-generate-autokey)))
13292 ;; Now parse the entry, get the key and return it.
13293 (save-excursion
13294 (bibtex-beginning-of-entry)
13295 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13297 (defun org-execute-file-search-in-bibtex (s)
13298 "Find the link search string S as a key for a database entry."
13299 (when (eq major-mode 'bibtex-mode)
13300 ;; Yes, we want to do the search in this file.
13301 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13302 (goto-char (point-min))
13305 (goto-char (match-beginning 0)))
13306 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13307 ;; Use double prefix to indicate that any web link should be browsed
13308 (let ((b (current-buffer)) (p (point)))
13309 ;; Restore the window configuration because we just use the web link
13310 (set-window-configuration org-window-config-before-follow-link)
13311 (save-excursion (set-buffer b) (goto-char p)
13312 (bibtex-url)))
13313 (recenter 0)) ; Move entry start to beginning of window
13314 ;; return t to indicate that the search is done.
13315 t))
13317 ;; Finally add the functions to the right hooks.
13318 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13319 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13321 ;; end of Bibtex link setup
13323 ;;; Following file links
13325 (defun org-open-file (path &optional in-emacs line search)
13326 "Open the file at PATH.
13327 First, this expands any special file name abbreviations. Then the
13328 configuration variable `org-file-apps' is checked if it contains an
13329 entry for this file type, and if yes, the corresponding command is launched.
13330 If no application is found, Emacs simply visits the file.
13331 With optional argument IN-EMACS, Emacs will visit the file.
13332 Optional LINE specifies a line to go to, optional SEARCH a string to
13333 search for. If LINE or SEARCH is given, the file will always be
13334 opened in Emacs.
13335 If the file does not exist, an error is thrown."
13336 (setq in-emacs (or in-emacs line search))
13337 (let* ((file (if (equal path "")
13338 buffer-file-name
13339 (substitute-in-file-name (expand-file-name path))))
13340 (apps (append org-file-apps (org-default-apps)))
13341 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13342 (dirp (if remp nil (file-directory-p file)))
13343 (dfile (downcase file))
13344 (old-buffer (current-buffer))
13345 (old-pos (point))
13346 (old-mode major-mode)
13347 ext cmd)
13349 (setq ext (match-string 1 dfile))
13351 (setq ext (match-string 1 dfile))))
13352 (if in-emacs
13353 (setq cmd 'emacs)
13354 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13355 (and dirp (cdr (assoc 'directory apps)))
13356 (cdr (assoc ext apps))
13357 (cdr (assoc t apps)))))
13358 (when (eq cmd 'mailcap)
13359 (require 'mailcap)
13360 (mailcap-parse-mailcaps)
13361 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13362 (command (mailcap-mime-info mime-type)))
13363 (if (stringp command)
13364 (setq cmd command)
13365 (setq cmd 'emacs))))
13366 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13367 (not (file-exists-p file))
13368 (not org-open-non-existing-files))
13369 (error "No such file: %s" file))
13370 (cond
13372 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13374 (setq cmd (replace-match "%s" t t cmd)))
13375 (while (string-match "%s" cmd)
13376 (setq cmd (replace-match
13377 (save-match-data (shell-quote-argument file))
13378 t t cmd)))
13379 (save-window-excursion
13380 (start-process-shell-command cmd nil cmd)))
13381 ((or (stringp cmd)
13382 (eq cmd 'emacs))
13383 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13384 (widen)
13385 (if line (goto-line line)
13386 (if search (org-link-search search))))
13387 ((consp cmd)
13388 (eval cmd))
13389 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13390 (and (org-mode-p) (eq old-mode 'org-mode)
13391 (or (not (equal old-buffer (current-buffer)))
13392 (not (equal old-pos (point))))
13393 (org-mark-ring-push old-pos old-buffer))))
13395 (defun org-default-apps ()
13396 "Return the default applications for this operating system."
13397 (cond
13398 ((eq system-type 'darwin)
13399 org-file-apps-defaults-macosx)
13400 ((eq system-type 'windows-nt)
13401 org-file-apps-defaults-windowsnt)
13402 (t org-file-apps-defaults-gnu)))
13404 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13405 (defun org-file-remote-p (file)
13406 "Test whether FILE specifies a location on a remote system.
13407 Return non-nil if the location is indeed remote.
13411 (cond ((fboundp 'file-remote-p)
13412 (file-remote-p file))
13413 ((fboundp 'tramp-handle-file-remote-p)
13414 (tramp-handle-file-remote-p file))
13415 ((and (boundp 'ange-ftp-name-format)
13416 (string-match (car ange-ftp-name-format) file))
13417 t)
13418 (t nil)))
13421 ;;;; Hooks for remember.el, and refiling
13423 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13424 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13426 ;;;###autoload
13427 (defun org-remember-insinuate ()
13428 "Setup remember.el for use wiht Org-mode."
13429 (require 'remember)
13430 (setq remember-annotation-functions '(org-remember-annotation))
13431 (setq remember-handler-functions '(org-remember-handler))
13432 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13434 ;;;###autoload
13435 (defun org-remember-annotation ()
13436 "Return a link to the current location as an annotation for remember.el.
13437 If you are using Org-mode files as target for data storage with
13438 remember.el, then the annotations should include a link compatible with the
13439 conventions in Org-mode. This function returns such a link."
13440 (org-store-link nil))
13442 (defconst org-remember-help
13443 "Select a destination location for the note.
13444 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13445 RET on headline -> Store as sublevel entry to current headline
13446 RET at beg-of-buf -> Append to file as level 2 headline
13447 <left>/<right> -> before/after current headline, same headings level")
13449 (defvar org-remember-previous-location nil)
13450 (defvar org-force-remember-template-char) ;; dynamically scoped
13452 (defun org-select-remember-template (&optional use-char)
13453 (when org-remember-templates
13454 (let* ((templates (mapcar (lambda (x)
13455 (if (stringp (car x))
13456 (append (list (nth 1 x) (car x)) (cddr x))
13457 (append (list (car x) "") (cdr x))))
13458 org-remember-templates))
13459 (char (or use-char
13460 (cond
13461 ((= (length templates) 1)
13462 (caar templates))
13463 ((and (boundp 'org-force-remember-template-char)
13464 org-force-remember-template-char)
13465 (if (stringp org-force-remember-template-char)
13466 (string-to-char org-force-remember-template-char)
13467 org-force-remember-template-char))
13468 (t
13469 (message "Select template: %s"
13470 (mapconcat
13471 (lambda (x)
13472 (cond
13474 (format "[%c]" (car x)))
13475 ((equal (downcase (car x))
13476 (downcase (aref (nth 1 x) 0)))
13477 (format "[%c]%s" (car x)
13478 (substring (nth 1 x) 1)))
13479 (t (format "[%c]%s" (car x) (nth 1 x)))))
13480 templates " "))
13481 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13482 (when (equal char0 ?\C-g)
13483 (jump-to-register remember-register)
13484 (kill-buffer remember-buffer))
13485 char0))))))
13486 (cddr (assoc char templates)))))
13488 (defvar x-last-selected-text)
13489 (defvar x-last-selected-text-primary)
13491 ;;;###autoload
13492 (defun org-remember-apply-template (&optional use-char skip-interactive)
13493 "Initialize *remember* buffer with template, invoke `org-mode'.
13494 This function should be placed into `remember-mode-hook' and in fact requires
13495 to be run from that hook to function properly."
13496 (if org-remember-templates
13497 (let* ((entry (org-select-remember-template use-char))
13498 (tpl (car entry))
13499 (plist-p (if org-store-link-plist t nil))
13500 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13502 (nth 1 entry)
13503 org-default-notes-file))
13504 (headline (nth 2 entry))
13505 (v-c (or (and (eq window-system 'x)
13506 (fboundp 'x-cut-buffer-or-selection-value)
13507 (x-cut-buffer-or-selection-value))
13508 (org-bound-and-true-p x-last-selected-text)
13509 (org-bound-and-true-p x-last-selected-text-primary)
13510 (and (> (length kill-ring) 0) (current-kill 0))))
13511 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13512 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13513 (v-u (concat "[" (substring v-t 1 -1) "]"))
13514 (v-U (concat "[" (substring v-T 1 -1) "]"))
13515 ;; `initial' and `annotation' are bound in `remember'
13516 (v-i (if (boundp 'initial) initial))
13517 (v-a (if (and (boundp 'annotation) annotation)
13518 (if (equal annotation "[[]]") "" annotation)
13519 ""))
13520 (v-A (if (and v-a
13523 v-a))
13524 (v-n user-full-name)
13525 (org-startup-folded nil)
13526 org-time-was-given org-end-time-was-given x
13527 prompt completions char time pos default histvar)
13528 (setq org-store-link-plist
13529 (append (list :annotation v-a :initial v-i)
13530 org-store-link-plist))
13531 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13532 (erase-buffer)
13533 (insert (substitute-command-keys
13534 (format
13535 "## Filing location: Select interactively, default, or last used:
13536 ## %s to select file and header location interactively.
13540 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13541 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13542 (abbreviate-file-name (or file org-default-notes-file))
13543 (or headline "")
13544 (or (car org-remember-previous-location) "???")
13545 (or (cdr org-remember-previous-location) "???"))))
13546 (insert tpl) (goto-char (point-min))
13547 ;; Simple %-escapes
13549 (when (and initial (equal (match-string 0) "%i"))
13550 (save-match-data
13551 (let* ((lead (buffer-substring
13552 (point-at-bol) (match-beginning 0))))
13553 (setq v-i (mapconcat 'identity
13556 (replace-match
13557 (or (eval (intern (concat "v-" (match-string 1)))) "")
13558 t t))
13560 ;; %[] Insert contents of a file.
13561 (goto-char (point-min))
13563 (let ((start (match-beginning 0))
13564 (end (match-end 0))
13565 (filename (expand-file-name (match-string 1))))
13566 (goto-char start)
13567 (delete-region start end)
13568 (condition-case error
13569 (insert-file-contents filename)
13570 (error (insert (format "%%![Couldn't insert %s: %s]"
13571 filename error))))))
13572 ;; %() embedded elisp
13573 (goto-char (point-min))
13575 (goto-char (match-beginning 0))
13576 (let ((template-start (point)))
13577 (forward-char 1)
13578 (let ((result
13579 (condition-case error
13580 (eval (read (current-buffer)))
13581 (error (format "%%![Error: %s]" error)))))
13582 (delete-region template-start (point))
13583 (insert result))))
13585 ;; From the property list
13586 (when plist-p
13587 (goto-char (point-min))
13589 (and (setq x (or (plist-get org-store-link-plist
13590 (intern (match-string 1))) ""))
13591 (replace-match x t t))))
13593 ;; Turn on org-mode in the remember buffer, set local variables
13594 (org-mode)
13595 (org-set-local 'org-finish-function 'org-remember-finalize)
13597 (org-set-local 'org-default-notes-file file))
13599 (org-set-local 'org-remember-default-headline headline))
13600 ;; Interactive template entries
13601 (goto-char (point-min))
13603 (setq char (if (match-end 3) (match-string 3))
13604 prompt (if (match-end 2) (match-string 2)))
13605 (goto-char (match-beginning 0))
13606 (replace-match "")
13607 (setq completions nil default nil)
13608 (when prompt
13609 (setq completions (org-split-string prompt "|")
13610 prompt (pop completions)
13611 default (car completions)
13612 histvar (intern (concat
13613 "org-remember-template-prompt-history::"
13614 (or prompt "")))
13615 completions (mapcar 'list completions)))
13616 (cond
13617 ((member char '("G" "g"))
13618 (let* ((org-last-tags-completion-table
13619 (org-global-tags-completion-table
13620 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13621 (org-add-colon-after-tag-completion t)
13622 (ins (completing-read
13623 (if prompt (concat prompt ": ") "Tags: ")
13624 'org-tags-completion-function nil nil nil
13625 'org-tags-history)))
13626 (setq ins (mapconcat 'identity
13627 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13628 ":"))
13630 (or (equal (char-before) ?:) (insert ":"))
13631 (insert ins)
13632 (or (equal (char-after) ?:) (insert ":")))))
13633 (char
13634 (setq org-time-was-given (equal (upcase char) char))
13635 (setq time (org-read-date (equal (upcase char) "U") t nil
13636 prompt))
13637 (org-insert-time-stamp time org-time-was-given
13638 (member char '("u" "U"))
13639 nil nil (list org-end-time-was-given)))
13640 (t
13641 (insert (org-completing-read
13642 (concat (if prompt prompt "Enter string")
13643 (if default (concat " [" default "]"))
13644 ": ")
13645 completions nil nil nil histvar default)))))
13646 (goto-char (point-min))
13648 (replace-match "")
13650 (org-mode)
13651 (org-set-local 'org-finish-function 'org-remember-finalize))
13652 (when (save-excursion
13653 (goto-char (point-min))
13654 (re-search-forward "%!" nil t))
13655 (replace-match "")
13656 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13658 (defun org-remember-finish-immediately ()
13659 "File remember note immediately.
13660 This should be run in `post-command-hook' and will remove itself
13661 from that hook."
13662 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13663 (when org-finish-function
13664 (funcall org-finish-function)))
13666 (defvar org-clock-marker) ; Defined below
13667 (defun org-remember-finalize ()
13668 "Finalize the remember process."
13669 (unless (fboundp 'remember-finalize)
13670 (defalias 'remember-finalize 'remember-buffer))
13671 (when (and org-clock-marker
13672 (equal (marker-buffer org-clock-marker) (current-buffer)))
13673 ;; FIXME: test this, this is w/o notetaking!
13674 (let (org-log-note-clock-out) (org-clock-out)))
13675 (when buffer-file-name
13676 (save-buffer)
13677 (setq buffer-file-name nil))
13678 (remember-finalize))
13680 ;;;###autoload
13681 (defun org-remember (&optional goto org-force-remember-template-char)
13682 "Call `remember'. If this is already a remember buffer, re-apply template.
13683 If there is an active region, make sure remember uses it as initial content
13684 of the remember buffer.
13686 When called interactively with a `C-u' prefix argument GOTO, don't remember
13687 anything, just go to the file/headline where the selected template usually
13688 stores its notes. With a double prefix arg `C-u C-u', go to the last
13689 note stored by remember.
13691 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13692 associated with a template in `org-remember-templates'."
13693 (interactive "P")
13694 (cond
13695 ((equal goto '(4)) (org-go-to-remember-target))
13696 ((equal goto '(16)) (org-remember-goto-last-stored))
13697 (t
13698 (if (memq org-finish-function '(remember-buffer remember-finalize))
13699 (progn
13700 (when (< (length org-remember-templates) 2)
13701 (error "No other template available"))
13702 (erase-buffer)
13703 (let ((annotation (plist-get org-store-link-plist :annotation))
13704 (initial (plist-get org-store-link-plist :initial)))
13705 (org-remember-apply-template))
13706 (message "Press C-c C-c to remember data"))
13707 (if (org-region-active-p)
13708 (remember (buffer-substring (point) (mark)))
13709 (call-interactively 'remember))))))
13711 (defun org-remember-goto-last-stored ()
13712 "Go to the location where the last remember note was stored."
13713 (interactive)
13714 (bookmark-jump "org-remember-last-stored")
13715 (message "This is the last note stored by remember"))
13717 (defun org-go-to-remember-target (&optional template-key)
13718 "Go to the target location of a remember template.
13719 The user is queried for the template."
13720 (interactive)
13721 (let* ((entry (org-select-remember-template template-key))
13722 (file (nth 1 entry))
13723 (heading (nth 2 entry))
13724 visiting)
13726 (setq file org-default-notes-file))
13728 (setq heading org-remember-default-headline))
13729 (setq visiting (org-find-base-buffer-visiting file))
13730 (if (not visiting) (find-file-noselect file))
13731 (switch-to-buffer (or visiting (get-file-buffer file)))
13732 (widen)
13733 (goto-char (point-min))
13734 (if (re-search-forward
13737 nil t)
13738 (goto-char (match-beginning 0))
13739 (error "Target headline not found: %s" heading))))
13741 (defvar org-note-abort nil) ; dynamically scoped
13743 ;;;###autoload
13744 (defun org-remember-handler ()
13745 "Store stuff from remember.el into an org file.
13746 First prompts for an org file. If the user just presses return, the value
13747 of `org-default-notes-file' is used.
13748 Then the command offers the headings tree of the selected file in order to
13749 file the text at a specific location.
13750 You can either immediately press RET to get the note appended to the
13751 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13752 find a better place. Then press RET or <left> or <right> in insert the note.
13754 Key Cursor position Note gets inserted
13755 -----------------------------------------------------------------------------
13756 RET buffer-start as level 1 heading at end of file
13757 RET on headline as sublevel of the heading at cursor
13758 RET no heading at cursor position, level taken from context.
13759 Or use prefix arg to specify level manually.
13760 <left> on headline as same level, before current heading
13761 <right> on headline as same level, after current heading
13763 So the fastest way to store the note is to press RET RET to append it to
13764 the default file. This way your current train of thought is not
13765 interrupted, in accordance with the principles of remember.el.
13766 You can also get the fast execution without prompting by using
13767 C-u C-c C-c to exit the remember buffer. See also the variable
13768 `org-remember-store-without-prompt'.
13770 Before being stored away, the function ensures that the text has a
13772 is constructed from the current date and some additional data.
13774 If the variable `org-adapt-indentation' is non-nil, the entire text is
13775 also indented so that it starts in the same column as the headline
13776 \(i.e. after the stars).
13778 See also the variable `org-reverse-note-order'."
13779 (goto-char (point-min))
13781 (replace-match ""))
13782 (goto-char (point-max))
13783 (beginning-of-line 1)
13785 (delete-region (1- (point)) (point-max))
13786 (beginning-of-line 1))
13787 (catch 'quit
13788 (if org-note-abort (throw 'quit nil))
13789 (let* ((txt (buffer-substring (point-min) (point-max)))
13790 (fastp (org-xor (equal current-prefix-arg '(4))
13791 org-remember-store-without-prompt))
13792 (file (cond
13793 (fastp org-default-notes-file)
13794 ((and (eq org-remember-interactive-interface 'refile)
13795 org-refile-targets)
13796 org-default-notes-file)
13797 ((not (and (equal current-prefix-arg '(16))
13798 org-remember-previous-location))
13799 (org-get-org-file))))
13800 (heading org-remember-default-headline)
13801 (visiting (and file (org-find-base-buffer-visiting file)))
13802 (org-startup-folded nil)
13803 (org-startup-align-all-tables nil)
13804 (org-goto-start-pos 1)
13805 spos exitcmd level indent reversed)
13806 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13807 (setq file (car org-remember-previous-location)
13808 heading (cdr org-remember-previous-location)
13809 fastp t))
13810 (setq current-prefix-arg nil)
13812 (setq txt (replace-match "" t t txt)))
13813 ;; Modify text so that it becomes a nice subtree which can be inserted
13814 ;; into an org tree.
13816 first)
13817 (setq first (car lines) lines (cdr lines))
13819 ;; Is already a headline
13820 (setq indent nil)
13821 ;; We need to add a headline: Use time and first buffer line
13822 (setq lines (cons first lines)
13823 first (concat "* " (current-time-string)
13824 " (" (remember-buffer-desc) ")")
13825 indent " "))
13826 (if (and org-adapt-indentation indent)
13827 (setq lines (mapcar
13828 (lambda (x)
13830 (concat indent x) x))
13831 lines)))
13838 ;; Put the modified text back into the remember buffer, for refile.
13839 (erase-buffer)
13840 (insert txt)
13841 (goto-char (point-min))
13842 (when (and (eq org-remember-interactive-interface 'refile)
13843 (not fastp))
13844 (org-refile nil (or visiting (find-file-noselect file)))
13845 (throw 'quit t))
13846 ;; Find the file
13847 (if (not visiting) (find-file-noselect file))
13848 (with-current-buffer (or visiting (get-file-buffer file))
13849 (unless (org-mode-p)
13850 (error "Target files for remember notes must be in Org-mode"))
13851 (save-excursion
13852 (save-restriction
13853 (widen)
13854 (and (goto-char (point-min))
13857 (setq reversed (org-notes-order-reversed-p))
13859 ;; Find the default location
13861 (goto-char (point-min))
13862 (if (re-search-forward
13865 nil t)
13866 (setq org-goto-start-pos (match-beginning 0))
13867 (when fastp
13868 (goto-char (point-max))
13869 (unless (bolp) (newline))
13871 (setq org-goto-start-pos (point-at-bol 0)))))
13873 ;; Ask the User for a location, using the appropriate interface
13874 (cond
13875 (fastp (setq spos org-goto-start-pos
13876 exitcmd 'return))
13877 ((eq org-remember-interactive-interface 'outline)
13878 (setq spos (org-get-location (current-buffer)
13879 org-remember-help)
13880 exitcmd (cdr spos)
13881 spos (car spos)))
13882 ((eq org-remember-interactive-interface 'outline-path-completion)
13883 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13884 (org-refile-use-outline-path t))
13885 (setq spos (org-refile-get-location "Heading: ")
13886 exitcmd 'return
13887 spos (nth 3 spos))))
13888 (t (error "this should not hapen")))
13889 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13890 ; not handle this note
13891 (goto-char spos)
13892 (cond ((org-on-heading-p t)
13893 (org-back-to-heading t)
13894 (setq level (funcall outline-level))
13895 (cond
13896 ((eq exitcmd 'return)
13897 ;; sublevel of current
13898 (setq org-remember-previous-location
13899 (cons (abbreviate-file-name file)
13900 (org-get-heading 'notags)))
13901 (if reversed
13902 (outline-next-heading)
13903 (org-end-of-subtree t)
13904 (if (not (bolp))
13906 (beginning-of-line 2)
13907 (end-of-line 1)
13909 (bookmark-set "org-remember-last-stored")
13910 (org-paste-subtree (org-get-legal-level level 1) txt))
13911 ((eq exitcmd 'left)
13912 ;; before current
13913 (bookmark-set "org-remember-last-stored")
13914 (org-paste-subtree level txt))
13915 ((eq exitcmd 'right)
13916 ;; after current
13917 (org-end-of-subtree t)
13918 (bookmark-set "org-remember-last-stored")
13919 (org-paste-subtree level txt))
13920 (t (error "This should not happen"))))
13922 ((and (bobp) (not reversed))
13923 ;; Put it at the end, one level below level 1
13924 (save-restriction
13925 (widen)
13926 (goto-char (point-max))
13927 (if (not (bolp)) (newline))
13928 (bookmark-set "org-remember-last-stored")
13929 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13931 ((and (bobp) reversed)
13932 ;; Put it at the start, as level 1
13933 (save-restriction
13934 (widen)
13935 (goto-char (point-min))
13937 (beginning-of-line 1)
13938 (bookmark-set "org-remember-last-stored")
13939 (org-paste-subtree 1 txt)))
13940 (t
13941 ;; Put it right there, with automatic level determined by
13942 ;; org-paste-subtree or from prefix arg
13943 (bookmark-set "org-remember-last-stored")
13944 (org-paste-subtree
13945 (if (numberp current-prefix-arg) current-prefix-arg)
13946 txt)))
13947 (when remember-save-after-remembering
13948 (save-buffer)
13949 (if (not visiting) (kill-buffer (current-buffer)))))))))
13951 t) ;; return t to indicate that we took care of this note.
13953 (defun org-get-org-file ()
13954 "Read a filename, with default directory `org-directory'."
13955 (let ((default (or org-default-notes-file remember-data-file)))
13956 (read-file-name (format "File name [%s]: " default)
13957 (file-name-as-directory org-directory)
13958 default)))
13960 (defun org-notes-order-reversed-p ()
13961 "Check if the current file should receive notes in reversed order."
13962 (cond
13963 ((not org-reverse-note-order) nil)
13964 ((eq t org-reverse-note-order) t)
13965 ((not (listp org-reverse-note-order)) nil)
13966 (t (catch 'exit
13967 (let ((all org-reverse-note-order)
13968 entry)
13969 (while (setq entry (pop all))
13970 (if (string-match (car entry) buffer-file-name)
13971 (throw 'exit (cdr entry))))
13972 nil)))))
13974 ;;; Refiling
13976 (defvar org-refile-target-table nil
13977 "The list of refile targets, created by `org-refile'.")
13979 (defvar org-agenda-new-buffers nil
13980 "Buffers created to visit agenda files.")
13982 (defun org-get-refile-targets (&optional default-buffer)
13983 "Produce a table with refile targets."
13984 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13985 targets txt re files f desc descre)
13986 (with-current-buffer (or default-buffer (current-buffer))
13987 (while (setq entry (pop entries))
13988 (setq files (car entry) desc (cdr entry))
13989 (cond
13990 ((null files) (setq files (list (current-buffer))))
13991 ((eq files 'org-agenda-files)
13992 (setq files (org-agenda-files 'unrestricted)))
13993 ((and (symbolp files) (fboundp files))
13994 (setq files (funcall files)))
13995 ((and (symbolp files) (boundp files))
13996 (setq files (symbol-value files))))
13997 (if (stringp files) (setq files (list files)))
13998 (cond
13999 ((eq (car desc) :tag)
14001 ((eq (car desc) :todo)
14003 ((eq (car desc) :regexp)
14004 (setq descre (cdr desc)))
14005 ((eq (car desc) :level)
14007 (if org-odd-levels-only
14008 (1- (* 2 (cdr desc)))
14009 (cdr desc)))
14011 ((eq (car desc) :maxlevel)
14013 (if org-odd-levels-only
14014 (1- (* 2 (cdr desc)))
14015 (cdr desc)))
14017 (t (error "Bad refiling target description %s" desc)))
14018 (while (setq f (pop files))
14019 (save-excursion
14020 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14021 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14022 (save-excursion
14023 (save-restriction
14024 (widen)
14025 (goto-char (point-min))
14026 (while (re-search-forward descre nil t)
14027 (goto-char (point-at-bol))
14028 (when (looking-at org-complex-heading-regexp)
14029 (setq txt (match-string 4)
14030 re (concat "^" (regexp-quote
14031 (buffer-substring (match-beginning 1)
14032 (match-end 4)))))
14034 (regexp-quote
14035 (match-string 5)))))
14037 (when org-refile-use-outline-path
14038 (setq txt (mapconcat 'identity
14039 (append
14040 (if (eq org-refile-use-outline-path 'file)
14041 (list (file-name-nondirectory
14042 (buffer-file-name (buffer-base-buffer))))
14043 (if (eq org-refile-use-outline-path 'full-file-path)
14044 (list (buffer-file-name (buffer-base-buffer)))))
14045 (org-get-outline-path)
14046 (list txt))
14047 "/")))
14048 (push (list txt f re (point)) targets))
14049 (goto-char (point-at-eol))))))))
14050 (nreverse targets))))
14052 (defun org-get-outline-path ()
14053 "Return the outline path to the current entry, as a list."
14054 (let (rtn)
14055 (save-excursion
14056 (while (org-up-heading-safe)
14057 (when (looking-at org-complex-heading-regexp)
14058 (push (org-match-string-no-properties 4) rtn)))
14059 rtn)))
14061 (defvar org-refile-history nil
14062 "History for refiling operations.")
14064 (defun org-refile (&optional goto default-buffer)
14065 "Move the entry at point to another heading.
14066 The list of target headings is compiled using the information in
14067 `org-refile-targets', which see. This list is created upon first use, and
14068 you can update it by calling this command with a double prefix (`C-u C-u').
14069 FIXME: Can we find a better way of updating?
14071 At the target location, the entry is filed as a subitem of the target heading.
14072 Depending on `org-reverse-note-order', the new subitem will either be the
14073 first of the last subitem.
14075 With prefix arg GOTO, the command will only visit the target location,
14076 not actually move anything.
14077 With a double prefix `C-c C-c', go to the location where the last refiling
14078 operation has put the subtree.
14080 With a double prefix argument, the command can be used to jump to any
14081 heading in the current buffer."
14082 (interactive "P")
14083 (let* ((cbuf (current-buffer))
14084 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14085 pos it nbuf file re level reversed)
14086 (if (equal goto '(16))
14087 (org-refile-goto-last-stored)
14088 (when (setq it (org-refile-get-location
14089 (if goto "Goto: " "Refile to: ") default-buffer))
14090 (setq file (nth 1 it)
14091 re (nth 2 it)
14092 pos (nth 3 it))
14093 (setq nbuf (or (find-buffer-visiting file)
14094 (find-file-noselect file)))
14095 (if goto
14096 (progn
14097 (switch-to-buffer nbuf)
14098 (goto-char pos)
14099 (org-show-context 'org-goto))
14100 (org-copy-special)
14101 (save-excursion
14102 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14103 (find-file-noselect file))))
14104 (setq reversed (org-notes-order-reversed-p))
14105 (save-excursion
14106 (save-restriction
14107 (widen)
14108 (goto-char pos)
14109 (looking-at outline-regexp)
14110 (setq level (org-get-legal-level (funcall outline-level) 1))
14111 (goto-char
14112 (if reversed
14113 (outline-next-heading)
14114 (or (save-excursion (outline-get-next-sibling))
14115 (org-end-of-subtree t t)
14116 (point-max))))
14117 (bookmark-set "org-refile-last-stored")
14118 (org-paste-subtree level))))
14119 (org-cut-special)
14122 (defun org-refile-goto-last-stored ()
14123 "Go to the location where the last refile was stored."
14124 (interactive)
14125 (bookmark-jump "org-refile-last-stored")
14126 (message "This is the location of the last refile"))
14128 (defun org-refile-get-location (&optional prompt default-buffer)
14129 "Prompt the user for a refile location, using PROMPT."
14130 (let ((org-refile-targets org-refile-targets)
14131 (org-refile-use-outline-path org-refile-use-outline-path))
14132 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14133 (unless org-refile-target-table
14134 (error "No refile targets"))
14135 (let* ((cbuf (current-buffer))
14136 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14137 (fname (and filename (file-truename filename)))
14138 (tbl (mapcar
14139 (lambda (x)
14140 (if (not (equal fname (file-truename (nth 1 x))))
14141 (cons (concat (car x) " (" (file-name-nondirectory
14142 (nth 1 x)) ")")
14143 (cdr x))
14144 x))
14145 org-refile-target-table))
14146 (completion-ignore-case t))
14147 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14148 tbl)))
14150 ;;;; Dynamic blocks
14152 (defun org-find-dblock (name)
14153 "Find the first dynamic block with name NAME in the buffer.
14154 If not found, stay at current position and return nil."
14155 (let (pos)
14156 (save-excursion
14157 (goto-char (point-min))
14159 nil t)
14160 (match-beginning 0))))
14161 (if pos (goto-char pos))
14162 pos))
14164 (defconst org-dblock-start-re
14166 "Matches the startline of a dynamic block, with parameters.")
14169 "Matches the end of a dyhamic block.")
14171 (defun org-create-dblock (plist)
14172 "Create a dynamic block section, with parameters taken from PLIST.
14173 PLIST must containe a :name entry which is used as name of the block."
14174 (unless (bolp) (newline))
14175 (let ((name (plist-get plist :name)))
14176 (insert "#+BEGIN: " name)
14177 (while plist
14178 (if (eq (car plist) :name)
14179 (setq plist (cddr plist))
14180 (insert " " (prin1-to-string (pop plist)))))
14182 (beginning-of-line -2)))
14184 (defun org-prepare-dblock ()
14185 "Prepare dynamic block for refresh.
14186 This empties the block, puts the cursor at the insert position and returns
14187 the property list including an extra property :name with the block name."
14188 (unless (looking-at org-dblock-start-re)
14189 (error "Not at a dynamic block"))
14190 (let* ((begdel (1+ (match-end 0)))
14191 (name (org-no-properties (match-string 1)))
14192 (params (append (list :name name)
14193 (read (concat "(" (match-string 3) ")")))))
14194 (unless (re-search-forward org-dblock-end-re nil t)
14195 (error "Dynamic block not terminated"))
14196 (delete-region begdel (match-beginning 0))
14197 (goto-char begdel)
14198 (open-line 1)
14199 params))
14201 (defun org-map-dblocks (&optional command)
14202 "Apply COMMAND to all dynamic blocks in the current buffer.
14203 If COMMAND is not given, use `org-update-dblock'."
14204 (let ((cmd (or command 'org-update-dblock))
14205 pos)
14206 (save-excursion
14207 (goto-char (point-min))
14208 (while (re-search-forward org-dblock-start-re nil t)
14209 (goto-char (setq pos (match-beginning 0)))
14210 (condition-case nil
14211 (funcall cmd)
14212 (error (message "Error during update of dynamic block")))
14213 (goto-char pos)
14214 (unless (re-search-forward org-dblock-end-re nil t)
14215 (error "Dynamic block not terminated"))))))
14217 (defun org-dblock-update (&optional arg)
14218 "User command for updating dynamic blocks.
14219 Update the dynamic block at point. With prefix ARG, update all dynamic
14220 blocks in the buffer."
14221 (interactive "P")
14222 (if arg
14223 (org-update-all-dblocks)
14224 (or (looking-at org-dblock-start-re)
14225 (org-beginning-of-dblock))
14226 (org-update-dblock)))
14228 (defun org-update-dblock ()
14229 "Update the dynamic block at point
14230 This means to empty the block, parse for parameters and then call
14231 the correct writing function."
14232 (save-window-excursion
14233 (let* ((pos (point))
14234 (line (org-current-line))
14235 (params (org-prepare-dblock))
14236 (name (plist-get params :name))
14237 (cmd (intern (concat "org-dblock-write:" name))))
14238 (message "Updating dynamic block `%s' at line %d..." name line)
14239 (funcall cmd params)
14240 (message "Updating dynamic block `%s' at line %d...done" name line)
14241 (goto-char pos))))
14243 (defun org-beginning-of-dblock ()
14244 "Find the beginning of the dynamic block at point.
14245 Error if there is no scuh block at point."
14246 (let ((pos (point))
14247 beg)
14248 (end-of-line 1)
14249 (if (and (re-search-backward org-dblock-start-re nil t)
14250 (setq beg (match-beginning 0))
14251 (re-search-forward org-dblock-end-re nil t)
14252 (> (match-end 0) pos))
14253 (goto-char beg)
14254 (goto-char pos)
14255 (error "Not in a dynamic block"))))
14257 (defun org-update-all-dblocks ()
14258 "Update all dynamic blocks in the buffer.
14259 This function can be used in a hook."
14260 (when (org-mode-p)
14261 (org-map-dblocks 'org-update-dblock)))
14264 ;;;; Completion
14266 (defconst org-additional-option-like-keywords
14267 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14268 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14269 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14271 (defun org-complete (&optional arg)
14272 "Perform completion on word at point.
14273 At the beginning of a headline, this completes TODO keywords as given in
14274 `org-todo-keywords'.
14275 If the current word is preceded by a backslash, completes the TeX symbols
14276 that are supported for HTML support.
14278 setting file options.
14280 At all other locations, this simply calls the value of
14281 `org-completion-fallback-command'."
14282 (interactive "P")
14283 (org-without-partial-completion
14284 (catch 'exit
14285 (let* ((end (point))
14286 (beg1 (save-excursion
14287 (skip-chars-backward (org-re "[:alnum:]_@"))
14288 (point)))
14289 (beg (save-excursion
14290 (skip-chars-backward "a-zA-Z0-9_:$")
14291 (point)))
14292 (confirm (lambda (x) (stringp (car x))))
14293 (searchhead (equal (char-before beg) ?*))
14294 (tag (and (equal (char-before beg1) ?:)
14295 (equal (char-after (point-at-bol)) ?*)))
14296 (prop (and (equal (char-before beg1) ?:)
14297 (not (equal (char-after (point-at-bol)) ?*))))
14299 (link (equal (char-before beg) ?\[))
14300 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14301 beg)
14302 "#+"))
14304 (buffer-substring (point-at-bol) (point))))
14305 (completion-ignore-case opt)
14306 (type nil)
14307 (tbl nil)
14308 (table (cond
14309 (opt
14310 (setq type :opt)
14311 (append
14312 (mapcar
14313 (lambda (x)
14315 (cons (match-string 2 x) (match-string 1 x)))
14317 (mapcar 'list org-additional-option-like-keywords)))
14318 (startup
14319 (setq type :startup)
14320 org-startup-options)
14321 (link (append org-link-abbrev-alist-local
14322 org-link-abbrev-alist))
14323 (texp
14324 (setq type :tex)
14325 org-html-entities)
14327 (buffer-substring (point-at-bol) beg))
14328 (setq type :todo)
14329 (mapcar 'list org-todo-keywords-1))
14330 (searchhead
14331 (setq type :searchhead)
14332 (save-excursion
14333 (goto-char (point-min))
14334 (while (re-search-forward org-todo-line-regexp nil t)
14335 (push (list
14336 (org-make-org-heading-search-string
14337 (match-string 3) t))
14338 tbl)))
14339 tbl)
14340 (tag (setq type :tag beg beg1)
14341 (or org-tag-alist (org-get-buffer-tags)))
14342 (prop (setq type :prop beg beg1)
14343 (mapcar 'list (org-buffer-property-keys nil t t)))
14344 (t (progn
14345 (call-interactively org-completion-fallback-command)
14346 (throw 'exit nil)))))
14347 (pattern (buffer-substring-no-properties beg end))
14348 (completion (try-completion pattern table confirm)))
14349 (cond ((eq completion t)
14350 (if (not (assoc (upcase pattern) table))
14351 (message "Already complete")
14352 (if (equal type :opt)
14353 (insert (substring (cdr (assoc (upcase pattern) table))
14354 (length pattern)))
14355 (if (memq type '(:tag :prop)) (insert ":")))))
14356 ((null completion)
14358 (ding))
14359 ((not (string= pattern completion))
14360 (delete-region beg end)
14361 (if (string-match " +$" completion)
14362 (setq completion (replace-match "" t t completion)))
14363 (insert completion)
14364 (if (get-buffer-window "*Completions*")
14365 (delete-window (get-buffer-window "*Completions*")))
14366 (if (assoc completion table)
14367 (if (eq type :todo) (insert " ")
14368 (if (memq type '(:tag :prop)) (insert ":"))))
14369 (if (and (equal type :opt) (assoc completion table))
14370 (message "%s" (substitute-command-keys
14372 (t
14373 (message "Making completion list...")
14374 (let ((list (sort (all-completions pattern table confirm)
14375 'string<)))
14376 (with-output-to-temp-buffer "*Completions*"
14377 (condition-case nil
14378 ;; Protection needed for XEmacs and emacs 21
14379 (display-completion-list list pattern)
14380 (error (display-completion-list list)))))
14381 (message "Making completion list...%s" "done")))))))
14383 ;;;; TODO, DEADLINE, Comments
14385 (defun org-toggle-comment ()
14386 "Change the COMMENT state of an entry."
14387 (interactive)
14388 (save-excursion
14389 (org-back-to-heading)
14390 (let (case-fold-search)
14391 (if (looking-at (concat outline-regexp
14393 (replace-match "" t t nil 1)
14394 (if (looking-at outline-regexp)
14395 (progn
14396 (goto-char (match-end 0))
14397 (insert org-comment-string " ")))))))
14399 (defvar org-last-todo-state-is-todo nil
14400 "This is non-nil when the last TODO state change led to a TODO state.
14401 If the last change removed the TODO tag or switched to DONE, then
14402 this is nil.")
14404 (defvar org-setting-tags nil) ; dynamically skiped
14406 ;; FIXME: better place
14407 (defun org-property-or-variable-value (var &optional inherit)
14408 "Check if there is a property fixing the value of VAR.
14409 If yes, return this value. If not, return the current value of the variable."
14410 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14412 (read prop)
14413 (symbol-value var))))
14415 (defun org-parse-local-options (string var)
14416 "Parse STRING for startup setting relevant for variable VAR."
14417 (let ((rtn (symbol-value var))
14418 e opts)
14419 (save-match-data
14421 rtn
14422 (setq opts (delq nil (mapcar (lambda (x)
14423 (setq e (assoc x org-startup-options))
14424 (if (eq (nth 1 e) var) e nil))
14426 (if (not opts)
14427 rtn
14428 (setq rtn nil)
14429 (while (setq e (pop opts))
14430 (if (not (nth 3 e))
14431 (setq rtn (nth 2 e))
14432 (if (not (listp rtn)) (setq rtn nil))
14433 (push (nth 2 e) rtn)))
14434 rtn)))))
14436 (defvar org-blocker-hook nil
14437 "Hook for functions that are allowed to block a state change.
14439 Each function gets as its single argument a property list, see
14440 `org-trigger-hook' for more information about this list.
14442 If any of the functions in this hook returns nil, the state change
14443 is blocked.")
14445 (defvar org-trigger-hook nil
14446 "Hook for functions that are triggered by a state change.
14448 Each function gets as its single argument a property list with at least
14449 the following elements:
14451 (:type type-of-change :position pos-at-entry-start
14452 :from old-state :to new-state)
14454 Depending on the type, more properties may be present.
14456 This mechanism is currently implemented for:
14458 TODO state changes
14459 ------------------
14460 :type todo-state-change
14461 :from previous state (keyword as a string), or nil
14462 :to new state (keyword as a string), or nil")
14465 (defun org-todo (&optional arg)
14466 "Change the TODO state of an item.
14467 The state of an item is given by a keyword at the start of the heading,
14468 like
14469 *** TODO Write paper
14470 *** DONE Call mom
14472 The different keywords are specified in the variable `org-todo-keywords'.
14474 So for this example: when the item starts with TODO, it is changed to DONE.
14475 When it starts with DONE, the DONE is removed. And when neither TODO nor
14476 DONE are present, add TODO at the beginning of the heading.
14478 With C-u prefix arg, use completion to determine the new state.
14479 With numeric prefix arg, switch to that state.
14481 For calling through lisp, arg is also interpreted in the following way:
14482 'none -> empty state
14484 'done -> switch to DONE
14485 'nextset -> switch to the next set of keywords
14486 'previousset -> switch to the previous set of keywords
14488 really is a member of `org-todo-keywords'."
14489 (interactive "P")
14490 (save-excursion
14491 (catch 'exit
14492 (org-back-to-heading)
14493 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14494 (or (looking-at (concat " +" org-todo-regexp " *"))
14495 (looking-at " *"))
14496 (let* ((match-data (match-data))
14497 (startpos (point-at-bol))
14498 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14499 (org-log-done org-log-done)
14500 (org-log-repeat org-log-repeat)
14501 (org-todo-log-states org-todo-log-states)
14502 (this (match-string 1))
14503 (hl-pos (match-beginning 0))
14504 (head (org-get-todo-sequence-head this))
14505 (ass (assoc head org-todo-kwd-alist))
14506 (interpret (nth 1 ass))
14507 (done-word (nth 3 ass))
14508 (final-done-word (nth 4 ass))
14509 (last-state (or this ""))
14510 (completion-ignore-case t)
14511 (member (member this org-todo-keywords-1))
14512 (tail (cdr member))
14513 (state (cond
14514 ((and org-todo-key-trigger
14515 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14516 (and (not arg) org-use-fast-todo-selection
14517 (not (eq org-use-fast-todo-selection 'prefix)))))
14518 ;; Use fast selection
14519 (org-fast-todo-selection))
14520 ((and (equal arg '(4))
14521 (or (not org-use-fast-todo-selection)
14522 (not org-todo-key-trigger)))
14523 ;; Read a state with completion
14524 (completing-read "State: " (mapcar (lambda(x) (list x))
14525 org-todo-keywords-1)
14526 nil t))
14527 ((eq arg 'right)
14528 (if this
14529 (if tail (car tail) nil)
14530 (car org-todo-keywords-1)))
14531 ((eq arg 'left)
14532 (if (equal member org-todo-keywords-1)
14533 nil
14534 (if this
14535 (nth (- (length org-todo-keywords-1) (length tail) 2)
14536 org-todo-keywords-1)
14537 (org-last org-todo-keywords-1))))
14538 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14539 (setq arg nil))) ; hack to fall back to cycling
14540 (arg
14541 ;; user or caller requests a specific state
14542 (cond
14543 ((equal arg "") nil)
14544 ((eq arg 'none) nil)
14545 ((eq arg 'done) (or done-word (car org-done-keywords)))
14546 ((eq arg 'nextset)
14547 (or (car (cdr (member head org-todo-heads)))
14548 (car org-todo-heads)))
14549 ((eq arg 'previousset)
14550 (let ((org-todo-heads (reverse org-todo-heads)))
14551 (or (car (cdr (member head org-todo-heads)))
14552 (car org-todo-heads))))
14553 ((car (member arg org-todo-keywords-1)))
14554 ((nth (1- (prefix-numeric-value arg))
14555 org-todo-keywords-1))))
14556 ((null member) (or head (car org-todo-keywords-1)))
14557 ((equal this final-done-word) nil) ;; -> make empty
14558 ((null tail) nil) ;; -> first entry
14559 ((eq interpret 'sequence)
14560 (car tail))
14561 ((memq interpret '(type priority))
14562 (if (eq this-command last-command)
14563 (car tail)
14564 (if (> (length tail) 0)
14565 (or done-word (car org-done-keywords))
14566 nil)))
14567 (t nil)))
14568 (next (if state (concat " " state " ") " "))
14569 (change-plist (list :type 'todo-state-change :from this :to state
14570 :position startpos))
14571 dolog now-done-p)
14572 (when org-blocker-hook
14573 (unless (save-excursion
14574 (save-match-data
14575 (run-hook-with-args-until-failure
14576 'org-blocker-hook change-plist)))
14577 (if (interactive-p)
14578 (error "TODO state change from %s to %s blocked" this state)
14579 ;; fail silently
14580 (message "TODO state change from %s to %s blocked" this state)
14581 (throw 'exit nil))))
14582 (store-match-data match-data)
14583 (replace-match next t t)
14584 (unless (pos-visible-in-window-p hl-pos)
14585 (message "TODO state changed to %s" (org-trim next)))
14586 (unless head
14587 (setq head (org-get-todo-sequence-head state)
14588 ass (assoc head org-todo-kwd-alist)
14589 interpret (nth 1 ass)
14590 done-word (nth 3 ass)
14591 final-done-word (nth 4 ass)))
14592 (when (memq arg '(nextset previousset))
14593 (message "Keyword-Set %d/%d: %s"
14594 (- (length org-todo-sets) -1
14595 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14596 (length org-todo-sets)
14597 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14598 (setq org-last-todo-state-is-todo
14599 (not (member state org-done-keywords)))
14600 (setq now-done-p (and (member state org-done-keywords)
14601 (not (member this org-done-keywords))))
14602 (and logging (org-local-logging logging))
14603 (when (and (or org-todo-log-states org-log-done)
14604 (not (memq arg '(nextset previousset))))
14605 ;; we need to look at recording a time and note
14606 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14607 (nth 2 (assoc this org-todo-log-states))))
14608 (when (and state
14609 (member state org-not-done-keywords)
14610 (not (member this org-not-done-keywords)))
14611 ;; This is now a todo state and was not one before
14612 ;; If there was a CLOSED time stamp, get rid of it.
14613 (org-add-planning-info nil nil 'closed))
14614 (when (and now-done-p org-log-done)
14615 ;; It is now done, and it was not done before
14616 (org-add-planning-info 'closed (org-current-time))
14617 (if (and (not dolog) (eq 'note org-log-done))
14618 (org-add-log-maybe 'done state 'findpos 'note)))
14619 (when (and state dolog)
14620 ;; This is a non-nil state, and we need to log it
14621 (org-add-log-maybe 'state state 'findpos dolog)))
14622 ;; Fixup tag positioning
14623 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14624 (run-hooks 'org-after-todo-state-change-hook)
14625 (if (and arg (not (member state org-done-keywords)))
14626 (setq head (org-get-todo-sequence-head state)))
14627 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14628 ;; Do we need to trigger a repeat?
14629 (when now-done-p (org-auto-repeat-maybe state))
14630 ;; Fixup cursor location if close to the keyword
14631 (if (and (outline-on-heading-p)
14632 (not (bolp))
14633 (save-excursion (beginning-of-line 1)
14634 (looking-at org-todo-line-regexp))
14635 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14636 (progn
14637 (goto-char (or (match-end 2) (match-end 1)))
14638 (just-one-space)))
14639 (when org-trigger-hook
14640 (save-excursion
14641 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14643 (defun org-local-logging (value)
14644 "Get logging settings from a property VALUE."
14645 (let* (words w a)
14646 ;; directly set the variables, they are already local.
14647 (setq org-log-done nil
14648 org-log-repeat nil
14649 org-todo-log-states nil)
14650 (setq words (org-split-string value))
14651 (while (setq w (pop words))
14652 (cond
14653 ((setq a (assoc w org-startup-options))
14654 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14655 (set (nth 1 a) (nth 2 a))))
14656 ((setq a (org-extract-log-state-settings w))
14657 (and (member (car a) org-todo-keywords-1)
14658 (push a org-todo-log-states)))))))
14660 (defun org-get-todo-sequence-head (kwd)
14661 "Return the head of the TODO sequence to which KWD belongs.
14662 If KWD is not set, check if there is a text property remembering the
14663 right sequence."
14664 (let (p)
14665 (cond
14666 ((not kwd)
14667 (or (get-text-property (point-at-bol) 'org-todo-head)
14668 (progn
14669 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14670 nil (point-at-eol)))
14671 (get-text-property p 'org-todo-head))))
14672 ((not (member kwd org-todo-keywords-1))
14673 (car org-todo-keywords-1))
14674 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14676 (defun org-fast-todo-selection ()
14677 "Fast TODO keyword selection with single keys.
14678 Returns the new TODO keyword, or nil if no state change should occur."
14679 (let* ((fulltable org-todo-key-alist)
14680 (done-keywords org-done-keywords) ;; needed for the faces.
14681 (maxlen (apply 'max (mapcar
14682 (lambda (x)
14683 (if (stringp (car x)) (string-width (car x)) 0))
14684 fulltable)))
14685 (expert nil)
14686 (fwidth (+ maxlen 3 1 3))
14687 (ncol (/ (- (window-width) 4) fwidth))
14688 tg cnt e c tbl
14689 groups ingroup)
14690 (save-window-excursion
14691 (if expert
14692 (set-buffer (get-buffer-create " *Org todo*"))
14693 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14694 (erase-buffer)
14695 (org-set-local 'org-done-keywords done-keywords)
14696 (setq tbl fulltable cnt 0)
14697 (while (setq e (pop tbl))
14698 (cond
14699 ((equal e '(:startgroup))
14700 (push '() groups) (setq ingroup t)
14701 (when (not (= cnt 0))
14702 (setq cnt 0)
14704 (insert "{ "))
14705 ((equal e '(:endgroup))
14706 (setq ingroup nil cnt 0)
14708 (t
14709 (setq tg (car e) c (cdr e))
14710 (if ingroup (push tg (car groups)))
14711 (setq tg (org-add-props tg nil 'face
14712 (org-get-todo-face tg)))
14713 (if (and (= cnt 0) (not ingroup)) (insert " "))
14714 (insert "[" c "] " tg (make-string
14715 (- fwidth 4 (length tg)) ?\ ))
14716 (when (= (setq cnt (1+ cnt)) ncol)
14718 (if ingroup (insert " "))
14719 (setq cnt 0)))))
14721 (goto-char (point-min))
14722 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14723 (fit-window-to-buffer))
14724 (message "[a-z..]:Set [SPC]:clear")
14725 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14726 (cond
14727 ((or (= c ?\C-g)
14728 (and (= c ?q) (not (rassoc c fulltable))))
14729 (setq quit-flag t))
14730 ((= c ?\ ) nil)
14731 ((setq e (rassoc c fulltable) tg (car e))
14732 tg)
14733 (t (setq quit-flag t))))))
14735 (defun org-get-repeat ()
14736 "Check if tere is a deadline/schedule with repeater in this entry."
14737 (save-match-data
14738 (save-excursion
14739 (org-back-to-heading t)
14740 (if (re-search-forward
14741 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14742 (match-string 1)))))
14744 (defvar org-last-changed-timestamp)
14745 (defvar org-log-post-message)
14746 (defvar org-log-note-purpose)
14747 (defun org-auto-repeat-maybe (done-word)
14748 "Check if the current headline contains a repeated deadline/schedule.
14749 If yes, set TODO state back to what it was and change the base date
14750 of repeating deadline/scheduled time stamps to new date.
14751 This function should be run in the `org-after-todo-state-change-hook'."
14752 ;; last-state is dynamically scoped into this function
14753 (let* ((repeat (org-get-repeat))
14754 (aa (assoc last-state org-todo-kwd-alist))
14755 (interpret (nth 1 aa))
14756 (head (nth 2 aa))
14757 (whata '(("d" . day) ("m" . month) ("y" . year)))
14758 (msg "Entry repeats: ")
14759 (org-log-done nil)
14760 re type n what ts)
14761 (when repeat
14762 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
14763 (org-todo (if (eq interpret 'type) last-state head))
14764 (when (and org-log-repeat
14765 (or (not (memq 'org-add-log-note
14766 (default-value 'post-command-hook)))
14767 (eq org-log-note-purpose 'done)))
14768 ;; Make sure a note is taken;
14769 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
14770 'findpos org-log-repeat))
14771 (org-back-to-heading t)
14772 (org-add-planning-info nil nil 'closed)
14776 (while (re-search-forward
14777 re (save-excursion (outline-next-heading) (point)) t)
14778 (setq type (if (match-end 1) org-scheduled-string
14779 (if (match-end 3) org-deadline-string "Plain:"))
14780 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14782 (setq n (string-to-number (match-string 1 ts))
14783 what (match-string 2 ts))
14784 (if (equal what "w") (setq n (* n 7) what "d"))
14785 (org-timestamp-change n (cdr (assoc what whata)))
14786 (setq msg (concat msg type org-last-changed-timestamp " "))))
14787 (setq org-log-post-message msg)
14788 (message "%s" msg))))
14790 (defun org-show-todo-tree (arg)
14791 "Make a compact tree which shows all headlines marked with TODO.
14792 The tree will show the lines where the regexp matches, and all higher
14793 headlines above the match.
14795 With a numeric prefix N, construct a sparse tree for the Nth element
14796 of `org-todo-keywords-1'."
14797 (interactive "P")
14798 (let ((case-fold-search nil)
14799 (kwd-re
14800 (cond ((null arg) org-not-done-regexp)
14801 ((equal arg '(4))
14802 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14803 (mapcar 'list org-todo-keywords-1))))
14807 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14808 (regexp-quote (nth (1- (prefix-numeric-value arg))
14809 org-todo-keywords-1)))
14810 (t (error "Invalid prefix argument: %s" arg)))))
14811 (message "%d TODO entries found"
14812 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14814 (defun org-deadline (&optional remove)
14816 With argument REMOVE, remove any deadline from the item."
14817 (interactive "P")
14818 (if remove
14819 (progn
14820 (org-remove-timestamp-with-keyword org-deadline-string)
14821 (message "Item no longer has a deadline."))
14822 (org-add-planning-info 'deadline nil 'closed)))
14824 (defun org-schedule (&optional remove)
14825 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14826 With argument REMOVE, remove any scheduling date from the item."
14827 (interactive "P")
14828 (if remove
14829 (progn
14830 (org-remove-timestamp-with-keyword org-scheduled-string)
14831 (message "Item is no longer scheduled."))
14832 (org-add-planning-info 'scheduled nil 'closed)))
14834 (defun org-remove-timestamp-with-keyword (keyword)
14835 "Remove all time stamps with KEYWORD in the current entry."
14837 beg)
14838 (save-excursion
14839 (org-back-to-heading t)
14840 (setq beg (point))
14841 (org-end-of-subtree t t)
14842 (while (re-search-backward re beg t)
14843 (replace-match "")
14845 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14847 (defun org-add-planning-info (what &optional time &rest remove)
14848 "Insert new timestamp with keyword in the line directly after the headline.
14849 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14850 If non is given, the user is prompted for a date.
14851 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14852 be removed."
14853 (interactive)
14854 (let (org-time-was-given org-end-time-was-given)
14855 (when what (setq time (or time (org-read-date nil 'to-time))))
14856 (when (and org-insert-labeled-timestamps-at-point
14857 (member what '(scheduled deadline)))
14858 (insert
14859 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14860 (org-insert-time-stamp time org-time-was-given
14861 nil nil nil (list org-end-time-was-given))
14862 (setq what nil))
14863 (save-excursion
14864 (save-restriction
14865 (let (col list elt ts buffer-invisibility-spec)
14866 (org-back-to-heading t)
14868 (goto-char (match-end 1))
14869 (setq col (current-column))
14870 (goto-char (match-end 0))
14872 (if (and (not (looking-at outline-regexp))
14875 (not (equal (match-string 1) org-clock-string)))
14876 (narrow-to-region (match-beginning 0) (match-end 0))
14878 (backward-char 1)
14879 (narrow-to-region (point) (point))
14880 (indent-to-column col))
14881 ;; Check if we have to remove something.
14882 (setq list (cons what remove))
14883 (while list
14884 (setq elt (pop list))
14885 (goto-char (point-min))
14886 (when (or (and (eq elt 'scheduled)
14887 (re-search-forward org-scheduled-time-regexp nil t))
14888 (and (eq elt 'deadline)
14889 (re-search-forward org-deadline-time-regexp nil t))
14890 (and (eq elt 'closed)
14891 (re-search-forward org-closed-time-regexp nil t)))
14892 (replace-match "")
14893 (if (looking-at "--+<[^>]+>") (replace-match ""))
14894 (if (looking-at " +") (replace-match ""))))
14895 (goto-char (point-max))
14896 (when what
14897 (insert
14898 (if (not (equal (char-before) ?\ )) " " "")
14899 (cond ((eq what 'scheduled) org-scheduled-string)
14900 ((eq what 'deadline) org-deadline-string)
14901 ((eq what 'closed) org-closed-string))
14902 " ")
14903 (setq ts (org-insert-time-stamp
14904 time
14905 (or org-time-was-given
14906 (and (eq what 'closed) org-log-done-with-time))
14907 (eq what 'closed)
14908 nil nil (list org-end-time-was-given)))
14909 (end-of-line 1))
14910 (goto-char (point-min))
14911 (widen)
14913 (replace-match ""))
14914 ts)))))
14916 (defvar org-log-note-marker (make-marker))
14917 (defvar org-log-note-purpose nil)
14918 (defvar org-log-note-state nil)
14919 (defvar org-log-note-how nil)
14920 (defvar org-log-note-window-configuration nil)
14921 (defvar org-log-note-return-to (make-marker))
14922 (defvar org-log-post-message nil
14923 "Message to be displayed after a log note has been stored.
14924 The auto-repeater uses this.")
14926 (defun org-add-log-maybe (&optional purpose state findpos how)
14927 "Set up the post command hook to take a note.
14928 If this is about to TODO state change, the new state is expected in STATE.
14929 When FINDPOS is non-nil, find the correct position for the note in
14930 the current entry. If not, assume that it can be inserted at point."
14931 (save-excursion
14932 (when findpos
14933 (org-back-to-heading t)
14937 (goto-char (match-end 0))
14938 (unless org-log-states-order-reversed
14940 (org-skip-over-state-notes)
14942 (move-marker org-log-note-marker (point))
14943 (setq org-log-note-purpose purpose
14944 org-log-note-state state
14945 org-log-note-how how)
14946 (add-hook 'post-command-hook 'org-add-log-note 'append)))
14948 (defun org-skip-over-state-notes ()
14949 "Skip past the list of State notes in an entry."
14952 (condition-case nil
14953 (org-next-item)
14954 (error (org-end-of-item)))))
14956 (defun org-add-log-note (&optional purpose)
14957 "Pop up a window for taking a note, and add this note later at point."
14958 (remove-hook 'post-command-hook 'org-add-log-note)
14959 (setq org-log-note-window-configuration (current-window-configuration))
14960 (delete-other-windows)
14961 (move-marker org-log-note-return-to (point))
14962 (switch-to-buffer (marker-buffer org-log-note-marker))
14963 (goto-char org-log-note-marker)
14964 (org-switch-to-buffer-other-window "*Org Note*")
14965 (erase-buffer)
14966 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
14967 (org-store-log-note)
14968 (let ((org-inhibit-startup t)) (org-mode))
14969 (insert (format "# Insert note for %s.
14971 (cond
14972 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14973 ((eq org-log-note-purpose 'done) "closed todo item")
14974 ((eq org-log-note-purpose 'state)
14976 (t (error "This should not happen")))))
14977 (org-set-local 'org-finish-function 'org-store-log-note)))
14979 (defun org-store-log-note ()
14980 "Finish taking a log note, and insert it to where it belongs."
14981 (let ((txt (buffer-string))
14982 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14983 lines ind)
14984 (kill-buffer (current-buffer))
14986 (setq txt (replace-match "" t t txt)))
14988 (setq txt (replace-match "" t t txt)))
14991 (setq note
14992 (org-replace-escapes
14993 note
14994 (list (cons "%u" (user-login-name))
14995 (cons "%U" user-full-name)
14996 (cons "%t" (format-time-string
14997 (org-time-stamp-format 'long 'inactive)
14998 (current-time)))
14999 (cons "%s" (if org-log-note-state
15001 "")))))
15003 (push note lines))
15004 (when (or current-prefix-arg org-note-abort) (setq lines nil))
15005 (when lines
15006 (save-excursion
15007 (set-buffer (marker-buffer org-log-note-marker))
15008 (save-excursion
15009 (goto-char org-log-note-marker)
15010 (move-marker org-log-note-marker nil)
15011 (end-of-line 1)
15013 (indent-relative nil)
15014 (insert "- " (pop lines))
15015 (org-indent-line-function)
15016 (beginning-of-line 1)
15018 (setq ind (concat (match-string 0) " "))
15019 (end-of-line 1)
15021 (set-window-configuration org-log-note-window-configuration)
15022 (with-current-buffer (marker-buffer org-log-note-return-to)
15023 (goto-char org-log-note-return-to))
15024 (move-marker org-log-note-return-to nil)
15025 (and org-log-post-message (message "%s" org-log-post-message)))
15027 ;; FIXME: what else would be useful?
15028 ;; - priority
15029 ;; - date
15031 (defun org-sparse-tree (&optional arg)
15032 "Create a sparse tree, prompt for the details.
15033 This command can create sparse trees. You first need to select the type
15034 of match used to create the tree:
15036 t Show entries with a specific TODO keyword.
15037 T Show entries selected by a tags match.
15038 p Enter a property name and its value (both with completion on existing
15039 names/values) and show entries with that property.
15040 r Show entries matching a regular expression
15041 d Show deadlines due within `org-deadline-warning-days'."
15042 (interactive "P")
15043 (let (ans kwd value)
15044 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15045 (setq ans (read-char-exclusive))
15046 (cond
15047 ((equal ans ?d)
15048 (call-interactively 'org-check-deadlines))
15049 ((equal ans ?b)
15050 (call-interactively 'org-check-before-date))
15051 ((equal ans ?t)
15052 (org-show-todo-tree '(4)))
15053 ((equal ans ?T)
15054 (call-interactively 'org-tags-sparse-tree))
15055 ((member ans '(?p ?P))
15056 (setq kwd (completing-read "Property: "
15057 (mapcar 'list (org-buffer-property-keys))))
15058 (setq value (completing-read "Value: "
15059 (mapcar 'list (org-property-values kwd))))
15062 (org-tags-sparse-tree arg (concat kwd "=" value)))
15063 ((member ans '(?r ?R ?/))
15064 (call-interactively 'org-occur))
15067 (defvar org-occur-highlights nil)
15068 (make-variable-buffer-local 'org-occur-highlights)
15070 (defun org-occur (regexp &optional keep-previous callback)
15071 "Make a compact tree which shows all matches of REGEXP.
15072 The tree will show the lines where the regexp matches, and all higher
15073 headlines above the match. It will also show the heading after the match,
15074 to make sure editing the matching entry is easy.
15075 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15076 call to `org-occur' will be kept, to allow stacking of calls to this
15077 command.
15078 If CALLBACK is non-nil, it is a function which is called to confirm
15079 that the match should indeed be shown."
15081 (or keep-previous (org-remove-occur-highlights nil nil t))
15082 (let ((cnt 0))
15083 (save-excursion
15084 (goto-char (point-min))
15085 (if (or (not keep-previous) ; do not want to keep
15086 (not org-occur-highlights)) ; no previous matches
15087 ;; hide everything
15088 (org-overview))
15089 (while (re-search-forward regexp nil t)
15090 (when (or (not callback)
15091 (save-match-data (funcall callback)))
15092 (setq cnt (1+ cnt))
15093 (when org-highlight-sparse-tree-matches
15094 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15095 (org-show-context 'occur-tree))))
15096 (when org-remove-highlights-with-change
15097 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15098 nil 'local))
15099 (unless org-sparse-tree-open-archived-trees
15100 (org-hide-archived-subtrees (point-min) (point-max)))
15101 (run-hooks 'org-occur-hook)
15102 (if (interactive-p)
15103 (message "%d match(es) for regexp %s" cnt regexp))
15104 cnt))
15106 (defun org-show-context (&optional key)
15107 "Make sure point and context and visible.
15108 How much context is shown depends upon the variables
15109 `org-show-hierarchy-above', `org-show-following-heading'. and
15110 `org-show-siblings'."
15111 (let ((heading-p (org-on-heading-p t))
15112 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15113 (following-p (org-get-alist-option org-show-following-heading key))
15114 (entry-p (org-get-alist-option org-show-entry-below key))
15115 (siblings-p (org-get-alist-option org-show-siblings key)))
15116 (catch 'exit
15117 ;; Show heading or entry text
15118 (if (and heading-p (not entry-p))
15119 (org-flag-heading nil) ; only show the heading
15120 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15121 (org-show-hidden-entry))) ; show entire entry
15122 (when following-p
15123 ;; Show next sibling, or heading below text
15124 (save-excursion
15125 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15126 (org-flag-heading nil))))
15127 (when siblings-p (org-show-siblings))
15128 (when hierarchy-p
15129 ;; show all higher headings, possibly with siblings
15130 (save-excursion
15131 (while (and (condition-case nil
15132 (progn (org-up-heading-all 1) t)
15133 (error nil))
15134 (not (bobp)))
15135 (org-flag-heading nil)
15136 (when siblings-p (org-show-siblings))))))))
15138 (defun org-reveal (&optional siblings)
15139 "Show current entry, hierarchy above it, and the following headline.
15140 This can be used to show a consistent set of context around locations
15141 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15142 not t for the search context.
15144 With optional argument SIBLINGS, on each level of the hierarchy all
15145 siblings are shown. This repairs the tree structure to what it would
15146 look like when opened with hierarchical calls to `org-cycle'."
15147 (interactive "P")
15148 (let ((org-show-hierarchy-above t)
15149 (org-show-following-heading t)
15150 (org-show-siblings (if siblings t org-show-siblings)))
15151 (org-show-context nil)))
15153 (defun org-highlight-new-match (beg end)
15154 "Highlight from BEG to END and mark the highlight is an occur headline."
15155 (let ((ov (org-make-overlay beg end)))
15156 (org-overlay-put ov 'face 'secondary-selection)
15157 (push ov org-occur-highlights)))
15159 (defun org-remove-occur-highlights (&optional beg end noremove)
15160 "Remove the occur highlights from the buffer.
15161 BEG and END are ignored. If NOREMOVE is nil, remove this function
15162 from the `before-change-functions' in the current buffer."
15163 (interactive)
15164 (unless org-inhibit-highlight-removal
15165 (mapc 'org-delete-overlay org-occur-highlights)
15166 (setq org-occur-highlights nil)
15167 (unless noremove
15168 (remove-hook 'before-change-functions
15169 'org-remove-occur-highlights 'local))))
15171 ;;;; Priorities
15174 "Regular expression matching the priority indicator.")
15176 (defvar org-remove-priority-next-time nil)
15178 (defun org-priority-up ()
15179 "Increase the priority of the current item."
15180 (interactive)
15181 (org-priority 'up))
15183 (defun org-priority-down ()
15184 "Decrease the priority of the current item."
15185 (interactive)
15186 (org-priority 'down))
15188 (defun org-priority (&optional action)
15189 "Change the priority of an item by ARG.
15190 ACTION can be `set', `up', `down', or a character."
15191 (interactive)
15192 (setq action (or action 'set))
15193 (let (current new news have remove)
15194 (save-excursion
15195 (org-back-to-heading)
15196 (if (looking-at org-priority-regexp)
15197 (setq current (string-to-char (match-string 2))
15198 have t)
15199 (setq current org-default-priority))
15200 (cond
15201 ((or (eq action 'set) (integerp action))
15202 (if (integerp action)
15203 (setq new action)
15204 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15205 (setq new (read-char-exclusive)))
15206 (if (and (= (upcase org-highest-priority) org-highest-priority)
15207 (= (upcase org-lowest-priority) org-lowest-priority))
15208 (setq new (upcase new)))
15209 (cond ((equal new ?\ ) (setq remove t))
15210 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15211 (error "Priority must be between `%c' and `%c'"
15212 org-highest-priority org-lowest-priority))))
15213 ((eq action 'up)
15214 (if (and (not have) (eq last-command this-command))
15215 (setq new org-lowest-priority)
15216 (setq new (if (and org-priority-start-cycle-with-default (not have))
15217 org-default-priority (1- current)))))
15218 ((eq action 'down)
15219 (if (and (not have) (eq last-command this-command))
15220 (setq new org-highest-priority)
15221 (setq new (if (and org-priority-start-cycle-with-default (not have))
15222 org-default-priority (1+ current)))))
15223 (t (error "Invalid action")))
15224 (if (or (< (upcase new) org-highest-priority)
15225 (> (upcase new) org-lowest-priority))
15226 (setq remove t))
15227 (setq news (format "%c" new))
15228 (if have
15229 (if remove
15230 (replace-match "" t t nil 1)
15231 (replace-match news t t nil 2))
15232 (if remove
15233 (error "No priority cookie found in line")
15234 (looking-at org-todo-line-regexp)
15235 (if (match-end 2)
15236 (progn
15237 (goto-char (match-end 2))
15238 (insert " [#" news "]"))
15239 (goto-char (match-beginning 3))
15240 (insert "[#" news "] ")))))
15241 (org-preserve-lc (org-set-tags nil 'align))
15242 (if remove
15243 (message "Priority removed")
15244 (message "Priority of current item set to %s" news))))
15247 (defun org-get-priority (s)
15248 "Find priority cookie and return priority."
15249 (save-match-data
15250 (if (not (string-match org-priority-regexp s))
15251 (* 1000 (- org-lowest-priority org-default-priority))
15252 (* 1000 (- org-lowest-priority
15253 (string-to-char (match-string 2 s)))))))
15255 ;;;; Tags
15257 (defun org-scan-tags (action matcher &optional todo-only)
15258 "Scan headline tags with inheritance and produce output ACTION.
15259 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15260 evaluated, testing if a given set of tags qualifies a headline for
15261 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15262 are included in the output."
15265 (org-re
15267 (props (list 'face nil
15268 'done-face 'org-done
15269 'undone-face nil
15270 'mouse-face 'highlight
15271 'org-not-done-regexp org-not-done-regexp
15272 'org-todo-regexp org-todo-regexp
15273 'keymap org-agenda-keymap
15274 'help-echo
15275 (format "mouse-2 or RET jump to org file %s"
15276 (abbreviate-file-name
15277 (or (buffer-file-name (buffer-base-buffer))
15278 (buffer-name (buffer-base-buffer)))))))
15279 (case-fold-search nil)
15280 lspos
15281 tags tags-list tags-alist (llast 0) rtn level category i txt
15282 todo marker entry priority)
15283 (save-excursion
15284 (goto-char (point-min))
15285 (when (eq action 'sparse-tree)
15286 (org-overview)
15287 (org-remove-occur-highlights))
15288 (while (re-search-forward re nil t)
15289 (catch :skip
15290 (setq todo (if (match-end 1) (match-string 2))
15291 tags (if (match-end 4) (match-string 4)))
15292 (goto-char (setq lspos (1+ (match-beginning 0))))
15293 (setq level (org-reduced-level (funcall outline-level))
15294 category (org-get-category))
15295 (setq i llast llast level)
15296 ;; remove tag lists from same and sublevels
15297 (while (>= i level)
15298 (when (setq entry (assoc i tags-alist))
15299 (setq tags-alist (delete entry tags-alist)))
15300 (setq i (1- i)))
15301 ;; add the nex tags
15302 (when tags
15303 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15304 tags-alist
15305 (cons (cons level tags) tags-alist)))
15306 ;; compile tags for current headline
15307 (setq tags-list
15308 (if org-use-tag-inheritance
15309 (apply 'append (mapcar 'cdr tags-alist))
15310 tags))
15311 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15312 (eval matcher)
15313 (or (not org-agenda-skip-archived-trees)
15314 (not (member org-archive-tag tags-list))))
15315 (and (eq action 'agenda) (org-agenda-skip))
15316 ;; list this headline
15318 (if (eq action 'sparse-tree)
15319 (progn
15320 (and org-highlight-sparse-tree-matches
15321 (org-get-heading) (match-end 0)
15322 (org-highlight-new-match
15323 (match-beginning 0) (match-beginning 1)))
15324 (org-show-context 'tags-tree))
15325 (setq txt (org-format-agenda-item
15326 ""
15327 (concat
15328 (if org-tags-match-list-sublevels
15329 (make-string (1- level) ?.) "")
15330 (org-get-heading))
15331 category tags-list)
15332 priority (org-get-priority txt))
15333 (goto-char lspos)
15334 (setq marker (org-agenda-new-marker))
15335 (org-add-props txt props
15336 'org-marker marker 'org-hd-marker marker 'org-category category
15337 'priority priority 'type "tagsmatch")
15338 (push txt rtn))
15339 ;; if we are to skip sublevels, jump to end of subtree
15340 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15341 (when (and (eq action 'sparse-tree)
15342 (not org-sparse-tree-open-archived-trees))
15343 (org-hide-archived-subtrees (point-min) (point-max)))
15344 (nreverse rtn)))
15346 (defvar todo-only) ;; dynamically scoped
15348 (defun org-tags-sparse-tree (&optional todo-only match)
15349 "Create a sparse tree according to tags string MATCH.
15350 MATCH can contain positive and negative selection of tags, like
15352 If optional argument TODO_ONLY is non-nil, only select lines that are
15353 also TODO lines."
15354 (interactive "P")
15355 (org-prepare-agenda-buffers (list (current-buffer)))
15356 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15358 (defvar org-cached-props nil)
15359 (defun org-cached-entry-get (pom property)
15360 (if (or (eq t org-use-property-inheritance)
15361 (member property org-use-property-inheritance))
15362 ;; Caching is not possible, check it directly
15363 (org-entry-get pom property 'inherit)
15364 ;; Get all properties, so that we can do complicated checks easily
15365 (cdr (assoc property (or org-cached-props
15366 (setq org-cached-props
15367 (org-entry-properties pom)))))))
15369 (defun org-global-tags-completion-table (&optional files)
15370 "Return the list of all tags in all agenda buffer/files."
15371 (save-excursion
15372 (org-uniquify
15373 (delq nil
15374 (apply 'append
15375 (mapcar
15376 (lambda (file)
15377 (set-buffer (find-file-noselect file))
15378 (append (org-get-buffer-tags)
15379 (mapcar (lambda (x) (if (stringp (car-safe x))
15380 (list (car-safe x)) nil))
15381 org-tag-alist)))
15382 (if (and files (car files))
15383 files
15384 (org-agenda-files))))))))
15386 (defun org-make-tags-matcher (match)
15387 "Create the TAGS//TODO matcher form for the selection string MATCH."
15388 ;; todo-only is scoped dynamically into this function, and the function
15389 ;; may change it it the matcher asksk for it.
15390 (unless match
15391 ;; Get a new match request, with completion
15392 (let ((org-last-tags-completion-table
15393 (org-global-tags-completion-table)))
15394 (setq match (completing-read
15395 "Match: " 'org-tags-completion-function nil nil nil
15396 'org-tags-history))))
15398 ;; Parse the string and create a lisp form
15399 (let ((match0 match)
15400 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15401 minus tag mm
15402 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15403 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15404 (if (string-match "/+" match)
15405 ;; match contains also a todo-matching request
15406 (progn
15407 (setq tagsmatch (substring match 0 (match-beginning 0))
15408 todomatch (substring match (match-end 0)))
15409 (if (string-match "^!" todomatch)
15410 (setq todo-only t todomatch (substring todomatch 1)))
15412 (setq todomatch nil)))
15413 ;; only matching tags
15414 (setq tagsmatch match todomatch nil))
15416 ;; Make the tags matcher
15418 (setq tagsmatcher t)
15419 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15420 (while (setq term (pop orterms))
15422 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15423 (while (string-match re term)
15424 (setq minus (and (match-end 1)
15425 (equal (match-string 1 term) "-"))
15426 tag (match-string 2 term)
15427 re-p (equal (string-to-char tag) ?{)
15428 level-p (match-end 3)
15429 prop-p (match-end 4)
15430 mm (cond
15431 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15432 (level-p `(= level ,(string-to-number
15433 (match-string 3 term))))
15434 (prop-p
15435 (setq pn (match-string 4 term)
15436 pv (match-string 5 term)
15437 cat-p (equal pn "CATEGORY")
15438 re-p (equal (string-to-char pv) ?{)
15439 pv (substring pv 1 -1))
15440 (if (equal pn "CATEGORY")
15441 (setq gv '(get-text-property (point) 'org-category))
15442 (setq gv `(org-cached-entry-get nil ,pn)))
15443 (if re-p
15444 `(string-match ,pv (or ,gv ""))
15445 `(equal ,pv (or ,gv ""))))
15446 (t `(member ,(downcase tag) tags-list)))
15447 mm (if minus (list 'not mm) mm)
15448 term (substring term (match-end 0)))
15449 (push mm tagsmatcher))
15450 (push (if (> (length tagsmatcher) 1)
15451 (cons 'and tagsmatcher)
15452 (car tagsmatcher))
15453 orlist)
15454 (setq tagsmatcher nil))
15455 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15456 (setq tagsmatcher
15457 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15459 ;; Make the todo matcher
15461 (setq todomatcher t)
15462 (setq orterms (org-split-string todomatch "|") orlist nil)
15463 (while (setq term (pop orterms))
15464 (while (string-match re term)
15465 (setq minus (and (match-end 1)
15466 (equal (match-string 1 term) "-"))
15467 kwd (match-string 2 term)
15468 re-p (equal (string-to-char kwd) ?{)
15469 term (substring term (match-end 0))
15470 mm (if re-p
15471 `(string-match ,(substring kwd 1 -1) todo)
15472 (list 'equal 'todo kwd))
15473 mm (if minus (list 'not mm) mm))
15474 (push mm todomatcher))
15475 (push (if (> (length todomatcher) 1)
15476 (cons 'and todomatcher)
15477 (car todomatcher))
15478 orlist)
15479 (setq todomatcher nil))
15480 (setq todomatcher (if (> (length orlist) 1)
15481 (cons 'or orlist) (car orlist))))
15483 ;; Return the string and lisp forms of the matcher
15484 (setq matcher (if todomatcher
15485 (list 'and tagsmatcher todomatcher)
15486 tagsmatcher))
15487 (cons match0 matcher)))
15489 (defun org-match-any-p (re list)
15490 "Does re match any element of list?"
15491 (setq list (mapcar (lambda (x) (string-match re x)) list))
15492 (delq nil list))
15494 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15495 (defvar org-tags-overlay (org-make-overlay 1 1))
15496 (org-detach-overlay org-tags-overlay)
15498 (defun org-align-tags-here (to-col)
15499 ;; Assumes that this is a headline
15500 (let ((pos (point)) (col (current-column)) tags)
15501 (beginning-of-line 1)
15503 (< pos (match-beginning 2)))
15504 (progn
15505 (setq tags (match-string 2))
15506 (goto-char (match-beginning 1))
15507 (insert " ")
15508 (delete-region (point) (1+ (match-end 0)))
15509 (backward-char 1)
15510 (move-to-column
15511 (max (1+ (current-column))
15512 (1+ col)
15513 (if (> to-col 0)
15514 to-col
15515 (- (abs to-col) (length tags))))
15516 t)
15517 (insert tags)
15518 (move-to-column (min (current-column) col) t))
15519 (goto-char pos))))
15521 (defun org-set-tags (&optional arg just-align)
15522 "Set the tags for the current headline.
15523 With prefix ARG, realign all tags in headings in the current buffer."
15524 (interactive "P")
15525 (let* ((re (concat "^" outline-regexp))
15526 (current (org-get-tags-string))
15527 (col (current-column))
15528 (org-setting-tags t)
15529 table current-tags inherited-tags ; computed below when needed
15530 tags p0 c0 c1 rpl)
15531 (if arg
15532 (save-excursion
15533 (goto-char (point-min))
15534 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15535 (while (re-search-forward re nil t)
15536 (org-set-tags nil t)
15537 (end-of-line 1)))
15538 (message "All tags realigned to column %d" org-tags-column))
15539 (if just-align
15540 (setq tags current)
15541 ;; Get a new set of tags from the user
15542 (save-excursion
15543 (setq table (or org-tag-alist (org-get-buffer-tags))
15544 org-last-tags-completion-table table
15545 current-tags (org-split-string current ":")
15546 inherited-tags (nreverse
15547 (nthcdr (length current-tags)
15548 (nreverse (org-get-tags-at))))
15549 tags
15550 (if (or (eq t org-use-fast-tag-selection)
15551 (and org-use-fast-tag-selection
15552 (delq nil (mapcar 'cdr table))))
15553 (org-fast-tag-selection
15554 current-tags inherited-tags table
15555 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15556 (let ((org-add-colon-after-tag-completion t))
15557 (org-trim
15558 (org-without-partial-completion
15559 (completing-read "Tags: " 'org-tags-completion-function
15560 nil nil current 'org-tags-history)))))))
15561 (while (string-match "[-+&]+" tags)
15562 ;; No boolean logic, just a list
15563 (setq tags (replace-match ":" t t tags))))
15566 (setq tags "")
15567 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15568 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15570 ;; Insert new tags at the correct column
15571 (beginning-of-line 1)
15572 (cond
15573 ((and (equal current "") (equal tags "")))
15574 ((re-search-forward
15576 (point-at-eol) t)
15577 (if (equal tags "")
15578 (setq rpl "")
15579 (goto-char (match-beginning 0))
15580 (setq c0 (current-column) p0 (point)
15581 c1 (max (1+ c0) (if (> org-tags-column 0)
15582 org-tags-column
15583 (- (- org-tags-column) (length tags))))
15584 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15585 (replace-match rpl t t)
15586 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15587 tags)
15588 (t (error "Tags alignment failed")))
15589 (move-to-column col)
15590 (unless just-align
15591 (run-hooks 'org-after-tags-change-hook)))))
15593 (defun org-change-tag-in-region (beg end tag off)
15594 "Add or remove TAG for each entry in the region.
15595 This works in the agenda, and also in an org-mode buffer."
15596 (interactive
15597 (list (region-beginning) (region-end)
15598 (let ((org-last-tags-completion-table
15599 (if (org-mode-p)
15600 (org-get-buffer-tags)
15601 (org-global-tags-completion-table))))
15602 (completing-read
15603 "Tag: " 'org-tags-completion-function nil nil nil
15604 'org-tags-history))
15605 (progn
15606 (message "[s]et or [r]emove? ")
15607 (equal (read-char-exclusive) ?r))))
15608 (if (fboundp 'deactivate-mark) (deactivate-mark))
15609 (let ((agendap (equal major-mode 'org-agenda-mode))
15610 l1 l2 m buf pos newhead (cnt 0))
15611 (goto-char end)
15612 (setq l2 (1- (org-current-line)))
15613 (goto-char beg)
15614 (setq l1 (org-current-line))
15615 (loop for l from l1 to l2 do
15616 (goto-line l)
15617 (setq m (get-text-property (point) 'org-hd-marker))
15618 (when (or (and (org-mode-p) (org-on-heading-p))
15619 (and agendap m))
15620 (setq buf (if agendap (marker-buffer m) (current-buffer))
15621 pos (if agendap m (point)))
15622 (with-current-buffer buf
15623 (save-excursion
15624 (save-restriction
15625 (goto-char pos)
15626 (setq cnt (1+ cnt))
15627 (org-toggle-tag tag (if off 'off 'on))
15628 (setq newhead (org-get-heading)))))
15629 (and agendap (org-agenda-change-all-lines newhead m))))
15630 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15632 (defun org-tags-completion-function (string predicate &optional flag)
15633 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15634 (confirm (lambda (x) (stringp (car x)))))
15636 (setq s1 (match-string 1 string)
15637 s2 (match-string 2 string))
15638 (setq s1 "" s2 string))
15639 (cond
15640 ((eq flag nil)
15641 ;; try completion
15642 (setq rtn (try-completion s2 ctable confirm))
15643 (if (stringp rtn)
15644 (setq rtn
15645 (concat s1 s2 (substring rtn (length s2))
15646 (if (and org-add-colon-after-tag-completion
15647 (assoc rtn ctable))
15648 ":" ""))))
15649 rtn)
15650 ((eq flag t)
15651 ;; all-completions
15652 (all-completions s2 ctable confirm)
15653 )
15654 ((eq flag 'lambda)
15655 ;; exact match?
15656 (assoc s2 ctable)))
15657 ))
15659 (defun org-fast-tag-insert (kwd tags face &optional end)
15660 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15661 (insert (format "%-12s" (concat kwd ":"))
15662 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15663 (or end "")))
15665 (defun org-fast-tag-show-exit (flag)
15666 (save-excursion
15667 (goto-line 3)
15669 (replace-match ""))
15670 (when flag
15671 (end-of-line 1)
15672 (move-to-column (- (window-width) 19) t)
15673 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15675 (defun org-set-current-tags-overlay (current prefix)
15676 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15677 (if (featurep 'xemacs)
15678 (org-overlay-display org-tags-overlay (concat prefix s)
15679 'secondary-selection)
15680 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15681 (org-overlay-display org-tags-overlay (concat prefix s)))))
15683 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15684 "Fast tag selection with single keys.
15685 CURRENT is the current list of tags in the headline, INHERITED is the
15686 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15687 possibly with grouping information. TODO-TABLE is a similar table with
15688 TODO keywords, should these have keys assigned to them.
15689 If the keys are nil, a-z are automatically assigned.
15690 Returns the new tags string, or nil to not change the current settings."
15691 (let* ((fulltable (append table todo-table))
15692 (maxlen (apply 'max (mapcar
15693 (lambda (x)
15694 (if (stringp (car x)) (string-width (car x)) 0))
15695 fulltable)))
15696 (buf (current-buffer))
15697 (expert (eq org-fast-tag-selection-single-key 'expert))
15698 (buffer-tags nil)
15699 (fwidth (+ maxlen 3 1 3))
15700 (ncol (/ (- (window-width) 4) fwidth))
15701 (i-face 'org-done)
15702 (c-face 'org-todo)
15703 tg cnt e c char c1 c2 ntable tbl rtn
15704 ov-start ov-end ov-prefix
15705 (exit-after-next org-fast-tag-selection-single-key)
15706 (done-keywords org-done-keywords)
15707 groups ingroup)
15708 (save-excursion
15709 (beginning-of-line 1)
15710 (if (looking-at
15712 (setq ov-start (match-beginning 1)
15713 ov-end (match-end 1)
15714 ov-prefix "")
15715 (setq ov-start (1- (point-at-eol))
15716 ov-end (1+ ov-start))
15718 (setq ov-prefix
15719 (concat
15720 (buffer-substring (1- (point)) (point))
15721 (if (> (current-column) org-tags-column)
15722 " "
15723 (make-string (- org-tags-column (current-column)) ?\ ))))))
15724 (org-move-overlay org-tags-overlay ov-start ov-end)
15725 (save-window-excursion
15726 (if expert
15727 (set-buffer (get-buffer-create " *Org tags*"))
15728 (delete-other-windows)
15729 (split-window-vertically)
15730 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15731 (erase-buffer)
15732 (org-set-local 'org-done-keywords done-keywords)
15735 (org-fast-tag-show-exit exit-after-next)
15736 (org-set-current-tags-overlay current ov-prefix)
15737 (setq tbl fulltable char ?a cnt 0)
15738 (while (setq e (pop tbl))
15739 (cond
15740 ((equal e '(:startgroup))
15741 (push '() groups) (setq ingroup t)
15742 (when (not (= cnt 0))
15743 (setq cnt 0)
15745 (insert "{ "))
15746 ((equal e '(:endgroup))
15747 (setq ingroup nil cnt 0)
15749 (t
15750 (setq tg (car e) c2 nil)
15751 (if (cdr e)
15752 (setq c (cdr e))
15753 ;; automatically assign a character.
15754 (setq c1 (string-to-char
15755 (downcase (substring
15756 tg (if (= (string-to-char tg) ?@) 1 0)))))
15757 (if (or (rassoc c1 ntable) (rassoc c1 table))
15758 (while (or (rassoc char ntable) (rassoc char table))
15759 (setq char (1+ char)))
15760 (setq c2 c1))
15761 (setq c (or c2 char)))
15762 (if ingroup (push tg (car groups)))
15763 (setq tg (org-add-props tg nil 'face
15764 (cond
15765 ((not (assoc tg table))
15766 (org-get-todo-face tg))
15767 ((member tg current) c-face)
15768 ((member tg inherited) i-face)
15769 (t nil))))
15770 (if (and (= cnt 0) (not ingroup)) (insert " "))
15771 (insert "[" c "] " tg (make-string
15772 (- fwidth 4 (length tg)) ?\ ))
15773 (push (cons tg c) ntable)
15774 (when (= (setq cnt (1+ cnt)) ncol)
15776 (if ingroup (insert " "))
15777 (setq cnt 0)))))
15778 (setq ntable (nreverse ntable))
15780 (goto-char (point-min))
15781 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15782 (fit-window-to-buffer))
15783 (setq rtn
15784 (catch 'exit
15785 (while t
15786 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15787 (if groups " [!] no groups" " [!]groups")
15788 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15789 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15790 (cond
15792 ((= c ?!)
15793 (setq groups (not groups))
15794 (goto-char (point-min))
15795 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15796 ((= c ?\C-c)
15797 (if (not expert)
15798 (org-fast-tag-show-exit
15799 (setq exit-after-next (not exit-after-next)))
15800 (setq expert nil)
15801 (delete-other-windows)
15802 (split-window-vertically)
15803 (org-switch-to-buffer-other-window " *Org tags*")
15804 (and (fboundp 'fit-window-to-buffer)
15805 (fit-window-to-buffer))))
15806 ((or (= c ?\C-g)
15807 (and (= c ?q) (not (rassoc c ntable))))
15808 (org-detach-overlay org-tags-overlay)
15809 (setq quit-flag t))
15810 ((= c ?\ )
15811 (setq current nil)
15812 (if exit-after-next (setq exit-after-next 'now)))
15814 (condition-case nil
15815 (setq tg (completing-read
15816 "Tag: "
15817 (or buffer-tags
15818 (with-current-buffer buf
15819 (org-get-buffer-tags)))))
15820 (quit (setq tg "")))
15822 (add-to-list 'buffer-tags (list tg))
15823 (if (member tg current)
15824 (setq current (delete tg current))
15825 (push tg current)))
15826 (if exit-after-next (setq exit-after-next 'now)))
15827 ((setq e (rassoc c todo-table) tg (car e))
15828 (with-current-buffer buf
15829 (save-excursion (org-todo tg)))
15830 (if exit-after-next (setq exit-after-next 'now)))
15831 ((setq e (rassoc c ntable) tg (car e))
15832 (if (member tg current)
15833 (setq current (delete tg current))
15834 (loop for g in groups do
15835 (if (member tg g)
15836 (mapc (lambda (x)
15837 (setq current (delete x current)))
15838 g)))
15839 (push tg current))
15840 (if exit-after-next (setq exit-after-next 'now))))
15842 ;; Create a sorted list
15843 (setq current
15844 (sort current
15845 (lambda (a b)
15846 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15847 (if (eq exit-after-next 'now) (throw 'exit t))
15848 (goto-char (point-min))
15849 (beginning-of-line 2)
15850 (delete-region (point) (point-at-eol))
15851 (org-fast-tag-insert "Current" current c-face)
15852 (org-set-current-tags-overlay current ov-prefix)
15853 (while (re-search-forward
15855 (setq tg (match-string 1))
15856 (add-text-properties
15857 (match-beginning 1) (match-end 1)
15858 (list 'face
15859 (cond
15860 ((member tg current) c-face)
15861 ((member tg inherited) i-face)
15862 (t (get-text-property (match-beginning 1) 'face))))))
15863 (goto-char (point-min)))))
15864 (org-detach-overlay org-tags-overlay)
15865 (if rtn
15866 (mapconcat 'identity current ":")
15867 nil))))
15869 (defun org-get-tags-string ()
15870 "Get the TAGS string in the current headline."
15871 (unless (org-on-heading-p t)
15872 (error "Not on a heading"))
15873 (save-excursion
15874 (beginning-of-line 1)
15876 (org-match-string-no-properties 1)
15877 "")))
15879 (defun org-get-tags ()
15880 "Get the list of tags specified in the current headline."
15881 (org-split-string (org-get-tags-string) ":"))
15883 (defun org-get-buffer-tags ()
15884 "Get a table of all tags used in the buffer, for completion."
15885 (let (tags)
15886 (save-excursion
15887 (goto-char (point-min))
15888 (while (re-search-forward
15890 (when (equal (char-after (point-at-bol 0)) ?*)
15891 (mapc (lambda (x) (add-to-list 'tags x))
15892 (org-split-string (org-match-string-no-properties 1) ":")))))
15893 (mapcar 'list tags)))
15896 ;;;; Properties
15898 ;;; Setting and retrieving properties
15900 (defconst org-special-properties
15901 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15902 "TIMESTAMP" "TIMESTAMP_IA")
15903 "The special properties valid in Org-mode.
15905 These are properties that are not defined in the property drawer,
15906 but in some other way.")
15908 (defconst org-default-properties
15909 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15910 "LOCATION" "LOGGING" "COLUMNS")
15911 "Some properties that are used by Org-mode for various purposes.
15912 Being in this list makes sure that they are offered for completion.")
15915 "Regular expression matching the first line of a property drawer.")
15918 "Regular expression matching the first line of a property drawer.")
15920 (defun org-property-action ()
15921 "Do an action on properties."
15922 (interactive)
15923 (let (c)
15924 (org-at-property-p)
15925 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15926 (setq c (read-char-exclusive))
15927 (cond
15928 ((equal c ?s)
15929 (call-interactively 'org-set-property))
15930 ((equal c ?d)
15931 (call-interactively 'org-delete-property))
15932 ((equal c ?D)
15933 (call-interactively 'org-delete-property-globally))
15934 ((equal c ?c)
15935 (call-interactively 'org-compute-property-at-point))
15936 (t (error "No such property action %c" c)))))
15938 (defun org-at-property-p ()
15939 "Is the cursor in a property line?"
15940 ;; FIXME: Does not check if we are actually in the drawer.
15941 ;; FIXME: also returns true on any drawers.....
15942 ;; This is used by C-c C-c for property action.
15943 (save-excursion
15944 (beginning-of-line 1)
15947 (defmacro org-with-point-at (pom &rest body)
15948 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15949 (declare (indent 1) (debug t))
15950 `(save-excursion
15951 (if (markerp pom) (set-buffer (marker-buffer pom)))
15952 (save-excursion
15953 (goto-char (or pom (point)))
15954 ,@body)))
15956 (defun org-get-property-block (&optional beg end force)
15957 "Return the (beg . end) range of the body of the property drawer.
15958 BEG and END can be beginning and end of subtree, if not given
15959 they will be found.
15960 If the drawer does not exist and FORCE is non-nil, create the drawer."
15961 (catch 'exit
15962 (save-excursion
15963 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15964 (end (or end (progn (outline-next-heading) (point)))))
15965 (goto-char beg)
15966 (if (re-search-forward org-property-start-re end t)
15967 (setq beg (1+ (match-end 0)))
15968 (if force
15969 (save-excursion
15970 (org-insert-property-drawer)
15971 (setq end (progn (outline-next-heading) (point))))
15972 (throw 'exit nil))
15973 (goto-char beg)
15974 (if (re-search-forward org-property-start-re end t)
15975 (setq beg (1+ (match-end 0)))))
15976 (if (re-search-forward org-property-end-re end t)
15977 (setq end (match-beginning 0))
15978 (or force (throw 'exit nil))
15979 (goto-char beg)
15980 (setq end beg)
15981 (org-indent-line-function)
15983 (cons beg end)))))
15985 (defun org-entry-properties (&optional pom which)
15986 "Get all properties of the entry at point-or-marker POM.
15987 This includes the TODO keyword, the tags, time strings for deadline,
15988 scheduled, and clocking, and any additional properties defined in the
15989 entry. The return value is an alist, keys may occur multiple times
15990 if the property key was used several times.
15991 POM may also be nil, in which case the current entry is used.
15992 If WHICH is nil or `all', get all properties. If WHICH is
15993 `special' or `standard', only get that subclass."
15994 (setq which (or which 'all))
15995 (org-with-point-at pom
15996 (let ((clockstr (substring org-clock-string 0 -1))
15997 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15998 beg end range props sum-props key value string clocksum)
15999 (save-excursion
16000 (when (condition-case nil (org-back-to-heading t) (error nil))
16001 (setq beg (point))
16002 (setq sum-props (get-text-property (point) 'org-summaries))
16003 (setq clocksum (get-text-property (point) :org-clock-minutes))
16004 (outline-next-heading)
16005 (setq end (point))
16006 (when (memq which '(all special))
16007 ;; Get the special properties, like TODO and tags
16008 (goto-char beg)
16009 (when (and (looking-at org-todo-line-regexp) (match-end 2))
16010 (push (cons "TODO" (org-match-string-no-properties 2)) props))
16011 (when (looking-at org-priority-regexp)
16012 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16013 (when (and (setq value (org-get-tags-string))
16015 (push (cons "TAGS" value) props))
16016 (when (setq value (org-get-tags-at))
16017 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16018 props))
16019 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16020 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16021 string (if (equal key clockstr)
16022 (org-no-properties
16023 (org-trim
16024 (buffer-substring
16025 (match-beginning 3) (goto-char (point-at-eol)))))
16026 (substring (org-match-string-no-properties 3) 1 -1)))
16027 (unless key
16028 (if (= (char-after (match-beginning 3)) ?\[)
16029 (setq key "TIMESTAMP_IA")
16030 (setq key "TIMESTAMP")))
16031 (when (or (equal key clockstr) (not (assoc key props)))
16032 (push (cons key string) props)))
16034 )
16036 (when (memq which '(all standard))
16037 ;; Get the standard properties, like :PORP: ...
16038 (setq range (org-get-property-block beg end))
16039 (when range
16040 (goto-char (car range))
16041 (while (re-search-forward
16043 (cdr range) t)
16044 (setq key (org-match-string-no-properties 1)
16045 value (org-trim (or (org-match-string-no-properties 2) "")))
16046 (unless (member key excluded)
16047 (push (cons key (or value "")) props)))))
16048 (if clocksum
16049 (push (cons "CLOCKSUM"
16050 (org-column-number-to-string (/ (float clocksum) 60.)
16051 'add_times))
16052 props))
16053 (append sum-props (nreverse props)))))))
16055 (defun org-entry-get (pom property &optional inherit)
16056 "Get value of PROPERTY for entry at point-or-marker POM.
16057 If INHERIT is non-nil and the entry does not have the property,
16058 then also check higher levels of the hierarchy.
16059 If the property is present but empty, the return value is the empty string.
16060 If the property is not present at all, nil is returned."
16061 (org-with-point-at pom
16062 (if inherit
16063 (org-entry-get-with-inheritance property)
16064 (if (member property org-special-properties)
16065 ;; We need a special property. Use brute force, get all properties.
16066 (cdr (assoc property (org-entry-properties nil 'special)))
16067 (let ((range (org-get-property-block)))
16068 (if (and range
16069 (goto-char (car range))
16070 (re-search-forward
16072 (cdr range) t))
16073 ;; Found the property, return it.
16074 (if (match-end 1)
16075 (org-match-string-no-properties 1)
16076 "")))))))
16078 (defun org-entry-delete (pom property)
16079 "Delete the property PROPERTY from entry at point-or-marker POM."
16080 (org-with-point-at pom
16081 (if (member property org-special-properties)
16082 nil ; cannot delete these properties.
16083 (let ((range (org-get-property-block)))
16084 (if (and range
16085 (goto-char (car range))
16086 (re-search-forward
16088 (cdr range) t))
16089 (progn
16090 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16091 t)
16092 nil)))))
16094 ;; Multi-values properties are properties that contain multiple values
16095 ;; These values are assumed to be single words, separated by whitespace.
16096 (defun org-entry-add-to-multivalued-property (pom property value)
16097 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16098 (let* ((old (org-entry-get pom property))
16100 (unless (member value values)
16101 (setq values (cons value values))
16102 (org-entry-put pom property
16103 (mapconcat 'identity values " ")))))
16105 (defun org-entry-remove-from-multivalued-property (pom property value)
16106 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16107 (let* ((old (org-entry-get pom property))
16109 (when (member value values)
16110 (setq values (delete value values))
16111 (org-entry-put pom property
16112 (mapconcat 'identity values " ")))))
16114 (defun org-entry-member-in-multivalued-property (pom property value)
16115 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16116 (let* ((old (org-entry-get pom property))
16118 (member value values)))
16120 (defvar org-entry-property-inherited-from (make-marker))
16122 (defun org-entry-get-with-inheritance (property)
16123 "Get entry property, and search higher levels if not present."
16124 (let (tmp)
16125 (save-excursion
16126 (save-restriction
16127 (widen)
16128 (catch 'ex
16129 (while t
16130 (when (setq tmp (org-entry-get nil property))
16131 (org-back-to-heading t)
16132 (move-marker org-entry-property-inherited-from (point))
16133 (throw 'ex tmp))
16134 (or (org-up-heading-safe) (throw 'ex nil)))))
16135 (or tmp (cdr (assoc property org-local-properties))
16136 (cdr (assoc property org-global-properties))))))
16138 (defun org-entry-put (pom property value)
16139 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16140 (org-with-point-at pom
16141 (org-back-to-heading t)
16142 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16143 range)
16144 (cond
16145 ((equal property "TODO")
16147 (not (member value org-todo-keywords-1)))
16149 (if (or (not value)
16151 (setq value 'none))
16152 (org-todo value)
16153 (org-set-tags nil 'align))
16154 ((equal property "PRIORITY")
16156 (string-to-char value) ?\ ))
16157 (org-set-tags nil 'align))
16158 ((equal property "SCHEDULED")
16159 (if (re-search-forward org-scheduled-time-regexp end t)
16160 (cond
16161 ((eq value 'earlier) (org-timestamp-change -1 'day))
16162 ((eq value 'later) (org-timestamp-change 1 'day))
16163 (t (call-interactively 'org-schedule)))
16164 (call-interactively 'org-schedule)))
16165 ((equal property "DEADLINE")
16166 (if (re-search-forward org-deadline-time-regexp end t)
16167 (cond
16168 ((eq value 'earlier) (org-timestamp-change -1 'day))
16169 ((eq value 'later) (org-timestamp-change 1 'day))
16170 (t (call-interactively 'org-deadline)))
16171 (call-interactively 'org-deadline)))
16172 ((member property org-special-properties)
16173 (error "The %s property can not yet be set with `org-entry-put'"
16174 property))
16175 (t ; a non-special property
16176 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16177 (setq range (org-get-property-block beg end 'force))
16178 (goto-char (car range))
16179 (if (re-search-forward
16181 (progn
16182 (delete-region (match-beginning 1) (match-end 1))
16183 (goto-char (match-beginning 1)))
16184 (goto-char (cdr range))
16186 (backward-char 1)
16187 (org-indent-line-function)
16188 (insert ":" property ":"))
16189 (and value (insert " " value))
16190 (org-indent-line-function)))))))
16192 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16193 "Get all property keys in the current buffer.
16194 With INCLUDE-SPECIALS, also list the special properties that relect things
16195 like tags and TODO state.
16196 With INCLUDE-DEFAULTS, also include properties that has special meaning
16197 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16198 With INCLUDE-COLUMNS, also include property names given in COLUMN
16199 formats in the current buffer."
16200 (let (rtn range cfmt cols s p)
16201 (save-excursion
16202 (save-restriction
16203 (widen)
16204 (goto-char (point-min))
16205 (while (re-search-forward org-property-start-re nil t)
16206 (setq range (org-get-property-block))
16207 (goto-char (car range))
16208 (while (re-search-forward
16210 (cdr range) t)
16211 (add-to-list 'rtn (org-match-string-no-properties 1)))
16212 (outline-next-heading))))
16214 (when include-specials
16215 (setq rtn (append org-special-properties rtn)))
16217 (when include-defaults
16218 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16220 (when include-columns
16221 (save-excursion
16222 (save-restriction
16223 (widen)
16224 (goto-char (point-min))
16225 (while (re-search-forward
16227 nil t)
16228 (setq cfmt (match-string 2) s 0)
16230 cfmt s)
16231 (setq s (match-end 0)
16232 p (match-string 1 cfmt))
16233 (unless (or (equal p "ITEM")
16234 (member p org-special-properties))
16235 (add-to-list 'rtn (match-string 1 cfmt))))))))
16237 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16239 (defun org-property-values (key)
16240 "Return a list of all values of property KEY."
16241 (save-excursion
16242 (save-restriction
16243 (widen)
16244 (goto-char (point-min))
16246 values)
16247 (while (re-search-forward re nil t)
16248 (add-to-list 'values (org-trim (match-string 1))))
16249 (delete "" values)))))
16251 (defun org-insert-property-drawer ()
16252 "Insert a property drawer into the current entry."
16253 (interactive)
16254 (org-back-to-heading t)
16255 (looking-at outline-regexp)
16256 (let ((indent (- (match-end 0)(match-beginning 0)))
16257 (beg (point))
16259 end hiddenp)
16260 (outline-next-heading)
16261 (setq end (point))
16262 (goto-char beg)
16263 (while (re-search-forward re end t))
16264 (setq hiddenp (org-invisible-p))
16265 (end-of-line 1)
16267 (org-skip-over-state-notes)
16269 (if (eq (char-before) ?*) (forward-char 1))
16271 (beginning-of-line 0)
16272 (indent-to-column indent)
16273 (beginning-of-line 2)
16274 (indent-to-column indent)
16275 (beginning-of-line 0)
16276 (if hiddenp
16277 (save-excursion
16278 (org-back-to-heading t)
16279 (hide-entry))
16280 (org-flag-drawer t))))
16282 (defun org-set-property (property value)
16283 "In the current entry, set PROPERTY to VALUE.
16284 When called interactively, this will prompt for a property name, offering
16285 completion on existing and default properties. And then it will prompt
16286 for a value, offering competion either on allowed values (via an inherited
16287 xxx_ALL property) or on existing values in other instances of this property
16288 in the current file."
16289 (interactive
16290 (let* ((prop (completing-read
16291 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16292 (cur (org-entry-get nil prop))
16293 (allowed (org-property-get-allowed-values nil prop 'table))
16294 (existing (mapcar 'list (org-property-values prop)))
16295 (val (if allowed
16296 (completing-read "Value: " allowed nil 'req-match)
16297 (completing-read
16299 (concat "[" cur "]") "")
16300 ": ")
16301 existing nil nil "" nil cur))))
16302 (list prop (if (equal val "") cur val))))
16303 (unless (equal (org-entry-get nil property) value)
16304 (org-entry-put nil property value)))
16306 (defun org-delete-property (property)
16307 "In the current entry, delete PROPERTY."
16308 (interactive
16309 (let* ((prop (completing-read
16310 "Property: " (org-entry-properties nil 'standard))))
16311 (list prop)))
16312 (message "Property %s %s" property
16313 (if (org-entry-delete nil property)
16314 "deleted"
16315 "was not present in the entry")))
16317 (defun org-delete-property-globally (property)
16318 "Remove PROPERTY globally, from all entries."
16319 (interactive
16320 (let* ((prop (completing-read
16321 "Globally remove property: "
16322 (mapcar 'list (org-buffer-property-keys)))))
16323 (list prop)))
16324 (save-excursion
16325 (save-restriction
16326 (widen)
16327 (goto-char (point-min))
16328 (let ((cnt 0))
16329 (while (re-search-forward
16331 nil t)
16332 (setq cnt (1+ cnt))
16333 (replace-match ""))
16336 (defvar org-columns-current-fmt-compiled) ; defined below
16338 (defun org-compute-property-at-point ()
16339 "Compute the property at point.
16340 This looks for an enclosing column format, extracts the operator and
16341 then applies it to the proerty in the column format's scope."
16342 (interactive)
16343 (unless (org-at-property-p)
16344 (error "Not at a property"))
16345 (let ((prop (org-match-string-no-properties 2)))
16346 (org-columns-get-format-and-top-level)
16347 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16348 (error "No operator defined for property %s" prop))
16349 (org-columns-compute prop)))
16351 (defun org-property-get-allowed-values (pom property &optional table)
16352 "Get allowed values for the property PROPERTY.
16353 When TABLE is non-nil, return an alist that can directly be used for
16354 completion."
16355 (let (vals)
16356 (cond
16357 ((equal property "TODO")
16358 (setq vals (org-with-point-at pom
16359 (append org-todo-keywords-1 '("")))))
16360 ((equal property "PRIORITY")
16361 (let ((n org-lowest-priority))
16362 (while (>= n org-highest-priority)
16363 (push (char-to-string n) vals)
16364 (setq n (1- n)))))
16365 ((member property org-special-properties))
16366 (t
16367 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16370 (setq vals (car (read-from-string (concat "(" vals ")"))))
16371 (setq vals (mapcar (lambda (x)
16372 (cond ((stringp x) x)
16373 ((numberp x) (number-to-string x))
16374 ((symbolp x) (symbol-name x))
16375 (t "???")))
16376 vals)))))
16377 (if table (mapcar 'list vals) vals)))
16379 (defun org-property-previous-allowed-value (&optional previous)
16380 "Switch to the next allowed value for this property."
16381 (interactive)
16382 (org-property-next-allowed-value t))
16384 (defun org-property-next-allowed-value (&optional previous)
16385 "Switch to the next allowed value for this property."
16386 (interactive)
16387 (unless (org-at-property-p)
16388 (error "Not at a property"))
16389 (let* ((key (match-string 2))
16390 (value (match-string 3))
16391 (allowed (or (org-property-get-allowed-values (point) key)
16392 (and (member value '("[ ]" "[-]" "[X]"))
16393 '("[ ]" "[X]"))))
16394 nval)
16395 (unless allowed
16396 (error "Allowed values for this property have not been defined"))
16397 (if previous (setq allowed (reverse allowed)))
16398 (if (member value allowed)
16399 (setq nval (car (cdr (member value allowed)))))
16400 (setq nval (or nval (car allowed)))
16401 (if (equal nval value)
16402 (error "Only one allowed value for this property"))
16403 (org-at-property-p)
16404 (replace-match (concat " :" key ": " nval) t t)
16405 (org-indent-line-function)
16406 (beginning-of-line 1)
16409 (defun org-find-entry-with-id (ident)
16410 "Locate the entry that contains the ID property with exact value IDENT.
16411 IDENT can be a string, a symbol or a number, this function will search for
16412 the string representation of it.
16413 Return the position where this entry starts, or nil if there is no such entry."
16414 (let ((id (cond
16415 ((stringp ident) ident)
16416 ((symbol-name ident) (symbol-name ident))
16417 ((numberp ident) (number-to-string ident))
16418 (t (error "IDENT %s must be a string, symbol or number" ident))))
16419 (case-fold-search nil))
16420 (save-excursion
16421 (save-restriction
16422 (goto-char (point-min))
16423 (when (re-search-forward
16425 nil t)
16426 (org-back-to-heading)
16427 (point))))))
16429 ;;; Column View
16431 (defvar org-columns-overlays nil
16432 "Holds the list of current column overlays.")
16434 (defvar org-columns-current-fmt nil
16435 "Local variable, holds the currently active column format.")
16436 (defvar org-columns-current-fmt-compiled nil
16437 "Local variable, holds the currently active column format.
16438 This is the compiled version of the format.")
16439 (defvar org-columns-current-widths nil
16440 "Loval variable, holds the currently widths of fields.")
16441 (defvar org-columns-current-maxwidths nil
16442 "Loval variable, holds the currently active maximum column widths.")
16443 (defvar org-columns-begin-marker (make-marker)
16444 "Points to the position where last a column creation command was called.")
16445 (defvar org-columns-top-level-marker (make-marker)
16446 "Points to the position where current columns region starts.")
16448 (defvar org-columns-map (make-sparse-keymap)
16449 "The keymap valid in column display.")
16451 (defun org-columns-content ()
16452 "Switch to contents view while in columns view."
16453 (interactive)
16454 (org-overview)
16455 (org-content))
16457 (org-defkey org-columns-map "c" 'org-columns-content)
16458 (org-defkey org-columns-map "o" 'org-overview)
16459 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16460 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16461 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16462 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16463 (org-defkey org-columns-map "v" 'org-columns-show-value)
16464 (org-defkey org-columns-map "q" 'org-columns-quit)
16465 (org-defkey org-columns-map "r" 'org-columns-redo)
16466 (org-defkey org-columns-map "g" 'org-columns-redo)
16467 (org-defkey org-columns-map [left] 'backward-char)
16468 (org-defkey org-columns-map "\M-b" 'backward-char)
16469 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16470 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16471 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16472 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16473 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16474 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16475 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16476 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16477 (org-defkey org-columns-map "<" 'org-columns-narrow)
16478 (org-defkey org-columns-map ">" 'org-columns-widen)
16479 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16480 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16481 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16482 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16484 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16485 '("Column"
16486 ["Edit property" org-columns-edit-value t]
16487 ["Next allowed value" org-columns-next-allowed-value t]
16488 ["Previous allowed value" org-columns-previous-allowed-value t]
16489 ["Show full value" org-columns-show-value t]
16490 ["Edit allowed values" org-columns-edit-allowed t]
16491 "--"
16492 ["Edit column attributes" org-columns-edit-attributes t]
16493 ["Increase column width" org-columns-widen t]
16494 ["Decrease column width" org-columns-narrow t]
16495 "--"
16496 ["Move column right" org-columns-move-right t]
16497 ["Move column left" org-columns-move-left t]
16498 ["Add column" org-columns-new t]
16499 ["Delete column" org-columns-delete t]
16500 "--"
16501 ["CONTENTS" org-columns-content t]
16502 ["OVERVIEW" org-overview t]
16503 ["Refresh columns display" org-columns-redo t]
16504 "--"
16505 ["Open link" org-columns-open-link t]
16506 "--"
16507 ["Quit" org-columns-quit t]))
16509 (defun org-columns-new-overlay (beg end &optional string face)
16510 "Create a new column overlay and add it to the list."
16511 (let ((ov (org-make-overlay beg end)))
16512 (org-overlay-put ov 'face (or face 'secondary-selection))
16513 (org-overlay-display ov string face)
16514 (push ov org-columns-overlays)
16515 ov))
16517 (defun org-columns-display-here (&optional props)
16518 "Overlay the current line with column display."
16519 (interactive)
16520 (let* ((fmt org-columns-current-fmt-compiled)
16521 (beg (point-at-bol))
16522 (level-face (save-excursion
16523 (beginning-of-line 1)
16525 (org-get-level-face 2))))
16526 (color (list :foreground
16527 (face-attribute (or level-face 'default) :foreground)))
16528 props pom property ass width f string ov column val modval)
16529 ;; Check if the entry is in another buffer.
16530 (unless props
16531 (if (eq major-mode 'org-agenda-mode)
16532 (setq pom (or (get-text-property (point) 'org-hd-marker)
16533 (get-text-property (point) 'org-marker))
16534 props (if pom (org-entry-properties pom) nil))
16535 (setq props (org-entry-properties nil))))
16536 ;; Walk the format
16537 (while (setq column (pop fmt))
16538 (setq property (car column)
16539 ass (if (equal property "ITEM")
16540 (cons "ITEM"
16541 (save-match-data
16542 (org-no-properties
16543 (org-remove-tabs
16544 (buffer-substring-no-properties
16545 (point-at-bol) (point-at-eol))))))
16546 (assoc property props))
16547 width (or (cdr (assoc property org-columns-current-maxwidths))
16548 (nth 2 column)
16549 (length property))
16550 f (format "%%-%d.%ds | " width width)
16551 val (or (cdr ass) "")
16552 modval (if (equal property "ITEM")
16553 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16554 string (format f (or modval val)))
16555 ;; Create the overlay
16556 (org-unmodified
16557 (setq ov (org-columns-new-overlay
16558 beg (setq beg (1+ beg)) string
16559 (list color 'org-column)))
16560 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16561 (org-overlay-put ov 'keymap org-columns-map)
16562 (org-overlay-put ov 'org-columns-key property)
16563 (org-overlay-put ov 'org-columns-value (cdr ass))
16564 (org-overlay-put ov 'org-columns-value-modified modval)
16565 (org-overlay-put ov 'org-columns-pom pom)
16566 (org-overlay-put ov 'org-columns-format f))
16567 (if (or (not (char-after beg))
16569 (let ((inhibit-read-only t))
16570 (save-excursion
16571 (goto-char beg)
16572 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16573 ;; Make the rest of the line disappear.
16574 (org-unmodified
16575 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16576 (org-overlay-put ov 'invisible t)
16577 (org-overlay-put ov 'keymap org-columns-map)
16578 (org-overlay-put ov 'intangible t)
16579 (push ov org-columns-overlays)
16580 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16581 (org-overlay-put ov 'keymap org-columns-map)
16582 (push ov org-columns-overlays)
16583 (let ((inhibit-read-only t))
16584 (put-text-property (max (point-min) (1- (point-at-bol)))
16585 (min (point-max) (1+ (point-at-eol)))
16586 'read-only "Type `e' to edit property")))))
16588 (defvar org-previous-header-line-format nil
16589 "The header line format before column view was turned on.")
16590 (defvar org-columns-inhibit-recalculation nil
16591 "Inhibit recomputing of columns on column view startup.")
16594 (defvar header-line-format)
16595 (defun org-columns-display-here-title ()
16596 "Overlay the newline before the current line with the table title."
16597 (interactive)
16598 (let ((fmt org-columns-current-fmt-compiled)
16599 string (title "")
16600 property width f column str widths)
16601 (while (setq column (pop fmt))
16602 (setq property (car column)
16603 str (or (nth 1 column) property)
16604 width (or (cdr (assoc property org-columns-current-maxwidths))
16605 (nth 2 column)
16606 (length str))
16607 widths (push width widths)
16608 f (format "%%-%d.%ds | " width width)
16609 string (format f str)
16610 title (concat title string)))
16611 (setq title (concat
16612 (org-add-props " " nil 'display '(space :align-to 0))
16613 (org-add-props title nil 'face '(:weight bold :underline t))))
16614 (org-set-local 'org-previous-header-line-format header-line-format)
16615 (org-set-local 'org-columns-current-widths (nreverse widths))
16616 (setq header-line-format title)))
16618 (defun org-columns-remove-overlays ()
16619 "Remove all currently active column overlays."
16620 (interactive)
16621 (when (marker-buffer org-columns-begin-marker)
16622 (with-current-buffer (marker-buffer org-columns-begin-marker)
16623 (when (local-variable-p 'org-previous-header-line-format)
16624 (setq header-line-format org-previous-header-line-format)
16625 (kill-local-variable 'org-previous-header-line-format))
16626 (move-marker org-columns-begin-marker nil)
16627 (move-marker org-columns-top-level-marker nil)
16628 (org-unmodified
16629 (mapc 'org-delete-overlay org-columns-overlays)
16630 (setq org-columns-overlays nil)
16631 (let ((inhibit-read-only t))
16632 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16634 (defun org-columns-cleanup-item (item fmt)
16635 "Remove from ITEM what is a column in the format FMT."
16636 (if (not org-complex-heading-regexp)
16637 item
16638 (when (string-match org-complex-heading-regexp item)
16639 (concat
16640 (org-add-props (concat (match-string 1 item) " ") nil
16641 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16642 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16643 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16644 " " (match-string 4 item)
16645 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16647 (defun org-columns-show-value ()
16648 "Show the full value of the property."
16649 (interactive)
16650 (let ((value (get-char-property (point) 'org-columns-value)))
16651 (message "Value is: %s" (or value ""))))
16653 (defun org-columns-quit ()
16654 "Remove the column overlays and in this way exit column editing."
16655 (interactive)
16656 (org-unmodified
16657 (org-columns-remove-overlays)
16658 (let ((inhibit-read-only t))
16659 (remove-text-properties (point-min) (point-max) '(read-only t))))
16660 (when (eq major-mode 'org-agenda-mode)
16661 (message
16662 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16664 (defun org-columns-check-computed ()
16665 "Check if this column value is computed.
16666 If yes, throw an error indicating that changing it does not make sense."
16667 (let ((val (get-char-property (point) 'org-columns-value)))
16668 (when (and (stringp val)
16669 (get-char-property 0 'org-computed val))
16670 (error "This value is computed from the entry's children"))))
16672 (defun org-columns-todo (&optional arg)
16673 "Change the TODO state during column view."
16674 (interactive "P")
16675 (org-columns-edit-value "TODO"))
16677 (defun org-columns-set-tags-or-toggle (&optional arg)
16678 "Toggle checkbox at point, or set tags for current headline."
16679 (interactive "P")
16681 (get-char-property (point) 'org-columns-value))
16682 (org-columns-next-allowed-value)
16683 (org-columns-edit-value "TAGS")))
16685 (defun org-columns-edit-value (&optional key)
16686 "Edit the value of the property at point in column view.
16687 Where possible, use the standard interface for changing this line."
16688 (interactive)
16689 (org-columns-check-computed)
16690 (let* ((external-key key)
16691 (col (current-column))
16692 (key (or key (get-char-property (point) 'org-columns-key)))
16693 (value (get-char-property (point) 'org-columns-value))
16694 (bol (point-at-bol)) (eol (point-at-eol))
16695 (pom (or (get-text-property bol 'org-hd-marker)
16696 (point))) ; keep despite of compiler waring
16697 (line-overlays
16698 (delq nil (mapcar (lambda (x)
16699 (and (eq (overlay-buffer x) (current-buffer))
16700 (>= (overlay-start x) bol)
16701 (<= (overlay-start x) eol)
16702 x))
16703 org-columns-overlays)))
16704 nval eval allowed)
16705 (cond
16706 ((equal key "CLOCKSUM")
16707 (error "This special column cannot be edited"))
16708 ((equal key "ITEM")
16709 (setq eval '(org-with-point-at pom
16710 (org-edit-headline))))
16711 ((equal key "TODO")
16712 (setq eval '(org-with-point-at pom
16713 (let ((current-prefix-arg
16714 (if external-key current-prefix-arg '(4))))
16715 (call-interactively 'org-todo)))))
16716 ((equal key "PRIORITY")
16717 (setq eval '(org-with-point-at pom
16718 (call-interactively 'org-priority))))
16719 ((equal key "TAGS")
16720 (setq eval '(org-with-point-at pom
16721 (let ((org-fast-tag-selection-single-key
16722 (if (eq org-fast-tag-selection-single-key 'expert)
16723 t org-fast-tag-selection-single-key)))
16724 (call-interactively 'org-set-tags)))))
16725 ((equal key "DEADLINE")
16726 (setq eval '(org-with-point-at pom
16727 (call-interactively 'org-deadline))))
16728 ((equal key "SCHEDULED")
16729 (setq eval '(org-with-point-at pom
16730 (call-interactively 'org-schedule))))
16731 (t
16732 (setq allowed (org-property-get-allowed-values pom key 'table))
16733 (if allowed
16734 (setq nval (completing-read "Value: " allowed nil t))
16735 (setq nval (read-string "Edit: " value)))
16736 (setq nval (org-trim nval))
16737 (when (not (equal nval value))
16738 (setq eval '(org-entry-put pom key nval)))))
16739 (when eval
16740 (let ((inhibit-read-only t))
16741 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16742 (unwind-protect
16743 (progn
16744 (setq org-columns-overlays
16745 (org-delete-all line-overlays org-columns-overlays))
16746 (mapc 'org-delete-overlay line-overlays)
16747 (org-columns-eval eval))
16748 (org-columns-display-here))))
16749 (move-to-column col)
16750 (if (and (org-mode-p)
16751 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16752 (org-columns-update key))))
16754 (defun org-edit-headline () ; FIXME: this is not columns specific
16755 "Edit the current headline, the part without TODO keyword, TAGS."
16756 (org-back-to-heading)
16757 (when (looking-at org-todo-line-regexp)
16758 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16759 (txt (match-string 3))
16760 (post "")
16761 txt2)
16763 (setq post (match-string 0 txt)
16764 txt (substring txt 0 (match-beginning 0))))
16765 (setq txt2 (read-string "Edit: " txt))
16766 (when (not (equal txt txt2))
16767 (beginning-of-line 1)
16768 (insert pre txt2 post)
16769 (delete-region (point) (point-at-eol))
16770 (org-set-tags nil t)))))
16772 (defun org-columns-edit-allowed ()
16773 "Edit the list of allowed values for the current property."
16774 (interactive)
16775 (let* ((key (get-char-property (point) 'org-columns-key))
16776 (key1 (concat key "_ALL"))
16777 (allowed (org-entry-get (point) key1 t))
16778 nval)
16779 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16780 (setq nval (read-string "Allowed: " allowed))
16781 (org-entry-put
16782 (cond ((marker-position org-entry-property-inherited-from)
16783 org-entry-property-inherited-from)
16784 ((marker-position org-columns-top-level-marker)
16785 org-columns-top-level-marker))
16786 key1 nval)))
16788 (defmacro org-no-warnings (&rest body)
16789 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16791 (defun org-columns-eval (form)
16792 (let (hidep)
16793 (save-excursion
16794 (beginning-of-line 1)
16795 ;; `next-line' is needed here, because it skips invisible line.
16796 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16797 (setq hidep (org-on-heading-p 1)))
16798 (eval form)
16799 (and hidep (hide-entry))))
16801 (defun org-columns-previous-allowed-value ()
16802 "Switch to the previous allowed value for this column."
16803 (interactive)
16804 (org-columns-next-allowed-value t))
16806 (defun org-columns-next-allowed-value (&optional previous)
16807 "Switch to the next allowed value for this column."
16808 (interactive)
16809 (org-columns-check-computed)
16810 (let* ((col (current-column))
16811 (key (get-char-property (point) 'org-columns-key))
16812 (value (get-char-property (point) 'org-columns-value))
16813 (bol (point-at-bol)) (eol (point-at-eol))
16814 (pom (or (get-text-property bol 'org-hd-marker)
16815 (point))) ; keep despite of compiler waring
16816 (line-overlays
16817 (delq nil (mapcar (lambda (x)
16818 (and (eq (overlay-buffer x) (current-buffer))
16819 (>= (overlay-start x) bol)
16820 (<= (overlay-start x) eol)
16821 x))
16822 org-columns-overlays)))
16823 (allowed (or (org-property-get-allowed-values pom key)
16824 (and (memq
16825 (nth 4 (assoc key org-columns-current-fmt-compiled))
16826 '(checkbox checkbox-n-of-m checkbox-percent))
16827 '("[ ]" "[X]"))))
16828 nval)
16829 (when (equal key "ITEM")
16830 (error "Cannot edit item headline from here"))
16831 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16832 (error "Allowed values for this property have not been defined"))
16833 (if (member key '("SCHEDULED" "DEADLINE"))
16834 (setq nval (if previous 'earlier 'later))
16835 (if previous (setq allowed (reverse allowed)))
16836 (if (member value allowed)
16837 (setq nval (car (cdr (member value allowed)))))
16838 (setq nval (or nval (car allowed)))
16839 (if (equal nval value)
16840 (error "Only one allowed value for this property")))
16841 (let ((inhibit-read-only t))
16842 (remove-text-properties (1- bol) eol '(read-only t))
16843 (unwind-protect
16844 (progn
16845 (setq org-columns-overlays
16846 (org-delete-all line-overlays org-columns-overlays))
16847 (mapc 'org-delete-overlay line-overlays)
16848 (org-columns-eval '(org-entry-put pom key nval)))
16849 (org-columns-display-here)))
16850 (move-to-column col)
16851 (if (and (org-mode-p)
16852 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16853 (org-columns-update key))))
16855 (defun org-verify-version (task)
16856 (cond
16857 ((eq task 'columns)
16858 (if (or (featurep 'xemacs)
16859 (< emacs-major-version 22))
16860 (error "Emacs 22 is required for the columns feature")))))
16862 (defun org-columns-open-link (&optional arg)
16863 (interactive "P")
16864 (let ((value (get-char-property (point) 'org-columns-value)))
16865 (org-open-link-from-string value arg)))
16867 (defun org-open-link-from-string (s &optional arg)
16868 "Open a link in the string S, as if it was in Org-mode."
16869 (interactive)
16870 (with-temp-buffer
16871 (let ((org-inhibit-startup t))
16872 (org-mode)
16873 (insert s)
16874 (goto-char (point-min))
16875 (org-open-at-point arg))))
16877 (defun org-columns-get-format-and-top-level ()
16878 (let (fmt)
16879 (when (condition-case nil (org-back-to-heading) (error nil))
16880 (move-marker org-entry-property-inherited-from nil)
16881 (setq fmt (org-entry-get nil "COLUMNS" t)))
16882 (setq fmt (or fmt org-columns-default-format))
16883 (org-set-local 'org-columns-current-fmt fmt)
16884 (org-columns-compile-format fmt)
16885 (if (marker-position org-entry-property-inherited-from)
16886 (move-marker org-columns-top-level-marker
16887 org-entry-property-inherited-from)
16888 (move-marker org-columns-top-level-marker (point)))
16889 fmt))
16891 (defun org-columns ()
16892 "Turn on column view on an org-mode file."
16893 (interactive)
16894 (org-verify-version 'columns)
16895 (org-columns-remove-overlays)
16896 (move-marker org-columns-begin-marker (point))
16897 (let (beg end fmt cache maxwidths)
16898 (setq fmt (org-columns-get-format-and-top-level))
16899 (save-excursion
16900 (goto-char org-columns-top-level-marker)
16901 (setq beg (point))
16902 (unless org-columns-inhibit-recalculation
16903 (org-columns-compute-all))
16904 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16905 (point-max)))
16906 ;; Get and cache the properties
16907 (goto-char beg)
16908 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16909 (save-excursion
16910 (save-restriction
16911 (narrow-to-region beg end)
16912 (org-clock-sum))))
16913 (while (re-search-forward (concat "^" outline-regexp) end t)
16914 (push (cons (org-current-line) (org-entry-properties)) cache))
16915 (when cache
16916 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16917 (org-set-local 'org-columns-current-maxwidths maxwidths)
16918 (org-columns-display-here-title)
16919 (mapc (lambda (x)
16920 (goto-line (car x))
16921 (org-columns-display-here (cdr x)))
16922 cache)))))
16924 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16925 "Insert a new column, to the leeft o the current column."
16926 (interactive)
16927 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16928 cell)
16929 (setq prop (completing-read
16930 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
16931 nil nil prop))
16932 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16933 (setq width (read-string "Column width: " (if width (number-to-string width))))
16935 (setq width (string-to-number width))
16936 (setq width nil))
16937 (setq fmt (completing-read "Summary [none]: "
16938 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
16939 nil t))
16941 (setq fmt (intern fmt))
16942 (setq fmt nil))
16943 (if (eq fmt 'none) (setq fmt nil))
16944 (if editp
16945 (progn
16946 (setcar editp prop)
16947 (setcdr editp (list title width nil fmt)))
16948 (setq cell (nthcdr (1- (current-column))
16949 org-columns-current-fmt-compiled))
16950 (setcdr cell (cons (list prop title width nil fmt)
16951 (cdr cell))))
16952 (org-columns-store-format)
16953 (org-columns-redo)))
16955 (defun org-columns-delete ()
16956 "Delete the column at point from columns view."
16957 (interactive)
16958 (let* ((n (current-column))
16959 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16960 (when (y-or-n-p
16962 (setq org-columns-current-fmt-compiled
16963 (delq (nth n org-columns-current-fmt-compiled)
16964 org-columns-current-fmt-compiled))
16965 (org-columns-store-format)
16966 (org-columns-redo)
16967 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16968 (backward-char 1)))))
16970 (defun org-columns-edit-attributes ()
16971 "Edit the attributes of the current column."
16972 (interactive)
16973 (let* ((n (current-column))
16974 (info (nth n org-columns-current-fmt-compiled)))
16975 (apply 'org-columns-new info)))
16977 (defun org-columns-widen (arg)
16978 "Make the column wider by ARG characters."
16979 (interactive "p")
16980 (let* ((n (current-column))
16981 (entry (nth n org-columns-current-fmt-compiled))
16982 (width (or (nth 2 entry)
16983 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16984 (setq width (max 1 (+ width arg)))
16985 (setcar (nthcdr 2 entry) width)
16986 (org-columns-store-format)
16987 (org-columns-redo)))
16989 (defun org-columns-narrow (arg)
16990 "Make the column nrrower by ARG characters."
16991 (interactive "p")
16992 (org-columns-widen (- arg)))
16994 (defun org-columns-move-right ()
16995 "Swap this column with the one to the right."
16996 (interactive)
16997 (let* ((n (current-column))
16998 (cell (nthcdr n org-columns-current-fmt-compiled))
16999 e)
17000 (when (>= n (1- (length org-columns-current-fmt-compiled)))
17001 (error "Cannot shift this column further to the right"))
17002 (setq e (car cell))
17003 (setcar cell (car (cdr cell)))
17004 (setcdr cell (cons e (cdr (cdr cell))))
17005 (org-columns-store-format)
17006 (org-columns-redo)
17007 (forward-char 1)))
17009 (defun org-columns-move-left ()
17010 "Swap this column with the one to the left."
17011 (interactive)
17012 (let* ((n (current-column)))
17013 (when (= n 0)
17014 (error "Cannot shift this column further to the left"))
17015 (backward-char 1)
17016 (org-columns-move-right)
17017 (backward-char 1)))
17019 (defun org-columns-store-format ()
17020 "Store the text version of the current columns format in appropriate place.
17021 This is either in the COLUMNS property of the node starting the current column
17022 display, or in the #+COLUMNS line of the current buffer."
17023 (let (fmt (cnt 0))
17024 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17025 (org-set-local 'org-columns-current-fmt fmt)
17026 (if (marker-position org-columns-top-level-marker)
17027 (save-excursion
17028 (goto-char org-columns-top-level-marker)
17029 (if (and (org-at-heading-p)
17030 (org-entry-get nil "COLUMNS"))
17031 (org-entry-put nil "COLUMNS" fmt)
17032 (goto-char (point-min))
17033 ;; Overwrite all #+COLUMNS lines....
17035 (setq cnt (1+ cnt))
17036 (replace-match (concat "#+COLUMNS: " fmt) t t))
17037 (unless (> cnt 0)
17038 (goto-char (point-min))
17039 (or (org-on-heading-p t) (outline-next-heading))
17040 (let ((inhibit-read-only t))
17042 (org-set-local 'org-columns-default-format fmt))))))
17044 (defvar org-overriding-columns-format nil
17045 "When set, overrides any other definition.")
17046 (defvar org-agenda-view-columns-initially nil
17047 "When set, switch to columns view immediately after creating the agenda.")
17049 (defun org-agenda-columns ()
17050 "Turn on column view in the agenda."
17051 (interactive)
17052 (org-verify-version 'columns)
17053 (org-columns-remove-overlays)
17054 (move-marker org-columns-begin-marker (point))
17055 (let (fmt cache maxwidths m)
17056 (cond
17057 ((and (local-variable-p 'org-overriding-columns-format)
17058 org-overriding-columns-format)
17059 (setq fmt org-overriding-columns-format))
17060 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17061 (setq fmt (org-entry-get m "COLUMNS" t)))
17062 ((and (boundp 'org-columns-current-fmt)
17063 (local-variable-p 'org-columns-current-fmt)
17064 org-columns-current-fmt)
17065 (setq fmt org-columns-current-fmt))
17066 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17067 (setq m (get-text-property m 'org-hd-marker))
17068 (setq fmt (org-entry-get m "COLUMNS" t))))
17069 (setq fmt (or fmt org-columns-default-format))
17070 (org-set-local 'org-columns-current-fmt fmt)
17071 (org-columns-compile-format fmt)
17072 (save-excursion
17073 ;; Get and cache the properties
17074 (goto-char (point-min))
17075 (while (not (eobp))
17076 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17077 (get-text-property (point) 'org-marker)))
17078 (push (cons (org-current-line) (org-entry-properties m)) cache))
17079 (beginning-of-line 2))
17080 (when cache
17081 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17082 (org-set-local 'org-columns-current-maxwidths maxwidths)
17083 (org-columns-display-here-title)
17084 (mapc (lambda (x)
17085 (goto-line (car x))
17086 (org-columns-display-here (cdr x)))
17087 cache)))))
17089 (defun org-columns-get-autowidth-alist (s cache)
17090 "Derive the maximum column widths from the format and the cache."
17091 (let ((start 0) rtn)
17093 (push (cons (match-string 1 s) 1) rtn)
17094 (setq start (match-end 0)))
17095 (mapc (lambda (x)
17096 (setcdr x (apply 'max
17097 (mapcar
17098 (lambda (y)
17099 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17100 cache))))
17101 rtn)
17102 rtn))
17104 (defun org-columns-compute-all ()
17105 "Compute all columns that have operators defined."
17106 (org-unmodified
17107 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17108 (let ((columns org-columns-current-fmt-compiled) col)
17109 (while (setq col (pop columns))
17110 (when (nth 3 col)
17111 (save-excursion
17112 (org-columns-compute (car col)))))))
17114 (defun org-columns-update (property)
17115 "Recompute PROPERTY, and update the columns display for it."
17116 (org-columns-compute property)
17117 (let (fmt val pos)
17118 (save-excursion
17119 (mapc (lambda (ov)
17120 (when (equal (org-overlay-get ov 'org-columns-key) property)
17121 (setq pos (org-overlay-start ov))
17122 (goto-char pos)
17123 (when (setq val (cdr (assoc property
17124 (get-text-property
17125 (point-at-bol) 'org-summaries))))
17126 (setq fmt (org-overlay-get ov 'org-columns-format))
17127 (org-overlay-put ov 'org-columns-value val)
17128 (org-overlay-put ov 'display (format fmt val)))))
17129 org-columns-overlays))))
17131 (defun org-columns-compute (property)
17132 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17133 (interactive)
17134 (let* ((re (concat "^" outline-regexp))
17135 (lmax 30) ; Does anyone use deeper levels???
17136 (lsum (make-vector lmax 0))
17137 (lflag (make-vector lmax nil))
17138 (level 0)
17139 (ass (assoc property org-columns-current-fmt-compiled))
17140 (format (nth 4 ass))
17141 (printf (nth 5 ass))
17142 (beg org-columns-top-level-marker)
17143 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17144 (save-excursion
17145 ;; Find the region to compute
17146 (goto-char beg)
17147 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17148 (goto-char end)
17149 ;; Walk the tree from the back and do the computations
17150 (while (re-search-backward re beg t)
17151 (setq sumpos (match-beginning 0)
17152 last-level level
17153 level (org-outline-level)
17154 val (org-entry-get nil property)
17156 (cond
17157 ((< level last-level)
17158 ;; put the sum of lower levels here as a property
17159 (setq sum (aref lsum last-level) ; current sum
17160 flag (aref lflag last-level) ; any valid entries from children?
17161 str (org-column-number-to-string sum format printf)
17162 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17163 useval (if flag str1 (if valflag val ""))
17164 sum-alist (get-text-property sumpos 'org-summaries))
17165 (if (assoc property sum-alist)
17166 (setcdr (assoc property sum-alist) useval)
17167 (push (cons property useval) sum-alist)
17168 (org-unmodified
17169 (add-text-properties sumpos (1+ sumpos)
17170 (list 'org-summaries sum-alist))))
17171 (when val
17172 (org-entry-put nil property (if flag str val)))
17173 ;; add current to current level accumulator
17174 (when (or flag valflag)
17175 (aset lsum level (+ (aref lsum level)
17176 (if flag sum (org-column-string-to-number
17177 (if flag str val) format))))
17178 (aset lflag level t))
17179 ;; clear accumulators for deeper levels
17180 (loop for l from (1+ level) to (1- lmax) do
17181 (aset lsum l 0)
17182 (aset lflag l nil)))
17183 ((>= level last-level)
17184 ;; add what we have here to the accumulator for this level
17185 (aset lsum level (+ (aref lsum level)
17186 (org-column-string-to-number (or val "0") format)))
17187 (and valflag (aset lflag level t)))
17188 (t (error "This should not happen")))))))
17190 (defun org-columns-redo ()
17191 "Construct the column display again."
17192 (interactive)
17193 (message "Recomputing columns...")
17194 (save-excursion
17195 (if (marker-position org-columns-begin-marker)
17196 (goto-char org-columns-begin-marker))
17197 (org-columns-remove-overlays)
17198 (if (org-mode-p)
17199 (call-interactively 'org-columns)
17200 (call-interactively 'org-agenda-columns)))
17201 (message "Recomputing columns...done"))
17203 (defun org-columns-not-in-agenda ()
17204 (if (eq major-mode 'org-agenda-mode)
17205 (error "This command is only allowed in Org-mode buffers")))
17208 (defun org-string-to-number (s)
17209 "Convert string to number, and interpret hh:mm:ss."
17210 (if (not (string-match ":" s))
17211 (string-to-number s)
17212 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17213 (while l
17214 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17215 sum)))
17217 (defun org-column-number-to-string (n fmt &optional printf)
17218 "Convert a computed column number to a string value, according to FMT."
17219 (cond
17220 ((eq fmt 'add_times)
17221 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17222 (format "%d:%02d" h m)))
17223 ((eq fmt 'checkbox)
17224 (cond ((= n (floor n)) "[X]")
17225 ((> n 1.) "[-]")
17226 (t "[ ]")))
17227 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17228 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17229 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17230 (printf (format printf n))
17231 ((eq fmt 'currency)
17232 (format "%.2f" n))
17233 (t (number-to-string n))))
17235 (defun org-nofm-to-completion (n m &optional percent)
17236 (if (not percent)
17237 (format "[%d/%d]" n m)
17238 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17240 (defun org-column-string-to-number (s fmt)
17241 "Convert a column value to a number that can be used for column computing."
17242 (cond
17243 ((string-match ":" s)
17244 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17245 (while l
17246 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17247 sum))
17248 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17249 (if (equal s "[X]") 1. 0.000001))
17250 (t (string-to-number s))))
17252 (defun org-columns-uncompile-format (cfmt)
17253 "Turn the compiled columns format back into a string representation."
17254 (let ((rtn "") e s prop title op width fmt printf)
17255 (while (setq e (pop cfmt))
17256 (setq prop (car e)
17257 title (nth 1 e)
17258 width (nth 2 e)
17259 op (nth 3 e)
17260 fmt (nth 4 e)
17261 printf (nth 5 e))
17262 (cond
17263 ((eq fmt 'add_times) (setq op ":"))
17264 ((eq fmt 'checkbox) (setq op "X"))
17265 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17266 ((eq fmt 'checkbox-percent) (setq op "X%"))
17267 ((eq fmt 'add_numbers) (setq op "+"))
17268 ((eq fmt 'currency) (setq op "$")))
17269 (if (and op printf) (setq op (concat op ";" printf)))
17270 (if (equal title prop) (setq title nil))
17271 (setq s (concat "%" (if width (number-to-string width))
17272 prop
17273 (if title (concat "(" title ")"))
17274 (if op (concat "{" op "}"))))
17275 (setq rtn (concat rtn " " s)))
17276 (org-trim rtn)))
17278 (defun org-columns-compile-format (fmt)
17279 "Turn a column format string into an alist of specifications.
17280 The alist has one entry for each column in the format. The elements of
17281 that list are:
17282 property the property
17283 title the title field for the columns
17284 width the column width in characters, can be nil for automatic
17285 operator the operator if any
17286 format the output format for computed results, derived from operator
17287 printf a printf format for computed values"
17288 (let ((start 0) width prop title op f printf)
17289 (setq org-columns-current-fmt-compiled nil)
17290 (while (string-match
17291 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17292 fmt start)
17293 (setq start (match-end 0)
17294 width (match-string 1 fmt)
17295 prop (match-string 2 fmt)
17296 title (or (match-string 3 fmt) prop)
17297 op (match-string 4 fmt)
17298 f nil
17299 printf nil)
17300 (if width (setq width (string-to-number width)))
17301 (when (and op (string-match ";" op))
17302 (setq printf (substring op (match-end 0))
17303 op (substring op 0 (match-beginning 0))))
17304 (cond
17305 ((equal op "+") (setq f 'add_numbers))
17306 ((equal op "$") (setq f 'currency))
17307 ((equal op ":") (setq f 'add_times))
17308 ((equal op "X") (setq f 'checkbox))
17309 ((equal op "X/") (setq f 'checkbox-n-of-m))
17310 ((equal op "X%") (setq f 'checkbox-percent))
17311 )
17312 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17313 (setq org-columns-current-fmt-compiled
17314 (nreverse org-columns-current-fmt-compiled))))
17317 ;;; Dynamic block for Column view
17319 (defun org-columns-capture-view ()
17320 "Get the column view of the current buffer and return it as a list.
17321 The list will contains the title row and all other rows. Each row is
17322 a list of fields."
17323 (save-excursion
17324 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17325 (n (length title)) row tbl)
17326 (goto-char (point-min))
17328 (when (get-char-property (match-beginning 0) 'org-columns-key)
17329 (setq row nil)
17330 (loop for i from 0 to (1- n) do
17331 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17332 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17333 "")
17334 row))
17335 (setq row (nreverse row))
17336 (push row tbl)))
17337 (append (list title 'hline) (nreverse tbl)))))
17339 (defun org-dblock-write:columnview (params)
17340 "Write the column view table.
17341 PARAMS is a property list of parameters:
17343 :width enforce same column widths with <N> specifiers.
17344 :id the :ID: property of the entry where the columns view
17345 should be built, as a string. When `local', call locally.
17346 When `global' call column view with the cursor at the beginning
17347 of the buffer (usually this means that the whole buffer switches
17348 to column view).
17349 :hlines When t, insert a hline before each item. When a number, insert
17350 a hline before each level <= that number.
17351 :vlines When t, make each column a colgroup to enforce vertical lines."
17352 (let ((pos (move-marker (make-marker) (point)))
17353 (hlines (plist-get params :hlines))
17354 (vlines (plist-get params :vlines))
17355 tbl id idpos nfields tmp)
17356 (save-excursion
17357 (save-restriction
17358 (when (setq id (plist-get params :id))
17359 (cond ((not id) nil)
17360 ((eq id 'global) (goto-char (point-min)))
17361 ((eq id 'local) nil)
17362 ((setq idpos (org-find-entry-with-id id))
17363 (goto-char idpos))
17364 (t (error "Cannot find entry with :ID: %s" id))))
17365 (org-columns)
17366 (setq tbl (org-columns-capture-view))
17367 (setq nfields (length (car tbl)))
17368 (org-columns-quit)))
17369 (goto-char pos)
17370 (move-marker pos nil)
17371 (when tbl
17372 (when (plist-get params :hlines)
17373 (setq tmp nil)
17374 (while tbl
17375 (if (eq (car tbl) 'hline)
17376 (push (pop tbl) tmp)
17378 (if (and (not (eq (car tmp) 'hline))
17379 (or (eq hlines t)
17380 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17381 (push 'hline tmp)))
17382 (push (pop tbl) tmp)))
17383 (setq tbl (nreverse tmp)))
17384 (when vlines
17385 (setq tbl (mapcar (lambda (x)
17386 (if (eq 'hline x) x (cons "" x)))
17387 tbl))
17388 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17389 (setq pos (point))
17390 (insert (org-listtable-to-string tbl))
17391 (when (plist-get params :width)
17393 org-columns-current-widths "|")))
17394 (goto-char pos)
17395 (org-table-align))))
17397 (defun org-listtable-to-string (tbl)
17398 "Convert a listtable TBL to a string that contains the Org-mode table.
17399 The table still need to be alligned. The resulting string has no leading
17400 and tailing newline characters."
17401 (mapconcat
17402 (lambda (x)
17403 (cond
17404 ((listp x)
17405 (concat "|" (mapconcat 'identity x "|") "|"))
17406 ((eq x 'hline) "|-|")
17407 (t (error "Garbage in listtable: %s" x))))
17410 (defun org-insert-columns-dblock ()
17411 "Create a dynamic block capturing a column view table."
17412 (interactive)
17413 (let ((defaults '(:name "columnview" :hlines 1))
17414 (id (completing-read
17415 "Capture columns (local, global, entry with :ID: property) [local]: "
17416 (append '(("global") ("local"))
17417 (mapcar 'list (org-property-values "ID"))))))
17418 (if (equal id "") (setq id 'local))
17419 (if (equal id "global") (setq id 'global))
17420 (setq defaults (append defaults (list :id id)))
17421 (org-create-dblock defaults)
17422 (org-update-dblock)))
17424 ;;;; Timestamps
17426 (defvar org-last-changed-timestamp nil)
17427 (defvar org-time-was-given) ; dynamically scoped parameter
17428 (defvar org-end-time-was-given) ; dynamically scoped parameter
17429 (defvar org-ts-what) ; dynamically scoped parameter
17431 (defun org-time-stamp (arg)
17432 "Prompt for a date/time and insert a time stamp.
17433 If the user specifies a time like HH:MM, or if this command is called
17434 with a prefix argument, the time stamp will contain date and time.
17435 Otherwise, only the date will be included. All parts of a date not
17436 specified by the user will be filled in from the current date/time.
17437 So if you press just return without typing anything, the time stamp
17438 will represent the current date/time. If there is already a timestamp
17439 at the cursor, it will be modified."
17440 (interactive "P")
17441 (let* ((ts nil)
17442 (default-time
17443 ;; Default time is either today, or, when entering a range,
17444 ;; the range start.
17445 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17446 (save-excursion
17447 (re-search-backward
17449 (- (point) 20) t)))
17450 (apply 'encode-time (org-parse-time-string (match-string 1)))
17451 (current-time)))
17452 (default-input (and ts (org-get-compact-tod ts)))
17453 org-time-was-given org-end-time-was-given time)
17454 (cond
17455 ((and (org-at-timestamp-p)
17456 (eq last-command 'org-time-stamp)
17457 (eq this-command 'org-time-stamp))
17458 (insert "--")
17459 (setq time (let ((this-command this-command))
17460 (org-read-date arg 'totime nil nil default-time default-input)))
17461 (org-insert-time-stamp time (or org-time-was-given arg)))
17462 ((org-at-timestamp-p)
17463 (setq time (let ((this-command this-command))
17464 (org-read-date arg 'totime nil nil default-time default-input)))
17465 (when (org-at-timestamp-p) ; just to get the match data
17466 (replace-match "")
17467 (setq org-last-changed-timestamp
17468 (org-insert-time-stamp
17469 time (or org-time-was-given arg)
17470 nil nil nil (list org-end-time-was-given))))
17471 (message "Timestamp updated"))
17472 (t
17473 (setq time (let ((this-command this-command))
17474 (org-read-date arg 'totime nil nil default-time default-input)))
17475 (org-insert-time-stamp time (or org-time-was-given arg)
17476 nil nil nil (list org-end-time-was-given))))))
17478 ;; FIXME: can we use this for something else????
17479 ;; like computing time differences?????
17480 (defun org-get-compact-tod (s)
17481 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17482 (let* ((t1 (match-string 1 s))
17483 (h1 (string-to-number (match-string 2 s)))
17484 (m1 (string-to-number (match-string 3 s)))
17485 (t2 (and (match-end 4) (match-string 5 s)))
17486 (h2 (and t2 (string-to-number (match-string 6 s))))
17487 (m2 (and t2 (string-to-number (match-string 7 s))))
17488 dh dm)
17489 (if (not t2)
17490 t1
17491 (setq dh (- h2 h1) dm (- m2 m1))
17492 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17493 (concat t1 "+" (number-to-string dh)
17494 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17496 (defun org-time-stamp-inactive (&optional arg)
17497 "Insert an inactive time stamp.
17498 An inactive time stamp is enclosed in square brackets instead of angle
17499 brackets. It is inactive in the sense that it does not trigger agenda entries,
17500 does not link to the calendar and cannot be changed with the S-cursor keys.
17501 So these are more for recording a certain time/date."
17502 (interactive "P")
17503 (let (org-time-was-given org-end-time-was-given time)
17504 (setq time (org-read-date arg 'totime))
17505 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17506 nil nil (list org-end-time-was-given))))
17508 (defvar org-date-ovl (org-make-overlay 1 1))
17509 (org-overlay-put org-date-ovl 'face 'org-warning)
17510 (org-detach-overlay org-date-ovl)
17512 (defvar org-ans1) ; dynamically scoped parameter
17513 (defvar org-ans2) ; dynamically scoped parameter
17515 (defvar org-plain-time-of-day-regexp) ; defined below
17517 (defvar org-read-date-overlay nil)
17518 (defvar org-dcst nil) ; dynamically scoped
17520 (defun org-read-date (&optional with-time to-time from-string prompt
17521 default-time default-input)
17522 "Read a date, possibly a time, and make things smooth for the user.
17523 The prompt will suggest to enter an ISO date, but you can also enter anything
17524 which will at least partially be understood by `parse-time-string'.
17525 Unrecognized parts of the date will default to the current day, month, year,
17526 hour and minute. If this command is called to replace a timestamp at point,
17527 of to enter the second timestamp of a range, the default time is taken from the
17528 existing stamp. For example,
17529 3-2-5 --> 2003-02-05
17530 feb 15 --> currentyear-02-15
17531 sep 12 9 --> 2009-09-12
17532 12:45 --> today 12:45
17533 22 sept 0:34 --> currentyear-09-22 0:34
17534 12 --> currentyear-currentmonth-12
17535 Fri --> nearest Friday (today or later)
17536 etc.
17538 Furthermore you can specify a relative date by giving, as the *first* thing
17539 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17540 change in days weeks, months, years.
17541 With a single plus or minus, the date is relative to today. With a double
17542 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17543 +4d --> four days from today
17544 +4 --> same as above
17545 +2w --> two weeks from today
17546 ++5 --> five days from default date
17548 The function understands only English month and weekday abbreviations,
17549 but this can be configured with the variables `parse-time-months' and
17550 `parse-time-weekdays'.
17552 While prompting, a calendar is popped up - you can also select the
17553 date with the mouse (button 1). The calendar shows a period of three
17554 months. To scroll it to other months, use the keys `>' and `<'.
17555 If you don't like the calendar, turn it off with
17556 \(setq org-read-date-popup-calendar nil)
17558 With optional argument TO-TIME, the date will immediately be converted
17559 to an internal time.
17560 With an optional argument WITH-TIME, the prompt will suggest to also
17561 insert a time. Note that when WITH-TIME is not set, you can still
17562 enter a time, and this function will inform the calling routine about
17563 this change. The calling routine may then choose to change the format
17564 used to insert the time stamp into the buffer to include the time.
17565 With optional argument FROM-STRING, read from this string instead from
17566 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17567 the time/date that is used for everything that is not specified by the
17568 user."
17569 (require 'parse-time)
17570 (let* ((org-time-stamp-rounding-minutes
17571 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17572 (org-dcst org-display-custom-times)
17573 (ct (org-current-time))
17574 (def (or default-time ct))
17575 (defdecode (decode-time def))
17576 (dummy (progn
17577 (when (< (nth 2 defdecode) org-extend-today-until)
17578 (setcar (nthcdr 2 defdecode) -1)
17579 (setcar (nthcdr 1 defdecode) 59)
17580 (setq def (apply 'encode-time defdecode)
17581 defdecode (decode-time def)))))
17582 (calendar-move-hook nil)
17583 (view-diary-entries-initially nil)
17584 (view-calendar-holidays-initially nil)
17585 (timestr (format-time-string
17586 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17587 (prompt (concat (if prompt (concat prompt " ") "")
17588 (format "Date+time [%s]: " timestr)))
17589 ans (org-ans0 "") org-ans1 org-ans2 final)
17591 (cond
17592 (from-string (setq ans from-string))
17593 (org-read-date-popup-calendar
17594 (save-excursion
17595 (save-window-excursion
17596 (calendar)
17597 (calendar-forward-day (- (time-to-days def)
17598 (calendar-absolute-from-gregorian
17599 (calendar-current-date))))
17600 (org-eval-in-calendar nil t)
17601 (let* ((old-map (current-local-map))
17602 (map (copy-keymap calendar-mode-map))
17603 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17604 (org-defkey map (kbd "RET") 'org-calendar-select)
17605 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17606 'org-calendar-select-mouse)
17644 ;; org-ans0: from prompt
17645 ;; org-ans1: from mouse click
17646 ;; org-ans2: from calendar motion
17674 "Display the currrent date prompt interpretation in the minibuffer."
17690 org-time-stamp-custom-formats
17691 org-time-stamp-formats))
17700 org-end-time-was-given
17707 "Analyze the combined answer of the date prompt."
17708 ;; FIXME: cleanup and comment
17710 hour minute second wday pm h2 m2 tl wday1)
17718 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17728 t nil ans)))
17729 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17730 ;; If there is a time with am/pm, and *no* time without it, we convert
17731 ;; so that matching will be successful.
17745 t t ans))))
17747 ;; Check if a time range is given as a duration
17748 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17756 ;; Check if there is a time range
17790 ;; Weekday was given, but no day, so pick that day in the week
17791 ;; on or after the derived date.
17805 "Check string S for special relative date string.
17806 TODAY and DEFAULT are internal times, for today and for a default.
17807 Return shift list (N what def-flag)
17809 N is the number of WHATs to shift.
17810 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17811 the DEFAULT date rather than TODAY."
17820 ?+))
17827 delta)
17837 "Eval FORM in the calendar window and return to current window.
17838 Also, store the cursor date in variable org-ans2."
17849 ; ;; Update the prompt to show new default date
17850 ; (save-excursion
17851 ; (goto-char (point-min))
17852 ; (when (and org-ans2
17853 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17854 ; (get-text-property (match-end 0) 'field))
17855 ; (let ((inhibit-read-only t))
17856 ; (replace-match (concat "[" org-ans2 "]") t t)
17857 ; (add-text-properties (point-min) (1+ (match-end 0))
17858 ; (text-properties-at (1+ (point-min)))))))))
17861 "Return to `org-read-date' with the date currently selected.
17862 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17871 "Insert a date stamp for the date given by the internal TIME.
17872 WITH-HM means, use the stamp format that includes the time of the day.
17873 INACTIVE means use square brackets instead of angular ones, so that the
17874 stamp will not contribute to the agenda.
17875 PRE and POST are optional strings to be inserted before and after the
17876 stamp.
17877 The command returns the inserted time stamp."
17879 stamp)
17896 stamp))
17899 "Toggle the use of custom time stamp formats."
17920 "Overlay modified time stamp format over timestamp between BED and END."
17947 "Translate all timestamps in STRING to custom format.
17948 But do this only if the variable `org-display-custom-times' is set."
17953 t1 with-hm inactive tf time str beg end)
17962 org-time-stamp-custom-formats)
17971 string)
17974 "Set 0 instead of nil for the first 6 elements of time.
17975 Don't touch the rest."
17980 "Difference between TIMESTAMP-STRING and now in days."
17985 "Is the time in TIMESTAMP-STRING close to the current date?"
17991 "Get the deadline lead time appropriate for timestring TS."
17994 ;; 0 or negative, enforce this value no matter what
17997 ;; lead time is specified.
18002 ;; go for the default.
18006 "Return to `org-read-date' with the date currently selected.
18007 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18017 "Check if there are any deadlines due or past due.
18018 A deadline is considered due if it happens within `org-deadline-warning-days'
18019 days from today's date. If the deadline appears in an entry marked DONE,
18020 it is not shown. The prefix arg NDAYS can be used to test that many
18035 org-warn-days)))
18038 "Check if there are deadlines or scheduled entries before DATE."
18052 "Evaluate a time range by computing the difference between start and end.
18053 Normally the result is just printed in the echo area, but with prefix arg
18054 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18055 If the time range is actually in a table, the result is inserted into the
18056 next column.
18057 For time difference computation, a year is assumed to be exactly 365
18058 days in order to avoid rounding problems."
18078 ;; (ys (floor (* 365 24 60 60)))
18086 y d h m align)
18089 y 0
18094 y 0
18132 "Convert a time stamp to an absolute day number.
18133 If there is a specifyer for a cyclic time stamp, get the closest date to
18134 DAYNR."
18138 daynr
18143 prefer))
18147 "Return the time corresponding to date D.
18148 D may be an absolute day number, or a calendar-type list (month day year)."
18153 "List of holidays, for Diary display in Org-mode."
18161 "Process a SEXP diary ENTRY for DATE."
18181 "Get iCalendar entries from diary entries in buffer FROMBUF.
18182 This uses the icalendar.el library."
18185 temporary-file-directory))
18188 buf rtn b e)
18204 rtn))
18207 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18208 When PREFER is `past' return a date that is either CURRENT or past.
18209 When PREFER is `future', return a date that is either CURRENT or future."
18210 ;; Make the proper lists from the dates
18213 dn dw sday cday n1 n2
18214 d m y y1 y2 date1 date2 nmonths nm ny m2)
18219 current
18243 ;; approx number of month between the tow dates
18245 ;; How often does dn fit in there?
18274 "Turn any specification of DATE into a gregorian date for the calendar."
18284 "Parse the standard Org-mode time string.
18285 This should be a lot faster than the normal `parse-time-string'.
18286 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18287 hour and minute fields will be nil if not given."
18297 nil nil nil)
18301 "Increase the date item at the cursor by one.
18302 If the cursor is on the year, change the year. If it is on the month or
18303 the day, change that.
18304 With prefix ARG, change by that many units."
18309 "Decrease the date item at the cursor by one.
18310 If the cursor is on the year, change the year. If it is on the month or
18311 the day, change that.
18312 With prefix ARG, change by that many units."
18317 "Increase the date in the time stamp by one day.
18318 With prefix ARG, change that many days."
18326 "Decrease the date in the time stamp by one day.
18327 With prefix ARG, change that many days."
18340 "Determine if the cursor is in or at a timestamp."
18366 ans))
18369 ""
18381 "Change the date in the time stamp at point.
18382 The date will be changed by N times WHAT. WHAT can be `day', `month',
18383 `year', `minute', `second'. If WHAT is not given, the cursor position
18384 in the timestamp determines what will be changed."
18386 with-hm inactive
18387 org-ts-what
18388 extra
18389 ts time time0)
18395 org-display-custom-times
18405 ts)
18433 ;; Try to recenter the calendar window, if any
18439 ;; FIXME: does not yet work for lead times
18441 "Change the different parts of the lead-time and repeat fields in timestamp."
18443 ng h m new)
18444 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18465 new
18467 s))
18470 "If the calendar is visible, recenter it to DATE."
18481 "Go to the Emacs calendar at the current date.
18482 If there is a time stamp in the current line, go to that date.
18483 A prefix ARG can be used to force the current date."
18502 "Return a list (month day year) of date at point in calendar."
18508 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18509 If there is already a time stamp at the cursor position, update it."
18517 ;; Make appt aware of appointments from the agenda
18518 ;;;###autoload
18520 "Activate appointments found in `org-agenda-files'.
18521 When prefixed, prompt for a regular expression and use it as a
18522 filter: only add entries if they match this regular expression.
18524 FILTER can be a string. In this case, use this string as a
18525 regular expression to filter results.
18527 FILTER can also be an alist, with the car of each cell being
18528 either 'headline or 'category. For example:
18533 will only add headlines containing IMPORTANT or headlines
18544 ;; Get all entries which may contain an appt
18549 file today
18552 ;; Map thru entries and find if they pass thru the filter
18565 ;; FIXME: Shall we remove text-properties for the appt text?
18566 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18578 ;;; The clock for measuring work time.
18603 "Start the clock on the current item.
18604 If necessary, clock-out of the currently active clock."
18612 org-clock-in-switch-to-state
18639 "Find the location where the next clock line should be inserted."
18645 first last)
18649 ;; we seem to have a CLOCK drawer, so go there.
18652 ;; Lets count the CLOCK lines
18660 ;; Wrap current entries into a new drawer
18678 ;; Planning info, skip to after it
18690 "Stop the currently running clock.
18691 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18728 "Cancel the running clock be removing the start timestamp."
18742 "Go to the currently clocked-in entry."
18759 "Sum the times for each subtree.
18760 Puts the resulting times in minutes as a text property on each headline."
18764 org-clock-string
18770 ts te dt
18771 time)
18778 ;; Two time stamps
18790 ;; A naket time
18807 "Show subtree times in the entire buffer.
18808 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18809 in the echo area."
18826 ;; Arrange to remove the overlays upon next change.
18836 "Put an overlays on the current line, displaying TIME.
18837 If LEVEL is given, prefix time with a corresponding number of stars.
18838 This creates a new overlay and stores it in `org-clock-overlays', so that it
18839 will be easy to remove."
18843 ov tx)
18862 "Remove the occur highlights from the buffer.
18863 BEG and END are ignored. If NOREMOVE is nil, remove this function
18864 from the `before-change-functions' in the current buffer."
18874 "Clock out if the current entry contains the running clock.
18875 This is used to stop the clock after a TODO entry is marked DONE,
18876 and is only done if the variable `org-clock-out-when-done' is not nil."
18882 org-clock-marker))
18883 ;; Clock out, but don't accept a logging message for this.
18891 "Check if the current buffer contains the running clock.
18892 If yes, offer to stop it and to save the buffer with the changes."
18901 "Create a table containing a report about clocked time.
18902 If the cursor is inside an existing clocktable block, then the table
18903 will be updated. If not, a new clocktable will be inserted.
18904 When called with a prefix argument, move to the first clock table in the
18905 buffer and update it."
18918 "Check if the cursor is in a clocktable."
18926 start))))
18929 "If this is a CLOCK line, update it and return t.
18930 Otherwise, return nil."
18939 ts te h m s)
18941 nil
18955 t)))))
18958 "Return two times bordering a special time range.
18959 Key is a symbol specifying the range and can be one of `today', `yesterday',
18960 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18961 A week starts Monday 0:00 and ends Sunday 24:00.
18962 The range is determined relative to TIME. TIME defaults to the current time.
18963 The return value is a cons cell with two internal times like the ones
18964 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18965 the returned times will be formatted strings."
18970 s1 m1 h1 d1 month1 y1 diff ts te fm)
19000 "Write the standard clocktable."
19015 ipos time h m p level hlc hdl
19016 cc beg end pos tbl)
19030 ;; Get the right scope
19053 file)
19063 org-clock-file-total-minutes)))))))
19074 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19095 "Clock summary at ["
19099 "]."
19112 "|"
19113 "*Total time*| "
19135 cc)
19169 x))
19170 lines)
19173 ;; FIXME: I don't think anybody uses this, ask David
19175 "Return an internal list with clocking information.
19176 This list has one entry for each CLOCK interval.
19177 FIXME: describe the elements."
19181 rtn beg end next cont level title total closedp leafp
19182 clockpos titlepos h m donep)
19207 total title titlepos level leafp)
19208 rtn)
19212 ;;;; Agenda, and Diary Integration
19214 ;;; Define the Org-agenda-mode
19228 "Mode for time-sorted view on action items in Org-mode files.
19230 The following commands are available:
19236 org-agenda-pending-undo-list nil)
19238 ;; Keep global-font-lock-mode from turning on font-lock-mode
19246 ;; Make sure properties are removed when copying text
19251 buffer-substring-filters)))
19254 org-agenda-show-log nil))
19261 "Restricted to single file"
19273 org-agenda-mode-map global-map)
19371 "--"
19378 "--"
19382 "--"
19387 "--"
19392 "--"
19397 "--"
19414 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19418 "--"
19420 "--"
19430 "--"
19432 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19436 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19440 "--"
19442 "--"
19445 ))
19447 ;;; Agenda undo
19459 "Execute BODY if there is no `org-protected' text property at point."
19465 "Execute BODY while recording undo information in two buffers."
19473 _c1 _c2)
19474 ,@_body
19481 ;; make sure there are undo boundaries
19484 ;; remember which buffer to undo
19486 org-agenda-undo-list)))))
19489 "Undo a remote editing step in the agenda.
19490 This undoes changes both in the agenda buffer and in the remote buffer
19491 that have been changed along."
19497 org-agenda-pending-undo-list org-agenda-undo-list))
19501 buf line cmd rembuf)
19523 "Verify that a real change occurred between the undo lists L1 and L2."
19528 ;;; Agenda dispatch
19536 ;;;###autoload
19538 "Dispatch agenda commands to collect entries to the agenda buffer.
19539 Prompts for a command to execute. Any prefix arg will be passed
19540 on to the selected command. The default selections are:
19542 a Call `org-agenda-list' to display the agenda for current day or week.
19543 t Call `org-todo-list' to display the global todo list.
19544 T Call `org-todo-list' to display the global todo list, select only
19545 entries with a specific TODO keyword (the user gets a prompt).
19546 m Call `org-tags-view' to display headlines with tags matching
19547 a condition (the user is prompted for the condition).
19548 M Like `m', but select only TODO entries, no ordinary headlines.
19549 L Create a timeline for the current buffer.
19550 e Export views to associated files.
19552 More commands can be added by configuring the variable
19553 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19554 searches can be pre-defined in this way.
19556 If the current buffer is in Org-mode and visiting a file, you can also
19557 first press `<' once to indicate that the agenda should be temporarily
19559 Pressing `<' twice means to restrict to the current subtree or region
19560 \(if active)."
19566 ;; normalize different versions
19572 nil)
19576 org-agenda-custom-commands)))
19579 entry key type match lprops ans)
19580 ;; Turn off restriction unless there is an overriding one
19586 ;; Delete old local properties
19588 ;; Remember where this call originated
19594 ;; Estabish the restriction, if any
19611 ;; For example the todo list should not need it (but does...)
19625 current-prefix-arg)))
19677 cmds)))
19680 "The user interface for selecting an agenda command."
19687 restriction second-time
19688 c entry key type match prefixes rmheader header-end custom1 desc)
19695 "
19696 Press key for an agenda command: < Buffer,subtree/region restriction
19697 -------------------------------- > Remove restriction
19698 a Agenda for current week or day e Export agenda views
19699 t List of all TODO entries T Entries with special TODO kwd
19700 m Match a TAGS query M Like m, but only TODO entries
19701 L Timeline for current buffer # List stuck projects (!=configure)
19702 / Multi-occur C Configure custom agenda commands
19707 header start)
19711 header)))
19763 prefix-descriptions))
19765 prefixes))
19776 " (restriction lock active)"
19789 prefixes nil
19795 nil
19797 custom))))
19814 nil)
19834 match ;; The byte compiler incorrectly complains about this. Keep it!
19835 cmd type lprops)
19866 ;;;###autoload
19868 "Run an agenda command in batch mode and send the result to STDOUT.
19869 If CMD-KEY is a string of length 1, it is used as a key in
19870 `org-agenda-custom-commands' and triggers this command. If it is a
19871 longer string it is used as a tags/todo match string.
19872 Paramters are alternating variable names and values that will be bound
19873 before running the agenda command."
19887 string))
19891 ;;;###autoload
19893 "Run an agenda command in batch mode and send the result to STDOUT.
19894 If CMD-KEY is a string of length 1, it is used as a key in
19895 `org-agenda-custom-commands' and triggers this command. If it is a
19896 longer string it is used as a tags/todo match string.
19897 Paramters are alternating variable names and values that will be bound
19898 before running the agenda command.
19900 The output gives a line for each selected agenda item. Each
19901 item is a list of comma-separated values, like this:
19903 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19905 category The category of the item
19906 head The headline, without TODO kwd, TAGS and PRIORITY
19907 type The type of the agenda entry, can be
19908 todo selected in TODO match
19909 tagsmatch selected in tags match
19910 diary imported from diary
19911 deadline a deadline on given date
19912 scheduled scheduled on given date
19913 timestamp entry has timestamp on given date
19914 closed entry was closed on given date
19915 upcoming-deadline warning about deadline
19916 past-scheduled forwarded scheduled item
19917 block entry has date block including g. date
19918 todo The todo keyword, if any
19919 tags All tags including inherited ones, separated by colons
19920 date The relevant date, like 2007-2-14
19921 time The time, like 15:00-16:50
19922 extra Sting with extra planning info
19923 priority-l The priority letter if any was given
19924 priority-n The computed numerical priority
19925 agenda-day The day in the agenda where this is listed"
19937 line)
19947 priority-letter priority agenda-day)
19952 "Make sure all properties on an agenda item have a canonical form,
19953 so the export commands can easily use it."
19980 props)
19994 ;;;###autoload
19999 ;; FIXME, why is this a macro?????
20000 ;;;###autoload
20002 "Run all custom agenda commands that have a file argument."
20006 pars cmd thiscmdkey files opts)
20029 "Write the current buffer (an agenda view) as a file.
20030 Depending on the extension of the file name, plain text (.txt),
20031 HTML (.html or .htm) or Postscript (.ps) is produced.
20032 If NOSETTINGS is given, do not scope the settings of
20033 `org-agenda-exporter-settings' into the export commands. This is used when
20034 the settings have already been scoped and we do not wish to overrule other,
20035 higher priority settings."
20051 ;; replace <style> section with org-agenda-export-html-style
20072 "Inhibit read-only for BODY."
20076 "Make sure current buffer is in org-mode. Error if not."
20079 major-mode)))
20082 "Fit the window to the buffer size."
20086 nil
20090 ;;; Agenda file list
20093 "Get the list of agenda files.
20094 Optional UNRESTRICTED means return the full list even if a restriction
20095 is currently in place."
20106 org-agenda-file-regexp)
20108 files)))
20114 files))
20118 "Edit the list of agenda files.
20119 Depending on setup, this either uses customize to edit the variable
20120 `org-agenda-files', or it visits the file that is holding the list. In the
20121 latter case, the buffer is set up in a way that saving it automatically kills
20122 the buffer and restores the previous window configuration."
20141 "Set new value for the agenda file list and save it correcly."
20152 "Read the list of agenda files from a file."
20159 ;;;###autoload
20161 "Cycle through the files in `org-agenda-files'.
20162 If the current buffer visits an agenda file, find the next one in the list.
20163 If the current buffer does not, find the first agenda file."
20168 file)
20180 "Move/add the current file to the top of the agenda file list.
20181 If the file is not present in the list, it is added to the front. If it is
20182 present, it is moved there. With optional argument TO-END, add/move to the
20183 end of the list."
20190 x had)
20203 "Remove current file from the list of files in variable `org-agenda-files'.
20204 These are the files which are being checked for agenda entries.
20205 Optional argument FILE means, use this file instead of the current."
20215 nil x))
20228 "Make sure FILE exists. If not, ask user what to do."
20239 ;;; Agenda prepare and finalize
20284 "Finishing touch for the agenda buffer, called just before displaying it."
20296 org-overriding-columns-format)
20298 org-overriding-columns-format))
20300 org-agenda-view-columns-initially)
20306 )))
20309 "Make highest priority lines bold, and lowest italic."
20316 b e p ov h l)
20320 org-highest-priority)
20322 org-lowest-priority)
20327 ov 'face
20335 "Create buffers for all agenda files, protect archived trees and comments."
20342 bmp file re)
20372 "Function to be called at each match during agenda construction.
20373 If this function returns nil, the current match should not be skipped.
20374 Otherwise, the function must return a position from where the search
20375 should be continued.
20376 This may also be a Lisp form, it will be evaluated.
20377 Never set this variable using `setq' or so, because then it will apply
20378 to all future agenda commands. Instead, bind it with `let' to scope
20379 it dynamically into the agenda-constructing command. A good way to set
20383 "Throw to `:skip' in places that should be skipped.
20384 Also moves point to the end of the skipped region, so that search can
20385 continue from there."
20411 "Return a new agenda marker.
20412 Org-mode keeps a list of these markers and resets them when they are
20413 no longer in use."
20417 m))
20420 "Reset markers created by `org-agenda'."
20425 "Get a buffer visiting FILE. If the buffer needs to be created, add
20426 it to the list of buffers which might be released later."
20429 buf ; just return it
20430 ;; Make a new buffer and remember it
20433 buf)))
20436 "Release all buffers in list, asking the user for confirmation when needed.
20437 When a buffer is unmodified, it is just killed. When modified, it is saved
20438 \(if the user agrees) and then killed."
20443 file
20449 "Get the category applying to position POS."
20452 ;;; Agenda timeline
20457 "Show a time-sorted view of the entries in the current org file.
20458 Only entries with a time stamp of today or later will be listed. With
20460 under the current date.
20461 If the buffer contains an active region, only check the region for
20462 dates."
20475 t doclosed ; always include today
20476 org-timeline-show-empty-dates))
20481 args
20482 s e rtn d emptyp)
20488 ;; Remove past dates from the list of dates.
20491 day-numbers))))
20508 dopast
20509 past)
20517 date args)))
20540 "Return a list of all relevant day numbers from BEG to END buffer positions.
20541 If NO-RANGES is non-nil, include only the start and end dates of a range,
20542 not every single day in the range. If FORCE-TODAY is non-nil, make
20543 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20544 inactive time stamps (those in square brackets) are included.
20545 When EMPTY is non-nil, also include days without any entries."
20549 dates dates1 date day day1 day2 ts1 ts2)
20579 dates)))
20581 ;;; Agenda Daily/Weekly
20592 ;;;###autoload
20594 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20595 The view will be for the current day or week, but from the overview buffer
20596 you will be able to go to other days/weeks.
20599 all unfinished TODO items will also be shown, before the agenda.
20600 This feature is considered obsolete, please use the TODO list or a block
20601 agenda instead.
20603 With a numeric prefix argument in an interactive call, the agenda will
20604 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20605 the number of days. NDAYS defaults to `org-agenda-ndays'.
20607 START-DAY defaults to TODAY, or to the most recent match for the weekday
20608 given in `org-agenda-start-on-weekday'."
20619 ;; Convert to an absolute day number
20627 org-agenda-start-on-weekday nil))
20636 sd
20645 s e rtn rtnall file date d start-pos end-pos todayp nd)
20648 ;; Make the list of days
20650 nd ndays)
20663 rtnall nil)
20691 rtnall nil)
20697 file date
20700 file date
20724 rtnall nd todayp))
20747 ;;; Agenda TODO list
20752 ;;;###autoload
20754 "Show all TODO entries from all agenda file in a single list.
20755 The prefix arg can be used to select a specific TODO keyword and limit
20757 for a keyword. A numeric prefix directly selects the Nth keyword in
20758 `org-todo-keywords-1'."
20772 rtn rtnall files file pos)
20782 rtnall nil)
20806 kwds))
20817 ;;; Agenda tags match
20819 ;;;###autoload
20821 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20822 The prefix arg TODO-ONLY limits the search to TODO entries."
20829 rtn rtnall files file pos matcher
20830 buffer)
20838 rtnall nil)
20846 ;; If file does not exist, merror message to agenda
20857 org-agenda-restrict-end)
20882 ;;; Agenda Finding stuck projects
20885 "Regular expression used in skipping subtrees for the agenda.
20886 This is basically a temporary global variable that can be set and then
20893 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20894 If yes, it returns the end position of this tree, causing agenda commands
20895 to skip this subtree. This is a function that can be put into
20896 `org-agenda-skip-function' for the duration of a command."
20898 skip)
20904 "Skip entry if any of CONDITIONS is true.
20905 See `org-agenda-skip-if' for details."
20909 "Skip entry if any of CONDITIONS is true.
20910 See `org-agenda-skip-if' for details."
20914 "Checks current entity for CONDITIONS.
20915 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20916 the entry, i.e. the text before the next heading is checked.
20918 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20919 from different tests. Valid conditions are:
20921 scheduled Check if there is a scheduled cookie
20922 notscheduled Check if there is no scheduled cookie
20923 deadline Check if there is a deadline
20924 notdeadline Check if there is no deadline
20925 regexp Check if regexp matches
20926 notregexp Check if regexp does not match.
20928 The regexp is taken from the conditions list, it must come right after
20929 the `regexp' or `notregexp' element.
20931 If any of these conditions is met, this function returns the end point of
20932 the entity, causing the search to continue from there. This is a function
20933 that can be put into `org-agenda-skip-function' for the duration of a command."
20957 end)))
20959 ;;;###autoload
20961 "Create agenda view for projects that are stuck.
20962 Stuck projects are project that have no next actions. For the definitions
20963 of what a project is and how to check if it stuck, customize the variable
20964 `org-stuck-projects'.
20965 MATCH is being ignored."
20968 ;; FIXME: we could have used org-agenda-skip-if here.
20976 org-done-keywords-for-agenda
20978 todo))
20995 gen-re)))))
21006 ;;; Diary integration
21011 "Get the (Emacs Calendar) diary entries for DATE."
21019 entries
21031 ;; No entries
21033 ;; Omit the date and other unnecessary stuff
21035 ;; Add prefix to each line and extend the text properties
21047 ;; Extend the text properties to the beginning of the line
21050 entries)))))
21053 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21054 This gets rid of the date, the underline under the date, and
21055 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21056 date. It also removes lines that contain only whitespace."
21073 ;; Make sure entries from the diary have the right text properties.
21076 ;; We can rely on the hook, nothing to do
21077 nil
21078 ;; Hook not avaiable, must use advice to make this work
21080 "Make the position visible."
21083 buffer-file-name)
21087 "Add text properties to string, allowing org-mode to act on it."
21090 'keymap org-agenda-keymap
21095 'org-agenda-diary-link t
21099 "Add a dummy entry to the diary.
21100 Needed to avoid empty dates which mess up holiday display."
21101 ;; Catch the error if dealing with the new add-to-diary-alist
21108 ;;;###autoload
21110 "Return diary information from org-files.
21112 It accesses org files and extracts information from those files to be
21113 listed in the diary. The function accepts arguments specifying what
21114 items should be listed. The following arguments are allowed:
21116 :timestamp List the headlines of items containing a date stamp or
21117 date range matching the selected date. Deadlines will
21118 also be listed, on the expiration day.
21120 :sexp List entries resulting from diary-like sexps.
21122 :deadline List any deadlines past due, or due within
21123 `org-deadline-warning-days'. The listing occurs only
21124 in the diary for *today*, not at any other date. If
21125 an entry is marked DONE, it is no longer listed.
21127 :scheduled List all items which are scheduled for the given date.
21128 The diary for *today* also contains items which were
21129 scheduled earlier and are not yet marked DONE.
21131 :todo List all TODO items from the org-file. This may be a
21132 long list - so this is not turned on by default.
21133 Like deadlines, these entries only show up in the
21134 diary for *today*, not at any other date.
21136 The call in the diary file should look like this:
21138 &%%(org-diary) ~/path/to/some/orgfile.org
21140 Use a separate line for each org file to check. Or, if you omit the file name,
21141 all files listed in `org-agenda-files' will be checked automatically:
21143 &%%(org-diary)
21145 If you don't give any arguments (as in the example above), the default
21146 arguments (:deadline :scheduled :timestamp :sexp) are used.
21147 So the example above may also be written as
21149 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21151 The function expects the lisp variables `entry' and `date' to be provided
21152 by the caller, because this is how the calendar works. Don't use this
21153 function from a program - use `org-agenda-get-day-entries' instead."
21155 org-agenda-last-marker-time)
21164 file rtn results)
21166 ;; If this is called during org-agenda, don't return any entries to
21167 ;; the calendar. Org Agenda will list these entries itself.
21175 ;;; Agenda entry finders
21178 "Does the work for `org-diary' and `org-agenda'.
21179 FILE is the path to a file to be checked for entries. DATE is date like
21180 the one returned by `calendar-current-date'. ARGS are symbols indicating
21181 which kind of entries should be extracted. For details about these, see
21182 the documentation of `org-diary'."
21189 arg results rtn)
21191 ;; If file does not exist, make sure an error message ends up in diary
21201 org-agenda-restrict-end)
21203 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21227 results))))
21243 "Is the cursor inside a date range?"
21258 nil)))
21261 "Return the TODO information for agenda display."
21264 'org-not-done-regexp org-not-done-regexp
21265 'org-todo-regexp org-todo-regexp
21267 'keymap org-agenda-keymap
21268 'help-echo
21271 ;; FIXME: get rid of the \n at some point but watch out
21275 org-todo-regexp
21279 org-not-done-regexp)
21281 marker priority category tags
21282 ee txt beg end)
21321 "Return the date stamp information for agenda display."
21323 'org-not-done-regexp org-not-done-regexp
21324 'org-todo-regexp org-todo-regexp
21326 'keymap org-agenda-keymap
21327 'help-echo
21335 "<%Y-%m-%d"
21349 marker hdmarker deadlinep scheduledp donep tmp priority category
21350 ee txt timestr tags b0 b3 e3 head)
21368 b0)
21375 ;; substring should only run to end of time stamp
21387 nil head category tags timestr nil
21388 remove-re)))
21401 "Return the sexp information for agenda display."
21405 'keymap org-agenda-keymap
21406 'help-echo
21410 marker category ee txt tags entry result beg b sexp sexp-entry)
21442 "Return the logged TODO entries for agenda display."
21444 'org-not-done-regexp org-not-done-regexp
21445 'org-todo-regexp org-todo-regexp
21446 'keymap org-agenda-keymap
21447 'help-echo
21459 marker hdmarker priority category tags closedp
21460 ee txt timestr)
21469 ;; donep (org-entry-is-done-p)
21470 )
21472 ;; substring should only run to end of time stamp
21496 "Return the deadline information for agenda display."
21498 'org-not-done-regexp org-not-done-regexp
21499 'org-todo-regexp org-todo-regexp
21500 'keymap org-agenda-keymap
21501 'help-echo
21507 d2 diff dfrac wdays pos pos1 category tags
21508 ee txt head face s upcomingp donep timestr)
21520 ;; When to show a deadline in the calendar:
21521 ;; If the expiration is within wdays warning time.
21522 ;; Past-due deadlines are only shown on the current date
21550 diff))
21551 head category tags timestr))))
21560 'org-category category
21569 "Return the face to displaying a deadline item.
21570 FRACTION is what fraction of the head-warning time has passed."
21577 "Return the scheduled information for agenda display."
21579 'org-todo-regexp org-todo-regexp
21582 'keymap org-agenda-keymap
21583 'help-echo
21589 d2 diff pos pos1 category tags
21590 ee txt head pastschedp donep face timestr s)
21598 ;;; is this right?
21599 ;;; do we need to do this for deadleine too????
21600 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21603 ;; When to show a scheduled item in the calendar:
21604 ;; If it is on or past the date.
21632 head category tags timestr))))
21636 'org-scheduled-previously
21639 'undone-face face
21651 "Return the date-range information for agenda display."
21653 'org-not-done-regexp org-not-done-regexp
21654 'org-todo-regexp org-todo-regexp
21656 'keymap org-agenda-keymap
21657 'help-echo
21662 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21663 donep head)
21675 ;; Only allow days between the limits, because the normal
21676 ;; date stamps will catch the limits.
21693 head category tags
21702 ;; Sort the entries by expiration date.
21705 ;;; Agenda presentation and sorting
21715 "Regular expression to match a plain time or time range.
21716 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21717 groups carry important information:
21718 0 the full match
21719 1 the first time, range or not
21727 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
21728 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21729 groups carry important information:
21730 0 the full match
21731 7 hours of duration
21740 "Regular expression to match a timestamp time or time range.
21741 After a match, the following groups carry important information:
21742 0 the full match
21743 1 date plus weekday, for backreferencing to make sure both times on same day
21744 2 the first time, range or not
21748 "A flag, set by `org-compile-prefix-format'.
21751 "A flag, set by `org-compile-prefix-format'.
21755 noprefix remove-re)
21756 "Format TXT to be inserted into the agenda buffer.
21757 In particular, it adds the prefix and corresponding text properties. EXTRA
21758 must be a string and replaces the `%s' specifier in the prefix format.
21759 CATEGORY (string, symbol or nil) may be used to overrule the default
21760 category taken from local variable or file name. It will replace the `%c'
21761 specifier in the format. DOTIME, when non-nil, indicates that a
21762 time-of-day should be extracted from TXT for sorting of this entry, and for
21763 the `%t' specifier in the format. When DOTIME is a string, this string is
21764 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21765 only the correctly processes TXT should be returned - this is used by
21766 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21767 Any match of REMOVE-RE will be removed from TXT."
21769 ;; Diary entries sometimes have extra whitespace at the beginning
21772 org-category
21778 time ; time and tag are needed for the eval of the prefix format
21781 stamp plain s0 s1 s2 rtn srp)
21783 ;; Extract starting and ending time and move them to prefix
21791 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21792 ;; them, we might want to remove them there to avoid duplication.
21793 ;; The user can turn this off with a variable.
21799 t))
21801 ;; Normalize the time(s) to 24 hour
21809 org-agenda-default-appointment-duration))
21810 h)
21815 txt)
21816 ;; Tags are in the string
21819 org-prefix-has-tag))
21824 t t txt))))
21830 ;; Create the final string
21833 ;; Prepare the variables needed in the eval of the compiled format
21839 ;; Evaluate the compiled format
21842 ;; And finally add the text properties
21845 'org-highest-priority org-highest-priority
21846 'org-lowest-priority org-lowest-priority
21848 'time-of-day time-of-day
21849 'txt txt
21850 'time time
21851 'extra extra
21866 list)))
21871 new time)
21873 ;; don't show empty grid
21879 nil string "" nil
21881 new)
21889 "Compile the prefix format into a Lisp form that can be evaluated.
21890 The resulting form is returned and stored in the variable
21891 `org-prefix-format-compiled'."
21895 org-agenda-prefix-format)
21900 varform vars var e c f opt)
21902 s start)
21915 ""
21925 ;; the old format
21933 "Check string S for a time of day.
21934 If found, return it as a military time number between 0 and 2400.
21935 If not found, return nil.
21936 The optional STRING argument forces conversion into a 5 character wide string
21937 HH:MM."
21959 "Sort and concatenate the agenda items."
21962 list
21987 x)
21991 " "
21993 x)))
21996 "Compare the priorities of string A and B."
22004 "Compare the string values of categories of strings A and B."
22012 "Compare the string values of categories of strings A and B."
22022 "Compare the time-of-day values of strings A and B."
22031 "Predicate for sorting agenda entries."
22032 ;; The following variables will be used when the form is evaluated.
22033 ;; So even though the compiler complains, keep them.
22047 ;;; Agenda restriction lock
22065 "Set restriction lock for agenda, to current subtree or file.
22066 Restriction will be the file if TYPE is `file', or if type is the
22067 universal prefix '(4), or if the cursor is before the first headline
22068 in the file. Otherwise, restriction will be to the current subtree."
22100 "Remove the agenda restriction lock."
22114 "If there is any window showing the agenda view, update it."
22123 org-agenda-overriding-restriction)
22126 ;;; Agenda commands
22129 "Check if agenda buffer is of allowed type.
22130 If ERROR is non-nil, throw an error, otherwise just return nil."
22132 t
22135 nil)))
22138 "Exit agenda by removing the window or the buffer."
22145 ;; Maybe restore the pre-agenda window configuration.
22148 org-pre-agenda-window-conf
22152 "Exit agenda by removing the window or the buffer.
22153 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22154 Org-mode buffers visited directly by the user will not be touched."
22168 "Save all Org-mode buffers without user confirmation."
22175 "Rebuild Agenda.
22176 When this is the global TODO list, a prefix argument will be interpreted."
22185 org-agenda-pending-undo-list nil)
22191 "Jump to DATE in agenda."
22196 "Go to today."
22222 "Go forward in time by thee current span.
22223 With prefix ARG, go forward that many times the current span."
22230 greg2 nd)
22252 "Go backward in time by the current span.
22253 With prefix ARG, go backward that many times the current span."
22258 "Switch to daily view for agenda."
22263 "Switch to daily view for agenda."
22268 "Switch to daily view for agenda."
22272 "Switch to daily view for agenda."
22279 "Change the agenda view to SPAN.
22280 SPAN may be `day', `week', `month', `year'."
22285 org-starting-day))
22296 "Compute starting date and number of days for agenda.
22297 SPAN may be `day', `week', `month', `year'. The return value
22298 is a cons cell with the starting date and the number of days,
22299 so that the date SD will be in that range."
22301 nd)
22318 sd)))
22324 sd))))
22327 ;; FIXME: does not work if user makes date format that starts with a blank
22329 "Jump to the next line indicating a date in agenda buffer."
22341 "Jump to the previous line indicating a date in agenda buffer."
22348 ;; Initialize the highlight
22353 "Highlight a region with overlay."
22358 "Detach overlay INDEX."
22361 ;; FIXME this is currently not used.
22370 "Toggle follow mode in an agenda buffer."
22378 "Toggle log mode in an agenda buffer."
22388 "Toggle diary inclusion in an agenda buffer."
22398 "Toggle time grid in an agenda buffer."
22408 "Set the mode name to indicate all the small mode settings."
22427 "Show the priority of the current item.
22428 This priority is composed of the main priority given with the [#A] cookies,
22429 and by additional input from the age of a schedules or deadline entry."
22435 "Show the tags applicable to the current item."
22444 "Go to the Org-mode file which contains the item at point."
22463 "Normal hook run after an item has been shown from the agenda.
22467 "Kill the entry or subtree belonging to the current agenda entry."
22500 "Kill the entry or subtree belonging to the current agenda entry."
22518 "Remove all lines in the agenda that correspond to a given subtree.
22519 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22520 If this information is not given, the function uses the tree at point."
22543 "Follow the link in the current line, if any."
22552 "Get a variable from a referenced buffer and install it here."
22559 "Go to the Org-mode file which contains the item at point."
22576 "Go to the Org-mode file which contains the item at the mouse click."
22582 "Display the Org-mode file which contains the item at point."
22589 "Display the Org-mode file which contains the item at point and recenter."
22597 "Display the Org-mode file which contains the item at the mouse click."
22603 "Check if the entry is a diary link and abort if yes."
22611 "Show the subtree corresponding to the current entry in an indirect buffer.
22612 This calls the command `org-tree-to-indirect-buffer' from the original
22613 Org-mode buffer.
22614 With numerical prefix arg ARG, go up to this level and then take that tree.
22615 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22616 dedicated frame)."
22629 "Marker pointing to the headline that last changed its TODO state
22633 "Switch TODO entry to next sequence."
22638 "Switch TODO entry to previous sequence."
22643 "Cycle TODO state of line at point, also in Org-mode file.
22644 This changes the line at point, all other lines in the agenda referring to
22645 the same tree node, and the headline of the tree node in the Org-mode file."
22655 newhead)
22676 "Change all lines in the agenda buffer which match HDMARKER.
22677 The new content of the line will be NEWHEAD (as modified by
22678 `org-format-agenda-item'). HDMARKER is checked with
22679 `equal' against all `org-hd-marker' text properties in the file.
22680 If FIXFACE is non-nil, the face of each item is modified acording to
22681 the new TODO state."
22683 props m pl undone-face done-face finish new dotime cat tags)
22713 undone-face done-face))))
22721 "Align all tags in agenda items to `org-agenda-tags-column'."
22734 org-agenda-tags-column))
22742 "Increase the priority of line at point, also in Org-mode file."
22747 "Decrease the priority of line at point, also in Org-mode file."
22752 "Set the priority of line at point, also in Org-mode file.
22753 This changes the line at point, all other lines in the agenda referring to
22754 the same tree node, and the headline of the tree node in the Org-mode file."
22763 newhead)
22779 "Get a list of all headline tags applicable at POS.
22780 POS defaults to point. If tags are inherited, the list contains
22781 the targets in the same sequence as the headlines appear, i.e.
22782 the tags of the current headline come last."
22797 tags)))
22801 tags)))
22803 ;; FIXME: should fix the tags property of the agenda line.
22805 "Set tags for the current headline."
22816 newhead)
22834 "Toggle the archive tag for the current entry."
22843 newhead)
22859 "Change the date of this item to one day later."
22878 "Change the date of this item to one day earlier."
22883 "Show new date stamp via text properties."
22884 ;; We use text properties to make this undoable
22893 ;; Use `duplicable' property to trigger undo recording
22908 "Change the date of this item. Date is prompted for, with default today.
22909 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22910 be used to request time specification in the time stamp."
22928 "Schedule the item at point."
22937 ts)
22949 "Schedule the item at point."
22958 ts)
22968 "Return the heading of the current entry, without the stars."
22978 "Start the clock on the currently selected item."
22991 "Stop the currently running clock."
22999 "Cancel the currently running clock."
23007 "Make a diary entry, like the `i' command from the calendar.
23008 All the standard commands work: block, weekly etc."
23024 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23033 ;; We implement this by hacking the `calendar-cursor-to-date' function
23034 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23050 "Execute a calendar command from the agenda, with the date associated to
23051 the cursor position."
23060 ;; the following 3 vars are needed in the calendar
23074 "Display the phases of the moon for the 3 months around the cursor date."
23079 "Display the holidays for the 3 months around the cursor date."
23084 "Display sunrise and sunset for the cursor date.
23085 Latitude and longitude can be specified with the variables
23086 `calendar-latitude' and `calendar-longitude'. When called with prefix
23087 argument, latitude and longitude will be prompted for."
23096 "Open the Emacs calendar with the date at the cursor."
23109 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23110 This is a command that has to be installed in `calendar-mode-map'."
23114 nil))
23120 date s)
23146 ;;;; Embedded LaTeX
23161 "Toggle the minor `org-cdlatex-mode'.
23162 This mode supports entering LaTeX environment and math in LaTeX fragments
23163 in Org-mode.
23165 nil " OCDL" nil
23170 "Always return t in org-mode buffers.
23171 This is because we want to insert math symbols without dollars even outside
23172 the LaTeX math segments. If Orgmode thinks that point is actually inside
23173 en embedded LaTeX fragement, let texmathp do its job.
23190 "Unconditionally turn on `org-cdlatex-mode'."
23194 "Test if point is inside a LaTeX fragment.
23196 sequence appearing also before point.
23197 Even though the matchers for math are configurable, this function assumes
23199 delimiters are skipped when they have been removed by customization.
23200 The return value is nil, or a cons cell with the delimiter and
23201 and the position of this delimiter.
23203 This function does a reasonably good job, but can locally be fooled by
23204 for example currency specifications. For example it will assume being in
23206 fragments that are properly closed, but during editing, we have to live
23207 with the uncertainty caused by missing closing delimiters. This function
23208 looks only before point, not after."
23227 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23231 ;; count $$
23239 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23240 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23241 - inside a LaTeX fragment, or
23242 - after the first word in a line, where an abbreviation expansion could
23243 insert a LaTeX environment."
23256 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23257 Revert to the normal definition outside of these fragments."
23265 "Execute `cdlatex-math-modify' in LaTeX fragments.
23266 Revert to the normal definition outside of these fragments."
23278 "Remove all overlays with LaTeX fragment images in current buffer."
23283 "Preview the LaTeX fragment at point, or all locally or globally.
23284 If the cursor is in a LaTeX fragment, create the image and overlay
23285 it over the source code. If there is no fragment at point, display
23286 all fragments in the current text, from one headline to the next. With
23287 prefix SUBTREE, display all fragments in the current subtree. With a
23288 double prefix `C-u C-u', or when the cursor is before the first headline,
23289 display all fragments in the buffer.
23319 buffer-file-name)))
23325 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23326 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23327 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23334 "Replace LaTeX fragments with links to an image, and produce images."
23343 m n block linkfile movefile ov)
23344 ;; Check if there are old images files with this prefix, and remove them
23348 todir 'full
23350 ;; Check the different regular expressions
23370 txt movefile opt forbuffer)
23378 ov 'end-glyph
23381 ov 'display
23388 ;; This function borrows from Ganesh Swami's latex2png.el
23392 temporary-file-directory))
23421 "-D" dpi
23422 ;;"-x" scale "-y" scale
23424 "-o" pngfile
23425 dvifile)
23428 ;; Use the requested file name and clean up
23432 pngfile))))
23435 "Return an rgb color specification for dvipng."
23441 "Return string to be used as color value for an RGB component."
23444 ;;;; Exporting
23446 ;;; Variables, constants, and parameter plists
23502 "Return the property list with default settings for the export variables."
23506 rtn))
23509 "Return the property list with file-local settings for export."
23516 p key val text options)
23549 o)
23553 options)
23557 p))))
23563 val)))
23564 dir))
23571 rtn line level)
23576 ;; Beginning of a COMMENT subtree. Skip it.
23582 ;; an ordinary comment line
23583 )
23589 ;; a special table line that should be removed
23590 )
23597 \[v] limit export to visible part of outline tree
23599 \[a] export as ASCII
23601 \[h] export as HTML
23602 \[H] export as HTML to temporary buffer
23603 \[R] export region as HTML
23604 \[b] export as HTML and browse immediately
23605 \[x] export as XOXO
23607 \[l] export as LaTeX
23608 \[L] export as LaTeX to temporary buffer
23610 \[i] export current file as iCalendar file
23611 \[I] export all agenda files as iCalendar files
23612 \[c] export agenda files into combined iCalendar file
23614 \[F] publish current file
23615 \[P] publish current project
23616 \[X] publish... (project will be prompted for)
23636 r1 r2 ass)
23939 )
23940 "Entities for TeX->HTML translation.
23944 The list contains HTML entities for Latin-1, Greek and other symbols.
23945 It is supplemented by a number of commonly used TeX macros with appropriate
23948 ;;; General functions for all backends
23951 "Cleanup a buffer STRING so that links can be created safely."
23969 a b xx
23970 rtn p)
23974 ;; Remove license-to-kill stuff
23982 ;; Get rid of drawers
23987 'identity
23995 ;; Get the correct stuff before the first headline
24006 ;; Get rid of archived trees
24018 ;; Find targets in comments and move them out of comments,
24019 ;; but mark them as targets that should be invisible
24024 ;; Protect backend specific stuff, throw away the others.
24029 fmt)
24060 ;; Protect quoted subtrees
24068 ;; Protect verbatim elements
24075 ;; Remove subtrees that are commented
24081 ;; Remove special table lines
24093 ;; Specific LaTeX stuff
24101 ;; Specific HTML stuff
24103 ;; Convert LaTeX fragments to images
24108 org-current-export-file)))
24112 ;; Remove or replace comments
24121 ;; Find matches for radio targets and turn them into internal links
24128 ;; Find all links that contain a newline and put them into a single line
24130 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24136 ;; Normalize links: Convert angle and plain links into bracket links
24137 ;; Expand link abbreviations
24144 ;; added 'org-link face to links
24160 "]"
24168 ;; Find multiline emphasis and put them into single line
24182 rtn))
24185 "Get a title for the current document, from looking at the buffer."
24191 ;; Mark the line so that it will not be exported as normal text.
24195 ;; Return the title string
24199 "Return subtree title and exclude it from export."
24205 ;; This is a subtree, we take the title from the first heading
24212 title))
24215 "Take link text and make a safe target out of it."
24219 'identity
24225 "Get the minimum level in LINES."
24233 ;; Variable holding the vector with section numbers
24237 "Initialize the vector for the section numbers."
24254 "Return a string with the current section number.
24255 When LEVEL is non-nil, increase section numbers on that level."
24277 string))
24279 ;;; ASCII export
24287 "Export the outline as a pretty ASCII file.
24288 If there is an active region, export only the region.
24289 The prefix ARG specifies how many levels of the outline should become
24290 underlined headlines. The default is 3."
24319 filename))
24335 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24344 region
24345 :for-ascii t
24346 :skip-before-1st-heading
24349 :verbatim-multiline t
24350 :archived-trees
24354 thetoc have-headings first-heading-pos
24355 table-open table-buffer)
24373 ;; create local variables for all options, to make sure all called
24374 ;; functions get the correct information
24378 org-export-plist-vars)
24381 org-export-headline-levels))
24384 umax))
24386 ;; File header
24390 org-export-author-info)
24412 line)
24413 ;; This is a headline
24419 todo
24423 org-done-keywords)))
24424 ; TODO, not DONE
24428 line lines level))))
24435 t t txt)))
24440 txt))
24455 thetoc)
24457 ))))
24458 lines)
24463 ;; Remove the quoted HTML tags.
24465 ;; Remove targets
24468 ;; Replace internal links
24472 t nil line)))
24477 ;; a Headline
24486 ;; New table starts
24488 ;; Accumulate lines
24509 ;; insert the table of contents
24521 ;; Convert whitespace place holders
24531 ;; remove display and invisible chars
24547 "Do extra work for ASCII export"
24557 "Search the subtree below LINE for any TODO entries."
24560 line lv todo)
24568 org-done-keywords))))
24569 ; TODO, not DONE
24574 "Handle quoted HTML for ASCII export."
24577 ;; We just remove the tags for now.
24579 line)
24582 "Insert the string S centered and underline it with character UNDERLINE."
24591 "Insert a new level in ASCII export."
24597 org-export-ascii-bullets))
24599 ;; find the indentation of the next non-empty line
24620 "Create a copy of the visible part of the current buffer, and export it.
24621 The copy is created in a temporary buffer and removed after use.
24622 TYPE is the final key (as a string) that also select the export command in
24623 the `C-c C-e' export dispatcher.
24624 As a special case, if the you type SPC at the prompt, the temporary
24625 org-mode file will not be removed but presented to you so that you can
24626 continue to use it. The prefix arg ARG is passed through to the exporting
24627 command."
24630 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24632 current-prefix-arg))
24647 s e)
24648 ;; Need to hack the drawers here.
24664 ;; Copy all comment lines to the end, to make sure #+ settings are
24665 ;; still available for the second export step. Kind of a hack, but
24666 ;; does do the trick.
24687 s))
24692 s))
24694 ;;; HTML export
24697 "Return a string with current options as keyword options.
24698 Does include HTML export options as well as TODO and CATEGORY stuff."
24700 "#+TITLE: %s
24701 #+AUTHOR: %s
24702 #+EMAIL: %s
24703 #+LANGUAGE: %s
24704 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24705 #+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
24706 #+CATEGORY: %s
24707 #+SEQ_TODO: %s
24708 #+TYP_TODO: %s
24709 #+PRIORITIES: %c %c %c
24710 #+DRAWERS: %s
24711 #+STARTUP: %s %s %s %s %s
24712 #+TAGS: %s
24713 #+ARCHIVE: %s
24714 #+LINK: %s
24715 "
24717 org-export-headline-levels
24718 org-export-with-section-numbers
24719 org-export-with-toc
24720 org-export-preserve-breaks
24721 org-export-html-expand
24722 org-export-with-fixed-width
24723 org-export-with-tables
24724 org-export-with-sub-superscripts
24725 org-export-with-special-strings
24726 org-export-with-footnotes
24727 org-export-with-emphasize
24728 org-export-with-TeX-macros
24729 org-export-with-LaTeX-fragments
24730 org-export-skip-text-before-1st-heading
24731 org-export-with-drawers
24732 org-export-with-tags
24734 "TODO FEEDBACK VERIFY DONE"
24735 "Me Jason Marie DONE"
24736 org-highest-priority org-lowest-priority org-default-priority
24753 org-archive-location
24754 "org file:~/org/%s.org"
24755 ))
24758 "Insert into the buffer a template with information for exporting."
24767 "Toggle the fixed-width export.
24768 If there is no active region, the QUOTE keyword at the current headline is
24769 inserted or removed. When present, it causes the text between this headline
24770 and the next to be exported as fixed-width text, and unmodified.
24771 If there is an active region, this command adds or removes a colon as the
24772 first character of this line. If the first character of a line is a colon,
24773 this line is also exported in fixed-width font."
24782 off)
24812 "Export the outline as HTML and immediately open it with a browser.
24813 If there is an active region, export only the region.
24814 The prefix ARG specifies how many levels of the outline should become
24815 headlines. The default is 3. Lower levels will become bulleted lists."
24821 "Call `org-export-as-html', may be used in batch processing as
24822 emacs --batch
24823 --load=$HOME/lib/emacs/org.el
24825 --visit=MyFile --funcall org-export-as-html-batch"
24829 "Call `org-exort-as-html` with output to a temporary buffer.
24830 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24836 "Assume the current region has org-mode syntax, and convert it to HTML.
24837 This can be used in any buffer. For example, you could write an
24838 itemized list in org-mode syntax in an HTML buffer and then use this
24839 command to convert it."
24859 "Convert region from BEG to END in org-mode buffer to HTML.
24860 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24861 contents, and only produce the region of converted text, useful for
24862 cut-and-paste operations.
24863 If BUFFER is a buffer or a string, use/create that buffer as a target
24864 of the converted HTML. If BUFFER is the symbol `string', return the
24865 produced HTML as a string and leave not buffer behind. For example,
24866 a Lisp program could call this function in the following way:
24868 (setq html (org-export-region-as-html beg end t 'string))
24870 When called interactively, the output buffer is selected, and shown
24871 in a window. A non-interactive call will only retunr the buffer."
24876 rtn)
24881 nil nil nil
24882 buffer body-only))
24886 rtn)))
24890 to-buffer body-only)
24891 "Export the outline as a pretty HTML file.
24892 If there is an active region, export only the region. The prefix
24893 ARG specifies how many levels of the outline should become
24894 headlines. The default is 3. Lower levels will become bulleted
24895 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24896 EXT-PLIST is a property list with external parameters overriding
24897 org-mode's default settings, but still inferior to file-local
24898 settings. When TO-BUFFER is non-nil, create a buffer with that
24899 name and export to that buffer. If TO-BUFFER is the symbol `string',
24900 don't leave any buffer behind but just return the resulting HTML as
24901 a string. When BODY-ONLY is set, don't produce the file header and footer,
24902 simply return the content of <body>...</body>, without even
24903 the body tags themselves."
24906 ;; Make sure we have a file name when we need it.
24912 buffer-file-name))
24921 ext-plist
24927 valid thetoc have-headings first-heading-pos
24936 ;; The following two are dynamically scoped into other
24937 ;; routines below.
24956 default-directory))
24990 buffer-file-coding-system))
24992 coding-system))
24994 coding-system))
25006 region
25007 :emph-multiline t
25008 :for-html t
25009 :skip-before-1st-heading
25012 :archived-trees
25014 :add-text
25016 :LaTeX-fragments
25019 table-open type
25020 table-buffer table-orig-buffer
25021 ind start-is-num starter didclose
25022 rpl path desc descp desc1 desc2 link
25023 )
25042 ;; Get the language-dependent settings
25046 ;; Switch to the output buffer
25056 ;; create local variables for all options, to make sure all called
25057 ;; functions get the correct information
25061 org-export-plist-vars)
25063 org-export-headline-levels))
25066 umax))
25068 ;; File header
25074 <head>
25075 <title>%s</title>
25080 %s
25081 </head><body>
25082 "
25095 org-export-html-toplevel-hlevel
25097 org-export-html-toplevel-hlevel)
25098 thetoc)
25103 ;; This is a headline
25112 todo
25116 org-done-keywords)))
25117 ; TODO, not DONE
25121 line lines level))))
25146 ;; Check for targets
25151 t t line))
25154 target-alist))
25165 )))
25166 line)
25167 lines))
25179 ;; end of quote section?
25183 ;; inside a quote section?
25188 ;; verbatim lines
25202 ;; Protected HTML
25217 ;; Horizontal line
25222 ;; make targets to anchors
25230 t t line)))
25234 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25235 t t line)))
25241 t t line)))))
25245 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25246 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25247 ;; Also handle sub_superscripts and checkboxes
25251 ;; Format the links
25261 ;; Make an image out of the description if that is so wanted
25267 ;; FIXME: do we need to unescape here somewhere?
25277 ;; standard URL, just check if we need to inline an image
25285 ;; standard URL
25289 ;; FILE link
25292 thefile file-is-image-p search)
25300 t))
25309 ;; make sure this is can be used as target search
25334 ;; TODO items
25342 org-done-keywords)
25347 ;; Does this contain a reference to a footnote?
25359 t t line))))))
25363 ;; This is a headline
25371 ;; Close any local lists before inserting a new header line
25377 in-local-list nil))
25381 head-count)
25382 ;; QUOTES
25390 ;; New table starts
25392 ;; Accumulate lines
25404 ;; Normal lines
25407 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25408 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25411 line)
25418 ;; empty line. Pretend indentation is large.
25420 0
25436 ;; Start new (level of) list
25443 ;; continue current list
25447 ;; we did close a list, normal text follows: need <p>
25453 "<b>[X]</b>"
25455 t t line))))
25457 ;; Empty lines start a new paragraph. If hand-formatted lists
25458 ;; are not fully interpreted, lines starting with "-", "+", "*"
25459 ;; also start a new paragraph.
25462 ;; Is this the start of a footnote?
25468 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25470 ;; Check if the line break needs to be conserved
25479 ;; Properly close all local lists and other lists
25482 ;; Close any local lists before inserting a new header line
25488 in-local-list nil))
25491 head-count)
25522 ;; insert the table of contents
25539 ;; remove empty paragraphs and lists
25549 ;; Convert whitespace place holders
25570 "Format a table for ascii export."
25574 ;; Table made by table.el - test for spanning
25575 lines
25577 ;; A normal org table
25578 ;; Get rid of hlines at beginning and end
25584 ;; Check if the table has a marking column. If yes remove the
25585 ;; column and the special lines
25587 ;; Get rid of the vertical lines except for grouping
25589 rtn line vl1 start)
25611 vl))
25614 "Find out which HTML converter to use and return the HTML code."
25618 ;; A normal org table
25620 ;; Table made by table.el - test for spanning
25624 nil))
25625 lines)))
25631 hlines))))
25634 ;; We can use my own converter with HTML conversions
25636 ;; Need to use the code generator in table.el, with the original text.
25640 "Format a table into HTML."
25641 ;; Get rid of hlines at beginning and end
25647 ;; Check if the table has a marking column. If yes remove the
25648 ;; column and the special lines
25656 tbopen line fields html gr colgropen)
25668 ;; ignore this line
25670 ;; Break the line into fields
25688 html)))
25693 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25709 html)
25715 "Check if the table has a marking column.
25716 If yes remove the column and the special lines."
25722 lines))
25737 nil)
25739 lines)))
25753 nil)
25758 ;; remove the first column
25760 lines))))
25763 "Format a table generated by table.el into HTML.
25764 This conversion does *not* use `table-generate-source' from table.el.
25765 This has the advantage that Org-mode's HTML conversions can be used.
25766 But it has the disadvantage, that no cell- or row-spanning is allowed."
25769 fields html empty)
25779 html
25781 html
25782 "<tr>"
25795 ;; Ignore this line
25797 ;; Break the line into fields and store the fields
25803 field-buffer))
25806 html))
25809 "Format a table into html, using `table-generate-source' from table.el.
25810 This has the advantage that cell- or row-spanning is allowed.
25811 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25826 "Format time stamps in string S, or remove them."
25831 ;; never export CLOCK
25846 ;; Line break if line started and ended with time stamp stuff
25848 s
25852 r))))
25855 ;; convert & to &, < to < and > to >
25864 s)
25867 "Remove tags and time staps from lines going into the toc."
25876 t t s)))
25877 s)
25880 "Prepare STRING for HTML export. Applies all active conversions.
25881 If there are links in the string, don't modify these."
25884 m s l res)
25895 "Apply all active conversions to translate special ASCII to HTML."
25916 t t s))
25918 s)
25921 "Create a regular expression which will match a balanced sexp.
25922 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25923 as single character strings.
25924 The regexp returned will match the entire expression including the
25925 delimiters. It will also define a single group which contains the
25926 match except for the outermost delimiters. The maximum depth of
25927 stacked delimiters is N. Escaping delimiters is not possible."
25963 "Convert special characters in STRING to HTML."
25965 e a re rpl start)
25972 string))
25975 "Convert sub- and superscripts in STRING to HTML."
25991 t t string)))))
25994 string))
25997 "Apply emphasis."
26004 rpl
26010 org-emphasis-alist))
26015 string))
26019 "Insert <p>, but first close previous paragraph if any."
26024 "Close paragraph if there is one open."
26029 "Close <li> if necessary."
26035 "Insert a new level in HTML export.
26036 When TITLE is nil, just close all open levels."
26046 ;; If title is nil, this means this function is called to close
26047 ;; all levels, so the rest is done only if title is given
26059 t t title)))
26075 level level head-count title level))
26080 "Terminate one level in HTML export."
26086 ;;; iCalendar export
26088 ;;;###autoload
26090 "Export current file as an iCalendar file.
26091 The iCalendar file will be located in the same directory as the Org-mode
26092 file, but with extension `.ics'."
26096 ;;;###autoload
26098 "Export all files in `org-agenda-files' to iCalendar .ics files.
26099 Each iCalendar file will be located in the same directory as the Org-mode
26100 file, but with extension `.ics'."
26104 ;;;###autoload
26106 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26107 The file is stored under the name `org-combined-agenda-icalendar-file'."
26112 "Create iCalendar files for all elements of FILES.
26113 If COMBINE is non-nil, combine all calendar entries into a single large
26114 file and store it under the name `org-combined-agenda-icalendar-file'."
26119 org-export-publishing-directory)))
26120 file ical-file ical-buffer category started org-agenda-new-buffers)
26126 org-combined-agenda-icalendar-file
26159 "Hook run after an iCalendar file has been saved.
26160 The iCalendar buffer is still current when this hook is run.
26161 A good way to use this is to tell a desktop calenndar application to re-read
26165 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26166 When COMBINE is non nil, add the category to each line."
26173 scheduledp deadlinep tmp pri category entry location summary desc
26183 inc t
26190 t org-icalendar-include-body)
26200 pos)
26205 ts)
26208 ;; donep (org-entry-is-done-p)
26209 ))
26228 t t summary)))
26235 %s
26236 %s%s
26237 SUMMARY:%s%s%s
26238 CATEGORIES:%s
26242 rrule summary
26247 category)))))
26252 ;; Get all the literal sexps
26278 )
26285 t org-icalendar-include-body)
26291 t t hd)))
26301 %s
26302 SUMMARY:%s%s%s
26303 CATEGORIES:%s
26304 SEQUENCE:1
26305 PRIORITY:%d
26306 STATUS:%s
26308 dts
26314 category pri status)))))))))
26317 "Take out stuff and quote what needs to be quoted.
26318 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26319 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26320 characters."
26322 nil
26341 s))
26344 "Clean-up description string."
26350 "Start an iCalendar file by inserting the header."
26356 VERSION:2.0
26357 X-WR-CALNAME:%s
26358 PRODID:-//%s//Emacs with Org-mode//EN
26359 X-WR-TIMEZONE:%s
26363 "Finish an iCalendar file by inserting the END statement."
26367 "Take a time string S and convert it to iCalendar format.
26368 KEYWORD is added in front, to make a complete line like DTSTART....
26369 When INC is non-nil, increase the hour by two (if time string contains
26370 a time), or the day by one (if it does not contain a time)."
26372 t2 fmt have-time time)
26388 ;;; XOXO export
26396 "Export the org buffer as XOXO.
26397 The XOXO buffer is named *xoxo-<source buffer name>*"
26399 ;; A quickie abstraction
26401 ;; Output everything as XOXO
26415 ;; Check the output buffer is empty.
26417 ;; Kick off the output
26434 ;; Handle level rendering
26451 )
26455 ;; And output the new li
26461 ;; Finally finish off the ol
26468 ;; Finish the buffer off and clean it up.
26473 )))
26476 ;;;; Key bindings
26478 ;; Make `C-c C-x' a prefix key
26481 ;; TAB key with modifiers
26488 ;; The following line is necessary under Suse GNU/Linux
26494 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26495 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26496 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26498 ;; Cursor keys with modifiers
26499 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26500 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26501 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26502 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26504 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26505 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26506 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26507 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26509 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26510 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26511 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26512 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26514 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26515 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26517 ;;; Extra keys for tty access.
26518 ;; We only set them when really needed because otherwise the
26519 ;; menus don't show the simple keys
26521 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26522 (not window-system))
26523 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26524 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26525 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26526 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26527 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26528 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26529 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26530 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26531 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26532 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26533 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26534 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26535 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26536 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26537 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26538 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26539 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26540 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26541 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26542 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26543 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26544 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26546 ;; All the other keys
26548 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26549 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26550 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26551 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26552 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26553 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26554 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26555 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26556 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26557 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26558 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26559 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26560 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26561 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26562 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26564 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26565 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26566 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26567 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26568 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26569 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26570 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26571 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26572 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26573 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26574 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26575 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26576 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26577 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26578 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26579 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26580 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26582 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26583 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26584 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26585 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26586 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26587 (org-defkey org-mode-map "\C-c^" 'org-sort)
26588 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26589 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26590 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26591 (org-defkey org-mode-map "\C-m" 'org-return)
26592 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26593 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26594 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26595 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26596 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26597 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26598 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26599 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26600 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26601 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26602 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26603 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26604 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26605 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26606 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26607 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26608 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26610 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26611 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26612 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26613 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26615 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26616 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26617 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26618 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26619 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26620 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26621 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26622 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26623 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26624 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26625 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26626 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26628 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26630 (when (featurep 'xemacs)
26631 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26633 (defsubst org-table-p () (org-at-table-p))
26635 (defun org-self-insert-command (N)
26636 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26637 If the cursor is in a table looking at whitespace, the whitespace is
26638 overwritten, and the table is not marked as requiring realignment."
26639 (interactive "p")
26640 (if (and (org-table-p)
26641 (progn
26642 ;; check if we blank the field, and if that triggers align
26643 (and org-table-auto-blank-field
26644 (member last-command
26645 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26647 ;; got extra space, this field does not determine column width
26648 (let (org-table-may-need-update) (org-table-blank-field))
26649 ;; no extra space, this field may determine column width
26650 (org-table-blank-field)))
26651 t)
26652 (eq N 1)
26654 (let (org-table-may-need-update)
26655 (goto-char (1- (match-end 0)))
26656 (delete-backward-char 1)
26657 (goto-char (match-beginning 0))
26658 (self-insert-command N))
26659 (setq org-table-may-need-update t)
26660 (self-insert-command N)
26661 (org-fix-tags-on-the-fly)))
26663 (defun org-fix-tags-on-the-fly ()
26664 (when (and (equal (char-after (point-at-bol)) ?*)
26665 (org-on-heading-p))
26666 (org-align-tags-here org-tags-column)))
26668 (defun org-delete-backward-char (N)
26669 "Like `delete-backward-char', insert whitespace at field end in tables.
26670 When deleting backwards, in tables this function will insert whitespace in
26672 still be marked for re-alignment if the field did fill the entire column,
26673 because, in this case the deletion might narrow the column."
26674 (interactive "p")
26675 (if (and (org-table-p)
26676 (eq N 1)
26677 (string-match "|" (buffer-substring (point-at-bol) (point)))
26678 (looking-at ".*?|"))
26679 (let ((pos (point))
26681 (c org-table-may-need-update))
26682 (backward-delete-char N)
26683 (skip-chars-forward "^|")
26684 (insert " ")
26685 (goto-char (1- pos))
26686 ;; noalign: if there were two spaces at the end, this field
26687 ;; does not determine the width of the column.
26688 (if noalign (setq org-table-may-need-update c)))
26689 (backward-delete-char N)
26690 (org-fix-tags-on-the-fly)))
26692 (defun org-delete-char (N)
26693 "Like `delete-char', but insert whitespace at field end in tables.
26694 When deleting characters, in tables this function will insert whitespace in
26696 still be marked for re-alignment if the field did fill the entire column,
26697 because, in this case the deletion might narrow the column."
26698 (interactive "p")
26699 (if (and (org-table-p)
26700 (not (bolp))
26701 (not (= (char-after) ?|))
26702 (eq N 1))
26703 (if (looking-at ".*?|")
26704 (let ((pos (point))
26706 (c org-table-may-need-update))
26707 (replace-match (concat
26708 (substring (match-string 0) 1 -1)
26709 " |"))
26710 (goto-char pos)
26711 ;; noalign: if there were two spaces at the end, this field
26712 ;; does not determine the width of the column.
26713 (if noalign (setq org-table-may-need-update c)))
26714 (delete-char N))
26715 (delete-char N)
26716 (org-fix-tags-on-the-fly)))
26718 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26719 (put 'org-self-insert-command 'delete-selection t)
26720 (put 'orgtbl-self-insert-command 'delete-selection t)
26721 (put 'org-delete-char 'delete-selection 'supersede)
26722 (put 'org-delete-backward-char 'delete-selection 'supersede)
26724 ;; Make `flyspell-mode' delay after some commands
26725 (put 'org-self-insert-command 'flyspell-delayed t)
26726 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26727 (put 'org-delete-char 'flyspell-delayed t)
26728 (put 'org-delete-backward-char 'flyspell-delayed t)
26730 ;; Make pabbrev-mode expand after org-mode commands
26731 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26732 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26734 ;; How to do this: Measure non-white length of current string
26735 ;; If equal to column width, we should realign.
26737 (defun org-remap (map &rest commands)
26738 "In MAP, remap the functions given in COMMANDS.
26739 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26740 (let (new old)
26741 (while commands
26742 (setq old (pop commands) new (pop commands))
26743 (if (fboundp 'command-remapping)
26744 (org-defkey map (vector 'remap old) new)
26745 (substitute-key-definition old new map global-map)))))
26747 (when (eq org-enable-table-editor 'optimized)
26748 ;; If the user wants maximum table support, we need to hijack
26749 ;; some standard editing functions
26750 (org-remap org-mode-map
26751 'self-insert-command 'org-self-insert-command
26752 'delete-char 'org-delete-char
26753 'delete-backward-char 'org-delete-backward-char)
26754 (org-defkey org-mode-map "|" 'org-force-self-insert))
26756 (defun org-shiftcursor-error ()
26757 "Throw an error because Shift-Cursor command was applied in wrong context."
26758 (error "This command is active in special context like tables, headlines or timestamps"))
26760 (defun org-shifttab (&optional arg)
26761 "Global visibility cycling or move to previous table field.
26762 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26763 on context.
26764 See the individual commands for more information."
26765 (interactive "P")
26766 (cond
26767 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26768 (arg (message "Content view to level: ")
26769 (org-content (prefix-numeric-value arg))
26770 (setq org-cycle-global-status 'overview))
26771 (t (call-interactively 'org-global-cycle))))
26773 (defun org-shiftmetaleft ()
26774 "Promote subtree or delete table column.
26775 Calls `org-promote-subtree', `org-outdent-item',
26776 or `org-table-delete-column', depending on context.
26777 See the individual commands for more information."
26778 (interactive)
26779 (cond
26780 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26781 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26782 ((org-at-item-p) (call-interactively 'org-outdent-item))
26783 (t (org-shiftcursor-error))))
26785 (defun org-shiftmetaright ()
26786 "Demote subtree or insert table column.
26787 Calls `org-demote-subtree', `org-indent-item',
26788 or `org-table-insert-column', depending on context.
26789 See the individual commands for more information."
26790 (interactive)
26791 (cond
26792 ((org-at-table-p) (call-interactively 'org-table-insert-column))
26793 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26794 ((org-at-item-p) (call-interactively 'org-indent-item))
26795 (t (org-shiftcursor-error))))
26797 (defun org-shiftmetaup (&optional arg)
26798 "Move subtree up or kill table row.
26799 Calls `org-move-subtree-up' or `org-table-kill-row' or
26800 `org-move-item-up' depending on context. See the individual commands
26801 for more information."
26802 (interactive "P")
26803 (cond
26804 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26805 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26806 ((org-at-item-p) (call-interactively 'org-move-item-up))
26807 (t (org-shiftcursor-error))))
26808 (defun org-shiftmetadown (&optional arg)
26809 "Move subtree down or insert table row.
26810 Calls `org-move-subtree-down' or `org-table-insert-row' or
26811 `org-move-item-down', depending on context. See the individual
26812 commands for more information."
26813 (interactive "P")
26814 (cond
26815 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26816 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26817 ((org-at-item-p) (call-interactively 'org-move-item-down))
26818 (t (org-shiftcursor-error))))
26820 (defun org-metaleft (&optional arg)
26821 "Promote heading or move table column to left.
26822 Calls `org-do-promote' or `org-table-move-column', depending on context.
26823 With no specific context, calls the Emacs default `backward-word'.
26824 See the individual commands for more information."
26825 (interactive "P")
26826 (cond
26827 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26828 ((or (org-on-heading-p) (org-region-active-p))
26829 (call-interactively 'org-do-promote))
26830 ((org-at-item-p) (call-interactively 'org-outdent-item))
26831 (t (call-interactively 'backward-word))))
26833 (defun org-metaright (&optional arg)
26834 "Demote subtree or move table column to right.
26835 Calls `org-do-demote' or `org-table-move-column', depending on context.
26836 With no specific context, calls the Emacs default `forward-word'.
26837 See the individual commands for more information."
26838 (interactive "P")
26839 (cond
26840 ((org-at-table-p) (call-interactively 'org-table-move-column))
26841 ((or (org-on-heading-p) (org-region-active-p))
26842 (call-interactively 'org-do-demote))
26843 ((org-at-item-p) (call-interactively 'org-indent-item))
26844 (t (call-interactively 'forward-word))))
26846 (defun org-metaup (&optional arg)
26847 "Move subtree up or move table row up.
26848 Calls `org-move-subtree-up' or `org-table-move-row' or
26849 `org-move-item-up', depending on context. See the individual commands
26850 for more information."
26851 (interactive "P")
26852 (cond
26853 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26854 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26855 ((org-at-item-p) (call-interactively 'org-move-item-up))
26856 (t (transpose-lines 1) (beginning-of-line -1))))
26858 (defun org-metadown (&optional arg)
26859 "Move subtree down or move table row down.
26860 Calls `org-move-subtree-down' or `org-table-move-row' or
26861 `org-move-item-down', depending on context. See the individual
26862 commands for more information."
26863 (interactive "P")
26864 (cond
26865 ((org-at-table-p) (call-interactively 'org-table-move-row))
26866 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26867 ((org-at-item-p) (call-interactively 'org-move-item-down))
26868 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26870 (defun org-shiftup (&optional arg)
26871 "Increase item in timestamp or increase priority of current headline.
26872 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26873 depending on context. See the individual commands for more information."
26874 (interactive "P")
26875 (cond
26876 ((org-at-timestamp-p t)
26877 (call-interactively (if org-edit-timestamp-down-means-later
26878 'org-timestamp-down 'org-timestamp-up)))
26879 ((org-on-heading-p) (call-interactively 'org-priority-up))
26880 ((org-at-item-p) (call-interactively 'org-previous-item))
26881 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26883 (defun org-shiftdown (&optional arg)
26884 "Decrease item in timestamp or decrease priority of current headline.
26885 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26886 depending on context. See the individual commands for more information."
26887 (interactive "P")
26888 (cond
26889 ((org-at-timestamp-p t)
26890 (call-interactively (if org-edit-timestamp-down-means-later
26891 'org-timestamp-up 'org-timestamp-down)))
26892 ((org-on-heading-p) (call-interactively 'org-priority-down))
26893 (t (call-interactively 'org-next-item))))
26895 (defun org-shiftright ()
26896 "Next TODO keyword or timestamp one day later, depending on context."
26897 (interactive)
26898 (cond
26899 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26900 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26901 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26902 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26903 (t (org-shiftcursor-error))))
26905 (defun org-shiftleft ()
26906 "Previous TODO keyword or timestamp one day earlier, depending on context."
26907 (interactive)
26908 (cond
26909 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26910 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26911 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26912 ((org-at-property-p)
26913 (call-interactively 'org-property-previous-allowed-value))
26914 (t (org-shiftcursor-error))))
26916 (defun org-shiftcontrolright ()
26917 "Switch to next TODO set."
26918 (interactive)
26919 (cond
26920 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26921 (t (org-shiftcursor-error))))
26923 (defun org-shiftcontrolleft ()
26924 "Switch to previous TODO set."
26925 (interactive)
26926 (cond
26927 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26928 (t (org-shiftcursor-error))))
26930 (defun org-ctrl-c-ret ()
26931 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26932 (interactive)
26933 (cond
26934 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26935 (t (call-interactively 'org-insert-heading))))
26937 (defun org-copy-special ()
26938 "Copy region in table or copy current subtree.
26939 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26940 See the individual commands for more information."
26941 (interactive)
26942 (call-interactively
26943 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26945 (defun org-cut-special ()
26946 "Cut region in table or cut current subtree.
26947 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26948 See the individual commands for more information."
26949 (interactive)
26950 (call-interactively
26951 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26953 (defun org-paste-special (arg)
26954 "Paste rectangular region into table, or past subtree relative to level.
26955 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26956 See the individual commands for more information."
26957 (interactive "P")
26958 (if (org-at-table-p)
26959 (org-table-paste-rectangle)
26960 (org-paste-subtree arg)))
26962 (defun org-ctrl-c-ctrl-c (&optional arg)
26963 "Set tags in headline, or update according to changed information at point.
26965 This command does many different things, depending on context:
26967 - If the cursor is in a headline, prompt for tags and insert them
26968 into the current line, aligned to `org-tags-column'. When called
26969 with prefix arg, realign all tags in the current buffer.
26971 - If the cursor is in one of the special #+KEYWORD lines, this
26972 triggers scanning the buffer for these lines and updating the
26973 information.
26975 - If the cursor is inside a table, realign the table. This command
26976 works even if the automatic table editor has been turned off.
26978 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26979 the entire table.
26981 - If the cursor is a the beginning of a dynamic block, update it.
26983 - If the cursor is inside a table created by the table.el package,
26984 activate that table.
26986 - If the current buffer is a remember buffer, close note and file it.
26987 with a prefix argument, file it without further interaction to the default
26988 location.
26990 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26991 links in this buffer.
26993 - If the cursor is on a numbered item in a plain list, renumber the
26994 ordered list.
26996 - If the cursor is on a checkbox, toggle it."
26997 (interactive "P")
26998 (let ((org-enable-table-editor t))
26999 (cond
27000 ((or org-clock-overlays
27001 org-occur-highlights
27002 org-latex-fragment-image-overlays)
27003 (org-remove-clock-overlays)
27004 (org-remove-occur-highlights)
27005 (org-remove-latex-fragment-image-overlays)
27006 (message "Temporary highlights/overlays removed from current buffer"))
27007 ((and (local-variable-p 'org-finish-function (current-buffer))
27008 (fboundp org-finish-function))
27009 (funcall org-finish-function))
27010 ((org-at-property-p)
27011 (call-interactively 'org-property-action))
27012 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27013 ((org-on-heading-p) (call-interactively 'org-set-tags))
27014 ((org-at-table.el-p)
27015 (require 'table)
27016 (beginning-of-line 1)
27017 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27018 (call-interactively 'table-recognize-table))
27019 ((org-at-table-p)
27020 (org-table-maybe-eval-formula)
27021 (if arg
27022 (call-interactively 'org-table-recalculate)
27023 (org-table-maybe-recalculate-line))
27024 (call-interactively 'org-table-align))
27025 ((org-at-item-checkbox-p)
27026 (call-interactively 'org-toggle-checkbox))
27027 ((org-at-item-p)
27028 (call-interactively 'org-maybe-renumber-ordered-list))
27030 ;; Dynamic block
27031 (beginning-of-line 1)
27032 (org-update-dblock))
27034 (cond
27035 ((equal (match-string 1) "TBLFM")
27036 ;; Recalculate the table before this line
27037 (save-excursion
27038 (beginning-of-line 1)
27040 (if (org-at-table-p)
27041 (org-call-with-arg 'org-table-recalculate t))))
27042 (t
27043 (call-interactively 'org-mode-restart))))
27044 (t (error "C-c C-c can do nothing useful at this location.")))))
27046 (defun org-mode-restart ()
27047 "Restart Org-mode, to scan again for special lines.
27048 Also updates the keyword regular expressions."
27049 (interactive)
27050 (let ((org-inhibit-startup t)) (org-mode))
27051 (message "Org-mode restarted to refresh keyword and special line setup"))
27053 (defun org-kill-note-or-show-branches ()
27054 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27055 (interactive)
27056 (if (not org-finish-function)
27057 (call-interactively 'show-branches)
27058 (let ((org-note-abort t))
27059 (funcall org-finish-function))))
27061 (defun org-return (&optional indent)
27062 "Goto next table row or insert a newline.
27063 Calls `org-table-next-row' or `newline', depending on context.
27064 See the individual commands for more information."
27065 (interactive)
27066 (cond
27067 ((bobp) (if indent (newline-and-indent) (newline)))
27068 ((and (org-at-heading-p)
27069 (looking-at
27071 (org-show-entry)
27072 (end-of-line 1)
27073 (newline))
27074 ((org-at-table-p)
27075 (org-table-justify-field-maybe)
27076 (call-interactively 'org-table-next-row))
27077 (t (if indent (newline-and-indent) (newline)))))
27079 (defun org-return-indent ()
27080 (interactive)
27081 "Goto next table row or insert a newline and indent.
27082 Calls `org-table-next-row' or `newline-and-indent', depending on
27083 context. See the individual commands for more information."
27084 (org-return t))
27086 (defun org-ctrl-c-minus ()
27087 "Insert separator line in table or modify bullet type in list.
27088 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
27089 depending on context."
27090 (interactive)
27091 (cond
27092 ((org-at-table-p)
27093 (call-interactively 'org-table-insert-hline))
27094 ((org-on-heading-p)
27095 ;; Convert to item
27096 (save-excursion
27097 (beginning-of-line 1)
27099 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27100 ((org-in-item-p)
27101 (call-interactively 'org-cycle-list-bullet))
27102 (t (error "`C-c -' does have no function here."))))
27104 (defun org-meta-return (&optional arg)
27105 "Insert a new heading or wrap a region in a table.
27106 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27107 See the individual commands for more information."
27108 (interactive "P")
27109 (cond
27110 ((org-at-table-p)
27111 (call-interactively 'org-table-wrap-region))
27112 (t (call-interactively 'org-insert-heading))))
27114 ;;; Menu entries
27116 ;; Define the Org-mode menus
27117 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27118 '("Tbl"
27119 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27120 ["Next Field" org-cycle (org-at-table-p)]
27121 ["Previous Field" org-shifttab (org-at-table-p)]
27122 ["Next Row" org-return (org-at-table-p)]
27123 "--"
27124 ["Blank Field" org-table-blank-field (org-at-table-p)]
27125 ["Edit Field" org-table-edit-field (org-at-table-p)]
27126 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27127 "--"
27128 ("Column"
27129 ["Move Column Left" org-metaleft (org-at-table-p)]
27130 ["Move Column Right" org-metaright (org-at-table-p)]
27131 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27132 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27133 ("Row"
27134 ["Move Row Up" org-metaup (org-at-table-p)]
27135 ["Move Row Down" org-metadown (org-at-table-p)]
27136 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27137 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27138 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27139 "--"
27140 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27141 ("Rectangle"
27142 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27143 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27144 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27145 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27146 "--"
27147 ("Calculate"
27148 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27149 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27150 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27151 "--"
27152 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27153 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27154 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27155 "--"
27156 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27157 "--"
27158 ["Sum Column/Rectangle" org-table-sum
27159 (or (org-at-table-p) (org-region-active-p))]
27160 ["Which Column?" org-table-current-column (org-at-table-p)])
27161 ["Debug Formulas"
27162 org-table-toggle-formula-debugger
27163 :style toggle :selected org-table-formula-debug]
27164 ["Show Col/Row Numbers"
27165 org-table-toggle-coordinate-overlays
27166 :style toggle :selected org-table-overlay-coordinates]
27167 "--"
27168 ["Create" org-table-create (and (not (org-at-table-p))
27169 org-enable-table-editor)]
27170 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27171 ["Import from File" org-table-import (not (org-at-table-p))]
27172 ["Export to File" org-table-export (org-at-table-p)]
27173 "--"
27174 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27176 (easy-menu-define org-org-menu org-mode-map "Org menu"
27177 '("Org"
27178 ("Show/Hide"
27179 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27180 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27181 ["Sparse Tree" org-occur t]
27182 ["Reveal Context" org-reveal t]
27183 ["Show All" show-all t]
27184 "--"
27185 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27186 "--"
27187 ["New Heading" org-insert-heading t]
27188 ("Navigate Headings"
27189 ["Up" outline-up-heading t]
27190 ["Next" outline-next-visible-heading t]
27191 ["Previous" outline-previous-visible-heading t]
27192 ["Next Same Level" outline-forward-same-level t]
27193 ["Previous Same Level" outline-backward-same-level t]
27194 "--"
27195 ["Jump" org-goto t])
27196 ("Edit Structure"
27197 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27198 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27199 "--"
27200 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27201 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27202 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27203 "--"
27204 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27205 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27206 ["Demote Heading" org-metaright (not (org-at-table-p))]
27207 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27208 "--"
27209 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27210 "--"
27211 ["Convert to odd levels" org-convert-to-odd-levels t]
27212 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27213 ("Editing"
27214 ["Emphasis..." org-emphasize t])
27215 ("Archive"
27216 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27217 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27218 ; :active t :keys "C-u C-c C-x C-a"]
27219 ["Sparse trees open ARCHIVE trees"
27220 (setq org-sparse-tree-open-archived-trees
27221 (not org-sparse-tree-open-archived-trees))
27222 :style toggle :selected org-sparse-tree-open-archived-trees]
27223 ["Cycling opens ARCHIVE trees"
27224 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27225 :style toggle :selected org-cycle-open-archived-trees]
27226 ["Agenda includes ARCHIVE trees"
27227 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27228 :style toggle :selected (not org-agenda-skip-archived-trees)]
27229 "--"
27230 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27231 ; ["Check and Move Children" (org-archive-subtree '(4))
27232 ; :active t :keys "C-u C-c C-x C-s"]
27233 )
27234 "--"
27235 ("TODO Lists"
27236 ["TODO/DONE/-" org-todo t]
27237 ("Select keyword"
27238 ["Next keyword" org-shiftright (org-on-heading-p)]
27239 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27240 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27241 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27242 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27243 ["Show TODO Tree" org-show-todo-tree t]
27244 ["Global TODO list" org-todo-list t]
27245 "--"
27246 ["Set Priority" org-priority t]
27247 ["Priority Up" org-shiftup t]
27248 ["Priority Down" org-shiftdown t])
27249 ("TAGS and Properties"
27250 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27251 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27252 "--"
27253 ["Set property" 'org-set-property t]
27254 ["Column view of properties" org-columns t]
27255 ["Insert Column View DBlock" org-insert-columns-dblock t])
27256 ("Dates and Scheduling"
27257 ["Timestamp" org-time-stamp t]
27258 ["Timestamp (inactive)" org-time-stamp-inactive t]
27259 ("Change Date"
27260 ["1 Day Later" org-shiftright t]
27261 ["1 Day Earlier" org-shiftleft t]
27262 ["1 ... Later" org-shiftup t]
27263 ["1 ... Earlier" org-shiftdown t])
27264 ["Compute Time Range" org-evaluate-time-range t]
27265 ["Schedule Item" org-schedule t]
27266 ["Deadline" org-deadline t]
27267 "--"
27268 ["Custom time format" org-toggle-time-stamp-overlays
27269 :style radio :selected org-display-custom-times]
27270 "--"
27271 ["Goto Calendar" org-goto-calendar t]
27272 ["Date from Calendar" org-date-from-calendar t])
27273 ("Logging work"
27274 ["Clock in" org-clock-in t]
27275 ["Clock out" org-clock-out t]
27276 ["Clock cancel" org-clock-cancel t]
27277 ["Goto running clock" org-clock-goto t]
27278 ["Display times" org-clock-display t]
27279 ["Create clock table" org-clock-report t]
27280 "--"
27281 ["Record DONE time"
27282 (progn (setq org-log-done (not org-log-done))
27283 (message "Switching to %s will %s record a timestamp"
27284 (car org-done-keywords)
27285 (if org-log-done "automatically" "not")))
27286 :style toggle :selected org-log-done])
27287 "--"
27288 ["Agenda Command..." org-agenda t]
27289 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27290 ("File List for Agenda")
27291 ("Special views current file"
27292 ["TODO Tree" org-show-todo-tree t]
27293 ["Check Deadlines" org-check-deadlines t]
27294 ["Timeline" org-timeline t]
27295 ["Tags Tree" org-tags-sparse-tree t])
27296 "--"
27297 ("Hyperlinks"
27298 ["Store Link (Global)" org-store-link t]
27299 ["Insert Link" org-insert-link t]
27300 ["Follow Link" org-open-at-point t]
27301 "--"
27302 ["Next link" org-next-link t]
27303 ["Previous link" org-previous-link t]
27304 "--"
27305 ["Descriptive Links"
27306 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27307 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27308 ["Literal Links"
27309 (progn
27310 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27311 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27312 "--"
27313 ["Export/Publish..." org-export t]
27314 ("LaTeX"
27315 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27316 :selected org-cdlatex-mode]
27317 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27318 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27319 ["Modify math symbol" org-cdlatex-math-modify
27320 (org-inside-LaTeX-fragment-p)]
27321 ["Export LaTeX fragments as images"
27322 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27323 :style toggle :selected org-export-with-LaTeX-fragments])
27324 "--"
27325 ("Documentation"
27326 ["Show Version" org-version t]
27327 ["Info Documentation" org-info t])
27328 ("Customize"
27329 ["Browse Org Group" org-customize t]
27330 "--"
27331 ["Expand This Menu" org-create-customize-menu
27332 (fboundp 'customize-menu-create)])
27333 "--"
27334 ["Refresh setup" org-mode-restart t]
27335 ))
27337 (defun org-info (&optional node)
27338 "Read documentation for Org-mode in the info system.
27339 With optional NODE, go directly to that node."
27340 (interactive)
27341 (require 'info)
27342 (Info-goto-node (format "(org)%s" (or node ""))))
27344 (defun org-install-agenda-files-menu ()
27345 (let ((bl (buffer-list)))
27346 (save-excursion
27347 (while bl
27348 (set-buffer (pop bl))
27349 (if (org-mode-p) (setq bl nil)))
27350 (when (org-mode-p)
27351 (easy-menu-change
27352 '("Org") "File List for Agenda"
27353 (append
27354 (list
27355 ["Edit File List" (org-edit-agenda-file-list) t]
27356 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27357 ["Remove Current File from List" org-remove-file t]
27358 ["Cycle through agenda files" org-cycle-agenda-files t]
27359 ["Occur in all agenda files" org-occur-in-agenda-files t]
27360 "--")
27361 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27363 ;;;; Documentation
27365 (defun org-customize ()
27366 "Call the customize function with org as argument."
27367 (interactive)
27368 (customize-browse 'org))
27370 (defun org-create-customize-menu ()
27371 "Create a full customization menu for Org-mode, insert it into the menu."
27372 (interactive)
27373 (if (fboundp 'customize-menu-create)
27374 (progn
27375 (easy-menu-change
27376 '("Org") "Customize"
27377 `(["Browse Org group" org-customize t]
27378 "--"
27379 ,(customize-menu-create 'org)
27380 ["Set" Custom-set t]
27381 ["Save" Custom-save t]
27382 ["Reset to Current" Custom-reset-current t]
27383 ["Reset to Saved" Custom-reset-saved t]
27384 ["Reset to Standard Settings" Custom-reset-standard t]))
27386 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27388 ;;;; Miscellaneous stuff
27391 ;;; Generally useful functions
27393 (defun org-context ()
27394 "Return a list of contexts of the current cursor position.
27395 If several contexts apply, all are returned.
27396 Each context entry is a list with a symbol naming the context, and
27397 two positions indicating start and end of the context. Possible
27398 contexts are:
27400 :headline anywhere in a headline
27401 :headline-stars on the leading stars in a headline
27402 :todo-keyword on a TODO keyword (including DONE) in a headline
27403 :tags on the TAGS in a headline
27404 :priority on the priority cookie in a headline
27405 :item on the first line of a plain list item
27406 :item-bullet on the bullet/number of a plain list item
27407 :checkbox on the checkbox in a plain list item
27408 :table in an org-mode table
27409 :table-special on a special filed in a table
27410 :table-table in a table.el table
27411 :link on a hyperlink
27412 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27413 :target on a <<target>>
27414 :radio-target on a <<<radio-target>>>
27415 :latex-fragment on a LaTeX fragment
27416 :latex-preview on a LaTeX fragment with overlayed preview image
27418 This function expects the position to be visible because it uses font-lock
27419 faces as a help to recognize the following contexts: :table-special, :link,
27420 and :keyword."
27421 (let* ((f (get-text-property (point) 'face))
27422 (faces (if (listp f) f (list f)))
27423 (p (point)) clist o)
27424 ;; First the large context
27425 (cond
27426 ((org-on-heading-p t)
27427 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27428 (when (progn
27429 (beginning-of-line 1)
27430 (looking-at org-todo-line-tags-regexp))
27431 (push (org-point-in-group p 1 :headline-stars) clist)
27432 (push (org-point-in-group p 2 :todo-keyword) clist)
27433 (push (org-point-in-group p 4 :tags) clist))
27434 (goto-char p)
27437 (push (org-point-in-group p 0 :priority) clist)))
27439 ((org-at-item-p)
27440 (push (org-point-in-group p 2 :item-bullet) clist)
27441 (push (list :item (point-at-bol)
27442 (save-excursion (org-end-of-item) (point)))
27443 clist)
27444 (and (org-at-item-checkbox-p)
27445 (push (org-point-in-group p 0 :checkbox) clist)))
27447 ((org-at-table-p)
27448 (push (list :table (org-table-begin) (org-table-end)) clist)
27449 (if (memq 'org-formula faces)
27450 (push (list :table-special
27451 (previous-single-property-change p 'face)
27452 (next-single-property-change p 'face)) clist)))
27453 ((org-at-table-p 'any)
27454 (push (list :table-table) clist)))
27455 (goto-char p)
27457 ;; Now the small context
27458 (cond
27459 ((org-at-timestamp-p)
27460 (push (org-point-in-group p 0 :timestamp) clist))
27461 ((memq 'org-link faces)
27462 (push (list :link
27463 (previous-single-property-change p 'face)
27464 (next-single-property-change p 'face)) clist))
27465 ((memq 'org-special-keyword faces)
27466 (push (list :keyword
27467 (previous-single-property-change p 'face)
27468 (next-single-property-change p 'face)) clist))
27469 ((org-on-target-p)
27470 (push (org-point-in-group p 0 :target) clist)
27471 (goto-char (1- (match-beginning 0)))
27472 (if (looking-at org-radio-target-regexp)
27473 (push (org-point-in-group p 0 :radio-target) clist))
27474 (goto-char p))
27475 ((setq o (car (delq nil
27476 (mapcar
27477 (lambda (x)
27478 (if (memq x org-latex-fragment-image-overlays) x))
27479 (org-overlays-at (point))))))
27480 (push (list :latex-fragment
27481 (org-overlay-start o) (org-overlay-end o)) clist)
27482 (push (list :latex-preview
27483 (org-overlay-start o) (org-overlay-end o)) clist))
27484 ((org-inside-LaTeX-fragment-p)
27485 ;; FIXME: positions wrong.
27486 (push (list :latex-fragment (point) (point)) clist)))
27488 (setq clist (nreverse (delq nil clist)))
27489 clist))
27491 ;; FIXME: Compare with at-regexp-p Do we need both?
27492 (defun org-in-regexp (re &optional nlines visually)
27493 "Check if point is inside a match of regexp.
27494 Normally only the current line is checked, but you can include NLINES extra
27495 lines both before and after point into the search.
27496 If VISUALLY is set, require that the cursor is not after the match but
27497 really on, so that the block visually is on the match."
27498 (catch 'exit
27499 (let ((pos (point))
27500 (eol (point-at-eol (+ 1 (or nlines 0))))
27501 (inc (if visually 1 0)))
27502 (save-excursion
27503 (beginning-of-line (- 1 (or nlines 0)))
27504 (while (re-search-forward re eol t)
27505 (if (and (<= (match-beginning 0) pos)
27506 (>= (+ inc (match-end 0)) pos))
27507 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27509 (defun org-at-regexp-p (regexp)
27510 "Is point inside a match of REGEXP in the current line?"
27511 (catch 'exit
27512 (save-excursion
27513 (let ((pos (point)) (end (point-at-eol)))
27514 (beginning-of-line 1)
27515 (while (re-search-forward regexp end t)
27516 (if (and (<= (match-beginning 0) pos)
27517 (>= (match-end 0) pos))
27518 (throw 'exit t)))
27519 nil))))
27521 (defun org-occur-in-agenda-files (regexp &optional nlines)
27522 "Call `multi-occur' with buffers for all agenda files."
27524 (let* ((files (org-agenda-files))
27525 (tnames (mapcar 'file-truename files))
27526 (extra org-agenda-multi-occur-extra-files)
27527 f)
27528 (while (setq f (pop extra))
27529 (unless (member (file-truename f) tnames)
27530 (add-to-list 'files f 'append)
27531 (add-to-list 'tnames (file-truename f) 'append)))
27532 (multi-occur
27533 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27534 regexp)))
27536 (if (boundp 'occur-mode-find-occurrence-hook)
27537 ;; Emacs 23
27538 (add-hook 'occur-mode-find-occurrence-hook
27539 (lambda ()
27540 (when (org-mode-p)
27541 (org-reveal))))
27542 ;; Emacs 22
27543 (defadvice occur-mode-goto-occurrence
27544 (after org-occur-reveal activate)
27545 (and (org-mode-p) (org-reveal)))
27546 (defadvice occur-mode-goto-occurrence-other-window
27547 (after org-occur-reveal activate)
27548 (and (org-mode-p) (org-reveal)))
27549 (defadvice occur-mode-display-occurrence
27550 (after org-occur-reveal activate)
27551 (when (org-mode-p)
27552 (let ((pos (occur-mode-find-occurrence)))
27553 (with-current-buffer (marker-buffer pos)
27554 (save-excursion
27555 (goto-char pos)
27556 (org-reveal)))))))
27558 (defun org-uniquify (list)
27559 "Remove duplicate elements from LIST."
27560 (let (res)
27561 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27562 res))
27564 (defun org-delete-all (elts list)
27565 "Remove all elements in ELTS from LIST."
27566 (while elts
27567 (setq list (delete (pop elts) list)))
27568 list)
27570 (defun org-back-over-empty-lines ()
27571 "Move backwards over witespace, to the beginning of the first empty line.
27572 Returns the number o empty lines passed."
27573 (let ((pos (point)))
27575 (beginning-of-line 2)
27576 (goto-char (min (point) pos))
27577 (count-lines (point) pos)))
27579 (defun org-skip-whitespace ()
27582 (defun org-point-in-group (point group &optional context)
27583 "Check if POINT is in match-group GROUP.
27584 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27585 match. If the match group does ot exist or point is not inside it,
27586 return nil."
27587 (and (match-beginning group)
27588 (>= point (match-beginning group))
27589 (<= point (match-end group))
27590 (if context
27591 (list context (match-beginning group) (match-end group))
27592 t)))
27594 (defun org-switch-to-buffer-other-window (&rest args)
27595 "Switch to buffer in a second window on the current frame.
27596 In particular, do not allow pop-up frames."
27597 (let (pop-up-frames special-display-buffer-names special-display-regexps
27598 special-display-function)
27599 (apply 'switch-to-buffer-other-window args)))
27601 (defun org-combine-plists (&rest plists)
27602 "Create a single property list from all plists in PLISTS.
27603 The process starts by copying the first list, and then setting properties
27604 from the other lists. Settings in the last list are the most significant
27605 ones and overrule settings in the other lists."
27606 (let ((rtn (copy-sequence (pop plists)))
27607 p v ls)
27608 (while plists
27609 (setq ls (pop plists))
27610 (while ls
27611 (setq p (pop ls) v (pop ls))
27612 (setq rtn (plist-put rtn p v))))
27613 rtn))
27615 (defun org-move-line-down (arg)
27616 "Move the current line down. With prefix argument, move it past ARG lines."
27617 (interactive "p")
27618 (let ((col (current-column))
27619 beg end pos)
27620 (beginning-of-line 1) (setq beg (point))
27621 (beginning-of-line 2) (setq end (point))
27622 (beginning-of-line (+ 1 arg))
27623 (setq pos (move-marker (make-marker) (point)))
27624 (insert (delete-and-extract-region beg end))
27625 (goto-char pos)
27626 (move-to-column col)))
27628 (defun org-move-line-up (arg)
27629 "Move the current line up. With prefix argument, move it past ARG lines."
27630 (interactive "p")
27631 (let ((col (current-column))
27632 beg end pos)
27633 (beginning-of-line 1) (setq beg (point))
27634 (beginning-of-line 2) (setq end (point))
27635 (beginning-of-line (- arg))
27636 (setq pos (move-marker (make-marker) (point)))
27637 (insert (delete-and-extract-region beg end))
27638 (goto-char pos)
27639 (move-to-column col)))
27641 (defun org-replace-escapes (string table)
27642 "Replace %-escapes in STRING with values in TABLE.
27644 The sequences in STRING may contain normal field width and padding information,
27646 so values can contain further %-escapes if they are define later in TABLE."
27647 (let ((case-fold-search nil)
27648 e re rpl)
27649 (while (setq e (pop table))
27650 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27651 (while (string-match re string)
27652 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27653 (cdr e)))
27654 (setq string (replace-match rpl t t string))))
27655 string))
27658 (defun org-sublist (list start end)
27659 "Return a section of LIST, from START to END.
27660 Counting starts at 1."
27661 (let (rtn (c start))
27662 (setq list (nthcdr (1- start) list))
27663 (while (and list (<= c end))
27664 (push (pop list) rtn)
27665 (setq c (1+ c)))
27666 (nreverse rtn)))
27668 (defun org-find-base-buffer-visiting (file)
27669 "Like `find-buffer-visiting' but alway return the base buffer and
27670 not an indirect buffer"
27671 (let ((buf (find-buffer-visiting file)))
27672 (if buf
27673 (or (buffer-base-buffer buf) buf)
27674 nil)))
27676 (defun org-image-file-name-regexp ()
27677 "Return regexp matching the file names of images."
27678 (if (fboundp 'image-file-name-regexp)
27679 (image-file-name-regexp)
27680 (let ((image-file-name-extensions
27681 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27682 "xbm" "xpm" "pbm" "pgm" "ppm")))
27684 (regexp-opt (nconc (mapcar 'upcase
27685 image-file-name-extensions)
27686 image-file-name-extensions)
27687 t)
27690 (defun org-file-image-p (file)
27691 "Return non-nil if FILE is an image."
27692 (save-match-data
27693 (string-match (org-image-file-name-regexp) file)))
27695 ;;; Paragraph filling stuff.
27696 ;; We want this to be just right, so use the full arsenal.
27698 (defun org-indent-line-function ()
27699 "Indent line like previous, but further if previous was headline or item."
27700 (interactive)
27701 (let* ((pos (point))
27702 (itemp (org-at-item-p))
27703 column bpos bcol tpos tcol bullet btype bullet-type)
27704 ;; Find the previous relevant line
27705 (beginning-of-line 1)
27706 (cond
27707 ((looking-at "#") (setq column 0))
27709 (t
27710 (beginning-of-line 0)
27712 (beginning-of-line 0))
27713 (cond
27715 (goto-char (match-end 0))
27716 (setq column (current-column)))
27717 ((org-in-item-p)
27718 (org-beginning-of-item)
27721 (setq bpos (match-beginning 1) tpos (match-end 0)
27722 bcol (progn (goto-char bpos) (current-column))
27723 tcol (progn (goto-char tpos) (current-column))
27724 bullet (match-string 1)
27725 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27726 (if (not itemp)
27727 (setq column tcol)
27728 (goto-char pos)
27729 (beginning-of-line 1)
27731 (progn
27733 (setq bullet (match-string 1)
27734 btype (if (string-match "[0-9]" bullet) "n" bullet))
27735 (setq column (if (equal btype bullet-type) bcol tcol)))
27736 (setq column (org-get-indentation)))))
27737 (t (setq column (org-get-indentation))))))
27738 (goto-char pos)
27739 (if (<= (current-column) (current-indentation))
27740 (indent-line-to column)
27741 (save-excursion (indent-line-to column)))
27742 (setq column (current-column))
27743 (beginning-of-line 1)
27744 (if (looking-at
27747 (match-string 2) (match-string 3)))
27748 t nil))
27749 (move-to-column column)))
27751 (defun org-set-autofill-regexps ()
27752 (interactive)
27753 ;; In the paragraph separator we include headlines, because filling
27754 ;; text in a line directly attached to a headline would otherwise
27755 ;; fill the headline as well.
27758 ;; The paragraph starter includes hand-formatted lists.
27759 (org-set-local 'paragraph-start
27761 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27762 ;; But only if the user has not turned off tables or fixed-width regions
27763 (org-set-local
27764 'auto-fill-inhibit-regexp
27767 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27768 (concat
27770 (if org-enable-table-editor "|" "")
27771 (if org-enable-fixed-width-editor ":" "")
27772 "]"))))
27773 ;; We use our own fill-paragraph function, to make sure that tables
27774 ;; and fixed-width regions are not wrapped. That function will pass
27775 ;; through to `fill-paragraph' when appropriate.
27776 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27777 ; Adaptive filling: To get full control, first make sure that
27778 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27780 (org-set-local 'adaptive-fill-function
27781 'org-adaptive-fill-function)
27782 (org-set-local
27783 'align-mode-rules-list
27784 '((org-in-buffer-settings
27786 (modes . '(org-mode))))))
27788 (defun org-fill-paragraph (&optional justify)
27789 "Re-align a table, pass through to fill-paragraph if no table."
27790 (let ((table-p (org-at-table-p))
27791 (table.el-p (org-at-table.el-p)))
27792 (cond ((and (equal (char-after (point-at-bol)) ?*)
27793 (save-excursion (goto-char (point-at-bol))
27794 (looking-at outline-regexp)))
27795 t) ; skip headlines
27796 (table.el-p t) ; skip table.el tables
27797 (table-p (org-table-align) t) ; align org-mode tables
27798 (t nil)))) ; call paragraph-fill
27800 ;; For reference, this is the default value of adaptive-fill-regexp
27803 (defun org-adaptive-fill-function ()
27804 "Return a fill prefix for org-mode files.
27805 In particular, this makes sure hanging paragraphs for hand-formatted lists
27806 work correctly."
27808 (match-string 0))
27810 (save-excursion
27811 (goto-char (match-end 0))
27812 (make-string (current-column) ?\ )))
27813 (t nil)))
27815 ;;;; Functions extending outline functionality
27818 (defun org-beginning-of-line (&optional arg)
27819 "Go to the beginning of the current line. If that is invisible, continue
27820 to a visible line beginning. This makes the function of C-a more intuitive.
27821 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27822 first attempt, and only move to after the tags when the cursor is already
27823 beyond the end of the headline."
27824 (interactive "P")
27825 (let ((pos (point)))
27826 (beginning-of-line 1)
27827 (if (bobp)
27828 nil
27829 (backward-char 1)
27830 (if (org-invisible-p)
27831 (while (and (not (bobp)) (org-invisible-p))
27832 (backward-char 1)
27833 (beginning-of-line 1))
27834 (forward-char 1)))
27835 (when org-special-ctrl-a/e
27836 (cond
27837 ((and (looking-at org-todo-line-regexp)
27838 (= (char-after (match-end 1)) ?\ ))
27839 (goto-char
27840 (if (eq org-special-ctrl-a/e t)
27841 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27842 ((= pos (point)) (match-beginning 3))
27843 (t (point)))
27844 (cond ((> pos (point)) (point))
27845 ((not (eq last-command this-command)) (point))
27846 (t (match-beginning 3))))))
27847 ((org-at-item-p)
27848 (goto-char
27849 (if (eq org-special-ctrl-a/e t)
27850 (cond ((> pos (match-end 4)) (match-end 4))
27851 ((= pos (point)) (match-end 4))
27852 (t (point)))
27853 (cond ((> pos (point)) (point))
27854 ((not (eq last-command this-command)) (point))
27855 (t (match-end 4))))))))))
27857 (defun org-end-of-line (&optional arg)
27858 "Go to the end of the line.
27859 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27860 first attempt, and only move to after the tags when the cursor is already
27861 beyond the end of the headline."
27862 (interactive "P")
27863 (if (or (not org-special-ctrl-a/e)
27864 (not (org-on-heading-p)))
27865 (end-of-line arg)
27866 (let ((pos (point)))
27867 (beginning-of-line 1)
27869 (if (eq org-special-ctrl-a/e t)
27870 (if (or (< pos (match-beginning 1))
27871 (= pos (match-end 0)))
27872 (goto-char (match-beginning 1))
27873 (goto-char (match-end 0)))
27874 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27875 (goto-char (match-end 0))
27876 (goto-char (match-beginning 1))))
27877 (end-of-line arg)))))
27879 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27880 (define-key org-mode-map "\C-e" 'org-end-of-line)
27882 (defun org-kill-line (&optional arg)
27883 "Kill line, to tags or end of line."
27884 (interactive "P")
27885 (cond
27886 ((or (not org-special-ctrl-k)
27887 (bolp)
27888 (not (org-on-heading-p)))
27889 (call-interactively 'kill-line))
27891 (kill-region (point) (match-beginning 1))
27892 (org-set-tags nil t))
27893 (t (kill-region (point) (point-at-eol)))))
27895 (define-key org-mode-map "\C-k" 'org-kill-line)
27897 (defun org-invisible-p ()
27898 "Check if point is at a character currently not visible."
27899 ;; Early versions of noutline don't have `outline-invisible-p'.
27900 (if (fboundp 'outline-invisible-p)
27901 (outline-invisible-p)
27902 (get-char-property (point) 'invisible)))
27904 (defun org-invisible-p2 ()
27905 "Check if point is at a character currently not visible."
27906 (save-excursion
27907 (if (and (eolp) (not (bobp))) (backward-char 1))
27908 ;; Early versions of noutline don't have `outline-invisible-p'.
27909 (if (fboundp 'outline-invisible-p)
27910 (outline-invisible-p)
27911 (get-char-property (point) 'invisible))))
27913 (defalias 'org-back-to-heading 'outline-back-to-heading)
27914 (defalias 'org-on-heading-p 'outline-on-heading-p)
27915 (defalias 'org-at-heading-p 'outline-on-heading-p)
27916 (defun org-at-heading-or-item-p ()
27917 (or (org-on-heading-p) (org-at-item-p)))
27919 (defun org-on-target-p ()
27920 (or (org-in-regexp org-radio-target-regexp)
27921 (org-in-regexp org-target-regexp)))
27923 (defun org-up-heading-all (arg)
27924 "Move to the heading line of which the present line is a subheading.
27925 This function considers both visible and invisible heading lines.
27926 With argument, move up ARG levels."
27927 (if (fboundp 'outline-up-heading-all)
27928 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27929 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27931 (defun org-up-heading-safe ()
27932 "Move to the heading line of which the present line is a subheading.
27933 This version will not throw an error. It will return the level of the
27934 headline found, or nil if no higher level is found."
27935 (let ((pos (point)) start-level level
27936 (re (concat "^" outline-regexp)))
27937 (catch 'exit
27938 (outline-back-to-heading t)
27939 (setq start-level (funcall outline-level))
27940 (if (equal start-level 1) (throw 'exit nil))
27941 (while (re-search-backward re nil t)
27942 (setq level (funcall outline-level))
27943 (if (< level start-level) (throw 'exit level)))
27944 nil)))
27946 (defun org-first-sibling-p ()
27947 "Is this heading the first child of its parents?"
27948 (interactive)
27949 (let ((re (concat "^" outline-regexp))
27950 level l)
27951 (unless (org-at-heading-p t)
27952 (error "Not at a heading"))
27953 (setq level (funcall outline-level))
27954 (save-excursion
27955 (if (not (re-search-backward re nil t))
27956 t
27957 (setq l (funcall outline-level))
27958 (< l level)))))
27960 (defun org-goto-sibling (&optional previous)
27961 "Goto the next sibling, even if it is invisible.
27962 When PREVIOUS is set, go to the previous sibling instead. Returns t
27963 when a sibling was found. When none is found, return nil and don't
27964 move point."
27965 (let ((fun (if previous 're-search-backward 're-search-forward))
27966 (pos (point))
27967 (re (concat "^" outline-regexp))
27968 level l)
27969 (when (condition-case nil (org-back-to-heading t) (error nil))
27970 (setq level (funcall outline-level))
27971 (catch 'exit
27972 (or previous (forward-char 1))
27973 (while (funcall fun re nil t)
27974 (setq l (funcall outline-level))
27975 (when (< l level) (goto-char pos) (throw 'exit nil))
27976 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27977 (goto-char pos)
27978 nil))))
27980 (defun org-show-siblings ()
27981 "Show all siblings of the current headline."
27982 (save-excursion
27983 (while (org-goto-sibling) (org-flag-heading nil)))
27984 (save-excursion
27985 (while (org-goto-sibling 'previous)
27986 (org-flag-heading nil))))
27988 (defun org-show-hidden-entry ()
27989 "Show an entry where even the heading is hidden."
27990 (save-excursion
27991 (org-show-entry)))
27993 (defun org-flag-heading (flag &optional entry)
27994 "Flag the current heading. FLAG non-nil means make invisible.
27995 When ENTRY is non-nil, show the entire entry."
27996 (save-excursion
27997 (org-back-to-heading t)
27998 ;; Check if we should show the entire entry
27999 (if entry
28000 (progn
28001 (org-show-entry)
28002 (save-excursion
28003 (and (outline-next-heading)
28004 (org-flag-heading nil))))
28005 (outline-flag-region (max (point-min) (1- (point)))
28006 (save-excursion (outline-end-of-heading) (point))
28007 flag))))
28009 (defun org-end-of-subtree (&optional invisible-OK to-heading)
28010 ;; This is an exact copy of the original function, but it uses
28011 ;; `org-back-to-heading', to make it work also in invisible
28012 ;; trees. And is uses an invisible-OK argument.
28013 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28014 (org-back-to-heading invisible-OK)
28015 (let ((first t)
28016 (level (funcall outline-level)))
28017 (while (and (not (eobp))
28018 (or first (> (funcall outline-level) level)))
28019 (setq first nil)
28020 (outline-next-heading))
28021 (unless to-heading
28023 (progn
28024 ;; Go to end of line before heading
28025 (forward-char -1)
28027 ;; leave blank line before heading
28028 (forward-char -1))))))
28029 (point))
28031 (defun org-show-subtree ()
28032 "Show everything after this heading at deeper levels."
28033 (outline-flag-region
28034 (point)
28035 (save-excursion
28036 (outline-end-of-subtree) (outline-next-heading) (point))
28037 nil))
28039 (defun org-show-entry ()
28040 "Show the body directly following this heading.
28041 Show the heading too, if it is currently invisible."
28042 (interactive)
28043 (save-excursion
28044 (condition-case nil
28045 (progn
28046 (org-back-to-heading t)
28047 (outline-flag-region
28048 (max (point-min) (1- (point)))
28049 (save-excursion
28050 (re-search-forward
28052 (or (match-beginning 1) (point-max)))
28053 nil))
28054 (error nil))))
28056 (defun org-make-options-regexp (kwds)
28057 "Make a regular expression for keyword lines."
28058 (concat
28059 "^"
28065 ;; Make isearch reveal the necessary context
28066 (defun org-isearch-end ()
28067 "Reveal context after isearch exits."
28068 (when isearch-success ; only if search was successful
28069 (if (featurep 'xemacs)
28070 ;; Under XEmacs, the hook is run in the correct place,
28071 ;; we directly show the context.
28072 (org-show-context 'isearch)
28073 ;; In Emacs the hook runs *before* restoring the overlays.
28074 ;; So we have to use a one-time post-command-hook to do this.
28075 ;; (Emacs 22 has a special variable, see function `org-mode')
28076 (unless (and (boundp 'isearch-mode-end-hook-quit)
28077 isearch-mode-end-hook-quit)
28078 ;; Only when the isearch was not quitted.
28079 (org-add-hook 'post-command-hook 'org-isearch-post-command
28080 'append 'local)))))
28082 (defun org-isearch-post-command ()
28083 "Remove self from hook, and show context."
28084 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28085 (org-show-context 'isearch))
28088 ;;;; Integration with and fixes for other packages
28090 ;;; Imenu support
28092 (defvar org-imenu-markers nil
28093 "All markers currently used by Imenu.")
28094 (make-variable-buffer-local 'org-imenu-markers)
28096 (defun org-imenu-new-marker (&optional pos)
28097 "Return a new marker for use by Imenu, and remember the marker."
28098 (let ((m (make-marker)))
28099 (move-marker m (or pos (point)))
28100 (push m org-imenu-markers)
28101 m))
28103 (defun org-imenu-get-tree ()
28104 "Produce the index for Imenu."
28105 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28106 (setq org-imenu-markers nil)
28107 (let* ((n org-imenu-depth)
28108 (re (concat "^" outline-regexp))
28109 (subs (make-vector (1+ n) nil))
28110 (last-level 0)
28111 m tree level head)
28112 (save-excursion
28113 (save-restriction
28114 (widen)
28115 (goto-char (point-max))
28116 (while (re-search-backward re nil t)
28117 (setq level (org-reduced-level (funcall outline-level)))
28118 (when (<= level n)
28119 (looking-at org-complex-heading-regexp)
28120 (setq head (org-match-string-no-properties 4)
28121 m (org-imenu-new-marker))
28122 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28123 (if (>= level last-level)
28124 (push (cons head m) (aref subs level))
28125 (push (cons head (aref subs (1+ level))) (aref subs level))
28126 (loop for i from (1+ level) to n do (aset subs i nil)))
28127 (setq last-level level)))))
28128 (aref subs 1)))
28130 (eval-after-load "imenu"
28131 '(progn
28132 (add-hook 'imenu-after-jump-hook
28133 (lambda () (org-show-context 'org-goto)))))
28135 ;; Speedbar support
28137 (defun org-speedbar-set-agenda-restriction ()
28138 "Restrict future agenda commands to the location at point in speedbar.
28140 (interactive)
28141 (let (p m tp np dir txt w)
28142 (cond
28143 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28144 'org-imenu t))
28145 (setq m (get-text-property p 'org-imenu-marker))
28146 (save-excursion
28147 (save-restriction
28148 (set-buffer (marker-buffer m))
28149 (goto-char m)
28150 (org-agenda-set-restriction-lock 'subtree))))
28151 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28152 'speedbar-function 'speedbar-find-file))
28153 (setq tp (previous-single-property-change
28154 (1+ p) 'speedbar-function)
28155 np (next-single-property-change
28156 tp 'speedbar-function)
28157 dir (speedbar-line-directory)
28158 txt (buffer-substring-no-properties (or tp (point-min))
28159 (or np (point-max))))
28160 (save-excursion
28161 (save-restriction
28162 (set-buffer (find-file-noselect
28163 (let ((default-directory dir))
28164 (expand-file-name txt))))
28165 (unless (org-mode-p)
28166 (error "Cannot restrict to non-Org-mode file"))
28167 (org-agenda-set-restriction-lock 'file))))
28168 (t (error "Don't know how to restrict Org-mode's agenda")))
28169 (org-move-overlay org-speedbar-restriction-lock-overlay
28170 (point-at-bol) (point-at-eol))
28171 (setq current-prefix-arg nil)
28172 (org-agenda-maybe-redo)))
28174 (eval-after-load "speedbar"
28175 '(progn
28176 (speedbar-add-supported-extension ".org")
28177 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28178 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28179 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28180 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28181 (add-hook 'speedbar-visiting-tag-hook
28182 (lambda () (org-show-context 'org-goto)))))
28185 ;;; Fixes and Hacks
28187 ;; Make flyspell not check words in links, to not mess up our keymap
28188 (defun org-mode-flyspell-verify ()
28189 "Don't let flyspell put overlays at active buttons."
28190 (not (get-text-property (point) 'keymap)))
28192 ;; Make `bookmark-jump' show the jump location if it was hidden.
28193 (eval-after-load "bookmark"
28194 '(if (boundp 'bookmark-after-jump-hook)
28195 ;; We can use the hook
28196 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28197 ;; Hook not available, use advice
28198 (defadvice bookmark-jump (after org-make-visible activate)
28199 "Make the position visible."
28200 (org-bookmark-jump-unhide))))
28202 (defun org-bookmark-jump-unhide ()
28203 "Unhide the current position, to show the bookmark location."
28204 (and (org-mode-p)
28205 (or (org-invisible-p)
28206 (save-excursion (goto-char (max (point-min) (1- (point))))
28207 (org-invisible-p)))
28208 (org-show-context 'bookmark-jump)))
28210 ;; Fix a bug in htmlize where there are text properties (face nil)
28211 (eval-after-load "htmlize"
28212 '(progn
28213 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28214 "Make sure there are no nil faces"
28215 (setq ad-return-value (delq nil ad-return-value)))))
28217 ;; Make session.el ignore our circular variable
28218 (eval-after-load "session"
28219 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28221 ;;;; Experimental code
28223 (defun org-closed-in-range ()
28224 "Sparse tree of items closed in a certain time range.
28225 Still experimental, may disappear in the future."
28226 (interactive)
28227 ;; Get the time interval from the user.
28228 (let* ((time1 (time-to-seconds
28229 (org-read-date nil 'to-time nil "Starting date: ")))
28230 (time2 (time-to-seconds
28231 (org-read-date nil 'to-time nil "End date:")))
28232 ;; callback function
28233 (callback (lambda ()
28234 (let ((time
28235 (time-to-seconds
28236 (apply 'encode-time
28237 (org-parse-time-string
28238 (match-string 1))))))
28239 ;; check if time in interval
28240 (and (>= time time1) (<= time time2))))))
28241 ;; make tree, check each match with the callback
28244 ;;;; Finish up
28246 (provide 'org)
28248 (run-hooks 'org-load-hook)
28250 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28251 ;;; org.el ends here