| blob | 714995c0e52f8cab3034b946bec94543e7a8ccc9 |
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.22
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 (end-of-line 1)
6217 (newline (if blank 2 1))))
6218 (insert head) (just-one-space)
6219 (setq pos (point))
6220 (end-of-line 1)
6221 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6222 (run-hooks 'org-insert-heading-hook)))))
6224 (defun org-insert-heading-after-current ()
6225 "Insert a new heading with same level as current, after current subtree."
6226 (interactive)
6227 (org-back-to-heading)
6228 (org-insert-heading)
6229 (org-move-subtree-down)
6230 (end-of-line 1))
6232 (defun org-insert-todo-heading (arg)
6233 "Insert a new heading with the same level and TODO state as current heading.
6234 If the heading has no TODO state, or if the state is DONE, use the first
6235 state (TODO by default). Also with prefix arg, force first state."
6236 (interactive "P")
6237 (when (not (org-insert-item 'checkbox))
6238 (org-insert-heading)
6239 (save-excursion
6240 (org-back-to-heading)
6241 (outline-previous-heading)
6242 (looking-at org-todo-line-regexp))
6243 (if (or arg
6244 (not (match-beginning 2))
6245 (member (match-string 2) org-done-keywords))
6246 (insert (car org-todo-keywords-1) " ")
6247 (insert (match-string 2) " "))))
6249 (defun org-insert-subheading (arg)
6250 "Insert a new subheading and demote it.
6251 Works for outline headings and for plain lists alike."
6252 (interactive "P")
6253 (org-insert-heading arg)
6254 (cond
6255 ((org-on-heading-p) (org-do-demote))
6256 ((org-at-item-p) (org-indent-item 1))))
6258 (defun org-insert-todo-subheading (arg)
6259 "Insert a new subheading with TODO keyword or checkbox and demote it.
6260 Works for outline headings and for plain lists alike."
6261 (interactive "P")
6262 (org-insert-todo-heading arg)
6263 (cond
6264 ((org-on-heading-p) (org-do-demote))
6265 ((org-at-item-p) (org-indent-item 1))))
6267 ;;; Promotion and Demotion
6269 (defun org-promote-subtree ()
6270 "Promote the entire subtree.
6271 See also `org-promote'."
6272 (interactive)
6273 (save-excursion
6274 (org-map-tree 'org-promote))
6275 (org-fix-position-after-promote))
6277 (defun org-demote-subtree ()
6278 "Demote the entire subtree. See `org-demote'.
6279 See also `org-promote'."
6280 (interactive)
6281 (save-excursion
6282 (org-map-tree 'org-demote))
6283 (org-fix-position-after-promote))
6286 (defun org-do-promote ()
6287 "Promote the current heading higher up the tree.
6288 If the region is active in `transient-mark-mode', promote all headings
6289 in the region."
6290 (interactive)
6291 (save-excursion
6292 (if (org-region-active-p)
6293 (org-map-region 'org-promote (region-beginning) (region-end))
6294 (org-promote)))
6295 (org-fix-position-after-promote))
6297 (defun org-do-demote ()
6298 "Demote the current heading lower down the tree.
6299 If the region is active in `transient-mark-mode', demote all headings
6300 in the region."
6301 (interactive)
6302 (save-excursion
6303 (if (org-region-active-p)
6304 (org-map-region 'org-demote (region-beginning) (region-end))
6305 (org-demote)))
6306 (org-fix-position-after-promote))
6308 (defun org-fix-position-after-promote ()
6309 "Make sure that after pro/demotion cursor position is right."
6310 (let ((pos (point)))
6311 (when (save-excursion
6312 (beginning-of-line 1)
6313 (looking-at org-todo-line-regexp)
6314 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6315 (cond ((eobp) (insert " "))
6316 ((eolp) (insert " "))
6317 ((equal (char-after) ?\ ) (forward-char 1))))))
6319 (defun org-reduced-level (l)
6320 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6322 (defun org-get-legal-level (level &optional change)
6323 "Rectify a level change under the influence of `org-odd-levels-only'
6324 LEVEL is a current level, CHANGE is by how much the level should be
6325 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6326 even level numbers will become the next higher odd number."
6327 (if org-odd-levels-only
6328 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6329 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6330 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6331 (max 1 (+ level change))))
6333 (defun org-promote ()
6334 "Promote the current heading higher up the tree.
6335 If the region is active in `transient-mark-mode', promote all headings
6336 in the region."
6337 (org-back-to-heading t)
6338 (let* ((level (save-match-data (funcall outline-level)))
6339 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
6340 (diff (abs (- level (length up-head) -1))))
6341 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6342 (replace-match up-head nil t)
6343 ;; Fixup tag positioning
6344 (and org-auto-align-tags (org-set-tags nil t))
6345 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
6347 (defun org-demote ()
6348 "Demote the current heading lower down the tree.
6349 If the region is active in `transient-mark-mode', demote all headings
6350 in the region."
6351 (org-back-to-heading t)
6352 (let* ((level (save-match-data (funcall outline-level)))
6353 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
6354 (diff (abs (- level (length down-head) -1))))
6355 (replace-match down-head nil t)
6356 ;; Fixup tag positioning
6357 (and org-auto-align-tags (org-set-tags nil t))
6358 (if org-adapt-indentation (org-fixup-indentation diff))))
6360 (defun org-map-tree (fun)
6361 "Call FUN for every heading underneath the current one."
6362 (org-back-to-heading)
6363 (let ((level (funcall outline-level)))
6364 (save-excursion
6365 (funcall fun)
6366 (while (and (progn
6367 (outline-next-heading)
6368 (> (funcall outline-level) level))
6369 (not (eobp)))
6370 (funcall fun)))))
6372 (defun org-map-region (fun beg end)
6373 "Call FUN for every heading between BEG and END."
6374 (let ((org-ignore-region t))
6375 (save-excursion
6376 (setq end (copy-marker end))
6377 (goto-char beg)
6378 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6379 (< (point) end))
6380 (funcall fun))
6381 (while (and (progn
6382 (outline-next-heading)
6383 (< (point) end))
6384 (not (eobp)))
6385 (funcall fun)))))
6387 (defun org-fixup-indentation (diff)
6388 "Change the indentation in the current entry by DIFF
6389 However, if any line in the current entry has no indentation, or if it
6390 would end up with no indentation after the change, nothing at all is done."
6391 (save-excursion
6392 (let ((end (save-excursion (outline-next-heading)
6393 (point-marker)))
6394 (prohibit (if (> diff 0)
6397 col)
6398 (unless (save-excursion (end-of-line 1)
6399 (re-search-forward prohibit end t))
6400 (while (and (< (point) end)
6402 (goto-char (match-end 0))
6403 (setq col (current-column))
6404 (if (< diff 0) (replace-match ""))
6405 (indent-to (+ diff col))))
6406 (move-marker end nil))))
6408 (defun org-convert-to-odd-levels ()
6409 "Convert an org-mode file with all levels allowed to one with odd levels.
6410 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6411 level 5 etc."
6412 (interactive)
6413 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6414 (let ((org-odd-levels-only nil) n)
6415 (save-excursion
6416 (goto-char (point-min))
6418 (setq n (- (length (match-string 0)) 2))
6419 (while (>= (setq n (1- n)) 0)
6420 (org-demote))
6421 (end-of-line 1))))))
6424 (defun org-convert-to-oddeven-levels ()
6425 "Convert an org-mode file with only odd levels to one with odd and even levels.
6426 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6427 section with an even level, conversion would destroy the structure of the file. An error
6428 is signaled in this case."
6429 (interactive)
6430 (goto-char (point-min))
6431 ;; First check if there are no even levels
6433 (org-show-context t)
6434 (error "Not all levels are odd in this file. Conversion not possible."))
6435 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6436 (let ((org-odd-levels-only nil) n)
6437 (save-excursion
6438 (goto-char (point-min))
6440 (setq n (/ (1- (length (match-string 0))) 2))
6441 (while (>= (setq n (1- n)) 0)
6442 (org-promote))
6443 (end-of-line 1))))))
6445 (defun org-tr-level (n)
6446 "Make N odd if required."
6447 (if org-odd-levels-only (1+ (/ n 2)) n))
6449 ;;; Vertical tree motion, cutting and pasting of subtrees
6451 (defun org-move-subtree-up (&optional arg)
6452 "Move the current subtree up past ARG headlines of the same level."
6453 (interactive "p")
6454 (org-move-subtree-down (- (prefix-numeric-value arg))))
6456 (defun org-move-subtree-down (&optional arg)
6457 "Move the current subtree down past ARG headlines of the same level."
6458 (interactive "p")
6459 (setq arg (prefix-numeric-value arg))
6460 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
6461 'outline-get-last-sibling))
6462 (ins-point (make-marker))
6463 (cnt (abs arg))
6464 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6465 ;; Select the tree
6466 (org-back-to-heading)
6467 (setq beg0 (point))
6468 (save-excursion
6469 (setq ne-beg (org-back-over-empty-lines))
6470 (setq beg (point)))
6471 (save-match-data
6472 (save-excursion (outline-end-of-heading)
6473 (setq folded (org-invisible-p)))
6474 (outline-end-of-subtree))
6475 (outline-next-heading)
6476 (setq ne-end (org-back-over-empty-lines))
6477 (setq end (point))
6478 (goto-char beg0)
6479 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6480 ;; include less whitespace
6481 (save-excursion
6482 (goto-char beg)
6483 (forward-line (- ne-beg ne-end))
6484 (setq beg (point))))
6485 ;; Find insertion point, with error handling
6486 (while (> cnt 0)
6487 (or (and (funcall movfunc) (looking-at outline-regexp))
6488 (progn (goto-char beg0)
6489 (error "Cannot move past superior level or buffer limit")))
6490 (setq cnt (1- cnt)))
6491 (if (> arg 0)
6492 ;; Moving forward - still need to move over subtree
6493 (progn (org-end-of-subtree t t)
6494 (save-excursion
6495 (org-back-over-empty-lines)
6496 (or (bolp) (newline)))))
6497 (setq ne-ins (org-back-over-empty-lines))
6498 (move-marker ins-point (point))
6499 (setq txt (buffer-substring beg end))
6500 (delete-region beg end)
6501 (outline-flag-region (1- beg) beg nil)
6502 (outline-flag-region (1- (point)) (point) nil)
6503 (insert txt)
6505 (setq ins-end (point))
6506 (goto-char ins-point)
6507 (org-skip-whitespace)
6508 (when (and (< arg 0)
6509 (org-first-sibling-p)
6510 (> ne-ins ne-beg))
6511 ;; Move whitespace back to beginning
6512 (save-excursion
6513 (goto-char ins-end)
6514 (let ((kill-whole-line t))
6515 (kill-line (- ne-ins ne-beg)) (point)))
6517 (move-marker ins-point nil)
6518 (org-compact-display-after-subtree-move)
6519 (unless folded
6520 (org-show-entry)
6521 (show-children)
6522 (org-cycle-hide-drawers 'children))))
6524 (defvar org-subtree-clip ""
6525 "Clipboard for cut and paste of subtrees.
6526 This is actually only a copy of the kill, because we use the normal kill
6527 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6529 (defvar org-subtree-clip-folded nil
6530 "Was the last copied subtree folded?
6531 This is used to fold the tree back after pasting.")
6533 (defun org-cut-subtree (&optional n)
6534 "Cut the current subtree into the clipboard.
6535 With prefix arg N, cut this many sequential subtrees.
6536 This is a short-hand for marking the subtree and then cutting it."
6537 (interactive "p")
6538 (org-copy-subtree n 'cut))
6540 (defun org-copy-subtree (&optional n cut)
6541 "Cut the current subtree into the clipboard.
6542 With prefix arg N, cut this many sequential subtrees.
6543 This is a short-hand for marking the subtree and then copying it.
6544 If CUT is non-nil, actually cut the subtree."
6545 (interactive "p")
6546 (let (beg end folded (beg0 (point)))
6547 (if (interactive-p)
6548 (org-back-to-heading nil) ; take what looks like a subtree
6549 (org-back-to-heading t)) ; take what is really there
6550 (org-back-over-empty-lines)
6551 (setq beg (point))
6553 (save-match-data
6554 (save-excursion (outline-end-of-heading)
6555 (setq folded (org-invisible-p)))
6556 (condition-case nil
6557 (outline-forward-same-level (1- n))
6558 (error nil))
6559 (org-end-of-subtree t t))
6560 (org-back-over-empty-lines)
6561 (setq end (point))
6562 (goto-char beg0)
6563 (when (> end beg)
6564 (setq org-subtree-clip-folded folded)
6565 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6566 (setq org-subtree-clip (current-kill 0))
6567 (message "%s: Subtree(s) with %d characters"
6568 (if cut "Cut" "Copied")
6569 (length org-subtree-clip)))))
6571 (defun org-paste-subtree (&optional level tree)
6572 "Paste the clipboard as a subtree, with modification of headline level.
6573 The entire subtree is promoted or demoted in order to match a new headline
6574 level. By default, the new level is derived from the visible headings
6575 before and after the insertion point, and taken to be the inferior headline
6576 level of the two. So if the previous visible heading is level 3 and the
6577 next is level 4 (or vice versa), level 4 will be used for insertion.
6578 This makes sure that the subtree remains an independent subtree and does
6579 not swallow low level entries.
6581 You can also force a different level, either by using a numeric prefix
6582 argument, or by inserting the heading marker by hand. For example, if the
6587 If optional TREE is given, use this text instead of the kill ring."
6588 (interactive "P")
6589 (unless (org-kill-is-subtree-p tree)
6590 (error "%s"
6591 (substitute-command-keys
6593 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6598 (old-level (if (string-match ^re txt)
6599 (- (match-end 0) (match-beginning 0) 1)
6600 -1))
6601 (force-level (cond (level (prefix-numeric-value level))
6602 ((string-match
6603 ^re_ (buffer-substring (point-at-bol) (point)))
6604 (- (match-end 1) (match-beginning 1)))
6605 (t nil)))
6606 (previous-level (save-excursion
6607 (condition-case nil
6608 (progn
6609 (outline-previous-visible-heading 1)
6610 (if (looking-at re)
6611 (- (match-end 0) (match-beginning 0) 1)
6612 1))
6613 (error 1))))
6614 (next-level (save-excursion
6615 (condition-case nil
6616 (progn
6617 (or (looking-at outline-regexp)
6618 (outline-next-visible-heading 1))
6619 (if (looking-at re)
6620 (- (match-end 0) (match-beginning 0) 1)
6621 1))
6622 (error 1))))
6623 (new-level (or force-level (max previous-level next-level)))
6624 (shift (if (or (= old-level -1)
6625 (= new-level -1)
6626 (= old-level new-level))
6627 0
6628 (- new-level old-level)))
6629 (delta (if (> shift 0) -1 1))
6630 (func (if (> shift 0) 'org-demote 'org-promote))
6631 (org-odd-levels-only nil)
6632 beg end)
6633 ;; Remove the forced level indicator
6634 (if force-level
6635 (delete-region (point-at-bol) (point)))
6636 ;; Paste
6637 (beginning-of-line 1)
6638 (org-back-over-empty-lines) ;; FIXME: correct fix????
6639 (setq beg (point))
6640 (insert-before-markers txt) ;; FIXME: correct fix????
6642 (setq end (point))
6643 (goto-char beg)
6645 (setq beg (point))
6646 ;; Shift if necessary
6647 (unless (= shift 0)
6648 (save-restriction
6649 (narrow-to-region beg end)
6650 (while (not (= shift 0))
6651 (org-map-region func (point-min) (point-max))
6652 (setq shift (+ delta shift)))
6653 (goto-char (point-min))))
6654 (when (interactive-p)
6655 (message "Clipboard pasted as level %d subtree" new-level))
6656 (if (and kill-ring
6657 (eq org-subtree-clip (current-kill 0))
6658 org-subtree-clip-folded)
6659 ;; The tree was folded before it was killed/copied
6660 (hide-subtree))))
6662 (defun org-kill-is-subtree-p (&optional txt)
6663 "Check if the current kill is an outline subtree, or a set of trees.
6664 Returns nil if kill does not start with a headline, or if the first
6665 headline level is not the largest headline level in the tree.
6666 So this will actually accept several entries of equal levels as well,
6667 which is OK for `org-paste-subtree'.
6668 If optional TXT is given, check this string instead of the current kill."
6669 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6670 (start-level (and kill
6673 kill)
6674 (- (match-end 2) (match-beginning 2) 1)))
6675 (re (concat "^" org-outline-regexp))
6676 (start (1+ (match-beginning 2))))
6677 (if (not start-level)
6678 (progn
6679 nil) ;; does not even start with a heading
6680 (catch 'exit
6681 (while (setq start (string-match re kill (1+ start)))
6682 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6683 (throw 'exit nil)))
6684 t))))
6686 (defun org-narrow-to-subtree ()
6687 "Narrow buffer to the current subtree."
6688 (interactive)
6689 (save-excursion
6690 (save-match-data
6691 (narrow-to-region
6692 (progn (org-back-to-heading) (point))
6693 (progn (org-end-of-subtree t t) (point))))))
6696 ;;; Outline Sorting
6698 (defun org-sort (with-case)
6699 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6700 Optional argument WITH-CASE means sort case-sensitively."
6701 (interactive "P")
6702 (if (org-at-table-p)
6703 (org-call-with-arg 'org-table-sort-lines with-case)
6704 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6706 (defvar org-priority-regexp) ; defined later in the file
6708 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6709 "Sort entries on a certain level of an outline tree.
6710 If there is an active region, the entries in the region are sorted.
6711 Else, if the cursor is before the first entry, sort the top-level items.
6712 Else, the children of the entry at point are sorted.
6714 Sorting can be alphabetically, numerically, and by date/time as given by
6715 the first time stamp in the entry. The command prompts for the sorting
6716 type unless it has been given to the function through the SORTING-TYPE
6717 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6718 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6719 called with point at the beginning of the record. It must return either
6720 a string or a number that should serve as the sorting key for that record.
6722 Comparing entries ignores case by default. However, with an optional argument
6723 WITH-CASE, the sorting considers case as well."
6724 (interactive "P")
6725 (let ((case-func (if with-case 'identity 'downcase))
6726 start beg end stars re re2
6727 txt what tmp plain-list-p)
6728 ;; Find beginning and end of region to sort
6729 (cond
6730 ((org-region-active-p)
6731 ;; we will sort the region
6732 (setq end (region-end)
6733 what "region")
6734 (goto-char (region-beginning))
6735 (if (not (org-on-heading-p)) (outline-next-heading))
6736 (setq start (point)))
6737 ((org-at-item-p)
6738 ;; we will sort this plain list
6739 (org-beginning-of-item-list) (setq start (point))
6740 (org-end-of-item-list) (setq end (point))
6741 (goto-char start)
6742 (setq plain-list-p t
6743 what "plain list"))
6744 ((or (org-on-heading-p)
6745 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6746 ;; we will sort the children of the current headline
6747 (org-back-to-heading)
6748 (setq start (point)
6749 end (progn (org-end-of-subtree t t)
6750 (org-back-over-empty-lines)
6751 (point))
6752 what "children")
6753 (goto-char start)
6754 (show-subtree)
6755 (outline-next-heading))
6756 (t
6757 ;; we will sort the top-level entries in this file
6758 (goto-char (point-min))
6759 (or (org-on-heading-p) (outline-next-heading))
6760 (setq start (point) end (point-max) what "top-level")
6761 (goto-char start)
6762 (show-all)))
6764 (setq beg (point))
6765 (if (>= beg end) (error "Nothing to sort"))
6767 (unless plain-list-p
6769 (setq stars (match-string 1)
6770 re (concat "^" (regexp-quote stars) " +")
6771 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6772 txt (buffer-substring beg end))
6774 (if (and (not (equal stars "*")) (string-match re2 txt))
6775 (error "Region to sort contains a level above the first entry")))
6777 (unless sorting-type
6778 (message
6779 (if plain-list-p
6780 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6781 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6782 what)
6783 (setq sorting-type (read-char-exclusive))
6785 (and (= (downcase sorting-type) ?f)
6786 (setq getkey-func
6787 (completing-read "Sort using function: "
6788 obarray 'fboundp t nil nil))
6789 (setq getkey-func (intern getkey-func)))
6791 (and (= (downcase sorting-type) ?r)
6792 (setq property
6793 (completing-read "Property: "
6794 (mapcar 'list (org-buffer-property-keys t))
6795 nil t))))
6797 (message "Sorting entries...")
6799 (save-restriction
6800 (narrow-to-region start end)
6802 (let ((dcst (downcase sorting-type))
6803 (now (current-time)))
6804 (sort-subr
6805 (/= dcst sorting-type)
6806 ;; This function moves to the beginning character of the "record" to
6807 ;; be sorted.
6808 (if plain-list-p
6809 (lambda nil
6810 (if (org-at-item-p) t (goto-char (point-max))))
6811 (lambda nil
6812 (if (re-search-forward re nil t)
6813 (goto-char (match-beginning 0))
6814 (goto-char (point-max)))))
6815 ;; This function moves to the last character of the "record" being
6816 ;; sorted.
6817 (if plain-list-p
6818 'org-end-of-item
6819 (lambda nil
6820 (save-match-data
6821 (condition-case nil
6822 (outline-forward-same-level 1)
6823 (error
6824 (goto-char (point-max)))))))
6826 ;; This function returns the value that gets sorted against.
6827 (if plain-list-p
6828 (lambda nil
6830 (cond
6831 ((= dcst ?n)
6832 (string-to-number (buffer-substring (match-end 0)
6833 (point-at-eol))))
6834 ((= dcst ?a)
6835 (buffer-substring (match-end 0) (point-at-eol)))
6836 ((= dcst ?t)
6837 (if (re-search-forward org-ts-regexp
6838 (point-at-eol) t)
6839 (org-time-string-to-time (match-string 0))
6840 now))
6841 ((= dcst ?f)
6842 (if getkey-func
6843 (progn
6844 (setq tmp (funcall getkey-func))
6845 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6846 tmp)
6847 (error "Invalid key function `%s'" getkey-func)))
6848 (t (error "Invalid sorting type `%c'" sorting-type)))))
6849 (lambda nil
6850 (cond
6851 ((= dcst ?n)
6852 (if (looking-at outline-regexp)
6853 (string-to-number (buffer-substring (match-end 0)
6854 (point-at-eol)))
6855 nil))
6856 ((= dcst ?a)
6857 (funcall case-func (buffer-substring (point-at-bol)
6858 (point-at-eol))))
6859 ((= dcst ?t)
6860 (if (re-search-forward org-ts-regexp
6861 (save-excursion
6862 (forward-line 2)
6863 (point)) t)
6864 (org-time-string-to-time (match-string 0))
6865 now))
6866 ((= dcst ?p)
6867 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6868 (string-to-char (match-string 2))
6869 org-default-priority))
6870 ((= dcst ?r)
6871 (or (org-entry-get nil property) ""))
6872 ((= dcst ?f)
6873 (if getkey-func
6874 (progn
6875 (setq tmp (funcall getkey-func))
6876 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6877 tmp)
6878 (error "Invalid key function `%s'" getkey-func)))
6879 (t (error "Invalid sorting type `%c'" sorting-type)))))
6880 nil
6881 (cond
6882 ((= dcst ?a) 'string<)
6883 ((= dcst ?t) 'time-less-p)
6884 (t nil)))))
6885 (message "Sorting entries...done")))
6887 (defun org-do-sort (table what &optional with-case sorting-type)
6888 "Sort TABLE of WHAT according to SORTING-TYPE.
6889 The user will be prompted for the SORTING-TYPE if the call to this
6890 function does not specify it. WHAT is only for the prompt, to indicate
6891 what is being sorted. The sorting key will be extracted from
6892 the car of the elements of the table.
6893 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6894 (unless sorting-type
6895 (message
6896 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6897 what)
6898 (setq sorting-type (read-char-exclusive)))
6899 (let ((dcst (downcase sorting-type))
6900 extractfun comparefun)
6901 ;; Define the appropriate functions
6902 (cond
6903 ((= dcst ?n)
6904 (setq extractfun 'string-to-number
6905 comparefun (if (= dcst sorting-type) '< '>)))
6906 ((= dcst ?a)
6907 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6908 (lambda(x) (downcase (org-sort-remove-invisible x))))
6909 comparefun (if (= dcst sorting-type)
6910 'string<
6911 (lambda (a b) (and (not (string< a b))
6912 (not (string= a b)))))))
6913 ((= dcst ?t)
6914 (setq extractfun
6915 (lambda (x)
6916 (if (string-match org-ts-regexp x)
6917 (time-to-seconds
6918 (org-time-string-to-time (match-string 0 x)))
6919 0))
6920 comparefun (if (= dcst sorting-type) '< '>)))
6921 (t (error "Invalid sorting type `%c'" sorting-type)))
6923 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6924 table)
6925 (lambda (a b) (funcall comparefun (car a) (car b))))))
6927 ;;;; Plain list items, including checkboxes
6929 ;;; Plain list items
6931 (defun org-at-item-p ()
6932 "Is point in a line starting a hand-formatted item?"
6933 (let ((llt org-plain-list-ordered-item-terminator))
6934 (save-excursion
6935 (goto-char (point-at-bol))
6936 (looking-at
6937 (cond
6941 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6943 (defun org-in-item-p ()
6944 "It the cursor inside a plain list item.
6945 Does not have to be the first line."
6946 (save-excursion
6947 (condition-case nil
6948 (progn
6949 (org-beginning-of-item)
6950 (org-at-item-p)
6951 t)
6952 (error nil))))
6954 (defun org-insert-item (&optional checkbox)
6955 "Insert a new item at the current level.
6956 Return t when things worked, nil when we are not in an item."
6957 (when (save-excursion
6958 (condition-case nil
6959 (progn
6960 (org-beginning-of-item)
6961 (org-at-item-p)
6962 (if (org-invisible-p) (error "Invisible item"))
6963 t)
6964 (error nil)))
6965 (let* ((bul (match-string 0))
6967 (match-end 0)))
6968 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6969 pos)
6970 (cond
6971 ((and (org-at-item-p) (<= (point) eow))
6972 ;; before the bullet
6973 (beginning-of-line 1)
6974 (open-line (if blank 2 1)))
6975 ((<= (point) eow)
6976 (beginning-of-line 1))
6977 (t (newline (if blank 2 1))))
6978 (insert bul (if checkbox "[ ]" ""))
6979 (just-one-space)
6980 (setq pos (point))
6981 (end-of-line 1)
6982 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6983 (org-maybe-renumber-ordered-list)
6984 (and checkbox (org-update-checkbox-count-maybe))
6985 t))
6987 ;;; Checkboxes
6989 (defun org-at-item-checkbox-p ()
6990 "Is point at a line starting a plain-list item with a checklet?"
6991 (and (org-at-item-p)
6992 (save-excursion
6993 (goto-char (match-end 0))
6997 (defun org-toggle-checkbox (&optional arg)
6998 "Toggle the checkbox in the current line."
6999 (interactive "P")
7000 (catch 'exit
7001 (let (beg end status (firstnew 'unknown))
7002 (cond
7003 ((org-region-active-p)
7004 (setq beg (region-beginning) end (region-end)))
7005 ((org-on-heading-p)
7006 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
7007 ((org-at-item-checkbox-p)
7008 (let ((pos (point)))
7009 (replace-match
7010 (cond (arg "[-]")
7011 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
7012 (t "[ ]"))
7013 t t)
7014 (goto-char pos))
7015 (throw 'exit t))
7016 (t (error "Not at a checkbox or heading, and no active region")))
7017 (save-excursion
7018 (goto-char beg)
7019 (while (< (point) end)
7020 (when (org-at-item-checkbox-p)
7021 (setq status (equal (match-string 0) "[X]"))
7022 (when (eq firstnew 'unknown)
7023 (setq firstnew (not status)))
7024 (replace-match
7025 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
7026 (beginning-of-line 2)))))
7027 (org-update-checkbox-count-maybe))
7029 (defun org-update-checkbox-count-maybe ()
7030 "Update checkbox statistics unless turned off by user."
7031 (when org-provide-checkbox-statistics
7032 (org-update-checkbox-count)))
7034 (defun org-update-checkbox-count (&optional all)
7035 "Update the checkbox statistics in the current section.
7036 This will find all statistic cookies like [57%] and [6/12] and update them
7037 with the current numbers. With optional prefix argument ALL, do this for
7038 the whole buffer."
7039 (interactive "P")
7040 (save-excursion
7041 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
7042 (beg (condition-case nil
7043 (progn (outline-back-to-heading) (point))
7044 (error (point-min))))
7045 (end (move-marker (make-marker)
7046 (progn (outline-next-heading) (point))))
7050 beg-cookie end-cookie is-percent c-on c-off lim
7051 eline curr-ind next-ind continue-from startsearch
7052 (cstat 0)
7053 )
7054 (when all
7055 (goto-char (point-min))
7056 (outline-next-heading)
7057 (setq beg (point) end (point-max)))
7058 (goto-char end)
7059 ;; find each statistic cookie
7060 (while (re-search-backward re-find beg t)
7061 (setq beg-cookie (match-beginning 1)
7062 end-cookie (match-end 1)
7063 cstat (+ cstat (if end-cookie 1 0))
7064 startsearch (point-at-eol)
7065 continue-from (point-at-bol)
7066 is-percent (match-beginning 2)
7067 lim (cond
7068 ((org-on-heading-p) (outline-next-heading) (point))
7069 ((org-at-item-p) (org-end-of-item) (point))
7070 (t nil))
7071 c-on 0
7072 c-off 0)
7073 (when lim
7074 ;; find first checkbox for this cookie and gather
7075 ;; statistics from all that are at this indentation level
7076 (goto-char startsearch)
7077 (if (re-search-forward re-box lim t)
7078 (progn
7079 (org-beginning-of-item)
7080 (setq curr-ind (org-get-indentation))
7081 (setq next-ind curr-ind)
7082 (while (= curr-ind next-ind)
7083 (save-excursion (end-of-line) (setq eline (point)))
7084 (if (re-search-forward re-box eline t)
7085 (if (member (match-string 2) '("[ ]" "[-]"))
7086 (setq c-off (1+ c-off))
7087 (setq c-on (1+ c-on))
7088 )
7089 )
7090 (org-end-of-item)
7091 (setq next-ind (org-get-indentation))
7092 )))
7093 (goto-char continue-from)
7094 ;; update cookie
7095 (when end-cookie
7096 (delete-region beg-cookie end-cookie)
7097 (goto-char beg-cookie)
7098 (insert
7099 (if is-percent
7100 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
7101 (format "[%d/%d]" c-on (+ c-on c-off)))))
7102 ;; update items checkbox if it has one
7103 (when (org-at-item-p)
7104 (org-beginning-of-item)
7105 (when (and (> (+ c-on c-off) 0)
7106 (re-search-forward re-box (point-at-eol) t))
7107 (setq beg-cookie (match-beginning 2)
7108 end-cookie (match-end 2))
7109 (delete-region beg-cookie end-cookie)
7110 (goto-char beg-cookie)
7111 (cond ((= c-off 0) (insert "[X]"))
7112 ((= c-on 0) (insert "[ ]"))
7113 (t (insert "[-]")))
7114 )))
7115 (goto-char continue-from))
7116 (when (interactive-p)
7117 (message "Checkbox satistics updated %s (%d places)"
7118 (if all "in entire file" "in current outline entry") cstat)))))
7120 (defun org-get-checkbox-statistics-face ()
7121 "Select the face for checkbox statistics.
7122 The face will be `org-done' when all relevant boxes are checked. Otherwise
7123 it will be `org-todo'."
7124 (if (match-end 1)
7125 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
7126 (if (and (> (match-end 2) (match-beginning 2))
7127 (equal (match-string 2) (match-string 3)))
7128 'org-done
7129 'org-todo)))
7131 (defun org-get-indentation (&optional line)
7132 "Get the indentation of the current line, interpreting tabs.
7133 When LINE is given, assume it represents a line and compute its indentation."
7134 (if line
7135 (if (string-match "^ *" (org-remove-tabs line))
7136 (match-end 0))
7137 (save-excursion
7138 (beginning-of-line 1)
7140 (current-column))))
7142 (defun org-remove-tabs (s &optional width)
7143 "Replace tabulators in S with spaces.
7144 Assumes that s is a single line, starting in column 0."
7145 (setq width (or width tab-width))
7147 (setq s (replace-match
7148 (make-string
7149 (- (* width (/ (+ (match-beginning 0) width) width))
7150 (match-beginning 0)) ?\ )
7151 t t s)))
7152 s)
7154 (defun org-fix-indentation (line ind)
7155 "Fix indentation in LINE.
7156 IND is a cons cell with target and minimum indentation.
7157 If the current indenation in LINE is smaller than the minimum,
7158 leave it alone. If it is larger than ind, set it to the target."
7159 (let* ((l (org-remove-tabs line))
7160 (i (org-get-indentation l))
7161 (i1 (car ind)) (i2 (cdr ind)))
7162 (if (>= i i2) (setq l (substring line i2)))
7163 (if (> i1 0)
7164 (concat (make-string i1 ?\ ) l)
7165 l)))
7167 (defcustom org-empty-line-terminates-plain-lists nil
7168 "Non-nil means, an empty line ends all plain list levels.
7169 When nil, empty lines are part of the preceeding item."
7170 :group 'org-plain-lists
7171 :type 'boolean)
7173 (defun org-beginning-of-item ()
7174 "Go to the beginning of the current hand-formatted item.
7175 If the cursor is not in an item, throw an error."
7176 (interactive)
7177 (let ((pos (point))
7178 (limit (save-excursion
7179 (condition-case nil
7180 (progn
7181 (org-back-to-heading)
7182 (beginning-of-line 2) (point))
7183 (error (point-min)))))
7184 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7185 ind ind1)
7186 (if (org-at-item-p)
7187 (beginning-of-line 1)
7188 (beginning-of-line 1)
7190 (setq ind (current-column))
7191 (if (catch 'exit
7192 (while t
7193 (beginning-of-line 0)
7194 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
7197 (setq ind1 ind-empty)
7199 (setq ind1 (current-column)))
7200 (if (< ind1 ind)
7201 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
7202 nil
7203 (goto-char pos)
7204 (error "Not in an item")))))
7206 (defun org-end-of-item ()
7207 "Go to the end of the current hand-formatted item.
7208 If the cursor is not in an item, throw an error."
7209 (interactive)
7210 (let* ((pos (point))
7211 ind1
7212 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
7213 (limit (save-excursion (outline-next-heading) (point)))
7214 (ind (save-excursion
7215 (org-beginning-of-item)
7217 (current-column)))
7218 (end (catch 'exit
7219 (while t
7220 (beginning-of-line 2)
7221 (if (eobp) (throw 'exit (point)))
7222 (if (>= (point) limit) (throw 'exit (point-at-bol)))
7224 (setq ind1 ind-empty)
7226 (setq ind1 (current-column)))
7227 (if (<= ind1 ind)
7228 (throw 'exit (point-at-bol)))))))
7229 (if end
7230 (goto-char end)
7231 (goto-char pos)
7232 (error "Not in an item"))))
7234 (defun org-next-item ()
7235 "Move to the beginning of the next item in the current plain list.
7236 Error if not at a plain list, or if this is the last item in the list."
7237 (interactive)
7238 (let (ind ind1 (pos (point)))
7239 (org-beginning-of-item)
7240 (setq ind (org-get-indentation))
7241 (org-end-of-item)
7242 (setq ind1 (org-get-indentation))
7243 (unless (and (org-at-item-p) (= ind ind1))
7244 (goto-char pos)
7245 (error "On last item"))))
7247 (defun org-previous-item ()
7248 "Move to the beginning of the previous item in the current plain list.
7249 Error if not at a plain list, or if this is the first item in the list."
7250 (interactive)
7251 (let (beg ind ind1 (pos (point)))
7252 (org-beginning-of-item)
7253 (setq beg (point))
7254 (setq ind (org-get-indentation))
7255 (goto-char beg)
7256 (catch 'exit
7257 (while t
7258 (beginning-of-line 0)
7260 nil
7261 (if (<= (setq ind1 (org-get-indentation)) ind)
7262 (throw 'exit t)))))
7263 (condition-case nil
7264 (if (or (not (org-at-item-p))
7265 (< ind1 (1- ind)))
7266 (error "")
7267 (org-beginning-of-item))
7268 (error (goto-char pos)
7269 (error "On first item")))))
7271 (defun org-first-list-item-p ()
7272 "Is this heading the item in a plain list?"
7273 (unless (org-at-item-p)
7274 (error "Not at a plain list item"))
7275 (org-beginning-of-item)
7276 (= (point) (save-excursion (org-beginning-of-item-list))))
7278 (defun org-move-item-down ()
7279 "Move the plain list item at point down, i.e. swap with following item.
7280 Subitems (items with larger indentation) are considered part of the item,
7281 so this really moves item trees."
7282 (interactive)
7283 (let (beg beg0 end end0 ind ind1 (pos (point)) txt ne-end ne-beg)
7284 (org-beginning-of-item)
7285 (setq beg0 (point))
7286 (save-excursion
7287 (setq ne-beg (org-back-over-empty-lines))
7288 (setq beg (point)))
7289 (goto-char beg0)
7290 (setq ind (org-get-indentation))
7291 (org-end-of-item)
7292 (setq end0 (point))
7293 (setq ind1 (org-get-indentation))
7294 (setq ne-end (org-back-over-empty-lines))
7295 (setq end (point))
7296 (goto-char beg0)
7297 (when (and (org-first-list-item-p) (< ne-end ne-beg))
7298 ;; include less whitespace
7299 (save-excursion
7300 (goto-char beg)
7301 (forward-line (- ne-beg ne-end))
7302 (setq beg (point))))
7303 (goto-char end0)
7304 (if (and (org-at-item-p) (= ind ind1))
7305 (progn
7306 (org-end-of-item)
7307 (org-back-over-empty-lines)
7308 (setq txt (buffer-substring beg end))
7309 (save-excursion
7310 (delete-region beg end))
7311 (setq pos (point))
7312 (insert txt)
7313 (goto-char pos) (org-skip-whitespace)
7314 (org-maybe-renumber-ordered-list))
7315 (goto-char pos)
7316 (error "Cannot move this item further down"))))
7318 (defun org-move-item-up (arg)
7319 "Move the plain list item at point up, i.e. swap with previous item.
7320 Subitems (items with larger indentation) are considered part of the item,
7321 so this really moves item trees."
7322 (interactive "p")
7323 (let (beg beg0 end ind ind1 (pos (point)) txt
7324 ne-beg ne-ins ins-end)
7325 (org-beginning-of-item)
7326 (setq beg0 (point))
7327 (setq ind (org-get-indentation))
7328 (save-excursion
7329 (setq ne-beg (org-back-over-empty-lines))
7330 (setq beg (point)))
7331 (goto-char beg0)
7332 (org-end-of-item)
7333 (setq end (point))
7334 (goto-char beg0)
7335 (catch 'exit
7336 (while t
7337 (beginning-of-line 0)
7339 (if org-empty-line-terminates-plain-lists
7340 (progn
7341 (goto-char pos)
7342 (error "Cannot move this item further up"))
7343 nil)
7344 (if (<= (setq ind1 (org-get-indentation)) ind)
7345 (throw 'exit t)))))
7346 (condition-case nil
7347 (org-beginning-of-item)
7348 (error (goto-char beg)
7349 (error "Cannot move this item further up")))
7350 (setq ind1 (org-get-indentation))
7351 (if (and (org-at-item-p) (= ind ind1))
7352 (progn
7353 (setq ne-ins (org-back-over-empty-lines))
7354 (setq txt (buffer-substring beg end))
7355 (save-excursion
7356 (delete-region beg end))
7357 (setq pos (point))
7358 (insert txt)
7359 (setq ins-end (point))
7360 (goto-char pos) (org-skip-whitespace)
7362 (when (and (org-first-list-item-p) (> ne-ins ne-beg))
7363 ;; Move whitespace back to beginning
7364 (save-excursion
7365 (goto-char ins-end)
7366 (let ((kill-whole-line t))
7367 (kill-line (- ne-ins ne-beg)) (point)))
7370 (org-maybe-renumber-ordered-list))
7371 (goto-char pos)
7372 (error "Cannot move this item further up"))))
7374 (defun org-maybe-renumber-ordered-list ()
7375 "Renumber the ordered list at point if setup allows it.
7376 This tests the user option `org-auto-renumber-ordered-lists' before
7377 doing the renumbering."
7378 (interactive)
7379 (when (and org-auto-renumber-ordered-lists
7380 (org-at-item-p))
7381 (if (match-beginning 3)
7382 (org-renumber-ordered-list 1)
7383 (org-fix-bullet-type))))
7385 (defun org-maybe-renumber-ordered-list-safe ()
7386 (condition-case nil
7387 (save-excursion
7388 (org-maybe-renumber-ordered-list))
7389 (error nil)))
7391 (defun org-cycle-list-bullet (&optional which)
7392 "Cycle through the different itemize/enumerate bullets.
7393 This cycle the entire list level through the sequence:
7395 `-' -> `+' -> `*' -> `1.' -> `1)'
7397 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
7398 0 meand `-', 1 means `+' etc."
7399 (interactive "P")
7400 (org-preserve-lc
7401 (org-beginning-of-item-list)
7402 (org-at-item-p)
7403 (beginning-of-line 1)
7404 (let ((current (match-string 0))
7405 (prevp (eq which 'previous))
7406 new)
7407 (setq new (cond
7408 ((and (numberp which)
7409 (nth (1- which) '("-" "+" "*" "1." "1)"))))
7410 ((string-match "-" current) (if prevp "1)" "+"))
7415 ((string-match ")" current) (if prevp "1." "-"))
7416 (t (error "This should not happen"))))
7418 (org-fix-bullet-type)
7419 (org-maybe-renumber-ordered-list))))
7421 (defun org-get-string-indentation (s)
7422 "What indentation has S due to SPACE and TAB at the beginning of the string?"
7423 (let ((n -1) (i 0) (w tab-width) c)
7424 (catch 'exit
7425 (while (< (setq n (1+ n)) (length s))
7426 (setq c (aref s n))
7427 (cond ((= c ?\ ) (setq i (1+ i)))
7429 (t (throw 'exit t)))))
7430 i))
7432 (defun org-renumber-ordered-list (arg)
7433 "Renumber an ordered plain list.
7434 Cursor needs to be in the first line of an item, the line that starts
7436 (interactive "p")
7437 (unless (and (org-at-item-p)
7438 (match-beginning 3))
7439 (error "This is not an ordered list"))
7440 (let ((line (org-current-line))
7441 (col (current-column))
7442 (ind (org-get-string-indentation
7443 (buffer-substring (point-at-bol) (match-beginning 3))))
7444 ;; (term (substring (match-string 3) -1))
7445 ind1 (n (1- arg))
7446 fmt)
7447 ;; find where this list begins
7448 (org-beginning-of-item-list)
7450 (setq fmt (concat "%d" (match-string 1)))
7451 (beginning-of-line 0)
7452 ;; walk forward and replace these numbers
7453 (catch 'exit
7454 (while t
7455 (catch 'next
7456 (beginning-of-line 2)
7457 (if (eobp) (throw 'exit nil))
7460 (if (> ind1 ind) (throw 'next t))
7461 (if (< ind1 ind) (throw 'exit t))
7462 (if (not (org-at-item-p)) (throw 'exit nil))
7463 (delete-region (match-beginning 2) (match-end 2))
7464 (goto-char (match-beginning 2))
7465 (insert (format fmt (setq n (1+ n)))))))
7466 (goto-line line)
7467 (move-to-column col)))
7469 (defun org-fix-bullet-type ()
7470 "Make sure all items in this list have the same bullet as the firsst item."
7471 (interactive)
7472 (unless (org-at-item-p) (error "This is not a list"))
7473 (let ((line (org-current-line))
7474 (col (current-column))
7475 (ind (current-indentation))
7476 ind1 bullet)
7477 ;; find where this list begins
7478 (org-beginning-of-item-list)
7479 (beginning-of-line 1)
7480 ;; find out what the bullet type is
7482 (setq bullet (match-string 1))
7483 ;; walk forward and replace these numbers
7484 (beginning-of-line 0)
7485 (catch 'exit
7486 (while t
7487 (catch 'next
7488 (beginning-of-line 2)
7489 (if (eobp) (throw 'exit nil))
7492 (if (> ind1 ind) (throw 'next t))
7493 (if (< ind1 ind) (throw 'exit t))
7494 (if (not (org-at-item-p)) (throw 'exit nil))
7497 (replace-match bullet))))
7498 (goto-line line)
7499 (move-to-column col)
7500 (if (string-match "[0-9]" bullet)
7501 (org-renumber-ordered-list 1))))
7503 (defun org-beginning-of-item-list ()
7504 "Go to the beginning of the current item list.
7505 I.e. to the first item in this list."
7506 (interactive)
7507 (org-beginning-of-item)
7508 (let ((pos (point-at-bol))
7509 (ind (org-get-indentation))
7510 ind1)
7511 ;; find where this list begins
7512 (catch 'exit
7513 (while t
7514 (catch 'next
7515 (beginning-of-line 0)
7517 (throw (if (bobp) 'exit 'next) t))
7519 (if (or (< ind1 ind)
7520 (and (= ind1 ind)
7521 (not (org-at-item-p)))
7522 (bobp))
7523 (throw 'exit t)
7524 (when (org-at-item-p) (setq pos (point-at-bol)))))))
7525 (goto-char pos)))
7528 (defun org-end-of-item-list ()
7529 "Go to the end of the current item list.
7530 I.e. to the text after the last item."
7531 (interactive)
7532 (org-beginning-of-item)
7533 (let ((pos (point-at-bol))
7534 (ind (org-get-indentation))
7535 ind1)
7536 ;; find where this list begins
7537 (catch 'exit
7538 (while t
7539 (catch 'next
7540 (beginning-of-line 2)
7542 (throw (if (eobp) 'exit 'next) t))
7544 (if (or (< ind1 ind)
7545 (and (= ind1 ind)
7546 (not (org-at-item-p)))
7547 (eobp))
7548 (progn
7549 (setq pos (point-at-bol))
7550 (throw 'exit t))))))
7551 (goto-char pos)))
7554 (defvar org-last-indent-begin-marker (make-marker))
7555 (defvar org-last-indent-end-marker (make-marker))
7557 (defun org-outdent-item (arg)
7558 "Outdent a local list item."
7559 (interactive "p")
7560 (org-indent-item (- arg)))
7562 (defun org-indent-item (arg)
7563 "Indent a local list item."
7564 (interactive "p")
7565 (unless (org-at-item-p)
7566 (error "Not on an item"))
7567 (save-excursion
7568 (let (beg end ind ind1 tmp delta ind-down ind-up)
7569 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
7570 (setq beg org-last-indent-begin-marker
7571 end org-last-indent-end-marker)
7572 (org-beginning-of-item)
7573 (setq beg (move-marker org-last-indent-begin-marker (point)))
7574 (org-end-of-item)
7575 (setq end (move-marker org-last-indent-end-marker (point))))
7576 (goto-char beg)
7577 (setq tmp (org-item-indent-positions)
7578 ind (car tmp)
7579 ind-down (nth 2 tmp)
7580 ind-up (nth 1 tmp)
7581 delta (if (> arg 0)
7582 (if ind-down (- ind-down ind) 2)
7583 (if ind-up (- ind-up ind) -2)))
7584 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
7585 (while (< (point) end)
7586 (beginning-of-line 1)
7588 (delete-region (point-at-bol) (point))
7589 (or (eolp) (indent-to-column (+ ind1 delta)))
7590 (beginning-of-line 2))))
7591 (org-fix-bullet-type)
7592 (org-maybe-renumber-ordered-list-safe)
7593 (save-excursion
7594 (beginning-of-line 0)
7595 (condition-case nil (org-beginning-of-item) (error nil))
7596 (org-maybe-renumber-ordered-list-safe)))
7598 (defun org-item-indent-positions ()
7599 "Return indentation for plain list items.
7600 This returns a list with three values: The current indentation, the
7601 parent indentation and the indentation a child should habe.
7602 Assumes cursor in item line."
7603 (let* ((bolpos (point-at-bol))
7604 (ind (org-get-indentation))
7605 ind-down ind-up pos)
7606 (save-excursion
7607 (org-beginning-of-item-list)
7609 (when (org-in-item-p)
7610 (org-beginning-of-item)
7611 (setq ind-up (org-get-indentation))))
7612 (setq pos (point))
7613 (save-excursion
7614 (cond
7615 ((and (condition-case nil (progn (org-previous-item) t)
7616 (error nil))
7617 (or (forward-char 1) t)
7618 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
7619 (setq ind-down (org-get-indentation)))
7620 ((and (goto-char pos)
7621 (org-at-item-p))
7622 (goto-char (match-end 0))
7624 (setq ind-down (current-column)))))
7625 (list ind ind-up ind-down)))
7627 ;;; The orgstruct minor mode
7629 ;; Define a minor mode which can be used in other modes in order to
7630 ;; integrate the org-mode structure editing commands.
7632 ;; This is really a hack, because the org-mode structure commands use
7633 ;; keys which normally belong to the major mode. Here is how it
7634 ;; works: The minor mode defines all the keys necessary to operate the
7635 ;; structure commands, but wraps the commands into a function which
7636 ;; tests if the cursor is currently at a headline or a plain list
7637 ;; item. If that is the case, the structure command is used,
7638 ;; temporarily setting many Org-mode variables like regular
7639 ;; expressions for filling etc. However, when any of those keys is
7640 ;; used at a different location, function uses `key-binding' to look
7641 ;; up if the key has an associated command in another currently active
7642 ;; keymap (minor modes, major mode, global), and executes that
7643 ;; command. There might be problems if any of the keys is otherwise
7644 ;; used as a prefix key.
7646 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7647 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7648 ;; addresses this by checking explicitly for both bindings.
7650 (defvar orgstruct-mode-map (make-sparse-keymap)
7651 "Keymap for the minor `orgstruct-mode'.")
7653 (defvar org-local-vars nil
7654 "List of local variables, for use by `orgstruct-mode'")
7656 ;;;###autoload
7657 (define-minor-mode orgstruct-mode
7658 "Toggle the minor more `orgstruct-mode'.
7659 This mode is for using Org-mode structure commands in other modes.
7660 The following key behave as if Org-mode was active, if the cursor
7661 is on a headline, or on a plain list item (both in the definition
7662 of Org-mode).
7664 M-up Move entry/item up
7665 M-down Move entry/item down
7666 M-left Promote
7667 M-right Demote
7668 M-S-up Move entry/item up
7669 M-S-down Move entry/item down
7670 M-S-left Promote subtree
7671 M-S-right Demote subtree
7672 M-q Fill paragraph and items like in Org-mode
7673 C-c ^ Sort entries
7674 C-c - Cycle list bullet
7675 TAB Cycle item visibility
7676 M-RET Insert new heading/item
7677 S-M-RET Insert new TODO heading / Chekbox item
7678 C-c C-c Set tags / toggle checkbox"
7679 nil " OrgStruct" nil
7680 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7682 ;;;###autoload
7683 (defun turn-on-orgstruct ()
7684 "Unconditionally turn on `orgstruct-mode'."
7685 (orgstruct-mode 1))
7687 ;;;###autoload
7688 (defun turn-on-orgstruct++ ()
7689 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7690 In addition to setting orgstruct-mode, this also exports all indentation and
7691 autofilling variables from org-mode into the buffer. Note that turning
7692 off orgstruct-mode will *not* remove these additional settings."
7693 (orgstruct-mode 1)
7694 (let (var val)
7695 (mapc
7696 (lambda (x)
7697 (when (string-match
7699 (symbol-name (car x)))
7700 (setq var (car x) val (nth 1 x))
7701 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7702 org-local-vars)))
7704 (defun orgstruct-error ()
7705 "Error when there is no default binding for a structure key."
7706 (interactive)
7707 (error "This key has no function outside structure elements"))
7709 (defun orgstruct-setup ()
7710 "Setup orgstruct keymaps."
7711 (let ((nfunc 0)
7712 (bindings
7713 (list
7714 '([(meta up)] org-metaup)
7715 '([(meta down)] org-metadown)
7716 '([(meta left)] org-metaleft)
7717 '([(meta right)] org-metaright)
7718 '([(meta shift up)] org-shiftmetaup)
7719 '([(meta shift down)] org-shiftmetadown)
7720 '([(meta shift left)] org-shiftmetaleft)
7721 '([(meta shift right)] org-shiftmetaright)
7722 '([(shift up)] org-shiftup)
7723 '([(shift down)] org-shiftdown)
7724 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7725 '("\M-q" fill-paragraph)
7726 '("\C-c^" org-sort)
7727 '("\C-c-" org-cycle-list-bullet)))
7728 elt key fun cmd)
7729 (while (setq elt (pop bindings))
7730 (setq nfunc (1+ nfunc))
7731 (setq key (org-key (car elt))
7732 fun (nth 1 elt)
7733 cmd (orgstruct-make-binding fun nfunc key))
7734 (org-defkey orgstruct-mode-map key cmd))
7736 ;; Special treatment needed for TAB and RET
7737 (org-defkey orgstruct-mode-map [(tab)]
7738 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7739 (org-defkey orgstruct-mode-map "\C-i"
7740 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7742 (org-defkey orgstruct-mode-map "\M-\C-m"
7743 (orgstruct-make-binding 'org-insert-heading 105
7744 "\M-\C-m" [(meta return)]))
7745 (org-defkey orgstruct-mode-map [(meta return)]
7746 (orgstruct-make-binding 'org-insert-heading 106
7747 [(meta return)] "\M-\C-m"))
7749 (org-defkey orgstruct-mode-map [(shift meta return)]
7750 (orgstruct-make-binding 'org-insert-todo-heading 107
7751 [(meta return)] "\M-\C-m"))
7753 (unless org-local-vars
7754 (setq org-local-vars (org-get-local-variables)))
7756 t))
7758 (defun orgstruct-make-binding (fun n &rest keys)
7759 "Create a function for binding in the structure minor mode.
7760 FUN is the command to call inside a table. N is used to create a unique
7761 command name. KEYS are keys that should be checked in for a command
7762 to execute outside of tables."
7763 (eval
7764 (list 'defun
7765 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7766 '(arg)
7768 "Outside of structure, run the binding of `"
7769 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7770 "'.")
7771 '(interactive "p")
7772 (list 'if
7773 '(org-context-p 'headline 'item)
7774 (list 'org-run-like-in-org-mode (list 'quote fun))
7775 (list 'let '(orgstruct-mode)
7776 (list 'call-interactively
7777 (append '(or)
7778 (mapcar (lambda (k)
7779 (list 'key-binding k))
7780 keys)
7781 '('orgstruct-error))))))))
7783 (defun org-context-p (&rest contexts)
7784 "Check if local context is and of CONTEXTS.
7785 Possible values in the list of contexts are `table', `headline', and `item'."
7786 (let ((pos (point)))
7787 (goto-char (point-at-bol))
7788 (prog1 (or (and (memq 'table contexts)
7790 (and (memq 'headline contexts)
7792 (and (memq 'item contexts)
7794 (goto-char pos))))
7796 (defun org-get-local-variables ()
7797 "Return a list of all local variables in an org-mode buffer."
7798 (let (varlist)
7799 (with-current-buffer (get-buffer-create "*Org tmp*")
7800 (erase-buffer)
7801 (org-mode)
7802 (setq varlist (buffer-local-variables)))
7803 (kill-buffer "*Org tmp*")
7804 (delq nil
7805 (mapcar
7806 (lambda (x)
7807 (setq x
7808 (if (symbolp x)
7809 (list x)
7810 (list (car x) (list 'quote (cdr x)))))
7811 (if (string-match
7812 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7813 (symbol-name (car x)))
7814 x nil))
7815 varlist))))
7817 ;;;###autoload
7818 (defun org-run-like-in-org-mode (cmd)
7819 (unless org-local-vars
7820 (setq org-local-vars (org-get-local-variables)))
7821 (eval (list 'let org-local-vars
7822 (list 'call-interactively (list 'quote cmd)))))
7824 ;;;; Archiving
7826 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7828 (defun org-archive-subtree (&optional find-done)
7829 "Move the current subtree to the archive.
7830 The archive can be a certain top-level heading in the current file, or in
7831 a different file. The tree will be moved to that location, the subtree
7832 heading be marked DONE, and the current time will be added.
7834 When called with prefix argument FIND-DONE, find whole trees without any
7835 open TODO items and archive them (after getting confirmation from the user).
7836 If the cursor is not at a headline when this comand is called, try all level
7837 1 trees. If the cursor is on a headline, only try the direct children of
7838 this heading."
7839 (interactive "P")
7840 (if find-done
7841 (org-archive-all-done)
7842 ;; Save all relevant TODO keyword-relatex variables
7844 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7845 (tr-org-todo-keywords-1 org-todo-keywords-1)
7846 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7847 (tr-org-done-keywords org-done-keywords)
7848 (tr-org-todo-regexp org-todo-regexp)
7849 (tr-org-todo-line-regexp org-todo-line-regexp)
7850 (tr-org-odd-levels-only org-odd-levels-only)
7851 (this-buffer (current-buffer))
7852 (org-archive-location org-archive-location)
7854 ;; start of variables that will be used for saving context
7855 ;; The compiler complains about them - keep them anyway!
7856 (file (abbreviate-file-name (buffer-file-name)))
7857 (olpath (mapconcat 'identity (org-get-outline-path) "/"))
7858 (time (format-time-string
7859 (substring (cdr org-time-stamp-formats) 1 -1)
7860 (current-time)))
7861 afile heading buffer level newfile-p
7862 category todo priority
7863 ;; start of variables that will be used for savind context
7864 ltags itags prop)
7866 ;; Try to find a local archive location
7867 (save-excursion
7868 (save-restriction
7869 (widen)
7870 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7872 (setq org-archive-location prop)
7873 (if (or (re-search-backward re nil t)
7874 (re-search-forward re nil t))
7875 (setq org-archive-location (match-string 1))))))
7878 (progn
7879 (setq afile (format (match-string 1 org-archive-location)
7880 (file-name-nondirectory buffer-file-name))
7881 heading (match-string 2 org-archive-location)))
7882 (error "Invalid `org-archive-location'"))
7883 (if (> (length afile) 0)
7884 (setq newfile-p (not (file-exists-p afile))
7885 buffer (find-file-noselect afile))
7886 (setq buffer (current-buffer)))
7887 (unless buffer
7889 (if (and (> (length heading) 0)
7891 (setq level (match-end 0))
7892 (setq heading nil level 0))
7893 (save-excursion
7894 (org-back-to-heading t)
7895 ;; Get context information that will be lost by moving the tree
7896 (org-refresh-category-properties)
7897 (setq category (org-get-category)
7898 todo (and (looking-at org-todo-line-regexp)
7899 (match-string 2))
7900 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7901 ltags (org-get-tags)
7902 itags (org-delete-all ltags (org-get-tags-at)))
7903 (setq ltags (mapconcat 'identity ltags " ")
7904 itags (mapconcat 'identity itags " "))
7905 ;; We first only copy, in case something goes wrong
7906 ;; we need to protect this-command, to avoid kill-region sets it,
7907 ;; which would lead to duplication of subtrees
7908 (let (this-command) (org-copy-subtree))
7909 (set-buffer buffer)
7910 ;; Enforce org-mode for the archive buffer
7911 (if (not (org-mode-p))
7912 ;; Force the mode for future visits.
7913 (let ((org-insert-mode-line-in-empty-file t)
7914 (org-inhibit-startup t))
7915 (call-interactively 'org-mode)))
7916 (when newfile-p
7917 (goto-char (point-max))
7919 (buffer-file-name this-buffer))))
7920 ;; Force the TODO keywords of the original buffer
7921 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7922 (org-todo-keywords-1 tr-org-todo-keywords-1)
7923 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7924 (org-done-keywords tr-org-done-keywords)
7925 (org-todo-regexp tr-org-todo-regexp)
7926 (org-todo-line-regexp tr-org-todo-line-regexp)
7927 (org-odd-levels-only
7928 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7929 org-odd-levels-only
7930 tr-org-odd-levels-only)))
7931 (goto-char (point-min))
7932 (if heading
7933 (progn
7934 (if (re-search-forward
7935 (concat "^" (regexp-quote heading)
7937 nil t)
7938 (goto-char (match-end 0))
7939 ;; Heading not found, just insert it at the end
7940 (goto-char (point-max))
7943 (end-of-line 0))
7944 ;; Make the subtree visible
7945 (show-subtree)
7946 (org-end-of-subtree t)
7950 ;; No specific heading, just go to end of file.
7952 ;; Paste
7953 (org-paste-subtree (org-get-legal-level level 1))
7955 ;; Mark the entry as done
7956 (when (and org-archive-mark-done
7957 (looking-at org-todo-line-regexp)
7958 (or (not (match-end 2))
7959 (not (member (match-string 2) org-done-keywords))))
7960 (let (org-log-done org-todo-log-states)
7961 (org-todo
7962 (car (or (member org-archive-mark-done org-done-keywords)
7963 org-done-keywords)))))
7965 ;; Add the context info
7966 (when org-archive-save-context-info
7967 (let ((l org-archive-save-context-info) e n v)
7968 (while (setq e (pop l))
7969 (when (and (setq v (symbol-value e))
7971 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7972 (org-entry-put (point) n v)))))
7974 ;; Save the buffer, if it is not the same buffer.
7975 (if (not (eq this-buffer buffer)) (save-buffer))))
7976 ;; Here we are back in the original buffer. Everything seems to have
7977 ;; worked. So now cut the tree and finish up.
7978 (let (this-command) (org-cut-subtree))
7980 (message "Subtree archived %s"
7981 (if (eq this-buffer buffer)
7982 (concat "under heading: " heading)
7983 (concat "in file: " (abbreviate-file-name afile)))))))
7985 (defun org-refresh-category-properties ()
7986 "Refresh category text properties in teh buffer."
7987 (let ((def-cat (cond
7988 ((null org-category)
7989 (if buffer-file-name
7990 (file-name-sans-extension
7991 (file-name-nondirectory buffer-file-name))
7992 "???"))
7993 ((symbolp org-category) (symbol-name org-category))
7994 (t org-category)))
7995 beg end cat pos optionp)
7996 (org-unmodified
7997 (save-excursion
7998 (save-restriction
7999 (widen)
8000 (goto-char (point-min))
8001 (put-text-property (point) (point-max) 'org-category def-cat)
8002 (while (re-search-forward
8004 (setq pos (match-end 0)
8005 optionp (equal (char-after (match-beginning 0)) ?#)
8006 cat (org-trim (match-string 2)))
8007 (if optionp
8008 (setq beg (point-at-bol) end (point-max))
8009 (org-back-to-heading t)
8010 (setq beg (point) end (org-end-of-subtree t t)))
8011 (put-text-property beg end 'org-category cat)
8012 (goto-char pos)))))))
8014 (defun org-archive-all-done (&optional tag)
8015 "Archive sublevels of the current tree without open TODO items.
8016 If the cursor is not on a headline, try all level 1 trees. If
8017 it is on a headline, try all direct children.
8018 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
8020 (rea (concat ".*:" org-archive-tag ":"))
8021 (begm (make-marker))
8022 (endm (make-marker))
8023 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
8024 "Move subtree to archive (no open TODO items)? "))
8025 beg end (cntarch 0))
8026 (if (org-on-heading-p)
8027 (progn
8028 (setq re1 (concat "^" (regexp-quote
8029 (make-string
8030 (1+ (- (match-end 0) (match-beginning 0) 1))
8031 ?*))
8032 " "))
8033 (move-marker begm (point))
8034 (move-marker endm (org-end-of-subtree t)))
8035 (setq re1 "^* ")
8036 (move-marker begm (point-min))
8037 (move-marker endm (point-max)))
8038 (save-excursion
8039 (goto-char begm)
8040 (while (re-search-forward re1 endm t)
8041 (setq beg (match-beginning 0)
8042 end (save-excursion (org-end-of-subtree t) (point)))
8043 (goto-char beg)
8044 (if (re-search-forward re end t)
8045 (goto-char end)
8046 (goto-char beg)
8047 (if (and (or (not tag) (not (looking-at rea)))
8048 (y-or-n-p question))
8049 (progn
8050 (if tag
8051 (org-toggle-tag org-archive-tag 'on)
8052 (org-archive-subtree))
8053 (setq cntarch (1+ cntarch)))
8054 (goto-char end)))))
8055 (message "%d trees archived" cntarch)))
8057 (defun org-cycle-hide-drawers (state)
8058 "Re-hide all drawers after a visibility state change."
8059 (when (and (org-mode-p)
8060 (not (memq state '(overview folded))))
8061 (save-excursion
8062 (let* ((globalp (memq state '(contents all)))
8063 (beg (if globalp (point-min) (point)))
8064 (end (if globalp (point-max) (org-end-of-subtree t))))
8065 (goto-char beg)
8066 (while (re-search-forward org-drawer-regexp end t)
8067 (org-flag-drawer t))))))
8069 (defun org-flag-drawer (flag)
8070 (save-excursion
8071 (beginning-of-line 1)
8073 (let ((b (match-end 0))
8074 (outline-regexp org-outline-regexp))
8075 (if (re-search-forward
8077 (save-excursion (outline-next-heading) (point)) t)
8078 (outline-flag-region b (point-at-eol) flag)
8079 (error ":END: line missing"))))))
8081 (defun org-cycle-hide-archived-subtrees (state)
8082 "Re-hide all archived subtrees after a visibility state change."
8083 (when (and (not org-cycle-open-archived-trees)
8084 (not (memq state '(overview folded))))
8085 (save-excursion
8086 (let* ((globalp (memq state '(contents all)))
8087 (beg (if globalp (point-min) (point)))
8088 (end (if globalp (point-max) (org-end-of-subtree t))))
8089 (org-hide-archived-subtrees beg end)
8090 (goto-char beg)
8091 (if (looking-at (concat ".*:" org-archive-tag ":"))
8092 (message "%s" (substitute-command-keys
8093 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
8095 (defun org-force-cycle-archived ()
8096 "Cycle subtree even if it is archived."
8097 (interactive)
8098 (setq this-command 'org-cycle)
8099 (let ((org-cycle-open-archived-trees t))
8100 (call-interactively 'org-cycle)))
8102 (defun org-hide-archived-subtrees (beg end)
8103 "Re-hide all archived subtrees after a visibility state change."
8104 (save-excursion
8105 (let* ((re (concat ":" org-archive-tag ":")))
8106 (goto-char beg)
8107 (while (re-search-forward re end t)
8108 (and (org-on-heading-p) (hide-subtree))
8109 (org-end-of-subtree t)))))
8111 (defun org-toggle-tag (tag &optional onoff)
8112 "Toggle the tag TAG for the current line.
8113 If ONOFF is `on' or `off', don't toggle but set to this state."
8114 (unless (org-on-heading-p t) (error "Not on headling"))
8115 (let (res current)
8116 (save-excursion
8117 (beginning-of-line)
8119 (point-at-eol) t)
8120 (progn
8121 (setq current (match-string 1))
8122 (replace-match ""))
8123 (setq current ""))
8124 (setq current (nreverse (org-split-string current ":")))
8125 (cond
8126 ((eq onoff 'on)
8127 (setq res t)
8128 (or (member tag current) (push tag current)))
8129 ((eq onoff 'off)
8130 (or (not (member tag current)) (setq current (delete tag current))))
8131 (t (if (member tag current)
8132 (setq current (delete tag current))
8133 (setq res t)
8134 (push tag current))))
8135 (end-of-line 1)
8136 (if current
8137 (progn
8138 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
8139 (org-set-tags nil t))
8140 (delete-horizontal-space))
8141 (run-hooks 'org-after-tags-change-hook))
8142 res))
8144 (defun org-toggle-archive-tag (&optional arg)
8145 "Toggle the archive tag for the current headline.
8146 With prefix ARG, check all children of current headline and offer tagging
8147 the children that do not contain any open TODO items."
8148 (interactive "P")
8149 (if arg
8150 (org-archive-all-done 'tag)
8151 (let (set)
8152 (save-excursion
8153 (org-back-to-heading t)
8154 (setq set (org-toggle-tag org-archive-tag))
8155 (when set (hide-subtree)))
8156 (and set (beginning-of-line 1))
8157 (message "Subtree %s" (if set "archived" "unarchived")))))
8160 ;;;; Tables
8162 ;;; The table editor
8164 ;; Watch out: Here we are talking about two different kind of tables.
8165 ;; Most of the code is for the tables created with the Org-mode table editor.
8166 ;; Sometimes, we talk about tables created and edited with the table.el
8167 ;; Emacs package. We call the former org-type tables, and the latter
8168 ;; table.el-type tables.
8170 (defun org-before-change-function (beg end)
8171 "Every change indicates that a table might need an update."
8172 (setq org-table-may-need-update t))
8175 "Detects an org-type table line.")
8177 "Detects an org-type table line.")
8179 "Detects a table line marked for automatic recalculation.")
8181 "Detects a table line marked for automatic recalculation.")
8183 "Detects a table line marked for automatic recalculation.")
8185 "Detects an org-type table hline.")
8187 "Detects a table-type table hline.")
8189 "Detects an org-type or table-type table.")
8191 "Searching from within a table (any type) this finds the first line
8192 outside the table.")
8194 "Searching from within a table (any type) this finds the first line
8195 outside the table.")
8197 (defvar org-table-last-highlighted-reference nil)
8198 (defvar org-table-formula-history nil)
8200 (defvar org-table-column-names nil
8201 "Alist with column names, derived from the `!' line.")
8202 (defvar org-table-column-name-regexp nil
8203 "Regular expression matching the current column names.")
8204 (defvar org-table-local-parameters nil
8205 "Alist with parameter names, derived from the `$' line.")
8206 (defvar org-table-named-field-locations nil
8207 "Alist with locations of named fields.")
8209 (defvar org-table-current-line-types nil
8210 "Table row types, non-nil only for the duration of a comand.")
8211 (defvar org-table-current-begin-line nil
8212 "Table begin line, non-nil only for the duration of a comand.")
8213 (defvar org-table-current-begin-pos nil
8214 "Table begin position, non-nil only for the duration of a comand.")
8215 (defvar org-table-dlines nil
8216 "Vector of data line line numbers in the current table.")
8217 (defvar org-table-hlines nil
8218 "Vector of hline line numbers in the current table.")
8220 (defconst org-table-range-regexp
8221 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
8222 ;; 1 2 3 4 5
8223 "Regular expression for matching ranges in formulas.")
8225 (defconst org-table-range-regexp2
8226 (concat
8230 "Match a range for reference display.")
8232 (defconst org-table-translate-regexp
8234 "Match a reference that needs translation, for reference display.")
8236 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
8238 (defun org-table-create-with-table.el ()
8239 "Use the table.el package to insert a new table.
8240 If there is already a table at point, convert between Org-mode tables
8241 and table.el tables."
8242 (interactive)
8243 (require 'table)
8244 (cond
8245 ((org-at-table.el-p)
8246 (if (y-or-n-p "Convert table to Org-mode table? ")
8247 (org-table-convert)))
8248 ((org-at-table-p)
8249 (if (y-or-n-p "Convert table to table.el table? ")
8250 (org-table-convert)))
8251 (t (call-interactively 'table-insert))))
8253 (defun org-table-create-or-convert-from-region (arg)
8254 "Convert region to table, or create an empty table.
8255 If there is an active region, convert it to a table, using the function
8256 `org-table-convert-region'. See the documentation of that function
8257 to learn how the prefix argument is interpreted to determine the field
8258 separator.
8259 If there is no such region, create an empty table with `org-table-create'."
8260 (interactive "P")
8261 (if (org-region-active-p)
8262 (org-table-convert-region (region-beginning) (region-end) arg)
8263 (org-table-create arg)))
8265 (defun org-table-create (&optional size)
8266 "Query for a size and insert a table skeleton.
8268 (interactive "P")
8269 (unless size
8270 (setq size (read-string
8271 (concat "Table size Columns x Rows [e.g. "
8272 org-table-default-size "]: ")
8273 "" nil org-table-default-size)))
8275 (let* ((pos (point))
8276 (indent (make-string (current-column) ?\ ))
8277 (split (org-split-string size " *x *"))
8278 (rows (string-to-number (nth 1 split)))
8279 (columns (string-to-number (car split)))
8280 (line (concat (apply 'concat indent "|" (make-list columns " |"))
8283 (point-at-bol) (point)))
8284 (beginning-of-line 1)
8285 (newline))
8286 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
8287 (dotimes (i rows) (insert line))
8288 (goto-char pos)
8289 (if (> rows 1)
8290 ;; Insert a hline after the first row.
8291 (progn
8292 (end-of-line 1)
8294 (goto-char pos)))
8295 (org-table-align)))
8297 (defun org-table-convert-region (beg0 end0 &optional separator)
8298 "Convert region to a table.
8299 The region goes from BEG0 to END0, but these borders will be moved
8300 slightly, to make sure a beginning of line in the first line is included.
8302 SEPARATOR specifies the field separator in the lines. It can have the
8303 following values:
8305 '(4) Use the comma as a field separator
8306 '(16) Use a TAB as field separator
8307 integer When a number, use that many spaces as field separator
8308 nil When nil, the command tries to be smart and figure out the
8309 separator in the following way:
8310 - when each line contains a TAB, assume TAB-separated material
8311 - when each line contains a comme, assume CSV material
8312 - else, assume one or more SPACE charcters as separator."
8313 (interactive "rP")
8314 (let* ((beg (min beg0 end0))
8315 (end (max beg0 end0))
8316 re)
8317 (goto-char beg)
8318 (beginning-of-line 1)
8319 (setq beg (move-marker (make-marker) (point)))
8320 (goto-char end)
8321 (if (bolp) (backward-char 1) (end-of-line 1))
8322 (setq end (move-marker (make-marker) (point)))
8323 ;; Get the right field separator
8324 (unless separator
8325 (goto-char beg)
8326 (setq separator
8327 (cond
8330 (t 1))))
8331 (setq re (cond
8334 ((integerp separator)
8336 (t (error "This should not happen"))))
8337 (goto-char beg)
8338 (while (re-search-forward re end t)
8339 (replace-match "| " t t))
8340 (goto-char beg)
8341 (insert " ")
8342 (org-table-align)))
8344 (defun org-table-import (file arg)
8345 "Import FILE as a table.
8346 The file is assumed to be tab-separated. Such files can be produced by most
8347 spreadsheet and database applications. If no tabs (at least one per line)
8348 are found, lines will be split on whitespace into fields."
8350 (or (bolp) (newline))
8351 (let ((beg (point))
8352 (pm (point-max)))
8353 (insert-file-contents file)
8354 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
8356 (defun org-table-export ()
8357 "Export table as a tab-separated file.
8358 Such a file can be imported into a spreadsheet program like Excel."
8359 (interactive)
8360 (let* ((beg (org-table-begin))
8361 (end (org-table-end))
8362 (table (buffer-substring beg end))
8363 (file (read-file-name "Export table to: "))
8364 buf)
8365 (unless (or (not (file-exists-p file))
8366 (y-or-n-p (format "Overwrite file %s? " file)))
8367 (error "Abort"))
8368 (with-current-buffer (find-file-noselect file)
8369 (setq buf (current-buffer))
8370 (erase-buffer)
8371 (fundamental-mode)
8372 (insert table)
8373 (goto-char (point-min))
8375 (replace-match "" t t)
8376 (end-of-line 1))
8377 (goto-char (point-min))
8379 (replace-match "" t t)
8380 (goto-char (min (1+ (point)) (point-max))))
8381 (goto-char (point-min))
8382 (while (re-search-forward "^-[-+]*$" nil t)
8383 (replace-match "")
8385 (delete-char 1)))
8386 (goto-char (point-min))
8389 (save-buffer))
8390 (kill-buffer buf)))
8392 (defvar org-table-aligned-begin-marker (make-marker)
8393 "Marker at the beginning of the table last aligned.
8394 Used to check if cursor still is in that table, to minimize realignment.")
8395 (defvar org-table-aligned-end-marker (make-marker)
8396 "Marker at the end of the table last aligned.
8397 Used to check if cursor still is in that table, to minimize realignment.")
8398 (defvar org-table-last-alignment nil
8399 "List of flags for flushright alignment, from the last re-alignment.
8400 This is being used to correctly align a single field after TAB or RET.")
8401 (defvar org-table-last-column-widths nil
8402 "List of max width of fields in each column.
8403 This is being used to correctly align a single field after TAB or RET.")
8404 (defvar org-table-overlay-coordinates nil
8405 "Overlay coordinates after each align of a table.")
8406 (make-variable-buffer-local 'org-table-overlay-coordinates)
8408 (defvar org-last-recalc-line nil)
8409 (defconst org-narrow-column-arrow "=>"
8410 "Used as display property in narrowed table columns.")
8412 (defun org-table-align ()
8413 "Align the table at point by aligning all vertical bars."
8414 (interactive)
8415 (let* (
8416 ;; Limits of table
8417 (beg (org-table-begin))
8418 (end (org-table-end))
8419 ;; Current cursor position
8420 (linepos (org-current-line))
8421 (colpos (org-table-current-column))
8422 (winstart (window-start))
8423 (winstartline (org-current-line (min winstart (1- (point-max)))))
8424 lines (new "") lengths l typenums ty fields maxfields i
8425 column
8426 (indent "") cnt frac
8427 rfmt hfmt
8428 (spaces '(1 . 1))
8429 (sp1 (car spaces))
8430 (sp2 (cdr spaces))
8431 (rfmt1 (concat
8432 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
8433 (hfmt1 (concat
8434 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
8435 emptystrings links dates emph narrow fmax f1 len c e)
8436 (untabify beg end)
8437 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
8438 ;; Check if we have links or dates
8439 (goto-char beg)
8440 (setq links (re-search-forward org-bracket-link-regexp end t))
8441 (goto-char beg)
8442 (setq emph (and org-hide-emphasis-markers
8443 (re-search-forward org-emph-re end t)))
8444 (goto-char beg)
8445 (setq dates (and org-display-custom-times
8446 (re-search-forward org-ts-regexp-both end t)))
8447 ;; Make sure the link properties are right
8448 (when links (goto-char beg) (while (org-activate-bracket-links end)))
8449 ;; Make sure the date properties are right
8450 (when dates (goto-char beg) (while (org-activate-dates end)))
8451 (when emph (goto-char beg) (while (org-do-emphasis-faces end)))
8453 ;; Check if we are narrowing any columns
8454 (goto-char beg)
8455 (setq narrow (and org-format-transports-properties-p
8456 (re-search-forward "<[0-9]+>" end t)))
8457 ;; Get the rows
8458 (setq lines (org-split-string
8460 ;; Store the indentation of the first line
8461 (if (string-match "^ *" (car lines))
8462 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
8463 ;; Mark the hlines by setting the corresponding element to nil
8464 ;; At the same time, we remove trailing space.
8465 (setq lines (mapcar (lambda (l)
8466 (if (string-match "^ *|-" l)
8467 nil
8469 (substring l 0 (match-beginning 0))
8470 l)))
8471 lines))
8472 ;; Get the data fields by splitting the lines.
8473 (setq fields (mapcar
8474 (lambda (l)
8475 (org-split-string l " *| *"))
8476 (delq nil (copy-sequence lines))))
8477 ;; How many fields in the longest line?
8478 (condition-case nil
8479 (setq maxfields (apply 'max (mapcar 'length fields)))
8480 (error
8481 (kill-region beg end)
8482 (org-table-create org-table-default-size)
8483 (error "Empty table - created default table")))
8484 ;; A list of empty strings to fill any short rows on output
8485 (setq emptystrings (make-list maxfields ""))
8486 ;; Check for special formatting.
8487 (setq i -1)
8488 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
8489 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
8490 ;; Check if there is an explicit width specified
8491 (when narrow
8492 (setq c column fmax nil)
8493 (while c
8494 (setq e (pop c))
8496 (setq fmax (string-to-number (match-string 1 e)) c nil)))
8497 ;; Find fields that are wider than fmax, and shorten them
8498 (when fmax
8499 (loop for xx in column do
8500 (when (and (stringp xx)
8501 (> (org-string-width xx) fmax))
8502 (org-add-props xx nil
8503 'help-echo
8504 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
8505 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
8506 (unless (> f1 1)
8508 (match-string 0 xx)))
8509 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
8510 (add-text-properties (- f1 2) f1
8511 (list 'display org-narrow-column-arrow)
8512 xx)))))
8513 ;; Get the maximum width for each column
8514 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
8515 ;; Get the fraction of numbers, to decide about alignment of the column
8516 (setq cnt 0 frac 0.0)
8517 (loop for x in column do
8518 (if (equal x "")
8519 nil
8520 (setq frac ( / (+ (* frac cnt)
8521 (if (string-match org-table-number-regexp x) 1 0))
8522 (setq cnt (1+ cnt))))))
8523 (push (>= frac org-table-number-fraction) typenums))
8524 (setq lengths (nreverse lengths) typenums (nreverse typenums))
8526 ;; Store the alignment of this table, for later editing of single fields
8527 (setq org-table-last-alignment typenums
8528 org-table-last-column-widths lengths)
8530 ;; With invisible characters, `format' does not get the field width right
8531 ;; So we need to make these fields wide by hand.
8532 (when (or links emph)
8533 (loop for i from 0 upto (1- maxfields) do
8534 (setq len (nth i lengths))
8535 (loop for j from 0 upto (1- (length fields)) do
8536 (setq c (nthcdr i (car (nthcdr j fields))))
8537 (if (and (stringp (car c))
8538 (text-property-any 0 (length (car c)) 'invisible 'org-link (car c))
8539 ; (string-match org-bracket-link-regexp (car c))
8540 (< (org-string-width (car c)) len))
8541 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
8543 ;; Compute the formats needed for output of the table
8544 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
8545 (while (setq l (pop lengths))
8546 (setq ty (if (pop typenums) "" "-")) ; number types flushright
8547 (setq rfmt (concat rfmt (format rfmt1 ty l))
8548 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
8552 (setq new (mapconcat
8553 (lambda (l)
8554 (if l (apply 'format rfmt
8555 (append (pop fields) emptystrings))
8556 hfmt))
8557 lines ""))
8558 ;; Replace the old one
8559 (delete-region beg end)
8560 (move-marker end nil)
8561 (move-marker org-table-aligned-begin-marker (point))
8562 (insert new)
8563 (move-marker org-table-aligned-end-marker (point))
8564 (when (and orgtbl-mode (not (org-mode-p)))
8565 (goto-char org-table-aligned-begin-marker)
8566 (while (org-hide-wide-columns org-table-aligned-end-marker)))
8567 ;; Try to move to the old location
8568 (goto-line winstartline)
8569 (setq winstart (point-at-bol))
8570 (goto-line linepos)
8571 (set-window-start (selected-window) winstart 'noforce)
8572 (org-table-goto-column colpos)
8573 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
8574 (setq org-table-may-need-update nil)
8575 ))
8577 (defun org-string-width (s)
8578 "Compute width of string, ignoring invisible characters.
8579 This ignores character with invisibility property `org-link', and also
8580 characters with property `org-cwidth', because these will become invisible
8581 upon the next fontification round."
8582 (let (b l)
8583 (when (or (eq t buffer-invisibility-spec)
8584 (assq 'org-link buffer-invisibility-spec))
8585 (while (setq b (text-property-any 0 (length s)
8586 'invisible 'org-link s))
8587 (setq s (concat (substring s 0 b)
8588 (substring s (or (next-single-property-change
8589 b 'invisible s) (length s)))))))
8590 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
8591 (setq s (concat (substring s 0 b)
8592 (substring s (or (next-single-property-change
8593 b 'org-cwidth s) (length s))))))
8594 (setq l (string-width s) b -1)
8595 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
8596 (setq l (- l (get-text-property b 'org-dwidth-n s))))
8597 l))
8599 (defun org-table-begin (&optional table-type)
8600 "Find the beginning of the table and return its position.
8601 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
8602 (save-excursion
8603 (if (not (re-search-backward
8604 (if table-type org-table-any-border-regexp
8605 org-table-border-regexp)
8606 nil t))
8607 (progn (goto-char (point-min)) (point))
8608 (goto-char (match-beginning 0))
8609 (beginning-of-line 2)
8610 (point))))
8612 (defun org-table-end (&optional table-type)
8613 "Find the end of the table and return its position.
8614 With argument TABLE-TYPE, go to the end of a table.el-type table."
8615 (save-excursion
8616 (if (not (re-search-forward
8617 (if table-type org-table-any-border-regexp
8618 org-table-border-regexp)
8619 nil t))
8620 (goto-char (point-max))
8621 (goto-char (match-beginning 0)))
8622 (point-marker)))
8624 (defun org-table-justify-field-maybe (&optional new)
8625 "Justify the current field, text to left, number to right.
8626 Optional argument NEW may specify text to replace the current field content."
8627 (cond
8628 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
8629 ((org-at-table-hline-p))
8630 ((and (not new)
8631 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
8632 (current-buffer)))
8633 (< (point) org-table-aligned-begin-marker)
8634 (>= (point) org-table-aligned-end-marker)))
8635 ;; This is not the same table, force a full re-align
8636 (setq org-table-may-need-update t))
8637 (t ;; realign the current field, based on previous full realign
8638 (let* ((pos (point)) s
8639 (col (org-table-current-column))
8640 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
8641 l f n o e)
8642 (when (> col 0)
8645 (progn
8646 (setq s (match-string 1)
8647 o (match-string 0)
8648 l (max 1 (- (match-end 0) (match-beginning 0) 3))
8649 e (not (= (match-beginning 2) (match-end 2))))
8650 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
8651 l (if e "|" (setq org-table-may-need-update t) ""))
8652 n (format f s))
8653 (if new
8654 (if (<= (length new) l) ;; FIXME: length -> str-width?
8655 (setq n (format f new))
8656 (setq n (concat new "|") org-table-may-need-update t)))
8657 (or (equal n o)
8658 (let (org-table-may-need-update)
8659 (replace-match n t t))))
8660 (setq org-table-may-need-update t))
8661 (goto-char pos))))))
8663 (defun org-table-next-field ()
8664 "Go to the next field in the current table, creating new lines as needed.
8665 Before doing so, re-align the table if necessary."
8666 (interactive)
8667 (org-table-maybe-eval-formula)
8668 (org-table-maybe-recalculate-line)
8669 (if (and org-table-automatic-realign
8670 org-table-may-need-update)
8671 (org-table-align))
8672 (let ((end (org-table-end)))
8673 (if (org-at-table-hline-p)
8674 (end-of-line 1))
8675 (condition-case nil
8676 (progn
8677 (re-search-forward "|" end)
8679 (re-search-forward "|" end))
8680 (if (and (looking-at "-")
8681 org-table-tab-jumps-over-hlines
8683 (goto-char (match-beginning 1)))
8684 (if (looking-at "-")
8685 (progn
8686 (beginning-of-line 0)
8687 (org-table-insert-row 'below))
8688 (if (looking-at " ") (forward-char 1))))
8689 (error
8690 (org-table-insert-row 'below)))))
8692 (defun org-table-previous-field ()
8693 "Go to the previous field in the table.
8694 Before doing so, re-align the table if necessary."
8695 (interactive)
8696 (org-table-justify-field-maybe)
8697 (org-table-maybe-recalculate-line)
8698 (if (and org-table-automatic-realign
8699 org-table-may-need-update)
8700 (org-table-align))
8701 (if (org-at-table-hline-p)
8702 (end-of-line 1))
8703 (re-search-backward "|" (org-table-begin))
8704 (re-search-backward "|" (org-table-begin))
8706 (re-search-backward "|" (org-table-begin)))
8707 (if (looking-at "| ?")
8708 (goto-char (match-end 0))))
8710 (defun org-table-next-row ()
8711 "Go to the next row (same column) in the current table.
8712 Before doing so, re-align the table if necessary."
8713 (interactive)
8714 (org-table-maybe-eval-formula)
8715 (org-table-maybe-recalculate-line)
8718 (newline)
8719 (if (and org-table-automatic-realign
8720 org-table-may-need-update)
8721 (org-table-align))
8722 (let ((col (org-table-current-column)))
8723 (beginning-of-line 2)
8724 (if (or (not (org-at-table-p))
8725 (org-at-table-hline-p))
8726 (progn
8727 (beginning-of-line 0)
8728 (org-table-insert-row 'below)))
8729 (org-table-goto-column col)
8731 (if (looking-at " ") (forward-char 1)))))
8733 (defun org-table-copy-down (n)
8734 "Copy a field down in the current column.
8735 If the field at the cursor is empty, copy into it the content of the nearest
8736 non-empty field above. With argument N, use the Nth non-empty field.
8737 If the current field is not empty, it is copied down to the next row, and
8738 the cursor is moved with it. Therefore, repeating this command causes the
8739 column to be filled row-by-row.
8740 If the variable `org-table-copy-increment' is non-nil and the field is an
8741 integer or a timestamp, it will be incremented while copying. In the case of
8742 a timestamp, if the cursor is on the year, change the year. If it is on the
8743 month or the day, change that. Point will stay on the current date field
8744 in order to easily repeat the interval."
8745 (interactive "p")
8746 (let* ((colpos (org-table-current-column))
8747 (col (current-column))
8748 (field (org-table-get-field))
8750 (beg (org-table-begin))
8751 txt)
8752 (org-table-check-inside-data-field)
8753 (if non-empty
8754 (progn
8755 (setq txt (org-trim field))
8756 (org-table-next-row)
8757 (org-table-blank-field))
8758 (save-excursion
8759 (setq txt
8760 (catch 'exit
8761 (while (progn (beginning-of-line 1)
8762 (re-search-backward org-table-dataline-regexp
8763 beg t))
8764 (org-table-goto-column colpos t)
8765 (if (and (looking-at
8767 (= (setq n (1- n)) 0))
8768 (throw 'exit (match-string 1))))))))
8769 (if txt
8770 (progn
8771 (if (and org-table-copy-increment
8772 (string-match "^[0-9]+$" txt))
8773 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8774 (insert txt)
8775 (move-to-column col)
8776 (if (and org-table-copy-increment (org-at-timestamp-p t))
8777 (org-timestamp-up 1)
8778 (org-table-maybe-recalculate-line))
8779 (org-table-align)
8780 (move-to-column col))
8781 (error "No non-empty field found"))))
8783 (defun org-table-check-inside-data-field ()
8784 "Is point inside a table data field?
8785 I.e. not on a hline or before the first or after the last column?
8786 This actually throws an error, so it aborts the current command."
8787 (if (or (not (org-at-table-p))
8788 (= (org-table-current-column) 0)
8789 (org-at-table-hline-p)
8791 (error "Not in table data field")))
8793 (defvar org-table-clip nil
8794 "Clipboard for table regions.")
8796 (defun org-table-blank-field ()
8797 "Blank the current table field or active region."
8798 (interactive)
8799 (org-table-check-inside-data-field)
8800 (if (and (interactive-p) (org-region-active-p))
8801 (let (org-table-clip)
8802 (org-table-cut-region (region-beginning) (region-end)))
8803 (skip-chars-backward "^|")
8804 (backward-char 1)
8806 (let* ((pos (match-beginning 0))
8807 (match (match-string 0))
8808 (len (org-string-width match)))
8809 (replace-match (concat "|" (make-string (1- len) ?\ )))
8810 (goto-char (+ 2 pos))
8811 (substring match 1)))))
8813 (defun org-table-get-field (&optional n replace)
8814 "Return the value of the field in column N of current row.
8815 N defaults to current field.
8816 If REPLACE is a string, replace field with this value. The return value
8817 is always the old value."
8818 (and n (org-table-goto-column n))
8820 (backward-char 1)
8822 (let* ((pos (match-beginning 0))
8823 (val (buffer-substring (1+ pos) (match-end 0))))
8824 (if replace
8825 (replace-match (concat "|" replace) t t))
8826 (goto-char (min (point-at-eol) (+ 2 pos)))
8827 val)
8828 (forward-char 1) ""))
8830 (defun org-table-field-info (arg)
8831 "Show info about the current field, and highlight any reference at point."
8832 (interactive "P")
8833 (org-table-get-specials)
8834 (save-excursion
8835 (let* ((pos (point))
8836 (col (org-table-current-column))
8837 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8838 (name (car (rassoc (list (org-current-line) col)
8839 org-table-named-field-locations)))
8840 (eql (org-table-get-stored-formulas))
8841 (dline (org-table-current-dline))
8842 (ref (format "@%d$%d" dline col))
8843 (ref1 (org-table-convert-refs-to-an ref))
8844 (fequation (or (assoc name eql) (assoc ref eql)))
8845 (cequation (assoc (int-to-string col) eql))
8846 (eqn (or fequation cequation)))
8847 (goto-char pos)
8848 (condition-case nil
8849 (org-table-show-reference 'local)
8850 (error nil))
8851 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8852 dline col
8853 (if cname (concat " or $" cname) "")
8854 dline col ref1
8855 (if name (concat " or $" name) "")
8856 ;; FIXME: formula info not correct if special table line
8857 (if eqn
8858 (concat ", formula: "
8859 (org-table-formula-to-user
8860 (concat
8861 (if (string-match "^[$@]"(car eqn)) "" "$")
8862 (car eqn) "=" (cdr eqn))))
8863 "")))))
8865 (defun org-table-current-column ()
8866 "Find out which column we are in.
8867 When called interactively, column is also displayed in echo area."
8868 (interactive)
8869 (if (interactive-p) (org-table-check-inside-data-field))
8870 (save-excursion
8871 (let ((cnt 0) (pos (point)))
8872 (beginning-of-line 1)
8873 (while (search-forward "|" pos t)
8874 (setq cnt (1+ cnt)))
8875 (if (interactive-p) (message "This is table column %d" cnt))
8876 cnt)))
8878 (defun org-table-current-dline ()
8879 "Find out what table data line we are in.
8880 Only datalins count for this."
8881 (interactive)
8882 (if (interactive-p) (org-table-check-inside-data-field))
8883 (save-excursion
8884 (let ((cnt 0) (pos (point)))
8885 (goto-char (org-table-begin))
8886 (while (<= (point) pos)
8887 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8888 (beginning-of-line 2))
8889 (if (interactive-p) (message "This is table line %d" cnt))
8890 cnt)))
8892 (defun org-table-goto-column (n &optional on-delim force)
8893 "Move the cursor to the Nth column in the current table line.
8894 With optional argument ON-DELIM, stop with point before the left delimiter
8895 of the field.
8896 If there are less than N fields, just go to after the last delimiter.
8897 However, when FORCE is non-nil, create new columns if necessary."
8898 (interactive "p")
8899 (let ((pos (point-at-eol)))
8900 (beginning-of-line 1)
8901 (when (> n 0)
8902 (while (and (> (setq n (1- n)) -1)
8903 (or (search-forward "|" pos t)
8904 (and force
8905 (progn (end-of-line 1)
8906 (skip-chars-backward "^|")
8907 (insert " | "))))))
8908 ; (backward-char 2) t)))))
8909 (when (and force (not (looking-at ".*|")))
8910 (save-excursion (end-of-line 1) (insert " | ")))
8911 (if on-delim
8912 (backward-char 1)
8913 (if (looking-at " ") (forward-char 1))))))
8915 (defun org-at-table-p (&optional table-type)
8916 "Return t if the cursor is inside an org-type table.
8917 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8918 (if org-enable-table-editor
8919 (save-excursion
8920 (beginning-of-line 1)
8921 (looking-at (if table-type org-table-any-line-regexp
8922 org-table-line-regexp)))
8923 nil))
8925 (defun org-at-table.el-p ()
8926 "Return t if and only if we are at a table.el table."
8927 (and (org-at-table-p 'any)
8928 (save-excursion
8929 (goto-char (org-table-begin 'any))
8930 (looking-at org-table1-hline-regexp))))
8932 (defun org-table-recognize-table.el ()
8933 "If there is a table.el table nearby, recognize it and move into it."
8934 (if org-table-tab-recognizes-table.el
8935 (if (org-at-table.el-p)
8936 (progn
8937 (beginning-of-line 1)
8938 (if (looking-at org-table-dataline-regexp)
8939 nil
8940 (if (looking-at org-table1-hline-regexp)
8941 (progn
8942 (beginning-of-line 2)
8943 (if (looking-at org-table-any-border-regexp)
8944 (beginning-of-line -1)))))
8945 (if (re-search-forward "|" (org-table-end t) t)
8946 (progn
8947 (require 'table)
8948 (if (table--at-cell-p (point))
8949 t
8950 (message "recognizing table.el table...")
8951 (table-recognize-table)
8952 (message "recognizing table.el table...done")))
8953 (error "This should not happen..."))
8954 t)
8955 nil)
8956 nil))
8958 (defun org-at-table-hline-p ()
8959 "Return t if the cursor is inside a hline in a table."
8960 (if org-enable-table-editor
8961 (save-excursion
8962 (beginning-of-line 1)
8963 (looking-at org-table-hline-regexp))
8964 nil))
8966 (defun org-table-insert-column ()
8967 "Insert a new column into the table."
8968 (interactive)
8969 (if (not (org-at-table-p))
8970 (error "Not at a table"))
8971 (org-table-find-dataline)
8972 (let* ((col (max 1 (org-table-current-column)))
8973 (beg (org-table-begin))
8974 (end (org-table-end))
8975 ;; Current cursor position
8976 (linepos (org-current-line))
8977 (colpos col))
8978 (goto-char beg)
8979 (while (< (point) end)
8980 (if (org-at-table-hline-p)
8981 nil
8982 (org-table-goto-column col t)
8983 (insert "| "))
8984 (beginning-of-line 2))
8985 (move-marker end nil)
8986 (goto-line linepos)
8987 (org-table-goto-column colpos)
8988 (org-table-align)
8989 (org-table-fix-formulas "$" nil (1- col) 1)))
8991 (defun org-table-find-dataline ()
8992 "Find a dataline in the current table, which is needed for column commands."
8993 (if (and (org-at-table-p)
8994 (not (org-at-table-hline-p)))
8995 t
8996 (let ((col (current-column))
8997 (end (org-table-end)))
8998 (move-to-column col)
8999 (while (and (< (point) end)
9000 (or (not (= (current-column) col))
9001 (org-at-table-hline-p)))
9002 (beginning-of-line 2)
9003 (move-to-column col))
9004 (if (and (org-at-table-p)
9005 (not (org-at-table-hline-p)))
9006 t
9007 (error
9008 "Please position cursor in a data line for column operations")))))
9010 (defun org-table-delete-column ()
9011 "Delete a column from the table."
9012 (interactive)
9013 (if (not (org-at-table-p))
9014 (error "Not at a table"))
9015 (org-table-find-dataline)
9016 (org-table-check-inside-data-field)
9017 (let* ((col (org-table-current-column))
9018 (beg (org-table-begin))
9019 (end (org-table-end))
9020 ;; Current cursor position
9021 (linepos (org-current-line))
9022 (colpos col))
9023 (goto-char beg)
9024 (while (< (point) end)
9025 (if (org-at-table-hline-p)
9026 nil
9027 (org-table-goto-column col t)
9029 (replace-match "|")))
9030 (beginning-of-line 2))
9031 (move-marker end nil)
9032 (goto-line linepos)
9033 (org-table-goto-column colpos)
9034 (org-table-align)
9035 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
9036 col -1 col)))
9038 (defun org-table-move-column-right ()
9039 "Move column to the right."
9040 (interactive)
9041 (org-table-move-column nil))
9042 (defun org-table-move-column-left ()
9043 "Move column to the left."
9044 (interactive)
9045 (org-table-move-column 'left))
9047 (defun org-table-move-column (&optional left)
9048 "Move the current column to the right. With arg LEFT, move to the left."
9049 (interactive "P")
9050 (if (not (org-at-table-p))
9051 (error "Not at a table"))
9052 (org-table-find-dataline)
9053 (org-table-check-inside-data-field)
9054 (let* ((col (org-table-current-column))
9055 (col1 (if left (1- col) col))
9056 (beg (org-table-begin))
9057 (end (org-table-end))
9058 ;; Current cursor position
9059 (linepos (org-current-line))
9060 (colpos (if left (1- col) (1+ col))))
9061 (if (and left (= col 1))
9062 (error "Cannot move column further left"))
9064 (error "Cannot move column further right"))
9065 (goto-char beg)
9066 (while (< (point) end)
9067 (if (org-at-table-hline-p)
9068 nil
9069 (org-table-goto-column col1 t)
9072 (beginning-of-line 2))
9073 (move-marker end nil)
9074 (goto-line linepos)
9075 (org-table-goto-column colpos)
9076 (org-table-align)
9077 (org-table-fix-formulas
9078 "$" (list (cons (number-to-string col) (number-to-string colpos))
9079 (cons (number-to-string colpos) (number-to-string col))))))
9081 (defun org-table-move-row-down ()
9082 "Move table row down."
9083 (interactive)
9084 (org-table-move-row nil))
9085 (defun org-table-move-row-up ()
9086 "Move table row up."
9087 (interactive)
9088 (org-table-move-row 'up))
9090 (defun org-table-move-row (&optional up)
9091 "Move the current table line down. With arg UP, move it up."
9092 (interactive "P")
9093 (let* ((col (current-column))
9094 (pos (point))
9095 (hline1p (save-excursion (beginning-of-line 1)
9096 (looking-at org-table-hline-regexp)))
9097 (dline1 (org-table-current-dline))
9098 (dline2 (+ dline1 (if up -1 1)))
9099 (tonew (if up 0 2))
9100 txt hline2p)
9101 (beginning-of-line tonew)
9102 (unless (org-at-table-p)
9103 (goto-char pos)
9104 (error "Cannot move row further"))
9105 (setq hline2p (looking-at org-table-hline-regexp))
9106 (goto-char pos)
9107 (beginning-of-line 1)
9108 (setq pos (point))
9109 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
9110 (delete-region (point) (1+ (point-at-eol)))
9111 (beginning-of-line tonew)
9112 (insert txt)
9113 (beginning-of-line 0)
9114 (move-to-column col)
9115 (unless (or hline1p hline2p)
9116 (org-table-fix-formulas
9117 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
9118 (cons (number-to-string dline2) (number-to-string dline1)))))))
9120 (defun org-table-insert-row (&optional arg)
9121 "Insert a new row above the current line into the table.
9122 With prefix ARG, insert below the current line."
9123 (interactive "P")
9124 (if (not (org-at-table-p))
9125 (error "Not at a table"))
9126 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
9127 (new (org-table-clean-line line)))
9128 ;; Fix the first field if necessary
9130 (setq new (replace-match (match-string 0 line) t t new)))
9131 (beginning-of-line (if arg 2 1))
9133 (beginning-of-line 0)
9134 (re-search-forward "| ?" (point-at-eol) t)
9135 (and (or org-table-may-need-update org-table-overlay-coordinates)
9136 (org-table-align))
9137 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
9139 (defun org-table-insert-hline (&optional above)
9140 "Insert a horizontal-line below the current line into the table.
9141 With prefix ABOVE, insert above the current line."
9142 (interactive "P")
9143 (if (not (org-at-table-p))
9144 (error "Not at a table"))
9145 (let ((line (org-table-clean-line
9146 (buffer-substring (point-at-bol) (point-at-eol))))
9147 (col (current-column)))
9149 (setq line (replace-match
9150 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
9151 ?-) "|") t t line)))
9153 (beginning-of-line (if above 1 2))
9155 (beginning-of-line (if above 1 -1))
9156 (move-to-column col)
9157 (and org-table-overlay-coordinates (org-table-align))))
9159 (defun org-table-hline-and-move (&optional same-column)
9160 "Insert a hline and move to the row below that line."
9161 (interactive "P")
9162 (let ((col (org-table-current-column)))
9163 (org-table-maybe-eval-formula)
9164 (org-table-maybe-recalculate-line)
9165 (org-table-insert-hline)
9166 (end-of-line 2)
9169 (org-table-next-field))
9170 (if same-column (org-table-goto-column col))))
9172 (defun org-table-clean-line (s)
9174 In particular, this does handle wide and invisible characters."
9176 ;; It's a hline, just map the characters
9177 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
9179 (setq s (replace-match
9180 (concat "|" (make-string (org-string-width (match-string 1 s))
9181 ?\ ) "|")
9182 t t s)))
9183 s))
9185 (defun org-table-kill-row ()
9186 "Delete the current row or horizontal line from the table."
9187 (interactive)
9188 (if (not (org-at-table-p))
9189 (error "Not at a table"))
9190 (let ((col (current-column))
9191 (dline (org-table-current-dline)))
9192 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
9193 (if (not (org-at-table-p)) (beginning-of-line 0))
9194 (move-to-column col)
9195 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
9196 dline -1 dline)))
9198 (defun org-table-sort-lines (with-case &optional sorting-type)
9199 "Sort table lines according to the column at point.
9201 The position of point indicates the column to be used for
9202 sorting, and the range of lines is the range between the nearest
9203 horizontal separator lines, or the entire table of no such lines
9204 exist. If point is before the first column, you will be prompted
9205 for the sorting column. If there is an active region, the mark
9206 specifies the first line and the sorting column, while point
9207 should be in the last line to be included into the sorting.
9209 The command then prompts for the sorting type which can be
9210 alphabetically, numerically, or by time (as given in a time stamp
9211 in the field). Sorting in reverse order is also possible.
9213 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
9215 If SORTING-TYPE is specified when this function is called from a Lisp
9216 program, no prompting will take place. SORTING-TYPE must be a character,
9217 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
9218 should be done in reverse order."
9219 (interactive "P")
9220 (let* ((thisline (org-current-line))
9221 (thiscol (org-table-current-column))
9222 beg end bcol ecol tend tbeg column lns pos)
9223 (when (equal thiscol 0)
9224 (if (interactive-p)
9225 (setq thiscol
9226 (string-to-number
9227 (read-string "Use column N for sorting: ")))
9228 (setq thiscol 1))
9229 (org-table-goto-column thiscol))
9230 (org-table-check-inside-data-field)
9231 (if (org-region-active-p)
9232 (progn
9233 (setq beg (region-beginning) end (region-end))
9234 (goto-char beg)
9235 (setq column (org-table-current-column)
9236 beg (point-at-bol))
9237 (goto-char end)
9238 (setq end (point-at-bol 2)))
9239 (setq column (org-table-current-column)
9240 pos (point)
9241 tbeg (org-table-begin)
9242 tend (org-table-end))
9243 (if (re-search-backward org-table-hline-regexp tbeg t)
9244 (setq beg (point-at-bol 2))
9245 (goto-char tbeg)
9246 (setq beg (point-at-bol 1)))
9247 (goto-char pos)
9248 (if (re-search-forward org-table-hline-regexp tend t)
9249 (setq end (point-at-bol 1))
9250 (goto-char tend)
9251 (setq end (point-at-bol))))
9252 (setq beg (move-marker (make-marker) beg)
9253 end (move-marker (make-marker) end))
9254 (untabify beg end)
9255 (goto-char beg)
9256 (org-table-goto-column column)
9257 (skip-chars-backward "^|")
9258 (setq bcol (current-column))
9259 (org-table-goto-column (1+ column))
9260 (skip-chars-backward "^|")
9261 (setq ecol (1- (current-column)))
9262 (org-table-goto-column column)
9263 (setq lns (mapcar (lambda(x) (cons
9264 (org-sort-remove-invisible
9265 (nth (1- column)
9267 x))
9269 (setq lns (org-do-sort lns "Table" with-case sorting-type))
9270 (delete-region beg end)
9271 (move-marker beg nil)
9272 (move-marker end nil)
9274 (goto-line thisline)
9275 (org-table-goto-column thiscol)
9276 (message "%d lines sorted, based on column %d" (length lns) column)))
9278 ;; FIXME: maybe we will not need this? Table sorting is broken....
9279 (defun org-sort-remove-invisible (s)
9280 (remove-text-properties 0 (length s) org-rm-props s)
9281 (while (string-match org-bracket-link-regexp s)
9282 (setq s (replace-match (if (match-end 2)
9283 (match-string 3 s)
9284 (match-string 1 s)) t t s)))
9285 s)
9287 (defun org-table-cut-region (beg end)
9288 "Copy region in table to the clipboard and blank all relevant fields."
9289 (interactive "r")
9290 (org-table-copy-region beg end 'cut))
9292 (defun org-table-copy-region (beg end &optional cut)
9293 "Copy rectangular region in table to clipboard.
9294 A special clipboard is used which can only be accessed
9295 with `org-table-paste-rectangle'."
9296 (interactive "rP")
9297 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
9298 region cols
9299 (rpl (if cut " " nil)))
9300 (goto-char beg)
9301 (org-table-check-inside-data-field)
9302 (setq l01 (org-current-line)
9303 c01 (org-table-current-column))
9304 (goto-char end)
9305 (org-table-check-inside-data-field)
9306 (setq l02 (org-current-line)
9307 c02 (org-table-current-column))
9308 (setq l1 (min l01 l02) l2 (max l01 l02)
9309 c1 (min c01 c02) c2 (max c01 c02))
9310 (catch 'exit
9311 (while t
9312 (catch 'nextline
9313 (if (> l1 l2) (throw 'exit t))
9314 (goto-line l1)
9315 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
9316 (setq cols nil ic1 c1 ic2 c2)
9317 (while (< ic1 (1+ ic2))
9318 (push (org-table-get-field ic1 rpl) cols)
9319 (setq ic1 (1+ ic1)))
9320 (push (nreverse cols) region)
9321 (setq l1 (1+ l1)))))
9322 (setq org-table-clip (nreverse region))
9323 (if cut (org-table-align))
9324 org-table-clip))
9326 (defun org-table-paste-rectangle ()
9327 "Paste a rectangular region into a table.
9328 The upper right corner ends up in the current field. All involved fields
9329 will be overwritten. If the rectangle does not fit into the present table,
9330 the table is enlarged as needed. The process ignores horizontal separator
9331 lines."
9332 (interactive)
9333 (unless (and org-table-clip (listp org-table-clip))
9334 (error "First cut/copy a region to paste!"))
9335 (org-table-check-inside-data-field)
9336 (let* ((clip org-table-clip)
9337 (line (org-current-line))
9338 (col (org-table-current-column))
9339 (org-enable-table-editor t)
9340 (org-table-automatic-realign nil)
9341 c cols field)
9342 (while (setq cols (pop clip))
9343 (while (org-at-table-hline-p) (beginning-of-line 2))
9344 (if (not (org-at-table-p))
9345 (progn (end-of-line 0) (org-table-next-field)))
9346 (setq c col)
9347 (while (setq field (pop cols))
9348 (org-table-goto-column c nil 'force)
9349 (org-table-get-field nil field)
9350 (setq c (1+ c)))
9351 (beginning-of-line 2))
9352 (goto-line line)
9353 (org-table-goto-column col)
9354 (org-table-align)))
9356 (defun org-table-convert ()
9357 "Convert from `org-mode' table to table.el and back.
9358 Obviously, this only works within limits. When an Org-mode table is
9359 converted to table.el, all horizontal separator lines get lost, because
9360 table.el uses these as cell boundaries and has no notion of horizontal lines.
9361 A table.el table can be converted to an Org-mode table only if it does not
9362 do row or column spanning. Multiline cells will become multiple cells.
9363 Beware, Org-mode does not test if the table can be successfully converted - it
9364 blindly applies a recipe that works for simple tables."
9365 (interactive)
9366 (require 'table)
9367 (if (org-at-table.el-p)
9368 ;; convert to Org-mode table
9369 (let ((beg (move-marker (make-marker) (org-table-begin t)))
9370 (end (move-marker (make-marker) (org-table-end t))))
9371 (table-unrecognize-region beg end)
9372 (goto-char beg)
9374 (replace-match ""))
9375 (goto-char beg))
9376 (if (org-at-table-p)
9377 ;; convert to table.el table
9378 (let ((beg (move-marker (make-marker) (org-table-begin)))
9379 (end (move-marker (make-marker) (org-table-end))))
9380 ;; first, get rid of all horizontal lines
9381 (goto-char beg)
9383 (replace-match ""))
9384 ;; insert a hline before first
9385 (goto-char beg)
9386 (org-table-insert-hline 'above)
9387 (beginning-of-line -1)
9388 ;; insert a hline after each line
9389 (while (progn (beginning-of-line 3) (< (point) end))
9390 (org-table-insert-hline))
9391 (goto-char beg)
9392 (setq end (move-marker end (org-table-end)))
9393 ;; replace "+" at beginning and ending of hlines
9396 (goto-char beg)
9398 (replace-match "-+"))
9399 (goto-char beg)))))
9401 (defun org-table-wrap-region (arg)
9402 "Wrap several fields in a column like a paragraph.
9403 This is useful if you'd like to spread the contents of a field over several
9404 lines, in order to keep the table compact.
9406 If there is an active region, and both point and mark are in the same column,
9407 the text in the column is wrapped to minimum width for the given number of
9408 lines. Generally, this makes the table more compact. A prefix ARG may be
9410 formats the selected text to two lines. If the region was longer than two
9411 lines, the remaining lines remain empty. A negative prefix argument reduces
9412 the current number of lines by that amount. The wrapped text is pasted back
9413 into the table. If you formatted it to more lines than it was before, fields
9414 further down in the table get overwritten - so you might need to make space in
9415 the table first.
9417 If there is no region, the current field is split at the cursor position and
9418 the text fragment to the right of the cursor is prepended to the field one
9419 line down.
9421 If there is no region, but you specify a prefix ARG, the current field gets
9422 blank, and the content is appended to the field above."
9423 (interactive "P")
9424 (org-table-check-inside-data-field)
9425 (if (org-region-active-p)
9426 ;; There is a region: fill as a paragraph
9427 (let* ((beg (region-beginning))
9428 (cline (save-excursion (goto-char beg) (org-current-line)))
9429 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
9430 nlines)
9431 (org-table-cut-region (region-beginning) (region-end))
9432 (if (> (length (car org-table-clip)) 1)
9433 (error "Region must be limited to single column"))
9434 (setq nlines (if arg
9435 (if (< arg 1)
9436 (+ (length org-table-clip) arg)
9437 arg)
9438 (length org-table-clip)))
9439 (setq org-table-clip
9440 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
9441 nil nlines)))
9442 (goto-line cline)
9443 (org-table-goto-column ccol)
9444 (org-table-paste-rectangle))
9445 ;; No region, split the current field at point
9446 (if arg
9447 ;; combine with field above
9448 (let ((s (org-table-blank-field))
9449 (col (org-table-current-column)))
9450 (beginning-of-line 0)
9451 (while (org-at-table-hline-p) (beginning-of-line 0))
9452 (org-table-goto-column col)
9453 (skip-chars-forward "^|")
9454 (skip-chars-backward " ")
9455 (insert " " (org-trim s))
9456 (org-table-align))
9457 ;; split field
9459 (let ((s (match-string 1)))
9460 (replace-match " |")
9461 (goto-char (match-beginning 0))
9462 (org-table-next-row)
9463 (insert (org-trim s) " ")
9464 (org-table-align))))))
9466 (defvar org-field-marker nil)
9468 (defun org-table-edit-field (arg)
9469 "Edit table field in a different window.
9470 This is mainly useful for fields that contain hidden parts.
9472 it can be edited in place."
9473 (interactive "P")
9474 (if arg
9475 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
9477 (remove-text-properties b e '(org-cwidth t invisible t
9478 display t intangible t))
9479 (if (and (boundp 'font-lock-mode) font-lock-mode)
9480 (font-lock-fontify-block)))
9481 (let ((pos (move-marker (make-marker) (point)))
9482 (field (org-table-get-field))
9483 (cw (current-window-configuration))
9484 p)
9485 (org-switch-to-buffer-other-window "*Org tmp*")
9486 (erase-buffer)
9488 (let ((org-inhibit-startup t)) (org-mode))
9489 (goto-char (setq p (point-max)))
9490 (insert (org-trim field))
9491 (remove-text-properties p (point-max)
9492 '(invisible t org-cwidth t display t
9493 intangible t))
9494 (goto-char p)
9495 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
9496 (org-set-local 'org-window-configuration cw)
9497 (org-set-local 'org-field-marker pos)
9498 (message "Edit and finish with C-c C-c"))))
9500 (defun org-table-finish-edit-field ()
9501 "Finish editing a table data field.
9502 Remove all newline characters, insert the result into the table, realign
9503 the table and kill the editing buffer."
9504 (let ((pos org-field-marker)
9505 (cw org-window-configuration)
9506 (cb (current-buffer))
9507 text)
9508 (goto-char (point-min))
9511 (replace-match " "))
9512 (setq text (org-trim (buffer-string)))
9513 (set-window-configuration cw)
9514 (kill-buffer cb)
9515 (select-window (get-buffer-window (marker-buffer pos)))
9516 (goto-char pos)
9517 (move-marker pos nil)
9518 (org-table-check-inside-data-field)
9519 (org-table-get-field nil text)
9520 (org-table-align)
9521 (message "New field value inserted")))
9523 (defun org-trim (s)
9524 "Remove whitespace at beginning and end of string."
9527 s)
9529 (defun org-wrap (string &optional width lines)
9530 "Wrap string to either a number of lines, or a width in characters.
9531 If WIDTH is non-nil, the string is wrapped to that width, however many lines
9532 that costs. If there is a word longer than WIDTH, the text is actually
9533 wrapped to the length of that word.
9534 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
9535 many lines, whatever width that takes.
9536 The return value is a list of lines, without newlines at the end."
9538 (maxword (apply 'max (mapcar 'org-string-width words)))
9539 w ll)
9540 (cond (width
9541 (org-do-wrap words (max maxword width)))
9542 (lines
9543 (setq w maxword)
9544 (setq ll (org-do-wrap words maxword))
9545 (if (<= (length ll) lines)
9546 ll
9547 (setq ll words)
9548 (while (> (length ll) lines)
9549 (setq w (1+ w))
9550 (setq ll (org-do-wrap words w)))
9551 ll))
9552 (t (error "Cannot wrap this")))))
9555 (defun org-do-wrap (words width)
9556 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
9557 (let (lines line)
9558 (while words
9559 (setq line (pop words))
9560 (while (and words (< (+ (length line) (length (car words))) width))
9561 (setq line (concat line " " (pop words))))
9562 (setq lines (push line lines)))
9563 (nreverse lines)))
9565 (defun org-split-string (string &optional separators)
9566 "Splits STRING into substrings at SEPARATORS.
9567 No empty strings are returned if there are matches at the beginning
9568 and end of string."
9570 (start 0)
9571 notfirst
9572 (list nil))
9573 (while (and (string-match rexp string
9574 (if (and notfirst
9575 (= start (match-beginning 0))
9576 (< start (length string)))
9577 (1+ start) start))
9578 (< (match-beginning 0) (length string)))
9579 (setq notfirst t)
9580 (or (eq (match-beginning 0) 0)
9581 (and (eq (match-beginning 0) (match-end 0))
9582 (eq (match-beginning 0) start))
9583 (setq list
9584 (cons (substring string start (match-beginning 0))
9585 list)))
9586 (setq start (match-end 0)))
9587 (or (eq start (length string))
9588 (setq list
9589 (cons (substring string start)
9590 list)))
9591 (nreverse list)))
9593 (defun org-table-map-tables (function)
9594 "Apply FUNCTION to the start of all tables in the buffer."
9595 (save-excursion
9596 (save-restriction
9597 (widen)
9598 (goto-char (point-min))
9599 (while (re-search-forward org-table-any-line-regexp nil t)
9600 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
9601 (beginning-of-line 1)
9602 (if (looking-at org-table-line-regexp)
9603 (save-excursion (funcall function)))
9604 (re-search-forward org-table-any-border-regexp nil 1))))
9605 (message "Mapping tables: done"))
9607 (defvar org-timecnt) ; dynamically scoped parameter
9609 (defun org-table-sum (&optional beg end nlast)
9610 "Sum numbers in region of current table column.
9611 The result will be displayed in the echo area, and will be available
9614 If there is an active region, it is interpreted as a rectangle and all
9615 numbers in that rectangle will be summed. If there is no active
9616 region and point is located in a table column, sum all numbers in that
9617 column.
9619 If at least one number looks like a time HH:MM or HH:MM:SS, all other
9620 numbers are assumed to be times as well (in decimal hours) and the
9621 numbers are added as such.
9623 If NLAST is a number, only the NLAST fields will actually be summed."
9624 (interactive)
9625 (save-excursion
9626 (let (col (org-timecnt 0) diff h m s org-table-clip)
9627 (cond
9628 ((and beg end)) ; beg and end given explicitly
9629 ((org-region-active-p)
9630 (setq beg (region-beginning) end (region-end)))
9631 (t
9632 (setq col (org-table-current-column))
9633 (goto-char (org-table-begin))
9635 (error "No table data"))
9636 (org-table-goto-column col)
9637 (setq beg (point))
9638 (goto-char (org-table-end))
9640 (error "No table data"))
9641 (org-table-goto-column col)
9642 (setq end (point))))
9643 (let* ((items (apply 'append (org-table-copy-region beg end)))
9644 (items1 (cond ((not nlast) items)
9645 ((>= nlast (length items)) items)
9646 (t (setq items (reverse items))
9647 (setcdr (nthcdr (1- nlast) items) nil)
9648 (nreverse items))))
9649 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
9650 items1)))
9651 (res (apply '+ numbers))
9652 (sres (if (= org-timecnt 0)
9653 (format "%g" res)
9654 (setq diff (* 3600 res)
9655 h (floor (/ diff 3600)) diff (mod diff 3600)
9656 m (floor (/ diff 60)) diff (mod diff 60)
9657 s diff)
9658 (format "%d:%02d:%02d" h m s))))
9659 (kill-new sres)
9660 (if (interactive-p)
9661 (message "%s"
9662 (substitute-command-keys
9664 (length numbers) sres))))
9665 sres))))
9667 (defun org-table-get-number-for-summing (s)
9668 (let (n)
9669 (if (string-match "^ *|? *" s)
9670 (setq s (replace-match "" nil nil s)))
9671 (if (string-match " *|? *$" s)
9672 (setq s (replace-match "" nil nil s)))
9673 (setq n (string-to-number s))
9674 (cond
9675 ((and (string-match "0" s)
9679 (let ((h (string-to-number (or (match-string 1 s) "0")))
9680 (m (string-to-number (or (match-string 2 s) "0")))
9681 (s (string-to-number (or (match-string 4 s) "0"))))
9682 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
9683 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
9684 ((equal n 0) nil)
9685 (t n))))
9687 (defun org-table-current-field-formula (&optional key noerror)
9688 "Return the formula active for the current field.
9689 Assumes that specials are in place.
9690 If KEY is given, return the key to this formula.
9692 (let* ((name (car (rassoc (list (org-current-line)
9693 (org-table-current-column))
9694 org-table-named-field-locations)))
9695 (col (org-table-current-column))
9696 (scol (int-to-string col))
9697 (ref (format "@%d$%d" (org-table-current-dline) col))
9698 (stored-list (org-table-get-stored-formulas noerror))
9699 (ass (or (assoc name stored-list)
9700 (assoc ref stored-list)
9701 (assoc scol stored-list))))
9702 (if key
9703 (car ass)
9704 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9705 (cdr ass))))))
9707 (defun org-table-get-formula (&optional equation named)
9708 "Read a formula from the minibuffer, offer stored formula as default.
9709 When NAMED is non-nil, look for a named equation."
9710 (let* ((stored-list (org-table-get-stored-formulas))
9711 (name (car (rassoc (list (org-current-line)
9712 (org-table-current-column))
9713 org-table-named-field-locations)))
9714 (ref (format "@%d$%d" (org-table-current-dline)
9715 (org-table-current-column)))
9716 (refass (assoc ref stored-list))
9717 (scol (if named
9718 (if name name ref)
9719 (int-to-string (org-table-current-column))))
9720 (dummy (and (or name refass) (not named)
9721 (not (y-or-n-p "Replace field formula with column formula? " ))
9722 (error "Abort")))
9723 (name (or name ref))
9724 (org-table-may-need-update nil)
9725 (stored (cdr (assoc scol stored-list)))
9726 (eq (cond
9727 ((and stored equation (string-match "^ *=? *$" equation))
9728 stored)
9729 ((stringp equation)
9730 equation)
9731 (t (org-table-formula-from-user
9732 (read-string
9733 (org-table-formula-to-user
9734 (format "%s formula %s%s="
9735 (if named "Field" "Column")
9736 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9737 scol))
9738 (if stored (org-table-formula-to-user stored) "")
9739 'org-table-formula-history
9740 )))))
9741 mustsave)
9743 ;; remove formula
9744 (setq stored-list (delq (assoc scol stored-list) stored-list))
9745 (org-table-store-formulas stored-list)
9746 (error "Formula removed"))
9747 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9748 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9749 (if (and name (not named))
9750 ;; We set the column equation, delete the named one.
9751 (setq stored-list (delq (assoc name stored-list) stored-list)
9752 mustsave t))
9753 (if stored
9754 (setcdr (assoc scol stored-list) eq)
9755 (setq stored-list (cons (cons scol eq) stored-list)))
9756 (if (or mustsave (not (equal stored eq)))
9757 (org-table-store-formulas stored-list))
9758 eq))
9760 (defun org-table-store-formulas (alist)
9761 "Store the list of formulas below the current table."
9762 (setq alist (sort alist 'org-table-formula-less-p))
9763 (save-excursion
9764 (goto-char (org-table-end))
9766 (progn
9767 ;; don't overwrite TBLFM, we might use text properties to store stuff
9768 (goto-char (match-beginning 2))
9769 (delete-region (match-beginning 2) (match-end 0)))
9770 (insert "#+TBLFM:"))
9771 (insert " "
9772 (mapconcat (lambda (x)
9773 (concat
9774 (if (equal (string-to-char (car x)) ?@) "" "$")
9775 (car x) "=" (cdr x)))
9776 alist "::")
9779 (defsubst org-table-formula-make-cmp-string (a)
9781 (concat
9782 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9783 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9784 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9786 (defun org-table-formula-less-p (a b)
9787 "Compare two formulas for sorting."
9788 (let ((as (org-table-formula-make-cmp-string (car a)))
9789 (bs (org-table-formula-make-cmp-string (car b))))
9790 (and as bs (string< as bs))))
9792 (defun org-table-get-stored-formulas (&optional noerror)
9793 "Return an alist with the stored formulas directly after current table."
9794 (interactive)
9795 (let (scol eq eq-alist strings string seen)
9796 (save-excursion
9797 (goto-char (org-table-end))
9799 (setq strings (org-split-string (match-string 2) " *:: *"))
9800 (while (setq string (pop strings))
9801 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9802 (setq scol (if (match-end 2)
9803 (match-string 2 string)
9804 (match-string 1 string))
9805 eq (match-string 3 string)
9806 eq-alist (cons (cons scol eq) eq-alist))
9807 (if (member scol seen)
9808 (if noerror
9809 (progn
9810 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9811 (ding)
9812 (sit-for 2))
9813 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9814 (push scol seen))))))
9815 (nreverse eq-alist)))
9817 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9818 "Modify the equations after the table structure has been edited.
9820 For all numbers larger than LIMIT, shift them by DELTA."
9821 (save-excursion
9822 (goto-char (org-table-end))
9825 (re2
9826 (when remove
9827 (if (equal key "$")
9830 s n a)
9831 (when remove
9832 (while (re-search-forward re2 (point-at-eol) t)
9833 (replace-match "")))
9834 (while (re-search-forward re (point-at-eol) t)
9835 (setq s (match-string 1) n (string-to-number s))
9836 (cond
9837 ((setq a (assoc s replace))
9838 (replace-match (concat key (cdr a)) t t))
9839 ((and limit (> n limit))
9840 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9842 (defun org-table-get-specials ()
9843 "Get the column names and local parameters for this table."
9844 (save-excursion
9845 (let ((beg (org-table-begin)) (end (org-table-end))
9846 names name fields fields1 field cnt
9847 c v l line col types dlines hlines)
9848 (setq org-table-column-names nil
9849 org-table-local-parameters nil
9850 org-table-named-field-locations nil
9851 org-table-current-begin-line nil
9852 org-table-current-begin-pos nil
9853 org-table-current-line-types nil)
9854 (goto-char beg)
9856 (setq names (org-split-string (match-string 1) " *| *")
9857 cnt 1)
9858 (while (setq name (pop names))
9859 (setq cnt (1+ cnt))
9860 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9861 (push (cons name (int-to-string cnt)) org-table-column-names))))
9862 (setq org-table-column-names (nreverse org-table-column-names))
9863 (setq org-table-column-name-regexp
9865 (goto-char beg)
9867 (setq fields (org-split-string (match-string 1) " *| *"))
9868 (while (setq field (pop fields))
9870 (push (cons (match-string 1 field) (match-string 2 field))
9871 org-table-local-parameters))))
9872 (goto-char beg)
9874 (setq c (match-string 1)
9875 fields (org-split-string (match-string 2) " *| *"))
9876 (save-excursion
9877 (beginning-of-line (if (equal c "_") 2 0))
9878 (setq line (org-current-line) col 1)
9880 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9881 (while (and fields1 (setq field (pop fields)))
9882 (setq v (pop fields1) col (1+ col))
9883 (when (and (stringp field) (stringp v)
9884 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9885 (push (cons field v) org-table-local-parameters)
9886 (push (list field line col) org-table-named-field-locations))))
9887 ;; Analyse the line types
9888 (goto-char beg)
9889 (setq org-table-current-begin-line (org-current-line)
9890 org-table-current-begin-pos (point)
9891 l org-table-current-begin-line)
9893 (push (if (match-end 1) 'hline 'dline) types)
9894 (if (match-end 1) (push l hlines) (push l dlines))
9895 (beginning-of-line 2)
9896 (setq l (1+ l)))
9897 (setq org-table-current-line-types (apply 'vector (nreverse types))
9898 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9899 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9901 (defun org-table-maybe-eval-formula ()
9903 If yes, store the formula and apply it."
9904 ;; We already know we are in a table. Get field will only return a formula
9905 ;; when appropriate. It might return a separator line, but no problem.
9906 (when org-table-formula-evaluate-inline
9907 (let* ((field (org-trim (or (org-table-get-field) "")))
9908 named eq)
9910 (setq named (equal (string-to-char field) ?:)
9911 eq (match-string 1 field))
9912 (if (or (fboundp 'calc-eval)
9913 (equal (substring eq 0 (min 2 (length eq))) "'("))
9914 (org-table-eval-formula (if named '(4) nil)
9915 (org-table-formula-from-user eq))
9916 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9918 (defvar org-recalc-commands nil
9919 "List of commands triggering the recalculation of a line.
9920 Will be filled automatically during use.")
9922 (defvar org-recalc-marks
9923 '((" " . "Unmarked: no special line, no automatic recalculation")
9924 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9925 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9926 ("!" . "Column name definition line. Reference in formula as $name.")
9927 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9928 ("_" . "Names for values in row below this one.")
9929 ("^" . "Names for values in row above this one.")))
9931 (defun org-table-rotate-recalc-marks (&optional newchar)
9932 "Rotate the recalculation mark in the first column.
9933 If in any row, the first field is not consistent with a mark,
9934 insert a new column for the markers.
9935 When there is an active region, change all the lines in the region,
9936 after prompting for the marking character.
9937 After each change, a message will be displayed indicating the meaning
9938 of the new mark."
9939 (interactive)
9940 (unless (org-at-table-p) (error "Not at a table"))
9941 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9942 (beg (org-table-begin))
9943 (end (org-table-end))
9944 (l (org-current-line))
9945 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9946 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9947 (have-col
9948 (save-excursion
9949 (goto-char beg)
9951 (col (org-table-current-column))
9952 (forcenew (car (assoc newchar org-recalc-marks)))
9953 epos new)
9954 (when l1
9955 (message "Change region to what mark? Type # * ! $ or SPC: ")
9956 (setq newchar (char-to-string (read-char-exclusive))
9957 forcenew (car (assoc newchar org-recalc-marks))))
9958 (if (and newchar (not forcenew))
9959 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9960 newchar))
9961 (if l1 (goto-line l1))
9962 (save-excursion
9963 (beginning-of-line 1)
9964 (unless (looking-at org-table-dataline-regexp)
9965 (error "Not at a table data line")))
9966 (unless have-col
9967 (org-table-goto-column 1)
9968 (org-table-insert-column)
9969 (org-table-goto-column (1+ col)))
9970 (setq epos (point-at-eol))
9971 (save-excursion
9972 (beginning-of-line 1)
9973 (org-table-get-field
9975 (concat " "
9976 (setq new (or forcenew
9977 (cadr (member (match-string 1) marks))))
9978 " ")
9979 " # ")))
9980 (if (and l1 l2)
9981 (progn
9982 (goto-line l1)
9983 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9984 (and (looking-at org-table-dataline-regexp)
9985 (org-table-get-field 1 (concat " " new " "))))
9986 (goto-line l1)))
9987 (if (not (= epos (point-at-eol))) (org-table-align))
9988 (goto-line l)
9989 (and (interactive-p) (message "%s" (cdr (assoc new org-recalc-marks))))))
9991 (defun org-table-maybe-recalculate-line ()
9992 "Recompute the current line if marked for it, and if we haven't just done it."
9993 (interactive)
9994 (and org-table-allow-automatic-line-recalculation
9995 (not (and (memq last-command org-recalc-commands)
9996 (equal org-last-recalc-line (org-current-line))))
9997 (save-excursion (beginning-of-line 1)
9998 (looking-at org-table-auto-recalculate-regexp))
9999 (org-table-recalculate) t))
10001 (defvar org-table-formula-debug nil
10002 "Non-nil means, debug table formulas.
10004 (make-variable-buffer-local 'org-table-formula-debug)
10006 (defvar modes)
10007 (defsubst org-set-calc-mode (var &optional value)
10008 (if (stringp var)
10009 (setq var (assoc var '(("D" calc-angle-mode deg)
10010 ("R" calc-angle-mode rad)
10011 ("F" calc-prefer-frac t)
10012 ("S" calc-symbolic-mode t)))
10013 value (nth 2 var) var (nth 1 var)))
10014 (if (memq var modes)
10015 (setcar (cdr (memq var modes)) value)
10016 (cons var (cons value modes)))
10017 modes)
10019 (defun org-table-eval-formula (&optional arg equation
10020 suppress-align suppress-const
10021 suppress-store suppress-analysis)
10022 "Replace the table field value at the cursor by the result of a calculation.
10024 This function makes use of Dave Gillespie's Calc package, in my view the
10025 most exciting program ever written for GNU Emacs. So you need to have Calc
10026 installed in order to use this function.
10028 In a table, this command replaces the value in the current field with the
10030 formula, by storing it in a special line below the table. When called
10031 with a `C-u' prefix, the current field must ba a named field, and the
10032 formula is installed as valid in only this specific field.
10034 When called with two `C-u' prefixes, insert the active equation
10035 for the field back into the current field, so that it can be
10037 to check the referenced fields.
10039 When called, the command first prompts for a formula, which is read in
10040 the minibuffer. Previously entered formulas are available through the
10041 history list, and the last used formula is offered as a default.
10042 These stored formulas are adapted correctly when moving, inserting, or
10043 deleting columns with the corresponding commands.
10045 The formula can be any algebraic expression understood by the Calc package.
10046 For details, see the Org-mode manual.
10048 This function can also be called from Lisp programs and offers
10049 additional arguments: EQUATION can be the formula to apply. If this
10050 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
10051 used to speed-up recursive calls by by-passing unnecessary aligns.
10052 SUPPRESS-CONST suppresses the interpretation of constants in the
10053 formula, assuming that this has been done already outside the function.
10054 SUPPRESS-STORE means the formula should not be stored, either because
10055 it is already stored, or because it is a modified equation that should
10056 not overwrite the stored one."
10057 (interactive "P")
10058 (org-table-check-inside-data-field)
10059 (or suppress-analysis (org-table-get-specials))
10060 (if (equal arg '(16))
10061 (let ((eq (org-table-current-field-formula)))
10062 (or eq (error "No equation active for current field"))
10063 (org-table-get-field nil eq)
10064 (org-table-align)
10065 (setq org-table-may-need-update t))
10066 (let* (fields
10067 (ndown (if (integerp arg) arg 1))
10068 (org-table-automatic-realign nil)
10069 (case-fold-search nil)
10070 (down (> ndown 1))
10071 (formula (if (and equation suppress-store)
10072 equation
10073 (org-table-get-formula equation (equal arg '(4)))))
10074 (n0 (org-table-current-column))
10075 (modes (copy-sequence org-calc-default-modes))
10076 (numbers nil) ; was a variable, now fixed default
10077 (keep-empty nil)
10078 n form form0 bw fmt x ev orig c lispp literal)
10079 ;; Parse the format string. Since we have a lot of modes, this is
10080 ;; a lot of work. However, I think calc still uses most of the time.
10081 (if (string-match ";" formula)
10082 (let ((tmp (org-split-string formula ";")))
10083 (setq formula (car tmp)
10084 fmt (concat (cdr (assoc "%" org-table-local-parameters))
10085 (nth 1 tmp)))
10087 (setq c (string-to-char (match-string 1 fmt))
10088 n (string-to-number (match-string 2 fmt)))
10089 (if (= c ?p)
10090 (setq modes (org-set-calc-mode 'calc-internal-prec n))
10091 (setq modes (org-set-calc-mode
10092 'calc-float-format
10093 (list (cdr (assoc c '((?n . float) (?f . fix)
10094 (?s . sci) (?e . eng))))
10095 n))))
10096 (setq fmt (replace-match "" t t fmt)))
10097 (if (string-match "[NT]" fmt)
10098 (setq numbers (equal (match-string 0 fmt) "N")
10099 fmt (replace-match "" t t fmt)))
10100 (if (string-match "L" fmt)
10101 (setq literal t
10102 fmt (replace-match "" t t fmt)))
10103 (if (string-match "E" fmt)
10104 (setq keep-empty t
10105 fmt (replace-match "" t t fmt)))
10106 (while (string-match "[DRFS]" fmt)
10107 (setq modes (org-set-calc-mode (match-string 0 fmt)))
10108 (setq fmt (replace-match "" t t fmt)))
10110 (setq fmt nil))))
10111 (if (and (not suppress-const) org-table-formula-use-constants)
10112 (setq formula (org-table-formula-substitute-names formula)))
10113 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
10114 (while (> ndown 0)
10115 (setq fields (org-split-string
10116 (org-no-properties
10117 (buffer-substring (point-at-bol) (point-at-eol)))
10118 " *| *"))
10119 (if (eq numbers t)
10120 (setq fields (mapcar
10121 (lambda (x) (number-to-string (string-to-number x)))
10122 fields)))
10123 (setq ndown (1- ndown))
10124 (setq form (copy-sequence formula)
10125 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
10126 (if (and lispp literal) (setq lispp 'literal))
10127 ;; Check for old vertical references
10128 (setq form (org-rewrite-old-row-references form))
10129 ;; Insert complex ranges
10130 (while (string-match org-table-range-regexp form)
10131 (setq form
10132 (replace-match
10133 (save-match-data
10134 (org-table-make-reference
10135 (org-table-get-range (match-string 0 form) nil n0)
10136 keep-empty numbers lispp))
10137 t t form)))
10138 ;; Insert simple ranges
10140 (setq form
10141 (replace-match
10142 (save-match-data
10143 (org-table-make-reference
10144 (org-sublist
10145 fields (string-to-number (match-string 1 form))
10146 (string-to-number (match-string 2 form)))
10147 keep-empty numbers lispp))
10148 t t form)))
10149 (setq form0 form)
10150 ;; Insert the references to fields in same row
10152 (setq n (string-to-number (match-string 1 form))
10153 x (nth (1- (if (= n 0) n0 n)) fields))
10155 (match-string 0 form)))
10156 (setq form (replace-match
10157 (save-match-data
10158 (org-table-make-reference x nil numbers lispp))
10159 t t form)))
10161 (if lispp
10162 (setq ev (condition-case nil
10163 (eval (eval (read form)))
10164 (error "#ERROR"))
10165 ev (if (numberp ev) (number-to-string ev) ev))
10166 (or (fboundp 'calc-eval)
10167 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
10168 (setq ev (calc-eval (cons form modes)
10169 (if numbers 'num))))
10171 (when org-table-formula-debug
10172 (with-output-to-temp-buffer "*Substitution History*"
10173 (princ (format "Substitution history of formula
10174 Orig: %s
10175 $xyz-> %s
10176 @r$c-> %s
10178 (if (listp ev)
10180 (make-string (car ev) ?\-) (nth 1 ev)))
10182 ev (or fmt "NONE")
10183 (if fmt (format fmt (string-to-number ev)) ev)))))
10184 (setq bw (get-buffer-window "*Substitution History*"))
10185 (shrink-window-if-larger-than-buffer bw)
10186 (unless (and (interactive-p) (not ndown))
10187 (unless (let (inhibit-redisplay)
10188 (y-or-n-p "Debugging Formula. Continue to next? "))
10189 (org-table-align)
10190 (error "Abort"))
10191 (delete-window bw)
10192 (message "")))
10193 (if (listp ev) (setq fmt nil ev "#ERROR"))
10194 (org-table-justify-field-maybe
10195 (if fmt (format fmt (string-to-number ev)) ev))
10197 (call-interactively 'org-return)
10198 (setq ndown 0)))
10199 (and down (org-table-maybe-recalculate-line))
10200 (or suppress-align (and org-table-may-need-update
10201 (org-table-align))))))
10203 (defun org-table-put-field-property (prop value)
10204 (save-excursion
10205 (put-text-property (progn (skip-chars-backward "^|") (point))
10206 (progn (skip-chars-forward "^|") (point))
10207 prop value)))
10209 (defun org-table-get-range (desc &optional tbeg col highlight)
10210 "Get a calc vector from a column, accorting to descriptor DESC.
10211 Optional arguments TBEG and COL can give the beginning of the table and
10212 the current column, to avoid unnecessary parsing.
10213 HIGHLIGHT means, just highlight the range."
10214 (if (not (equal (string-to-char desc) ?@))
10215 (setq desc (concat "@" desc)))
10216 (save-excursion
10217 (or tbeg (setq tbeg (org-table-begin)))
10218 (or col (setq col (org-table-current-column)))
10219 (let ((thisline (org-current-line))
10220 beg end c1 c2 r1 r2 rangep tmp)
10221 (unless (string-match org-table-range-regexp desc)
10222 (error "Invalid table range specifier `%s'" desc))
10223 (setq rangep (match-end 3)
10224 r1 (and (match-end 1) (match-string 1 desc))
10225 r2 (and (match-end 4) (match-string 4 desc))
10226 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
10227 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
10229 (and c1 (setq c1 (+ (string-to-number c1)
10230 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
10231 (and c2 (setq c2 (+ (string-to-number c2)
10232 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
10233 (if (equal r1 "") (setq r1 nil))
10234 (if (equal r2 "") (setq r2 nil))
10235 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
10236 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
10237 ; (setq r2 (or r2 r1) c2 (or c2 c1))
10238 (if (not r1) (setq r1 thisline))
10239 (if (not r2) (setq r2 thisline))
10240 (if (not c1) (setq c1 col))
10241 (if (not c2) (setq c2 col))
10242 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
10243 ;; just one field
10244 (progn
10245 (goto-line r1)
10246 (while (not (looking-at org-table-dataline-regexp))
10247 (beginning-of-line 2))
10248 (prog1 (org-trim (org-table-get-field c1))
10249 (if highlight (org-table-highlight-rectangle (point) (point)))))
10250 ;; A range, return a vector
10251 ;; First sort the numbers to get a regular ractangle
10252 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
10253 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
10254 (goto-line r1)
10255 (while (not (looking-at org-table-dataline-regexp))
10256 (beginning-of-line 2))
10257 (org-table-goto-column c1)
10258 (setq beg (point))
10259 (goto-line r2)
10260 (while (not (looking-at org-table-dataline-regexp))
10261 (beginning-of-line 0))
10262 (org-table-goto-column c2)
10263 (setq end (point))
10264 (if highlight
10265 (org-table-highlight-rectangle
10267 ;; return string representation of calc vector
10268 (mapcar 'org-trim
10269 (apply 'append (org-table-copy-region beg end)))))))
10271 (defun org-table-get-descriptor-line (desc &optional cline bline table)
10272 "Analyze descriptor DESC and retrieve the corresponding line number.
10273 The cursor is currently in line CLINE, the table begins in line BLINE,
10274 and TABLE is a vector with line types."
10275 (if (string-match "^[0-9]+$" desc)
10276 (aref org-table-dlines (string-to-number desc))
10277 (setq cline (or cline (org-current-line))
10278 bline (or bline org-table-current-begin-line)
10279 table (or table org-table-current-line-types))
10280 (if (or
10282 ;; 1 2 3 4 5 6
10283 (and (not (match-end 3)) (not (match-end 6)))
10284 (and (match-end 3) (match-end 6) (not (match-end 5))))
10285 (error "invalid row descriptor `%s'" desc))
10286 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
10287 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
10288 (odir (and (match-end 5) (match-string 5 desc)))
10289 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
10290 (i (- cline bline))
10291 (rel (and (match-end 6)
10292 (or (and (match-end 1) (not (match-end 3)))
10293 (match-end 5)))))
10294 (if (and hn (not hdir))
10295 (progn
10296 (setq i 0 hdir "+")
10297 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
10298 (if (and (not hn) on (not odir))
10299 (error "should never happen");;(aref org-table-dlines on)
10300 (if (and hn (> hn 0))
10301 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
10302 (if on
10303 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
10304 (+ bline i)))))
10306 (defun org-find-row-type (table i type backwards relative n)
10307 (let ((l (length table)))
10308 (while (> n 0)
10309 (while (and (setq i (+ i (if backwards -1 1)))
10310 (>= i 0) (< i l)
10311 (not (eq (aref table i) type))
10312 (if (and relative (eq (aref table i) 'hline))
10313 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
10314 t)))
10315 (setq n (1- n)))
10316 (if (or (< i 0) (>= i l))
10317 (error "Row descriptior leads outside table")
10318 i)))
10320 (defun org-rewrite-old-row-references (s)
10321 (if (string-match "&[-+0-9I]" s)
10322 (error "Formula contains old &row reference, please rewrite using @-syntax")
10323 s))
10325 (defun org-table-make-reference (elements keep-empty numbers lispp)
10326 "Convert list ELEMENTS to something appropriate to insert into formula.
10327 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
10328 NUMBERS indicates that everything should be converted to numbers.
10329 LISPP means to return something appropriate for a Lisp list."
10330 (if (stringp elements) ; just a single val
10331 (if lispp
10332 (if (eq lispp 'literal)
10333 elements
10334 (prin1-to-string (if numbers (string-to-number elements) elements)))
10335 (if (equal elements "") (setq elements "0"))
10336 (if numbers (number-to-string (string-to-number elements)) elements))
10337 (unless keep-empty
10338 (setq elements
10339 (delq nil
10341 elements))))
10342 (setq elements (or elements '("0")))
10343 (if lispp
10344 (mapconcat
10345 (lambda (x)
10346 (if (eq lispp 'literal)
10347 x
10348 (prin1-to-string (if numbers (string-to-number x) x))))
10349 elements " ")
10350 (concat "[" (mapconcat
10351 (lambda (x)
10352 (if numbers (number-to-string (string-to-number x)) x))
10353 elements
10354 ",") "]"))))
10356 (defun org-table-recalculate (&optional all noalign)
10357 "Recalculate the current table line by applying all stored formulas.
10358 With prefix arg ALL, do this for all lines in the table."
10359 (interactive "P")
10360 (or (memq this-command org-recalc-commands)
10361 (setq org-recalc-commands (cons this-command org-recalc-commands)))
10362 (unless (org-at-table-p) (error "Not at a table"))
10363 (if (equal all '(16))
10364 (org-table-iterate)
10365 (org-table-get-specials)
10366 (let* ((eqlist (sort (org-table-get-stored-formulas)
10367 (lambda (a b) (string< (car a) (car b)))))
10368 (inhibit-redisplay (not debug-on-error))
10369 (line-re org-table-dataline-regexp)
10370 (thisline (org-current-line))
10371 (thiscol (org-table-current-column))
10372 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
10373 ;; Insert constants in all formulas
10374 (setq eqlist
10375 (mapcar (lambda (x)
10376 (setcdr x (org-table-formula-substitute-names (cdr x)))
10377 x)
10378 eqlist))
10379 ;; Split the equation list
10380 (while (setq eq (pop eqlist))
10381 (if (<= (string-to-char (car eq)) ?9)
10382 (push eq eqlnum)
10383 (push eq eqlname)))
10384 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
10385 (if all
10386 (progn
10387 (setq end (move-marker (make-marker) (1+ (org-table-end))))
10388 (goto-char (setq beg (org-table-begin)))
10389 (if (re-search-forward org-table-calculate-mark-regexp end t)
10390 ;; This is a table with marked lines, compute selected lines
10391 (setq line-re org-table-recalculate-regexp)
10392 ;; Move forward to the first non-header line
10393 (if (and (re-search-forward org-table-dataline-regexp end t)
10394 (re-search-forward org-table-hline-regexp end t)
10395 (re-search-forward org-table-dataline-regexp end t))
10396 (setq beg (match-beginning 0))
10397 nil))) ;; just leave beg where it is
10398 (setq beg (point-at-bol)
10399 end (move-marker (make-marker) (1+ (point-at-eol)))))
10400 (goto-char beg)
10401 (and all (message "Re-applying formulas to full table..."))
10403 ;; First find the named fields, and mark them untouchanble
10404 (remove-text-properties beg end '(org-untouchable t))
10405 (while (setq eq (pop eqlname))
10406 (setq name (car eq)
10407 a (assoc name org-table-named-field-locations))
10408 (and (not a)
10410 (setq a (list name
10411 (aref org-table-dlines
10412 (string-to-number (match-string 1 name)))
10413 (string-to-number (match-string 2 name)))))
10414 (when (and a (or all (equal (nth 1 a) thisline)))
10415 (message "Re-applying formula to field: %s" name)
10416 (goto-line (nth 1 a))
10417 (org-table-goto-column (nth 2 a))
10418 (push (append a (list (cdr eq))) eqlname1)
10419 (org-table-put-field-property :org-untouchable t)))
10421 ;; Now evauluate the column formulas, but skip fields covered by
10422 ;; field formulas
10423 (goto-char beg)
10424 (while (re-search-forward line-re end t)
10425 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
10426 ;; Unprotected line, recalculate
10427 (and all (message "Re-applying formulas to full table...(line %d)"
10428 (setq cnt (1+ cnt))))
10429 (setq org-last-recalc-line (org-current-line))
10430 (setq eql eqlnum)
10431 (while (setq entry (pop eql))
10432 (goto-line org-last-recalc-line)
10433 (org-table-goto-column (string-to-number (car entry)) nil 'force)
10434 (unless (get-text-property (point) :org-untouchable)
10435 (org-table-eval-formula nil (cdr entry)
10436 'noalign 'nocst 'nostore 'noanalysis)))))
10438 ;; Now evaluate the field formulas
10439 (while (setq eq (pop eqlname1))
10440 (message "Re-applying formula to field: %s" (car eq))
10441 (goto-line (nth 1 eq))
10442 (org-table-goto-column (nth 2 eq))
10443 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
10444 'nostore 'noanalysis))
10446 (goto-line thisline)
10447 (org-table-goto-column thiscol)
10448 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
10449 (or noalign (and org-table-may-need-update (org-table-align))
10450 (and all (message "Re-applying formulas to %d lines...done" cnt)))
10452 ;; back to initial position
10453 (message "Re-applying formulas...done")
10454 (goto-line thisline)
10455 (org-table-goto-column thiscol)
10456 (or noalign (and org-table-may-need-update (org-table-align))
10457 (and all (message "Re-applying formulas...done"))))))
10459 (defun org-table-iterate (&optional arg)
10460 "Recalculate the table until it does not change anymore."
10461 (interactive "P")
10462 (let ((imax (if arg (prefix-numeric-value arg) 10))
10463 (i 0)
10464 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
10465 thistbl)
10466 (catch 'exit
10467 (while (< i imax)
10468 (setq i (1+ i))
10469 (org-table-recalculate 'all)
10470 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
10471 (if (not (string= lasttbl thistbl))
10472 (setq lasttbl thistbl)
10473 (if (> i 1)
10474 (message "Convergence after %d iterations" i)
10475 (message "Table was already stable"))
10476 (throw 'exit t)))
10477 (error "No convergence after %d iterations" i))))
10479 (defun org-table-formula-substitute-names (f)
10480 "Replace $const with values in string F."
10481 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
10482 ;; First, check for column names
10483 (while (setq start (string-match org-table-column-name-regexp f start))
10484 (setq start (1+ start))
10485 (setq a (assoc (match-string 1 f) org-table-column-names))
10486 (setq f (replace-match (concat "$" (cdr a)) t t f)))
10487 ;; Parameters and constants
10488 (setq start 0)
10490 (setq start (1+ start))
10491 (if (setq a (save-match-data
10492 (org-table-get-constant (match-string 1 f))))
10493 (setq f (replace-match
10494 (concat (if pp "(") a (if pp ")")) t t f))))
10495 (if org-table-formula-debug
10496 (put-text-property 0 (length f) :orig-formula f1 f))
10497 f))
10499 (defun org-table-get-constant (const)
10500 "Find the value for a parameter or constant in a formula.
10501 Parameters get priority."
10502 (or (cdr (assoc const org-table-local-parameters))
10503 (cdr (assoc const org-table-formula-constants-local))
10504 (cdr (assoc const org-table-formula-constants))
10505 (and (fboundp 'constants-get) (constants-get const))
10506 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
10507 (org-entry-get nil (substring const 5) 'inherit))
10508 "#UNDEFINED_NAME"))
10510 (defvar org-table-fedit-map
10511 (let ((map (make-sparse-keymap)))
10512 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
10513 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
10514 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
10515 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
10516 (org-defkey map "\C-c?" 'org-table-show-reference)
10517 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
10518 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
10519 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
10520 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
10521 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
10522 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
10523 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
10524 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
10525 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
10526 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
10527 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
10528 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
10529 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
10530 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
10531 map))
10533 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
10534 '("Edit-Formulas"
10535 ["Finish and Install" org-table-fedit-finish t]
10536 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
10537 ["Abort" org-table-fedit-abort t]
10538 "--"
10539 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
10540 ["Complete Lisp Symbol" lisp-complete-symbol t]
10541 "--"
10542 "Shift Reference at Point"
10543 ["Up" org-table-fedit-ref-up t]
10544 ["Down" org-table-fedit-ref-down t]
10545 ["Left" org-table-fedit-ref-left t]
10546 ["Right" org-table-fedit-ref-right t]
10547 "-"
10548 "Change Test Row for Column Formulas"
10549 ["Up" org-table-fedit-line-up t]
10550 ["Down" org-table-fedit-line-down t]
10551 "--"
10552 ["Scroll Table Window" org-table-fedit-scroll t]
10553 ["Scroll Table Window down" org-table-fedit-scroll-down t]
10554 ["Show Table Grid" org-table-fedit-toggle-coordinates
10555 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
10556 org-table-overlay-coordinates)]
10557 "--"
10558 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
10559 :style toggle :selected org-table-buffer-is-an]))
10561 (defvar org-pos)
10563 (defun org-table-edit-formulas ()
10564 "Edit the formulas of the current table in a separate buffer."
10565 (interactive)
10567 (beginning-of-line 0))
10568 (unless (org-at-table-p) (error "Not at a table"))
10569 (org-table-get-specials)
10570 (let ((key (org-table-current-field-formula 'key 'noerror))
10571 (eql (sort (org-table-get-stored-formulas 'noerror)
10572 'org-table-formula-less-p))
10573 (pos (move-marker (make-marker) (point)))
10574 (startline 1)
10575 (wc (current-window-configuration))
10579 entry s type title)
10580 (org-switch-to-buffer-other-window "*Edit Formulas*")
10581 (erase-buffer)
10582 ;; Keep global-font-lock-mode from turning on font-lock-mode
10583 (let ((font-lock-global-modes '(not fundamental-mode)))
10584 (fundamental-mode))
10585 (org-set-local 'font-lock-global-modes (list 'not major-mode))
10586 (org-set-local 'org-pos pos)
10587 (org-set-local 'org-window-configuration wc)
10588 (use-local-map org-table-fedit-map)
10589 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
10590 (easy-menu-add org-table-fedit-menu)
10591 (setq startline (org-current-line))
10592 (while (setq entry (pop eql))
10593 (setq type (cond
10594 ((equal (string-to-char (car entry)) ?@) 'field)
10595 ((string-match "^[0-9]" (car entry)) 'column)
10596 (t 'named)))
10597 (when (setq title (assq type titles))
10599 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
10600 (setq titles (delq title titles)))
10601 (if (equal key (car entry)) (setq startline (org-current-line)))
10602 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
10604 (remove-text-properties 0 (length s) '(face nil) s)
10605 (insert s))
10606 (if (eq org-table-use-standard-references t)
10607 (org-table-fedit-toggle-ref-type))
10608 (goto-line startline)
10609 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
10611 (defun org-table-fedit-post-command ()
10612 (when (not (memq this-command '(lisp-complete-symbol)))
10613 (let ((win (selected-window)))
10614 (save-excursion
10615 (condition-case nil
10616 (org-table-show-reference)
10617 (error nil))
10618 (select-window win)))))
10620 (defun org-table-formula-to-user (s)
10621 "Convert a formula from internal to user representation."
10622 (if (eq org-table-use-standard-references t)
10623 (org-table-convert-refs-to-an s)
10624 s))
10626 (defun org-table-formula-from-user (s)
10627 "Convert a formula from user to internal representation."
10628 (if org-table-use-standard-references
10629 (org-table-convert-refs-to-rc s)
10630 s))
10632 (defun org-table-convert-refs-to-rc (s)
10633 "Convert spreadsheet references from AB7 to @7$28.
10634 Works for single references, but also for entire formulas and even the
10635 full TBLFM line."
10636 (let ((start 0))
10638 (cond
10639 ((match-end 3)
10640 ;; format match, just advance
10641 (setq start (match-end 0)))
10642 ((and (> (match-beginning 0) 0)
10643 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
10644 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
10645 ;; 3.e5 or something like this.
10646 (setq start (match-end 0)))
10647 (t
10648 (setq start (match-beginning 0)
10649 s (replace-match
10650 (if (equal (match-string 2 s) "&")
10651 (format "$%d" (org-letters-to-number (match-string 1 s)))
10652 (format "@%d$%d"
10653 (string-to-number (match-string 2 s))
10654 (org-letters-to-number (match-string 1 s))))
10655 t t s)))))
10656 s))
10658 (defun org-table-convert-refs-to-an (s)
10659 "Convert spreadsheet references from to @7$28 to AB7.
10660 Works for single references, but also for entire formulas and even the
10661 full TBLFM line."
10663 (setq s (replace-match
10664 (format "%s%d"
10665 (org-number-to-letters
10666 (string-to-number (match-string 2 s)))
10667 (string-to-number (match-string 1 s)))
10668 t t s)))
10671 (org-number-to-letters
10672 (string-to-number (match-string 2 s))) "&")
10673 t nil s)))
10674 s)
10676 (defun org-letters-to-number (s)
10677 "Convert a base 26 number represented by letters into an integer.
10678 For example: AB -> 28."
10679 (let ((n 0))
10680 (setq s (upcase s))
10681 (while (> (length s) 0)
10682 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
10683 s (substring s 1)))
10684 n))
10686 (defun org-number-to-letters (n)
10687 "Convert an integer into a base 26 number represented by letters.
10688 For example: 28 -> AB."
10689 (let ((s ""))
10690 (while (> n 0)
10691 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
10692 n (/ (1- n) 26)))
10693 s))
10695 (defun org-table-fedit-convert-buffer (function)
10696 "Convert all references in this buffer, using FUNTION."
10697 (let ((line (org-current-line)))
10698 (goto-char (point-min))
10699 (while (not (eobp))
10700 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10701 (delete-region (point) (point-at-eol))
10702 (or (eobp) (forward-char 1)))
10703 (goto-line line)))
10705 (defun org-table-fedit-toggle-ref-type ()
10706 "Convert all references in the buffer from B3 to @3$2 and back."
10707 (interactive)
10708 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10709 (org-table-fedit-convert-buffer
10710 (if org-table-buffer-is-an
10711 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10712 (message "Reference type switched to %s"
10713 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10715 (defun org-table-fedit-ref-up ()
10716 "Shift the reference at point one row/hline up."
10717 (interactive)
10718 (org-table-fedit-shift-reference 'up))
10719 (defun org-table-fedit-ref-down ()
10720 "Shift the reference at point one row/hline down."
10721 (interactive)
10722 (org-table-fedit-shift-reference 'down))
10723 (defun org-table-fedit-ref-left ()
10724 "Shift the reference at point one field to the left."
10725 (interactive)
10726 (org-table-fedit-shift-reference 'left))
10727 (defun org-table-fedit-ref-right ()
10728 "Shift the reference at point one field to the right."
10729 (interactive)
10730 (org-table-fedit-shift-reference 'right))
10732 (defun org-table-fedit-shift-reference (dir)
10733 (cond
10735 (if (memq dir '(left right))
10736 (org-rematch-and-replace 1 (eq dir 'left))
10737 (error "Cannot shift reference in this direction")))
10739 ;; A B3-like reference
10740 (if (memq dir '(up down))
10741 (org-rematch-and-replace 2 (eq dir 'up))
10742 (org-rematch-and-replace 1 (eq dir 'left))))
10743 ((org-at-regexp-p
10745 ;; An internal reference
10746 (if (memq dir '(up down))
10747 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10748 (org-rematch-and-replace 5 (eq dir 'left))))))
10750 (defun org-rematch-and-replace (n &optional decr hline)
10751 "Re-match the group N, and replace it with the shifted refrence."
10752 (or (match-end n) (error "Cannot shift reference in this direction"))
10753 (goto-char (match-beginning n))
10754 (and (looking-at (regexp-quote (match-string n)))
10755 (replace-match (org-shift-refpart (match-string 0) decr hline)
10756 t t)))
10758 (defun org-shift-refpart (ref &optional decr hline)
10759 "Shift a refrence part REF.
10760 If DECR is set, decrease the references row/column, else increase.
10761 If HLINE is set, this may be a hline reference, it certainly is not
10762 a translation reference."
10763 (save-match-data
10764 (let* ((sign (string-match "^[-+]" ref)) n)
10766 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10767 (cond
10768 ((and hline (string-match "^I+" ref))
10769 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10770 (setq n (+ n (if decr -1 1)))
10771 (if (= n 0) (setq n (+ n (if decr -1 1))))
10772 (if sign
10773 (setq sign (if (< n 0) "-" "+") n (abs n))
10774 (setq n (max 1 n)))
10775 (concat sign (make-string n ?I)))
10777 ((string-match "^[0-9]+" ref)
10778 (setq n (string-to-number (concat sign ref)))
10779 (setq n (+ n (if decr -1 1)))
10780 (if sign
10781 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10782 (number-to-string (max 1 n))))
10784 ((string-match "^[a-zA-Z]+" ref)
10785 (org-number-to-letters
10786 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10788 (t (error "Cannot shift reference"))))))
10790 (defun org-table-fedit-toggle-coordinates ()
10791 "Toggle the display of coordinates in the refrenced table."
10792 (interactive)
10793 (let ((pos (marker-position org-pos)))
10794 (with-current-buffer (marker-buffer org-pos)
10795 (save-excursion
10796 (goto-char pos)
10797 (org-table-toggle-coordinate-overlays)))))
10799 (defun org-table-fedit-finish (&optional arg)
10800 "Parse the buffer for formula definitions and install them.
10801 With prefix ARG, apply the new formulas to the table."
10802 (interactive "P")
10803 (org-table-remove-rectangle-highlight)
10804 (if org-table-use-standard-references
10805 (progn
10806 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10807 (setq org-table-buffer-is-an nil)))
10808 (let ((pos org-pos) eql var form)
10809 (goto-char (point-min))
10810 (while (re-search-forward
10812 nil t)
10813 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10814 form (match-string 3))
10815 (setq form (org-trim form))
10816 (when (not (equal form ""))
10818 (setq form (replace-match " " t t form)))
10819 (when (assoc var eql)
10820 (error "Double formulas for %s" var))
10821 (push (cons var form) eql)))
10822 (setq org-pos nil)
10823 (set-window-configuration org-window-configuration)
10824 (select-window (get-buffer-window (marker-buffer pos)))
10825 (goto-char pos)
10826 (unless (org-at-table-p)
10827 (error "Lost table position - cannot install formulae"))
10828 (org-table-store-formulas eql)
10829 (move-marker pos nil)
10830 (kill-buffer "*Edit Formulas*")
10831 (if arg
10832 (org-table-recalculate 'all)
10833 (message "New formulas installed - press C-u C-c C-c to apply."))))
10835 (defun org-table-fedit-abort ()
10836 "Abort editing formulas, without installing the changes."
10837 (interactive)
10838 (org-table-remove-rectangle-highlight)
10839 (let ((pos org-pos))
10840 (set-window-configuration org-window-configuration)
10841 (select-window (get-buffer-window (marker-buffer pos)))
10842 (goto-char pos)
10843 (move-marker pos nil)
10844 (message "Formula editing aborted without installing changes")))
10846 (defun org-table-fedit-lisp-indent ()
10847 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10848 (interactive)
10849 (let ((pos (point)) beg end ind)
10850 (beginning-of-line 1)
10851 (cond
10853 (goto-char pos)
10854 (call-interactively 'lisp-indent-line))
10856 ((not (fboundp 'pp-buffer))
10857 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10858 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10859 (goto-char (- (match-end 0) 2))
10860 (setq beg (point))
10861 (setq ind (make-string (current-column) ?\ ))
10862 (condition-case nil (forward-sexp 1)
10863 (error
10864 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10865 (setq end (point))
10866 (save-restriction
10867 (narrow-to-region beg end)
10868 (if (eq last-command this-command)
10869 (progn
10870 (goto-char (point-min))
10871 (setq this-command nil)
10873 (replace-match " ")))
10874 (pp-buffer)
10875 (untabify (point-min) (point-max))
10876 (goto-char (1+ (point-min)))
10877 (while (re-search-forward "^." nil t)
10878 (beginning-of-line 1)
10879 (insert ind))
10880 (goto-char (point-max))
10881 (backward-delete-char 1)))
10882 (goto-char beg))
10883 (t nil))))
10885 (defvar org-show-positions nil)
10887 (defun org-table-show-reference (&optional local)
10888 "Show the location/value of the $ expression at point."
10889 (interactive)
10890 (org-table-remove-rectangle-highlight)
10891 (catch 'exit
10892 (let ((pos (if local (point) org-pos))
10893 (face2 'highlight)
10894 (org-inhibit-highlight-removal t)
10895 (win (selected-window))
10896 (org-show-positions nil)
10897 var name e what match dest)
10898 (if local (org-table-get-specials))
10899 (setq what (cond
10900 ((or (org-at-regexp-p org-table-range-regexp2)
10901 (org-at-regexp-p org-table-translate-regexp)
10902 (org-at-regexp-p org-table-range-regexp))
10903 (setq match
10904 (save-match-data
10905 (org-table-convert-refs-to-rc (match-string 0))))
10906 'range)
10909 ((not local) nil)
10910 (t (error "No reference at point")))
10911 match (and what (or match (match-string 0))))
10912 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10913 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10914 'secondary-selection))
10915 (org-add-hook 'before-change-functions
10916 'org-table-remove-rectangle-highlight)
10917 (if (eq what 'name) (setq var (substring match 1)))
10918 (when (eq what 'range)
10919 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10920 (setq match (org-table-formula-substitute-names match)))
10921 (unless local
10922 (save-excursion
10923 (end-of-line 1)
10925 (beginning-of-line 1)
10927 (setq dest
10928 (save-match-data
10929 (org-table-convert-refs-to-rc (match-string 1))))
10930 (org-table-add-rectangle-overlay
10931 (match-beginning 1) (match-end 1) face2))))
10932 (if (and (markerp pos) (marker-buffer pos))
10933 (if (get-buffer-window (marker-buffer pos))
10934 (select-window (get-buffer-window (marker-buffer pos)))
10935 (org-switch-to-buffer-other-window (get-buffer-window
10936 (marker-buffer pos)))))
10937 (goto-char pos)
10938 (org-table-force-dataline)
10939 (when dest
10940 (setq name (substring dest 1))
10941 (cond
10943 (setq e (assoc name org-table-named-field-locations))
10944 (goto-line (nth 1 e))
10945 (org-table-goto-column (nth 2 e)))
10947 (let ((l (string-to-number (match-string 1 dest)))
10948 (c (string-to-number (match-string 2 dest))))
10949 (goto-line (aref org-table-dlines l))
10950 (org-table-goto-column c)))
10951 (t (org-table-goto-column (string-to-number name))))
10952 (move-marker pos (point))
10953 (org-table-highlight-rectangle nil nil face2))
10954 (cond
10955 ((equal dest match))
10956 ((not match))
10957 ((eq what 'range)
10958 (condition-case nil
10959 (save-excursion
10960 (org-table-get-range match nil nil 'highlight))
10961 (error nil)))
10962 ((setq e (assoc var org-table-named-field-locations))
10963 (goto-line (nth 1 e))
10964 (org-table-goto-column (nth 2 e))
10965 (org-table-highlight-rectangle (point) (point))
10966 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10967 ((setq e (assoc var org-table-column-names))
10968 (org-table-goto-column (string-to-number (cdr e)))
10969 (org-table-highlight-rectangle (point) (point))
10970 (goto-char (org-table-begin))
10972 (org-table-end) t)
10973 (progn
10974 (goto-char (match-beginning 1))
10975 (org-table-highlight-rectangle)
10976 (message "Named column (column %s)" (cdr e)))
10977 (error "Column name not found")))
10978 ((eq what 'column)
10979 ;; column number
10980 (org-table-goto-column (string-to-number (substring match 1)))
10981 (org-table-highlight-rectangle (point) (point))
10982 (message "Column %s" (substring match 1)))
10983 ((setq e (assoc var org-table-local-parameters))
10984 (goto-char (org-table-begin))
10986 (progn
10987 (goto-char (match-beginning 1))
10988 (org-table-highlight-rectangle)
10989 (message "Local parameter."))
10990 (error "Parameter not found")))
10991 (t
10992 (cond
10993 ((not var) (error "No reference at point"))
10994 ((setq e (assoc var org-table-formula-constants-local))
10995 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10996 var (cdr e)))
10997 ((setq e (assoc var org-table-formula-constants))
10998 (message "Constant: $%s=%s in `org-table-formula-constants'."
10999 var (cdr e)))
11000 ((setq e (and (fboundp 'constants-get) (constants-get var)))
11001 (message "Constant: $%s=%s, from `constants.el'%s."
11002 var e (format " (%s units)" constants-unit-system)))
11003 (t (error "Undefined name $%s" var)))))
11004 (goto-char pos)
11005 (when (and org-show-positions
11006 (not (memq this-command '(org-table-fedit-scroll
11007 org-table-fedit-scroll-down))))
11008 (push pos org-show-positions)
11009 (push org-table-current-begin-pos org-show-positions)
11010 (let ((min (apply 'min org-show-positions))
11011 (max (apply 'max org-show-positions)))
11012 (goto-char min) (recenter 0)
11013 (goto-char max)
11014 (or (pos-visible-in-window-p max) (recenter -1))))
11015 (select-window win))))
11017 (defun org-table-force-dataline ()
11018 "Make sure the cursor is in a dataline in a table."
11019 (unless (save-excursion
11020 (beginning-of-line 1)
11021 (looking-at org-table-dataline-regexp))
11022 (let* ((re org-table-dataline-regexp)
11023 (p1 (save-excursion (re-search-forward re nil 'move)))
11024 (p2 (save-excursion (re-search-backward re nil 'move))))
11025 (cond ((and p1 p2)
11026 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
11027 p1 p2)))
11028 ((or p1 p2) (goto-char (or p1 p2)))
11029 (t (error "No table dataline around here"))))))
11031 (defun org-table-fedit-line-up ()
11032 "Move cursor one line up in the window showing the table."
11033 (interactive)
11034 (org-table-fedit-move 'previous-line))
11036 (defun org-table-fedit-line-down ()
11037 "Move cursor one line down in the window showing the table."
11038 (interactive)
11039 (org-table-fedit-move 'next-line))
11041 (defun org-table-fedit-move (command)
11042 "Move the cursor in the window shoinw the table.
11043 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
11044 (let ((org-table-allow-automatic-line-recalculation nil)
11045 (pos org-pos) (win (selected-window)) p)
11046 (select-window (get-buffer-window (marker-buffer org-pos)))
11047 (setq p (point))
11048 (call-interactively command)
11049 (while (and (org-at-table-p)
11050 (org-at-table-hline-p))
11051 (call-interactively command))
11052 (or (org-at-table-p) (goto-char p))
11053 (move-marker pos (point))
11054 (select-window win)))
11056 (defun org-table-fedit-scroll (N)
11057 (interactive "p")
11058 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
11059 (scroll-other-window N)))
11061 (defun org-table-fedit-scroll-down (N)
11062 (interactive "p")
11063 (org-table-fedit-scroll (- N)))
11065 (defvar org-table-rectangle-overlays nil)
11067 (defun org-table-add-rectangle-overlay (beg end &optional face)
11068 "Add a new overlay."
11069 (let ((ov (org-make-overlay beg end)))
11070 (org-overlay-put ov 'face (or face 'secondary-selection))
11071 (push ov org-table-rectangle-overlays)))
11073 (defun org-table-highlight-rectangle (&optional beg end face)
11074 "Highlight rectangular region in a table."
11075 (setq beg (or beg (point)) end (or end (point)))
11076 (let ((b (min beg end))
11077 (e (max beg end))
11078 l1 c1 l2 c2 tmp)
11079 (and (boundp 'org-show-positions)
11080 (setq org-show-positions (cons b (cons e org-show-positions))))
11081 (goto-char (min beg end))
11082 (setq l1 (org-current-line)
11083 c1 (org-table-current-column))
11084 (goto-char (max beg end))
11085 (setq l2 (org-current-line)
11086 c2 (org-table-current-column))
11087 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
11088 (goto-line l1)
11089 (beginning-of-line 1)
11090 (loop for line from l1 to l2 do
11091 (when (looking-at org-table-dataline-regexp)
11092 (org-table-goto-column c1)
11094 (org-table-goto-column c2)
11096 (org-table-add-rectangle-overlay beg end face))
11097 (beginning-of-line 2))
11098 (goto-char b))
11099 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
11101 (defun org-table-remove-rectangle-highlight (&rest ignore)
11102 "Remove the rectangle overlays."
11103 (unless org-inhibit-highlight-removal
11104 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
11105 (mapc 'org-delete-overlay org-table-rectangle-overlays)
11106 (setq org-table-rectangle-overlays nil)))
11108 (defvar org-table-coordinate-overlays nil
11109 "Collects the cooordinate grid overlays, so that they can be removed.")
11110 (make-variable-buffer-local 'org-table-coordinate-overlays)
11112 (defun org-table-overlay-coordinates ()
11113 "Add overlays to the table at point, to show row/column coordinates."
11114 (interactive)
11115 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11116 (setq org-table-coordinate-overlays nil)
11117 (save-excursion
11118 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
11119 (goto-char (org-table-begin))
11120 (while (org-at-table-p)
11121 (setq eol (point-at-eol))
11122 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
11123 (push ov org-table-coordinate-overlays)
11124 (setq hline (looking-at org-table-hline-regexp))
11125 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
11126 (format "%4d" (setq id (1+ id)))))
11127 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
11128 (when hline
11129 (setq ic 0)
11131 (setq beg (1+ (match-beginning 0))
11132 ic (1+ ic)
11133 s1 (concat "$" (int-to-string ic))
11134 s2 (org-number-to-letters ic)
11135 str (if (eq org-table-use-standard-references t) s2 s1))
11136 (setq ov (org-make-overlay beg (+ beg (length str))))
11137 (push ov org-table-coordinate-overlays)
11138 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
11139 (beginning-of-line 2)))))
11141 (defun org-table-toggle-coordinate-overlays ()
11142 "Toggle the display of Row/Column numbers in tables."
11143 (interactive)
11144 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
11145 (message "Row/Column number display turned %s"
11146 (if org-table-overlay-coordinates "on" "off"))
11147 (if (and (org-at-table-p) org-table-overlay-coordinates)
11148 (org-table-align))
11149 (unless org-table-overlay-coordinates
11150 (mapc 'org-delete-overlay org-table-coordinate-overlays)
11151 (setq org-table-coordinate-overlays nil)))
11153 (defun org-table-toggle-formula-debugger ()
11154 "Toggle the formula debugger in tables."
11155 (interactive)
11156 (setq org-table-formula-debug (not org-table-formula-debug))
11157 (message "Formula debugging has been turned %s"
11158 (if org-table-formula-debug "on" "off")))
11160 ;;; The orgtbl minor mode
11162 ;; Define a minor mode which can be used in other modes in order to
11163 ;; integrate the org-mode table editor.
11165 ;; This is really a hack, because the org-mode table editor uses several
11166 ;; keys which normally belong to the major mode, for example the TAB and
11167 ;; RET keys. Here is how it works: The minor mode defines all the keys
11168 ;; necessary to operate the table editor, but wraps the commands into a
11169 ;; function which tests if the cursor is currently inside a table. If that
11170 ;; is the case, the table editor command is executed. However, when any of
11171 ;; those keys is used outside a table, the function uses `key-binding' to
11172 ;; look up if the key has an associated command in another currently active
11173 ;; keymap (minor modes, major mode, global), and executes that command.
11174 ;; There might be problems if any of the keys used by the table editor is
11175 ;; otherwise used as a prefix key.
11177 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
11178 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
11179 ;; addresses this by checking explicitly for both bindings.
11181 ;; The optimized version (see variable `orgtbl-optimized') takes over
11182 ;; all keys which are bound to `self-insert-command' in the *global map*.
11183 ;; Some modes bind other commands to simple characters, for example
11184 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
11185 ;; active, this binding is ignored inside tables and replaced with a
11186 ;; modified self-insert.
11188 (defvar orgtbl-mode nil
11189 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
11190 table editor in arbitrary modes.")
11191 (make-variable-buffer-local 'orgtbl-mode)
11193 (defvar orgtbl-mode-map (make-keymap)
11194 "Keymap for `orgtbl-mode'.")
11196 ;;;###autoload
11197 (defun turn-on-orgtbl ()
11198 "Unconditionally turn on `orgtbl-mode'."
11199 (orgtbl-mode 1))
11201 (defvar org-old-auto-fill-inhibit-regexp nil
11202 "Local variable used by `orgtbl-mode'")
11205 "Matches a line belonging to an orgtbl.")
11207 (defconst orgtbl-extra-font-lock-keywords
11208 (list (list (concat "^" orgtbl-line-start-regexp ".*")
11209 0 (quote 'org-table) 'prepend))
11210 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
11212 ;;;###autoload
11213 (defun orgtbl-mode (&optional arg)
11214 "The `org-mode' table editor as a minor mode for use in other modes."
11215 (interactive)
11216 (if (org-mode-p)
11217 ;; Exit without error, in case some hook functions calls this
11218 ;; by accident in org-mode.
11219 (message "Orgtbl-mode is not useful in org-mode, command ignored")
11220 (setq orgtbl-mode
11221 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
11222 (if orgtbl-mode
11223 (progn
11224 (and (orgtbl-setup) (defun orgtbl-setup () nil))
11225 ;; Make sure we are first in minor-mode-map-alist
11226 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
11227 (and c (setq minor-mode-map-alist
11228 (cons c (delq c minor-mode-map-alist)))))
11229 (org-set-local (quote org-table-may-need-update) t)
11230 (org-add-hook 'before-change-functions 'org-before-change-function
11231 nil 'local)
11232 (org-set-local 'org-old-auto-fill-inhibit-regexp
11233 auto-fill-inhibit-regexp)
11234 (org-set-local 'auto-fill-inhibit-regexp
11235 (if auto-fill-inhibit-regexp
11237 auto-fill-inhibit-regexp)
11238 orgtbl-line-start-regexp))
11239 (org-add-to-invisibility-spec '(org-cwidth))
11240 (when (fboundp 'font-lock-add-keywords)
11241 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
11242 (org-restart-font-lock))
11243 (easy-menu-add orgtbl-mode-menu)
11244 (run-hooks 'orgtbl-mode-hook))
11245 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
11246 (org-cleanup-narrow-column-properties)
11247 (org-remove-from-invisibility-spec '(org-cwidth))
11248 (remove-hook 'before-change-functions 'org-before-change-function t)
11249 (when (fboundp 'font-lock-remove-keywords)
11250 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
11251 (org-restart-font-lock))
11252 (easy-menu-remove orgtbl-mode-menu)
11253 (force-mode-line-update 'all))))
11255 (defun org-cleanup-narrow-column-properties ()
11256 "Remove all properties related to narrow-column invisibility."
11257 (let ((s 1))
11258 (while (setq s (text-property-any s (point-max)
11259 'display org-narrow-column-arrow))
11260 (remove-text-properties s (1+ s) '(display t)))
11261 (setq s 1)
11262 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
11263 (remove-text-properties s (1+ s) '(org-cwidth t)))
11264 (setq s 1)
11265 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
11266 (remove-text-properties s (1+ s) '(invisible t)))))
11268 ;; Install it as a minor mode.
11269 (put 'orgtbl-mode :included t)
11270 (put 'orgtbl-mode :menu-tag "Org Table Mode")
11271 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
11273 (defun orgtbl-make-binding (fun n &rest keys)
11274 "Create a function for binding in the table minor mode.
11275 FUN is the command to call inside a table. N is used to create a unique
11276 command name. KEYS are keys that should be checked in for a command
11277 to execute outside of tables."
11278 (eval
11279 (list 'defun
11280 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
11281 '(arg)
11283 "Outside of tables, run the binding of `"
11284 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
11285 "'.")
11286 '(interactive "p")
11287 (list 'if
11288 '(org-at-table-p)
11289 (list 'call-interactively (list 'quote fun))
11290 (list 'let '(orgtbl-mode)
11291 (list 'call-interactively
11292 (append '(or)
11293 (mapcar (lambda (k)
11294 (list 'key-binding k))
11295 keys)
11296 '('orgtbl-error))))))))
11298 (defun orgtbl-error ()
11299 "Error when there is no default binding for a table key."
11300 (interactive)
11301 (error "This key has no function outside tables"))
11303 (defun orgtbl-setup ()
11304 "Setup orgtbl keymaps."
11305 (let ((nfunc 0)
11306 (bindings
11307 (list
11308 '([(meta shift left)] org-table-delete-column)
11309 '([(meta left)] org-table-move-column-left)
11310 '([(meta right)] org-table-move-column-right)
11311 '([(meta shift right)] org-table-insert-column)
11312 '([(meta shift up)] org-table-kill-row)
11313 '([(meta shift down)] org-table-insert-row)
11314 '([(meta up)] org-table-move-row-up)
11315 '([(meta down)] org-table-move-row-down)
11316 '("\C-c\C-w" org-table-cut-region)
11317 '("\C-c\M-w" org-table-copy-region)
11318 '("\C-c\C-y" org-table-paste-rectangle)
11319 '("\C-c-" org-table-insert-hline)
11320 '("\C-c}" org-table-toggle-coordinate-overlays)
11321 '("\C-c{" org-table-toggle-formula-debugger)
11322 '("\C-m" org-table-next-row)
11323 '([(shift return)] org-table-copy-down)
11324 '("\C-c\C-q" org-table-wrap-region)
11325 '("\C-c?" org-table-field-info)
11326 '("\C-c " org-table-blank-field)
11327 '("\C-c+" org-table-sum)
11328 '("\C-c=" org-table-eval-formula)
11329 '("\C-c'" org-table-edit-formulas)
11330 '("\C-c`" org-table-edit-field)
11331 '("\C-c*" org-table-recalculate)
11332 '("\C-c|" org-table-create-or-convert-from-region)
11333 '("\C-c^" org-table-sort-lines)
11334 '([(control ?#)] org-table-rotate-recalc-marks)))
11335 elt key fun cmd)
11336 (while (setq elt (pop bindings))
11337 (setq nfunc (1+ nfunc))
11338 (setq key (org-key (car elt))
11339 fun (nth 1 elt)
11340 cmd (orgtbl-make-binding fun nfunc key))
11341 (org-defkey orgtbl-mode-map key cmd))
11343 ;; Special treatment needed for TAB and RET
11344 (org-defkey orgtbl-mode-map [(return)]
11345 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
11346 (org-defkey orgtbl-mode-map "\C-m"
11347 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
11349 (org-defkey orgtbl-mode-map [(tab)]
11350 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
11351 (org-defkey orgtbl-mode-map "\C-i"
11352 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
11354 (org-defkey orgtbl-mode-map [(shift tab)]
11355 (orgtbl-make-binding 'org-table-previous-field 104
11356 [(shift tab)] [(tab)] "\C-i"))
11358 (org-defkey orgtbl-mode-map "\M-\C-m"
11359 (orgtbl-make-binding 'org-table-wrap-region 105
11360 "\M-\C-m" [(meta return)]))
11361 (org-defkey orgtbl-mode-map [(meta return)]
11362 (orgtbl-make-binding 'org-table-wrap-region 106
11363 [(meta return)] "\M-\C-m"))
11365 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
11366 (when orgtbl-optimized
11367 ;; If the user wants maximum table support, we need to hijack
11368 ;; some standard editing functions
11369 (org-remap orgtbl-mode-map
11370 'self-insert-command 'orgtbl-self-insert-command
11371 'delete-char 'org-delete-char
11372 'delete-backward-char 'org-delete-backward-char)
11373 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
11374 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
11375 '("OrgTbl"
11376 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
11377 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
11378 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
11379 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
11380 "--"
11381 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
11382 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
11383 ["Copy Field from Above"
11384 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
11385 "--"
11386 ("Column"
11387 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
11388 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
11389 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
11390 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
11391 ("Row"
11392 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
11393 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
11394 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
11395 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
11396 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
11397 "--"
11398 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
11399 ("Rectangle"
11400 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
11401 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
11402 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
11403 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
11404 "--"
11405 ("Radio tables"
11406 ["Insert table template" orgtbl-insert-radio-table
11407 (assq major-mode orgtbl-radio-table-templates)]
11408 ["Comment/uncomment table" orgtbl-toggle-comment t])
11409 "--"
11410 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
11411 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
11412 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
11413 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
11414 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
11415 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
11416 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
11417 ["Sum Column/Rectangle" org-table-sum
11418 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
11419 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
11420 ["Debug Formulas"
11421 org-table-toggle-formula-debugger :active (org-at-table-p)
11422 :keys "C-c {"
11423 :style toggle :selected org-table-formula-debug]
11424 ["Show Col/Row Numbers"
11425 org-table-toggle-coordinate-overlays :active (org-at-table-p)
11426 :keys "C-c }"
11427 :style toggle :selected org-table-overlay-coordinates]
11428 ))
11429 t))
11431 (defun orgtbl-ctrl-c-ctrl-c (arg)
11432 "If the cursor is inside a table, realign the table.
11433 It it is a table to be sent away to a receiver, do it.
11434 With prefix arg, also recompute table."
11435 (interactive "P")
11436 (let ((pos (point)) action)
11437 (save-excursion
11438 (beginning-of-line 1)
11442 (cond
11443 ((integerp action)
11444 (goto-char action)
11445 (org-table-maybe-eval-formula)
11446 (if arg
11447 (call-interactively 'org-table-recalculate)
11448 (org-table-maybe-recalculate-line))
11449 (call-interactively 'org-table-align)
11450 (orgtbl-send-table 'maybe))
11451 ((eq action 'recalc)
11452 (save-excursion
11453 (beginning-of-line 1)
11455 (if (org-at-table-p)
11456 (org-call-with-arg 'org-table-recalculate t))))
11457 (t (let (orgtbl-mode)
11458 (call-interactively (key-binding "\C-c\C-c")))))))
11460 (defun orgtbl-tab (arg)
11461 "Justification and field motion for `orgtbl-mode'."
11462 (interactive "P")
11463 (if arg (org-table-edit-field t)
11464 (org-table-justify-field-maybe)
11465 (org-table-next-field)))
11467 (defun orgtbl-ret ()
11468 "Justification and field motion for `orgtbl-mode'."
11469 (interactive)
11470 (org-table-justify-field-maybe)
11471 (org-table-next-row))
11473 (defun orgtbl-self-insert-command (N)
11474 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
11475 If the cursor is in a table looking at whitespace, the whitespace is
11476 overwritten, and the table is not marked as requiring realignment."
11477 (interactive "p")
11478 (if (and (org-at-table-p)
11479 (or
11480 (and org-table-auto-blank-field
11481 (member last-command
11482 '(orgtbl-hijacker-command-100
11483 orgtbl-hijacker-command-101
11484 orgtbl-hijacker-command-102
11485 orgtbl-hijacker-command-103
11486 orgtbl-hijacker-command-104
11487 orgtbl-hijacker-command-105))
11488 (org-table-blank-field))
11489 t)
11490 (eq N 1)
11492 (let (org-table-may-need-update)
11493 (goto-char (1- (match-end 0)))
11494 (delete-backward-char 1)
11495 (goto-char (match-beginning 0))
11496 (self-insert-command N))
11497 (setq org-table-may-need-update t)
11498 (let (orgtbl-mode)
11499 (call-interactively (key-binding (vector last-input-event))))))
11501 (defun org-force-self-insert (N)
11502 "Needed to enforce self-insert under remapping."
11503 (interactive "p")
11504 (self-insert-command N))
11507 "Regula expression matching exponentials as produced by calc.")
11509 (defvar org-table-clean-did-remove-column nil)
11511 (defun orgtbl-export (table target)
11512 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
11514 org-table-last-alignment org-table-last-column-widths
11515 maxcol column)
11516 (if (not (fboundp func))
11517 (error "Cannot export orgtbl table to %s" target))
11518 (setq lines (org-table-clean-before-export lines))
11519 (setq table
11520 (mapcar
11521 (lambda (x)
11522 (if (string-match org-table-hline-regexp x)
11523 'hline
11525 lines))
11526 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
11527 table)))
11528 (loop for i from (1- maxcol) downto 0 do
11529 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
11530 (setq column (delq nil column))
11531 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
11532 (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))
11533 (funcall func table nil)))
11535 (defun orgtbl-send-table (&optional maybe)
11536 "Send a tranformed version of this table to the receiver position.
11537 With argument MAYBE, fail quietly if no transformation is defined for
11538 this table."
11539 (interactive)
11540 (catch 'exit
11541 (unless (org-at-table-p) (error "Not at a table"))
11542 ;; when non-interactive, we assume align has just happened.
11543 (when (interactive-p) (org-table-align))
11544 (save-excursion
11545 (goto-char (org-table-begin))
11546 (beginning-of-line 0)
11548 (if maybe
11549 (throw 'exit nil)
11550 (error "Don't know how to transform this table."))))
11551 (let* ((name (match-string 1))
11552 beg
11553 (transform (intern (match-string 2)))
11554 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
11555 (skip (plist-get params :skip))
11556 (skipcols (plist-get params :skipcols))
11557 (txt (buffer-substring-no-properties
11558 (org-table-begin) (org-table-end)))
11560 (lines (org-table-clean-before-export lines))
11561 (i0 (if org-table-clean-did-remove-column 2 1))
11562 (table (mapcar
11563 (lambda (x)
11564 (if (string-match org-table-hline-regexp x)
11565 'hline
11566 (org-remove-by-index
11568 skipcols i0)))
11569 lines))
11570 (fun (if (= i0 2) 'cdr 'identity))
11571 (org-table-last-alignment
11572 (org-remove-by-index (funcall fun org-table-last-alignment)
11573 skipcols i0))
11574 (org-table-last-column-widths
11575 (org-remove-by-index (funcall fun org-table-last-column-widths)
11576 skipcols i0)))
11578 (unless (fboundp transform)
11579 (error "No such transformation function %s" transform))
11580 (setq txt (funcall transform table params))
11581 ;; Find the insertion place
11582 (save-excursion
11583 (goto-char (point-min))
11584 (unless (re-search-forward
11586 (error "Don't know where to insert translated table"))
11587 (goto-char (match-beginning 0))
11588 (beginning-of-line 2)
11589 (setq beg (point))
11590 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
11591 (error "Cannot find end of insertion region"))
11592 (beginning-of-line 1)
11593 (delete-region beg (point))
11594 (goto-char beg)
11596 (message "Table converted and installed at receiver location"))))
11598 (defun org-remove-by-index (list indices &optional i0)
11599 "Remove the elements in LIST with indices in INDICES.
11600 First element has index 0, or I0 if given."
11601 (if (not indices)
11602 list
11603 (if (integerp indices) (setq indices (list indices)))
11604 (setq i0 (1- (or i0 0)))
11605 (delq :rm (mapcar (lambda (x)
11606 (setq i0 (1+ i0))
11607 (if (memq i0 indices) :rm x))
11608 list))))
11610 (defun orgtbl-toggle-comment ()
11611 "Comment or uncomment the orgtbl at point."
11612 (interactive)
11613 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
11614 (re2 (concat "^" orgtbl-line-start-regexp))
11615 (commented (save-excursion (beginning-of-line 1)
11616 (cond ((looking-at re1) t)
11617 ((looking-at re2) nil)
11618 (t (error "Not at an org table")))))
11619 (re (if commented re1 re2))
11620 beg end)
11621 (save-excursion
11622 (beginning-of-line 1)
11623 (while (looking-at re) (beginning-of-line 0))
11624 (beginning-of-line 2)
11625 (setq beg (point))
11626 (while (looking-at re) (beginning-of-line 2))
11627 (setq end (point)))
11628 (comment-region beg end (if commented '(4) nil))))
11630 (defun orgtbl-insert-radio-table ()
11631 "Insert a radio table template appropriate for this major mode."
11632 (interactive)
11633 (let* ((e (assq major-mode orgtbl-radio-table-templates))
11634 (txt (nth 1 e))
11635 name pos)
11636 (unless e (error "No radio table setup defined for %s" major-mode))
11637 (setq name (read-string "Table name: "))
11638 (while (string-match "%n" txt)
11639 (setq txt (replace-match name t t txt)))
11641 (setq pos (point))
11642 (insert txt)
11643 (goto-char pos)))
11645 (defun org-get-param (params header i sym &optional hsym)
11646 "Get parameter value for symbol SYM.
11647 If this is a header line, actually get the value for the symbol with an
11649 If the value is a protperty list, get the element for the current column.
11650 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
11651 (let ((val (plist-get params sym)))
11652 (and hsym header (setq val (or (plist-get params hsym) val)))
11653 (if (consp val) (plist-get val i) val)))
11655 (defun orgtbl-to-generic (table params)
11656 "Convert the orgtbl-mode TABLE to some other format.
11657 This generic routine can be used for many standard cases.
11658 TABLE is a list, each entry either the symbol `hline' for a horizontal
11659 separator line, or a list of fields for that line.
11660 PARAMS is a property list of parameters that can influence the conversion.
11661 For the generic converter, some parameters are obligatory: You need to
11662 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
11663 :splice, you must have :tstart and :tend.
11665 Valid parameters are
11667 :tstart String to start the table. Ignored when :splice is t.
11668 :tend String to end the table. Ignored when :splice is t.
11670 :splice When set to t, return only table body lines, don't wrap
11671 them into :tstart and :tend. Default is nil.
11673 :hline String to be inserted on horizontal separation lines.
11674 May be nil to ignore hlines.
11676 :lstart String to start a new table line.
11677 :lend String to end a table line
11678 :sep Separator between two fields
11679 :lfmt Format for entire line, with enough %s to capture all fields.
11680 If this is present, :lstart, :lend, and :sep are ignored.
11681 :fmt A format to be used to wrap the field, should contain
11682 %s for the original field value. For example, to wrap
11684 This may also be a property list with column numbers and
11687 :hlstart :hlend :hlsep :hlfmt :hfmt
11688 Same as above, specific for the header lines in the table.
11689 All lines before the first hline are treated as header.
11690 If any of these is not present, the data line value is used.
11692 :efmt Use this format to print numbers with exponentials.
11693 The format should have %s twice for inserting mantissa
11695 may also be a property list with column numbers and
11696 formats. :fmt will still be applied after :efmt.
11698 In addition to this, the parameters :skip and :skipcols are always handled
11699 directly by `orgtbl-send-table'. See manual."
11700 (interactive)
11701 (let* ((p params)
11702 (splicep (plist-get p :splice))
11703 (hline (plist-get p :hline))
11704 rtn line i fm efm lfmt h)
11706 ;; Do we have a header?
11707 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11708 (setq h t))
11710 ;; Put header
11711 (unless splicep
11712 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11714 ;; Now loop over all lines
11715 (while (setq line (pop table))
11716 (if (eq line 'hline)
11717 ;; A horizontal separator line
11718 (progn (if hline (push hline rtn))
11719 (setq h nil)) ; no longer in header
11720 ;; A normal line. Convert the fields, push line onto the result list
11721 (setq i 0)
11722 (setq line
11723 (mapcar
11724 (lambda (f)
11725 (setq i (1+ i)
11726 fm (org-get-param p h i :fmt :hfmt)
11727 efm (org-get-param p h i :efmt))
11728 (if (and efm (string-match orgtbl-exp-regexp f))
11729 (setq f (format
11730 efm (match-string 1 f) (match-string 2 f))))
11731 (if fm (setq f (format fm f)))
11732 f)
11733 line))
11734 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11735 (push (apply 'format lfmt line) rtn)
11736 (push (concat
11737 (org-get-param p h i :lstart :hlstart)
11738 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11739 (org-get-param p h i :lend :hlend))
11740 rtn))))
11742 (unless splicep
11743 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11747 (defun orgtbl-to-latex (table params)
11748 "Convert the orgtbl-mode TABLE to LaTeX.
11749 TABLE is a list, each entry either the symbol `hline' for a horizontal
11750 separator line, or a list of fields for that line.
11751 PARAMS is a property list of parameters that can influence the conversion.
11752 Supports all parameters from `orgtbl-to-generic'. Most important for
11753 LaTeX are:
11755 :splice When set to t, return only table body lines, don't wrap
11756 them into a tabular environment. Default is nil.
11758 :fmt A format to be used to wrap the field, should contain %s for the
11759 original field value. For example, to wrap everything in dollars,
11763 :efmt Format for transforming numbers with exponentials. The format
11764 should have %s twice for inserting mantissa and exponent, for
11766 This may also be a property list with column numbers and formats.
11768 The general parameters :skip and :skipcols have already been applied when
11769 this function is called."
11770 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11771 org-table-last-alignment ""))
11772 (params2
11773 (list
11778 (orgtbl-to-generic table (org-combine-plists params2 params))))
11780 (defun orgtbl-to-html (table params)
11781 "Convert the orgtbl-mode TABLE to LaTeX.
11782 TABLE is a list, each entry either the symbol `hline' for a horizontal
11783 separator line, or a list of fields for that line.
11784 PARAMS is a property list of parameters that can influence the conversion.
11785 Currently this function recognizes the following parameters:
11787 :splice When set to t, return only table body lines, don't wrap
11788 them into a <table> environment. Default is nil.
11790 The general parameters :skip and :skipcols have already been applied when
11791 this function is called. The function does *not* use `orgtbl-to-generic',
11792 so you cannot specify parameters for it."
11793 (let* ((splicep (plist-get params :splice))
11794 html)
11795 ;; Just call the formatter we already have
11796 ;; We need to make text lines for it, so put the fields back together.
11797 (setq html (org-format-org-table-html
11798 (mapcar
11799 (lambda (x)
11800 (if (eq x 'hline)
11801 "|----+----|"
11802 (concat "| " (mapconcat 'identity x " | ") " |")))
11803 table)
11804 splicep))
11806 (setq html (replace-match "" t t html)))
11807 html))
11809 (defun orgtbl-to-texinfo (table params)
11810 "Convert the orgtbl-mode TABLE to TeXInfo.
11811 TABLE is a list, each entry either the symbol `hline' for a horizontal
11812 separator line, or a list of fields for that line.
11813 PARAMS is a property list of parameters that can influence the conversion.
11814 Supports all parameters from `orgtbl-to-generic'. Most important for
11815 TeXInfo are:
11817 :splice nil/t When set to t, return only table body lines, don't wrap
11818 them into a multitable environment. Default is nil.
11820 :fmt fmt A format to be used to wrap the field, should contain
11821 %s for the original field value. For example, to wrap
11823 This may also be a property list with column numbers and
11827 are computed automatically from the width of the columns
11828 under org-mode.
11830 The general parameters :skip and :skipcols have already been applied when
11831 this function is called."
11832 (let* ((total (float (apply '+ org-table-last-column-widths)))
11833 (colfrac (or (plist-get params :cf)
11834 (mapconcat
11835 (lambda (x) (format "%.3f" (/ (float x) total)))
11836 org-table-last-column-widths " ")))
11837 (params2
11838 (list
11839 :tstart (concat "@multitable @columnfractions " colfrac)
11840 :tend "@end multitable"
11841 :lstart "@item " :lend "" :sep " @tab "
11842 :hlstart "@headitem ")))
11843 (orgtbl-to-generic table (org-combine-plists params2 params))))
11845 ;;;; Link Stuff
11847 ;;; Link abbreviations
11849 (defun org-link-expand-abbrev (link)
11850 "Apply replacements as defined in `org-link-abbrev-alist."
11852 (let* ((key (match-string 1 link))
11853 (as (or (assoc key org-link-abbrev-alist-local)
11854 (assoc key org-link-abbrev-alist)))
11855 (tag (and (match-end 2) (match-string 3 link)))
11856 rpl)
11857 (if (not as)
11858 link
11859 (setq rpl (cdr as))
11860 (cond
11861 ((symbolp rpl) (funcall rpl tag))
11862 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11863 (t (concat rpl tag)))))
11864 link))
11866 ;;; Storing and inserting links
11868 (defvar org-insert-link-history nil
11869 "Minibuffer history for links inserted with `org-insert-link'.")
11871 (defvar org-stored-links nil
11872 "Contains the links stored with `org-store-link'.")
11874 (defvar org-store-link-plist nil
11875 "Plist with info about the most recently link created with `org-store-link'.")
11877 (defvar org-link-protocols nil
11878 "Link protocols added to Org-mode using `org-add-link-type'.")
11880 (defvar org-store-link-functions nil
11881 "List of functions that are called to create and store a link.
11882 Each function will be called in turn until one returns a non-nil
11883 value. Each function should check if it is responsible for creating
11884 this link (for example by looking at the major mode).
11885 If not, it must exit and return nil.
11886 If yes, it should return a non-nil value after a calling
11887 `org-store-link-props' with a list of properties and values.
11888 Special properties are:
11892 This is obligatory as well.
11893 :description Optional default description for the second pair
11894 of brackets in an Org-mode link. The user can still change
11895 this when inserting this link into an Org-mode buffer.
11897 In addition to these, any additional properties can be specified
11898 and then used in remember templates.")
11900 (defun org-add-link-type (type &optional follow publish)
11901 "Add TYPE to the list of `org-link-types'.
11902 Re-compute all regular expressions depending on `org-link-types'
11903 FOLLOW and PUBLISH are two functions. Both take the link path as
11904 an argument.
11905 FOLLOW should do whatever is necessary to follow the link, for example
11906 to find a file or display a mail message.
11908 PUBLISH takes the path and retuns the string that should be used when
11909 this document is published. FIMXE: This is actually not yet implemented."
11910 (add-to-list 'org-link-types type t)
11911 (org-make-link-regexps)
11912 (add-to-list 'org-link-protocols
11913 (list type follow publish)))
11915 (defun org-add-agenda-custom-command (entry)
11916 "Replace or add a command in `org-agenda-custom-commands'.
11917 This is mostly for hacking and trying a new command - once the command
11918 works you probably want to add it to `org-agenda-custom-commands' for good."
11919 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11920 (if ass
11921 (setcdr ass (cdr entry))
11922 (push entry org-agenda-custom-commands))))
11924 ;;;###autoload
11925 (defun org-store-link (arg)
11927 This link is added to `org-stored-links' and can later be inserted
11930 For some link types, a prefix arg is interpreted:
11931 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11932 For file links, arg negates `org-context-in-file-links'."
11933 (interactive "P")
11934 (setq org-store-link-plist nil) ; reset
11935 (let (link cpltxt desc description search txt)
11936 (cond
11938 ((run-hook-with-args-until-success 'org-store-link-functions)
11939 (setq link (plist-get org-store-link-plist :link)
11940 desc (or (plist-get org-store-link-plist :description) link)))
11942 ((eq major-mode 'bbdb-mode)
11943 (let ((name (bbdb-record-name (bbdb-current-record)))
11944 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11945 (setq cpltxt (concat "bbdb:" (or name company))
11946 link (org-make-link cpltxt))
11947 (org-store-link-props :type "bbdb" :name name :company company)))
11949 ((eq major-mode 'Info-mode)
11950 (setq link (org-make-link "info:"
11951 (file-name-nondirectory Info-current-file)
11952 ":" Info-current-node))
11953 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11954 ":" Info-current-node))
11955 (org-store-link-props :type "info" :file Info-current-file
11956 :node Info-current-node))
11958 ((eq major-mode 'calendar-mode)
11959 (let ((cd (calendar-cursor-to-date)))
11960 (setq link
11961 (format-time-string
11962 (car org-time-stamp-formats)
11963 (apply 'encode-time
11964 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11965 nil nil nil))))
11966 (org-store-link-props :type "calendar" :date cd)))
11968 ((or (eq major-mode 'vm-summary-mode)
11969 (eq major-mode 'vm-presentation-mode))
11970 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11971 (vm-follow-summary-cursor)
11972 (save-excursion
11973 (vm-select-folder-buffer)
11974 (let* ((message (car vm-message-pointer))
11975 (folder buffer-file-name)
11976 (subject (vm-su-subject message))
11977 (to (vm-get-header-contents message "To"))
11978 (from (vm-get-header-contents message "From"))
11979 (message-id (vm-su-message-id message)))
11980 (org-store-link-props :type "vm" :from from :to to :subject subject
11981 :message-id message-id)
11982 (setq message-id (org-remove-angle-brackets message-id))
11983 (setq folder (abbreviate-file-name folder))
11984 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11985 folder)
11986 (setq folder (replace-match "" t t folder)))
11987 (setq cpltxt (org-email-link-description))
11988 (setq link (org-make-link "vm:" folder "#" message-id)))))
11990 ((eq major-mode 'wl-summary-mode)
11991 (let* ((msgnum (wl-summary-message-number))
11992 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11993 msgnum 'message-id))
11994 (wl-message-entity
11995 (if (fboundp 'elmo-message-entity)
11996 (elmo-message-entity
11997 wl-summary-buffer-elmo-folder msgnum)
11998 (elmo-msgdb-overview-get-entity
11999 msgnum (wl-summary-buffer-msgdb))))
12000 (from (wl-summary-line-from))
12001 (to (car (elmo-message-entity-field wl-message-entity 'to)))
12002 (subject (let (wl-thr-indent-string wl-parent-message-entity)
12003 (wl-summary-line-subject))))
12004 (org-store-link-props :type "wl" :from from :to to
12005 :subject subject :message-id message-id)
12006 (setq message-id (org-remove-angle-brackets message-id))
12007 (setq cpltxt (org-email-link-description))
12008 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
12009 "#" message-id))))
12011 ((or (equal major-mode 'mh-folder-mode)
12012 (equal major-mode 'mh-show-mode))
12013 (let ((from (org-mhe-get-header "From:"))
12014 (to (org-mhe-get-header "To:"))
12015 (message-id (org-mhe-get-header "Message-Id:"))
12016 (subject (org-mhe-get-header "Subject:")))
12017 (org-store-link-props :type "mh" :from from :to to
12018 :subject subject :message-id message-id)
12019 (setq cpltxt (org-email-link-description))
12020 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
12021 (org-remove-angle-brackets message-id)))))
12023 ((or (eq major-mode 'rmail-mode)
12024 (eq major-mode 'rmail-summary-mode))
12025 (save-window-excursion
12026 (save-restriction
12027 (when (eq major-mode 'rmail-summary-mode)
12028 (rmail-show-message rmail-current-message))
12029 (rmail-narrow-to-non-pruned-header)
12030 (let ((folder buffer-file-name)
12031 (message-id (mail-fetch-field "message-id"))
12032 (from (mail-fetch-field "from"))
12033 (to (mail-fetch-field "to"))
12034 (subject (mail-fetch-field "subject")))
12035 (org-store-link-props
12036 :type "rmail" :from from :to to
12037 :subject subject :message-id message-id)
12038 (setq message-id (org-remove-angle-brackets message-id))
12039 (setq cpltxt (org-email-link-description))
12040 (setq link (org-make-link "rmail:" folder "#" message-id)))
12041 (rmail-show-message rmail-current-message))))
12043 ((eq major-mode 'gnus-group-mode)
12044 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
12045 (gnus-group-group-name)) ; version
12046 ((fboundp 'gnus-group-name)
12047 (gnus-group-name))
12048 (t "???"))))
12049 (unless group (error "Not on a group"))
12050 (org-store-link-props :type "gnus" :group group)
12051 (setq cpltxt (concat
12052 (if (org-xor arg org-usenet-links-prefer-google)
12053 "http://groups.google.com/groups?group="
12054 "gnus:")
12055 group)
12056 link (org-make-link cpltxt))))
12058 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
12059 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
12060 (let* ((group gnus-newsgroup-name)
12061 (article (gnus-summary-article-number))
12062 (header (gnus-summary-article-header article))
12063 (from (mail-header-from header))
12064 (message-id (mail-header-id header))
12065 (date (mail-header-date header))
12066 (subject (gnus-summary-subject-string)))
12067 (org-store-link-props :type "gnus" :from from :subject subject
12068 :message-id message-id :group group)
12069 (setq cpltxt (org-email-link-description))
12070 (if (org-xor arg org-usenet-links-prefer-google)
12071 (setq link
12072 (concat
12074 (format "http://groups.google.com/groups?as_umsgid=%s"
12075 (org-fixup-message-id-for-http message-id))))
12076 (setq link (org-make-link "gnus:" group
12077 "#" (number-to-string article))))))
12079 ((eq major-mode 'w3-mode)
12080 (setq cpltxt (url-view-url t)
12081 link (org-make-link cpltxt))
12082 (org-store-link-props :type "w3" :url (url-view-url t)))
12084 ((eq major-mode 'w3m-mode)
12085 (setq cpltxt (or w3m-current-title w3m-current-url)
12086 link (org-make-link w3m-current-url))
12087 (org-store-link-props :type "w3m" :url (url-view-url t)))
12089 ((setq search (run-hook-with-args-until-success
12090 'org-create-file-search-functions))
12091 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
12092 "::" search))
12093 (setq cpltxt (or description link)))
12095 ((eq major-mode 'image-mode)
12096 (setq cpltxt (concat "file:"
12097 (abbreviate-file-name buffer-file-name))
12098 link (org-make-link cpltxt))
12099 (org-store-link-props :type "image" :file buffer-file-name))
12101 ((eq major-mode 'dired-mode)
12102 ;; link to the file in the current line
12103 (setq cpltxt (concat "file:"
12104 (abbreviate-file-name
12105 (expand-file-name
12106 (dired-get-filename nil t))))
12107 link (org-make-link cpltxt)))
12109 ((and buffer-file-name (org-mode-p))
12110 ;; Just link to current headline
12111 (setq cpltxt (concat "file:"
12112 (abbreviate-file-name buffer-file-name)))
12113 ;; Add a context search string
12114 (when (org-xor org-context-in-file-links arg)
12115 ;; Check if we are on a target
12117 (setq cpltxt (concat cpltxt "::" (match-string 1)))
12118 (setq txt (cond
12119 ((org-on-heading-p) nil)
12120 ((org-region-active-p)
12121 (buffer-substring (region-beginning) (region-end)))
12122 (t (buffer-substring (point-at-bol) (point-at-eol)))))
12124 (setq cpltxt
12125 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12126 desc "NONE"))))
12128 (setq cpltxt (substring cpltxt 0 -2)))
12129 (setq link (org-make-link cpltxt)))
12131 ((buffer-file-name (buffer-base-buffer))
12132 ;; Just link to this file here.
12133 (setq cpltxt (concat "file:"
12134 (abbreviate-file-name
12135 (buffer-file-name (buffer-base-buffer)))))
12136 ;; Add a context string
12137 (when (org-xor org-context-in-file-links arg)
12138 (setq txt (if (org-region-active-p)
12139 (buffer-substring (region-beginning) (region-end))
12140 (buffer-substring (point-at-bol) (point-at-eol))))
12141 ;; Only use search option if there is some text.
12143 (setq cpltxt
12144 (concat cpltxt "::" (org-make-org-heading-search-string txt))
12145 desc "NONE")))
12146 (setq link (org-make-link cpltxt)))
12148 ((interactive-p)
12149 (error "Cannot link to a buffer which is not visiting a file"))
12151 (t (setq link nil)))
12153 (if (consp link) (setq cpltxt (car link) link (cdr link)))
12154 (setq link (or link cpltxt)
12155 desc (or desc cpltxt))
12156 (if (equal desc "NONE") (setq desc nil))
12158 (if (and (interactive-p) link)
12159 (progn
12160 (setq org-stored-links
12161 (cons (list link desc) org-stored-links))
12162 (message "Stored: %s" (or desc link)))
12163 (and link (org-make-link-string link desc)))))
12165 (defun org-store-link-props (&rest plist)
12166 "Store link properties, extract names and addresses."
12167 (let (x adr)
12168 (when (setq x (plist-get plist :from))
12169 (setq adr (mail-extract-address-components x))
12170 (plist-put plist :fromname (car adr))
12171 (plist-put plist :fromaddress (nth 1 adr)))
12172 (when (setq x (plist-get plist :to))
12173 (setq adr (mail-extract-address-components x))
12174 (plist-put plist :toname (car adr))
12175 (plist-put plist :toaddress (nth 1 adr))))
12176 (let ((from (plist-get plist :from))
12177 (to (plist-get plist :to)))
12178 (when (and from to org-from-is-user-regexp)
12179 (plist-put plist :fromto
12180 (if (string-match org-from-is-user-regexp from)
12181 (concat "to %t")
12182 (concat "from %f")))))
12183 (setq org-store-link-plist plist))
12185 (defun org-email-link-description (&optional fmt)
12186 "Return the description part of an email link.
12187 This takes information from `org-store-link-plist' and formats it
12188 according to FMT (default from `org-email-link-description-format')."
12189 (setq fmt (or fmt org-email-link-description-format))
12190 (let* ((p org-store-link-plist)
12191 (to (plist-get p :toaddress))
12192 (from (plist-get p :fromaddress))
12193 (table
12194 (list
12195 (cons "%c" (plist-get p :fromto))
12196 (cons "%F" (plist-get p :from))
12197 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
12198 (cons "%T" (plist-get p :to))
12199 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
12200 (cons "%s" (plist-get p :subject))
12201 (cons "%m" (plist-get p :message-id)))))
12202 (when (string-match "%c" fmt)
12203 ;; Check if the user wrote this message
12204 (if (and org-from-is-user-regexp from to
12205 (save-match-data (string-match org-from-is-user-regexp from)))
12206 (setq fmt (replace-match "to %t" t t fmt))
12207 (setq fmt (replace-match "from %f" t t fmt))))
12208 (org-replace-escapes fmt table)))
12210 (defun org-make-org-heading-search-string (&optional string heading)
12211 "Make search string for STRING or current headline."
12212 (interactive)
12213 (let ((s (or string (org-get-heading))))
12214 (unless (and string (not heading))
12215 ;; We are using a headline, clean up garbage in there.
12216 (if (string-match org-todo-regexp s)
12217 (setq s (replace-match "" t t s)))
12219 (setq s (replace-match "" t t s)))
12220 (setq s (org-trim s))
12223 (setq s (replace-match "" t t s)))
12224 (while (string-match org-ts-regexp s)
12225 (setq s (replace-match "" t t s))))
12227 (setq s (replace-match " " t t s)))
12228 (or string (setq s (concat "*" s))) ; Add * for headlines
12231 (defun org-make-link (&rest strings)
12232 "Concatenate STRINGS."
12233 (apply 'concat strings))
12235 (defun org-make-link-string (link &optional description)
12236 "Make a link with brackets, consisting of LINK and DESCRIPTION."
12238 (error "Empty link"))
12239 (when (stringp description)
12240 ;; Remove brackets from the description, they are fatal.
12242 (setq description (replace-match "{" t t description)))
12244 (setq description (replace-match "}" t t description))))
12245 (when (equal (org-link-escape link) description)
12246 ;; No description needed, it is identical
12247 (setq description nil))
12248 (when (and (not description)
12249 (not (equal link (org-link-escape link))))
12250 (setq description link))
12251 (concat "[[" (org-link-escape link) "]"
12252 (if description (concat "[" description "]") "")
12253 "]"))
12255 (defconst org-link-escape-chars
12256 '((?\ . "%20")
12257 (?\[ . "%5B")
12258 (?\] . "%5D")
12269 (?\; . "%3B")
12270 (?? . "%3F")
12271 (?= . "%3D")
12272 (?+ . "%2B")
12273 )
12274 "Association list of escapes for some characters problematic in links.
12275 This is the list that is used for internal purposes.")
12277 (defconst org-link-escape-chars-browser
12278 '((?\ . "%20")) ; 32 for the SPC char
12279 "Association list of escapes for some characters problematic in links.
12280 This is the list that is used before handing over to the browser.")
12282 (defun org-link-escape (text &optional table)
12283 "Escape charaters in TEXT that are problematic for links."
12284 (setq table (or table org-link-escape-chars))
12285 (when text
12286 (let ((re (mapconcat (lambda (x) (regexp-quote
12287 (char-to-string (car x))))
12289 (while (string-match re text)
12290 (setq text
12291 (replace-match
12292 (cdr (assoc (string-to-char (match-string 0 text))
12293 table))
12294 t t text)))
12295 text)))
12297 (defun org-link-unescape (text &optional table)
12298 "Reverse the action of `org-link-escape'."
12299 (setq table (or table org-link-escape-chars))
12300 (when text
12301 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
12303 (while (string-match re text)
12304 (setq text
12305 (replace-match
12306 (char-to-string (car (rassoc (match-string 0 text) table)))
12307 t t text)))
12308 text)))
12310 (defun org-xor (a b)
12311 "Exclusive or."
12312 (if a (not b) b))
12314 (defun org-get-header (header)
12315 "Find a header field in the current buffer."
12316 (save-excursion
12317 (goto-char (point-min))
12318 (let ((case-fold-search t) s)
12319 (cond
12320 ((eq header 'from)
12322 (setq s (match-string 1)))
12324 (setq s (replace-match "" t t s)))
12325 (if (string-match "[<(].*" s)
12326 (setq s (replace-match "" t t s))))
12327 ((eq header 'message-id)
12329 (setq s (match-string 1))))
12330 ((eq header 'subject)
12332 (setq s (match-string 1)))))
12335 s)))
12338 (defun org-fixup-message-id-for-http (s)
12339 "Replace special characters in a message id, so it can be used in an http query."
12340 (while (string-match "<" s)
12341 (setq s (replace-match "%3C" t t s)))
12342 (while (string-match ">" s)
12343 (setq s (replace-match "%3E" t t s)))
12344 (while (string-match "@" s)
12345 (setq s (replace-match "%40" t t s)))
12346 s)
12348 ;;;###autoload
12349 (defun org-insert-link-global ()
12350 "Insert a link like Org-mode does.
12351 This command can be called in any mode to insert a link in Org-mode syntax."
12352 (interactive)
12353 (org-run-like-in-org-mode 'org-insert-link))
12355 (defun org-insert-link (&optional complete-file)
12356 "Insert a link. At the prompt, enter the link.
12358 Completion can be used to select a link previously stored with
12359 `org-store-link'. When the empty string is entered (i.e. if you just
12360 press RET at the prompt), the link defaults to the most recently
12361 stored link. As SPC triggers completion in the minibuffer, you need to
12362 use M-SPC or C-q SPC to force the insertion of a space character.
12364 You will also be prompted for a description, and if one is given, it will
12365 be displayed in the buffer instead of the link.
12367 If there is already a link at point, this command will allow you to edit link
12368 and description parts.
12371 selected using completion. The path to the file will be relative to
12372 the current directory if the file is in the current directory or a
12373 subdirectory. Otherwise, the link will be the absolute path as
12374 completed in the minibuffer (i.e. normally ~/path/to/file).
12377 is in the current directory or below.
12379 `org-keep-stored-link-after-insertion'."
12380 (interactive "P")
12381 (let* ((wcf (current-window-configuration))
12382 (region (if (org-region-active-p)
12383 (buffer-substring (region-beginning) (region-end))))
12384 (remove (and region (list (region-beginning) (region-end))))
12385 (desc region)
12386 tmphist ; byte-compile incorrectly complains about this
12387 link entry file)
12388 (cond
12389 ((org-in-regexp org-bracket-link-regexp 1)
12390 ;; We do have a link at point, and we are going to edit it.
12391 (setq remove (list (match-beginning 0) (match-end 0)))
12392 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
12393 (setq link (read-string "Link: "
12394 (org-link-unescape
12395 (org-match-string-no-properties 1)))))
12396 ((or (org-in-regexp org-angle-link-re)
12397 (org-in-regexp org-plain-link-re))
12398 ;; Convert to bracket link
12399 (setq remove (list (match-beginning 0) (match-end 0))
12400 link (read-string "Link: "
12401 (org-remove-angle-brackets (match-string 0)))))
12402 ((equal complete-file '(4))
12403 ;; Completing read for file names.
12404 (setq file (read-file-name "File: "))
12405 (let ((pwd (file-name-as-directory (expand-file-name ".")))
12406 (pwd1 (file-name-as-directory (abbreviate-file-name
12407 (expand-file-name ".")))))
12408 (cond
12409 ((equal complete-file '(16))
12410 (setq link (org-make-link
12411 "file:"
12412 (abbreviate-file-name (expand-file-name file)))))
12414 (setq link (org-make-link "file:" (match-string 1 file))))
12416 (expand-file-name file))
12417 (setq link (org-make-link
12418 "file:" (match-string 1 (expand-file-name file)))))
12419 (t (setq link (org-make-link "file:" file))))))
12420 (t
12421 ;; Read link, with completion for stored links.
12422 (with-output-to-temp-buffer "*Org Links*"
12424 (when org-stored-links
12426 (princ (mapconcat
12427 (lambda (x)
12428 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
12430 (let ((cw (selected-window)))
12431 (select-window (get-buffer-window "*Org Links*"))
12432 (shrink-window-if-larger-than-buffer)
12433 (setq truncate-lines t)
12434 (select-window cw))
12435 ;; Fake a link history, containing the stored links.
12436 (setq tmphist (append (mapcar 'car org-stored-links)
12437 org-insert-link-history))
12438 (unwind-protect
12439 (setq link (org-completing-read
12440 "Link: "
12441 (append
12442 (mapcar (lambda (x) (list (concat (car x) ":")))
12443 (append org-link-abbrev-alist-local org-link-abbrev-alist))
12444 (mapcar (lambda (x) (list (concat x ":")))
12445 org-link-types))
12446 nil nil nil
12447 'tmphist
12448 (or (car (car org-stored-links)))))
12449 (set-window-configuration wcf)
12450 (kill-buffer "*Org Links*"))
12451 (setq entry (assoc link org-stored-links))
12452 (or entry (push link org-insert-link-history))
12453 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
12454 (not org-keep-stored-link-after-insertion))
12455 (setq org-stored-links (delq (assoc link org-stored-links)
12456 org-stored-links)))
12457 (setq desc (or desc (nth 1 entry)))))
12459 (if (string-match org-plain-link-re link)
12460 ;; URL-like link, normalize the use of angular brackets.
12461 (setq link (org-make-link (org-remove-angle-brackets link))))
12463 ;; Check if we are linking to the current file with a search option
12464 ;; If yes, simplify the link by using only the search option.
12465 (when (and buffer-file-name
12467 (let* ((path (match-string 1 link))
12468 (case-fold-search nil)
12469 (search (match-string 2 link)))
12470 (save-match-data
12471 (if (equal (file-truename buffer-file-name) (file-truename path))
12472 ;; We are linking to this same file, with a search option
12473 (setq link search)))))
12475 ;; Check if we can/should use a relative path. If yes, simplify the link
12477 (let* ((path (match-string 1 link))
12478 (origpath path)
12479 (case-fold-search nil))
12480 (cond
12481 ((eq org-link-file-path-type 'absolute)
12482 (setq path (abbreviate-file-name (expand-file-name path))))
12483 ((eq org-link-file-path-type 'noabbrev)
12484 (setq path (expand-file-name path)))
12485 ((eq org-link-file-path-type 'relative)
12486 (setq path (file-relative-name path)))
12487 (t
12488 (save-match-data
12489 (if (string-match (concat "^" (regexp-quote
12490 (file-name-as-directory
12491 (expand-file-name "."))))
12492 (expand-file-name path))
12493 ;; We are linking a file with relative path name.
12494 (setq path (substring (expand-file-name path)
12495 (match-end 0)))))))
12496 (setq link (concat "file:" path))
12497 (if (equal desc origpath)
12498 (setq desc path))))
12500 (setq desc (read-string "Description: " desc))
12502 (if remove (apply 'delete-region remove))
12503 (insert (org-make-link-string link desc))))
12505 (defun org-completing-read (&rest args)
12506 (let ((minibuffer-local-completion-map
12507 (copy-keymap minibuffer-local-completion-map)))
12508 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
12509 (apply 'completing-read args)))
12511 ;;; Opening/following a link
12512 (defvar org-link-search-failed nil)
12514 (defun org-next-link ()
12515 "Move forward to the next link.
12516 If the link is in hidden text, expose it."
12517 (interactive)
12518 (when (and org-link-search-failed (eq this-command last-command))
12519 (goto-char (point-min))
12520 (message "Link search wrapped back to beginning of buffer"))
12521 (setq org-link-search-failed nil)
12522 (let* ((pos (point))
12523 (ct (org-context))
12524 (a (assoc :link ct)))
12525 (if a (goto-char (nth 2 a)))
12526 (if (re-search-forward org-any-link-re nil t)
12527 (progn
12528 (goto-char (match-beginning 0))
12529 (if (org-invisible-p) (org-show-context)))
12530 (goto-char pos)
12531 (setq org-link-search-failed t)
12532 (error "No further link found"))))
12534 (defun org-previous-link ()
12535 "Move backward to the previous link.
12536 If the link is in hidden text, expose it."
12537 (interactive)
12538 (when (and org-link-search-failed (eq this-command last-command))
12539 (goto-char (point-max))
12540 (message "Link search wrapped back to end of buffer"))
12541 (setq org-link-search-failed nil)
12542 (let* ((pos (point))
12543 (ct (org-context))
12544 (a (assoc :link ct)))
12545 (if a (goto-char (nth 1 a)))
12546 (if (re-search-backward org-any-link-re nil t)
12547 (progn
12548 (goto-char (match-beginning 0))
12549 (if (org-invisible-p) (org-show-context)))
12550 (goto-char pos)
12551 (setq org-link-search-failed t)
12552 (error "No further link found"))))
12554 (defun org-find-file-at-mouse (ev)
12555 "Open file link or URL at mouse."
12556 (interactive "e")
12557 (mouse-set-point ev)
12558 (org-open-at-point 'in-emacs))
12560 (defun org-open-at-mouse (ev)
12561 "Open file link or URL at mouse."
12562 (interactive "e")
12563 (mouse-set-point ev)
12564 (org-open-at-point))
12566 (defvar org-window-config-before-follow-link nil
12567 "The window configuration before following a link.
12568 This is saved in case the need arises to restore it.")
12570 (defvar org-open-link-marker (make-marker)
12571 "Marker pointing to the location where `org-open-at-point; was called.")
12573 ;;;###autoload
12574 (defun org-open-at-point-global ()
12575 "Follow a link like Org-mode does.
12576 This command can be called in any mode to follow a link that has
12577 Org-mode syntax."
12578 (interactive)
12579 (org-run-like-in-org-mode 'org-open-at-point))
12581 (defun org-open-at-point (&optional in-emacs)
12582 "Open link at or after point.
12583 If there is no link at point, this function will search forward up to
12584 the end of the current subtree.
12585 Normally, files will be opened by an appropriate application. If the
12586 optional argument IN-EMACS is non-nil, Emacs will visit the file."
12587 (interactive "P")
12588 (catch 'abort
12589 (move-marker org-open-link-marker (point))
12590 (setq org-window-config-before-follow-link (current-window-configuration))
12591 (org-remove-occur-highlights nil nil t)
12592 (if (org-at-timestamp-p t)
12593 (org-follow-timestamp-link)
12594 (let (type path link line search (pos (point)))
12595 (catch 'match
12596 (save-excursion
12598 (when (org-in-regexp org-bracket-link-regexp)
12599 (setq link (org-link-unescape (org-match-string-no-properties 1)))
12601 (setq link (replace-match " " t t link)))
12602 (setq link (org-link-expand-abbrev link))
12603 (if (string-match org-link-re-with-space2 link)
12604 (setq type (match-string 1 link) path (match-string 2 link))
12605 (setq type "thisfile" path link))
12606 (throw 'match t)))
12608 (when (get-text-property (point) 'org-linked-text)
12609 (setq type "thisfile"
12610 pos (if (get-text-property (1+ (point)) 'org-linked-text)
12611 (1+ (point)) (point))
12612 path (buffer-substring
12613 (previous-single-property-change pos 'org-linked-text)
12614 (next-single-property-change pos 'org-linked-text)))
12615 (throw 'match t))
12617 (save-excursion
12618 (when (or (org-in-regexp org-angle-link-re)
12619 (org-in-regexp org-plain-link-re))
12620 (setq type (match-string 1) path (match-string 2))
12621 (throw 'match t)))
12623 (setq type "tree-match"
12624 path (match-string 1))
12625 (throw 'match t))
12626 (save-excursion
12628 (setq type "tags"
12629 path (match-string 1))
12630 (while (string-match ":" path)
12631 (setq path (replace-match "+" t t path)))
12632 (throw 'match t))))
12633 (unless path
12634 (error "No link found"))
12635 ;; Remove any trailing spaces in path
12637 (setq path (replace-match "" t t path)))
12639 (cond
12641 ((assoc type org-link-protocols)
12642 (funcall (nth 1 (assoc type org-link-protocols)) path))
12644 ((equal type "mailto")
12645 (let ((cmd (car org-link-mailto-program))
12646 (args (cdr org-link-mailto-program)) args1
12647 (address path) (subject "") a)
12649 (setq address (match-string 1 path)
12650 subject (org-link-escape (match-string 2 path))))
12651 (while args
12652 (cond
12653 ((not (stringp (car args))) (push (pop args) args1))
12654 (t (setq a (pop args))
12655 (if (string-match "%a" a)
12656 (setq a (replace-match address t t a)))
12657 (if (string-match "%s" a)
12658 (setq a (replace-match subject t t a)))
12659 (push a args1))))
12660 (apply cmd (nreverse args1))))
12662 ((member type '("http" "https" "ftp" "news"))
12663 (browse-url (concat type ":" (org-link-escape
12664 path org-link-escape-chars-browser))))
12666 ((member type '("message"))
12667 (browse-url (concat type ":" path)))
12669 ((string= type "tags")
12670 (org-tags-view in-emacs path))
12671 ((string= type "thisfile")
12672 (if in-emacs
12673 (switch-to-buffer-other-window
12674 (org-get-buffer-for-internal-link (current-buffer)))
12675 (org-mark-ring-push))
12676 (let ((cmd `(org-link-search
12677 ,path
12678 ,(cond ((equal in-emacs '(4)) 'occur)
12679 ((equal in-emacs '(16)) 'org-occur)
12680 (t nil))
12681 ,pos)))
12682 (condition-case nil (eval cmd)
12683 (error (progn (widen) (eval cmd))))))
12685 ((string= type "tree-match")
12688 ((string= type "file")
12690 (setq line (string-to-number (match-string 1 path))
12691 path (substring path 0 (match-beginning 0)))
12693 (setq search (match-string 1 path)
12694 path (substring path 0 (match-beginning 0)))))
12695 (if (string-match "[*?{]" (file-name-nondirectory path))
12696 (dired path)
12697 (org-open-file path in-emacs line search)))
12699 ((string= type "news")
12700 (org-follow-gnus-link path))
12702 ((string= type "bbdb")
12703 (org-follow-bbdb-link path))
12705 ((string= type "info")
12706 (org-follow-info-link path))
12708 ((string= type "gnus")
12709 (let (group article)
12711 (error "Error in Gnus link"))
12712 (setq group (match-string 1 path)
12713 article (match-string 3 path))
12714 (org-follow-gnus-link group article)))
12716 ((string= type "vm")
12717 (let (folder article)
12719 (error "Error in VM link"))
12720 (setq folder (match-string 1 path)
12721 article (match-string 3 path))
12722 ;; in-emacs is the prefix arg, will be interpreted as read-only
12723 (org-follow-vm-link folder article in-emacs)))
12725 ((string= type "wl")
12726 (let (folder article)
12728 (error "Error in Wanderlust link"))
12729 (setq folder (match-string 1 path)
12730 article (match-string 3 path))
12731 (org-follow-wl-link folder article)))
12733 ((string= type "mhe")
12734 (let (folder article)
12736 (error "Error in MHE link"))
12737 (setq folder (match-string 1 path)
12738 article (match-string 3 path))
12739 (org-follow-mhe-link folder article)))
12741 ((string= type "rmail")
12742 (let (folder article)
12744 (error "Error in RMAIL link"))
12745 (setq folder (match-string 1 path)
12746 article (match-string 3 path))
12747 (org-follow-rmail-link folder article)))
12749 ((string= type "shell")
12750 (let ((cmd path))
12751 (if (or (not org-confirm-shell-link-function)
12752 (funcall org-confirm-shell-link-function
12754 (org-add-props cmd nil
12755 'face 'org-warning))))
12756 (progn
12757 (message "Executing %s" cmd)
12758 (shell-command cmd))
12759 (error "Abort"))))
12761 ((string= type "elisp")
12762 (let ((cmd path))
12763 (if (or (not org-confirm-elisp-link-function)
12764 (funcall org-confirm-elisp-link-function
12766 (org-add-props cmd nil
12767 'face 'org-warning))))
12768 (message "%s => %s" cmd (eval (read cmd)))
12769 (error "Abort"))))
12771 (t
12772 (browse-url-at-point)))))
12773 (move-marker org-open-link-marker nil)))
12775 ;;; File search
12777 (defvar org-create-file-search-functions nil
12778 "List of functions to construct the right search string for a file link.
12779 These functions are called in turn with point at the location to
12780 which the link should point.
12782 A function in the hook should first test if it would like to
12783 handle this file type, for example by checking the major-mode or
12784 the file extension. If it decides not to handle this file, it
12785 should just return nil to give other functions a chance. If it
12786 does handle the file, it must return the search string to be used
12787 when following the link. The search string will be part of the
12788 file link, given after a double colon, and `org-open-at-point'
12789 will automatically search for it. If special measures must be
12790 taken to make the search successful, another function should be
12791 added to the companion hook `org-execute-file-search-functions',
12792 which see.
12794 A function in this hook may also use `setq' to set the variable
12795 `description' to provide a suggestion for the descriptive text to
12796 be used for this link when it gets inserted into an Org-mode
12799 (defvar org-execute-file-search-functions nil
12800 "List of functions to execute a file search triggered by a link.
12802 Functions added to this hook must accept a single argument, the
12803 search string that was part of the file link, the part after the
12804 double colon. The function must first check if it would like to
12805 handle this search, for example by checking the major-mode or the
12806 file extension. If it decides not to handle this search, it
12807 should just return nil to give other functions a chance. If it
12808 does handle the search, it must return a non-nil value to keep
12809 other functions from trying.
12811 Each function can access the current prefix argument through the
12812 variable `current-prefix-argument'. Note that a single prefix is
12813 used to force opening a link in Emacs, so it may be good to only
12814 use a numeric or double prefix to guide the search function.
12816 In case this is needed, a function in this hook can also restore
12817 the window configuration before `org-open-at-point' was called using:
12819 (set-window-configuration org-window-config-before-follow-link)")
12821 (defun org-link-search (s &optional type avoid-pos)
12822 "Search for a link search option.
12823 If S is surrounded by forward slashes, it is interpreted as a
12824 regular expression. In org-mode files, this will create an `org-occur'
12825 sparse tree. In ordinary files, `occur' will be used to list matches.
12826 If the current buffer is in `dired-mode', grep will be used to search
12827 in all files. If AVOID-POS is given, ignore matches near that position."
12828 (let ((case-fold-search t)
12832 org-emphasis-alist)
12834 (pos (point))
12835 (pre "") (post "")
12836 words re0 re1 re2 re3 re4 re5 re2a reall)
12837 (cond
12838 ;; First check if there are any special
12839 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12840 ;; Now try the builtin stuff
12841 ((save-excursion
12842 (goto-char (point-min))
12843 (and
12844 (re-search-forward
12845 (concat "<<" (regexp-quote s0) ">>") nil t)
12846 (setq pos (match-beginning 0))))
12847 ;; There is an exact target for this
12848 (goto-char pos))
12850 ;; A regular expression
12851 (cond
12852 ((org-mode-p)
12853 (org-occur (match-string 1 s)))
12854 ;;((eq major-mode 'dired-mode)
12855 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12856 (t (org-do-occur (match-string 1 s)))))
12857 (t
12858 ;; A normal search strings
12859 (when (equal (string-to-char s) ?*)
12860 ;; Anchor on headlines, post may include tags.
12863 s (substring s 1)))
12864 (remove-text-properties
12865 0 (length s)
12866 '(face nil mouse-face nil keymap nil fontified nil) s)
12867 ;; Make a series of regular expressions to find a match
12874 re1 (concat pre re2 post)
12875 re3 (concat pre re4 post)
12876 re5 (concat pre ".*" re4)
12877 re2 (concat pre re2)
12878 re2a (concat pre re2a)
12879 re4 (concat pre re4)
12883 ))
12884 (cond
12885 ((eq type 'org-occur) (org-occur reall))
12886 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12887 (t (goto-char (point-min))
12888 (if (or (org-search-not-self 1 re0 nil t)
12889 (org-search-not-self 1 re1 nil t)
12890 (org-search-not-self 1 re2 nil t)
12891 (org-search-not-self 1 re2a nil t)
12892 (org-search-not-self 1 re3 nil t)
12893 (org-search-not-self 1 re4 nil t)
12894 (org-search-not-self 1 re5 nil t)
12895 )
12896 (goto-char (match-beginning 1))
12897 (goto-char pos)
12898 (error "No match")))))
12899 (t
12900 ;; Normal string-search
12901 (goto-char (point-min))
12902 (if (search-forward s nil t)
12903 (goto-char (match-beginning 0))
12904 (error "No match"))))
12905 (and (org-mode-p) (org-show-context 'link-search))))
12907 (defun org-search-not-self (group &rest args)
12908 "Execute `re-search-forward', but only accept matches that do not
12909 enclose the position of `org-open-link-marker'."
12910 (let ((m org-open-link-marker))
12911 (catch 'exit
12912 (while (apply 're-search-forward args)
12913 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12914 (goto-char (match-end group))
12915 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12916 (> (match-beginning 0) (marker-position m))
12917 (< (match-end 0) (marker-position m)))
12918 (save-match-data
12919 (or (not (org-in-regexp
12920 org-bracket-link-analytic-regexp 1))
12921 (not (match-end 4)) ; no description
12922 (and (<= (match-beginning 4) (point))
12923 (>= (match-end 4) (point))))))
12924 (throw 'exit (point))))))))
12926 (defun org-get-buffer-for-internal-link (buffer)
12927 "Return a buffer to be used for displaying the link target of internal links."
12928 (cond
12929 ((not org-display-internal-link-with-indirect-buffer)
12930 buffer)
12931 ((string-match "(Clone)$" (buffer-name buffer))
12932 (message "Buffer is already a clone, not making another one")
12933 ;; we also do not modify visibility in this case
12934 buffer)
12935 (t ; make a new indirect buffer for displaying the link
12936 (let* ((bn (buffer-name buffer))
12937 (ibn (concat bn "(Clone)"))
12938 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12939 (with-current-buffer ib (org-overview))
12940 ib))))
12942 (defun org-do-occur (regexp &optional cleanup)
12943 "Call the Emacs command `occur'.
12944 If CLEANUP is non-nil, remove the printout of the regular expression
12945 in the *Occur* buffer. This is useful if the regex is long and not useful
12946 to read."
12947 (occur regexp)
12948 (when cleanup
12949 (let ((cwin (selected-window)) win beg end)
12950 (when (setq win (get-buffer-window "*Occur*"))
12951 (select-window win))
12952 (goto-char (point-min))
12953 (when (re-search-forward "match[a-z]+" nil t)
12954 (setq beg (match-end 0))
12956 (setq end (1- (match-beginning 0)))))
12957 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12958 (goto-char (point-min))
12959 (select-window cwin))))
12961 ;;; The mark ring for links jumps
12963 (defvar org-mark-ring nil
12964 "Mark ring for positions before jumps in Org-mode.")
12965 (defvar org-mark-ring-last-goto nil
12966 "Last position in the mark ring used to go back.")
12967 ;; Fill and close the ring
12968 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12969 (loop for i from 1 to org-mark-ring-length do
12970 (push (make-marker) org-mark-ring))
12971 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12972 org-mark-ring)
12974 (defun org-mark-ring-push (&optional pos buffer)
12975 "Put the current position or POS into the mark ring and rotate it."
12976 (interactive)
12977 (setq pos (or pos (point)))
12978 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12979 (move-marker (car org-mark-ring)
12980 (or pos (point))
12981 (or buffer (current-buffer)))
12982 (message "%s"
12983 (substitute-command-keys
12986 (defun org-mark-ring-goto (&optional n)
12987 "Jump to the previous position in the mark ring.
12988 With prefix arg N, jump back that many stored positions. When
12989 called several times in succession, walk through the entire ring.
12990 Org-mode commands jumping to a different position in the current file,
12991 or to another Org-mode file, automatically push the old position
12992 onto the ring."
12993 (interactive "p")
12994 (let (p m)
12995 (if (eq last-command this-command)
12996 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12997 (setq p org-mark-ring))
12998 (setq org-mark-ring-last-goto p)
12999 (setq m (car p))
13000 (switch-to-buffer (marker-buffer m))
13001 (goto-char m)
13002 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
13004 (defun org-remove-angle-brackets (s)
13005 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
13006 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
13007 s)
13008 (defun org-add-angle-brackets (s)
13009 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
13010 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
13011 s)
13013 ;;; Following specific links
13015 (defun org-follow-timestamp-link ()
13016 (cond
13017 ((org-at-date-range-p t)
13018 (let ((org-agenda-start-on-weekday)
13019 (t1 (match-string 1))
13020 (t2 (match-string 2)))
13021 (setq t1 (time-to-days (org-time-string-to-time t1))
13022 t2 (time-to-days (org-time-string-to-time t2)))
13023 (org-agenda-list nil t1 (1+ (- t2 t1)))))
13024 ((org-at-timestamp-p t)
13025 (org-agenda-list nil (time-to-days (org-time-string-to-time
13026 (substring (match-string 1) 0 10)))
13027 1))
13028 (t (error "This should not happen"))))
13031 (defun org-follow-bbdb-link (name)
13032 "Follow a BBDB link to NAME."
13033 (require 'bbdb)
13034 (let ((inhibit-redisplay (not debug-on-error))
13035 (bbdb-electric-p nil))
13036 (catch 'exit
13037 ;; Exact match on name
13039 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13040 ;; Exact match on name
13042 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13043 ;; Partial match on name
13044 (bbdb-name name nil)
13045 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13046 ;; Partial match on company
13047 (bbdb-company name nil)
13048 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
13049 ;; General match including network address and notes
13050 (bbdb name nil)
13051 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
13052 (delete-window (get-buffer-window "*BBDB*"))
13053 (error "No matching BBDB record")))))
13055 (defun org-follow-info-link (name)
13056 "Follow an info file & node link to NAME."
13059 (progn
13060 (require 'info)
13061 (if (match-string 2 name) ; If there isn't a node, choose "Top"
13062 (Info-find-node (match-string 1 name) (match-string 2 name))
13063 (Info-find-node (match-string 1 name) "Top")))
13064 (message "Could not open: %s" name)))
13066 (defun org-follow-gnus-link (&optional group article)
13067 "Follow a Gnus link to GROUP and ARTICLE."
13068 (require 'gnus)
13069 (funcall (cdr (assq 'gnus org-link-frame-setup)))
13070 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
13071 (cond ((and group article)
13072 (gnus-group-read-group 1 nil group)
13073 (gnus-summary-goto-article (string-to-number article) nil t))
13074 (group (gnus-group-jump-to-group group))))
13076 (defun org-follow-vm-link (&optional folder article readonly)
13077 "Follow a VM link to FOLDER and ARTICLE."
13078 (require 'vm)
13079 (setq article (org-add-angle-brackets article))
13081 ;; ange-ftp or efs or tramp access
13082 (let ((user (or (match-string 1 folder) (user-login-name)))
13083 (host (match-string 2 folder))
13084 (file (match-string 3 folder)))
13085 (cond
13086 ((featurep 'tramp)
13087 ;; use tramp to access the file
13088 (if (featurep 'xemacs)
13089 (setq folder (format "[%s@%s]%s" user host file))
13090 (setq folder (format "/%s@%s:%s" user host file))))
13091 (t
13092 ;; use ange-ftp or efs
13093 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
13094 (setq folder (format "/%s@%s:%s" user host file))))))
13095 (when folder
13096 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
13097 (sit-for 0.1)
13098 (when article
13099 (vm-select-folder-buffer)
13100 (widen)
13101 (let ((case-fold-search t))
13102 (goto-char (point-min))
13103 (if (not (re-search-forward
13104 (concat "^" "message-id: *" (regexp-quote article))))
13105 (error "Could not find the specified message in this folder"))
13106 (vm-isearch-update)
13107 (vm-isearch-narrow)
13108 (vm-beginning-of-message)
13109 (vm-summarize)))))
13111 (defun org-follow-wl-link (folder article)
13112 "Follow a Wanderlust link to FOLDER and ARTICLE."
13113 (if (and (string= folder "%")
13114 article
13116 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
13117 ;; Thus, we recompose folder and article ids.
13118 (setq folder (format "%s#%s" folder (match-string 1 article))
13119 article (match-string 3 article)))
13120 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
13121 (error "No such folder: %s" folder))
13122 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
13123 (and article
13124 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
13125 (wl-summary-redisplay)))
13127 (defun org-follow-rmail-link (folder article)
13128 "Follow an RMAIL link to FOLDER and ARTICLE."
13129 (setq article (org-add-angle-brackets article))
13130 (let (message-number)
13131 (save-excursion
13132 (save-window-excursion
13133 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13134 (setq message-number
13135 (save-restriction
13136 (widen)
13137 (goto-char (point-max))
13138 (if (re-search-backward
13140 (or article "")))
13141 nil t)
13142 (rmail-what-message))))))
13143 (if message-number
13144 (progn
13145 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
13146 (rmail-show-message message-number)
13147 message-number)
13148 (error "Message not found"))))
13150 ;;; mh-e integration based on planner-mode
13151 (defun org-mhe-get-message-real-folder ()
13152 "Return the name of the current message real folder, so if you use
13153 sequences, it will now work."
13154 (save-excursion
13155 (let* ((folder
13156 (if (equal major-mode 'mh-folder-mode)
13157 mh-current-folder
13158 ;; Refer to the show buffer
13159 mh-show-folder-buffer))
13160 (end-index
13161 (if (boundp 'mh-index-folder)
13162 (min (length mh-index-folder) (length folder))))
13163 )
13164 ;; a simple test on mh-index-data does not work, because
13165 ;; mh-index-data is always nil in a show buffer.
13166 (if (and (boundp 'mh-index-folder)
13167 (string= mh-index-folder (substring folder 0 end-index)))
13168 (if (equal major-mode 'mh-show-mode)
13169 (save-window-excursion
13170 (let (pop-up-frames)
13171 (when (buffer-live-p (get-buffer folder))
13172 (progn
13173 (pop-to-buffer folder)
13174 (org-mhe-get-message-folder-from-index)
13175 )
13176 )))
13177 (org-mhe-get-message-folder-from-index)
13178 )
13179 folder
13180 )
13181 )))
13183 (defun org-mhe-get-message-folder-from-index ()
13184 "Returns the name of the message folder in a index folder buffer."
13185 (save-excursion
13186 (mh-index-previous-folder)
13188 (message "%s" (match-string 1))))
13190 (defun org-mhe-get-message-folder ()
13191 "Return the name of the current message folder. Be careful if you
13192 use sequences."
13193 (save-excursion
13194 (if (equal major-mode 'mh-folder-mode)
13195 mh-current-folder
13196 ;; Refer to the show buffer
13197 mh-show-folder-buffer)))
13199 (defun org-mhe-get-message-num ()
13200 "Return the number of the current message. Be careful if you
13201 use sequences."
13202 (save-excursion
13203 (if (equal major-mode 'mh-folder-mode)
13204 (mh-get-msg-num nil)
13205 ;; Refer to the show buffer
13206 (mh-show-buffer-message-number))))
13208 (defun org-mhe-get-header (header)
13209 "Return a header of the message in folder mode. This will create a
13210 show buffer for the corresponding message. If you have a more clever
13211 idea..."
13212 (let* ((folder (org-mhe-get-message-folder))
13213 (num (org-mhe-get-message-num))
13214 (buffer (get-buffer-create (concat "show-" folder)))
13215 (header-field))
13216 (with-current-buffer buffer
13217 (mh-display-msg num folder)
13218 (if (equal major-mode 'mh-folder-mode)
13219 (mh-header-display)
13220 (mh-show-header-display))
13221 (set-buffer buffer)
13222 (setq header-field (mh-get-header-field header))
13223 (if (equal major-mode 'mh-folder-mode)
13224 (mh-show)
13225 (mh-show-show))
13226 header-field)))
13228 (defun org-follow-mhe-link (folder article)
13229 "Follow an MHE link to FOLDER and ARTICLE.
13230 If ARTICLE is nil FOLDER is shown. If the configuration variable
13231 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
13232 ARTICLE is searched in all folders. Indexed searches (swish++,
13233 namazu, and others supported by MH-E) will always search in all
13234 folders."
13235 (require 'mh-e)
13236 (require 'mh-search)
13237 (require 'mh-utils)
13238 (mh-find-path)
13239 (if (not article)
13240 (mh-visit-folder (mh-normalize-folder-name folder))
13241 (setq article (org-add-angle-brackets article))
13242 (mh-search-choose)
13243 (if (equal mh-searcher 'pick)
13244 (progn
13245 (mh-search folder (list "--message-id" article))
13246 (when (and org-mhe-search-all-folders
13247 (not (org-mhe-get-message-real-folder)))
13248 (kill-this-buffer)
13249 (mh-search "+" (list "--message-id" article))))
13250 (mh-search "+" article))
13251 (if (org-mhe-get-message-real-folder)
13252 (mh-show-msg 1)
13253 (kill-this-buffer)
13254 (error "Message not found"))))
13256 ;;; BibTeX links
13258 ;; Use the custom search meachnism to construct and use search strings for
13259 ;; file links to BibTeX database entries.
13261 (defun org-create-file-search-in-bibtex ()
13262 "Create the search string and description for a BibTeX database entry."
13263 (when (eq major-mode 'bibtex-mode)
13264 ;; yes, we want to construct this search string.
13265 ;; Make a good description for this entry, using names, year and the title
13266 ;; Put it into the `description' variable which is dynamically scoped.
13267 (let ((bibtex-autokey-names 1)
13268 (bibtex-autokey-names-stretch 1)
13269 (bibtex-autokey-name-case-convert-function 'identity)
13270 (bibtex-autokey-name-separator " & ")
13271 (bibtex-autokey-additional-names " et al.")
13272 (bibtex-autokey-year-length 4)
13273 (bibtex-autokey-name-year-separator " ")
13274 (bibtex-autokey-titlewords 3)
13275 (bibtex-autokey-titleword-separator " ")
13276 (bibtex-autokey-titleword-case-convert-function 'identity)
13277 (bibtex-autokey-titleword-length 'infty)
13278 (bibtex-autokey-year-title-separator ": "))
13279 (setq description (bibtex-generate-autokey)))
13280 ;; Now parse the entry, get the key and return it.
13281 (save-excursion
13282 (bibtex-beginning-of-entry)
13283 (cdr (assoc "=key=" (bibtex-parse-entry))))))
13285 (defun org-execute-file-search-in-bibtex (s)
13286 "Find the link search string S as a key for a database entry."
13287 (when (eq major-mode 'bibtex-mode)
13288 ;; Yes, we want to do the search in this file.
13289 ;; We construct a regexp that searches for "@entrytype{" followed by the key
13290 (goto-char (point-min))
13293 (goto-char (match-beginning 0)))
13294 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
13295 ;; Use double prefix to indicate that any web link should be browsed
13296 (let ((b (current-buffer)) (p (point)))
13297 ;; Restore the window configuration because we just use the web link
13298 (set-window-configuration org-window-config-before-follow-link)
13299 (save-excursion (set-buffer b) (goto-char p)
13300 (bibtex-url)))
13301 (recenter 0)) ; Move entry start to beginning of window
13302 ;; return t to indicate that the search is done.
13303 t))
13305 ;; Finally add the functions to the right hooks.
13306 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
13307 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
13309 ;; end of Bibtex link setup
13311 ;;; Following file links
13313 (defun org-open-file (path &optional in-emacs line search)
13314 "Open the file at PATH.
13315 First, this expands any special file name abbreviations. Then the
13316 configuration variable `org-file-apps' is checked if it contains an
13317 entry for this file type, and if yes, the corresponding command is launched.
13318 If no application is found, Emacs simply visits the file.
13319 With optional argument IN-EMACS, Emacs will visit the file.
13320 Optional LINE specifies a line to go to, optional SEARCH a string to
13321 search for. If LINE or SEARCH is given, the file will always be
13322 opened in Emacs.
13323 If the file does not exist, an error is thrown."
13324 (setq in-emacs (or in-emacs line search))
13325 (let* ((file (if (equal path "")
13326 buffer-file-name
13327 (substitute-in-file-name (expand-file-name path))))
13328 (apps (append org-file-apps (org-default-apps)))
13329 (remp (and (assq 'remote apps) (org-file-remote-p file)))
13330 (dirp (if remp nil (file-directory-p file)))
13331 (dfile (downcase file))
13332 (old-buffer (current-buffer))
13333 (old-pos (point))
13334 (old-mode major-mode)
13335 ext cmd)
13337 (setq ext (match-string 1 dfile))
13339 (setq ext (match-string 1 dfile))))
13340 (if in-emacs
13341 (setq cmd 'emacs)
13342 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
13343 (and dirp (cdr (assoc 'directory apps)))
13344 (cdr (assoc ext apps))
13345 (cdr (assoc t apps)))))
13346 (when (eq cmd 'mailcap)
13347 (require 'mailcap)
13348 (mailcap-parse-mailcaps)
13349 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
13350 (command (mailcap-mime-info mime-type)))
13351 (if (stringp command)
13352 (setq cmd command)
13353 (setq cmd 'emacs))))
13354 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
13355 (not (file-exists-p file))
13356 (not org-open-non-existing-files))
13357 (error "No such file: %s" file))
13358 (cond
13360 ;; Remove quotes around the file name - we'll use shell-quote-argument.
13362 (setq cmd (replace-match "%s" t t cmd)))
13363 (while (string-match "%s" cmd)
13364 (setq cmd (replace-match
13365 (save-match-data (shell-quote-argument file))
13366 t t cmd)))
13367 (save-window-excursion
13368 (start-process-shell-command cmd nil cmd)))
13369 ((or (stringp cmd)
13370 (eq cmd 'emacs))
13371 (funcall (cdr (assq 'file org-link-frame-setup)) file)
13372 (widen)
13373 (if line (goto-line line)
13374 (if search (org-link-search search))))
13375 ((consp cmd)
13376 (eval cmd))
13377 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
13378 (and (org-mode-p) (eq old-mode 'org-mode)
13379 (or (not (equal old-buffer (current-buffer)))
13380 (not (equal old-pos (point))))
13381 (org-mark-ring-push old-pos old-buffer))))
13383 (defun org-default-apps ()
13384 "Return the default applications for this operating system."
13385 (cond
13386 ((eq system-type 'darwin)
13387 org-file-apps-defaults-macosx)
13388 ((eq system-type 'windows-nt)
13389 org-file-apps-defaults-windowsnt)
13390 (t org-file-apps-defaults-gnu)))
13392 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
13393 (defun org-file-remote-p (file)
13394 "Test whether FILE specifies a location on a remote system.
13395 Return non-nil if the location is indeed remote.
13399 (cond ((fboundp 'file-remote-p)
13400 (file-remote-p file))
13401 ((fboundp 'tramp-handle-file-remote-p)
13402 (tramp-handle-file-remote-p file))
13403 ((and (boundp 'ange-ftp-name-format)
13404 (string-match (car ange-ftp-name-format) file))
13405 t)
13406 (t nil)))
13409 ;;;; Hooks for remember.el, and refiling
13411 (defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
13412 (defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
13414 ;;;###autoload
13415 (defun org-remember-insinuate ()
13416 "Setup remember.el for use wiht Org-mode."
13417 (require 'remember)
13418 (setq remember-annotation-functions '(org-remember-annotation))
13419 (setq remember-handler-functions '(org-remember-handler))
13420 (add-hook 'remember-mode-hook 'org-remember-apply-template))
13422 ;;;###autoload
13423 (defun org-remember-annotation ()
13424 "Return a link to the current location as an annotation for remember.el.
13425 If you are using Org-mode files as target for data storage with
13426 remember.el, then the annotations should include a link compatible with the
13427 conventions in Org-mode. This function returns such a link."
13428 (org-store-link nil))
13430 (defconst org-remember-help
13431 "Select a destination location for the note.
13432 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
13433 RET on headline -> Store as sublevel entry to current headline
13434 RET at beg-of-buf -> Append to file as level 2 headline
13435 <left>/<right> -> before/after current headline, same headings level")
13437 (defvar org-remember-previous-location nil)
13438 (defvar org-force-remember-template-char) ;; dynamically scoped
13440 (defun org-select-remember-template (&optional use-char)
13441 (when org-remember-templates
13442 (let* ((templates (mapcar (lambda (x)
13443 (if (stringp (car x))
13444 (append (list (nth 1 x) (car x)) (cddr x))
13445 (append (list (car x) "") (cdr x))))
13446 org-remember-templates))
13447 (char (or use-char
13448 (cond
13449 ((= (length templates) 1)
13450 (caar templates))
13451 ((and (boundp 'org-force-remember-template-char)
13452 org-force-remember-template-char)
13453 (if (stringp org-force-remember-template-char)
13454 (string-to-char org-force-remember-template-char)
13455 org-force-remember-template-char))
13456 (t
13457 (message "Select template: %s"
13458 (mapconcat
13459 (lambda (x)
13460 (cond
13462 (format "[%c]" (car x)))
13463 ((equal (downcase (car x))
13464 (downcase (aref (nth 1 x) 0)))
13465 (format "[%c]%s" (car x)
13466 (substring (nth 1 x) 1)))
13467 (t (format "[%c]%s" (car x) (nth 1 x)))))
13468 templates " "))
13469 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
13470 (when (equal char0 ?\C-g)
13471 (jump-to-register remember-register)
13472 (kill-buffer remember-buffer))
13473 char0))))))
13474 (cddr (assoc char templates)))))
13476 (defvar x-last-selected-text)
13477 (defvar x-last-selected-text-primary)
13479 ;;;###autoload
13480 (defun org-remember-apply-template (&optional use-char skip-interactive)
13481 "Initialize *remember* buffer with template, invoke `org-mode'.
13482 This function should be placed into `remember-mode-hook' and in fact requires
13483 to be run from that hook to function properly."
13484 (if org-remember-templates
13485 (let* ((entry (org-select-remember-template use-char))
13486 (tpl (car entry))
13487 (plist-p (if org-store-link-plist t nil))
13488 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
13490 (nth 1 entry)
13491 org-default-notes-file))
13492 (headline (nth 2 entry))
13493 (v-c (or (and (eq window-system 'x)
13494 (fboundp 'x-cut-buffer-or-selection-value)
13495 (x-cut-buffer-or-selection-value))
13496 (org-bound-and-true-p x-last-selected-text)
13497 (org-bound-and-true-p x-last-selected-text-primary)
13498 (and (> (length kill-ring) 0) (current-kill 0))))
13499 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
13500 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
13501 (v-u (concat "[" (substring v-t 1 -1) "]"))
13502 (v-U (concat "[" (substring v-T 1 -1) "]"))
13503 ;; `initial' and `annotation' are bound in `remember'
13504 (v-i (if (boundp 'initial) initial))
13505 (v-a (if (and (boundp 'annotation) annotation)
13506 (if (equal annotation "[[]]") "" annotation)
13507 ""))
13508 (v-A (if (and v-a
13511 v-a))
13512 (v-n user-full-name)
13513 (org-startup-folded nil)
13514 org-time-was-given org-end-time-was-given x
13515 prompt completions char time pos default histvar)
13516 (setq org-store-link-plist
13517 (append (list :annotation v-a :initial v-i)
13518 org-store-link-plist))
13519 (unless tpl (setq tpl "") (message "No template") (ding) (sit-for 1))
13520 (erase-buffer)
13521 (insert (substitute-command-keys
13522 (format
13523 "## Filing location: Select interactively, default, or last used:
13524 ## %s to select file and header location interactively.
13528 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
13529 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
13530 (abbreviate-file-name (or file org-default-notes-file))
13531 (or headline "")
13532 (or (car org-remember-previous-location) "???")
13533 (or (cdr org-remember-previous-location) "???"))))
13534 (insert tpl) (goto-char (point-min))
13535 ;; Simple %-escapes
13537 (when (and initial (equal (match-string 0) "%i"))
13538 (save-match-data
13539 (let* ((lead (buffer-substring
13540 (point-at-bol) (match-beginning 0))))
13541 (setq v-i (mapconcat 'identity
13544 (replace-match
13545 (or (eval (intern (concat "v-" (match-string 1)))) "")
13546 t t))
13548 ;; %[] Insert contents of a file.
13549 (goto-char (point-min))
13551 (let ((start (match-beginning 0))
13552 (end (match-end 0))
13553 (filename (expand-file-name (match-string 1))))
13554 (goto-char start)
13555 (delete-region start end)
13556 (condition-case error
13557 (insert-file-contents filename)
13558 (error (insert (format "%%![Couldn't insert %s: %s]"
13559 filename error))))))
13560 ;; %() embedded elisp
13561 (goto-char (point-min))
13563 (goto-char (match-beginning 0))
13564 (let ((template-start (point)))
13565 (forward-char 1)
13566 (let ((result
13567 (condition-case error
13568 (eval (read (current-buffer)))
13569 (error (format "%%![Error: %s]" error)))))
13570 (delete-region template-start (point))
13571 (insert result))))
13573 ;; From the property list
13574 (when plist-p
13575 (goto-char (point-min))
13577 (and (setq x (or (plist-get org-store-link-plist
13578 (intern (match-string 1))) ""))
13579 (replace-match x t t))))
13581 ;; Turn on org-mode in the remember buffer, set local variables
13582 (org-mode)
13583 (org-set-local 'org-finish-function 'org-remember-finalize)
13585 (org-set-local 'org-default-notes-file file))
13587 (org-set-local 'org-remember-default-headline headline))
13588 ;; Interactive template entries
13589 (goto-char (point-min))
13591 (setq char (if (match-end 3) (match-string 3))
13592 prompt (if (match-end 2) (match-string 2)))
13593 (goto-char (match-beginning 0))
13594 (replace-match "")
13595 (setq completions nil default nil)
13596 (when prompt
13597 (setq completions (org-split-string prompt "|")
13598 prompt (pop completions)
13599 default (car completions)
13600 histvar (intern (concat
13601 "org-remember-template-prompt-history::"
13602 (or prompt "")))
13603 completions (mapcar 'list completions)))
13604 (cond
13605 ((member char '("G" "g"))
13606 (let* ((org-last-tags-completion-table
13607 (org-global-tags-completion-table
13608 (if (equal char "G") (org-agenda-files) (and file (list file)))))
13609 (org-add-colon-after-tag-completion t)
13610 (ins (completing-read
13611 (if prompt (concat prompt ": ") "Tags: ")
13612 'org-tags-completion-function nil nil nil
13613 'org-tags-history)))
13614 (setq ins (mapconcat 'identity
13615 (org-split-string ins (org-re "[^[:alnum:]_@]+"))
13616 ":"))
13618 (or (equal (char-before) ?:) (insert ":"))
13619 (insert ins)
13620 (or (equal (char-after) ?:) (insert ":")))))
13621 (char
13622 (setq org-time-was-given (equal (upcase char) char))
13623 (setq time (org-read-date (equal (upcase char) "U") t nil
13624 prompt))
13625 (org-insert-time-stamp time org-time-was-given
13626 (member char '("u" "U"))
13627 nil nil (list org-end-time-was-given)))
13628 (t
13629 (insert (org-completing-read
13630 (concat (if prompt prompt "Enter string")
13631 (if default (concat " [" default "]"))
13632 ": ")
13633 completions nil nil nil histvar default)))))
13634 (goto-char (point-min))
13636 (replace-match "")
13638 (org-mode)
13639 (org-set-local 'org-finish-function 'org-remember-finalize))
13640 (when (save-excursion
13641 (goto-char (point-min))
13642 (re-search-forward "%!" nil t))
13643 (replace-match "")
13644 (add-hook 'post-command-hook 'org-remember-finish-immediately 'append)))
13646 (defun org-remember-finish-immediately ()
13647 "File remember note immediately.
13648 This should be run in `post-command-hook' and will remove itself
13649 from that hook."
13650 (remove-hook 'post-command-hook 'org-remember-finish-immediately)
13651 (when org-finish-function
13652 (funcall org-finish-function)))
13654 (defvar org-clock-marker) ; Defined below
13655 (defun org-remember-finalize ()
13656 "Finalize the remember process."
13657 (unless (fboundp 'remember-finalize)
13658 (defalias 'remember-finalize 'remember-buffer))
13659 (when (and org-clock-marker
13660 (equal (marker-buffer org-clock-marker) (current-buffer)))
13661 ;; FIXME: test this, this is w/o notetaking!
13662 (let (org-log-note-clock-out) (org-clock-out)))
13663 (when buffer-file-name
13664 (save-buffer)
13665 (setq buffer-file-name nil))
13666 (remember-finalize))
13668 ;;;###autoload
13669 (defun org-remember (&optional goto org-force-remember-template-char)
13670 "Call `remember'. If this is already a remember buffer, re-apply template.
13671 If there is an active region, make sure remember uses it as initial content
13672 of the remember buffer.
13674 When called interactively with a `C-u' prefix argument GOTO, don't remember
13675 anything, just go to the file/headline where the selected template usually
13676 stores its notes. With a double prefix arg `C-u C-u', go to the last
13677 note stored by remember.
13679 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
13680 associated with a template in `org-remember-templates'."
13681 (interactive "P")
13682 (cond
13683 ((equal goto '(4)) (org-go-to-remember-target))
13684 ((equal goto '(16)) (org-remember-goto-last-stored))
13685 (t
13686 (if (memq org-finish-function '(remember-buffer remember-finalize))
13687 (progn
13688 (when (< (length org-remember-templates) 2)
13689 (error "No other template available"))
13690 (erase-buffer)
13691 (let ((annotation (plist-get org-store-link-plist :annotation))
13692 (initial (plist-get org-store-link-plist :initial)))
13693 (org-remember-apply-template))
13694 (message "Press C-c C-c to remember data"))
13695 (if (org-region-active-p)
13696 (remember (buffer-substring (point) (mark)))
13697 (call-interactively 'remember))))))
13699 (defun org-remember-goto-last-stored ()
13700 "Go to the location where the last remember note was stored."
13701 (interactive)
13702 (bookmark-jump "org-remember-last-stored")
13703 (message "This is the last note stored by remember"))
13705 (defun org-go-to-remember-target (&optional template-key)
13706 "Go to the target location of a remember template.
13707 The user is queried for the template."
13708 (interactive)
13709 (let* ((entry (org-select-remember-template template-key))
13710 (file (nth 1 entry))
13711 (heading (nth 2 entry))
13712 visiting)
13714 (setq file org-default-notes-file))
13716 (setq heading org-remember-default-headline))
13717 (setq visiting (org-find-base-buffer-visiting file))
13718 (if (not visiting) (find-file-noselect file))
13719 (switch-to-buffer (or visiting (get-file-buffer file)))
13720 (widen)
13721 (goto-char (point-min))
13722 (if (re-search-forward
13725 nil t)
13726 (goto-char (match-beginning 0))
13727 (error "Target headline not found: %s" heading))))
13729 (defvar org-note-abort nil) ; dynamically scoped
13731 ;;;###autoload
13732 (defun org-remember-handler ()
13733 "Store stuff from remember.el into an org file.
13734 First prompts for an org file. If the user just presses return, the value
13735 of `org-default-notes-file' is used.
13736 Then the command offers the headings tree of the selected file in order to
13737 file the text at a specific location.
13738 You can either immediately press RET to get the note appended to the
13739 file, or you can use vertical cursor motion and visibility cycling (TAB) to
13740 find a better place. Then press RET or <left> or <right> in insert the note.
13742 Key Cursor position Note gets inserted
13743 -----------------------------------------------------------------------------
13744 RET buffer-start as level 1 heading at end of file
13745 RET on headline as sublevel of the heading at cursor
13746 RET no heading at cursor position, level taken from context.
13747 Or use prefix arg to specify level manually.
13748 <left> on headline as same level, before current heading
13749 <right> on headline as same level, after current heading
13751 So the fastest way to store the note is to press RET RET to append it to
13752 the default file. This way your current train of thought is not
13753 interrupted, in accordance with the principles of remember.el.
13754 You can also get the fast execution without prompting by using
13755 C-u C-c C-c to exit the remember buffer. See also the variable
13756 `org-remember-store-without-prompt'.
13758 Before being stored away, the function ensures that the text has a
13760 is constructed from the current date and some additional data.
13762 If the variable `org-adapt-indentation' is non-nil, the entire text is
13763 also indented so that it starts in the same column as the headline
13764 \(i.e. after the stars).
13766 See also the variable `org-reverse-note-order'."
13767 (goto-char (point-min))
13769 (replace-match ""))
13770 (goto-char (point-max))
13771 (beginning-of-line 1)
13773 (delete-region (1- (point)) (point-max))
13774 (beginning-of-line 1))
13775 (catch 'quit
13776 (if org-note-abort (throw 'quit nil))
13777 (let* ((txt (buffer-substring (point-min) (point-max)))
13778 (fastp (org-xor (equal current-prefix-arg '(4))
13779 org-remember-store-without-prompt))
13780 (file (cond
13781 (fastp org-default-notes-file)
13782 ((and (eq org-remember-interactive-interface 'refile)
13783 org-refile-targets)
13784 org-default-notes-file)
13785 ((not (and (equal current-prefix-arg '(16))
13786 org-remember-previous-location))
13787 (org-get-org-file))))
13788 (heading org-remember-default-headline)
13789 (visiting (and file (org-find-base-buffer-visiting file)))
13790 (org-startup-folded nil)
13791 (org-startup-align-all-tables nil)
13792 (org-goto-start-pos 1)
13793 spos exitcmd level indent reversed)
13794 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
13795 (setq file (car org-remember-previous-location)
13796 heading (cdr org-remember-previous-location)
13797 fastp t))
13798 (setq current-prefix-arg nil)
13800 (setq txt (replace-match "" t t txt)))
13801 ;; Modify text so that it becomes a nice subtree which can be inserted
13802 ;; into an org tree.
13804 first)
13805 (setq first (car lines) lines (cdr lines))
13807 ;; Is already a headline
13808 (setq indent nil)
13809 ;; We need to add a headline: Use time and first buffer line
13810 (setq lines (cons first lines)
13811 first (concat "* " (current-time-string)
13812 " (" (remember-buffer-desc) ")")
13813 indent " "))
13814 (if (and org-adapt-indentation indent)
13815 (setq lines (mapcar
13816 (lambda (x)
13818 (concat indent x) x))
13819 lines)))
13826 ;; Put the modified text back into the remember buffer, for refile.
13827 (erase-buffer)
13828 (insert txt)
13829 (goto-char (point-min))
13830 (when (and (eq org-remember-interactive-interface 'refile)
13831 (not fastp))
13832 (org-refile nil (or visiting (find-file-noselect file)))
13833 (throw 'quit t))
13834 ;; Find the file
13835 (if (not visiting) (find-file-noselect file))
13836 (with-current-buffer (or visiting (get-file-buffer file))
13837 (unless (org-mode-p)
13838 (error "Target files for remember notes must be in Org-mode"))
13839 (save-excursion
13840 (save-restriction
13841 (widen)
13842 (and (goto-char (point-min))
13845 (setq reversed (org-notes-order-reversed-p))
13847 ;; Find the default location
13849 (goto-char (point-min))
13850 (if (re-search-forward
13853 nil t)
13854 (setq org-goto-start-pos (match-beginning 0))
13855 (when fastp
13856 (goto-char (point-max))
13857 (unless (bolp) (newline))
13859 (setq org-goto-start-pos (point-at-bol 0)))))
13861 ;; Ask the User for a location, using the appropriate interface
13862 (cond
13863 (fastp (setq spos org-goto-start-pos
13864 exitcmd 'return))
13865 ((eq org-remember-interactive-interface 'outline)
13866 (setq spos (org-get-location (current-buffer)
13867 org-remember-help)
13868 exitcmd (cdr spos)
13869 spos (car spos)))
13870 ((eq org-remember-interactive-interface 'outline-path-completion)
13871 (let ((org-refile-targets '((nil . (:maxlevel . 10))))
13872 (org-refile-use-outline-path t))
13873 (setq spos (org-refile-get-location "Heading: ")
13874 exitcmd 'return
13875 spos (nth 3 spos))))
13876 (t (error "this should not hapen")))
13877 (if (not spos) (throw 'quit nil)) ; return nil to show we did
13878 ; not handle this note
13879 (goto-char spos)
13880 (cond ((org-on-heading-p t)
13881 (org-back-to-heading t)
13882 (setq level (funcall outline-level))
13883 (cond
13884 ((eq exitcmd 'return)
13885 ;; sublevel of current
13886 (setq org-remember-previous-location
13887 (cons (abbreviate-file-name file)
13888 (org-get-heading 'notags)))
13889 (if reversed
13890 (outline-next-heading)
13891 (org-end-of-subtree t)
13892 (if (not (bolp))
13894 (beginning-of-line 2)
13895 (end-of-line 1)
13897 (bookmark-set "org-remember-last-stored")
13898 (org-paste-subtree (org-get-legal-level level 1) txt))
13899 ((eq exitcmd 'left)
13900 ;; before current
13901 (bookmark-set "org-remember-last-stored")
13902 (org-paste-subtree level txt))
13903 ((eq exitcmd 'right)
13904 ;; after current
13905 (org-end-of-subtree t)
13906 (bookmark-set "org-remember-last-stored")
13907 (org-paste-subtree level txt))
13908 (t (error "This should not happen"))))
13910 ((and (bobp) (not reversed))
13911 ;; Put it at the end, one level below level 1
13912 (save-restriction
13913 (widen)
13914 (goto-char (point-max))
13915 (if (not (bolp)) (newline))
13916 (bookmark-set "org-remember-last-stored")
13917 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13919 ((and (bobp) reversed)
13920 ;; Put it at the start, as level 1
13921 (save-restriction
13922 (widen)
13923 (goto-char (point-min))
13925 (beginning-of-line 1)
13926 (bookmark-set "org-remember-last-stored")
13927 (org-paste-subtree 1 txt)))
13928 (t
13929 ;; Put it right there, with automatic level determined by
13930 ;; org-paste-subtree or from prefix arg
13931 (bookmark-set "org-remember-last-stored")
13932 (org-paste-subtree
13933 (if (numberp current-prefix-arg) current-prefix-arg)
13934 txt)))
13935 (when remember-save-after-remembering
13936 (save-buffer)
13937 (if (not visiting) (kill-buffer (current-buffer)))))))))
13939 t) ;; return t to indicate that we took care of this note.
13941 (defun org-get-org-file ()
13942 "Read a filename, with default directory `org-directory'."
13943 (let ((default (or org-default-notes-file remember-data-file)))
13944 (read-file-name (format "File name [%s]: " default)
13945 (file-name-as-directory org-directory)
13946 default)))
13948 (defun org-notes-order-reversed-p ()
13949 "Check if the current file should receive notes in reversed order."
13950 (cond
13951 ((not org-reverse-note-order) nil)
13952 ((eq t org-reverse-note-order) t)
13953 ((not (listp org-reverse-note-order)) nil)
13954 (t (catch 'exit
13955 (let ((all org-reverse-note-order)
13956 entry)
13957 (while (setq entry (pop all))
13958 (if (string-match (car entry) buffer-file-name)
13959 (throw 'exit (cdr entry))))
13960 nil)))))
13962 ;;; Refiling
13964 (defvar org-refile-target-table nil
13965 "The list of refile targets, created by `org-refile'.")
13967 (defvar org-agenda-new-buffers nil
13968 "Buffers created to visit agenda files.")
13970 (defun org-get-refile-targets (&optional default-buffer)
13971 "Produce a table with refile targets."
13972 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
13973 targets txt re files f desc descre)
13974 (with-current-buffer (or default-buffer (current-buffer))
13975 (while (setq entry (pop entries))
13976 (setq files (car entry) desc (cdr entry))
13977 (cond
13978 ((null files) (setq files (list (current-buffer))))
13979 ((eq files 'org-agenda-files)
13980 (setq files (org-agenda-files 'unrestricted)))
13981 ((and (symbolp files) (fboundp files))
13982 (setq files (funcall files)))
13983 ((and (symbolp files) (boundp files))
13984 (setq files (symbol-value files))))
13985 (if (stringp files) (setq files (list files)))
13986 (cond
13987 ((eq (car desc) :tag)
13989 ((eq (car desc) :todo)
13991 ((eq (car desc) :regexp)
13992 (setq descre (cdr desc)))
13993 ((eq (car desc) :level)
13995 (if org-odd-levels-only
13996 (1- (* 2 (cdr desc)))
13997 (cdr desc)))
13999 ((eq (car desc) :maxlevel)
14001 (if org-odd-levels-only
14002 (1- (* 2 (cdr desc)))
14003 (cdr desc)))
14005 (t (error "Bad refiling target description %s" desc)))
14006 (while (setq f (pop files))
14007 (save-excursion
14008 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
14009 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
14010 (save-excursion
14011 (save-restriction
14012 (widen)
14013 (goto-char (point-min))
14014 (while (re-search-forward descre nil t)
14015 (goto-char (point-at-bol))
14016 (when (looking-at org-complex-heading-regexp)
14017 (setq txt (match-string 4)
14018 re (concat "^" (regexp-quote
14019 (buffer-substring (match-beginning 1)
14020 (match-end 4)))))
14022 (regexp-quote
14023 (match-string 5)))))
14025 (when org-refile-use-outline-path
14026 (setq txt (mapconcat 'identity
14027 (append
14028 (if (eq org-refile-use-outline-path 'file)
14029 (list (file-name-nondirectory
14030 (buffer-file-name (buffer-base-buffer))))
14031 (if (eq org-refile-use-outline-path 'full-file-path)
14032 (list (buffer-file-name (buffer-base-buffer)))))
14033 (org-get-outline-path)
14034 (list txt))
14035 "/")))
14036 (push (list txt f re (point)) targets))
14037 (goto-char (point-at-eol))))))))
14038 (nreverse targets))))
14040 (defun org-get-outline-path ()
14041 "Return the outline path to the current entry, as a list."
14042 (let (rtn)
14043 (save-excursion
14044 (while (org-up-heading-safe)
14045 (when (looking-at org-complex-heading-regexp)
14046 (push (org-match-string-no-properties 4) rtn)))
14047 rtn)))
14049 (defvar org-refile-history nil
14050 "History for refiling operations.")
14052 (defun org-refile (&optional goto default-buffer)
14053 "Move the entry at point to another heading.
14054 The list of target headings is compiled using the information in
14055 `org-refile-targets', which see. This list is created upon first use, and
14056 you can update it by calling this command with a double prefix (`C-u C-u').
14057 FIXME: Can we find a better way of updating?
14059 At the target location, the entry is filed as a subitem of the target heading.
14060 Depending on `org-reverse-note-order', the new subitem will either be the
14061 first of the last subitem.
14063 With prefix arg GOTO, the command will only visit the target location,
14064 not actually move anything.
14065 With a double prefix `C-c C-c', go to the location where the last refiling
14066 operation has put the subtree.
14068 With a double prefix argument, the command can be used to jump to any
14069 heading in the current buffer."
14070 (interactive "P")
14071 (let* ((cbuf (current-buffer))
14072 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14073 pos it nbuf file re level reversed)
14074 (if (equal goto '(16))
14075 (org-refile-goto-last-stored)
14076 (when (setq it (org-refile-get-location
14077 (if goto "Goto: " "Refile to: ") default-buffer))
14078 (setq file (nth 1 it)
14079 re (nth 2 it)
14080 pos (nth 3 it))
14081 (setq nbuf (or (find-buffer-visiting file)
14082 (find-file-noselect file)))
14083 (if goto
14084 (progn
14085 (switch-to-buffer nbuf)
14086 (goto-char pos)
14087 (org-show-context 'org-goto))
14088 (org-copy-special)
14089 (save-excursion
14090 (set-buffer (setq nbuf (or (find-buffer-visiting file)
14091 (find-file-noselect file))))
14092 (setq reversed (org-notes-order-reversed-p))
14093 (save-excursion
14094 (save-restriction
14095 (widen)
14096 (goto-char pos)
14097 (looking-at outline-regexp)
14098 (setq level (org-get-legal-level (funcall outline-level) 1))
14099 (goto-char
14100 (if reversed
14101 (outline-next-heading)
14102 (or (save-excursion (outline-get-next-sibling))
14103 (org-end-of-subtree t t)
14104 (point-max))))
14105 (bookmark-set "org-refile-last-stored")
14106 (org-paste-subtree level))))
14107 (org-cut-special)
14110 (defun org-refile-goto-last-stored ()
14111 "Go to the location where the last refile was stored."
14112 (interactive)
14113 (bookmark-jump "org-refile-last-stored")
14114 (message "This is the location of the last refile"))
14116 (defun org-refile-get-location (&optional prompt default-buffer)
14117 "Prompt the user for a refile location, using PROMPT."
14118 (let ((org-refile-targets org-refile-targets)
14119 (org-refile-use-outline-path org-refile-use-outline-path))
14120 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
14121 (unless org-refile-target-table
14122 (error "No refile targets"))
14123 (let* ((cbuf (current-buffer))
14124 (filename (buffer-file-name (buffer-base-buffer cbuf)))
14125 (fname (and filename (file-truename filename)))
14126 (tbl (mapcar
14127 (lambda (x)
14128 (if (not (equal fname (file-truename (nth 1 x))))
14129 (cons (concat (car x) " (" (file-name-nondirectory
14130 (nth 1 x)) ")")
14131 (cdr x))
14132 x))
14133 org-refile-target-table))
14134 (completion-ignore-case t))
14135 (assoc (completing-read prompt tbl nil t nil 'org-refile-history)
14136 tbl)))
14138 ;;;; Dynamic blocks
14140 (defun org-find-dblock (name)
14141 "Find the first dynamic block with name NAME in the buffer.
14142 If not found, stay at current position and return nil."
14143 (let (pos)
14144 (save-excursion
14145 (goto-char (point-min))
14147 nil t)
14148 (match-beginning 0))))
14149 (if pos (goto-char pos))
14150 pos))
14152 (defconst org-dblock-start-re
14154 "Matches the startline of a dynamic block, with parameters.")
14157 "Matches the end of a dyhamic block.")
14159 (defun org-create-dblock (plist)
14160 "Create a dynamic block section, with parameters taken from PLIST.
14161 PLIST must containe a :name entry which is used as name of the block."
14162 (unless (bolp) (newline))
14163 (let ((name (plist-get plist :name)))
14164 (insert "#+BEGIN: " name)
14165 (while plist
14166 (if (eq (car plist) :name)
14167 (setq plist (cddr plist))
14168 (insert " " (prin1-to-string (pop plist)))))
14170 (beginning-of-line -2)))
14172 (defun org-prepare-dblock ()
14173 "Prepare dynamic block for refresh.
14174 This empties the block, puts the cursor at the insert position and returns
14175 the property list including an extra property :name with the block name."
14176 (unless (looking-at org-dblock-start-re)
14177 (error "Not at a dynamic block"))
14178 (let* ((begdel (1+ (match-end 0)))
14179 (name (org-no-properties (match-string 1)))
14180 (params (append (list :name name)
14181 (read (concat "(" (match-string 3) ")")))))
14182 (unless (re-search-forward org-dblock-end-re nil t)
14183 (error "Dynamic block not terminated"))
14184 (delete-region begdel (match-beginning 0))
14185 (goto-char begdel)
14186 (open-line 1)
14187 params))
14189 (defun org-map-dblocks (&optional command)
14190 "Apply COMMAND to all dynamic blocks in the current buffer.
14191 If COMMAND is not given, use `org-update-dblock'."
14192 (let ((cmd (or command 'org-update-dblock))
14193 pos)
14194 (save-excursion
14195 (goto-char (point-min))
14196 (while (re-search-forward org-dblock-start-re nil t)
14197 (goto-char (setq pos (match-beginning 0)))
14198 (condition-case nil
14199 (funcall cmd)
14200 (error (message "Error during update of dynamic block")))
14201 (goto-char pos)
14202 (unless (re-search-forward org-dblock-end-re nil t)
14203 (error "Dynamic block not terminated"))))))
14205 (defun org-dblock-update (&optional arg)
14206 "User command for updating dynamic blocks.
14207 Update the dynamic block at point. With prefix ARG, update all dynamic
14208 blocks in the buffer."
14209 (interactive "P")
14210 (if arg
14211 (org-update-all-dblocks)
14212 (or (looking-at org-dblock-start-re)
14213 (org-beginning-of-dblock))
14214 (org-update-dblock)))
14216 (defun org-update-dblock ()
14217 "Update the dynamic block at point
14218 This means to empty the block, parse for parameters and then call
14219 the correct writing function."
14220 (save-window-excursion
14221 (let* ((pos (point))
14222 (line (org-current-line))
14223 (params (org-prepare-dblock))
14224 (name (plist-get params :name))
14225 (cmd (intern (concat "org-dblock-write:" name))))
14226 (message "Updating dynamic block `%s' at line %d..." name line)
14227 (funcall cmd params)
14228 (message "Updating dynamic block `%s' at line %d...done" name line)
14229 (goto-char pos))))
14231 (defun org-beginning-of-dblock ()
14232 "Find the beginning of the dynamic block at point.
14233 Error if there is no scuh block at point."
14234 (let ((pos (point))
14235 beg)
14236 (end-of-line 1)
14237 (if (and (re-search-backward org-dblock-start-re nil t)
14238 (setq beg (match-beginning 0))
14239 (re-search-forward org-dblock-end-re nil t)
14240 (> (match-end 0) pos))
14241 (goto-char beg)
14242 (goto-char pos)
14243 (error "Not in a dynamic block"))))
14245 (defun org-update-all-dblocks ()
14246 "Update all dynamic blocks in the buffer.
14247 This function can be used in a hook."
14248 (when (org-mode-p)
14249 (org-map-dblocks 'org-update-dblock)))
14252 ;;;; Completion
14254 (defconst org-additional-option-like-keywords
14255 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
14256 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:" "TBLFM"
14257 "BEGIN_EXAMPLE" "END_EXAMPLE"))
14259 (defun org-complete (&optional arg)
14260 "Perform completion on word at point.
14261 At the beginning of a headline, this completes TODO keywords as given in
14262 `org-todo-keywords'.
14263 If the current word is preceded by a backslash, completes the TeX symbols
14264 that are supported for HTML support.
14266 setting file options.
14268 At all other locations, this simply calls the value of
14269 `org-completion-fallback-command'."
14270 (interactive "P")
14271 (org-without-partial-completion
14272 (catch 'exit
14273 (let* ((end (point))
14274 (beg1 (save-excursion
14275 (skip-chars-backward (org-re "[:alnum:]_@"))
14276 (point)))
14277 (beg (save-excursion
14278 (skip-chars-backward "a-zA-Z0-9_:$")
14279 (point)))
14280 (confirm (lambda (x) (stringp (car x))))
14281 (searchhead (equal (char-before beg) ?*))
14282 (tag (and (equal (char-before beg1) ?:)
14283 (equal (char-after (point-at-bol)) ?*)))
14284 (prop (and (equal (char-before beg1) ?:)
14285 (not (equal (char-after (point-at-bol)) ?*))))
14287 (link (equal (char-before beg) ?\[))
14288 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
14289 beg)
14290 "#+"))
14292 (buffer-substring (point-at-bol) (point))))
14293 (completion-ignore-case opt)
14294 (type nil)
14295 (tbl nil)
14296 (table (cond
14297 (opt
14298 (setq type :opt)
14299 (append
14300 (mapcar
14301 (lambda (x)
14303 (cons (match-string 2 x) (match-string 1 x)))
14305 (mapcar 'list org-additional-option-like-keywords)))
14306 (startup
14307 (setq type :startup)
14308 org-startup-options)
14309 (link (append org-link-abbrev-alist-local
14310 org-link-abbrev-alist))
14311 (texp
14312 (setq type :tex)
14313 org-html-entities)
14315 (buffer-substring (point-at-bol) beg))
14316 (setq type :todo)
14317 (mapcar 'list org-todo-keywords-1))
14318 (searchhead
14319 (setq type :searchhead)
14320 (save-excursion
14321 (goto-char (point-min))
14322 (while (re-search-forward org-todo-line-regexp nil t)
14323 (push (list
14324 (org-make-org-heading-search-string
14325 (match-string 3) t))
14326 tbl)))
14327 tbl)
14328 (tag (setq type :tag beg beg1)
14329 (or org-tag-alist (org-get-buffer-tags)))
14330 (prop (setq type :prop beg beg1)
14331 (mapcar 'list (org-buffer-property-keys nil t t)))
14332 (t (progn
14333 (call-interactively org-completion-fallback-command)
14334 (throw 'exit nil)))))
14335 (pattern (buffer-substring-no-properties beg end))
14336 (completion (try-completion pattern table confirm)))
14337 (cond ((eq completion t)
14338 (if (not (assoc (upcase pattern) table))
14339 (message "Already complete")
14340 (if (equal type :opt)
14341 (insert (substring (cdr (assoc (upcase pattern) table))
14342 (length pattern)))
14343 (if (memq type '(:tag :prop)) (insert ":")))))
14344 ((null completion)
14346 (ding))
14347 ((not (string= pattern completion))
14348 (delete-region beg end)
14349 (if (string-match " +$" completion)
14350 (setq completion (replace-match "" t t completion)))
14351 (insert completion)
14352 (if (get-buffer-window "*Completions*")
14353 (delete-window (get-buffer-window "*Completions*")))
14354 (if (assoc completion table)
14355 (if (eq type :todo) (insert " ")
14356 (if (memq type '(:tag :prop)) (insert ":"))))
14357 (if (and (equal type :opt) (assoc completion table))
14358 (message "%s" (substitute-command-keys
14360 (t
14361 (message "Making completion list...")
14362 (let ((list (sort (all-completions pattern table confirm)
14363 'string<)))
14364 (with-output-to-temp-buffer "*Completions*"
14365 (condition-case nil
14366 ;; Protection needed for XEmacs and emacs 21
14367 (display-completion-list list pattern)
14368 (error (display-completion-list list)))))
14369 (message "Making completion list...%s" "done")))))))
14371 ;;;; TODO, DEADLINE, Comments
14373 (defun org-toggle-comment ()
14374 "Change the COMMENT state of an entry."
14375 (interactive)
14376 (save-excursion
14377 (org-back-to-heading)
14378 (let (case-fold-search)
14379 (if (looking-at (concat outline-regexp
14381 (replace-match "" t t nil 1)
14382 (if (looking-at outline-regexp)
14383 (progn
14384 (goto-char (match-end 0))
14385 (insert org-comment-string " ")))))))
14387 (defvar org-last-todo-state-is-todo nil
14388 "This is non-nil when the last TODO state change led to a TODO state.
14389 If the last change removed the TODO tag or switched to DONE, then
14390 this is nil.")
14392 (defvar org-setting-tags nil) ; dynamically skiped
14394 ;; FIXME: better place
14395 (defun org-property-or-variable-value (var &optional inherit)
14396 "Check if there is a property fixing the value of VAR.
14397 If yes, return this value. If not, return the current value of the variable."
14398 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14400 (read prop)
14401 (symbol-value var))))
14403 (defun org-parse-local-options (string var)
14404 "Parse STRING for startup setting relevant for variable VAR."
14405 (let ((rtn (symbol-value var))
14406 e opts)
14407 (save-match-data
14409 rtn
14410 (setq opts (delq nil (mapcar (lambda (x)
14411 (setq e (assoc x org-startup-options))
14412 (if (eq (nth 1 e) var) e nil))
14414 (if (not opts)
14415 rtn
14416 (setq rtn nil)
14417 (while (setq e (pop opts))
14418 (if (not (nth 3 e))
14419 (setq rtn (nth 2 e))
14420 (if (not (listp rtn)) (setq rtn nil))
14421 (push (nth 2 e) rtn)))
14422 rtn)))))
14424 (defvar org-blocker-hook nil
14425 "Hook for functions that are allowed to block a state change.
14427 Each function gets as its single argument a property list, see
14428 `org-trigger-hook' for more information about this list.
14430 If any of the functions in this hook returns nil, the state change
14431 is blocked.")
14433 (defvar org-trigger-hook nil
14434 "Hook for functions that are triggered by a state change.
14436 Each function gets as its single argument a property list with at least
14437 the following elements:
14439 (:type type-of-change :position pos-at-entry-start
14440 :from old-state :to new-state)
14442 Depending on the type, more properties may be present.
14444 This mechanism is currently implemented for:
14446 TODO state changes
14447 ------------------
14448 :type todo-state-change
14449 :from previous state (keyword as a string), or nil
14450 :to new state (keyword as a string), or nil")
14453 (defun org-todo (&optional arg)
14454 "Change the TODO state of an item.
14455 The state of an item is given by a keyword at the start of the heading,
14456 like
14457 *** TODO Write paper
14458 *** DONE Call mom
14460 The different keywords are specified in the variable `org-todo-keywords'.
14462 So for this example: when the item starts with TODO, it is changed to DONE.
14463 When it starts with DONE, the DONE is removed. And when neither TODO nor
14464 DONE are present, add TODO at the beginning of the heading.
14466 With C-u prefix arg, use completion to determine the new state.
14467 With numeric prefix arg, switch to that state.
14469 For calling through lisp, arg is also interpreted in the following way:
14470 'none -> empty state
14472 'done -> switch to DONE
14473 'nextset -> switch to the next set of keywords
14474 'previousset -> switch to the previous set of keywords
14476 really is a member of `org-todo-keywords'."
14477 (interactive "P")
14478 (save-excursion
14479 (catch 'exit
14480 (org-back-to-heading)
14481 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
14482 (or (looking-at (concat " +" org-todo-regexp " *"))
14483 (looking-at " *"))
14484 (let* ((match-data (match-data))
14485 (startpos (point-at-bol))
14486 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
14487 (org-log-done org-log-done)
14488 (org-log-repeat org-log-repeat)
14489 (org-todo-log-states org-todo-log-states)
14490 (this (match-string 1))
14491 (hl-pos (match-beginning 0))
14492 (head (org-get-todo-sequence-head this))
14493 (ass (assoc head org-todo-kwd-alist))
14494 (interpret (nth 1 ass))
14495 (done-word (nth 3 ass))
14496 (final-done-word (nth 4 ass))
14497 (last-state (or this ""))
14498 (completion-ignore-case t)
14499 (member (member this org-todo-keywords-1))
14500 (tail (cdr member))
14501 (state (cond
14502 ((and org-todo-key-trigger
14503 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
14504 (and (not arg) org-use-fast-todo-selection
14505 (not (eq org-use-fast-todo-selection 'prefix)))))
14506 ;; Use fast selection
14507 (org-fast-todo-selection))
14508 ((and (equal arg '(4))
14509 (or (not org-use-fast-todo-selection)
14510 (not org-todo-key-trigger)))
14511 ;; Read a state with completion
14512 (completing-read "State: " (mapcar (lambda(x) (list x))
14513 org-todo-keywords-1)
14514 nil t))
14515 ((eq arg 'right)
14516 (if this
14517 (if tail (car tail) nil)
14518 (car org-todo-keywords-1)))
14519 ((eq arg 'left)
14520 (if (equal member org-todo-keywords-1)
14521 nil
14522 (if this
14523 (nth (- (length org-todo-keywords-1) (length tail) 2)
14524 org-todo-keywords-1)
14525 (org-last org-todo-keywords-1))))
14526 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
14527 (setq arg nil))) ; hack to fall back to cycling
14528 (arg
14529 ;; user or caller requests a specific state
14530 (cond
14531 ((equal arg "") nil)
14532 ((eq arg 'none) nil)
14533 ((eq arg 'done) (or done-word (car org-done-keywords)))
14534 ((eq arg 'nextset)
14535 (or (car (cdr (member head org-todo-heads)))
14536 (car org-todo-heads)))
14537 ((eq arg 'previousset)
14538 (let ((org-todo-heads (reverse org-todo-heads)))
14539 (or (car (cdr (member head org-todo-heads)))
14540 (car org-todo-heads))))
14541 ((car (member arg org-todo-keywords-1)))
14542 ((nth (1- (prefix-numeric-value arg))
14543 org-todo-keywords-1))))
14544 ((null member) (or head (car org-todo-keywords-1)))
14545 ((equal this final-done-word) nil) ;; -> make empty
14546 ((null tail) nil) ;; -> first entry
14547 ((eq interpret 'sequence)
14548 (car tail))
14549 ((memq interpret '(type priority))
14550 (if (eq this-command last-command)
14551 (car tail)
14552 (if (> (length tail) 0)
14553 (or done-word (car org-done-keywords))
14554 nil)))
14555 (t nil)))
14556 (next (if state (concat " " state " ") " "))
14557 (change-plist (list :type 'todo-state-change :from this :to state
14558 :position startpos))
14559 dolog now-done-p)
14560 (when org-blocker-hook
14561 (unless (save-excursion
14562 (save-match-data
14563 (run-hook-with-args-until-failure
14564 'org-blocker-hook change-plist)))
14565 (if (interactive-p)
14566 (error "TODO state change from %s to %s blocked" this state)
14567 ;; fail silently
14568 (message "TODO state change from %s to %s blocked" this state)
14569 (throw 'exit nil))))
14570 (store-match-data match-data)
14571 (replace-match next t t)
14572 (unless (pos-visible-in-window-p hl-pos)
14573 (message "TODO state changed to %s" (org-trim next)))
14574 (unless head
14575 (setq head (org-get-todo-sequence-head state)
14576 ass (assoc head org-todo-kwd-alist)
14577 interpret (nth 1 ass)
14578 done-word (nth 3 ass)
14579 final-done-word (nth 4 ass)))
14580 (when (memq arg '(nextset previousset))
14581 (message "Keyword-Set %d/%d: %s"
14582 (- (length org-todo-sets) -1
14583 (length (memq (assoc state org-todo-sets) org-todo-sets)))
14584 (length org-todo-sets)
14585 (mapconcat 'identity (assoc state org-todo-sets) " ")))
14586 (setq org-last-todo-state-is-todo
14587 (not (member state org-done-keywords)))
14588 (setq now-done-p (and (member state org-done-keywords)
14589 (not (member this org-done-keywords))))
14590 (and logging (org-local-logging logging))
14591 (when (and (or org-todo-log-states org-log-done)
14592 (not (memq arg '(nextset previousset))))
14593 ;; we need to look at recording a time and note
14594 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
14595 (nth 2 (assoc this org-todo-log-states))))
14596 (when (and state
14597 (member state org-not-done-keywords)
14598 (not (member this org-not-done-keywords)))
14599 ;; This is now a todo state and was not one before
14600 ;; If there was a CLOSED time stamp, get rid of it.
14601 (org-add-planning-info nil nil 'closed))
14602 (when (and now-done-p org-log-done)
14603 ;; It is now done, and it was not done before
14604 (org-add-planning-info 'closed (org-current-time))
14605 (if (and (not dolog) (eq 'note org-log-done))
14606 (org-add-log-maybe 'done state 'findpos 'note)))
14607 (when (and state dolog)
14608 ;; This is a non-nil state, and we need to log it
14609 (org-add-log-maybe 'state state 'findpos dolog)))
14610 ;; Fixup tag positioning
14611 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
14612 (run-hooks 'org-after-todo-state-change-hook)
14613 (if (and arg (not (member state org-done-keywords)))
14614 (setq head (org-get-todo-sequence-head state)))
14615 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
14616 ;; Do we need to trigger a repeat?
14617 (when now-done-p (org-auto-repeat-maybe state))
14618 ;; Fixup cursor location if close to the keyword
14619 (if (and (outline-on-heading-p)
14620 (not (bolp))
14621 (save-excursion (beginning-of-line 1)
14622 (looking-at org-todo-line-regexp))
14623 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
14624 (progn
14625 (goto-char (or (match-end 2) (match-end 1)))
14626 (just-one-space)))
14627 (when org-trigger-hook
14628 (save-excursion
14629 (run-hook-with-args 'org-trigger-hook change-plist)))))))
14631 (defun org-local-logging (value)
14632 "Get logging settings from a property VALUE."
14633 (let* (words w a)
14634 ;; directly set the variables, they are already local.
14635 (setq org-log-done nil
14636 org-log-repeat nil
14637 org-todo-log-states nil)
14638 (setq words (org-split-string value))
14639 (while (setq w (pop words))
14640 (cond
14641 ((setq a (assoc w org-startup-options))
14642 (and (member (nth 1 a) '(org-log-done org-log-repeat))
14643 (set (nth 1 a) (nth 2 a))))
14644 ((setq a (org-extract-log-state-settings w))
14645 (and (member (car a) org-todo-keywords-1)
14646 (push a org-todo-log-states)))))))
14648 (defun org-get-todo-sequence-head (kwd)
14649 "Return the head of the TODO sequence to which KWD belongs.
14650 If KWD is not set, check if there is a text property remembering the
14651 right sequence."
14652 (let (p)
14653 (cond
14654 ((not kwd)
14655 (or (get-text-property (point-at-bol) 'org-todo-head)
14656 (progn
14657 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
14658 nil (point-at-eol)))
14659 (get-text-property p 'org-todo-head))))
14660 ((not (member kwd org-todo-keywords-1))
14661 (car org-todo-keywords-1))
14662 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
14664 (defun org-fast-todo-selection ()
14665 "Fast TODO keyword selection with single keys.
14666 Returns the new TODO keyword, or nil if no state change should occur."
14667 (let* ((fulltable org-todo-key-alist)
14668 (done-keywords org-done-keywords) ;; needed for the faces.
14669 (maxlen (apply 'max (mapcar
14670 (lambda (x)
14671 (if (stringp (car x)) (string-width (car x)) 0))
14672 fulltable)))
14673 (expert nil)
14674 (fwidth (+ maxlen 3 1 3))
14675 (ncol (/ (- (window-width) 4) fwidth))
14676 tg cnt e c tbl
14677 groups ingroup)
14678 (save-window-excursion
14679 (if expert
14680 (set-buffer (get-buffer-create " *Org todo*"))
14681 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
14682 (erase-buffer)
14683 (org-set-local 'org-done-keywords done-keywords)
14684 (setq tbl fulltable cnt 0)
14685 (while (setq e (pop tbl))
14686 (cond
14687 ((equal e '(:startgroup))
14688 (push '() groups) (setq ingroup t)
14689 (when (not (= cnt 0))
14690 (setq cnt 0)
14692 (insert "{ "))
14693 ((equal e '(:endgroup))
14694 (setq ingroup nil cnt 0)
14696 (t
14697 (setq tg (car e) c (cdr e))
14698 (if ingroup (push tg (car groups)))
14699 (setq tg (org-add-props tg nil 'face
14700 (org-get-todo-face tg)))
14701 (if (and (= cnt 0) (not ingroup)) (insert " "))
14702 (insert "[" c "] " tg (make-string
14703 (- fwidth 4 (length tg)) ?\ ))
14704 (when (= (setq cnt (1+ cnt)) ncol)
14706 (if ingroup (insert " "))
14707 (setq cnt 0)))))
14709 (goto-char (point-min))
14710 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14711 (fit-window-to-buffer))
14712 (message "[a-z..]:Set [SPC]:clear")
14713 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14714 (cond
14715 ((or (= c ?\C-g)
14716 (and (= c ?q) (not (rassoc c fulltable))))
14717 (setq quit-flag t))
14718 ((= c ?\ ) nil)
14719 ((setq e (rassoc c fulltable) tg (car e))
14720 tg)
14721 (t (setq quit-flag t))))))
14723 (defun org-get-repeat ()
14724 "Check if tere is a deadline/schedule with repeater in this entry."
14725 (save-match-data
14726 (save-excursion
14727 (org-back-to-heading t)
14728 (if (re-search-forward
14729 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
14730 (match-string 1)))))
14732 (defvar org-last-changed-timestamp)
14733 (defvar org-log-post-message)
14734 (defvar org-log-note-purpose)
14735 (defun org-auto-repeat-maybe (done-word)
14736 "Check if the current headline contains a repeated deadline/schedule.
14737 If yes, set TODO state back to what it was and change the base date
14738 of repeating deadline/scheduled time stamps to new date.
14739 This function should be run in the `org-after-todo-state-change-hook'."
14740 ;; last-state is dynamically scoped into this function
14741 (let* ((repeat (org-get-repeat))
14742 (aa (assoc last-state org-todo-kwd-alist))
14743 (interpret (nth 1 aa))
14744 (head (nth 2 aa))
14745 (whata '(("d" . day) ("m" . month) ("y" . year)))
14746 (msg "Entry repeats: ")
14747 (org-log-done nil)
14748 re type n what ts)
14749 (when repeat
14750 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
14751 (org-todo (if (eq interpret 'type) last-state head))
14752 (when (and org-log-repeat
14753 (or (not (memq 'org-add-log-note
14754 (default-value 'post-command-hook)))
14755 (eq org-log-note-purpose 'done)))
14756 ;; Make sure a note is taken;
14757 (org-add-log-maybe 'state (or done-word (car org-done-keywords))
14758 'findpos org-log-repeat))
14759 (org-back-to-heading t)
14760 (org-add-planning-info nil nil 'closed)
14764 (while (re-search-forward
14765 re (save-excursion (outline-next-heading) (point)) t)
14766 (setq type (if (match-end 1) org-scheduled-string
14767 (if (match-end 3) org-deadline-string "Plain:"))
14768 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
14770 (setq n (string-to-number (match-string 1 ts))
14771 what (match-string 2 ts))
14772 (if (equal what "w") (setq n (* n 7) what "d"))
14773 (org-timestamp-change n (cdr (assoc what whata)))
14774 (setq msg (concat msg type org-last-changed-timestamp " "))))
14775 (setq org-log-post-message msg)
14776 (message "%s" msg))))
14778 (defun org-show-todo-tree (arg)
14779 "Make a compact tree which shows all headlines marked with TODO.
14780 The tree will show the lines where the regexp matches, and all higher
14781 headlines above the match.
14783 With a numeric prefix N, construct a sparse tree for the Nth element
14784 of `org-todo-keywords-1'."
14785 (interactive "P")
14786 (let ((case-fold-search nil)
14787 (kwd-re
14788 (cond ((null arg) org-not-done-regexp)
14789 ((equal arg '(4))
14790 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
14791 (mapcar 'list org-todo-keywords-1))))
14795 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
14796 (regexp-quote (nth (1- (prefix-numeric-value arg))
14797 org-todo-keywords-1)))
14798 (t (error "Invalid prefix argument: %s" arg)))))
14799 (message "%d TODO entries found"
14800 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
14802 (defun org-deadline (&optional remove)
14804 With argument REMOVE, remove any deadline from the item."
14805 (interactive "P")
14806 (if remove
14807 (progn
14808 (org-remove-timestamp-with-keyword org-deadline-string)
14809 (message "Item no longer has a deadline."))
14810 (org-add-planning-info 'deadline nil 'closed)))
14812 (defun org-schedule (&optional remove)
14813 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
14814 With argument REMOVE, remove any scheduling date from the item."
14815 (interactive "P")
14816 (if remove
14817 (progn
14818 (org-remove-timestamp-with-keyword org-scheduled-string)
14819 (message "Item is no longer scheduled."))
14820 (org-add-planning-info 'scheduled nil 'closed)))
14822 (defun org-remove-timestamp-with-keyword (keyword)
14823 "Remove all time stamps with KEYWORD in the current entry."
14825 beg)
14826 (save-excursion
14827 (org-back-to-heading t)
14828 (setq beg (point))
14829 (org-end-of-subtree t t)
14830 (while (re-search-backward re beg t)
14831 (replace-match "")
14833 (delete-region (point-at-bol) (min (1+ (point)) (point-max))))))))
14835 (defun org-add-planning-info (what &optional time &rest remove)
14836 "Insert new timestamp with keyword in the line directly after the headline.
14837 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
14838 If non is given, the user is prompted for a date.
14839 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
14840 be removed."
14841 (interactive)
14842 (let (org-time-was-given org-end-time-was-given)
14843 (when what (setq time (or time (org-read-date nil 'to-time))))
14844 (when (and org-insert-labeled-timestamps-at-point
14845 (member what '(scheduled deadline)))
14846 (insert
14847 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
14848 (org-insert-time-stamp time org-time-was-given
14849 nil nil nil (list org-end-time-was-given))
14850 (setq what nil))
14851 (save-excursion
14852 (save-restriction
14853 (let (col list elt ts buffer-invisibility-spec)
14854 (org-back-to-heading t)
14856 (goto-char (match-end 1))
14857 (setq col (current-column))
14858 (goto-char (match-end 0))
14860 (if (and (not (looking-at outline-regexp))
14863 (not (equal (match-string 1) org-clock-string)))
14864 (narrow-to-region (match-beginning 0) (match-end 0))
14866 (backward-char 1)
14867 (narrow-to-region (point) (point))
14868 (indent-to-column col))
14869 ;; Check if we have to remove something.
14870 (setq list (cons what remove))
14871 (while list
14872 (setq elt (pop list))
14873 (goto-char (point-min))
14874 (when (or (and (eq elt 'scheduled)
14875 (re-search-forward org-scheduled-time-regexp nil t))
14876 (and (eq elt 'deadline)
14877 (re-search-forward org-deadline-time-regexp nil t))
14878 (and (eq elt 'closed)
14879 (re-search-forward org-closed-time-regexp nil t)))
14880 (replace-match "")
14881 (if (looking-at "--+<[^>]+>") (replace-match ""))
14882 (if (looking-at " +") (replace-match ""))))
14883 (goto-char (point-max))
14884 (when what
14885 (insert
14886 (if (not (equal (char-before) ?\ )) " " "")
14887 (cond ((eq what 'scheduled) org-scheduled-string)
14888 ((eq what 'deadline) org-deadline-string)
14889 ((eq what 'closed) org-closed-string))
14890 " ")
14891 (setq ts (org-insert-time-stamp
14892 time
14893 (or org-time-was-given
14894 (and (eq what 'closed) org-log-done-with-time))
14895 (eq what 'closed)
14896 nil nil (list org-end-time-was-given)))
14897 (end-of-line 1))
14898 (goto-char (point-min))
14899 (widen)
14901 (replace-match ""))
14902 ts)))))
14904 (defvar org-log-note-marker (make-marker))
14905 (defvar org-log-note-purpose nil)
14906 (defvar org-log-note-state nil)
14907 (defvar org-log-note-how nil)
14908 (defvar org-log-note-window-configuration nil)
14909 (defvar org-log-note-return-to (make-marker))
14910 (defvar org-log-post-message nil
14911 "Message to be displayed after a log note has been stored.
14912 The auto-repeater uses this.")
14914 (defun org-add-log-maybe (&optional purpose state findpos how)
14915 "Set up the post command hook to take a note.
14916 If this is about to TODO state change, the new state is expected in STATE.
14917 When FINDPOS is non-nil, find the correct position for the note in
14918 the current entry. If not, assume that it can be inserted at point."
14919 (save-excursion
14920 (when findpos
14921 (org-back-to-heading t)
14925 (goto-char (match-end 0))
14926 (unless org-log-states-order-reversed
14928 (org-skip-over-state-notes)
14930 (move-marker org-log-note-marker (point))
14931 (setq org-log-note-purpose purpose
14932 org-log-note-state state
14933 org-log-note-how how)
14934 (add-hook 'post-command-hook 'org-add-log-note 'append)))
14936 (defun org-skip-over-state-notes ()
14937 "Skip past the list of State notes in an entry."
14940 (condition-case nil
14941 (org-next-item)
14942 (error (org-end-of-item)))))
14944 (defun org-add-log-note (&optional purpose)
14945 "Pop up a window for taking a note, and add this note later at point."
14946 (remove-hook 'post-command-hook 'org-add-log-note)
14947 (setq org-log-note-window-configuration (current-window-configuration))
14948 (delete-other-windows)
14949 (move-marker org-log-note-return-to (point))
14950 (switch-to-buffer (marker-buffer org-log-note-marker))
14951 (goto-char org-log-note-marker)
14952 (org-switch-to-buffer-other-window "*Org Note*")
14953 (erase-buffer)
14954 (if (memq org-log-note-how '(time state)) ; FIXME: time or state????????????
14955 (org-store-log-note)
14956 (let ((org-inhibit-startup t)) (org-mode))
14957 (insert (format "# Insert note for %s.
14959 (cond
14960 ((eq org-log-note-purpose 'clock-out) "stopped clock")
14961 ((eq org-log-note-purpose 'done) "closed todo item")
14962 ((eq org-log-note-purpose 'state)
14964 (t (error "This should not happen")))))
14965 (org-set-local 'org-finish-function 'org-store-log-note)))
14967 (defun org-store-log-note ()
14968 "Finish taking a log note, and insert it to where it belongs."
14969 (let ((txt (buffer-string))
14970 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
14971 lines ind)
14972 (kill-buffer (current-buffer))
14974 (setq txt (replace-match "" t t txt)))
14976 (setq txt (replace-match "" t t txt)))
14979 (setq note
14980 (org-replace-escapes
14981 note
14982 (list (cons "%u" (user-login-name))
14983 (cons "%U" user-full-name)
14984 (cons "%t" (format-time-string
14985 (org-time-stamp-format 'long 'inactive)
14986 (current-time)))
14987 (cons "%s" (if org-log-note-state
14989 "")))))
14991 (push note lines))
14992 (when (or current-prefix-arg org-note-abort) (setq lines nil))
14993 (when lines
14994 (save-excursion
14995 (set-buffer (marker-buffer org-log-note-marker))
14996 (save-excursion
14997 (goto-char org-log-note-marker)
14998 (move-marker org-log-note-marker nil)
14999 (end-of-line 1)
15001 (indent-relative nil)
15002 (insert "- " (pop lines))
15003 (org-indent-line-function)
15004 (beginning-of-line 1)
15006 (setq ind (concat (match-string 0) " "))
15007 (end-of-line 1)
15009 (set-window-configuration org-log-note-window-configuration)
15010 (with-current-buffer (marker-buffer org-log-note-return-to)
15011 (goto-char org-log-note-return-to))
15012 (move-marker org-log-note-return-to nil)
15013 (and org-log-post-message (message "%s" org-log-post-message)))
15015 ;; FIXME: what else would be useful?
15016 ;; - priority
15017 ;; - date
15019 (defun org-sparse-tree (&optional arg)
15020 "Create a sparse tree, prompt for the details.
15021 This command can create sparse trees. You first need to select the type
15022 of match used to create the tree:
15024 t Show entries with a specific TODO keyword.
15025 T Show entries selected by a tags match.
15026 p Enter a property name and its value (both with completion on existing
15027 names/values) and show entries with that property.
15028 r Show entries matching a regular expression
15029 d Show deadlines due within `org-deadline-warning-days'."
15030 (interactive "P")
15031 (let (ans kwd value)
15032 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
15033 (setq ans (read-char-exclusive))
15034 (cond
15035 ((equal ans ?d)
15036 (call-interactively 'org-check-deadlines))
15037 ((equal ans ?b)
15038 (call-interactively 'org-check-before-date))
15039 ((equal ans ?t)
15040 (org-show-todo-tree '(4)))
15041 ((equal ans ?T)
15042 (call-interactively 'org-tags-sparse-tree))
15043 ((member ans '(?p ?P))
15044 (setq kwd (completing-read "Property: "
15045 (mapcar 'list (org-buffer-property-keys))))
15046 (setq value (completing-read "Value: "
15047 (mapcar 'list (org-property-values kwd))))
15050 (org-tags-sparse-tree arg (concat kwd "=" value)))
15051 ((member ans '(?r ?R ?/))
15052 (call-interactively 'org-occur))
15055 (defvar org-occur-highlights nil)
15056 (make-variable-buffer-local 'org-occur-highlights)
15058 (defun org-occur (regexp &optional keep-previous callback)
15059 "Make a compact tree which shows all matches of REGEXP.
15060 The tree will show the lines where the regexp matches, and all higher
15061 headlines above the match. It will also show the heading after the match,
15062 to make sure editing the matching entry is easy.
15063 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
15064 call to `org-occur' will be kept, to allow stacking of calls to this
15065 command.
15066 If CALLBACK is non-nil, it is a function which is called to confirm
15067 that the match should indeed be shown."
15069 (or keep-previous (org-remove-occur-highlights nil nil t))
15070 (let ((cnt 0))
15071 (save-excursion
15072 (goto-char (point-min))
15073 (if (or (not keep-previous) ; do not want to keep
15074 (not org-occur-highlights)) ; no previous matches
15075 ;; hide everything
15076 (org-overview))
15077 (while (re-search-forward regexp nil t)
15078 (when (or (not callback)
15079 (save-match-data (funcall callback)))
15080 (setq cnt (1+ cnt))
15081 (when org-highlight-sparse-tree-matches
15082 (org-highlight-new-match (match-beginning 0) (match-end 0)))
15083 (org-show-context 'occur-tree))))
15084 (when org-remove-highlights-with-change
15085 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
15086 nil 'local))
15087 (unless org-sparse-tree-open-archived-trees
15088 (org-hide-archived-subtrees (point-min) (point-max)))
15089 (run-hooks 'org-occur-hook)
15090 (if (interactive-p)
15091 (message "%d match(es) for regexp %s" cnt regexp))
15092 cnt))
15094 (defun org-show-context (&optional key)
15095 "Make sure point and context and visible.
15096 How much context is shown depends upon the variables
15097 `org-show-hierarchy-above', `org-show-following-heading'. and
15098 `org-show-siblings'."
15099 (let ((heading-p (org-on-heading-p t))
15100 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
15101 (following-p (org-get-alist-option org-show-following-heading key))
15102 (entry-p (org-get-alist-option org-show-entry-below key))
15103 (siblings-p (org-get-alist-option org-show-siblings key)))
15104 (catch 'exit
15105 ;; Show heading or entry text
15106 (if (and heading-p (not entry-p))
15107 (org-flag-heading nil) ; only show the heading
15108 (and (or entry-p (org-invisible-p) (org-invisible-p2))
15109 (org-show-hidden-entry))) ; show entire entry
15110 (when following-p
15111 ;; Show next sibling, or heading below text
15112 (save-excursion
15113 (and (if heading-p (org-goto-sibling) (outline-next-heading))
15114 (org-flag-heading nil))))
15115 (when siblings-p (org-show-siblings))
15116 (when hierarchy-p
15117 ;; show all higher headings, possibly with siblings
15118 (save-excursion
15119 (while (and (condition-case nil
15120 (progn (org-up-heading-all 1) t)
15121 (error nil))
15122 (not (bobp)))
15123 (org-flag-heading nil)
15124 (when siblings-p (org-show-siblings))))))))
15126 (defun org-reveal (&optional siblings)
15127 "Show current entry, hierarchy above it, and the following headline.
15128 This can be used to show a consistent set of context around locations
15129 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
15130 not t for the search context.
15132 With optional argument SIBLINGS, on each level of the hierarchy all
15133 siblings are shown. This repairs the tree structure to what it would
15134 look like when opened with hierarchical calls to `org-cycle'."
15135 (interactive "P")
15136 (let ((org-show-hierarchy-above t)
15137 (org-show-following-heading t)
15138 (org-show-siblings (if siblings t org-show-siblings)))
15139 (org-show-context nil)))
15141 (defun org-highlight-new-match (beg end)
15142 "Highlight from BEG to END and mark the highlight is an occur headline."
15143 (let ((ov (org-make-overlay beg end)))
15144 (org-overlay-put ov 'face 'secondary-selection)
15145 (push ov org-occur-highlights)))
15147 (defun org-remove-occur-highlights (&optional beg end noremove)
15148 "Remove the occur highlights from the buffer.
15149 BEG and END are ignored. If NOREMOVE is nil, remove this function
15150 from the `before-change-functions' in the current buffer."
15151 (interactive)
15152 (unless org-inhibit-highlight-removal
15153 (mapc 'org-delete-overlay org-occur-highlights)
15154 (setq org-occur-highlights nil)
15155 (unless noremove
15156 (remove-hook 'before-change-functions
15157 'org-remove-occur-highlights 'local))))
15159 ;;;; Priorities
15162 "Regular expression matching the priority indicator.")
15164 (defvar org-remove-priority-next-time nil)
15166 (defun org-priority-up ()
15167 "Increase the priority of the current item."
15168 (interactive)
15169 (org-priority 'up))
15171 (defun org-priority-down ()
15172 "Decrease the priority of the current item."
15173 (interactive)
15174 (org-priority 'down))
15176 (defun org-priority (&optional action)
15177 "Change the priority of an item by ARG.
15178 ACTION can be `set', `up', `down', or a character."
15179 (interactive)
15180 (setq action (or action 'set))
15181 (let (current new news have remove)
15182 (save-excursion
15183 (org-back-to-heading)
15184 (if (looking-at org-priority-regexp)
15185 (setq current (string-to-char (match-string 2))
15186 have t)
15187 (setq current org-default-priority))
15188 (cond
15189 ((or (eq action 'set) (integerp action))
15190 (if (integerp action)
15191 (setq new action)
15192 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
15193 (setq new (read-char-exclusive)))
15194 (if (and (= (upcase org-highest-priority) org-highest-priority)
15195 (= (upcase org-lowest-priority) org-lowest-priority))
15196 (setq new (upcase new)))
15197 (cond ((equal new ?\ ) (setq remove t))
15198 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
15199 (error "Priority must be between `%c' and `%c'"
15200 org-highest-priority org-lowest-priority))))
15201 ((eq action 'up)
15202 (if (and (not have) (eq last-command this-command))
15203 (setq new org-lowest-priority)
15204 (setq new (if (and org-priority-start-cycle-with-default (not have))
15205 org-default-priority (1- current)))))
15206 ((eq action 'down)
15207 (if (and (not have) (eq last-command this-command))
15208 (setq new org-highest-priority)
15209 (setq new (if (and org-priority-start-cycle-with-default (not have))
15210 org-default-priority (1+ current)))))
15211 (t (error "Invalid action")))
15212 (if (or (< (upcase new) org-highest-priority)
15213 (> (upcase new) org-lowest-priority))
15214 (setq remove t))
15215 (setq news (format "%c" new))
15216 (if have
15217 (if remove
15218 (replace-match "" t t nil 1)
15219 (replace-match news t t nil 2))
15220 (if remove
15221 (error "No priority cookie found in line")
15222 (looking-at org-todo-line-regexp)
15223 (if (match-end 2)
15224 (progn
15225 (goto-char (match-end 2))
15226 (insert " [#" news "]"))
15227 (goto-char (match-beginning 3))
15228 (insert "[#" news "] ")))))
15229 (org-preserve-lc (org-set-tags nil 'align))
15230 (if remove
15231 (message "Priority removed")
15232 (message "Priority of current item set to %s" news))))
15235 (defun org-get-priority (s)
15236 "Find priority cookie and return priority."
15237 (save-match-data
15238 (if (not (string-match org-priority-regexp s))
15239 (* 1000 (- org-lowest-priority org-default-priority))
15240 (* 1000 (- org-lowest-priority
15241 (string-to-char (match-string 2 s)))))))
15243 ;;;; Tags
15245 (defun org-scan-tags (action matcher &optional todo-only)
15246 "Scan headline tags with inheritance and produce output ACTION.
15247 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
15248 evaluated, testing if a given set of tags qualifies a headline for
15249 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
15250 are included in the output."
15253 (org-re
15255 (props (list 'face nil
15256 'done-face 'org-done
15257 'undone-face nil
15258 'mouse-face 'highlight
15259 'org-not-done-regexp org-not-done-regexp
15260 'org-todo-regexp org-todo-regexp
15261 'keymap org-agenda-keymap
15262 'help-echo
15263 (format "mouse-2 or RET jump to org file %s"
15264 (abbreviate-file-name
15265 (or (buffer-file-name (buffer-base-buffer))
15266 (buffer-name (buffer-base-buffer)))))))
15267 (case-fold-search nil)
15268 lspos
15269 tags tags-list tags-alist (llast 0) rtn level category i txt
15270 todo marker entry priority)
15271 (save-excursion
15272 (goto-char (point-min))
15273 (when (eq action 'sparse-tree)
15274 (org-overview)
15275 (org-remove-occur-highlights))
15276 (while (re-search-forward re nil t)
15277 (catch :skip
15278 (setq todo (if (match-end 1) (match-string 2))
15279 tags (if (match-end 4) (match-string 4)))
15280 (goto-char (setq lspos (1+ (match-beginning 0))))
15281 (setq level (org-reduced-level (funcall outline-level))
15282 category (org-get-category))
15283 (setq i llast llast level)
15284 ;; remove tag lists from same and sublevels
15285 (while (>= i level)
15286 (when (setq entry (assoc i tags-alist))
15287 (setq tags-alist (delete entry tags-alist)))
15288 (setq i (1- i)))
15289 ;; add the nex tags
15290 (when tags
15291 (setq tags (mapcar 'downcase (org-split-string tags ":"))
15292 tags-alist
15293 (cons (cons level tags) tags-alist)))
15294 ;; compile tags for current headline
15295 (setq tags-list
15296 (if org-use-tag-inheritance
15297 (apply 'append (mapcar 'cdr tags-alist))
15298 tags))
15299 (when (and (or (not todo-only) (member todo org-not-done-keywords))
15300 (eval matcher)
15301 (or (not org-agenda-skip-archived-trees)
15302 (not (member org-archive-tag tags-list))))
15303 (and (eq action 'agenda) (org-agenda-skip))
15304 ;; list this headline
15306 (if (eq action 'sparse-tree)
15307 (progn
15308 (and org-highlight-sparse-tree-matches
15309 (org-get-heading) (match-end 0)
15310 (org-highlight-new-match
15311 (match-beginning 0) (match-beginning 1)))
15312 (org-show-context 'tags-tree))
15313 (setq txt (org-format-agenda-item
15314 ""
15315 (concat
15316 (if org-tags-match-list-sublevels
15317 (make-string (1- level) ?.) "")
15318 (org-get-heading))
15319 category tags-list)
15320 priority (org-get-priority txt))
15321 (goto-char lspos)
15322 (setq marker (org-agenda-new-marker))
15323 (org-add-props txt props
15324 'org-marker marker 'org-hd-marker marker 'org-category category
15325 'priority priority 'type "tagsmatch")
15326 (push txt rtn))
15327 ;; if we are to skip sublevels, jump to end of subtree
15328 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
15329 (when (and (eq action 'sparse-tree)
15330 (not org-sparse-tree-open-archived-trees))
15331 (org-hide-archived-subtrees (point-min) (point-max)))
15332 (nreverse rtn)))
15334 (defvar todo-only) ;; dynamically scoped
15336 (defun org-tags-sparse-tree (&optional todo-only match)
15337 "Create a sparse tree according to tags string MATCH.
15338 MATCH can contain positive and negative selection of tags, like
15340 If optional argument TODO_ONLY is non-nil, only select lines that are
15341 also TODO lines."
15342 (interactive "P")
15343 (org-prepare-agenda-buffers (list (current-buffer)))
15344 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
15346 (defvar org-cached-props nil)
15347 (defun org-cached-entry-get (pom property)
15348 (if (or (eq t org-use-property-inheritance)
15349 (member property org-use-property-inheritance))
15350 ;; Caching is not possible, check it directly
15351 (org-entry-get pom property 'inherit)
15352 ;; Get all properties, so that we can do complicated checks easily
15353 (cdr (assoc property (or org-cached-props
15354 (setq org-cached-props
15355 (org-entry-properties pom)))))))
15357 (defun org-global-tags-completion-table (&optional files)
15358 "Return the list of all tags in all agenda buffer/files."
15359 (save-excursion
15360 (org-uniquify
15361 (delq nil
15362 (apply 'append
15363 (mapcar
15364 (lambda (file)
15365 (set-buffer (find-file-noselect file))
15366 (append (org-get-buffer-tags)
15367 (mapcar (lambda (x) (if (stringp (car-safe x))
15368 (list (car-safe x)) nil))
15369 org-tag-alist)))
15370 (if (and files (car files))
15371 files
15372 (org-agenda-files))))))))
15374 (defun org-make-tags-matcher (match)
15375 "Create the TAGS//TODO matcher form for the selection string MATCH."
15376 ;; todo-only is scoped dynamically into this function, and the function
15377 ;; may change it it the matcher asksk for it.
15378 (unless match
15379 ;; Get a new match request, with completion
15380 (let ((org-last-tags-completion-table
15381 (org-global-tags-completion-table)))
15382 (setq match (completing-read
15383 "Match: " 'org-tags-completion-function nil nil nil
15384 'org-tags-history))))
15386 ;; Parse the string and create a lisp form
15387 (let ((match0 match)
15388 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]*\"\\)\\|[[:alnum:]_@]+\\)"))
15389 minus tag mm
15390 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
15391 orterms term orlist re-p level-p prop-p pn pv cat-p gv)
15392 (if (string-match "/+" match)
15393 ;; match contains also a todo-matching request
15394 (progn
15395 (setq tagsmatch (substring match 0 (match-beginning 0))
15396 todomatch (substring match (match-end 0)))
15397 (if (string-match "^!" todomatch)
15398 (setq todo-only t todomatch (substring todomatch 1)))
15400 (setq todomatch nil)))
15401 ;; only matching tags
15402 (setq tagsmatch match todomatch nil))
15404 ;; Make the tags matcher
15406 (setq tagsmatcher t)
15407 (setq orterms (org-split-string tagsmatch "|") orlist nil)
15408 (while (setq term (pop orterms))
15410 (setq term (concat term "|" (pop orterms)))) ; repair bad split
15411 (while (string-match re term)
15412 (setq minus (and (match-end 1)
15413 (equal (match-string 1 term) "-"))
15414 tag (match-string 2 term)
15415 re-p (equal (string-to-char tag) ?{)
15416 level-p (match-end 3)
15417 prop-p (match-end 4)
15418 mm (cond
15419 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
15420 (level-p `(= level ,(string-to-number
15421 (match-string 3 term))))
15422 (prop-p
15423 (setq pn (match-string 4 term)
15424 pv (match-string 5 term)
15425 cat-p (equal pn "CATEGORY")
15426 re-p (equal (string-to-char pv) ?{)
15427 pv (substring pv 1 -1))
15428 (if (equal pn "CATEGORY")
15429 (setq gv '(get-text-property (point) 'org-category))
15430 (setq gv `(org-cached-entry-get nil ,pn)))
15431 (if re-p
15432 `(string-match ,pv (or ,gv ""))
15433 `(equal ,pv (or ,gv ""))))
15434 (t `(member ,(downcase tag) tags-list)))
15435 mm (if minus (list 'not mm) mm)
15436 term (substring term (match-end 0)))
15437 (push mm tagsmatcher))
15438 (push (if (> (length tagsmatcher) 1)
15439 (cons 'and tagsmatcher)
15440 (car tagsmatcher))
15441 orlist)
15442 (setq tagsmatcher nil))
15443 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
15444 (setq tagsmatcher
15445 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
15447 ;; Make the todo matcher
15449 (setq todomatcher t)
15450 (setq orterms (org-split-string todomatch "|") orlist nil)
15451 (while (setq term (pop orterms))
15452 (while (string-match re term)
15453 (setq minus (and (match-end 1)
15454 (equal (match-string 1 term) "-"))
15455 kwd (match-string 2 term)
15456 re-p (equal (string-to-char kwd) ?{)
15457 term (substring term (match-end 0))
15458 mm (if re-p
15459 `(string-match ,(substring kwd 1 -1) todo)
15460 (list 'equal 'todo kwd))
15461 mm (if minus (list 'not mm) mm))
15462 (push mm todomatcher))
15463 (push (if (> (length todomatcher) 1)
15464 (cons 'and todomatcher)
15465 (car todomatcher))
15466 orlist)
15467 (setq todomatcher nil))
15468 (setq todomatcher (if (> (length orlist) 1)
15469 (cons 'or orlist) (car orlist))))
15471 ;; Return the string and lisp forms of the matcher
15472 (setq matcher (if todomatcher
15473 (list 'and tagsmatcher todomatcher)
15474 tagsmatcher))
15475 (cons match0 matcher)))
15477 (defun org-match-any-p (re list)
15478 "Does re match any element of list?"
15479 (setq list (mapcar (lambda (x) (string-match re x)) list))
15480 (delq nil list))
15482 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
15483 (defvar org-tags-overlay (org-make-overlay 1 1))
15484 (org-detach-overlay org-tags-overlay)
15486 (defun org-align-tags-here (to-col)
15487 ;; Assumes that this is a headline
15488 (let ((pos (point)) (col (current-column)) tags)
15489 (beginning-of-line 1)
15491 (< pos (match-beginning 2)))
15492 (progn
15493 (setq tags (match-string 2))
15494 (goto-char (match-beginning 1))
15495 (insert " ")
15496 (delete-region (point) (1+ (match-end 0)))
15497 (backward-char 1)
15498 (move-to-column
15499 (max (1+ (current-column))
15500 (1+ col)
15501 (if (> to-col 0)
15502 to-col
15503 (- (abs to-col) (length tags))))
15504 t)
15505 (insert tags)
15506 (move-to-column (min (current-column) col) t))
15507 (goto-char pos))))
15509 (defun org-set-tags (&optional arg just-align)
15510 "Set the tags for the current headline.
15511 With prefix ARG, realign all tags in headings in the current buffer."
15512 (interactive "P")
15513 (let* ((re (concat "^" outline-regexp))
15514 (current (org-get-tags-string))
15515 (col (current-column))
15516 (org-setting-tags t)
15517 table current-tags inherited-tags ; computed below when needed
15518 tags p0 c0 c1 rpl)
15519 (if arg
15520 (save-excursion
15521 (goto-char (point-min))
15522 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15523 (while (re-search-forward re nil t)
15524 (org-set-tags nil t)
15525 (end-of-line 1)))
15526 (message "All tags realigned to column %d" org-tags-column))
15527 (if just-align
15528 (setq tags current)
15529 ;; Get a new set of tags from the user
15530 (save-excursion
15531 (setq table (or org-tag-alist (org-get-buffer-tags))
15532 org-last-tags-completion-table table
15533 current-tags (org-split-string current ":")
15534 inherited-tags (nreverse
15535 (nthcdr (length current-tags)
15536 (nreverse (org-get-tags-at))))
15537 tags
15538 (if (or (eq t org-use-fast-tag-selection)
15539 (and org-use-fast-tag-selection
15540 (delq nil (mapcar 'cdr table))))
15541 (org-fast-tag-selection
15542 current-tags inherited-tags table
15543 (if org-fast-tag-selection-include-todo org-todo-key-alist))
15544 (let ((org-add-colon-after-tag-completion t))
15545 (org-trim
15546 (org-without-partial-completion
15547 (completing-read "Tags: " 'org-tags-completion-function
15548 nil nil current 'org-tags-history)))))))
15549 (while (string-match "[-+&]+" tags)
15550 ;; No boolean logic, just a list
15551 (setq tags (replace-match ":" t t tags))))
15554 (setq tags "")
15555 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
15556 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15558 ;; Insert new tags at the correct column
15559 (beginning-of-line 1)
15560 (cond
15561 ((and (equal current "") (equal tags "")))
15562 ((re-search-forward
15564 (point-at-eol) t)
15565 (if (equal tags "")
15566 (setq rpl "")
15567 (goto-char (match-beginning 0))
15568 (setq c0 (current-column) p0 (point)
15569 c1 (max (1+ c0) (if (> org-tags-column 0)
15570 org-tags-column
15571 (- (- org-tags-column) (length tags))))
15572 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15573 (replace-match rpl t t)
15574 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15575 tags)
15576 (t (error "Tags alignment failed")))
15577 (move-to-column col)
15578 (unless just-align
15579 (run-hooks 'org-after-tags-change-hook)))))
15581 (defun org-change-tag-in-region (beg end tag off)
15582 "Add or remove TAG for each entry in the region.
15583 This works in the agenda, and also in an org-mode buffer."
15584 (interactive
15585 (list (region-beginning) (region-end)
15586 (let ((org-last-tags-completion-table
15587 (if (org-mode-p)
15588 (org-get-buffer-tags)
15589 (org-global-tags-completion-table))))
15590 (completing-read
15591 "Tag: " 'org-tags-completion-function nil nil nil
15592 'org-tags-history))
15593 (progn
15594 (message "[s]et or [r]emove? ")
15595 (equal (read-char-exclusive) ?r))))
15596 (if (fboundp 'deactivate-mark) (deactivate-mark))
15597 (let ((agendap (equal major-mode 'org-agenda-mode))
15598 l1 l2 m buf pos newhead (cnt 0))
15599 (goto-char end)
15600 (setq l2 (1- (org-current-line)))
15601 (goto-char beg)
15602 (setq l1 (org-current-line))
15603 (loop for l from l1 to l2 do
15604 (goto-line l)
15605 (setq m (get-text-property (point) 'org-hd-marker))
15606 (when (or (and (org-mode-p) (org-on-heading-p))
15607 (and agendap m))
15608 (setq buf (if agendap (marker-buffer m) (current-buffer))
15609 pos (if agendap m (point)))
15610 (with-current-buffer buf
15611 (save-excursion
15612 (save-restriction
15613 (goto-char pos)
15614 (setq cnt (1+ cnt))
15615 (org-toggle-tag tag (if off 'off 'on))
15616 (setq newhead (org-get-heading)))))
15617 (and agendap (org-agenda-change-all-lines newhead m))))
15618 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15620 (defun org-tags-completion-function (string predicate &optional flag)
15621 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15622 (confirm (lambda (x) (stringp (car x)))))
15624 (setq s1 (match-string 1 string)
15625 s2 (match-string 2 string))
15626 (setq s1 "" s2 string))
15627 (cond
15628 ((eq flag nil)
15629 ;; try completion
15630 (setq rtn (try-completion s2 ctable confirm))
15631 (if (stringp rtn)
15632 (setq rtn
15633 (concat s1 s2 (substring rtn (length s2))
15634 (if (and org-add-colon-after-tag-completion
15635 (assoc rtn ctable))
15636 ":" ""))))
15637 rtn)
15638 ((eq flag t)
15639 ;; all-completions
15640 (all-completions s2 ctable confirm)
15641 )
15642 ((eq flag 'lambda)
15643 ;; exact match?
15644 (assoc s2 ctable)))
15645 ))
15647 (defun org-fast-tag-insert (kwd tags face &optional end)
15648 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
15649 (insert (format "%-12s" (concat kwd ":"))
15650 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15651 (or end "")))
15653 (defun org-fast-tag-show-exit (flag)
15654 (save-excursion
15655 (goto-line 3)
15657 (replace-match ""))
15658 (when flag
15659 (end-of-line 1)
15660 (move-to-column (- (window-width) 19) t)
15661 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15663 (defun org-set-current-tags-overlay (current prefix)
15664 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15665 (if (featurep 'xemacs)
15666 (org-overlay-display org-tags-overlay (concat prefix s)
15667 'secondary-selection)
15668 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15669 (org-overlay-display org-tags-overlay (concat prefix s)))))
15671 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15672 "Fast tag selection with single keys.
15673 CURRENT is the current list of tags in the headline, INHERITED is the
15674 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15675 possibly with grouping information. TODO-TABLE is a similar table with
15676 TODO keywords, should these have keys assigned to them.
15677 If the keys are nil, a-z are automatically assigned.
15678 Returns the new tags string, or nil to not change the current settings."
15679 (let* ((fulltable (append table todo-table))
15680 (maxlen (apply 'max (mapcar
15681 (lambda (x)
15682 (if (stringp (car x)) (string-width (car x)) 0))
15683 fulltable)))
15684 (buf (current-buffer))
15685 (expert (eq org-fast-tag-selection-single-key 'expert))
15686 (buffer-tags nil)
15687 (fwidth (+ maxlen 3 1 3))
15688 (ncol (/ (- (window-width) 4) fwidth))
15689 (i-face 'org-done)
15690 (c-face 'org-todo)
15691 tg cnt e c char c1 c2 ntable tbl rtn
15692 ov-start ov-end ov-prefix
15693 (exit-after-next org-fast-tag-selection-single-key)
15694 (done-keywords org-done-keywords)
15695 groups ingroup)
15696 (save-excursion
15697 (beginning-of-line 1)
15698 (if (looking-at
15700 (setq ov-start (match-beginning 1)
15701 ov-end (match-end 1)
15702 ov-prefix "")
15703 (setq ov-start (1- (point-at-eol))
15704 ov-end (1+ ov-start))
15706 (setq ov-prefix
15707 (concat
15708 (buffer-substring (1- (point)) (point))
15709 (if (> (current-column) org-tags-column)
15710 " "
15711 (make-string (- org-tags-column (current-column)) ?\ ))))))
15712 (org-move-overlay org-tags-overlay ov-start ov-end)
15713 (save-window-excursion
15714 (if expert
15715 (set-buffer (get-buffer-create " *Org tags*"))
15716 (delete-other-windows)
15717 (split-window-vertically)
15718 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
15719 (erase-buffer)
15720 (org-set-local 'org-done-keywords done-keywords)
15723 (org-fast-tag-show-exit exit-after-next)
15724 (org-set-current-tags-overlay current ov-prefix)
15725 (setq tbl fulltable char ?a cnt 0)
15726 (while (setq e (pop tbl))
15727 (cond
15728 ((equal e '(:startgroup))
15729 (push '() groups) (setq ingroup t)
15730 (when (not (= cnt 0))
15731 (setq cnt 0)
15733 (insert "{ "))
15734 ((equal e '(:endgroup))
15735 (setq ingroup nil cnt 0)
15737 (t
15738 (setq tg (car e) c2 nil)
15739 (if (cdr e)
15740 (setq c (cdr e))
15741 ;; automatically assign a character.
15742 (setq c1 (string-to-char
15743 (downcase (substring
15744 tg (if (= (string-to-char tg) ?@) 1 0)))))
15745 (if (or (rassoc c1 ntable) (rassoc c1 table))
15746 (while (or (rassoc char ntable) (rassoc char table))
15747 (setq char (1+ char)))
15748 (setq c2 c1))
15749 (setq c (or c2 char)))
15750 (if ingroup (push tg (car groups)))
15751 (setq tg (org-add-props tg nil 'face
15752 (cond
15753 ((not (assoc tg table))
15754 (org-get-todo-face tg))
15755 ((member tg current) c-face)
15756 ((member tg inherited) i-face)
15757 (t nil))))
15758 (if (and (= cnt 0) (not ingroup)) (insert " "))
15759 (insert "[" c "] " tg (make-string
15760 (- fwidth 4 (length tg)) ?\ ))
15761 (push (cons tg c) ntable)
15762 (when (= (setq cnt (1+ cnt)) ncol)
15764 (if ingroup (insert " "))
15765 (setq cnt 0)))))
15766 (setq ntable (nreverse ntable))
15768 (goto-char (point-min))
15769 (if (and (not expert) (fboundp 'fit-window-to-buffer))
15770 (fit-window-to-buffer))
15771 (setq rtn
15772 (catch 'exit
15773 (while t
15774 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
15775 (if groups " [!] no groups" " [!]groups")
15776 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15777 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15778 (cond
15780 ((= c ?!)
15781 (setq groups (not groups))
15782 (goto-char (point-min))
15783 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15784 ((= c ?\C-c)
15785 (if (not expert)
15786 (org-fast-tag-show-exit
15787 (setq exit-after-next (not exit-after-next)))
15788 (setq expert nil)
15789 (delete-other-windows)
15790 (split-window-vertically)
15791 (org-switch-to-buffer-other-window " *Org tags*")
15792 (and (fboundp 'fit-window-to-buffer)
15793 (fit-window-to-buffer))))
15794 ((or (= c ?\C-g)
15795 (and (= c ?q) (not (rassoc c ntable))))
15796 (org-detach-overlay org-tags-overlay)
15797 (setq quit-flag t))
15798 ((= c ?\ )
15799 (setq current nil)
15800 (if exit-after-next (setq exit-after-next 'now)))
15802 (condition-case nil
15803 (setq tg (completing-read
15804 "Tag: "
15805 (or buffer-tags
15806 (with-current-buffer buf
15807 (org-get-buffer-tags)))))
15808 (quit (setq tg "")))
15810 (add-to-list 'buffer-tags (list tg))
15811 (if (member tg current)
15812 (setq current (delete tg current))
15813 (push tg current)))
15814 (if exit-after-next (setq exit-after-next 'now)))
15815 ((setq e (rassoc c todo-table) tg (car e))
15816 (with-current-buffer buf
15817 (save-excursion (org-todo tg)))
15818 (if exit-after-next (setq exit-after-next 'now)))
15819 ((setq e (rassoc c ntable) tg (car e))
15820 (if (member tg current)
15821 (setq current (delete tg current))
15822 (loop for g in groups do
15823 (if (member tg g)
15824 (mapc (lambda (x)
15825 (setq current (delete x current)))
15826 g)))
15827 (push tg current))
15828 (if exit-after-next (setq exit-after-next 'now))))
15830 ;; Create a sorted list
15831 (setq current
15832 (sort current
15833 (lambda (a b)
15834 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15835 (if (eq exit-after-next 'now) (throw 'exit t))
15836 (goto-char (point-min))
15837 (beginning-of-line 2)
15838 (delete-region (point) (point-at-eol))
15839 (org-fast-tag-insert "Current" current c-face)
15840 (org-set-current-tags-overlay current ov-prefix)
15841 (while (re-search-forward
15843 (setq tg (match-string 1))
15844 (add-text-properties
15845 (match-beginning 1) (match-end 1)
15846 (list 'face
15847 (cond
15848 ((member tg current) c-face)
15849 ((member tg inherited) i-face)
15850 (t (get-text-property (match-beginning 1) 'face))))))
15851 (goto-char (point-min)))))
15852 (org-detach-overlay org-tags-overlay)
15853 (if rtn
15854 (mapconcat 'identity current ":")
15855 nil))))
15857 (defun org-get-tags-string ()
15858 "Get the TAGS string in the current headline."
15859 (unless (org-on-heading-p t)
15860 (error "Not on a heading"))
15861 (save-excursion
15862 (beginning-of-line 1)
15864 (org-match-string-no-properties 1)
15865 "")))
15867 (defun org-get-tags ()
15868 "Get the list of tags specified in the current headline."
15869 (org-split-string (org-get-tags-string) ":"))
15871 (defun org-get-buffer-tags ()
15872 "Get a table of all tags used in the buffer, for completion."
15873 (let (tags)
15874 (save-excursion
15875 (goto-char (point-min))
15876 (while (re-search-forward
15878 (when (equal (char-after (point-at-bol 0)) ?*)
15879 (mapc (lambda (x) (add-to-list 'tags x))
15880 (org-split-string (org-match-string-no-properties 1) ":")))))
15881 (mapcar 'list tags)))
15884 ;;;; Properties
15886 ;;; Setting and retrieving properties
15888 (defconst org-special-properties
15889 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY"
15890 "TIMESTAMP" "TIMESTAMP_IA")
15891 "The special properties valid in Org-mode.
15893 These are properties that are not defined in the property drawer,
15894 but in some other way.")
15896 (defconst org-default-properties
15897 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
15898 "LOCATION" "LOGGING" "COLUMNS")
15899 "Some properties that are used by Org-mode for various purposes.
15900 Being in this list makes sure that they are offered for completion.")
15903 "Regular expression matching the first line of a property drawer.")
15906 "Regular expression matching the first line of a property drawer.")
15908 (defun org-property-action ()
15909 "Do an action on properties."
15910 (interactive)
15911 (let (c)
15912 (org-at-property-p)
15913 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15914 (setq c (read-char-exclusive))
15915 (cond
15916 ((equal c ?s)
15917 (call-interactively 'org-set-property))
15918 ((equal c ?d)
15919 (call-interactively 'org-delete-property))
15920 ((equal c ?D)
15921 (call-interactively 'org-delete-property-globally))
15922 ((equal c ?c)
15923 (call-interactively 'org-compute-property-at-point))
15924 (t (error "No such property action %c" c)))))
15926 (defun org-at-property-p ()
15927 "Is the cursor in a property line?"
15928 ;; FIXME: Does not check if we are actually in the drawer.
15929 ;; FIXME: also returns true on any drawers.....
15930 ;; This is used by C-c C-c for property action.
15931 (save-excursion
15932 (beginning-of-line 1)
15935 (defmacro org-with-point-at (pom &rest body)
15936 "Move to buffer and point of point-or-marker POM for the duration of BODY."
15937 (declare (indent 1) (debug t))
15938 `(save-excursion
15939 (if (markerp pom) (set-buffer (marker-buffer pom)))
15940 (save-excursion
15941 (goto-char (or pom (point)))
15942 ,@body)))
15944 (defun org-get-property-block (&optional beg end force)
15945 "Return the (beg . end) range of the body of the property drawer.
15946 BEG and END can be beginning and end of subtree, if not given
15947 they will be found.
15948 If the drawer does not exist and FORCE is non-nil, create the drawer."
15949 (catch 'exit
15950 (save-excursion
15951 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
15952 (end (or end (progn (outline-next-heading) (point)))))
15953 (goto-char beg)
15954 (if (re-search-forward org-property-start-re end t)
15955 (setq beg (1+ (match-end 0)))
15956 (if force
15957 (save-excursion
15958 (org-insert-property-drawer)
15959 (setq end (progn (outline-next-heading) (point))))
15960 (throw 'exit nil))
15961 (goto-char beg)
15962 (if (re-search-forward org-property-start-re end t)
15963 (setq beg (1+ (match-end 0)))))
15964 (if (re-search-forward org-property-end-re end t)
15965 (setq end (match-beginning 0))
15966 (or force (throw 'exit nil))
15967 (goto-char beg)
15968 (setq end beg)
15969 (org-indent-line-function)
15971 (cons beg end)))))
15973 (defun org-entry-properties (&optional pom which)
15974 "Get all properties of the entry at point-or-marker POM.
15975 This includes the TODO keyword, the tags, time strings for deadline,
15976 scheduled, and clocking, and any additional properties defined in the
15977 entry. The return value is an alist, keys may occur multiple times
15978 if the property key was used several times.
15979 POM may also be nil, in which case the current entry is used.
15980 If WHICH is nil or `all', get all properties. If WHICH is
15981 `special' or `standard', only get that subclass."
15982 (setq which (or which 'all))
15983 (org-with-point-at pom
15984 (let ((clockstr (substring org-clock-string 0 -1))
15985 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
15986 beg end range props sum-props key value string clocksum)
15987 (save-excursion
15988 (when (condition-case nil (org-back-to-heading t) (error nil))
15989 (setq beg (point))
15990 (setq sum-props (get-text-property (point) 'org-summaries))
15991 (setq clocksum (get-text-property (point) :org-clock-minutes))
15992 (outline-next-heading)
15993 (setq end (point))
15994 (when (memq which '(all special))
15995 ;; Get the special properties, like TODO and tags
15996 (goto-char beg)
15997 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15998 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15999 (when (looking-at org-priority-regexp)
16000 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
16001 (when (and (setq value (org-get-tags-string))
16003 (push (cons "TAGS" value) props))
16004 (when (setq value (org-get-tags-at))
16005 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
16006 props))
16007 (while (re-search-forward org-maybe-keyword-time-regexp end t)
16008 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
16009 string (if (equal key clockstr)
16010 (org-no-properties
16011 (org-trim
16012 (buffer-substring
16013 (match-beginning 3) (goto-char (point-at-eol)))))
16014 (substring (org-match-string-no-properties 3) 1 -1)))
16015 (unless key
16016 (if (= (char-after (match-beginning 3)) ?\[)
16017 (setq key "TIMESTAMP_IA")
16018 (setq key "TIMESTAMP")))
16019 (when (or (equal key clockstr) (not (assoc key props)))
16020 (push (cons key string) props)))
16022 )
16024 (when (memq which '(all standard))
16025 ;; Get the standard properties, like :PORP: ...
16026 (setq range (org-get-property-block beg end))
16027 (when range
16028 (goto-char (car range))
16029 (while (re-search-forward
16031 (cdr range) t)
16032 (setq key (org-match-string-no-properties 1)
16033 value (org-trim (or (org-match-string-no-properties 2) "")))
16034 (unless (member key excluded)
16035 (push (cons key (or value "")) props)))))
16036 (if clocksum
16037 (push (cons "CLOCKSUM"
16038 (org-column-number-to-string (/ (float clocksum) 60.)
16039 'add_times))
16040 props))
16041 (append sum-props (nreverse props)))))))
16043 (defun org-entry-get (pom property &optional inherit)
16044 "Get value of PROPERTY for entry at point-or-marker POM.
16045 If INHERIT is non-nil and the entry does not have the property,
16046 then also check higher levels of the hierarchy.
16047 If the property is present but empty, the return value is the empty string.
16048 If the property is not present at all, nil is returned."
16049 (org-with-point-at pom
16050 (if inherit
16051 (org-entry-get-with-inheritance property)
16052 (if (member property org-special-properties)
16053 ;; We need a special property. Use brute force, get all properties.
16054 (cdr (assoc property (org-entry-properties nil 'special)))
16055 (let ((range (org-get-property-block)))
16056 (if (and range
16057 (goto-char (car range))
16058 (re-search-forward
16060 (cdr range) t))
16061 ;; Found the property, return it.
16062 (if (match-end 1)
16063 (org-match-string-no-properties 1)
16064 "")))))))
16066 (defun org-entry-delete (pom property)
16067 "Delete the property PROPERTY from entry at point-or-marker POM."
16068 (org-with-point-at pom
16069 (if (member property org-special-properties)
16070 nil ; cannot delete these properties.
16071 (let ((range (org-get-property-block)))
16072 (if (and range
16073 (goto-char (car range))
16074 (re-search-forward
16076 (cdr range) t))
16077 (progn
16078 (delete-region (match-beginning 0) (1+ (point-at-eol)))
16079 t)
16080 nil)))))
16082 ;; Multi-values properties are properties that contain multiple values
16083 ;; These values are assumed to be single words, separated by whitespace.
16084 (defun org-entry-add-to-multivalued-property (pom property value)
16085 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16086 (let* ((old (org-entry-get pom property))
16088 (unless (member value values)
16089 (setq values (cons value values))
16090 (org-entry-put pom property
16091 (mapconcat 'identity values " ")))))
16093 (defun org-entry-remove-from-multivalued-property (pom property value)
16094 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16095 (let* ((old (org-entry-get pom property))
16097 (when (member value values)
16098 (setq values (delete value values))
16099 (org-entry-put pom property
16100 (mapconcat 'identity values " ")))))
16102 (defun org-entry-member-in-multivalued-property (pom property value)
16103 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16104 (let* ((old (org-entry-get pom property))
16106 (member value values)))
16108 (defvar org-entry-property-inherited-from (make-marker))
16110 (defun org-entry-get-with-inheritance (property)
16111 "Get entry property, and search higher levels if not present."
16112 (let (tmp)
16113 (save-excursion
16114 (save-restriction
16115 (widen)
16116 (catch 'ex
16117 (while t
16118 (when (setq tmp (org-entry-get nil property))
16119 (org-back-to-heading t)
16120 (move-marker org-entry-property-inherited-from (point))
16121 (throw 'ex tmp))
16122 (or (org-up-heading-safe) (throw 'ex nil)))))
16123 (or tmp (cdr (assoc property org-local-properties))
16124 (cdr (assoc property org-global-properties))))))
16126 (defun org-entry-put (pom property value)
16127 "Set PROPERTY to VALUE for entry at point-or-marker POM."
16128 (org-with-point-at pom
16129 (org-back-to-heading t)
16130 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
16131 range)
16132 (cond
16133 ((equal property "TODO")
16135 (not (member value org-todo-keywords-1)))
16137 (if (or (not value)
16139 (setq value 'none))
16140 (org-todo value)
16141 (org-set-tags nil 'align))
16142 ((equal property "PRIORITY")
16144 (string-to-char value) ?\ ))
16145 (org-set-tags nil 'align))
16146 ((equal property "SCHEDULED")
16147 (if (re-search-forward org-scheduled-time-regexp end t)
16148 (cond
16149 ((eq value 'earlier) (org-timestamp-change -1 'day))
16150 ((eq value 'later) (org-timestamp-change 1 'day))
16151 (t (call-interactively 'org-schedule)))
16152 (call-interactively 'org-schedule)))
16153 ((equal property "DEADLINE")
16154 (if (re-search-forward org-deadline-time-regexp end t)
16155 (cond
16156 ((eq value 'earlier) (org-timestamp-change -1 'day))
16157 ((eq value 'later) (org-timestamp-change 1 'day))
16158 (t (call-interactively 'org-deadline)))
16159 (call-interactively 'org-deadline)))
16160 ((member property org-special-properties)
16161 (error "The %s property can not yet be set with `org-entry-put'"
16162 property))
16163 (t ; a non-special property
16164 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
16165 (setq range (org-get-property-block beg end 'force))
16166 (goto-char (car range))
16167 (if (re-search-forward
16169 (progn
16170 (delete-region (match-beginning 1) (match-end 1))
16171 (goto-char (match-beginning 1)))
16172 (goto-char (cdr range))
16174 (backward-char 1)
16175 (org-indent-line-function)
16176 (insert ":" property ":"))
16177 (and value (insert " " value))
16178 (org-indent-line-function)))))))
16180 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
16181 "Get all property keys in the current buffer.
16182 With INCLUDE-SPECIALS, also list the special properties that relect things
16183 like tags and TODO state.
16184 With INCLUDE-DEFAULTS, also include properties that has special meaning
16185 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
16186 With INCLUDE-COLUMNS, also include property names given in COLUMN
16187 formats in the current buffer."
16188 (let (rtn range cfmt cols s p)
16189 (save-excursion
16190 (save-restriction
16191 (widen)
16192 (goto-char (point-min))
16193 (while (re-search-forward org-property-start-re nil t)
16194 (setq range (org-get-property-block))
16195 (goto-char (car range))
16196 (while (re-search-forward
16198 (cdr range) t)
16199 (add-to-list 'rtn (org-match-string-no-properties 1)))
16200 (outline-next-heading))))
16202 (when include-specials
16203 (setq rtn (append org-special-properties rtn)))
16205 (when include-defaults
16206 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
16208 (when include-columns
16209 (save-excursion
16210 (save-restriction
16211 (widen)
16212 (goto-char (point-min))
16213 (while (re-search-forward
16215 nil t)
16216 (setq cfmt (match-string 2) s 0)
16218 cfmt s)
16219 (setq s (match-end 0)
16220 p (match-string 1 cfmt))
16221 (unless (or (equal p "ITEM")
16222 (member p org-special-properties))
16223 (add-to-list 'rtn (match-string 1 cfmt))))))))
16225 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
16227 (defun org-property-values (key)
16228 "Return a list of all values of property KEY."
16229 (save-excursion
16230 (save-restriction
16231 (widen)
16232 (goto-char (point-min))
16234 values)
16235 (while (re-search-forward re nil t)
16236 (add-to-list 'values (org-trim (match-string 1))))
16237 (delete "" values)))))
16239 (defun org-insert-property-drawer ()
16240 "Insert a property drawer into the current entry."
16241 (interactive)
16242 (org-back-to-heading t)
16243 (looking-at outline-regexp)
16244 (let ((indent (- (match-end 0)(match-beginning 0)))
16245 (beg (point))
16247 end hiddenp)
16248 (outline-next-heading)
16249 (setq end (point))
16250 (goto-char beg)
16251 (while (re-search-forward re end t))
16252 (setq hiddenp (org-invisible-p))
16253 (end-of-line 1)
16255 (org-skip-over-state-notes)
16257 (if (eq (char-before) ?*) (forward-char 1))
16259 (beginning-of-line 0)
16260 (indent-to-column indent)
16261 (beginning-of-line 2)
16262 (indent-to-column indent)
16263 (beginning-of-line 0)
16264 (if hiddenp
16265 (save-excursion
16266 (org-back-to-heading t)
16267 (hide-entry))
16268 (org-flag-drawer t))))
16270 (defun org-set-property (property value)
16271 "In the current entry, set PROPERTY to VALUE.
16272 When called interactively, this will prompt for a property name, offering
16273 completion on existing and default properties. And then it will prompt
16274 for a value, offering competion either on allowed values (via an inherited
16275 xxx_ALL property) or on existing values in other instances of this property
16276 in the current file."
16277 (interactive
16278 (let* ((prop (completing-read
16279 "Property: " (mapcar 'list (org-buffer-property-keys nil t t))))
16280 (cur (org-entry-get nil prop))
16281 (allowed (org-property-get-allowed-values nil prop 'table))
16282 (existing (mapcar 'list (org-property-values prop)))
16283 (val (if allowed
16284 (completing-read "Value: " allowed nil 'req-match)
16285 (completing-read
16287 (concat "[" cur "]") "")
16288 ": ")
16289 existing nil nil "" nil cur))))
16290 (list prop (if (equal val "") cur val))))
16291 (unless (equal (org-entry-get nil property) value)
16292 (org-entry-put nil property value)))
16294 (defun org-delete-property (property)
16295 "In the current entry, delete PROPERTY."
16296 (interactive
16297 (let* ((prop (completing-read
16298 "Property: " (org-entry-properties nil 'standard))))
16299 (list prop)))
16300 (message "Property %s %s" property
16301 (if (org-entry-delete nil property)
16302 "deleted"
16303 "was not present in the entry")))
16305 (defun org-delete-property-globally (property)
16306 "Remove PROPERTY globally, from all entries."
16307 (interactive
16308 (let* ((prop (completing-read
16309 "Globally remove property: "
16310 (mapcar 'list (org-buffer-property-keys)))))
16311 (list prop)))
16312 (save-excursion
16313 (save-restriction
16314 (widen)
16315 (goto-char (point-min))
16316 (let ((cnt 0))
16317 (while (re-search-forward
16319 nil t)
16320 (setq cnt (1+ cnt))
16321 (replace-match ""))
16324 (defvar org-columns-current-fmt-compiled) ; defined below
16326 (defun org-compute-property-at-point ()
16327 "Compute the property at point.
16328 This looks for an enclosing column format, extracts the operator and
16329 then applies it to the proerty in the column format's scope."
16330 (interactive)
16331 (unless (org-at-property-p)
16332 (error "Not at a property"))
16333 (let ((prop (org-match-string-no-properties 2)))
16334 (org-columns-get-format-and-top-level)
16335 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16336 (error "No operator defined for property %s" prop))
16337 (org-columns-compute prop)))
16339 (defun org-property-get-allowed-values (pom property &optional table)
16340 "Get allowed values for the property PROPERTY.
16341 When TABLE is non-nil, return an alist that can directly be used for
16342 completion."
16343 (let (vals)
16344 (cond
16345 ((equal property "TODO")
16346 (setq vals (org-with-point-at pom
16347 (append org-todo-keywords-1 '("")))))
16348 ((equal property "PRIORITY")
16349 (let ((n org-lowest-priority))
16350 (while (>= n org-highest-priority)
16351 (push (char-to-string n) vals)
16352 (setq n (1- n)))))
16353 ((member property org-special-properties))
16354 (t
16355 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16358 (setq vals (car (read-from-string (concat "(" vals ")"))))
16359 (setq vals (mapcar (lambda (x)
16360 (cond ((stringp x) x)
16361 ((numberp x) (number-to-string x))
16362 ((symbolp x) (symbol-name x))
16363 (t "???")))
16364 vals)))))
16365 (if table (mapcar 'list vals) vals)))
16367 (defun org-property-previous-allowed-value (&optional previous)
16368 "Switch to the next allowed value for this property."
16369 (interactive)
16370 (org-property-next-allowed-value t))
16372 (defun org-property-next-allowed-value (&optional previous)
16373 "Switch to the next allowed value for this property."
16374 (interactive)
16375 (unless (org-at-property-p)
16376 (error "Not at a property"))
16377 (let* ((key (match-string 2))
16378 (value (match-string 3))
16379 (allowed (or (org-property-get-allowed-values (point) key)
16380 (and (member value '("[ ]" "[-]" "[X]"))
16381 '("[ ]" "[X]"))))
16382 nval)
16383 (unless allowed
16384 (error "Allowed values for this property have not been defined"))
16385 (if previous (setq allowed (reverse allowed)))
16386 (if (member value allowed)
16387 (setq nval (car (cdr (member value allowed)))))
16388 (setq nval (or nval (car allowed)))
16389 (if (equal nval value)
16390 (error "Only one allowed value for this property"))
16391 (org-at-property-p)
16392 (replace-match (concat " :" key ": " nval) t t)
16393 (org-indent-line-function)
16394 (beginning-of-line 1)
16397 (defun org-find-entry-with-id (ident)
16398 "Locate the entry that contains the ID property with exact value IDENT.
16399 IDENT can be a string, a symbol or a number, this function will search for
16400 the string representation of it.
16401 Return the position where this entry starts, or nil if there is no such entry."
16402 (let ((id (cond
16403 ((stringp ident) ident)
16404 ((symbol-name ident) (symbol-name ident))
16405 ((numberp ident) (number-to-string ident))
16406 (t (error "IDENT %s must be a string, symbol or number" ident))))
16407 (case-fold-search nil))
16408 (save-excursion
16409 (save-restriction
16410 (goto-char (point-min))
16411 (when (re-search-forward
16413 nil t)
16414 (org-back-to-heading)
16415 (point))))))
16417 ;;; Column View
16419 (defvar org-columns-overlays nil
16420 "Holds the list of current column overlays.")
16422 (defvar org-columns-current-fmt nil
16423 "Local variable, holds the currently active column format.")
16424 (defvar org-columns-current-fmt-compiled nil
16425 "Local variable, holds the currently active column format.
16426 This is the compiled version of the format.")
16427 (defvar org-columns-current-widths nil
16428 "Loval variable, holds the currently widths of fields.")
16429 (defvar org-columns-current-maxwidths nil
16430 "Loval variable, holds the currently active maximum column widths.")
16431 (defvar org-columns-begin-marker (make-marker)
16432 "Points to the position where last a column creation command was called.")
16433 (defvar org-columns-top-level-marker (make-marker)
16434 "Points to the position where current columns region starts.")
16436 (defvar org-columns-map (make-sparse-keymap)
16437 "The keymap valid in column display.")
16439 (defun org-columns-content ()
16440 "Switch to contents view while in columns view."
16441 (interactive)
16442 (org-overview)
16443 (org-content))
16445 (org-defkey org-columns-map "c" 'org-columns-content)
16446 (org-defkey org-columns-map "o" 'org-overview)
16447 (org-defkey org-columns-map "e" 'org-columns-edit-value)
16448 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
16449 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
16450 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
16451 (org-defkey org-columns-map "v" 'org-columns-show-value)
16452 (org-defkey org-columns-map "q" 'org-columns-quit)
16453 (org-defkey org-columns-map "r" 'org-columns-redo)
16454 (org-defkey org-columns-map "g" 'org-columns-redo)
16455 (org-defkey org-columns-map [left] 'backward-char)
16456 (org-defkey org-columns-map "\M-b" 'backward-char)
16457 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
16458 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
16459 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
16460 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
16461 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
16462 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
16463 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
16464 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
16465 (org-defkey org-columns-map "<" 'org-columns-narrow)
16466 (org-defkey org-columns-map ">" 'org-columns-widen)
16467 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
16468 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
16469 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
16470 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
16472 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
16473 '("Column"
16474 ["Edit property" org-columns-edit-value t]
16475 ["Next allowed value" org-columns-next-allowed-value t]
16476 ["Previous allowed value" org-columns-previous-allowed-value t]
16477 ["Show full value" org-columns-show-value t]
16478 ["Edit allowed values" org-columns-edit-allowed t]
16479 "--"
16480 ["Edit column attributes" org-columns-edit-attributes t]
16481 ["Increase column width" org-columns-widen t]
16482 ["Decrease column width" org-columns-narrow t]
16483 "--"
16484 ["Move column right" org-columns-move-right t]
16485 ["Move column left" org-columns-move-left t]
16486 ["Add column" org-columns-new t]
16487 ["Delete column" org-columns-delete t]
16488 "--"
16489 ["CONTENTS" org-columns-content t]
16490 ["OVERVIEW" org-overview t]
16491 ["Refresh columns display" org-columns-redo t]
16492 "--"
16493 ["Open link" org-columns-open-link t]
16494 "--"
16495 ["Quit" org-columns-quit t]))
16497 (defun org-columns-new-overlay (beg end &optional string face)
16498 "Create a new column overlay and add it to the list."
16499 (let ((ov (org-make-overlay beg end)))
16500 (org-overlay-put ov 'face (or face 'secondary-selection))
16501 (org-overlay-display ov string face)
16502 (push ov org-columns-overlays)
16503 ov))
16505 (defun org-columns-display-here (&optional props)
16506 "Overlay the current line with column display."
16507 (interactive)
16508 (let* ((fmt org-columns-current-fmt-compiled)
16509 (beg (point-at-bol))
16510 (level-face (save-excursion
16511 (beginning-of-line 1)
16513 (org-get-level-face 2))))
16514 (color (list :foreground
16515 (face-attribute (or level-face 'default) :foreground)))
16516 props pom property ass width f string ov column val modval)
16517 ;; Check if the entry is in another buffer.
16518 (unless props
16519 (if (eq major-mode 'org-agenda-mode)
16520 (setq pom (or (get-text-property (point) 'org-hd-marker)
16521 (get-text-property (point) 'org-marker))
16522 props (if pom (org-entry-properties pom) nil))
16523 (setq props (org-entry-properties nil))))
16524 ;; Walk the format
16525 (while (setq column (pop fmt))
16526 (setq property (car column)
16527 ass (if (equal property "ITEM")
16528 (cons "ITEM"
16529 (save-match-data
16530 (org-no-properties
16531 (org-remove-tabs
16532 (buffer-substring-no-properties
16533 (point-at-bol) (point-at-eol))))))
16534 (assoc property props))
16535 width (or (cdr (assoc property org-columns-current-maxwidths))
16536 (nth 2 column)
16537 (length property))
16538 f (format "%%-%d.%ds | " width width)
16539 val (or (cdr ass) "")
16540 modval (if (equal property "ITEM")
16541 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
16542 string (format f (or modval val)))
16543 ;; Create the overlay
16544 (org-unmodified
16545 (setq ov (org-columns-new-overlay
16546 beg (setq beg (1+ beg)) string
16547 (list color 'org-column)))
16548 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
16549 (org-overlay-put ov 'keymap org-columns-map)
16550 (org-overlay-put ov 'org-columns-key property)
16551 (org-overlay-put ov 'org-columns-value (cdr ass))
16552 (org-overlay-put ov 'org-columns-value-modified modval)
16553 (org-overlay-put ov 'org-columns-pom pom)
16554 (org-overlay-put ov 'org-columns-format f))
16555 (if (or (not (char-after beg))
16557 (let ((inhibit-read-only t))
16558 (save-excursion
16559 (goto-char beg)
16560 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
16561 ;; Make the rest of the line disappear.
16562 (org-unmodified
16563 (setq ov (org-columns-new-overlay beg (point-at-eol)))
16564 (org-overlay-put ov 'invisible t)
16565 (org-overlay-put ov 'keymap org-columns-map)
16566 (org-overlay-put ov 'intangible t)
16567 (push ov org-columns-overlays)
16568 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
16569 (org-overlay-put ov 'keymap org-columns-map)
16570 (push ov org-columns-overlays)
16571 (let ((inhibit-read-only t))
16572 (put-text-property (max (point-min) (1- (point-at-bol)))
16573 (min (point-max) (1+ (point-at-eol)))
16574 'read-only "Type `e' to edit property")))))
16576 (defvar org-previous-header-line-format nil
16577 "The header line format before column view was turned on.")
16578 (defvar org-columns-inhibit-recalculation nil
16579 "Inhibit recomputing of columns on column view startup.")
16582 (defvar header-line-format)
16583 (defun org-columns-display-here-title ()
16584 "Overlay the newline before the current line with the table title."
16585 (interactive)
16586 (let ((fmt org-columns-current-fmt-compiled)
16587 string (title "")
16588 property width f column str widths)
16589 (while (setq column (pop fmt))
16590 (setq property (car column)
16591 str (or (nth 1 column) property)
16592 width (or (cdr (assoc property org-columns-current-maxwidths))
16593 (nth 2 column)
16594 (length str))
16595 widths (push width widths)
16596 f (format "%%-%d.%ds | " width width)
16597 string (format f str)
16598 title (concat title string)))
16599 (setq title (concat
16600 (org-add-props " " nil 'display '(space :align-to 0))
16601 (org-add-props title nil 'face '(:weight bold :underline t))))
16602 (org-set-local 'org-previous-header-line-format header-line-format)
16603 (org-set-local 'org-columns-current-widths (nreverse widths))
16604 (setq header-line-format title)))
16606 (defun org-columns-remove-overlays ()
16607 "Remove all currently active column overlays."
16608 (interactive)
16609 (when (marker-buffer org-columns-begin-marker)
16610 (with-current-buffer (marker-buffer org-columns-begin-marker)
16611 (when (local-variable-p 'org-previous-header-line-format)
16612 (setq header-line-format org-previous-header-line-format)
16613 (kill-local-variable 'org-previous-header-line-format))
16614 (move-marker org-columns-begin-marker nil)
16615 (move-marker org-columns-top-level-marker nil)
16616 (org-unmodified
16617 (mapc 'org-delete-overlay org-columns-overlays)
16618 (setq org-columns-overlays nil)
16619 (let ((inhibit-read-only t))
16620 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
16622 (defun org-columns-cleanup-item (item fmt)
16623 "Remove from ITEM what is a column in the format FMT."
16624 (if (not org-complex-heading-regexp)
16625 item
16626 (when (string-match org-complex-heading-regexp item)
16627 (concat
16628 (org-add-props (concat (match-string 1 item) " ") nil
16629 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
16630 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
16631 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
16632 " " (match-string 4 item)
16633 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
16635 (defun org-columns-show-value ()
16636 "Show the full value of the property."
16637 (interactive)
16638 (let ((value (get-char-property (point) 'org-columns-value)))
16639 (message "Value is: %s" (or value ""))))
16641 (defun org-columns-quit ()
16642 "Remove the column overlays and in this way exit column editing."
16643 (interactive)
16644 (org-unmodified
16645 (org-columns-remove-overlays)
16646 (let ((inhibit-read-only t))
16647 (remove-text-properties (point-min) (point-max) '(read-only t))))
16648 (when (eq major-mode 'org-agenda-mode)
16649 (message
16650 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
16652 (defun org-columns-check-computed ()
16653 "Check if this column value is computed.
16654 If yes, throw an error indicating that changing it does not make sense."
16655 (let ((val (get-char-property (point) 'org-columns-value)))
16656 (when (and (stringp val)
16657 (get-char-property 0 'org-computed val))
16658 (error "This value is computed from the entry's children"))))
16660 (defun org-columns-todo (&optional arg)
16661 "Change the TODO state during column view."
16662 (interactive "P")
16663 (org-columns-edit-value "TODO"))
16665 (defun org-columns-set-tags-or-toggle (&optional arg)
16666 "Toggle checkbox at point, or set tags for current headline."
16667 (interactive "P")
16669 (get-char-property (point) 'org-columns-value))
16670 (org-columns-next-allowed-value)
16671 (org-columns-edit-value "TAGS")))
16673 (defun org-columns-edit-value (&optional key)
16674 "Edit the value of the property at point in column view.
16675 Where possible, use the standard interface for changing this line."
16676 (interactive)
16677 (org-columns-check-computed)
16678 (let* ((external-key key)
16679 (col (current-column))
16680 (key (or key (get-char-property (point) 'org-columns-key)))
16681 (value (get-char-property (point) 'org-columns-value))
16682 (bol (point-at-bol)) (eol (point-at-eol))
16683 (pom (or (get-text-property bol 'org-hd-marker)
16684 (point))) ; keep despite of compiler waring
16685 (line-overlays
16686 (delq nil (mapcar (lambda (x)
16687 (and (eq (overlay-buffer x) (current-buffer))
16688 (>= (overlay-start x) bol)
16689 (<= (overlay-start x) eol)
16690 x))
16691 org-columns-overlays)))
16692 nval eval allowed)
16693 (cond
16694 ((equal key "CLOCKSUM")
16695 (error "This special column cannot be edited"))
16696 ((equal key "ITEM")
16697 (setq eval '(org-with-point-at pom
16698 (org-edit-headline))))
16699 ((equal key "TODO")
16700 (setq eval '(org-with-point-at pom
16701 (let ((current-prefix-arg
16702 (if external-key current-prefix-arg '(4))))
16703 (call-interactively 'org-todo)))))
16704 ((equal key "PRIORITY")
16705 (setq eval '(org-with-point-at pom
16706 (call-interactively 'org-priority))))
16707 ((equal key "TAGS")
16708 (setq eval '(org-with-point-at pom
16709 (let ((org-fast-tag-selection-single-key
16710 (if (eq org-fast-tag-selection-single-key 'expert)
16711 t org-fast-tag-selection-single-key)))
16712 (call-interactively 'org-set-tags)))))
16713 ((equal key "DEADLINE")
16714 (setq eval '(org-with-point-at pom
16715 (call-interactively 'org-deadline))))
16716 ((equal key "SCHEDULED")
16717 (setq eval '(org-with-point-at pom
16718 (call-interactively 'org-schedule))))
16719 (t
16720 (setq allowed (org-property-get-allowed-values pom key 'table))
16721 (if allowed
16722 (setq nval (completing-read "Value: " allowed nil t))
16723 (setq nval (read-string "Edit: " value)))
16724 (setq nval (org-trim nval))
16725 (when (not (equal nval value))
16726 (setq eval '(org-entry-put pom key nval)))))
16727 (when eval
16728 (let ((inhibit-read-only t))
16729 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
16730 (unwind-protect
16731 (progn
16732 (setq org-columns-overlays
16733 (org-delete-all line-overlays org-columns-overlays))
16734 (mapc 'org-delete-overlay line-overlays)
16735 (org-columns-eval eval))
16736 (org-columns-display-here))))
16737 (move-to-column col)
16738 (if (and (org-mode-p)
16739 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16740 (org-columns-update key))))
16742 (defun org-edit-headline () ; FIXME: this is not columns specific
16743 "Edit the current headline, the part without TODO keyword, TAGS."
16744 (org-back-to-heading)
16745 (when (looking-at org-todo-line-regexp)
16746 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
16747 (txt (match-string 3))
16748 (post "")
16749 txt2)
16751 (setq post (match-string 0 txt)
16752 txt (substring txt 0 (match-beginning 0))))
16753 (setq txt2 (read-string "Edit: " txt))
16754 (when (not (equal txt txt2))
16755 (beginning-of-line 1)
16756 (insert pre txt2 post)
16757 (delete-region (point) (point-at-eol))
16758 (org-set-tags nil t)))))
16760 (defun org-columns-edit-allowed ()
16761 "Edit the list of allowed values for the current property."
16762 (interactive)
16763 (let* ((key (get-char-property (point) 'org-columns-key))
16764 (key1 (concat key "_ALL"))
16765 (allowed (org-entry-get (point) key1 t))
16766 nval)
16767 ;; FIXME: Cover editing TODO, TAGS etc in-buffer settings.????
16768 (setq nval (read-string "Allowed: " allowed))
16769 (org-entry-put
16770 (cond ((marker-position org-entry-property-inherited-from)
16771 org-entry-property-inherited-from)
16772 ((marker-position org-columns-top-level-marker)
16773 org-columns-top-level-marker))
16774 key1 nval)))
16776 (defmacro org-no-warnings (&rest body)
16777 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
16779 (defun org-columns-eval (form)
16780 (let (hidep)
16781 (save-excursion
16782 (beginning-of-line 1)
16783 ;; `next-line' is needed here, because it skips invisible line.
16784 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
16785 (setq hidep (org-on-heading-p 1)))
16786 (eval form)
16787 (and hidep (hide-entry))))
16789 (defun org-columns-previous-allowed-value ()
16790 "Switch to the previous allowed value for this column."
16791 (interactive)
16792 (org-columns-next-allowed-value t))
16794 (defun org-columns-next-allowed-value (&optional previous)
16795 "Switch to the next allowed value for this column."
16796 (interactive)
16797 (org-columns-check-computed)
16798 (let* ((col (current-column))
16799 (key (get-char-property (point) 'org-columns-key))
16800 (value (get-char-property (point) 'org-columns-value))
16801 (bol (point-at-bol)) (eol (point-at-eol))
16802 (pom (or (get-text-property bol 'org-hd-marker)
16803 (point))) ; keep despite of compiler waring
16804 (line-overlays
16805 (delq nil (mapcar (lambda (x)
16806 (and (eq (overlay-buffer x) (current-buffer))
16807 (>= (overlay-start x) bol)
16808 (<= (overlay-start x) eol)
16809 x))
16810 org-columns-overlays)))
16811 (allowed (or (org-property-get-allowed-values pom key)
16812 (and (memq
16813 (nth 4 (assoc key org-columns-current-fmt-compiled))
16814 '(checkbox checkbox-n-of-m checkbox-percent))
16815 '("[ ]" "[X]"))))
16816 nval)
16817 (when (equal key "ITEM")
16818 (error "Cannot edit item headline from here"))
16819 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
16820 (error "Allowed values for this property have not been defined"))
16821 (if (member key '("SCHEDULED" "DEADLINE"))
16822 (setq nval (if previous 'earlier 'later))
16823 (if previous (setq allowed (reverse allowed)))
16824 (if (member value allowed)
16825 (setq nval (car (cdr (member value allowed)))))
16826 (setq nval (or nval (car allowed)))
16827 (if (equal nval value)
16828 (error "Only one allowed value for this property")))
16829 (let ((inhibit-read-only t))
16830 (remove-text-properties (1- bol) eol '(read-only t))
16831 (unwind-protect
16832 (progn
16833 (setq org-columns-overlays
16834 (org-delete-all line-overlays org-columns-overlays))
16835 (mapc 'org-delete-overlay line-overlays)
16836 (org-columns-eval '(org-entry-put pom key nval)))
16837 (org-columns-display-here)))
16838 (move-to-column col)
16839 (if (and (org-mode-p)
16840 (nth 3 (assoc key org-columns-current-fmt-compiled)))
16841 (org-columns-update key))))
16843 (defun org-verify-version (task)
16844 (cond
16845 ((eq task 'columns)
16846 (if (or (featurep 'xemacs)
16847 (< emacs-major-version 22))
16848 (error "Emacs 22 is required for the columns feature")))))
16850 (defun org-columns-open-link (&optional arg)
16851 (interactive "P")
16852 (let ((value (get-char-property (point) 'org-columns-value)))
16853 (org-open-link-from-string value arg)))
16855 (defun org-open-link-from-string (s &optional arg)
16856 "Open a link in the string S, as if it was in Org-mode."
16857 (interactive)
16858 (with-temp-buffer
16859 (let ((org-inhibit-startup t))
16860 (org-mode)
16861 (insert s)
16862 (goto-char (point-min))
16863 (org-open-at-point arg))))
16865 (defun org-columns-get-format-and-top-level ()
16866 (let (fmt)
16867 (when (condition-case nil (org-back-to-heading) (error nil))
16868 (move-marker org-entry-property-inherited-from nil)
16869 (setq fmt (org-entry-get nil "COLUMNS" t)))
16870 (setq fmt (or fmt org-columns-default-format))
16871 (org-set-local 'org-columns-current-fmt fmt)
16872 (org-columns-compile-format fmt)
16873 (if (marker-position org-entry-property-inherited-from)
16874 (move-marker org-columns-top-level-marker
16875 org-entry-property-inherited-from)
16876 (move-marker org-columns-top-level-marker (point)))
16877 fmt))
16879 (defun org-columns ()
16880 "Turn on column view on an org-mode file."
16881 (interactive)
16882 (org-verify-version 'columns)
16883 (org-columns-remove-overlays)
16884 (move-marker org-columns-begin-marker (point))
16885 (let (beg end fmt cache maxwidths)
16886 (setq fmt (org-columns-get-format-and-top-level))
16887 (save-excursion
16888 (goto-char org-columns-top-level-marker)
16889 (setq beg (point))
16890 (unless org-columns-inhibit-recalculation
16891 (org-columns-compute-all))
16892 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
16893 (point-max)))
16894 ;; Get and cache the properties
16895 (goto-char beg)
16896 (when (assoc "CLOCKSUM" org-columns-current-fmt-compiled)
16897 (save-excursion
16898 (save-restriction
16899 (narrow-to-region beg end)
16900 (org-clock-sum))))
16901 (while (re-search-forward (concat "^" outline-regexp) end t)
16902 (push (cons (org-current-line) (org-entry-properties)) cache))
16903 (when cache
16904 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
16905 (org-set-local 'org-columns-current-maxwidths maxwidths)
16906 (org-columns-display-here-title)
16907 (mapc (lambda (x)
16908 (goto-line (car x))
16909 (org-columns-display-here (cdr x)))
16910 cache)))))
16912 (defun org-columns-new (&optional prop title width op fmt &rest rest)
16913 "Insert a new column, to the leeft o the current column."
16914 (interactive)
16915 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
16916 cell)
16917 (setq prop (completing-read
16918 "Property: " (mapcar 'list (org-buffer-property-keys t nil t))
16919 nil nil prop))
16920 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
16921 (setq width (read-string "Column width: " (if width (number-to-string width))))
16923 (setq width (string-to-number width))
16924 (setq width nil))
16925 (setq fmt (completing-read "Summary [none]: "
16926 '(("none") ("add_numbers") ("currency") ("add_times") ("checkbox") ("checkbox-n-of-m") ("checkbox-percent"))
16927 nil t))
16929 (setq fmt (intern fmt))
16930 (setq fmt nil))
16931 (if (eq fmt 'none) (setq fmt nil))
16932 (if editp
16933 (progn
16934 (setcar editp prop)
16935 (setcdr editp (list title width nil fmt)))
16936 (setq cell (nthcdr (1- (current-column))
16937 org-columns-current-fmt-compiled))
16938 (setcdr cell (cons (list prop title width nil fmt)
16939 (cdr cell))))
16940 (org-columns-store-format)
16941 (org-columns-redo)))
16943 (defun org-columns-delete ()
16944 "Delete the column at point from columns view."
16945 (interactive)
16946 (let* ((n (current-column))
16947 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
16948 (when (y-or-n-p
16950 (setq org-columns-current-fmt-compiled
16951 (delq (nth n org-columns-current-fmt-compiled)
16952 org-columns-current-fmt-compiled))
16953 (org-columns-store-format)
16954 (org-columns-redo)
16955 (if (>= (current-column) (length org-columns-current-fmt-compiled))
16956 (backward-char 1)))))
16958 (defun org-columns-edit-attributes ()
16959 "Edit the attributes of the current column."
16960 (interactive)
16961 (let* ((n (current-column))
16962 (info (nth n org-columns-current-fmt-compiled)))
16963 (apply 'org-columns-new info)))
16965 (defun org-columns-widen (arg)
16966 "Make the column wider by ARG characters."
16967 (interactive "p")
16968 (let* ((n (current-column))
16969 (entry (nth n org-columns-current-fmt-compiled))
16970 (width (or (nth 2 entry)
16971 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
16972 (setq width (max 1 (+ width arg)))
16973 (setcar (nthcdr 2 entry) width)
16974 (org-columns-store-format)
16975 (org-columns-redo)))
16977 (defun org-columns-narrow (arg)
16978 "Make the column nrrower by ARG characters."
16979 (interactive "p")
16980 (org-columns-widen (- arg)))
16982 (defun org-columns-move-right ()
16983 "Swap this column with the one to the right."
16984 (interactive)
16985 (let* ((n (current-column))
16986 (cell (nthcdr n org-columns-current-fmt-compiled))
16987 e)
16988 (when (>= n (1- (length org-columns-current-fmt-compiled)))
16989 (error "Cannot shift this column further to the right"))
16990 (setq e (car cell))
16991 (setcar cell (car (cdr cell)))
16992 (setcdr cell (cons e (cdr (cdr cell))))
16993 (org-columns-store-format)
16994 (org-columns-redo)
16995 (forward-char 1)))
16997 (defun org-columns-move-left ()
16998 "Swap this column with the one to the left."
16999 (interactive)
17000 (let* ((n (current-column)))
17001 (when (= n 0)
17002 (error "Cannot shift this column further to the left"))
17003 (backward-char 1)
17004 (org-columns-move-right)
17005 (backward-char 1)))
17007 (defun org-columns-store-format ()
17008 "Store the text version of the current columns format in appropriate place.
17009 This is either in the COLUMNS property of the node starting the current column
17010 display, or in the #+COLUMNS line of the current buffer."
17011 (let (fmt (cnt 0))
17012 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
17013 (org-set-local 'org-columns-current-fmt fmt)
17014 (if (marker-position org-columns-top-level-marker)
17015 (save-excursion
17016 (goto-char org-columns-top-level-marker)
17017 (if (and (org-at-heading-p)
17018 (org-entry-get nil "COLUMNS"))
17019 (org-entry-put nil "COLUMNS" fmt)
17020 (goto-char (point-min))
17021 ;; Overwrite all #+COLUMNS lines....
17023 (setq cnt (1+ cnt))
17024 (replace-match (concat "#+COLUMNS: " fmt) t t))
17025 (unless (> cnt 0)
17026 (goto-char (point-min))
17027 (or (org-on-heading-p t) (outline-next-heading))
17028 (let ((inhibit-read-only t))
17030 (org-set-local 'org-columns-default-format fmt))))))
17032 (defvar org-overriding-columns-format nil
17033 "When set, overrides any other definition.")
17034 (defvar org-agenda-view-columns-initially nil
17035 "When set, switch to columns view immediately after creating the agenda.")
17037 (defun org-agenda-columns ()
17038 "Turn on column view in the agenda."
17039 (interactive)
17040 (org-verify-version 'columns)
17041 (org-columns-remove-overlays)
17042 (move-marker org-columns-begin-marker (point))
17043 (let (fmt cache maxwidths m)
17044 (cond
17045 ((and (local-variable-p 'org-overriding-columns-format)
17046 org-overriding-columns-format)
17047 (setq fmt org-overriding-columns-format))
17048 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
17049 (setq fmt (org-entry-get m "COLUMNS" t)))
17050 ((and (boundp 'org-columns-current-fmt)
17051 (local-variable-p 'org-columns-current-fmt)
17052 org-columns-current-fmt)
17053 (setq fmt org-columns-current-fmt))
17054 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
17055 (setq m (get-text-property m 'org-hd-marker))
17056 (setq fmt (org-entry-get m "COLUMNS" t))))
17057 (setq fmt (or fmt org-columns-default-format))
17058 (org-set-local 'org-columns-current-fmt fmt)
17059 (org-columns-compile-format fmt)
17060 (save-excursion
17061 ;; Get and cache the properties
17062 (goto-char (point-min))
17063 (while (not (eobp))
17064 (when (setq m (or (get-text-property (point) 'org-hd-marker)
17065 (get-text-property (point) 'org-marker)))
17066 (push (cons (org-current-line) (org-entry-properties m)) cache))
17067 (beginning-of-line 2))
17068 (when cache
17069 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
17070 (org-set-local 'org-columns-current-maxwidths maxwidths)
17071 (org-columns-display-here-title)
17072 (mapc (lambda (x)
17073 (goto-line (car x))
17074 (org-columns-display-here (cdr x)))
17075 cache)))))
17077 (defun org-columns-get-autowidth-alist (s cache)
17078 "Derive the maximum column widths from the format and the cache."
17079 (let ((start 0) rtn)
17081 (push (cons (match-string 1 s) 1) rtn)
17082 (setq start (match-end 0)))
17083 (mapc (lambda (x)
17084 (setcdr x (apply 'max
17085 (mapcar
17086 (lambda (y)
17087 (length (or (cdr (assoc (car x) (cdr y))) " ")))
17088 cache))))
17089 rtn)
17090 rtn))
17092 (defun org-columns-compute-all ()
17093 "Compute all columns that have operators defined."
17094 (org-unmodified
17095 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
17096 (let ((columns org-columns-current-fmt-compiled) col)
17097 (while (setq col (pop columns))
17098 (when (nth 3 col)
17099 (save-excursion
17100 (org-columns-compute (car col)))))))
17102 (defun org-columns-update (property)
17103 "Recompute PROPERTY, and update the columns display for it."
17104 (org-columns-compute property)
17105 (let (fmt val pos)
17106 (save-excursion
17107 (mapc (lambda (ov)
17108 (when (equal (org-overlay-get ov 'org-columns-key) property)
17109 (setq pos (org-overlay-start ov))
17110 (goto-char pos)
17111 (when (setq val (cdr (assoc property
17112 (get-text-property
17113 (point-at-bol) 'org-summaries))))
17114 (setq fmt (org-overlay-get ov 'org-columns-format))
17115 (org-overlay-put ov 'org-columns-value val)
17116 (org-overlay-put ov 'display (format fmt val)))))
17117 org-columns-overlays))))
17119 (defun org-columns-compute (property)
17120 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
17121 (interactive)
17122 (let* ((re (concat "^" outline-regexp))
17123 (lmax 30) ; Does anyone use deeper levels???
17124 (lsum (make-vector lmax 0))
17125 (lflag (make-vector lmax nil))
17126 (level 0)
17127 (ass (assoc property org-columns-current-fmt-compiled))
17128 (format (nth 4 ass))
17129 (printf (nth 5 ass))
17130 (beg org-columns-top-level-marker)
17131 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
17132 (save-excursion
17133 ;; Find the region to compute
17134 (goto-char beg)
17135 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
17136 (goto-char end)
17137 ;; Walk the tree from the back and do the computations
17138 (while (re-search-backward re beg t)
17139 (setq sumpos (match-beginning 0)
17140 last-level level
17141 level (org-outline-level)
17142 val (org-entry-get nil property)
17144 (cond
17145 ((< level last-level)
17146 ;; put the sum of lower levels here as a property
17147 (setq sum (aref lsum last-level) ; current sum
17148 flag (aref lflag last-level) ; any valid entries from children?
17149 str (org-column-number-to-string sum format printf)
17150 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
17151 useval (if flag str1 (if valflag val ""))
17152 sum-alist (get-text-property sumpos 'org-summaries))
17153 (if (assoc property sum-alist)
17154 (setcdr (assoc property sum-alist) useval)
17155 (push (cons property useval) sum-alist)
17156 (org-unmodified
17157 (add-text-properties sumpos (1+ sumpos)
17158 (list 'org-summaries sum-alist))))
17159 (when val
17160 (org-entry-put nil property (if flag str val)))
17161 ;; add current to current level accumulator
17162 (when (or flag valflag)
17163 (aset lsum level (+ (aref lsum level)
17164 (if flag sum (org-column-string-to-number
17165 (if flag str val) format))))
17166 (aset lflag level t))
17167 ;; clear accumulators for deeper levels
17168 (loop for l from (1+ level) to (1- lmax) do
17169 (aset lsum l 0)
17170 (aset lflag l nil)))
17171 ((>= level last-level)
17172 ;; add what we have here to the accumulator for this level
17173 (aset lsum level (+ (aref lsum level)
17174 (org-column-string-to-number (or val "0") format)))
17175 (and valflag (aset lflag level t)))
17176 (t (error "This should not happen")))))))
17178 (defun org-columns-redo ()
17179 "Construct the column display again."
17180 (interactive)
17181 (message "Recomputing columns...")
17182 (save-excursion
17183 (if (marker-position org-columns-begin-marker)
17184 (goto-char org-columns-begin-marker))
17185 (org-columns-remove-overlays)
17186 (if (org-mode-p)
17187 (call-interactively 'org-columns)
17188 (call-interactively 'org-agenda-columns)))
17189 (message "Recomputing columns...done"))
17191 (defun org-columns-not-in-agenda ()
17192 (if (eq major-mode 'org-agenda-mode)
17193 (error "This command is only allowed in Org-mode buffers")))
17196 (defun org-string-to-number (s)
17197 "Convert string to number, and interpret hh:mm:ss."
17198 (if (not (string-match ":" s))
17199 (string-to-number s)
17200 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17201 (while l
17202 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17203 sum)))
17205 (defun org-column-number-to-string (n fmt &optional printf)
17206 "Convert a computed column number to a string value, according to FMT."
17207 (cond
17208 ((eq fmt 'add_times)
17209 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
17210 (format "%d:%02d" h m)))
17211 ((eq fmt 'checkbox)
17212 (cond ((= n (floor n)) "[X]")
17213 ((> n 1.) "[-]")
17214 (t "[ ]")))
17215 ((memq fmt '(checkbox-n-of-m checkbox-percent))
17216 (let* ((n1 (floor n)) (n2 (floor (+ .5 (* 1000000 (- n n1))))))
17217 (org-nofm-to-completion n1 (+ n2 n1) (eq fmt 'checkbox-percent))))
17218 (printf (format printf n))
17219 ((eq fmt 'currency)
17220 (format "%.2f" n))
17221 (t (number-to-string n))))
17223 (defun org-nofm-to-completion (n m &optional percent)
17224 (if (not percent)
17225 (format "[%d/%d]" n m)
17226 (format "[%d%%]"(floor (+ 0.5 (* 100. (/ (* 1.0 n) m)))))))
17228 (defun org-column-string-to-number (s fmt)
17229 "Convert a column value to a number that can be used for column computing."
17230 (cond
17231 ((string-match ":" s)
17232 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
17233 (while l
17234 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
17235 sum))
17236 ((memq fmt '(checkbox checkbox-n-of-m checkbox-percent))
17237 (if (equal s "[X]") 1. 0.000001))
17238 (t (string-to-number s))))
17240 (defun org-columns-uncompile-format (cfmt)
17241 "Turn the compiled columns format back into a string representation."
17242 (let ((rtn "") e s prop title op width fmt printf)
17243 (while (setq e (pop cfmt))
17244 (setq prop (car e)
17245 title (nth 1 e)
17246 width (nth 2 e)
17247 op (nth 3 e)
17248 fmt (nth 4 e)
17249 printf (nth 5 e))
17250 (cond
17251 ((eq fmt 'add_times) (setq op ":"))
17252 ((eq fmt 'checkbox) (setq op "X"))
17253 ((eq fmt 'checkbox-n-of-m) (setq op "X/"))
17254 ((eq fmt 'checkbox-percent) (setq op "X%"))
17255 ((eq fmt 'add_numbers) (setq op "+"))
17256 ((eq fmt 'currency) (setq op "$")))
17257 (if (and op printf) (setq op (concat op ";" printf)))
17258 (if (equal title prop) (setq title nil))
17259 (setq s (concat "%" (if width (number-to-string width))
17260 prop
17261 (if title (concat "(" title ")"))
17262 (if op (concat "{" op "}"))))
17263 (setq rtn (concat rtn " " s)))
17264 (org-trim rtn)))
17266 (defun org-columns-compile-format (fmt)
17267 "Turn a column format string into an alist of specifications.
17268 The alist has one entry for each column in the format. The elements of
17269 that list are:
17270 property the property
17271 title the title field for the columns
17272 width the column width in characters, can be nil for automatic
17273 operator the operator if any
17274 format the output format for computed results, derived from operator
17275 printf a printf format for computed values"
17276 (let ((start 0) width prop title op f printf)
17277 (setq org-columns-current-fmt-compiled nil)
17278 (while (string-match
17279 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
17280 fmt start)
17281 (setq start (match-end 0)
17282 width (match-string 1 fmt)
17283 prop (match-string 2 fmt)
17284 title (or (match-string 3 fmt) prop)
17285 op (match-string 4 fmt)
17286 f nil
17287 printf nil)
17288 (if width (setq width (string-to-number width)))
17289 (when (and op (string-match ";" op))
17290 (setq printf (substring op (match-end 0))
17291 op (substring op 0 (match-beginning 0))))
17292 (cond
17293 ((equal op "+") (setq f 'add_numbers))
17294 ((equal op "$") (setq f 'currency))
17295 ((equal op ":") (setq f 'add_times))
17296 ((equal op "X") (setq f 'checkbox))
17297 ((equal op "X/") (setq f 'checkbox-n-of-m))
17298 ((equal op "X%") (setq f 'checkbox-percent))
17299 )
17300 (push (list prop title width op f printf) org-columns-current-fmt-compiled))
17301 (setq org-columns-current-fmt-compiled
17302 (nreverse org-columns-current-fmt-compiled))))
17305 ;;; Dynamic block for Column view
17307 (defun org-columns-capture-view ()
17308 "Get the column view of the current buffer and return it as a list.
17309 The list will contains the title row and all other rows. Each row is
17310 a list of fields."
17311 (save-excursion
17312 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
17313 (n (length title)) row tbl)
17314 (goto-char (point-min))
17316 (when (get-char-property (match-beginning 0) 'org-columns-key)
17317 (setq row nil)
17318 (loop for i from 0 to (1- n) do
17319 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
17320 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
17321 "")
17322 row))
17323 (setq row (nreverse row))
17324 (push row tbl)))
17325 (append (list title 'hline) (nreverse tbl)))))
17327 (defun org-dblock-write:columnview (params)
17328 "Write the column view table.
17329 PARAMS is a property list of parameters:
17331 :width enforce same column widths with <N> specifiers.
17332 :id the :ID: property of the entry where the columns view
17333 should be built, as a string. When `local', call locally.
17334 When `global' call column view with the cursor at the beginning
17335 of the buffer (usually this means that the whole buffer switches
17336 to column view).
17337 :hlines When t, insert a hline before each item. When a number, insert
17338 a hline before each level <= that number.
17339 :vlines When t, make each column a colgroup to enforce vertical lines."
17340 (let ((pos (move-marker (make-marker) (point)))
17341 (hlines (plist-get params :hlines))
17342 (vlines (plist-get params :vlines))
17343 tbl id idpos nfields tmp)
17344 (save-excursion
17345 (save-restriction
17346 (when (setq id (plist-get params :id))
17347 (cond ((not id) nil)
17348 ((eq id 'global) (goto-char (point-min)))
17349 ((eq id 'local) nil)
17350 ((setq idpos (org-find-entry-with-id id))
17351 (goto-char idpos))
17352 (t (error "Cannot find entry with :ID: %s" id))))
17353 (org-columns)
17354 (setq tbl (org-columns-capture-view))
17355 (setq nfields (length (car tbl)))
17356 (org-columns-quit)))
17357 (goto-char pos)
17358 (move-marker pos nil)
17359 (when tbl
17360 (when (plist-get params :hlines)
17361 (setq tmp nil)
17362 (while tbl
17363 (if (eq (car tbl) 'hline)
17364 (push (pop tbl) tmp)
17366 (if (and (not (eq (car tmp) 'hline))
17367 (or (eq hlines t)
17368 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
17369 (push 'hline tmp)))
17370 (push (pop tbl) tmp)))
17371 (setq tbl (nreverse tmp)))
17372 (when vlines
17373 (setq tbl (mapcar (lambda (x)
17374 (if (eq 'hline x) x (cons "" x)))
17375 tbl))
17376 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
17377 (setq pos (point))
17378 (insert (org-listtable-to-string tbl))
17379 (when (plist-get params :width)
17381 org-columns-current-widths "|")))
17382 (goto-char pos)
17383 (org-table-align))))
17385 (defun org-listtable-to-string (tbl)
17386 "Convert a listtable TBL to a string that contains the Org-mode table.
17387 The table still need to be alligned. The resulting string has no leading
17388 and tailing newline characters."
17389 (mapconcat
17390 (lambda (x)
17391 (cond
17392 ((listp x)
17393 (concat "|" (mapconcat 'identity x "|") "|"))
17394 ((eq x 'hline) "|-|")
17395 (t (error "Garbage in listtable: %s" x))))
17398 (defun org-insert-columns-dblock ()
17399 "Create a dynamic block capturing a column view table."
17400 (interactive)
17401 (let ((defaults '(:name "columnview" :hlines 1))
17402 (id (completing-read
17403 "Capture columns (local, global, entry with :ID: property) [local]: "
17404 (append '(("global") ("local"))
17405 (mapcar 'list (org-property-values "ID"))))))
17406 (if (equal id "") (setq id 'local))
17407 (if (equal id "global") (setq id 'global))
17408 (setq defaults (append defaults (list :id id)))
17409 (org-create-dblock defaults)
17410 (org-update-dblock)))
17412 ;;;; Timestamps
17414 (defvar org-last-changed-timestamp nil)
17415 (defvar org-time-was-given) ; dynamically scoped parameter
17416 (defvar org-end-time-was-given) ; dynamically scoped parameter
17417 (defvar org-ts-what) ; dynamically scoped parameter
17419 (defun org-time-stamp (arg)
17420 "Prompt for a date/time and insert a time stamp.
17421 If the user specifies a time like HH:MM, or if this command is called
17422 with a prefix argument, the time stamp will contain date and time.
17423 Otherwise, only the date will be included. All parts of a date not
17424 specified by the user will be filled in from the current date/time.
17425 So if you press just return without typing anything, the time stamp
17426 will represent the current date/time. If there is already a timestamp
17427 at the cursor, it will be modified."
17428 (interactive "P")
17429 (let* ((ts nil)
17430 (default-time
17431 ;; Default time is either today, or, when entering a range,
17432 ;; the range start.
17433 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
17434 (save-excursion
17435 (re-search-backward
17437 (- (point) 20) t)))
17438 (apply 'encode-time (org-parse-time-string (match-string 1)))
17439 (current-time)))
17440 (default-input (and ts (org-get-compact-tod ts)))
17441 org-time-was-given org-end-time-was-given time)
17442 (cond
17443 ((and (org-at-timestamp-p)
17444 (eq last-command 'org-time-stamp)
17445 (eq this-command 'org-time-stamp))
17446 (insert "--")
17447 (setq time (let ((this-command this-command))
17448 (org-read-date arg 'totime nil nil default-time default-input)))
17449 (org-insert-time-stamp time (or org-time-was-given arg)))
17450 ((org-at-timestamp-p)
17451 (setq time (let ((this-command this-command))
17452 (org-read-date arg 'totime nil nil default-time default-input)))
17453 (when (org-at-timestamp-p) ; just to get the match data
17454 (replace-match "")
17455 (setq org-last-changed-timestamp
17456 (org-insert-time-stamp
17457 time (or org-time-was-given arg)
17458 nil nil nil (list org-end-time-was-given))))
17459 (message "Timestamp updated"))
17460 (t
17461 (setq time (let ((this-command this-command))
17462 (org-read-date arg 'totime nil nil default-time default-input)))
17463 (org-insert-time-stamp time (or org-time-was-given arg)
17464 nil nil nil (list org-end-time-was-given))))))
17466 ;; FIXME: can we use this for something else????
17467 ;; like computing time differences?????
17468 (defun org-get-compact-tod (s)
17469 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
17470 (let* ((t1 (match-string 1 s))
17471 (h1 (string-to-number (match-string 2 s)))
17472 (m1 (string-to-number (match-string 3 s)))
17473 (t2 (and (match-end 4) (match-string 5 s)))
17474 (h2 (and t2 (string-to-number (match-string 6 s))))
17475 (m2 (and t2 (string-to-number (match-string 7 s))))
17476 dh dm)
17477 (if (not t2)
17478 t1
17479 (setq dh (- h2 h1) dm (- m2 m1))
17480 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
17481 (concat t1 "+" (number-to-string dh)
17482 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
17484 (defun org-time-stamp-inactive (&optional arg)
17485 "Insert an inactive time stamp.
17486 An inactive time stamp is enclosed in square brackets instead of angle
17487 brackets. It is inactive in the sense that it does not trigger agenda entries,
17488 does not link to the calendar and cannot be changed with the S-cursor keys.
17489 So these are more for recording a certain time/date."
17490 (interactive "P")
17491 (let (org-time-was-given org-end-time-was-given time)
17492 (setq time (org-read-date arg 'totime))
17493 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
17494 nil nil (list org-end-time-was-given))))
17496 (defvar org-date-ovl (org-make-overlay 1 1))
17497 (org-overlay-put org-date-ovl 'face 'org-warning)
17498 (org-detach-overlay org-date-ovl)
17500 (defvar org-ans1) ; dynamically scoped parameter
17501 (defvar org-ans2) ; dynamically scoped parameter
17503 (defvar org-plain-time-of-day-regexp) ; defined below
17505 (defvar org-read-date-overlay nil)
17506 (defvar org-dcst nil) ; dynamically scoped
17508 (defun org-read-date (&optional with-time to-time from-string prompt
17509 default-time default-input)
17510 "Read a date, possibly a time, and make things smooth for the user.
17511 The prompt will suggest to enter an ISO date, but you can also enter anything
17512 which will at least partially be understood by `parse-time-string'.
17513 Unrecognized parts of the date will default to the current day, month, year,
17514 hour and minute. If this command is called to replace a timestamp at point,
17515 of to enter the second timestamp of a range, the default time is taken from the
17516 existing stamp. For example,
17517 3-2-5 --> 2003-02-05
17518 feb 15 --> currentyear-02-15
17519 sep 12 9 --> 2009-09-12
17520 12:45 --> today 12:45
17521 22 sept 0:34 --> currentyear-09-22 0:34
17522 12 --> currentyear-currentmonth-12
17523 Fri --> nearest Friday (today or later)
17524 etc.
17526 Furthermore you can specify a relative date by giving, as the *first* thing
17527 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
17528 change in days weeks, months, years.
17529 With a single plus or minus, the date is relative to today. With a double
17530 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17531 +4d --> four days from today
17532 +4 --> same as above
17533 +2w --> two weeks from today
17534 ++5 --> five days from default date
17536 The function understands only English month and weekday abbreviations,
17537 but this can be configured with the variables `parse-time-months' and
17538 `parse-time-weekdays'.
17540 While prompting, a calendar is popped up - you can also select the
17541 date with the mouse (button 1). The calendar shows a period of three
17542 months. To scroll it to other months, use the keys `>' and `<'.
17543 If you don't like the calendar, turn it off with
17544 \(setq org-read-date-popup-calendar nil)
17546 With optional argument TO-TIME, the date will immediately be converted
17547 to an internal time.
17548 With an optional argument WITH-TIME, the prompt will suggest to also
17549 insert a time. Note that when WITH-TIME is not set, you can still
17550 enter a time, and this function will inform the calling routine about
17551 this change. The calling routine may then choose to change the format
17552 used to insert the time stamp into the buffer to include the time.
17553 With optional argument FROM-STRING, read from this string instead from
17554 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17555 the time/date that is used for everything that is not specified by the
17556 user."
17557 (require 'parse-time)
17558 (let* ((org-time-stamp-rounding-minutes
17559 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
17560 (org-dcst org-display-custom-times)
17561 (ct (org-current-time))
17562 (def (or default-time ct))
17563 (defdecode (decode-time def))
17564 (dummy (progn
17565 (when (< (nth 2 defdecode) org-extend-today-until)
17566 (setcar (nthcdr 2 defdecode) -1)
17567 (setcar (nthcdr 1 defdecode) 59)
17568 (setq def (apply 'encode-time defdecode)
17569 defdecode (decode-time def)))))
17570 (calendar-move-hook nil)
17571 (view-diary-entries-initially nil)
17572 (view-calendar-holidays-initially nil)
17573 (timestr (format-time-string
17574 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
17575 (prompt (concat (if prompt (concat prompt " ") "")
17576 (format "Date+time [%s]: " timestr)))
17577 ans (org-ans0 "") org-ans1 org-ans2 final)
17579 (cond
17580 (from-string (setq ans from-string))
17581 (org-read-date-popup-calendar
17582 (save-excursion
17583 (save-window-excursion
17584 (calendar)
17585 (calendar-forward-day (- (time-to-days def)
17586 (calendar-absolute-from-gregorian
17587 (calendar-current-date))))
17588 (org-eval-in-calendar nil t)
17589 (let* ((old-map (current-local-map))
17590 (map (copy-keymap calendar-mode-map))
17591 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
17592 (org-defkey map (kbd "RET") 'org-calendar-select)
17593 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
17594 'org-calendar-select-mouse)
17632 ;; org-ans0: from prompt
17633 ;; org-ans1: from mouse click
17634 ;; org-ans2: from calendar motion
17662 "Display the currrent date prompt interpretation in the minibuffer."
17678 org-time-stamp-custom-formats
17679 org-time-stamp-formats))
17688 org-end-time-was-given
17695 "Analyze the combined answer of the date prompt."
17696 ;; FIXME: cleanup and comment
17698 hour minute second wday pm h2 m2 tl wday1)
17706 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
17716 t nil ans)))
17717 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17718 ;; If there is a time with am/pm, and *no* time without it, we convert
17719 ;; so that matching will be successful.
17733 t t ans))))
17735 ;; Check if a time range is given as a duration
17736 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17744 ;; Check if there is a time range
17778 ;; Weekday was given, but no day, so pick that day in the week
17779 ;; on or after the derived date.
17793 "Check string S for special relative date string.
17794 TODAY and DEFAULT are internal times, for today and for a default.
17795 Return shift list (N what def-flag)
17797 N is the number of WHATs to shift.
17798 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17799 the DEFAULT date rather than TODAY."
17808 ?+))
17815 delta)
17825 "Eval FORM in the calendar window and return to current window.
17826 Also, store the cursor date in variable org-ans2."
17837 ; ;; Update the prompt to show new default date
17838 ; (save-excursion
17839 ; (goto-char (point-min))
17840 ; (when (and org-ans2
17841 ; (re-search-forward "\\[[-0-9]+\\]" nil t)
17842 ; (get-text-property (match-end 0) 'field))
17843 ; (let ((inhibit-read-only t))
17844 ; (replace-match (concat "[" org-ans2 "]") t t)
17845 ; (add-text-properties (point-min) (1+ (match-end 0))
17846 ; (text-properties-at (1+ (point-min)))))))))
17849 "Return to `org-read-date' with the date currently selected.
17850 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17859 "Insert a date stamp for the date given by the internal TIME.
17860 WITH-HM means, use the stamp format that includes the time of the day.
17861 INACTIVE means use square brackets instead of angular ones, so that the
17862 stamp will not contribute to the agenda.
17863 PRE and POST are optional strings to be inserted before and after the
17864 stamp.
17865 The command returns the inserted time stamp."
17867 stamp)
17884 stamp))
17887 "Toggle the use of custom time stamp formats."
17908 "Overlay modified time stamp format over timestamp between BED and END."
17935 "Translate all timestamps in STRING to custom format.
17936 But do this only if the variable `org-display-custom-times' is set."
17941 t1 with-hm inactive tf time str beg end)
17950 org-time-stamp-custom-formats)
17959 string)
17962 "Set 0 instead of nil for the first 6 elements of time.
17963 Don't touch the rest."
17968 "Difference between TIMESTAMP-STRING and now in days."
17973 "Is the time in TIMESTAMP-STRING close to the current date?"
17979 "Get the deadline lead time appropriate for timestring TS."
17982 ;; 0 or negative, enforce this value no matter what
17985 ;; lead time is specified.
17990 ;; go for the default.
17994 "Return to `org-read-date' with the date currently selected.
17995 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
18005 "Check if there are any deadlines due or past due.
18006 A deadline is considered due if it happens within `org-deadline-warning-days'
18007 days from today's date. If the deadline appears in an entry marked DONE,
18008 it is not shown. The prefix arg NDAYS can be used to test that many
18023 org-warn-days)))
18026 "Check if there are deadlines or scheduled entries before DATE."
18040 "Evaluate a time range by computing the difference between start and end.
18041 Normally the result is just printed in the echo area, but with prefix arg
18042 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
18043 If the time range is actually in a table, the result is inserted into the
18044 next column.
18045 For time difference computation, a year is assumed to be exactly 365
18046 days in order to avoid rounding problems."
18066 ;; (ys (floor (* 365 24 60 60)))
18074 y d h m align)
18077 y 0
18082 y 0
18120 "Convert a time stamp to an absolute day number.
18121 If there is a specifyer for a cyclic time stamp, get the closest date to
18122 DAYNR."
18126 daynr
18131 prefer))
18135 "Return the time corresponding to date D.
18136 D may be an absolute day number, or a calendar-type list (month day year)."
18141 "List of holidays, for Diary display in Org-mode."
18149 "Process a SEXP diary ENTRY for DATE."
18169 "Get iCalendar entries from diary entries in buffer FROMBUF.
18170 This uses the icalendar.el library."
18173 temporary-file-directory))
18176 buf rtn b e)
18192 rtn))
18195 "Find the date closest to CURRENT that is consistent with START and CHANGE.
18196 When PREFER is `past' return a date that is either CURRENT or past.
18197 When PREFER is `future', return a date that is either CURRENT or future."
18198 ;; Make the proper lists from the dates
18201 dn dw sday cday n1 n2
18202 d m y y1 y2 date1 date2 nmonths nm ny m2)
18207 current
18231 ;; approx number of month between the tow dates
18233 ;; How often does dn fit in there?
18262 "Turn any specification of DATE into a gregorian date for the calendar."
18272 "Parse the standard Org-mode time string.
18273 This should be a lot faster than the normal `parse-time-string'.
18274 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18275 hour and minute fields will be nil if not given."
18285 nil nil nil)
18289 "Increase the date item at the cursor by one.
18290 If the cursor is on the year, change the year. If it is on the month or
18291 the day, change that.
18292 With prefix ARG, change by that many units."
18297 "Decrease the date item at the cursor by one.
18298 If the cursor is on the year, change the year. If it is on the month or
18299 the day, change that.
18300 With prefix ARG, change by that many units."
18305 "Increase the date in the time stamp by one day.
18306 With prefix ARG, change that many days."
18314 "Decrease the date in the time stamp by one day.
18315 With prefix ARG, change that many days."
18328 "Determine if the cursor is in or at a timestamp."
18354 ans))
18357 ""
18369 "Change the date in the time stamp at point.
18370 The date will be changed by N times WHAT. WHAT can be `day', `month',
18371 `year', `minute', `second'. If WHAT is not given, the cursor position
18372 in the timestamp determines what will be changed."
18374 with-hm inactive
18375 org-ts-what
18376 extra
18377 ts time time0)
18383 org-display-custom-times
18393 ts)
18421 ;; Try to recenter the calendar window, if any
18427 ;; FIXME: does not yet work for lead times
18429 "Change the different parts of the lead-time and repeat fields in timestamp."
18431 ng h m new)
18432 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18453 new
18455 s))
18458 "If the calendar is visible, recenter it to DATE."
18469 "Go to the Emacs calendar at the current date.
18470 If there is a time stamp in the current line, go to that date.
18471 A prefix ARG can be used to force the current date."
18490 "Return a list (month day year) of date at point in calendar."
18496 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18497 If there is already a time stamp at the cursor position, update it."
18505 ;; Make appt aware of appointments from the agenda
18506 ;;;###autoload
18508 "Activate appointments found in `org-agenda-files'.
18509 When prefixed, prompt for a regular expression and use it as a
18510 filter: only add entries if they match this regular expression.
18512 FILTER can be a string. In this case, use this string as a
18513 regular expression to filter results.
18515 FILTER can also be an alist, with the car of each cell being
18516 either 'headline or 'category. For example:
18521 will only add headlines containing IMPORTANT or headlines
18532 ;; Get all entries which may contain an appt
18537 file today
18540 ;; Map thru entries and find if they pass thru the filter
18553 ;; FIXME: Shall we remove text-properties for the appt text?
18554 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
18566 ;;; The clock for measuring work time.
18591 "Start the clock on the current item.
18592 If necessary, clock-out of the currently active clock."
18600 org-clock-in-switch-to-state
18627 "Find the location where the next clock line should be inserted."
18633 first last)
18637 ;; we seem to have a CLOCK drawer, so go there.
18640 ;; Lets count the CLOCK lines
18648 ;; Wrap current entries into a new drawer
18666 ;; Planning info, skip to after it
18678 "Stop the currently running clock.
18679 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
18716 "Cancel the running clock be removing the start timestamp."
18730 "Go to the currently clocked-in entry."
18747 "Sum the times for each subtree.
18748 Puts the resulting times in minutes as a text property on each headline."
18752 org-clock-string
18758 ts te dt
18759 time)
18766 ;; Two time stamps
18778 ;; A naket time
18795 "Show subtree times in the entire buffer.
18796 If TOTAL-ONLY is non-nil, only show the total time for the entire file
18797 in the echo area."
18814 ;; Arrange to remove the overlays upon next change.
18824 "Put an overlays on the current line, displaying TIME.
18825 If LEVEL is given, prefix time with a corresponding number of stars.
18826 This creates a new overlay and stores it in `org-clock-overlays', so that it
18827 will be easy to remove."
18831 ov tx)
18850 "Remove the occur highlights from the buffer.
18851 BEG and END are ignored. If NOREMOVE is nil, remove this function
18852 from the `before-change-functions' in the current buffer."
18862 "Clock out if the current entry contains the running clock.
18863 This is used to stop the clock after a TODO entry is marked DONE,
18864 and is only done if the variable `org-clock-out-when-done' is not nil."
18870 org-clock-marker))
18871 ;; Clock out, but don't accept a logging message for this.
18879 "Check if the current buffer contains the running clock.
18880 If yes, offer to stop it and to save the buffer with the changes."
18889 "Create a table containing a report about clocked time.
18890 If the cursor is inside an existing clocktable block, then the table
18891 will be updated. If not, a new clocktable will be inserted.
18892 When called with a prefix argument, move to the first clock table in the
18893 buffer and update it."
18906 "Check if the cursor is in a clocktable."
18914 start))))
18917 "If this is a CLOCK line, update it and return t.
18918 Otherwise, return nil."
18927 ts te h m s)
18929 nil
18943 t)))))
18946 "Return two times bordering a special time range.
18947 Key is a symbol specifying the range and can be one of `today', `yesterday',
18948 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
18949 A week starts Monday 0:00 and ends Sunday 24:00.
18950 The range is determined relative to TIME. TIME defaults to the current time.
18951 The return value is a cons cell with two internal times like the ones
18952 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
18953 the returned times will be formatted strings."
18958 s1 m1 h1 d1 month1 y1 diff ts te fm)
18988 "Write the standard clocktable."
19003 ipos time h m p level hlc hdl
19004 cc beg end pos tbl)
19018 ;; Get the right scope
19041 file)
19051 org-clock-file-total-minutes)))))))
19062 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
19083 "Clock summary at ["
19087 "]."
19100 "|"
19101 "*Total time*| "
19123 cc)
19157 x))
19158 lines)
19161 ;; FIXME: I don't think anybody uses this, ask David
19163 "Return an internal list with clocking information.
19164 This list has one entry for each CLOCK interval.
19165 FIXME: describe the elements."
19169 rtn beg end next cont level title total closedp leafp
19170 clockpos titlepos h m donep)
19195 total title titlepos level leafp)
19196 rtn)
19200 ;;;; Agenda, and Diary Integration
19202 ;;; Define the Org-agenda-mode
19216 "Mode for time-sorted view on action items in Org-mode files.
19218 The following commands are available:
19224 org-agenda-pending-undo-list nil)
19226 ;; Keep global-font-lock-mode from turning on font-lock-mode
19234 ;; Make sure properties are removed when copying text
19239 buffer-substring-filters)))
19242 org-agenda-show-log nil))
19249 "Restricted to single file"
19261 org-agenda-mode-map global-map)
19359 "--"
19366 "--"
19370 "--"
19375 "--"
19380 "--"
19385 "--"
19402 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
19406 "--"
19408 "--"
19418 "--"
19420 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
19424 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
19428 "--"
19430 "--"
19433 ))
19435 ;;; Agenda undo
19447 "Execute BODY if there is no `org-protected' text property at point."
19453 "Execute BODY while recording undo information in two buffers."
19461 _c1 _c2)
19462 ,@_body
19469 ;; make sure there are undo boundaries
19472 ;; remember which buffer to undo
19474 org-agenda-undo-list)))))
19477 "Undo a remote editing step in the agenda.
19478 This undoes changes both in the agenda buffer and in the remote buffer
19479 that have been changed along."
19485 org-agenda-pending-undo-list org-agenda-undo-list))
19489 buf line cmd rembuf)
19511 "Verify that a real change occurred between the undo lists L1 and L2."
19516 ;;; Agenda dispatch
19524 ;;;###autoload
19526 "Dispatch agenda commands to collect entries to the agenda buffer.
19527 Prompts for a command to execute. Any prefix arg will be passed
19528 on to the selected command. The default selections are:
19530 a Call `org-agenda-list' to display the agenda for current day or week.
19531 t Call `org-todo-list' to display the global todo list.
19532 T Call `org-todo-list' to display the global todo list, select only
19533 entries with a specific TODO keyword (the user gets a prompt).
19534 m Call `org-tags-view' to display headlines with tags matching
19535 a condition (the user is prompted for the condition).
19536 M Like `m', but select only TODO entries, no ordinary headlines.
19537 L Create a timeline for the current buffer.
19538 e Export views to associated files.
19540 More commands can be added by configuring the variable
19541 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
19542 searches can be pre-defined in this way.
19544 If the current buffer is in Org-mode and visiting a file, you can also
19545 first press `<' once to indicate that the agenda should be temporarily
19547 Pressing `<' twice means to restrict to the current subtree or region
19548 \(if active)."
19554 ;; normalize different versions
19560 nil)
19564 org-agenda-custom-commands)))
19567 entry key type match lprops ans)
19568 ;; Turn off restriction unless there is an overriding one
19574 ;; Delete old local properties
19576 ;; Remember where this call originated
19582 ;; Estabish the restriction, if any
19599 ;; For example the todo list should not need it (but does...)
19613 current-prefix-arg)))
19665 cmds)))
19668 "The user interface for selecting an agenda command."
19675 restriction second-time
19676 c entry key type match prefixes rmheader header-end custom1 desc)
19683 "
19684 Press key for an agenda command: < Buffer,subtree/region restriction
19685 -------------------------------- > Remove restriction
19686 a Agenda for current week or day e Export agenda views
19687 t List of all TODO entries T Entries with special TODO kwd
19688 m Match a TAGS query M Like m, but only TODO entries
19689 L Timeline for current buffer # List stuck projects (!=configure)
19690 / Multi-occur C Configure custom agenda commands
19695 header start)
19699 header)))
19751 prefix-descriptions))
19753 prefixes))
19764 " (restriction lock active)"
19777 prefixes nil
19783 nil
19785 custom))))
19802 nil)
19822 match ;; The byte compiler incorrectly complains about this. Keep it!
19823 cmd type lprops)
19854 ;;;###autoload
19856 "Run an agenda command in batch mode and send the result to STDOUT.
19857 If CMD-KEY is a string of length 1, it is used as a key in
19858 `org-agenda-custom-commands' and triggers this command. If it is a
19859 longer string it is used as a tags/todo match string.
19860 Paramters are alternating variable names and values that will be bound
19861 before running the agenda command."
19875 string))
19879 ;;;###autoload
19881 "Run an agenda command in batch mode and send the result to STDOUT.
19882 If CMD-KEY is a string of length 1, it is used as a key in
19883 `org-agenda-custom-commands' and triggers this command. If it is a
19884 longer string it is used as a tags/todo match string.
19885 Paramters are alternating variable names and values that will be bound
19886 before running the agenda command.
19888 The output gives a line for each selected agenda item. Each
19889 item is a list of comma-separated values, like this:
19891 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
19893 category The category of the item
19894 head The headline, without TODO kwd, TAGS and PRIORITY
19895 type The type of the agenda entry, can be
19896 todo selected in TODO match
19897 tagsmatch selected in tags match
19898 diary imported from diary
19899 deadline a deadline on given date
19900 scheduled scheduled on given date
19901 timestamp entry has timestamp on given date
19902 closed entry was closed on given date
19903 upcoming-deadline warning about deadline
19904 past-scheduled forwarded scheduled item
19905 block entry has date block including g. date
19906 todo The todo keyword, if any
19907 tags All tags including inherited ones, separated by colons
19908 date The relevant date, like 2007-2-14
19909 time The time, like 15:00-16:50
19910 extra Sting with extra planning info
19911 priority-l The priority letter if any was given
19912 priority-n The computed numerical priority
19913 agenda-day The day in the agenda where this is listed"
19925 line)
19935 priority-letter priority agenda-day)
19940 "Make sure all properties on an agenda item have a canonical form,
19941 so the export commands can easily use it."
19968 props)
19982 ;;;###autoload
19987 ;; FIXME, why is this a macro?????
19988 ;;;###autoload
19990 "Run all custom agenda commands that have a file argument."
19994 pars cmd thiscmdkey files opts)
20017 "Write the current buffer (an agenda view) as a file.
20018 Depending on the extension of the file name, plain text (.txt),
20019 HTML (.html or .htm) or Postscript (.ps) is produced.
20020 If NOSETTINGS is given, do not scope the settings of
20021 `org-agenda-exporter-settings' into the export commands. This is used when
20022 the settings have already been scoped and we do not wish to overrule other,
20023 higher priority settings."
20039 ;; replace <style> section with org-agenda-export-html-style
20060 "Inhibit read-only for BODY."
20064 "Make sure current buffer is in org-mode. Error if not."
20067 major-mode)))
20070 "Fit the window to the buffer size."
20074 nil
20078 ;;; Agenda file list
20081 "Get the list of agenda files.
20082 Optional UNRESTRICTED means return the full list even if a restriction
20083 is currently in place."
20094 org-agenda-file-regexp)
20096 files)))
20102 files))
20106 "Edit the list of agenda files.
20107 Depending on setup, this either uses customize to edit the variable
20108 `org-agenda-files', or it visits the file that is holding the list. In the
20109 latter case, the buffer is set up in a way that saving it automatically kills
20110 the buffer and restores the previous window configuration."
20129 "Set new value for the agenda file list and save it correcly."
20140 "Read the list of agenda files from a file."
20147 ;;;###autoload
20149 "Cycle through the files in `org-agenda-files'.
20150 If the current buffer visits an agenda file, find the next one in the list.
20151 If the current buffer does not, find the first agenda file."
20156 file)
20168 "Move/add the current file to the top of the agenda file list.
20169 If the file is not present in the list, it is added to the front. If it is
20170 present, it is moved there. With optional argument TO-END, add/move to the
20171 end of the list."
20178 x had)
20191 "Remove current file from the list of files in variable `org-agenda-files'.
20192 These are the files which are being checked for agenda entries.
20193 Optional argument FILE means, use this file instead of the current."
20203 nil x))
20216 "Make sure FILE exists. If not, ask user what to do."
20227 ;;; Agenda prepare and finalize
20272 "Finishing touch for the agenda buffer, called just before displaying it."
20284 org-overriding-columns-format)
20286 org-overriding-columns-format))
20288 org-agenda-view-columns-initially)
20294 )))
20297 "Make highest priority lines bold, and lowest italic."
20304 b e p ov h l)
20308 org-highest-priority)
20310 org-lowest-priority)
20315 ov 'face
20323 "Create buffers for all agenda files, protect archived trees and comments."
20330 bmp file re)
20360 "Function to be called at each match during agenda construction.
20361 If this function returns nil, the current match should not be skipped.
20362 Otherwise, the function must return a position from where the search
20363 should be continued.
20364 This may also be a Lisp form, it will be evaluated.
20365 Never set this variable using `setq' or so, because then it will apply
20366 to all future agenda commands. Instead, bind it with `let' to scope
20367 it dynamically into the agenda-constructing command. A good way to set
20371 "Throw to `:skip' in places that should be skipped.
20372 Also moves point to the end of the skipped region, so that search can
20373 continue from there."
20399 "Return a new agenda marker.
20400 Org-mode keeps a list of these markers and resets them when they are
20401 no longer in use."
20405 m))
20408 "Reset markers created by `org-agenda'."
20413 "Get a buffer visiting FILE. If the buffer needs to be created, add
20414 it to the list of buffers which might be released later."
20417 buf ; just return it
20418 ;; Make a new buffer and remember it
20421 buf)))
20424 "Release all buffers in list, asking the user for confirmation when needed.
20425 When a buffer is unmodified, it is just killed. When modified, it is saved
20426 \(if the user agrees) and then killed."
20431 file
20437 "Get the category applying to position POS."
20440 ;;; Agenda timeline
20445 "Show a time-sorted view of the entries in the current org file.
20446 Only entries with a time stamp of today or later will be listed. With
20448 under the current date.
20449 If the buffer contains an active region, only check the region for
20450 dates."
20463 t doclosed ; always include today
20464 org-timeline-show-empty-dates))
20469 args
20470 s e rtn d emptyp)
20476 ;; Remove past dates from the list of dates.
20479 day-numbers))))
20496 dopast
20497 past)
20505 date args)))
20528 "Return a list of all relevant day numbers from BEG to END buffer positions.
20529 If NO-RANGES is non-nil, include only the start and end dates of a range,
20530 not every single day in the range. If FORCE-TODAY is non-nil, make
20531 sure that TODAY is included in the list. If INACTIVE is non-nil, also
20532 inactive time stamps (those in square brackets) are included.
20533 When EMPTY is non-nil, also include days without any entries."
20537 dates dates1 date day day1 day2 ts1 ts2)
20567 dates)))
20569 ;;; Agenda Daily/Weekly
20580 ;;;###autoload
20582 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
20583 The view will be for the current day or week, but from the overview buffer
20584 you will be able to go to other days/weeks.
20587 all unfinished TODO items will also be shown, before the agenda.
20588 This feature is considered obsolete, please use the TODO list or a block
20589 agenda instead.
20591 With a numeric prefix argument in an interactive call, the agenda will
20592 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
20593 the number of days. NDAYS defaults to `org-agenda-ndays'.
20595 START-DAY defaults to TODAY, or to the most recent match for the weekday
20596 given in `org-agenda-start-on-weekday'."
20607 ;; Convert to an absolute day number
20615 org-agenda-start-on-weekday nil))
20624 sd
20633 s e rtn rtnall file date d start-pos end-pos todayp nd)
20636 ;; Make the list of days
20638 nd ndays)
20651 rtnall nil)
20679 rtnall nil)
20685 file date
20688 file date
20712 rtnall nd todayp))
20735 ;;; Agenda TODO list
20740 ;;;###autoload
20742 "Show all TODO entries from all agenda file in a single list.
20743 The prefix arg can be used to select a specific TODO keyword and limit
20745 for a keyword. A numeric prefix directly selects the Nth keyword in
20746 `org-todo-keywords-1'."
20760 rtn rtnall files file pos)
20770 rtnall nil)
20794 kwds))
20805 ;;; Agenda tags match
20807 ;;;###autoload
20809 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
20810 The prefix arg TODO-ONLY limits the search to TODO entries."
20817 rtn rtnall files file pos matcher
20818 buffer)
20826 rtnall nil)
20834 ;; If file does not exist, merror message to agenda
20845 org-agenda-restrict-end)
20870 ;;; Agenda Finding stuck projects
20873 "Regular expression used in skipping subtrees for the agenda.
20874 This is basically a temporary global variable that can be set and then
20881 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
20882 If yes, it returns the end position of this tree, causing agenda commands
20883 to skip this subtree. This is a function that can be put into
20884 `org-agenda-skip-function' for the duration of a command."
20886 skip)
20892 "Skip entry if any of CONDITIONS is true.
20893 See `org-agenda-skip-if' for details."
20897 "Skip entry if any of CONDITIONS is true.
20898 See `org-agenda-skip-if' for details."
20902 "Checks current entity for CONDITIONS.
20903 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
20904 the entry, i.e. the text before the next heading is checked.
20906 CONDITIONS is a list of symbols, boolean OR is used to combine the results
20907 from different tests. Valid conditions are:
20909 scheduled Check if there is a scheduled cookie
20910 notscheduled Check if there is no scheduled cookie
20911 deadline Check if there is a deadline
20912 notdeadline Check if there is no deadline
20913 regexp Check if regexp matches
20914 notregexp Check if regexp does not match.
20916 The regexp is taken from the conditions list, it must come right after
20917 the `regexp' or `notregexp' element.
20919 If any of these conditions is met, this function returns the end point of
20920 the entity, causing the search to continue from there. This is a function
20921 that can be put into `org-agenda-skip-function' for the duration of a command."
20945 end)))
20947 ;;;###autoload
20949 "Create agenda view for projects that are stuck.
20950 Stuck projects are project that have no next actions. For the definitions
20951 of what a project is and how to check if it stuck, customize the variable
20952 `org-stuck-projects'.
20953 MATCH is being ignored."
20956 ;; FIXME: we could have used org-agenda-skip-if here.
20964 org-done-keywords-for-agenda
20966 todo))
20983 gen-re)))))
20994 ;;; Diary integration
20999 "Get the (Emacs Calendar) diary entries for DATE."
21007 entries
21019 ;; No entries
21021 ;; Omit the date and other unnecessary stuff
21023 ;; Add prefix to each line and extend the text properties
21035 ;; Extend the text properties to the beginning of the line
21038 entries)))))
21041 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
21042 This gets rid of the date, the underline under the date, and
21043 the dummy entry installed by `org-mode' to ensure non-empty diary for each
21044 date. It also removes lines that contain only whitespace."
21061 ;; Make sure entries from the diary have the right text properties.
21064 ;; We can rely on the hook, nothing to do
21065 nil
21066 ;; Hook not avaiable, must use advice to make this work
21068 "Make the position visible."
21071 buffer-file-name)
21075 "Add text properties to string, allowing org-mode to act on it."
21078 'keymap org-agenda-keymap
21083 'org-agenda-diary-link t
21087 "Add a dummy entry to the diary.
21088 Needed to avoid empty dates which mess up holiday display."
21089 ;; Catch the error if dealing with the new add-to-diary-alist
21096 ;;;###autoload
21098 "Return diary information from org-files.
21100 It accesses org files and extracts information from those files to be
21101 listed in the diary. The function accepts arguments specifying what
21102 items should be listed. The following arguments are allowed:
21104 :timestamp List the headlines of items containing a date stamp or
21105 date range matching the selected date. Deadlines will
21106 also be listed, on the expiration day.
21108 :sexp List entries resulting from diary-like sexps.
21110 :deadline List any deadlines past due, or due within
21111 `org-deadline-warning-days'. The listing occurs only
21112 in the diary for *today*, not at any other date. If
21113 an entry is marked DONE, it is no longer listed.
21115 :scheduled List all items which are scheduled for the given date.
21116 The diary for *today* also contains items which were
21117 scheduled earlier and are not yet marked DONE.
21119 :todo List all TODO items from the org-file. This may be a
21120 long list - so this is not turned on by default.
21121 Like deadlines, these entries only show up in the
21122 diary for *today*, not at any other date.
21124 The call in the diary file should look like this:
21126 &%%(org-diary) ~/path/to/some/orgfile.org
21128 Use a separate line for each org file to check. Or, if you omit the file name,
21129 all files listed in `org-agenda-files' will be checked automatically:
21131 &%%(org-diary)
21133 If you don't give any arguments (as in the example above), the default
21134 arguments (:deadline :scheduled :timestamp :sexp) are used.
21135 So the example above may also be written as
21137 &%%(org-diary :deadline :timestamp :sexp :scheduled)
21139 The function expects the lisp variables `entry' and `date' to be provided
21140 by the caller, because this is how the calendar works. Don't use this
21141 function from a program - use `org-agenda-get-day-entries' instead."
21143 org-agenda-last-marker-time)
21152 file rtn results)
21154 ;; If this is called during org-agenda, don't return any entries to
21155 ;; the calendar. Org Agenda will list these entries itself.
21163 ;;; Agenda entry finders
21166 "Does the work for `org-diary' and `org-agenda'.
21167 FILE is the path to a file to be checked for entries. DATE is date like
21168 the one returned by `calendar-current-date'. ARGS are symbols indicating
21169 which kind of entries should be extracted. For details about these, see
21170 the documentation of `org-diary'."
21177 arg results rtn)
21179 ;; If file does not exist, make sure an error message ends up in diary
21189 org-agenda-restrict-end)
21191 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
21215 results))))
21231 "Is the cursor inside a date range?"
21246 nil)))
21249 "Return the TODO information for agenda display."
21252 'org-not-done-regexp org-not-done-regexp
21253 'org-todo-regexp org-todo-regexp
21255 'keymap org-agenda-keymap
21256 'help-echo
21259 ;; FIXME: get rid of the \n at some point but watch out
21263 org-todo-regexp
21267 org-not-done-regexp)
21269 marker priority category tags
21270 ee txt beg end)
21309 "Return the date stamp information for agenda display."
21311 'org-not-done-regexp org-not-done-regexp
21312 'org-todo-regexp org-todo-regexp
21314 'keymap org-agenda-keymap
21315 'help-echo
21323 "<%Y-%m-%d"
21337 marker hdmarker deadlinep scheduledp donep tmp priority category
21338 ee txt timestr tags b0 b3 e3 head)
21356 b0)
21363 ;; substring should only run to end of time stamp
21375 nil head category tags timestr nil
21376 remove-re)))
21389 "Return the sexp information for agenda display."
21393 'keymap org-agenda-keymap
21394 'help-echo
21398 marker category ee txt tags entry result beg b sexp sexp-entry)
21430 "Return the logged TODO entries for agenda display."
21432 'org-not-done-regexp org-not-done-regexp
21433 'org-todo-regexp org-todo-regexp
21434 'keymap org-agenda-keymap
21435 'help-echo
21447 marker hdmarker priority category tags closedp
21448 ee txt timestr)
21457 ;; donep (org-entry-is-done-p)
21458 )
21460 ;; substring should only run to end of time stamp
21484 "Return the deadline information for agenda display."
21486 'org-not-done-regexp org-not-done-regexp
21487 'org-todo-regexp org-todo-regexp
21488 'keymap org-agenda-keymap
21489 'help-echo
21495 d2 diff dfrac wdays pos pos1 category tags
21496 ee txt head face s upcomingp donep timestr)
21508 ;; When to show a deadline in the calendar:
21509 ;; If the expiration is within wdays warning time.
21510 ;; Past-due deadlines are only shown on the current date
21538 diff))
21539 head category tags timestr))))
21548 'org-category category
21557 "Return the face to displaying a deadline item.
21558 FRACTION is what fraction of the head-warning time has passed."
21565 "Return the scheduled information for agenda display."
21567 'org-todo-regexp org-todo-regexp
21570 'keymap org-agenda-keymap
21571 'help-echo
21577 d2 diff pos pos1 category tags
21578 ee txt head pastschedp donep face timestr s)
21586 ;;; is this right?
21587 ;;; do we need to do this for deadleine too????
21588 ;;; d2 (org-time-string-to-absolute (match-string 1) (if todayp nil d1))
21591 ;; When to show a scheduled item in the calendar:
21592 ;; If it is on or past the date.
21620 head category tags timestr))))
21624 'org-scheduled-previously
21627 'undone-face face
21639 "Return the date-range information for agenda display."
21641 'org-not-done-regexp org-not-done-regexp
21642 'org-todo-regexp org-todo-regexp
21644 'keymap org-agenda-keymap
21645 'help-echo
21650 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos
21651 donep head)
21663 ;; Only allow days between the limits, because the normal
21664 ;; date stamps will catch the limits.
21681 head category tags
21690 ;; Sort the entries by expiration date.
21693 ;;; Agenda presentation and sorting
21703 "Regular expression to match a plain time or time range.
21704 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
21705 groups carry important information:
21706 0 the full match
21707 1 the first time, range or not
21715 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
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 7 hours of duration
21728 "Regular expression to match a timestamp time or time range.
21729 After a match, the following groups carry important information:
21730 0 the full match
21731 1 date plus weekday, for backreferencing to make sure both times on same day
21732 2 the first time, range or not
21736 "A flag, set by `org-compile-prefix-format'.
21739 "A flag, set by `org-compile-prefix-format'.
21743 noprefix remove-re)
21744 "Format TXT to be inserted into the agenda buffer.
21745 In particular, it adds the prefix and corresponding text properties. EXTRA
21746 must be a string and replaces the `%s' specifier in the prefix format.
21747 CATEGORY (string, symbol or nil) may be used to overrule the default
21748 category taken from local variable or file name. It will replace the `%c'
21749 specifier in the format. DOTIME, when non-nil, indicates that a
21750 time-of-day should be extracted from TXT for sorting of this entry, and for
21751 the `%t' specifier in the format. When DOTIME is a string, this string is
21752 searched for a time before TXT is. NOPREFIX is a flag and indicates that
21753 only the correctly processes TXT should be returned - this is used by
21754 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
21755 Any match of REMOVE-RE will be removed from TXT."
21757 ;; Diary entries sometimes have extra whitespace at the beginning
21760 org-category
21766 time ; time and tag are needed for the eval of the prefix format
21769 stamp plain s0 s1 s2 rtn srp)
21771 ;; Extract starting and ending time and move them to prefix
21779 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
21780 ;; them, we might want to remove them there to avoid duplication.
21781 ;; The user can turn this off with a variable.
21787 t))
21789 ;; Normalize the time(s) to 24 hour
21797 org-agenda-default-appointment-duration))
21798 h)
21803 txt)
21804 ;; Tags are in the string
21807 org-prefix-has-tag))
21812 t t txt))))
21818 ;; Create the final string
21821 ;; Prepare the variables needed in the eval of the compiled format
21827 ;; Evaluate the compiled format
21830 ;; And finally add the text properties
21833 'org-highest-priority org-highest-priority
21834 'org-lowest-priority org-lowest-priority
21836 'time-of-day time-of-day
21837 'txt txt
21838 'time time
21839 'extra extra
21854 list)))
21859 new time)
21861 ;; don't show empty grid
21867 nil string "" nil
21869 new)
21877 "Compile the prefix format into a Lisp form that can be evaluated.
21878 The resulting form is returned and stored in the variable
21879 `org-prefix-format-compiled'."
21883 org-agenda-prefix-format)
21888 varform vars var e c f opt)
21890 s start)
21903 ""
21913 ;; the old format
21921 "Check string S for a time of day.
21922 If found, return it as a military time number between 0 and 2400.
21923 If not found, return nil.
21924 The optional STRING argument forces conversion into a 5 character wide string
21925 HH:MM."
21947 "Sort and concatenate the agenda items."
21950 list
21975 x)
21979 " "
21981 x)))
21984 "Compare the priorities of string A and B."
21992 "Compare the string values of categories of strings A and B."
22000 "Compare the string values of categories of strings A and B."
22010 "Compare the time-of-day values of strings A and B."
22019 "Predicate for sorting agenda entries."
22020 ;; The following variables will be used when the form is evaluated.
22021 ;; So even though the compiler complains, keep them.
22035 ;;; Agenda restriction lock
22053 "Set restriction lock for agenda, to current subtree or file.
22054 Restriction will be the file if TYPE is `file', or if type is the
22055 universal prefix '(4), or if the cursor is before the first headline
22056 in the file. Otherwise, restriction will be to the current subtree."
22088 "Remove the agenda restriction lock."
22102 "If there is any window showing the agenda view, update it."
22111 org-agenda-overriding-restriction)
22114 ;;; Agenda commands
22117 "Check if agenda buffer is of allowed type.
22118 If ERROR is non-nil, throw an error, otherwise just return nil."
22120 t
22123 nil)))
22126 "Exit agenda by removing the window or the buffer."
22133 ;; Maybe restore the pre-agenda window configuration.
22136 org-pre-agenda-window-conf
22140 "Exit agenda by removing the window or the buffer.
22141 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
22142 Org-mode buffers visited directly by the user will not be touched."
22156 "Save all Org-mode buffers without user confirmation."
22163 "Rebuild Agenda.
22164 When this is the global TODO list, a prefix argument will be interpreted."
22173 org-agenda-pending-undo-list nil)
22179 "Jump to DATE in agenda."
22184 "Go to today."
22210 "Go forward in time by thee current span.
22211 With prefix ARG, go forward that many times the current span."
22218 greg2 nd)
22240 "Go backward in time by the current span.
22241 With prefix ARG, go backward that many times the current span."
22246 "Switch to daily view for agenda."
22251 "Switch to daily view for agenda."
22256 "Switch to daily view for agenda."
22260 "Switch to daily view for agenda."
22267 "Change the agenda view to SPAN.
22268 SPAN may be `day', `week', `month', `year'."
22273 org-starting-day))
22284 "Compute starting date and number of days for agenda.
22285 SPAN may be `day', `week', `month', `year'. The return value
22286 is a cons cell with the starting date and the number of days,
22287 so that the date SD will be in that range."
22289 nd)
22306 sd)))
22312 sd))))
22315 ;; FIXME: does not work if user makes date format that starts with a blank
22317 "Jump to the next line indicating a date in agenda buffer."
22329 "Jump to the previous line indicating a date in agenda buffer."
22336 ;; Initialize the highlight
22341 "Highlight a region with overlay."
22346 "Detach overlay INDEX."
22349 ;; FIXME this is currently not used.
22358 "Toggle follow mode in an agenda buffer."
22366 "Toggle log mode in an agenda buffer."
22376 "Toggle diary inclusion in an agenda buffer."
22386 "Toggle time grid in an agenda buffer."
22396 "Set the mode name to indicate all the small mode settings."
22415 "Show the priority of the current item.
22416 This priority is composed of the main priority given with the [#A] cookies,
22417 and by additional input from the age of a schedules or deadline entry."
22423 "Show the tags applicable to the current item."
22432 "Go to the Org-mode file which contains the item at point."
22451 "Normal hook run after an item has been shown from the agenda.
22455 "Kill the entry or subtree belonging to the current agenda entry."
22488 "Kill the entry or subtree belonging to the current agenda entry."
22506 "Remove all lines in the agenda that correspond to a given subtree.
22507 The subtree is the one in buffer BUF, starting at BEG and ending at END.
22508 If this information is not given, the function uses the tree at point."
22531 "Follow the link in the current line, if any."
22540 "Get a variable from a referenced buffer and install it here."
22547 "Go to the Org-mode file which contains the item at point."
22564 "Go to the Org-mode file which contains the item at the mouse click."
22570 "Display the Org-mode file which contains the item at point."
22577 "Display the Org-mode file which contains the item at point and recenter."
22585 "Display the Org-mode file which contains the item at the mouse click."
22591 "Check if the entry is a diary link and abort if yes."
22599 "Show the subtree corresponding to the current entry in an indirect buffer.
22600 This calls the command `org-tree-to-indirect-buffer' from the original
22601 Org-mode buffer.
22602 With numerical prefix arg ARG, go up to this level and then take that tree.
22603 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
22604 dedicated frame)."
22617 "Marker pointing to the headline that last changed its TODO state
22621 "Switch TODO entry to next sequence."
22626 "Switch TODO entry to previous sequence."
22631 "Cycle TODO state of line at point, also in Org-mode file.
22632 This changes the line at point, all other lines in the agenda referring to
22633 the same tree node, and the headline of the tree node in the Org-mode file."
22643 newhead)
22664 "Change all lines in the agenda buffer which match HDMARKER.
22665 The new content of the line will be NEWHEAD (as modified by
22666 `org-format-agenda-item'). HDMARKER is checked with
22667 `equal' against all `org-hd-marker' text properties in the file.
22668 If FIXFACE is non-nil, the face of each item is modified acording to
22669 the new TODO state."
22671 props m pl undone-face done-face finish new dotime cat tags)
22701 undone-face done-face))))
22709 "Align all tags in agenda items to `org-agenda-tags-column'."
22722 org-agenda-tags-column))
22730 "Increase the priority of line at point, also in Org-mode file."
22735 "Decrease the priority of line at point, also in Org-mode file."
22740 "Set the priority of line at point, also in Org-mode file.
22741 This changes the line at point, all other lines in the agenda referring to
22742 the same tree node, and the headline of the tree node in the Org-mode file."
22751 newhead)
22767 "Get a list of all headline tags applicable at POS.
22768 POS defaults to point. If tags are inherited, the list contains
22769 the targets in the same sequence as the headlines appear, i.e.
22770 the tags of the current headline come last."
22785 tags)))
22789 tags)))
22791 ;; FIXME: should fix the tags property of the agenda line.
22793 "Set tags for the current headline."
22804 newhead)
22822 "Toggle the archive tag for the current entry."
22831 newhead)
22847 "Change the date of this item to one day later."
22866 "Change the date of this item to one day earlier."
22871 "Show new date stamp via text properties."
22872 ;; We use text properties to make this undoable
22881 ;; Use `duplicable' property to trigger undo recording
22896 "Change the date of this item. Date is prompted for, with default today.
22897 The prefix ARG is passed to the `org-time-stamp' command and can therefore
22898 be used to request time specification in the time stamp."
22916 "Schedule the item at point."
22925 ts)
22937 "Schedule the item at point."
22946 ts)
22956 "Return the heading of the current entry, without the stars."
22966 "Start the clock on the currently selected item."
22979 "Stop the currently running clock."
22987 "Cancel the currently running clock."
22995 "Make a diary entry, like the `i' command from the calendar.
22996 All the standard commands work: block, weekly etc."
23012 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
23021 ;; We implement this by hacking the `calendar-cursor-to-date' function
23022 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
23038 "Execute a calendar command from the agenda, with the date associated to
23039 the cursor position."
23048 ;; the following 3 vars are needed in the calendar
23062 "Display the phases of the moon for the 3 months around the cursor date."
23067 "Display the holidays for the 3 months around the cursor date."
23072 "Display sunrise and sunset for the cursor date.
23073 Latitude and longitude can be specified with the variables
23074 `calendar-latitude' and `calendar-longitude'. When called with prefix
23075 argument, latitude and longitude will be prompted for."
23084 "Open the Emacs calendar with the date at the cursor."
23097 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
23098 This is a command that has to be installed in `calendar-mode-map'."
23102 nil))
23108 date s)
23134 ;;;; Embedded LaTeX
23149 "Toggle the minor `org-cdlatex-mode'.
23150 This mode supports entering LaTeX environment and math in LaTeX fragments
23151 in Org-mode.
23153 nil " OCDL" nil
23158 "Always return t in org-mode buffers.
23159 This is because we want to insert math symbols without dollars even outside
23160 the LaTeX math segments. If Orgmode thinks that point is actually inside
23161 en embedded LaTeX fragement, let texmathp do its job.
23178 "Unconditionally turn on `org-cdlatex-mode'."
23182 "Test if point is inside a LaTeX fragment.
23184 sequence appearing also before point.
23185 Even though the matchers for math are configurable, this function assumes
23187 delimiters are skipped when they have been removed by customization.
23188 The return value is nil, or a cons cell with the delimiter and
23189 and the position of this delimiter.
23191 This function does a reasonably good job, but can locally be fooled by
23192 for example currency specifications. For example it will assume being in
23194 fragments that are properly closed, but during editing, we have to live
23195 with the uncertainty caused by missing closing delimiters. This function
23196 looks only before point, not after."
23215 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
23219 ;; count $$
23227 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
23228 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
23229 - inside a LaTeX fragment, or
23230 - after the first word in a line, where an abbreviation expansion could
23231 insert a LaTeX environment."
23244 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
23245 Revert to the normal definition outside of these fragments."
23253 "Execute `cdlatex-math-modify' in LaTeX fragments.
23254 Revert to the normal definition outside of these fragments."
23266 "Remove all overlays with LaTeX fragment images in current buffer."
23271 "Preview the LaTeX fragment at point, or all locally or globally.
23272 If the cursor is in a LaTeX fragment, create the image and overlay
23273 it over the source code. If there is no fragment at point, display
23274 all fragments in the current text, from one headline to the next. With
23275 prefix SUBTREE, display all fragments in the current subtree. With a
23276 double prefix `C-u C-u', or when the cursor is before the first headline,
23277 display all fragments in the buffer.
23307 buffer-file-name)))
23313 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
23314 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
23315 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
23322 "Replace LaTeX fragments with links to an image, and produce images."
23331 m n block linkfile movefile ov)
23332 ;; Check if there are old images files with this prefix, and remove them
23336 todir 'full
23338 ;; Check the different regular expressions
23358 txt movefile opt forbuffer)
23366 ov 'end-glyph
23369 ov 'display
23376 ;; This function borrows from Ganesh Swami's latex2png.el
23380 temporary-file-directory))
23409 "-D" dpi
23410 ;;"-x" scale "-y" scale
23412 "-o" pngfile
23413 dvifile)
23416 ;; Use the requested file name and clean up
23420 pngfile))))
23423 "Return an rgb color specification for dvipng."
23429 "Return string to be used as color value for an RGB component."
23432 ;;;; Exporting
23434 ;;; Variables, constants, and parameter plists
23490 "Return the property list with default settings for the export variables."
23494 rtn))
23497 "Return the property list with file-local settings for export."
23504 p key val text options)
23537 o)
23541 options)
23545 p))))
23551 val)))
23552 dir))
23559 rtn line level)
23564 ;; Beginning of a COMMENT subtree. Skip it.
23570 ;; an ordinary comment line
23571 )
23577 ;; a special table line that should be removed
23578 )
23585 \[v] limit export to visible part of outline tree
23587 \[a] export as ASCII
23589 \[h] export as HTML
23590 \[H] export as HTML to temporary buffer
23591 \[R] export region as HTML
23592 \[b] export as HTML and browse immediately
23593 \[x] export as XOXO
23595 \[l] export as LaTeX
23596 \[L] export as LaTeX to temporary buffer
23598 \[i] export current file as iCalendar file
23599 \[I] export all agenda files as iCalendar files
23600 \[c] export agenda files into combined iCalendar file
23602 \[F] publish current file
23603 \[P] publish current project
23604 \[X] publish... (project will be prompted for)
23624 r1 r2 ass)
23927 )
23928 "Entities for TeX->HTML translation.
23932 The list contains HTML entities for Latin-1, Greek and other symbols.
23933 It is supplemented by a number of commonly used TeX macros with appropriate
23936 ;;; General functions for all backends
23939 "Cleanup a buffer STRING so that links can be created safely."
23957 a b xx
23958 rtn p)
23962 ;; Remove license-to-kill stuff
23970 ;; Get rid of drawers
23975 'identity
23983 ;; Get the correct stuff before the first headline
23994 ;; Get rid of archived trees
24006 ;; Find targets in comments and move them out of comments,
24007 ;; but mark them as targets that should be invisible
24012 ;; Protect backend specific stuff, throw away the others.
24017 fmt)
24048 ;; Protect quoted subtrees
24056 ;; Protect verbatim elements
24063 ;; Remove subtrees that are commented
24069 ;; Remove special table lines
24081 ;; Specific LaTeX stuff
24089 ;; Specific HTML stuff
24091 ;; Convert LaTeX fragments to images
24096 org-current-export-file)))
24100 ;; Remove or replace comments
24109 ;; Find matches for radio targets and turn them into internal links
24116 ;; Find all links that contain a newline and put them into a single line
24118 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
24124 ;; Normalize links: Convert angle and plain links into bracket links
24125 ;; Expand link abbreviations
24132 ;; added 'org-link face to links
24148 "]"
24156 ;; Find multiline emphasis and put them into single line
24170 rtn))
24173 "Get a title for the current document, from looking at the buffer."
24179 ;; Mark the line so that it will not be exported as normal text.
24183 ;; Return the title string
24187 "Return subtree title and exclude it from export."
24193 ;; This is a subtree, we take the title from the first heading
24200 title))
24203 "Take link text and make a safe target out of it."
24207 'identity
24213 "Get the minimum level in LINES."
24221 ;; Variable holding the vector with section numbers
24225 "Initialize the vector for the section numbers."
24242 "Return a string with the current section number.
24243 When LEVEL is non-nil, increase section numbers on that level."
24265 string))
24267 ;;; ASCII export
24275 "Export the outline as a pretty ASCII file.
24276 If there is an active region, export only the region.
24277 The prefix ARG specifies how many levels of the outline should become
24278 underlined headlines. The default is 3."
24307 filename))
24323 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
24332 region
24333 :for-ascii t
24334 :skip-before-1st-heading
24337 :verbatim-multiline t
24338 :archived-trees
24342 thetoc have-headings first-heading-pos
24343 table-open table-buffer)
24361 ;; create local variables for all options, to make sure all called
24362 ;; functions get the correct information
24366 org-export-plist-vars)
24369 org-export-headline-levels))
24372 umax))
24374 ;; File header
24378 org-export-author-info)
24400 line)
24401 ;; This is a headline
24407 todo
24411 org-done-keywords)))
24412 ; TODO, not DONE
24416 line lines level))))
24423 t t txt)))
24428 txt))
24443 thetoc)
24445 ))))
24446 lines)
24451 ;; Remove the quoted HTML tags.
24453 ;; Remove targets
24456 ;; Replace internal links
24460 t nil line)))
24465 ;; a Headline
24474 ;; New table starts
24476 ;; Accumulate lines
24497 ;; insert the table of contents
24509 ;; Convert whitespace place holders
24519 ;; remove display and invisible chars
24535 "Do extra work for ASCII export"
24545 "Search the subtree below LINE for any TODO entries."
24548 line lv todo)
24556 org-done-keywords))))
24557 ; TODO, not DONE
24562 "Handle quoted HTML for ASCII export."
24565 ;; We just remove the tags for now.
24567 line)
24570 "Insert the string S centered and underline it with character UNDERLINE."
24579 "Insert a new level in ASCII export."
24585 org-export-ascii-bullets))
24587 ;; find the indentation of the next non-empty line
24608 "Create a copy of the visible part of the current buffer, and export it.
24609 The copy is created in a temporary buffer and removed after use.
24610 TYPE is the final key (as a string) that also select the export command in
24611 the `C-c C-e' export dispatcher.
24612 As a special case, if the you type SPC at the prompt, the temporary
24613 org-mode file will not be removed but presented to you so that you can
24614 continue to use it. The prefix arg ARG is passed through to the exporting
24615 command."
24618 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
24620 current-prefix-arg))
24635 s e)
24636 ;; Need to hack the drawers here.
24652 ;; Copy all comment lines to the end, to make sure #+ settings are
24653 ;; still available for the second export step. Kind of a hack, but
24654 ;; does do the trick.
24675 s))
24680 s))
24682 ;;; HTML export
24685 "Return a string with current options as keyword options.
24686 Does include HTML export options as well as TODO and CATEGORY stuff."
24688 "#+TITLE: %s
24689 #+AUTHOR: %s
24690 #+EMAIL: %s
24691 #+LANGUAGE: %s
24692 #+TEXT: Some descriptive text to be emitted. Several lines OK.
24693 #+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
24694 #+CATEGORY: %s
24695 #+SEQ_TODO: %s
24696 #+TYP_TODO: %s
24697 #+PRIORITIES: %c %c %c
24698 #+DRAWERS: %s
24699 #+STARTUP: %s %s %s %s %s
24700 #+TAGS: %s
24701 #+ARCHIVE: %s
24702 #+LINK: %s
24703 "
24705 org-export-headline-levels
24706 org-export-with-section-numbers
24707 org-export-with-toc
24708 org-export-preserve-breaks
24709 org-export-html-expand
24710 org-export-with-fixed-width
24711 org-export-with-tables
24712 org-export-with-sub-superscripts
24713 org-export-with-special-strings
24714 org-export-with-footnotes
24715 org-export-with-emphasize
24716 org-export-with-TeX-macros
24717 org-export-with-LaTeX-fragments
24718 org-export-skip-text-before-1st-heading
24719 org-export-with-drawers
24720 org-export-with-tags
24722 "TODO FEEDBACK VERIFY DONE"
24723 "Me Jason Marie DONE"
24724 org-highest-priority org-lowest-priority org-default-priority
24741 org-archive-location
24742 "org file:~/org/%s.org"
24743 ))
24746 "Insert into the buffer a template with information for exporting."
24755 "Toggle the fixed-width export.
24756 If there is no active region, the QUOTE keyword at the current headline is
24757 inserted or removed. When present, it causes the text between this headline
24758 and the next to be exported as fixed-width text, and unmodified.
24759 If there is an active region, this command adds or removes a colon as the
24760 first character of this line. If the first character of a line is a colon,
24761 this line is also exported in fixed-width font."
24770 off)
24800 "Export the outline as HTML and immediately open it with a browser.
24801 If there is an active region, export only the region.
24802 The prefix ARG specifies how many levels of the outline should become
24803 headlines. The default is 3. Lower levels will become bulleted lists."
24809 "Call `org-export-as-html', may be used in batch processing as
24810 emacs --batch
24811 --load=$HOME/lib/emacs/org.el
24813 --visit=MyFile --funcall org-export-as-html-batch"
24817 "Call `org-exort-as-html` with output to a temporary buffer.
24818 No file is created. The prefix ARG is passed through to `org-export-as-html'."
24824 "Assume the current region has org-mode syntax, and convert it to HTML.
24825 This can be used in any buffer. For example, you could write an
24826 itemized list in org-mode syntax in an HTML buffer and then use this
24827 command to convert it."
24847 "Convert region from BEG to END in org-mode buffer to HTML.
24848 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
24849 contents, and only produce the region of converted text, useful for
24850 cut-and-paste operations.
24851 If BUFFER is a buffer or a string, use/create that buffer as a target
24852 of the converted HTML. If BUFFER is the symbol `string', return the
24853 produced HTML as a string and leave not buffer behind. For example,
24854 a Lisp program could call this function in the following way:
24856 (setq html (org-export-region-as-html beg end t 'string))
24858 When called interactively, the output buffer is selected, and shown
24859 in a window. A non-interactive call will only retunr the buffer."
24864 rtn)
24869 nil nil nil
24870 buffer body-only))
24874 rtn)))
24878 to-buffer body-only)
24879 "Export the outline as a pretty HTML file.
24880 If there is an active region, export only the region. The prefix
24881 ARG specifies how many levels of the outline should become
24882 headlines. The default is 3. Lower levels will become bulleted
24883 lists. When HIDDEN is non-nil, don't display the HTML buffer.
24884 EXT-PLIST is a property list with external parameters overriding
24885 org-mode's default settings, but still inferior to file-local
24886 settings. When TO-BUFFER is non-nil, create a buffer with that
24887 name and export to that buffer. If TO-BUFFER is the symbol `string',
24888 don't leave any buffer behind but just return the resulting HTML as
24889 a string. When BODY-ONLY is set, don't produce the file header and footer,
24890 simply return the content of <body>...</body>, without even
24891 the body tags themselves."
24894 ;; Make sure we have a file name when we need it.
24900 buffer-file-name))
24909 ext-plist
24915 valid thetoc have-headings first-heading-pos
24924 ;; The following two are dynamically scoped into other
24925 ;; routines below.
24944 default-directory))
24978 buffer-file-coding-system))
24980 coding-system))
24982 coding-system))
24994 region
24995 :emph-multiline t
24996 :for-html t
24997 :skip-before-1st-heading
25000 :archived-trees
25002 :add-text
25004 :LaTeX-fragments
25007 table-open type
25008 table-buffer table-orig-buffer
25009 ind start-is-num starter didclose
25010 rpl path desc descp desc1 desc2 link
25011 )
25030 ;; Get the language-dependent settings
25034 ;; Switch to the output buffer
25044 ;; create local variables for all options, to make sure all called
25045 ;; functions get the correct information
25049 org-export-plist-vars)
25051 org-export-headline-levels))
25054 umax))
25056 ;; File header
25062 <head>
25063 <title>%s</title>
25068 %s
25069 </head><body>
25070 "
25083 org-export-html-toplevel-hlevel
25085 org-export-html-toplevel-hlevel)
25086 thetoc)
25091 ;; This is a headline
25100 todo
25104 org-done-keywords)))
25105 ; TODO, not DONE
25109 line lines level))))
25134 ;; Check for targets
25139 t t line))
25142 target-alist))
25153 )))
25154 line)
25155 lines))
25167 ;; end of quote section?
25171 ;; inside a quote section?
25176 ;; verbatim lines
25190 ;; Protected HTML
25205 ;; Horizontal line
25210 ;; make targets to anchors
25218 t t line)))
25222 ; (concat "@<i>" (match-string 1 line) "@</i> ")
25223 t t line)))
25229 t t line)))))
25233 ;; replace "&" by "&", "<" and ">" by "<" and ">"
25234 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
25235 ;; Also handle sub_superscripts and checkboxes
25239 ;; Format the links
25249 ;; Make an image out of the description if that is so wanted
25255 ;; FIXME: do we need to unescape here somewhere?
25265 ;; standard URL, just check if we need to inline an image
25273 ;; standard URL
25277 ;; FILE link
25280 thefile file-is-image-p search)
25288 t))
25297 ;; make sure this is can be used as target search
25322 ;; TODO items
25330 org-done-keywords)
25335 ;; Does this contain a reference to a footnote?
25347 t t line))))))
25351 ;; This is a headline
25359 ;; Close any local lists before inserting a new header line
25365 in-local-list nil))
25369 head-count)
25370 ;; QUOTES
25378 ;; New table starts
25380 ;; Accumulate lines
25392 ;; Normal lines
25395 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25396 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
25399 line)
25406 ;; empty line. Pretend indentation is large.
25408 0
25424 ;; Start new (level of) list
25431 ;; continue current list
25435 ;; we did close a list, normal text follows: need <p>
25441 "<b>[X]</b>"
25443 t t line))))
25445 ;; Empty lines start a new paragraph. If hand-formatted lists
25446 ;; are not fully interpreted, lines starting with "-", "+", "*"
25447 ;; also start a new paragraph.
25450 ;; Is this the start of a footnote?
25456 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
25458 ;; Check if the line break needs to be conserved
25467 ;; Properly close all local lists and other lists
25470 ;; Close any local lists before inserting a new header line
25476 in-local-list nil))
25479 head-count)
25510 ;; insert the table of contents
25527 ;; remove empty paragraphs and lists
25537 ;; Convert whitespace place holders
25558 "Format a table for ascii export."
25562 ;; Table made by table.el - test for spanning
25563 lines
25565 ;; A normal org table
25566 ;; Get rid of hlines at beginning and end
25572 ;; Check if the table has a marking column. If yes remove the
25573 ;; column and the special lines
25575 ;; Get rid of the vertical lines except for grouping
25577 rtn line vl1 start)
25599 vl))
25602 "Find out which HTML converter to use and return the HTML code."
25606 ;; A normal org table
25608 ;; Table made by table.el - test for spanning
25612 nil))
25613 lines)))
25619 hlines))))
25622 ;; We can use my own converter with HTML conversions
25624 ;; Need to use the code generator in table.el, with the original text.
25628 "Format a table into HTML."
25629 ;; Get rid of hlines at beginning and end
25635 ;; Check if the table has a marking column. If yes remove the
25636 ;; column and the special lines
25644 tbopen line fields html gr colgropen)
25656 ;; ignore this line
25658 ;; Break the line into fields
25676 html)))
25681 ;; Put in col tags with the alignment (unfortuntely often ignored...)
25697 html)
25703 "Check if the table has a marking column.
25704 If yes remove the column and the special lines."
25710 lines))
25725 nil)
25727 lines)))
25741 nil)
25746 ;; remove the first column
25748 lines))))
25751 "Format a table generated by table.el into HTML.
25752 This conversion does *not* use `table-generate-source' from table.el.
25753 This has the advantage that Org-mode's HTML conversions can be used.
25754 But it has the disadvantage, that no cell- or row-spanning is allowed."
25757 fields html empty)
25767 html
25769 html
25770 "<tr>"
25783 ;; Ignore this line
25785 ;; Break the line into fields and store the fields
25791 field-buffer))
25794 html))
25797 "Format a table into html, using `table-generate-source' from table.el.
25798 This has the advantage that cell- or row-spanning is allowed.
25799 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
25814 "Format time stamps in string S, or remove them."
25819 ;; never export CLOCK
25834 ;; Line break if line started and ended with time stamp stuff
25836 s
25840 r))))
25843 ;; convert & to &, < to < and > to >
25852 s)
25855 "Remove tags and time staps from lines going into the toc."
25864 t t s)))
25865 s)
25868 "Prepare STRING for HTML export. Applies all active conversions.
25869 If there are links in the string, don't modify these."
25872 m s l res)
25883 "Apply all active conversions to translate special ASCII to HTML."
25904 t t s))
25906 s)
25909 "Create a regular expression which will match a balanced sexp.
25910 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
25911 as single character strings.
25912 The regexp returned will match the entire expression including the
25913 delimiters. It will also define a single group which contains the
25914 match except for the outermost delimiters. The maximum depth of
25915 stacked delimiters is N. Escaping delimiters is not possible."
25951 "Convert special characters in STRING to HTML."
25953 e a re rpl start)
25960 string))
25963 "Convert sub- and superscripts in STRING to HTML."
25979 t t string)))))
25982 string))
25985 "Apply emphasis."
25992 rpl
25998 org-emphasis-alist))
26003 string))
26007 "Insert <p>, but first close previous paragraph if any."
26012 "Close paragraph if there is one open."
26017 "Close <li> if necessary."
26023 "Insert a new level in HTML export.
26024 When TITLE is nil, just close all open levels."
26034 ;; If title is nil, this means this function is called to close
26035 ;; all levels, so the rest is done only if title is given
26047 t t title)))
26063 level level head-count title level))
26068 "Terminate one level in HTML export."
26074 ;;; iCalendar export
26076 ;;;###autoload
26078 "Export current file as an iCalendar file.
26079 The iCalendar file will be located in the same directory as the Org-mode
26080 file, but with extension `.ics'."
26084 ;;;###autoload
26086 "Export all files in `org-agenda-files' to iCalendar .ics files.
26087 Each iCalendar file will be located in the same directory as the Org-mode
26088 file, but with extension `.ics'."
26092 ;;;###autoload
26094 "Export all files in `org-agenda-files' to a single combined iCalendar file.
26095 The file is stored under the name `org-combined-agenda-icalendar-file'."
26100 "Create iCalendar files for all elements of FILES.
26101 If COMBINE is non-nil, combine all calendar entries into a single large
26102 file and store it under the name `org-combined-agenda-icalendar-file'."
26107 org-export-publishing-directory)))
26108 file ical-file ical-buffer category started org-agenda-new-buffers)
26114 org-combined-agenda-icalendar-file
26147 "Hook run after an iCalendar file has been saved.
26148 The iCalendar buffer is still current when this hook is run.
26149 A good way to use this is to tell a desktop calenndar application to re-read
26153 "Print iCalendar entries for the current Org-mode file to `standard-output'.
26154 When COMBINE is non nil, add the category to each line."
26161 scheduledp deadlinep tmp pri category entry location summary desc
26171 inc t
26178 t org-icalendar-include-body)
26188 pos)
26193 ts)
26196 ;; donep (org-entry-is-done-p)
26197 ))
26216 t t summary)))
26223 %s
26224 %s%s
26225 SUMMARY:%s%s%s
26226 CATEGORIES:%s
26230 rrule summary
26235 category)))))
26240 ;; Get all the literal sexps
26266 )
26273 t org-icalendar-include-body)
26279 t t hd)))
26289 %s
26290 SUMMARY:%s%s%s
26291 CATEGORIES:%s
26292 SEQUENCE:1
26293 PRIORITY:%d
26294 STATUS:%s
26296 dts
26302 category pri status)))))))))
26305 "Take out stuff and quote what needs to be quoted.
26306 When IS-BODY is non-nil, assume that this is the body of an item, clean up
26307 whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
26308 characters."
26310 nil
26329 s))
26332 "Clean-up description string."
26338 "Start an iCalendar file by inserting the header."
26344 VERSION:2.0
26345 X-WR-CALNAME:%s
26346 PRODID:-//%s//Emacs with Org-mode//EN
26347 X-WR-TIMEZONE:%s
26351 "Finish an iCalendar file by inserting the END statement."
26355 "Take a time string S and convert it to iCalendar format.
26356 KEYWORD is added in front, to make a complete line like DTSTART....
26357 When INC is non-nil, increase the hour by two (if time string contains
26358 a time), or the day by one (if it does not contain a time)."
26360 t2 fmt have-time time)
26376 ;;; XOXO export
26384 "Export the org buffer as XOXO.
26385 The XOXO buffer is named *xoxo-<source buffer name>*"
26387 ;; A quickie abstraction
26389 ;; Output everything as XOXO
26403 ;; Check the output buffer is empty.
26405 ;; Kick off the output
26422 ;; Handle level rendering
26439 )
26443 ;; And output the new li
26449 ;; Finally finish off the ol
26456 ;; Finish the buffer off and clean it up.
26461 )))
26464 ;;;; Key bindings
26466 ;; Make `C-c C-x' a prefix key
26469 ;; TAB key with modifiers
26476 ;; The following line is necessary under Suse GNU/Linux
26482 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
26483 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
26484 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
26486 ;; Cursor keys with modifiers
26487 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
26488 (org-defkey org-mode-map [(meta right)] 'org-metaright)
26489 (org-defkey org-mode-map [(meta up)] 'org-metaup)
26490 (org-defkey org-mode-map [(meta down)] 'org-metadown)
26492 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
26493 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
26494 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
26495 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
26497 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
26498 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
26499 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
26500 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
26502 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
26503 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
26505 ;;; Extra keys for tty access.
26506 ;; We only set them when really needed because otherwise the
26507 ;; menus don't show the simple keys
26509 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
26510 (not window-system))
26511 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
26512 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
26513 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
26514 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
26515 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
26516 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
26517 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
26518 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
26519 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
26520 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
26521 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
26522 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
26523 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
26524 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
26525 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
26526 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
26527 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
26528 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
26529 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
26530 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
26531 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
26532 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
26534 ;; All the other keys
26536 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
26537 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
26538 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
26539 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
26540 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
26541 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
26542 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
26543 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
26544 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
26545 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
26546 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
26547 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
26548 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
26549 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
26550 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
26552 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
26553 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
26554 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
26555 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
26556 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
26557 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
26558 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
26559 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
26560 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
26561 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
26562 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
26563 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
26564 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
26565 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
26566 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
26567 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
26568 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
26570 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
26571 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
26572 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
26573 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
26574 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
26575 (org-defkey org-mode-map "\C-c^" 'org-sort)
26576 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
26577 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
26578 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
26579 (org-defkey org-mode-map "\C-m" 'org-return)
26580 (org-defkey org-mode-map "\C-j" 'org-return-indent)
26581 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
26582 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
26583 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
26584 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
26585 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
26586 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
26587 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
26588 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
26589 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
26590 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
26591 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
26592 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
26593 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
26594 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
26595 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
26596 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
26598 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
26599 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
26600 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
26601 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
26603 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
26604 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
26605 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
26606 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
26607 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
26608 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
26609 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
26610 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
26611 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
26612 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
26613 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
26614 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
26616 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
26618 (when (featurep 'xemacs)
26619 (org-defkey org-mode-map 'button3 'popup-mode-menu))
26621 (defsubst org-table-p () (org-at-table-p))
26623 (defun org-self-insert-command (N)
26624 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
26625 If the cursor is in a table looking at whitespace, the whitespace is
26626 overwritten, and the table is not marked as requiring realignment."
26627 (interactive "p")
26628 (if (and (org-table-p)
26629 (progn
26630 ;; check if we blank the field, and if that triggers align
26631 (and org-table-auto-blank-field
26632 (member last-command
26633 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
26635 ;; got extra space, this field does not determine column width
26636 (let (org-table-may-need-update) (org-table-blank-field))
26637 ;; no extra space, this field may determine column width
26638 (org-table-blank-field)))
26639 t)
26640 (eq N 1)
26642 (let (org-table-may-need-update)
26643 (goto-char (1- (match-end 0)))
26644 (delete-backward-char 1)
26645 (goto-char (match-beginning 0))
26646 (self-insert-command N))
26647 (setq org-table-may-need-update t)
26648 (self-insert-command N)
26649 (org-fix-tags-on-the-fly)))
26651 (defun org-fix-tags-on-the-fly ()
26652 (when (and (equal (char-after (point-at-bol)) ?*)
26653 (org-on-heading-p))
26654 (org-align-tags-here org-tags-column)))
26656 (defun org-delete-backward-char (N)
26657 "Like `delete-backward-char', insert whitespace at field end in tables.
26658 When deleting backwards, in tables this function will insert whitespace in
26660 still be marked for re-alignment if the field did fill the entire column,
26661 because, in this case the deletion might narrow the column."
26662 (interactive "p")
26663 (if (and (org-table-p)
26664 (eq N 1)
26665 (string-match "|" (buffer-substring (point-at-bol) (point)))
26666 (looking-at ".*?|"))
26667 (let ((pos (point))
26669 (c org-table-may-need-update))
26670 (backward-delete-char N)
26671 (skip-chars-forward "^|")
26672 (insert " ")
26673 (goto-char (1- pos))
26674 ;; noalign: if there were two spaces at the end, this field
26675 ;; does not determine the width of the column.
26676 (if noalign (setq org-table-may-need-update c)))
26677 (backward-delete-char N)
26678 (org-fix-tags-on-the-fly)))
26680 (defun org-delete-char (N)
26681 "Like `delete-char', but insert whitespace at field end in tables.
26682 When deleting characters, in tables this function will insert whitespace in
26684 still be marked for re-alignment if the field did fill the entire column,
26685 because, in this case the deletion might narrow the column."
26686 (interactive "p")
26687 (if (and (org-table-p)
26688 (not (bolp))
26689 (not (= (char-after) ?|))
26690 (eq N 1))
26691 (if (looking-at ".*?|")
26692 (let ((pos (point))
26694 (c org-table-may-need-update))
26695 (replace-match (concat
26696 (substring (match-string 0) 1 -1)
26697 " |"))
26698 (goto-char pos)
26699 ;; noalign: if there were two spaces at the end, this field
26700 ;; does not determine the width of the column.
26701 (if noalign (setq org-table-may-need-update c)))
26702 (delete-char N))
26703 (delete-char N)
26704 (org-fix-tags-on-the-fly)))
26706 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
26707 (put 'org-self-insert-command 'delete-selection t)
26708 (put 'orgtbl-self-insert-command 'delete-selection t)
26709 (put 'org-delete-char 'delete-selection 'supersede)
26710 (put 'org-delete-backward-char 'delete-selection 'supersede)
26712 ;; Make `flyspell-mode' delay after some commands
26713 (put 'org-self-insert-command 'flyspell-delayed t)
26714 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
26715 (put 'org-delete-char 'flyspell-delayed t)
26716 (put 'org-delete-backward-char 'flyspell-delayed t)
26718 ;; Make pabbrev-mode expand after org-mode commands
26719 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
26720 (put 'orgybl-self-insert-command 'pabbrev-expand-after-command t)
26722 ;; How to do this: Measure non-white length of current string
26723 ;; If equal to column width, we should realign.
26725 (defun org-remap (map &rest commands)
26726 "In MAP, remap the functions given in COMMANDS.
26727 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
26728 (let (new old)
26729 (while commands
26730 (setq old (pop commands) new (pop commands))
26731 (if (fboundp 'command-remapping)
26732 (org-defkey map (vector 'remap old) new)
26733 (substitute-key-definition old new map global-map)))))
26735 (when (eq org-enable-table-editor 'optimized)
26736 ;; If the user wants maximum table support, we need to hijack
26737 ;; some standard editing functions
26738 (org-remap org-mode-map
26739 'self-insert-command 'org-self-insert-command
26740 'delete-char 'org-delete-char
26741 'delete-backward-char 'org-delete-backward-char)
26742 (org-defkey org-mode-map "|" 'org-force-self-insert))
26744 (defun org-shiftcursor-error ()
26745 "Throw an error because Shift-Cursor command was applied in wrong context."
26746 (error "This command is active in special context like tables, headlines or timestamps"))
26748 (defun org-shifttab (&optional arg)
26749 "Global visibility cycling or move to previous table field.
26750 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
26751 on context.
26752 See the individual commands for more information."
26753 (interactive "P")
26754 (cond
26755 ((org-at-table-p) (call-interactively 'org-table-previous-field))
26756 (arg (message "Content view to level: ")
26757 (org-content (prefix-numeric-value arg))
26758 (setq org-cycle-global-status 'overview))
26759 (t (call-interactively 'org-global-cycle))))
26761 (defun org-shiftmetaleft ()
26762 "Promote subtree or delete table column.
26763 Calls `org-promote-subtree', `org-outdent-item',
26764 or `org-table-delete-column', depending on context.
26765 See the individual commands for more information."
26766 (interactive)
26767 (cond
26768 ((org-at-table-p) (call-interactively 'org-table-delete-column))
26769 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
26770 ((org-at-item-p) (call-interactively 'org-outdent-item))
26771 (t (org-shiftcursor-error))))
26773 (defun org-shiftmetaright ()
26774 "Demote subtree or insert table column.
26775 Calls `org-demote-subtree', `org-indent-item',
26776 or `org-table-insert-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-insert-column))
26781 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
26782 ((org-at-item-p) (call-interactively 'org-indent-item))
26783 (t (org-shiftcursor-error))))
26785 (defun org-shiftmetaup (&optional arg)
26786 "Move subtree up or kill table row.
26787 Calls `org-move-subtree-up' or `org-table-kill-row' or
26788 `org-move-item-up' depending on context. See the individual commands
26789 for more information."
26790 (interactive "P")
26791 (cond
26792 ((org-at-table-p) (call-interactively 'org-table-kill-row))
26793 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26794 ((org-at-item-p) (call-interactively 'org-move-item-up))
26795 (t (org-shiftcursor-error))))
26796 (defun org-shiftmetadown (&optional arg)
26797 "Move subtree down or insert table row.
26798 Calls `org-move-subtree-down' or `org-table-insert-row' or
26799 `org-move-item-down', depending on context. See the individual
26800 commands for more information."
26801 (interactive "P")
26802 (cond
26803 ((org-at-table-p) (call-interactively 'org-table-insert-row))
26804 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26805 ((org-at-item-p) (call-interactively 'org-move-item-down))
26806 (t (org-shiftcursor-error))))
26808 (defun org-metaleft (&optional arg)
26809 "Promote heading or move table column to left.
26810 Calls `org-do-promote' or `org-table-move-column', depending on context.
26811 With no specific context, calls the Emacs default `backward-word'.
26812 See the individual commands for more information."
26813 (interactive "P")
26814 (cond
26815 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
26816 ((or (org-on-heading-p) (org-region-active-p))
26817 (call-interactively 'org-do-promote))
26818 ((org-at-item-p) (call-interactively 'org-outdent-item))
26819 (t (call-interactively 'backward-word))))
26821 (defun org-metaright (&optional arg)
26822 "Demote subtree or move table column to right.
26823 Calls `org-do-demote' or `org-table-move-column', depending on context.
26824 With no specific context, calls the Emacs default `forward-word'.
26825 See the individual commands for more information."
26826 (interactive "P")
26827 (cond
26828 ((org-at-table-p) (call-interactively 'org-table-move-column))
26829 ((or (org-on-heading-p) (org-region-active-p))
26830 (call-interactively 'org-do-demote))
26831 ((org-at-item-p) (call-interactively 'org-indent-item))
26832 (t (call-interactively 'forward-word))))
26834 (defun org-metaup (&optional arg)
26835 "Move subtree up or move table row up.
26836 Calls `org-move-subtree-up' or `org-table-move-row' or
26837 `org-move-item-up', depending on context. See the individual commands
26838 for more information."
26839 (interactive "P")
26840 (cond
26841 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
26842 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
26843 ((org-at-item-p) (call-interactively 'org-move-item-up))
26844 (t (transpose-lines 1) (beginning-of-line -1))))
26846 (defun org-metadown (&optional arg)
26847 "Move subtree down or move table row down.
26848 Calls `org-move-subtree-down' or `org-table-move-row' or
26849 `org-move-item-down', depending on context. See the individual
26850 commands for more information."
26851 (interactive "P")
26852 (cond
26853 ((org-at-table-p) (call-interactively 'org-table-move-row))
26854 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
26855 ((org-at-item-p) (call-interactively 'org-move-item-down))
26856 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
26858 (defun org-shiftup (&optional arg)
26859 "Increase item in timestamp or increase priority of current headline.
26860 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
26861 depending on context. See the individual commands for more information."
26862 (interactive "P")
26863 (cond
26864 ((org-at-timestamp-p t)
26865 (call-interactively (if org-edit-timestamp-down-means-later
26866 'org-timestamp-down 'org-timestamp-up)))
26867 ((org-on-heading-p) (call-interactively 'org-priority-up))
26868 ((org-at-item-p) (call-interactively 'org-previous-item))
26869 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
26871 (defun org-shiftdown (&optional arg)
26872 "Decrease item in timestamp or decrease priority of current headline.
26873 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
26874 depending on context. See the individual commands for more information."
26875 (interactive "P")
26876 (cond
26877 ((org-at-timestamp-p t)
26878 (call-interactively (if org-edit-timestamp-down-means-later
26879 'org-timestamp-up 'org-timestamp-down)))
26880 ((org-on-heading-p) (call-interactively 'org-priority-down))
26881 (t (call-interactively 'org-next-item))))
26883 (defun org-shiftright ()
26884 "Next TODO keyword or timestamp one day later, depending on context."
26885 (interactive)
26886 (cond
26887 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
26888 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
26889 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
26890 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
26891 (t (org-shiftcursor-error))))
26893 (defun org-shiftleft ()
26894 "Previous TODO keyword or timestamp one day earlier, depending on context."
26895 (interactive)
26896 (cond
26897 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
26898 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
26899 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
26900 ((org-at-property-p)
26901 (call-interactively 'org-property-previous-allowed-value))
26902 (t (org-shiftcursor-error))))
26904 (defun org-shiftcontrolright ()
26905 "Switch to next TODO set."
26906 (interactive)
26907 (cond
26908 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
26909 (t (org-shiftcursor-error))))
26911 (defun org-shiftcontrolleft ()
26912 "Switch to previous TODO set."
26913 (interactive)
26914 (cond
26915 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
26916 (t (org-shiftcursor-error))))
26918 (defun org-ctrl-c-ret ()
26919 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
26920 (interactive)
26921 (cond
26922 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
26923 (t (call-interactively 'org-insert-heading))))
26925 (defun org-copy-special ()
26926 "Copy region in table or copy current subtree.
26927 Calls `org-table-copy' or `org-copy-subtree', depending on context.
26928 See the individual commands for more information."
26929 (interactive)
26930 (call-interactively
26931 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
26933 (defun org-cut-special ()
26934 "Cut region in table or cut current subtree.
26935 Calls `org-table-copy' or `org-cut-subtree', depending on context.
26936 See the individual commands for more information."
26937 (interactive)
26938 (call-interactively
26939 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
26941 (defun org-paste-special (arg)
26942 "Paste rectangular region into table, or past subtree relative to level.
26943 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
26944 See the individual commands for more information."
26945 (interactive "P")
26946 (if (org-at-table-p)
26947 (org-table-paste-rectangle)
26948 (org-paste-subtree arg)))
26950 (defun org-ctrl-c-ctrl-c (&optional arg)
26951 "Set tags in headline, or update according to changed information at point.
26953 This command does many different things, depending on context:
26955 - If the cursor is in a headline, prompt for tags and insert them
26956 into the current line, aligned to `org-tags-column'. When called
26957 with prefix arg, realign all tags in the current buffer.
26959 - If the cursor is in one of the special #+KEYWORD lines, this
26960 triggers scanning the buffer for these lines and updating the
26961 information.
26963 - If the cursor is inside a table, realign the table. This command
26964 works even if the automatic table editor has been turned off.
26966 - If the cursor is on a #+TBLFM line, re-apply the formulas to
26967 the entire table.
26969 - If the cursor is a the beginning of a dynamic block, update it.
26971 - If the cursor is inside a table created by the table.el package,
26972 activate that table.
26974 - If the current buffer is a remember buffer, close note and file it.
26975 with a prefix argument, file it without further interaction to the default
26976 location.
26978 - If the cursor is on a <<<target>>>, update radio targets and corresponding
26979 links in this buffer.
26981 - If the cursor is on a numbered item in a plain list, renumber the
26982 ordered list.
26984 - If the cursor is on a checkbox, toggle it."
26985 (interactive "P")
26986 (let ((org-enable-table-editor t))
26987 (cond
26988 ((or org-clock-overlays
26989 org-occur-highlights
26990 org-latex-fragment-image-overlays)
26991 (org-remove-clock-overlays)
26992 (org-remove-occur-highlights)
26993 (org-remove-latex-fragment-image-overlays)
26994 (message "Temporary highlights/overlays removed from current buffer"))
26995 ((and (local-variable-p 'org-finish-function (current-buffer))
26996 (fboundp org-finish-function))
26997 (funcall org-finish-function))
26998 ((org-at-property-p)
26999 (call-interactively 'org-property-action))
27000 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
27001 ((org-on-heading-p) (call-interactively 'org-set-tags))
27002 ((org-at-table.el-p)
27003 (require 'table)
27004 (beginning-of-line 1)
27005 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
27006 (call-interactively 'table-recognize-table))
27007 ((org-at-table-p)
27008 (org-table-maybe-eval-formula)
27009 (if arg
27010 (call-interactively 'org-table-recalculate)
27011 (org-table-maybe-recalculate-line))
27012 (call-interactively 'org-table-align))
27013 ((org-at-item-checkbox-p)
27014 (call-interactively 'org-toggle-checkbox))
27015 ((org-at-item-p)
27016 (call-interactively 'org-maybe-renumber-ordered-list))
27018 ;; Dynamic block
27019 (beginning-of-line 1)
27020 (org-update-dblock))
27022 (cond
27023 ((equal (match-string 1) "TBLFM")
27024 ;; Recalculate the table before this line
27025 (save-excursion
27026 (beginning-of-line 1)
27028 (if (org-at-table-p)
27029 (org-call-with-arg 'org-table-recalculate t))))
27030 (t
27031 (call-interactively 'org-mode-restart))))
27032 (t (error "C-c C-c can do nothing useful at this location.")))))
27034 (defun org-mode-restart ()
27035 "Restart Org-mode, to scan again for special lines.
27036 Also updates the keyword regular expressions."
27037 (interactive)
27038 (let ((org-inhibit-startup t)) (org-mode))
27039 (message "Org-mode restarted to refresh keyword and special line setup"))
27041 (defun org-kill-note-or-show-branches ()
27042 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
27043 (interactive)
27044 (if (not org-finish-function)
27045 (call-interactively 'show-branches)
27046 (let ((org-note-abort t))
27047 (funcall org-finish-function))))
27049 (defun org-return (&optional indent)
27050 "Goto next table row or insert a newline.
27051 Calls `org-table-next-row' or `newline', depending on context.
27052 See the individual commands for more information."
27053 (interactive)
27054 (cond
27055 ((bobp) (if indent (newline-and-indent) (newline)))
27056 ((and (org-at-heading-p)
27057 (looking-at
27059 (org-show-entry)
27060 (end-of-line 1)
27061 (newline))
27062 ((org-at-table-p)
27063 (org-table-justify-field-maybe)
27064 (call-interactively 'org-table-next-row))
27065 (t (if indent (newline-and-indent) (newline)))))
27067 (defun org-return-indent ()
27068 (interactive)
27069 "Goto next table row or insert a newline and indent.
27070 Calls `org-table-next-row' or `newline-and-indent', depending on
27071 context. See the individual commands for more information."
27072 (org-return t))
27074 (defun org-ctrl-c-minus ()
27075 "Insert separator line in table or modify bullet type in list.
27076 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
27077 depending on context."
27078 (interactive)
27079 (cond
27080 ((org-at-table-p)
27081 (call-interactively 'org-table-insert-hline))
27082 ((org-on-heading-p)
27083 ;; Convert to item
27084 (save-excursion
27085 (beginning-of-line 1)
27087 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
27088 ((org-in-item-p)
27089 (call-interactively 'org-cycle-list-bullet))
27090 (t (error "`C-c -' does have no function here."))))
27092 (defun org-meta-return (&optional arg)
27093 "Insert a new heading or wrap a region in a table.
27094 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
27095 See the individual commands for more information."
27096 (interactive "P")
27097 (cond
27098 ((org-at-table-p)
27099 (call-interactively 'org-table-wrap-region))
27100 (t (call-interactively 'org-insert-heading))))
27102 ;;; Menu entries
27104 ;; Define the Org-mode menus
27105 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
27106 '("Tbl"
27107 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
27108 ["Next Field" org-cycle (org-at-table-p)]
27109 ["Previous Field" org-shifttab (org-at-table-p)]
27110 ["Next Row" org-return (org-at-table-p)]
27111 "--"
27112 ["Blank Field" org-table-blank-field (org-at-table-p)]
27113 ["Edit Field" org-table-edit-field (org-at-table-p)]
27114 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
27115 "--"
27116 ("Column"
27117 ["Move Column Left" org-metaleft (org-at-table-p)]
27118 ["Move Column Right" org-metaright (org-at-table-p)]
27119 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
27120 ["Insert Column" org-shiftmetaright (org-at-table-p)])
27121 ("Row"
27122 ["Move Row Up" org-metaup (org-at-table-p)]
27123 ["Move Row Down" org-metadown (org-at-table-p)]
27124 ["Delete Row" org-shiftmetaup (org-at-table-p)]
27125 ["Insert Row" org-shiftmetadown (org-at-table-p)]
27126 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
27127 "--"
27128 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
27129 ("Rectangle"
27130 ["Copy Rectangle" org-copy-special (org-at-table-p)]
27131 ["Cut Rectangle" org-cut-special (org-at-table-p)]
27132 ["Paste Rectangle" org-paste-special (org-at-table-p)]
27133 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
27134 "--"
27135 ("Calculate"
27136 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
27137 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
27138 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
27139 "--"
27140 ["Recalculate line" org-table-recalculate (org-at-table-p)]
27141 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
27142 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
27143 "--"
27144 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
27145 "--"
27146 ["Sum Column/Rectangle" org-table-sum
27147 (or (org-at-table-p) (org-region-active-p))]
27148 ["Which Column?" org-table-current-column (org-at-table-p)])
27149 ["Debug Formulas"
27150 org-table-toggle-formula-debugger
27151 :style toggle :selected org-table-formula-debug]
27152 ["Show Col/Row Numbers"
27153 org-table-toggle-coordinate-overlays
27154 :style toggle :selected org-table-overlay-coordinates]
27155 "--"
27156 ["Create" org-table-create (and (not (org-at-table-p))
27157 org-enable-table-editor)]
27158 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
27159 ["Import from File" org-table-import (not (org-at-table-p))]
27160 ["Export to File" org-table-export (org-at-table-p)]
27161 "--"
27162 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
27164 (easy-menu-define org-org-menu org-mode-map "Org menu"
27165 '("Org"
27166 ("Show/Hide"
27167 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
27168 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
27169 ["Sparse Tree" org-occur t]
27170 ["Reveal Context" org-reveal t]
27171 ["Show All" show-all t]
27172 "--"
27173 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
27174 "--"
27175 ["New Heading" org-insert-heading t]
27176 ("Navigate Headings"
27177 ["Up" outline-up-heading t]
27178 ["Next" outline-next-visible-heading t]
27179 ["Previous" outline-previous-visible-heading t]
27180 ["Next Same Level" outline-forward-same-level t]
27181 ["Previous Same Level" outline-backward-same-level t]
27182 "--"
27183 ["Jump" org-goto t])
27184 ("Edit Structure"
27185 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
27186 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
27187 "--"
27188 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
27189 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
27190 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
27191 "--"
27192 ["Promote Heading" org-metaleft (not (org-at-table-p))]
27193 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
27194 ["Demote Heading" org-metaright (not (org-at-table-p))]
27195 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
27196 "--"
27197 ["Sort Region/Children" org-sort (not (org-at-table-p))]
27198 "--"
27199 ["Convert to odd levels" org-convert-to-odd-levels t]
27200 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
27201 ("Editing"
27202 ["Emphasis..." org-emphasize t])
27203 ("Archive"
27204 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
27205 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
27206 ; :active t :keys "C-u C-c C-x C-a"]
27207 ["Sparse trees open ARCHIVE trees"
27208 (setq org-sparse-tree-open-archived-trees
27209 (not org-sparse-tree-open-archived-trees))
27210 :style toggle :selected org-sparse-tree-open-archived-trees]
27211 ["Cycling opens ARCHIVE trees"
27212 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
27213 :style toggle :selected org-cycle-open-archived-trees]
27214 ["Agenda includes ARCHIVE trees"
27215 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
27216 :style toggle :selected (not org-agenda-skip-archived-trees)]
27217 "--"
27218 ["Move Subtree to Archive" org-advertized-archive-subtree t]
27219 ; ["Check and Move Children" (org-archive-subtree '(4))
27220 ; :active t :keys "C-u C-c C-x C-s"]
27221 )
27222 "--"
27223 ("TODO Lists"
27224 ["TODO/DONE/-" org-todo t]
27225 ("Select keyword"
27226 ["Next keyword" org-shiftright (org-on-heading-p)]
27227 ["Previous keyword" org-shiftleft (org-on-heading-p)]
27228 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
27229 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
27230 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
27231 ["Show TODO Tree" org-show-todo-tree t]
27232 ["Global TODO list" org-todo-list t]
27233 "--"
27234 ["Set Priority" org-priority t]
27235 ["Priority Up" org-shiftup t]
27236 ["Priority Down" org-shiftdown t])
27237 ("TAGS and Properties"
27238 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
27239 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
27240 "--"
27241 ["Set property" 'org-set-property t]
27242 ["Column view of properties" org-columns t]
27243 ["Insert Column View DBlock" org-insert-columns-dblock t])
27244 ("Dates and Scheduling"
27245 ["Timestamp" org-time-stamp t]
27246 ["Timestamp (inactive)" org-time-stamp-inactive t]
27247 ("Change Date"
27248 ["1 Day Later" org-shiftright t]
27249 ["1 Day Earlier" org-shiftleft t]
27250 ["1 ... Later" org-shiftup t]
27251 ["1 ... Earlier" org-shiftdown t])
27252 ["Compute Time Range" org-evaluate-time-range t]
27253 ["Schedule Item" org-schedule t]
27254 ["Deadline" org-deadline t]
27255 "--"
27256 ["Custom time format" org-toggle-time-stamp-overlays
27257 :style radio :selected org-display-custom-times]
27258 "--"
27259 ["Goto Calendar" org-goto-calendar t]
27260 ["Date from Calendar" org-date-from-calendar t])
27261 ("Logging work"
27262 ["Clock in" org-clock-in t]
27263 ["Clock out" org-clock-out t]
27264 ["Clock cancel" org-clock-cancel t]
27265 ["Goto running clock" org-clock-goto t]
27266 ["Display times" org-clock-display t]
27267 ["Create clock table" org-clock-report t]
27268 "--"
27269 ["Record DONE time"
27270 (progn (setq org-log-done (not org-log-done))
27271 (message "Switching to %s will %s record a timestamp"
27272 (car org-done-keywords)
27273 (if org-log-done "automatically" "not")))
27274 :style toggle :selected org-log-done])
27275 "--"
27276 ["Agenda Command..." org-agenda t]
27277 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
27278 ("File List for Agenda")
27279 ("Special views current file"
27280 ["TODO Tree" org-show-todo-tree t]
27281 ["Check Deadlines" org-check-deadlines t]
27282 ["Timeline" org-timeline t]
27283 ["Tags Tree" org-tags-sparse-tree t])
27284 "--"
27285 ("Hyperlinks"
27286 ["Store Link (Global)" org-store-link t]
27287 ["Insert Link" org-insert-link t]
27288 ["Follow Link" org-open-at-point t]
27289 "--"
27290 ["Next link" org-next-link t]
27291 ["Previous link" org-previous-link t]
27292 "--"
27293 ["Descriptive Links"
27294 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
27295 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
27296 ["Literal Links"
27297 (progn
27298 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
27299 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
27300 "--"
27301 ["Export/Publish..." org-export t]
27302 ("LaTeX"
27303 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
27304 :selected org-cdlatex-mode]
27305 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
27306 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
27307 ["Modify math symbol" org-cdlatex-math-modify
27308 (org-inside-LaTeX-fragment-p)]
27309 ["Export LaTeX fragments as images"
27310 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
27311 :style toggle :selected org-export-with-LaTeX-fragments])
27312 "--"
27313 ("Documentation"
27314 ["Show Version" org-version t]
27315 ["Info Documentation" org-info t])
27316 ("Customize"
27317 ["Browse Org Group" org-customize t]
27318 "--"
27319 ["Expand This Menu" org-create-customize-menu
27320 (fboundp 'customize-menu-create)])
27321 "--"
27322 ["Refresh setup" org-mode-restart t]
27323 ))
27325 (defun org-info (&optional node)
27326 "Read documentation for Org-mode in the info system.
27327 With optional NODE, go directly to that node."
27328 (interactive)
27329 (require 'info)
27330 (Info-goto-node (format "(org)%s" (or node ""))))
27332 (defun org-install-agenda-files-menu ()
27333 (let ((bl (buffer-list)))
27334 (save-excursion
27335 (while bl
27336 (set-buffer (pop bl))
27337 (if (org-mode-p) (setq bl nil)))
27338 (when (org-mode-p)
27339 (easy-menu-change
27340 '("Org") "File List for Agenda"
27341 (append
27342 (list
27343 ["Edit File List" (org-edit-agenda-file-list) t]
27344 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
27345 ["Remove Current File from List" org-remove-file t]
27346 ["Cycle through agenda files" org-cycle-agenda-files t]
27347 ["Occur in all agenda files" org-occur-in-agenda-files t]
27348 "--")
27349 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
27351 ;;;; Documentation
27353 (defun org-customize ()
27354 "Call the customize function with org as argument."
27355 (interactive)
27356 (customize-browse 'org))
27358 (defun org-create-customize-menu ()
27359 "Create a full customization menu for Org-mode, insert it into the menu."
27360 (interactive)
27361 (if (fboundp 'customize-menu-create)
27362 (progn
27363 (easy-menu-change
27364 '("Org") "Customize"
27365 `(["Browse Org group" org-customize t]
27366 "--"
27367 ,(customize-menu-create 'org)
27368 ["Set" Custom-set t]
27369 ["Save" Custom-save t]
27370 ["Reset to Current" Custom-reset-current t]
27371 ["Reset to Saved" Custom-reset-saved t]
27372 ["Reset to Standard Settings" Custom-reset-standard t]))
27374 (error "Cannot expand menu (outdated version of cus-edit.el)")))
27376 ;;;; Miscellaneous stuff
27379 ;;; Generally useful functions
27381 (defun org-context ()
27382 "Return a list of contexts of the current cursor position.
27383 If several contexts apply, all are returned.
27384 Each context entry is a list with a symbol naming the context, and
27385 two positions indicating start and end of the context. Possible
27386 contexts are:
27388 :headline anywhere in a headline
27389 :headline-stars on the leading stars in a headline
27390 :todo-keyword on a TODO keyword (including DONE) in a headline
27391 :tags on the TAGS in a headline
27392 :priority on the priority cookie in a headline
27393 :item on the first line of a plain list item
27394 :item-bullet on the bullet/number of a plain list item
27395 :checkbox on the checkbox in a plain list item
27396 :table in an org-mode table
27397 :table-special on a special filed in a table
27398 :table-table in a table.el table
27399 :link on a hyperlink
27400 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
27401 :target on a <<target>>
27402 :radio-target on a <<<radio-target>>>
27403 :latex-fragment on a LaTeX fragment
27404 :latex-preview on a LaTeX fragment with overlayed preview image
27406 This function expects the position to be visible because it uses font-lock
27407 faces as a help to recognize the following contexts: :table-special, :link,
27408 and :keyword."
27409 (let* ((f (get-text-property (point) 'face))
27410 (faces (if (listp f) f (list f)))
27411 (p (point)) clist o)
27412 ;; First the large context
27413 (cond
27414 ((org-on-heading-p t)
27415 (push (list :headline (point-at-bol) (point-at-eol)) clist)
27416 (when (progn
27417 (beginning-of-line 1)
27418 (looking-at org-todo-line-tags-regexp))
27419 (push (org-point-in-group p 1 :headline-stars) clist)
27420 (push (org-point-in-group p 2 :todo-keyword) clist)
27421 (push (org-point-in-group p 4 :tags) clist))
27422 (goto-char p)
27425 (push (org-point-in-group p 0 :priority) clist)))
27427 ((org-at-item-p)
27428 (push (org-point-in-group p 2 :item-bullet) clist)
27429 (push (list :item (point-at-bol)
27430 (save-excursion (org-end-of-item) (point)))
27431 clist)
27432 (and (org-at-item-checkbox-p)
27433 (push (org-point-in-group p 0 :checkbox) clist)))
27435 ((org-at-table-p)
27436 (push (list :table (org-table-begin) (org-table-end)) clist)
27437 (if (memq 'org-formula faces)
27438 (push (list :table-special
27439 (previous-single-property-change p 'face)
27440 (next-single-property-change p 'face)) clist)))
27441 ((org-at-table-p 'any)
27442 (push (list :table-table) clist)))
27443 (goto-char p)
27445 ;; Now the small context
27446 (cond
27447 ((org-at-timestamp-p)
27448 (push (org-point-in-group p 0 :timestamp) clist))
27449 ((memq 'org-link faces)
27450 (push (list :link
27451 (previous-single-property-change p 'face)
27452 (next-single-property-change p 'face)) clist))
27453 ((memq 'org-special-keyword faces)
27454 (push (list :keyword
27455 (previous-single-property-change p 'face)
27456 (next-single-property-change p 'face)) clist))
27457 ((org-on-target-p)
27458 (push (org-point-in-group p 0 :target) clist)
27459 (goto-char (1- (match-beginning 0)))
27460 (if (looking-at org-radio-target-regexp)
27461 (push (org-point-in-group p 0 :radio-target) clist))
27462 (goto-char p))
27463 ((setq o (car (delq nil
27464 (mapcar
27465 (lambda (x)
27466 (if (memq x org-latex-fragment-image-overlays) x))
27467 (org-overlays-at (point))))))
27468 (push (list :latex-fragment
27469 (org-overlay-start o) (org-overlay-end o)) clist)
27470 (push (list :latex-preview
27471 (org-overlay-start o) (org-overlay-end o)) clist))
27472 ((org-inside-LaTeX-fragment-p)
27473 ;; FIXME: positions wrong.
27474 (push (list :latex-fragment (point) (point)) clist)))
27476 (setq clist (nreverse (delq nil clist)))
27477 clist))
27479 ;; FIXME: Compare with at-regexp-p Do we need both?
27480 (defun org-in-regexp (re &optional nlines visually)
27481 "Check if point is inside a match of regexp.
27482 Normally only the current line is checked, but you can include NLINES extra
27483 lines both before and after point into the search.
27484 If VISUALLY is set, require that the cursor is not after the match but
27485 really on, so that the block visually is on the match."
27486 (catch 'exit
27487 (let ((pos (point))
27488 (eol (point-at-eol (+ 1 (or nlines 0))))
27489 (inc (if visually 1 0)))
27490 (save-excursion
27491 (beginning-of-line (- 1 (or nlines 0)))
27492 (while (re-search-forward re eol t)
27493 (if (and (<= (match-beginning 0) pos)
27494 (>= (+ inc (match-end 0)) pos))
27495 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
27497 (defun org-at-regexp-p (regexp)
27498 "Is point inside a match of REGEXP in the current line?"
27499 (catch 'exit
27500 (save-excursion
27501 (let ((pos (point)) (end (point-at-eol)))
27502 (beginning-of-line 1)
27503 (while (re-search-forward regexp end t)
27504 (if (and (<= (match-beginning 0) pos)
27505 (>= (match-end 0) pos))
27506 (throw 'exit t)))
27507 nil))))
27509 (defun org-occur-in-agenda-files (regexp &optional nlines)
27510 "Call `multi-occur' with buffers for all agenda files."
27512 (let* ((files (org-agenda-files))
27513 (tnames (mapcar 'file-truename files))
27514 (extra org-agenda-multi-occur-extra-files)
27515 f)
27516 (while (setq f (pop extra))
27517 (unless (member (file-truename f) tnames)
27518 (add-to-list 'files f 'append)
27519 (add-to-list 'tnames (file-truename f) 'append)))
27520 (multi-occur
27521 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
27522 regexp)))
27524 (if (boundp 'occur-mode-find-occurrence-hook)
27525 ;; Emacs 23
27526 (add-hook 'occur-mode-find-occurrence-hook
27527 (lambda ()
27528 (when (org-mode-p)
27529 (org-reveal))))
27530 ;; Emacs 22
27531 (defadvice occur-mode-goto-occurrence
27532 (after org-occur-reveal activate)
27533 (and (org-mode-p) (org-reveal)))
27534 (defadvice occur-mode-goto-occurrence-other-window
27535 (after org-occur-reveal activate)
27536 (and (org-mode-p) (org-reveal)))
27537 (defadvice occur-mode-display-occurrence
27538 (after org-occur-reveal activate)
27539 (when (org-mode-p)
27540 (let ((pos (occur-mode-find-occurrence)))
27541 (with-current-buffer (marker-buffer pos)
27542 (save-excursion
27543 (goto-char pos)
27544 (org-reveal)))))))
27546 (defun org-uniquify (list)
27547 "Remove duplicate elements from LIST."
27548 (let (res)
27549 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
27550 res))
27552 (defun org-delete-all (elts list)
27553 "Remove all elements in ELTS from LIST."
27554 (while elts
27555 (setq list (delete (pop elts) list)))
27556 list)
27558 (defun org-back-over-empty-lines ()
27559 "Move backwards over witespace, to the beginning of the first empty line.
27560 Returns the number o empty lines passed."
27561 (let ((pos (point)))
27563 (beginning-of-line 2)
27564 (goto-char (min (point) pos))
27565 (count-lines (point) pos)))
27567 (defun org-skip-whitespace ()
27570 (defun org-point-in-group (point group &optional context)
27571 "Check if POINT is in match-group GROUP.
27572 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
27573 match. If the match group does ot exist or point is not inside it,
27574 return nil."
27575 (and (match-beginning group)
27576 (>= point (match-beginning group))
27577 (<= point (match-end group))
27578 (if context
27579 (list context (match-beginning group) (match-end group))
27580 t)))
27582 (defun org-switch-to-buffer-other-window (&rest args)
27583 "Switch to buffer in a second window on the current frame.
27584 In particular, do not allow pop-up frames."
27585 (let (pop-up-frames special-display-buffer-names special-display-regexps
27586 special-display-function)
27587 (apply 'switch-to-buffer-other-window args)))
27589 (defun org-combine-plists (&rest plists)
27590 "Create a single property list from all plists in PLISTS.
27591 The process starts by copying the first list, and then setting properties
27592 from the other lists. Settings in the last list are the most significant
27593 ones and overrule settings in the other lists."
27594 (let ((rtn (copy-sequence (pop plists)))
27595 p v ls)
27596 (while plists
27597 (setq ls (pop plists))
27598 (while ls
27599 (setq p (pop ls) v (pop ls))
27600 (setq rtn (plist-put rtn p v))))
27601 rtn))
27603 (defun org-move-line-down (arg)
27604 "Move the current line down. With prefix argument, move it past ARG lines."
27605 (interactive "p")
27606 (let ((col (current-column))
27607 beg end pos)
27608 (beginning-of-line 1) (setq beg (point))
27609 (beginning-of-line 2) (setq end (point))
27610 (beginning-of-line (+ 1 arg))
27611 (setq pos (move-marker (make-marker) (point)))
27612 (insert (delete-and-extract-region beg end))
27613 (goto-char pos)
27614 (move-to-column col)))
27616 (defun org-move-line-up (arg)
27617 "Move the current line up. With prefix argument, move it past ARG lines."
27618 (interactive "p")
27619 (let ((col (current-column))
27620 beg end pos)
27621 (beginning-of-line 1) (setq beg (point))
27622 (beginning-of-line 2) (setq end (point))
27623 (beginning-of-line (- arg))
27624 (setq pos (move-marker (make-marker) (point)))
27625 (insert (delete-and-extract-region beg end))
27626 (goto-char pos)
27627 (move-to-column col)))
27629 (defun org-replace-escapes (string table)
27630 "Replace %-escapes in STRING with values in TABLE.
27632 The sequences in STRING may contain normal field width and padding information,
27634 so values can contain further %-escapes if they are define later in TABLE."
27635 (let ((case-fold-search nil)
27636 e re rpl)
27637 (while (setq e (pop table))
27638 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
27639 (while (string-match re string)
27640 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
27641 (cdr e)))
27642 (setq string (replace-match rpl t t string))))
27643 string))
27646 (defun org-sublist (list start end)
27647 "Return a section of LIST, from START to END.
27648 Counting starts at 1."
27649 (let (rtn (c start))
27650 (setq list (nthcdr (1- start) list))
27651 (while (and list (<= c end))
27652 (push (pop list) rtn)
27653 (setq c (1+ c)))
27654 (nreverse rtn)))
27656 (defun org-find-base-buffer-visiting (file)
27657 "Like `find-buffer-visiting' but alway return the base buffer and
27658 not an indirect buffer"
27659 (let ((buf (find-buffer-visiting file)))
27660 (if buf
27661 (or (buffer-base-buffer buf) buf)
27662 nil)))
27664 (defun org-image-file-name-regexp ()
27665 "Return regexp matching the file names of images."
27666 (if (fboundp 'image-file-name-regexp)
27667 (image-file-name-regexp)
27668 (let ((image-file-name-extensions
27669 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
27670 "xbm" "xpm" "pbm" "pgm" "ppm")))
27672 (regexp-opt (nconc (mapcar 'upcase
27673 image-file-name-extensions)
27674 image-file-name-extensions)
27675 t)
27678 (defun org-file-image-p (file)
27679 "Return non-nil if FILE is an image."
27680 (save-match-data
27681 (string-match (org-image-file-name-regexp) file)))
27683 ;;; Paragraph filling stuff.
27684 ;; We want this to be just right, so use the full arsenal.
27686 (defun org-indent-line-function ()
27687 "Indent line like previous, but further if previous was headline or item."
27688 (interactive)
27689 (let* ((pos (point))
27690 (itemp (org-at-item-p))
27691 column bpos bcol tpos tcol bullet btype bullet-type)
27692 ;; Find the previous relevant line
27693 (beginning-of-line 1)
27694 (cond
27695 ((looking-at "#") (setq column 0))
27697 (t
27698 (beginning-of-line 0)
27700 (beginning-of-line 0))
27701 (cond
27703 (goto-char (match-end 0))
27704 (setq column (current-column)))
27705 ((org-in-item-p)
27706 (org-beginning-of-item)
27709 (setq bpos (match-beginning 1) tpos (match-end 0)
27710 bcol (progn (goto-char bpos) (current-column))
27711 tcol (progn (goto-char tpos) (current-column))
27712 bullet (match-string 1)
27713 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
27714 (if (not itemp)
27715 (setq column tcol)
27716 (goto-char pos)
27717 (beginning-of-line 1)
27719 (progn
27721 (setq bullet (match-string 1)
27722 btype (if (string-match "[0-9]" bullet) "n" bullet))
27723 (setq column (if (equal btype bullet-type) bcol tcol)))
27724 (setq column (org-get-indentation)))))
27725 (t (setq column (org-get-indentation))))))
27726 (goto-char pos)
27727 (if (<= (current-column) (current-indentation))
27728 (indent-line-to column)
27729 (save-excursion (indent-line-to column)))
27730 (setq column (current-column))
27731 (beginning-of-line 1)
27732 (if (looking-at
27735 (match-string 2) (match-string 3)))
27736 t nil))
27737 (move-to-column column)))
27739 (defun org-set-autofill-regexps ()
27740 (interactive)
27741 ;; In the paragraph separator we include headlines, because filling
27742 ;; text in a line directly attached to a headline would otherwise
27743 ;; fill the headline as well.
27746 ;; The paragraph starter includes hand-formatted lists.
27747 (org-set-local 'paragraph-start
27749 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
27750 ;; But only if the user has not turned off tables or fixed-width regions
27751 (org-set-local
27752 'auto-fill-inhibit-regexp
27755 (if (or org-enable-table-editor org-enable-fixed-width-editor)
27756 (concat
27758 (if org-enable-table-editor "|" "")
27759 (if org-enable-fixed-width-editor ":" "")
27760 "]"))))
27761 ;; We use our own fill-paragraph function, to make sure that tables
27762 ;; and fixed-width regions are not wrapped. That function will pass
27763 ;; through to `fill-paragraph' when appropriate.
27764 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
27765 ; Adaptive filling: To get full control, first make sure that
27766 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
27768 (org-set-local 'adaptive-fill-function
27769 'org-adaptive-fill-function)
27770 (org-set-local
27771 'align-mode-rules-list
27772 '((org-in-buffer-settings
27774 (modes . '(org-mode))))))
27776 (defun org-fill-paragraph (&optional justify)
27777 "Re-align a table, pass through to fill-paragraph if no table."
27778 (let ((table-p (org-at-table-p))
27779 (table.el-p (org-at-table.el-p)))
27780 (cond ((and (equal (char-after (point-at-bol)) ?*)
27781 (save-excursion (goto-char (point-at-bol))
27782 (looking-at outline-regexp)))
27783 t) ; skip headlines
27784 (table.el-p t) ; skip table.el tables
27785 (table-p (org-table-align) t) ; align org-mode tables
27786 (t nil)))) ; call paragraph-fill
27788 ;; For reference, this is the default value of adaptive-fill-regexp
27791 (defun org-adaptive-fill-function ()
27792 "Return a fill prefix for org-mode files.
27793 In particular, this makes sure hanging paragraphs for hand-formatted lists
27794 work correctly."
27796 (match-string 0))
27798 (save-excursion
27799 (goto-char (match-end 0))
27800 (make-string (current-column) ?\ )))
27801 (t nil)))
27803 ;;;; Functions extending outline functionality
27806 (defun org-beginning-of-line (&optional arg)
27807 "Go to the beginning of the current line. If that is invisible, continue
27808 to a visible line beginning. This makes the function of C-a more intuitive.
27809 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27810 first attempt, and only move to after the tags when the cursor is already
27811 beyond the end of the headline."
27812 (interactive "P")
27813 (let ((pos (point)))
27814 (beginning-of-line 1)
27815 (if (bobp)
27816 nil
27817 (backward-char 1)
27818 (if (org-invisible-p)
27819 (while (and (not (bobp)) (org-invisible-p))
27820 (backward-char 1)
27821 (beginning-of-line 1))
27822 (forward-char 1)))
27823 (when org-special-ctrl-a/e
27824 (cond
27825 ((and (looking-at org-todo-line-regexp)
27826 (= (char-after (match-end 1)) ?\ ))
27827 (goto-char
27828 (if (eq org-special-ctrl-a/e t)
27829 (cond ((> pos (match-beginning 3)) (match-beginning 3))
27830 ((= pos (point)) (match-beginning 3))
27831 (t (point)))
27832 (cond ((> pos (point)) (point))
27833 ((not (eq last-command this-command)) (point))
27834 (t (match-beginning 3))))))
27835 ((org-at-item-p)
27836 (goto-char
27837 (if (eq org-special-ctrl-a/e t)
27838 (cond ((> pos (match-end 4)) (match-end 4))
27839 ((= pos (point)) (match-end 4))
27840 (t (point)))
27841 (cond ((> pos (point)) (point))
27842 ((not (eq last-command this-command)) (point))
27843 (t (match-end 4))))))))))
27845 (defun org-end-of-line (&optional arg)
27846 "Go to the end of the line.
27847 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
27848 first attempt, and only move to after the tags when the cursor is already
27849 beyond the end of the headline."
27850 (interactive "P")
27851 (if (or (not org-special-ctrl-a/e)
27852 (not (org-on-heading-p)))
27853 (end-of-line arg)
27854 (let ((pos (point)))
27855 (beginning-of-line 1)
27857 (if (eq org-special-ctrl-a/e t)
27858 (if (or (< pos (match-beginning 1))
27859 (= pos (match-end 0)))
27860 (goto-char (match-beginning 1))
27861 (goto-char (match-end 0)))
27862 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
27863 (goto-char (match-end 0))
27864 (goto-char (match-beginning 1))))
27865 (end-of-line arg)))))
27867 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
27868 (define-key org-mode-map "\C-e" 'org-end-of-line)
27870 (defun org-kill-line (&optional arg)
27871 "Kill line, to tags or end of line."
27872 (interactive "P")
27873 (cond
27874 ((or (not org-special-ctrl-k)
27875 (bolp)
27876 (not (org-on-heading-p)))
27877 (call-interactively 'kill-line))
27879 (kill-region (point) (match-beginning 1))
27880 (org-set-tags nil t))
27881 (t (kill-region (point) (point-at-eol)))))
27883 (define-key org-mode-map "\C-k" 'org-kill-line)
27885 (defun org-invisible-p ()
27886 "Check if point is at a character currently not visible."
27887 ;; Early versions of noutline don't have `outline-invisible-p'.
27888 (if (fboundp 'outline-invisible-p)
27889 (outline-invisible-p)
27890 (get-char-property (point) 'invisible)))
27892 (defun org-invisible-p2 ()
27893 "Check if point is at a character currently not visible."
27894 (save-excursion
27895 (if (and (eolp) (not (bobp))) (backward-char 1))
27896 ;; Early versions of noutline don't have `outline-invisible-p'.
27897 (if (fboundp 'outline-invisible-p)
27898 (outline-invisible-p)
27899 (get-char-property (point) 'invisible))))
27901 (defalias 'org-back-to-heading 'outline-back-to-heading)
27902 (defalias 'org-on-heading-p 'outline-on-heading-p)
27903 (defalias 'org-at-heading-p 'outline-on-heading-p)
27904 (defun org-at-heading-or-item-p ()
27905 (or (org-on-heading-p) (org-at-item-p)))
27907 (defun org-on-target-p ()
27908 (or (org-in-regexp org-radio-target-regexp)
27909 (org-in-regexp org-target-regexp)))
27911 (defun org-up-heading-all (arg)
27912 "Move to the heading line of which the present line is a subheading.
27913 This function considers both visible and invisible heading lines.
27914 With argument, move up ARG levels."
27915 (if (fboundp 'outline-up-heading-all)
27916 (outline-up-heading-all arg) ; emacs 21 version of outline.el
27917 (outline-up-heading arg t))) ; emacs 22 version of outline.el
27919 (defun org-up-heading-safe ()
27920 "Move to the heading line of which the present line is a subheading.
27921 This version will not throw an error. It will return the level of the
27922 headline found, or nil if no higher level is found."
27923 (let ((pos (point)) start-level level
27924 (re (concat "^" outline-regexp)))
27925 (catch 'exit
27926 (outline-back-to-heading t)
27927 (setq start-level (funcall outline-level))
27928 (if (equal start-level 1) (throw 'exit nil))
27929 (while (re-search-backward re nil t)
27930 (setq level (funcall outline-level))
27931 (if (< level start-level) (throw 'exit level)))
27932 nil)))
27934 (defun org-first-sibling-p ()
27935 "Is this heading the first child of its parents?"
27936 (interactive)
27937 (let ((re (concat "^" outline-regexp))
27938 level l)
27939 (unless (org-at-heading-p t)
27940 (error "Not at a heading"))
27941 (setq level (funcall outline-level))
27942 (save-excursion
27943 (if (not (re-search-backward re nil t))
27944 t
27945 (setq l (funcall outline-level))
27946 (< l level)))))
27948 (defun org-goto-sibling (&optional previous)
27949 "Goto the next sibling, even if it is invisible.
27950 When PREVIOUS is set, go to the previous sibling instead. Returns t
27951 when a sibling was found. When none is found, return nil and don't
27952 move point."
27953 (let ((fun (if previous 're-search-backward 're-search-forward))
27954 (pos (point))
27955 (re (concat "^" outline-regexp))
27956 level l)
27957 (when (condition-case nil (org-back-to-heading t) (error nil))
27958 (setq level (funcall outline-level))
27959 (catch 'exit
27960 (or previous (forward-char 1))
27961 (while (funcall fun re nil t)
27962 (setq l (funcall outline-level))
27963 (when (< l level) (goto-char pos) (throw 'exit nil))
27964 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
27965 (goto-char pos)
27966 nil))))
27968 (defun org-show-siblings ()
27969 "Show all siblings of the current headline."
27970 (save-excursion
27971 (while (org-goto-sibling) (org-flag-heading nil)))
27972 (save-excursion
27973 (while (org-goto-sibling 'previous)
27974 (org-flag-heading nil))))
27976 (defun org-show-hidden-entry ()
27977 "Show an entry where even the heading is hidden."
27978 (save-excursion
27979 (org-show-entry)))
27981 (defun org-flag-heading (flag &optional entry)
27982 "Flag the current heading. FLAG non-nil means make invisible.
27983 When ENTRY is non-nil, show the entire entry."
27984 (save-excursion
27985 (org-back-to-heading t)
27986 ;; Check if we should show the entire entry
27987 (if entry
27988 (progn
27989 (org-show-entry)
27990 (save-excursion
27991 (and (outline-next-heading)
27992 (org-flag-heading nil))))
27993 (outline-flag-region (max (point-min) (1- (point)))
27994 (save-excursion (outline-end-of-heading) (point))
27995 flag))))
27997 (defun org-end-of-subtree (&optional invisible-OK to-heading)
27998 ;; This is an exact copy of the original function, but it uses
27999 ;; `org-back-to-heading', to make it work also in invisible
28000 ;; trees. And is uses an invisible-OK argument.
28001 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
28002 (org-back-to-heading invisible-OK)
28003 (let ((first t)
28004 (level (funcall outline-level)))
28005 (while (and (not (eobp))
28006 (or first (> (funcall outline-level) level)))
28007 (setq first nil)
28008 (outline-next-heading))
28009 (unless to-heading
28011 (progn
28012 ;; Go to end of line before heading
28013 (forward-char -1)
28015 ;; leave blank line before heading
28016 (forward-char -1))))))
28017 (point))
28019 (defun org-show-subtree ()
28020 "Show everything after this heading at deeper levels."
28021 (outline-flag-region
28022 (point)
28023 (save-excursion
28024 (outline-end-of-subtree) (outline-next-heading) (point))
28025 nil))
28027 (defun org-show-entry ()
28028 "Show the body directly following this heading.
28029 Show the heading too, if it is currently invisible."
28030 (interactive)
28031 (save-excursion
28032 (condition-case nil
28033 (progn
28034 (org-back-to-heading t)
28035 (outline-flag-region
28036 (max (point-min) (1- (point)))
28037 (save-excursion
28038 (re-search-forward
28040 (or (match-beginning 1) (point-max)))
28041 nil))
28042 (error nil))))
28044 (defun org-make-options-regexp (kwds)
28045 "Make a regular expression for keyword lines."
28046 (concat
28047 "^"
28053 ;; Make isearch reveal the necessary context
28054 (defun org-isearch-end ()
28055 "Reveal context after isearch exits."
28056 (when isearch-success ; only if search was successful
28057 (if (featurep 'xemacs)
28058 ;; Under XEmacs, the hook is run in the correct place,
28059 ;; we directly show the context.
28060 (org-show-context 'isearch)
28061 ;; In Emacs the hook runs *before* restoring the overlays.
28062 ;; So we have to use a one-time post-command-hook to do this.
28063 ;; (Emacs 22 has a special variable, see function `org-mode')
28064 (unless (and (boundp 'isearch-mode-end-hook-quit)
28065 isearch-mode-end-hook-quit)
28066 ;; Only when the isearch was not quitted.
28067 (org-add-hook 'post-command-hook 'org-isearch-post-command
28068 'append 'local)))))
28070 (defun org-isearch-post-command ()
28071 "Remove self from hook, and show context."
28072 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
28073 (org-show-context 'isearch))
28076 ;;;; Integration with and fixes for other packages
28078 ;;; Imenu support
28080 (defvar org-imenu-markers nil
28081 "All markers currently used by Imenu.")
28082 (make-variable-buffer-local 'org-imenu-markers)
28084 (defun org-imenu-new-marker (&optional pos)
28085 "Return a new marker for use by Imenu, and remember the marker."
28086 (let ((m (make-marker)))
28087 (move-marker m (or pos (point)))
28088 (push m org-imenu-markers)
28089 m))
28091 (defun org-imenu-get-tree ()
28092 "Produce the index for Imenu."
28093 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
28094 (setq org-imenu-markers nil)
28095 (let* ((n org-imenu-depth)
28096 (re (concat "^" outline-regexp))
28097 (subs (make-vector (1+ n) nil))
28098 (last-level 0)
28099 m tree level head)
28100 (save-excursion
28101 (save-restriction
28102 (widen)
28103 (goto-char (point-max))
28104 (while (re-search-backward re nil t)
28105 (setq level (org-reduced-level (funcall outline-level)))
28106 (when (<= level n)
28107 (looking-at org-complex-heading-regexp)
28108 (setq head (org-match-string-no-properties 4)
28109 m (org-imenu-new-marker))
28110 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
28111 (if (>= level last-level)
28112 (push (cons head m) (aref subs level))
28113 (push (cons head (aref subs (1+ level))) (aref subs level))
28114 (loop for i from (1+ level) to n do (aset subs i nil)))
28115 (setq last-level level)))))
28116 (aref subs 1)))
28118 (eval-after-load "imenu"
28119 '(progn
28120 (add-hook 'imenu-after-jump-hook
28121 (lambda () (org-show-context 'org-goto)))))
28123 ;; Speedbar support
28125 (defun org-speedbar-set-agenda-restriction ()
28126 "Restrict future agenda commands to the location at point in speedbar.
28128 (interactive)
28129 (let (p m tp np dir txt w)
28130 (cond
28131 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28132 'org-imenu t))
28133 (setq m (get-text-property p 'org-imenu-marker))
28134 (save-excursion
28135 (save-restriction
28136 (set-buffer (marker-buffer m))
28137 (goto-char m)
28138 (org-agenda-set-restriction-lock 'subtree))))
28139 ((setq p (text-property-any (point-at-bol) (point-at-eol)
28140 'speedbar-function 'speedbar-find-file))
28141 (setq tp (previous-single-property-change
28142 (1+ p) 'speedbar-function)
28143 np (next-single-property-change
28144 tp 'speedbar-function)
28145 dir (speedbar-line-directory)
28146 txt (buffer-substring-no-properties (or tp (point-min))
28147 (or np (point-max))))
28148 (save-excursion
28149 (save-restriction
28150 (set-buffer (find-file-noselect
28151 (let ((default-directory dir))
28152 (expand-file-name txt))))
28153 (unless (org-mode-p)
28154 (error "Cannot restrict to non-Org-mode file"))
28155 (org-agenda-set-restriction-lock 'file))))
28156 (t (error "Don't know how to restrict Org-mode's agenda")))
28157 (org-move-overlay org-speedbar-restriction-lock-overlay
28158 (point-at-bol) (point-at-eol))
28159 (setq current-prefix-arg nil)
28160 (org-agenda-maybe-redo)))
28162 (eval-after-load "speedbar"
28163 '(progn
28164 (speedbar-add-supported-extension ".org")
28165 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
28166 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
28167 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
28168 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
28169 (add-hook 'speedbar-visiting-tag-hook
28170 (lambda () (org-show-context 'org-goto)))))
28173 ;;; Fixes and Hacks
28175 ;; Make flyspell not check words in links, to not mess up our keymap
28176 (defun org-mode-flyspell-verify ()
28177 "Don't let flyspell put overlays at active buttons."
28178 (not (get-text-property (point) 'keymap)))
28180 ;; Make `bookmark-jump' show the jump location if it was hidden.
28181 (eval-after-load "bookmark"
28182 '(if (boundp 'bookmark-after-jump-hook)
28183 ;; We can use the hook
28184 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
28185 ;; Hook not available, use advice
28186 (defadvice bookmark-jump (after org-make-visible activate)
28187 "Make the position visible."
28188 (org-bookmark-jump-unhide))))
28190 (defun org-bookmark-jump-unhide ()
28191 "Unhide the current position, to show the bookmark location."
28192 (and (org-mode-p)
28193 (or (org-invisible-p)
28194 (save-excursion (goto-char (max (point-min) (1- (point))))
28195 (org-invisible-p)))
28196 (org-show-context 'bookmark-jump)))
28198 ;; Fix a bug in htmlize where there are text properties (face nil)
28199 (eval-after-load "htmlize"
28200 '(progn
28201 (defadvice htmlize-faces-in-buffer (after org-no-nil-faces activate)
28202 "Make sure there are no nil faces"
28203 (setq ad-return-value (delq nil ad-return-value)))))
28205 ;; Make session.el ignore our circular variable
28206 (eval-after-load "session"
28207 '(add-to-list 'session-globals-exclude 'org-mark-ring))
28209 ;;;; Experimental code
28211 (defun org-closed-in-range ()
28212 "Sparse tree of items closed in a certain time range.
28213 Still experimental, may disappear in the future."
28214 (interactive)
28215 ;; Get the time interval from the user.
28216 (let* ((time1 (time-to-seconds
28217 (org-read-date nil 'to-time nil "Starting date: ")))
28218 (time2 (time-to-seconds
28219 (org-read-date nil 'to-time nil "End date:")))
28220 ;; callback function
28221 (callback (lambda ()
28222 (let ((time
28223 (time-to-seconds
28224 (apply 'encode-time
28225 (org-parse-time-string
28226 (match-string 1))))))
28227 ;; check if time in interval
28228 (and (>= time time1) (<= time time2))))))
28229 ;; make tree, check each match with the callback
28232 ;;;; Finish up
28234 (provide 'org)
28236 (run-hooks 'org-load-hook)
28238 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
28239 ;;; org.el ends here