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, 2009 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
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 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
65 (defvar org-inhibit-highlight-removal nil
) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local
)
70 ;;;; Require other packages
76 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
77 ;; the file noutline.el being loaded.
78 (if (featurep 'xemacs
) (condition-case nil
(require 'noutline
)))
79 ;; We require noutline, which might be provided in outline.el
80 (require 'outline
) (require 'noutline
)
81 ;; Other stuff we need.
83 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
91 ;;;; Customization variables
95 (defconst org-version
"6.16"
96 "The version number of the file org.el.")
98 (defun org-version (&optional here
)
99 "Show the org-mode version in the echo area.
100 With prefix arg HERE, insert it at point."
102 (let ((version (format "Org-mode version %s" org-version
)))
107 ;;; Compatibility constants
109 ;;; The custom variables
112 "Outline-based notes management and organizer."
118 (defcustom org-load-hook nil
119 "Hook that is run after org.el has been loaded."
123 (defvar org-modules
) ; defined below
124 (defvar org-modules-loaded nil
125 "Have the modules been loaded already?")
127 (defun org-load-modules-maybe (&optional force
)
128 "Load all extensions listed in `org-modules'."
129 (when (or force
(not org-modules-loaded
))
131 (condition-case nil
(require ext
)
132 (error (message "Problems while trying to load feature `%s'" ext
))))
134 (setq org-modules-loaded t
)))
136 (defun org-set-modules (var value
)
137 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
139 (when (featurep 'org
)
140 (org-load-modules-maybe 'force
)))
142 (when (org-bound-and-true-p org-modules
)
143 (let ((a (member 'org-infojs org-modules
)))
144 (and a
(setcar a
'org-jsinfo
))))
146 (defcustom org-modules
'(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl
)
147 "Modules that should always be loaded together with org.el.
148 If a description starts with <C>, the file is not part of Emacs
149 and loading it will require that you have downloaded and properly installed
150 the org-mode distribution.
152 You can also use this system to load external packages (i.e. neither Org
153 core modules, not modules from the CONTRIB directory). Just add symbols
154 to the end of the list. If the package is called org-xyz.el, then you need
155 to add the symbol `xyz', and the package must have a call to
159 :set
'org-set-modules
162 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
163 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
164 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
165 (const :tag
" id: Global IDs for identifying entries" org-id
)
166 (const :tag
" info: Links to Info nodes" org-info
)
167 (const :tag
" jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo
)
168 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
169 (const :tag
" mac-message: Links to messages in Apple Mail" org-mac-message
)
170 (const :tag
" mew Links to Mew folders/messages" org-mew
)
171 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
172 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
173 (const :tag
" vm: Links to VM folders/messages" org-vm
)
174 (const :tag
" wl: Links to Wanderlust folders/messages" org-wl
)
175 (const :tag
" w3m: Special cut/past from w3m to Org." org-w3m
)
176 (const :tag
" mouse: Additional mouse support" org-mouse
)
178 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
179 (const :tag
"C annotation-helper: Call Remember directly from Browser" org-annotation-helper
)
180 (const :tag
"C bookmark: Org links to bookmarks" org-bookmark
)
181 (const :tag
"C browser-url: Store link, directly from Browser" org-browser-url
)
182 (const :tag
"C depend: TODO dependencies for Org-mode" org-depend
)
183 (const :tag
"C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol
)
184 (const :tag
"C eval: Include command output as text" org-eval
)
185 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
186 (const :tag
"C expiry: Expiry mechanism for Org entries" org-expiry
)
187 (const :tag
"C exp-blocks: Pre-process blocks for export" org-exp-blocks
)
188 (const :tag
"C interactive-query: Interactive modification of tags query" org-interactive-query
)
189 (const :tag
"C mairix: Hook mairix search into Org for different MUAs" org-mairix
)
190 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
191 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
192 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
193 (const :tag
"C registry: A registry for Org links" org-registry
)
194 (const :tag
"C org2rem: Convert org appointments into reminders" org2rem
)
195 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
196 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
197 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
198 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
201 (defgroup org-startup nil
202 "Options concerning startup of Org-mode."
206 (defcustom org-startup-folded t
207 "Non-nil means, entering Org-mode will switch to OVERVIEW.
208 This can also be configured on a per-file basis by adding one of
209 the following lines anywhere in the buffer:
216 (const :tag
"nofold: show all" nil
)
217 (const :tag
"fold: overview" t
)
218 (const :tag
"content: all headlines" content
)))
220 (defcustom org-startup-truncated t
221 "Non-nil means, entering Org-mode will set `truncate-lines'.
222 This is useful since some lines containing links can be very long and
223 uninteresting. Also tables look terrible when wrapped."
227 (defcustom org-startup-align-all-tables nil
228 "Non-nil means, align all tables when visiting a file.
229 This is useful when the column width in tables is forced with <N> cookies
230 in table fields. Such tables will look correct only after the first re-align.
231 This can also be configured on a per-file basis by adding one of
232 the following lines anywhere in the buffer:
238 (defcustom org-insert-mode-line-in-empty-file nil
239 "Non-nil means insert the first line setting Org-mode in empty files.
240 When the function `org-mode' is called interactively in an empty file, this
241 normally means that the file name does not automatically trigger Org-mode.
242 To ensure that the file will always be in Org-mode in the future, a
243 line enforcing Org-mode will be inserted into the buffer, if this option
248 (defcustom org-replace-disputed-keys nil
249 "Non-nil means use alternative key bindings for some keys.
250 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
251 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
252 If you want to use Org-mode together with one of these other modes,
253 or more generally if you would like to move some Org-mode commands to
254 other keys, set this variable and configure the keys with the variable
257 This option is only relevant at load-time of Org-mode, and must be set
258 *before* org.el is loaded. Changing it requires a restart of Emacs to
263 (defcustom org-use-extra-keys nil
264 "Non-nil means use extra key sequence definitions for certain
265 commands. This happens automatically if you run XEmacs or if
266 window-system is nil. This variable lets you do the same
267 manually. You must set it before loading org.
269 Example: on Carbon Emacs 22 running graphically, with an external
270 keyboard on a Powerbook, the default way of setting M-left might
271 not work for either Alt or ESC. Setting this variable will make
276 (if (fboundp 'defvaralias
)
277 (defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
))
279 (defcustom org-disputed-keys
280 '(([(shift up
)] .
[(meta p
)])
281 ([(shift down
)] .
[(meta n
)])
282 ([(shift left
)] .
[(meta -
)])
283 ([(shift right
)] .
[(meta +)])
284 ([(control shift right
)] .
[(meta shift
+)])
285 ([(control shift left
)] .
[(meta shift -
)]))
286 "Keys for which Org-mode and other modes compete.
287 This is an alist, cars are the default keys, second element specifies
288 the alternative to use when `org-replace-disputed-keys' is t.
290 Keys can be specified in any syntax supported by `define-key'.
291 The value of this option takes effect only at Org-mode's startup,
292 therefore you'll have to restart Emacs to apply it after changing."
297 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
298 Or return the original if not disputed."
299 (if org-replace-disputed-keys
300 (let* ((nkey (key-description key
))
301 (x (org-find-if (lambda (x)
302 (equal (key-description (car x
)) nkey
))
307 (defun org-find-if (predicate seq
)
310 (if (funcall predicate
(car seq
))
311 (throw 'exit
(car seq
))
314 (defun org-defkey (keymap key def
)
315 "Define a key, possibly translated, as returned by `org-key'."
316 (define-key keymap
(org-key key
) def
))
318 (defcustom org-ellipsis nil
319 "The ellipsis to use in the Org-mode outline.
320 When nil, just use the standard three dots. When a string, use that instead,
321 When a face, use the standard 3 dots, but with the specified face.
322 The change affects only Org-mode (which will then use its own display table).
323 Changing this requires executing `M-x org-mode' in a buffer to become
326 :type
'(choice (const :tag
"Default" nil
)
327 (face :tag
"Face" :value org-warning
)
328 (string :tag
"String" :value
"...#")))
330 (defvar org-display-table nil
331 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
333 (defgroup org-keywords nil
334 "Keywords in Org-mode."
338 (defcustom org-deadline-string
"DEADLINE:"
339 "String to mark deadline entries.
340 A deadline is this string, followed by a time stamp. Should be a word,
341 terminated by a colon. You can insert a schedule keyword and
342 a timestamp with \\[org-deadline].
343 Changes become only effective after restarting Emacs."
347 (defcustom org-scheduled-string
"SCHEDULED:"
348 "String to mark scheduled TODO entries.
349 A schedule is this string, followed by a time stamp. Should be a word,
350 terminated by a colon. You can insert a schedule keyword and
351 a timestamp with \\[org-schedule].
352 Changes become only effective after restarting Emacs."
356 (defcustom org-closed-string
"CLOSED:"
357 "String used as the prefix for timestamps logging closing a TODO entry."
361 (defcustom org-clock-string
"CLOCK:"
362 "String used as prefix for timestamps clocking work hours on an item."
366 (defcustom org-comment-string
"COMMENT"
367 "Entries starting with this keyword will never be exported.
368 An entry can be toggled between COMMENT and normal with
369 \\[org-toggle-comment].
370 Changes become only effective after restarting Emacs."
374 (defcustom org-quote-string
"QUOTE"
375 "Entries starting with this keyword will be exported in fixed-width font.
376 Quoting applies only to the text in the entry following the headline, and does
377 not extend beyond the next headline, even if that is lower level.
378 An entry can be toggled between QUOTE and normal with
379 \\[org-toggle-fixed-width-section]."
383 (defconst org-repeat-re
384 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*\\([.+]?\\+[0-9]+[dwmy]\\)"
385 "Regular expression for specifying repeated events.
386 After a match, group 1 contains the repeat expression.")
388 (defgroup org-structure nil
389 "Options concerning the general structure of Org-mode files."
393 (defgroup org-reveal-location nil
394 "Options about how to make context of a location visible."
395 :tag
"Org Reveal Location"
396 :group
'org-structure
)
398 (defconst org-context-choice
400 (const :tag
"Always" t
)
401 (const :tag
"Never" nil
)
402 (repeat :greedy t
:tag
"Individual contexts"
404 (choice :tag
"Context"
411 (const bookmark-jump
)
415 "Contexts for the reveal options.")
417 (defcustom org-show-hierarchy-above
'((default . t
))
418 "Non-nil means, show full hierarchy when revealing a location.
419 Org-mode often shows locations in an org-mode file which might have
420 been invisible before. When this is set, the hierarchy of headings
421 above the exposed location is shown.
422 Turning this off for example for sparse trees makes them very compact.
423 Instead of t, this can also be an alist specifying this option for different
424 contexts. Valid contexts are
425 agenda when exposing an entry from the agenda
426 org-goto when using the command `org-goto' on key C-c C-j
427 occur-tree when using the command `org-occur' on key C-c /
428 tags-tree when constructing a sparse tree based on tags matches
429 link-search when exposing search matches associated with a link
430 mark-goto when exposing the jump goal of a mark
431 bookmark-jump when exposing a bookmark location
432 isearch when exiting from an incremental search
433 default default for all contexts not set explicitly"
434 :group
'org-reveal-location
435 :type org-context-choice
)
437 (defcustom org-show-following-heading
'((default . nil
))
438 "Non-nil means, show following heading when revealing a location.
439 Org-mode often shows locations in an org-mode file which might have
440 been invisible before. When this is set, the heading following the
442 Turning this off for example for sparse trees makes them very compact,
443 but makes it harder to edit the location of the match. In such a case,
444 use the command \\[org-reveal] to show more context.
445 Instead of t, this can also be an alist specifying this option for different
446 contexts. See `org-show-hierarchy-above' for valid contexts."
447 :group
'org-reveal-location
448 :type org-context-choice
)
450 (defcustom org-show-siblings
'((default . nil
) (isearch t
))
451 "Non-nil means, show all sibling heading when revealing a location.
452 Org-mode often shows locations in an org-mode file which might have
453 been invisible before. When this is set, the sibling of the current entry
454 heading are all made visible. If `org-show-hierarchy-above' is t,
455 the same happens on each level of the hierarchy above the current entry.
457 By default this is on for the isearch context, off for all other contexts.
458 Turning this off for example for sparse trees makes them very compact,
459 but makes it harder to edit the location of the match. In such a case,
460 use the command \\[org-reveal] to show more context.
461 Instead of t, this can also be an alist specifying this option for different
462 contexts. See `org-show-hierarchy-above' for valid contexts."
463 :group
'org-reveal-location
464 :type org-context-choice
)
466 (defcustom org-show-entry-below
'((default . nil
))
467 "Non-nil means, show the entry below a headline when revealing a location.
468 Org-mode often shows locations in an org-mode file which might have
469 been invisible before. When this is set, the text below the headline that is
470 exposed is also shown.
472 By default this is off for all contexts.
473 Instead of t, this can also be an alist specifying this option for different
474 contexts. See `org-show-hierarchy-above' for valid contexts."
475 :group
'org-reveal-location
476 :type org-context-choice
)
478 (defcustom org-indirect-buffer-display
'other-window
479 "How should indirect tree buffers be displayed?
480 This applies to indirect buffers created with the commands
481 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
483 current-window Display in the current window
484 other-window Just display in another window.
485 dedicated-frame Create one new frame, and re-use it each time.
486 new-frame Make a new frame each time. Note that in this case
487 previously-made indirect buffers are kept, and you need to
488 kill these buffers yourself."
489 :group
'org-structure
490 :group
'org-agenda-windows
492 (const :tag
"In current window" current-window
)
493 (const :tag
"In current frame, other window" other-window
)
494 (const :tag
"Each time a new frame" new-frame
)
495 (const :tag
"One dedicated frame" dedicated-frame
)))
497 (defgroup org-cycle nil
498 "Options concerning visibility cycling in Org-mode."
500 :group
'org-structure
)
502 (defcustom org-drawers
'("PROPERTIES" "CLOCK")
503 "Names of drawers. Drawers are not opened by cycling on the headline above.
504 Drawers only open with a TAB on the drawer line itself. A drawer looks like
509 The drawer \"PROPERTIES\" is special for capturing properties through
512 Drawers can be defined on the per-file basis with a line like:
514 #+DRAWERS: HIDDEN STATE PROPERTIES"
515 :group
'org-structure
516 :type
'(repeat (string :tag
"Drawer Name")))
518 (defcustom org-cycle-global-at-bob nil
519 "Cycle globally if cursor is at beginning of buffer and not at a headline.
520 This makes it possible to do global cycling without having to use S-TAB or
521 C-u TAB. For this special case to work, the first line of the buffer
522 must not be a headline - it may be empty ot some other text. When used in
523 this way, `org-cycle-hook' is disables temporarily, to make sure the
524 cursor stays at the beginning of the buffer.
525 When this option is nil, don't do anything special at the beginning
530 (defcustom org-cycle-emulate-tab t
531 "Where should `org-cycle' emulate TAB.
533 white Only in completely white lines
534 whitestart Only at the beginning of lines, before the first non-white char
535 t Everywhere except in headlines
536 exc-hl-bol Everywhere except at the start of a headline
537 If TAB is used in a place where it does not emulate TAB, the current subtree
538 visibility is cycled."
540 :type
'(choice (const :tag
"Never" nil
)
541 (const :tag
"Only in completely white lines" white
)
542 (const :tag
"Before first char in a line" whitestart
)
543 (const :tag
"Everywhere except in headlines" t
)
544 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)
547 (defcustom org-cycle-separator-lines
2
548 "Number of empty lines needed to keep an empty line between collapsed trees.
549 If you leave an empty line between the end of a subtree and the following
550 headline, this empty line is hidden when the subtree is folded.
551 Org-mode will leave (exactly) one empty line visible if the number of
552 empty lines is equal or larger to the number given in this variable.
553 So the default 2 means, at least 2 empty lines after the end of a subtree
554 are needed to produce free space between a collapsed subtree and the
557 Special case: when 0, never leave empty lines in collapsed view."
560 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
562 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
563 org-cycle-hide-drawers
564 org-cycle-show-empty-lines
565 org-optimize-window-after-visibility-change
)
566 "Hook that is run after `org-cycle' has changed the buffer visibility.
567 The function(s) in this hook must accept a single argument which indicates
568 the new state that was set by the most recent `org-cycle' command. The
569 argument is a symbol. After a global state change, it can have the values
570 `overview', `content', or `all'. After a local state change, it can have
571 the values `folded', `children', or `subtree'."
575 (defgroup org-edit-structure nil
576 "Options concerning structure editing in Org-mode."
577 :tag
"Org Edit Structure"
578 :group
'org-structure
)
580 (defcustom org-odd-levels-only nil
581 "Non-nil means, skip even levels and only use odd levels for the outline.
582 This has the effect that two stars are being added/taken away in
583 promotion/demotion commands. It also influences how levels are
584 handled by the exporters.
585 Changing it requires restart of `font-lock-mode' to become effective
586 for fontification also in regions already fontified.
587 You may also set this on a per-file basis by adding one of the following
592 :group
'org-edit-structure
593 :group
'org-font-lock
596 (defcustom org-adapt-indentation t
597 "Non-nil means, adapt indentation when promoting and demoting.
598 When this is set and the *entire* text in an entry is indented, the
599 indentation is increased by one space in a demotion command, and
600 decreased by one in a promotion command. If any line in the entry
601 body starts at column 0, indentation is not changed at all."
602 :group
'org-edit-structure
605 (defcustom org-special-ctrl-a
/e nil
606 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
607 When t, `C-a' will bring back the cursor to the beginning of the
608 headline text, i.e. after the stars and after a possible TODO keyword.
609 In an item, this will be the position after the bullet.
610 When the cursor is already at that position, another `C-a' will bring
611 it to the beginning of the line.
612 `C-e' will jump to the end of the headline, ignoring the presence of tags
613 in the headline. A second `C-e' will then jump to the true end of the
614 line, after any tags.
615 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
616 and only a directly following, identical keypress will bring the cursor
617 to the special positions."
618 :group
'org-edit-structure
620 (const :tag
"off" nil
)
621 (const :tag
"after bullet first" t
)
622 (const :tag
"border first" reversed
)))
624 (if (fboundp 'defvaralias
)
625 (defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
))
627 (defcustom org-special-ctrl-k nil
628 "Non-nil means `C-k' will behave specially in headlines.
629 When nil, `C-k' will call the default `kill-line' command.
630 When t, the following will happen while the cursor is in the headline:
632 - When the cursor is at the beginning of a headline, kill the entire
633 line and possible the folded subtree below the line.
634 - When in the middle of the headline text, kill the headline up to the tags.
635 - When after the headline text, kill the tags."
636 :group
'org-edit-structure
639 (defcustom org-yank-folded-subtrees t
640 "Non-nil means, when yanking subtrees, fold them.
641 If the kill is a single subtree, or a sequence of subtrees, i.e. if
642 it starts with a heading and all other headings in it are either children
643 or siblings, then fold all the subtrees. However, do this only if no
644 text after the yank would be swallowed into a folded tree by this action."
645 :group
'org-edit-structure
648 (defcustom org-yank-adjusted-subtrees t
649 "Non-nil means, when yanking subtrees, adjust the level.
650 With this setting, `org-paste-subtree' is used to insert the subtree, see
651 this function for details."
652 :group
'org-edit-structure
655 (defcustom org-M-RET-may-split-line
'((default . t
))
656 "Non-nil means, M-RET will split the line at the cursor position.
657 When nil, it will go to the end of the line before making a
659 You may also set this option in a different way for different
660 contexts. Valid contexts are:
662 headline when creating a new headline
663 item when creating a new item
664 table in a table field
665 default the value to be used for all contexts not explicitly
667 :group
'org-structure
670 (const :tag
"Always" t
)
671 (const :tag
"Never" nil
)
672 (repeat :greedy t
:tag
"Individual contexts"
674 (choice :tag
"Context"
682 (defcustom org-insert-heading-respect-content nil
683 "Non-nil means, insert new headings after the current subtree.
684 When nil, the new heading is created directly after the current line.
685 The commands \\[org-insert-heading-respect-content] and
686 \\[org-insert-todo-heading-respect-content] turn this variable on
687 for the duration of the command."
688 :group
'org-structure
691 (defcustom org-blank-before-new-entry
'((heading . nil
)
692 (plain-list-item . nil
))
693 "Should `org-insert-heading' leave a blank line before new heading/item?
694 The value is an alist, with `heading' and `plain-list-item' as car,
695 and a boolean flag as cdr."
696 :group
'org-edit-structure
698 (cons (const heading
) (boolean))
699 (cons (const plain-list-item
) (boolean))))
701 (defcustom org-insert-heading-hook nil
702 "Hook being run after inserting a new heading."
703 :group
'org-edit-structure
706 (defcustom org-enable-fixed-width-editor t
707 "Non-nil means, lines starting with \":\" are treated as fixed-width.
708 This currently only means, they are never auto-wrapped.
709 When nil, such lines will be treated like ordinary lines.
710 See also the QUOTE keyword."
711 :group
'org-edit-structure
714 (defcustom org-edit-src-region-extra nil
715 "Additional regexps to identify regions for editing with `org-edit-src-code'.
716 For examples see the function `org-edit-src-find-region-and-lang'.
717 The regular expression identifying the begin marker should end with a newline,
718 and the regexp marking the end line should start with a newline, to make sure
719 there are kept outside the narrowed region."
720 :group
'org-edit-structure
723 (regexp :tag
"begin regexp")
724 (regexp :tag
"end regexp")
725 (choice :tag
"language"
726 (string :tag
"specify")
727 (integer :tag
"from match group")
728 (const :tag
"from `lang' element")
729 (const :tag
"from `style' element")))))
731 (defcustom org-edit-fixed-width-region-mode
'artist-mode
732 "The mode that should be used to edit fixed-width regions.
733 These are the regions where each line starts with a colon."
734 :group
'org-edit-structure
738 (const fundamental-mode
)
739 (function :tag
"Other (specify)")))
741 (defcustom org-goto-auto-isearch t
742 "Non-nil means, typing characters in org-goto starts incremental search."
743 :group
'org-edit-structure
746 (defgroup org-sparse-trees nil
747 "Options concerning sparse trees in Org-mode."
748 :tag
"Org Sparse Trees"
749 :group
'org-structure
)
751 (defcustom org-highlight-sparse-tree-matches t
752 "Non-nil means, highlight all matches that define a sparse tree.
753 The highlights will automatically disappear the next time the buffer is
754 changed by an edit command."
755 :group
'org-sparse-trees
758 (defcustom org-remove-highlights-with-change t
759 "Non-nil means, any change to the buffer will remove temporary highlights.
760 Such highlights are created by `org-occur' and `org-clock-display'.
761 When nil, `C-c C-c needs to be used to get rid of the highlights.
762 The highlights created by `org-preview-latex-fragment' always need
763 `C-c C-c' to be removed."
764 :group
'org-sparse-trees
769 (defcustom org-occur-hook
'(org-first-headline-recenter)
770 "Hook that is run after `org-occur' has constructed a sparse tree.
771 This can be used to recenter the window to show as much of the structure
773 :group
'org-sparse-trees
776 (defgroup org-imenu-and-speedbar nil
777 "Options concerning imenu and speedbar in Org-mode."
778 :tag
"Org Imenu and Speedbar"
779 :group
'org-structure
)
781 (defcustom org-imenu-depth
2
782 "The maximum level for Imenu access to Org-mode headlines.
783 This also applied for speedbar access."
784 :group
'org-imenu-and-speedbar
787 (defgroup org-table nil
788 "Options concerning tables in Org-mode."
792 (defcustom org-enable-table-editor
'optimized
793 "Non-nil means, lines starting with \"|\" are handled by the table editor.
794 When nil, such lines will be treated like ordinary lines.
796 When equal to the symbol `optimized', the table editor will be optimized to
798 - Automatic overwrite mode in front of whitespace in table fields.
799 This makes the structure of the table stay in tact as long as the edited
800 field does not exceed the column width.
801 - Minimize the number of realigns. Normally, the table is aligned each time
802 TAB or RET are pressed to move to another field. With optimization this
803 happens only if changes to a field might have changed the column width.
804 Optimization requires replacing the functions `self-insert-command',
805 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
806 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
807 very good at guessing when a re-align will be necessary, but you can always
808 force one with \\[org-ctrl-c-ctrl-c].
810 If you would like to use the optimized version in Org-mode, but the
811 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
813 This variable can be used to turn on and off the table editor during a session,
814 but in order to toggle optimization, a restart is required.
816 See also the variable `org-table-auto-blank-field'."
819 (const :tag
"off" nil
)
821 (const :tag
"on, optimized" optimized
)))
823 (defcustom org-table-tab-recognizes-table.el t
824 "Non-nil means, TAB will automatically notice a table.el table.
825 When it sees such a table, it moves point into it and - if necessary -
826 calls `table-recognize-table'."
827 :group
'org-table-editing
830 (defgroup org-link nil
831 "Options concerning links in Org-mode."
835 (defvar org-link-abbrev-alist-local nil
836 "Buffer-local version of `org-link-abbrev-alist', which see.
837 The value of this is taken from the #+LINK lines.")
838 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
840 (defcustom org-link-abbrev-alist nil
841 "Alist of link abbreviations.
842 The car of each element is a string, to be replaced at the start of a link.
843 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
844 links in Org-mode buffers can have an optional tag after a double colon, e.g.
846 [[linkkey:tag][description]]
848 If REPLACE is a string, the tag will simply be appended to create the link.
849 If the string contains \"%s\", the tag will be inserted there. Alternatively,
850 the placeholder \"%h\" will cause a url-encoded version of the tag to
851 be inserted at that point (see the function `url-hexify-string').
853 REPLACE may also be a function that will be called with the tag as the
854 only argument to create the link, which should be returned as a string.
856 See the manual for examples."
860 (string :tag
"Protocol")
862 (string :tag
"Format")
865 (defcustom org-descriptive-links t
866 "Non-nil means, hide link part and only show description of bracket links.
867 Bracket links are like [[link][description]]. This variable sets the initial
868 state in new org-mode buffers. The setting can then be toggled on a
869 per-buffer basis from the Org->Hyperlinks menu."
873 (defcustom org-link-file-path-type
'adaptive
874 "How the path name in file links should be stored.
877 relative Relative to the current directory, i.e. the directory of the file
878 into which the link is being inserted.
879 absolute Absolute path, if possible with ~ for home directory.
880 noabbrev Absolute path, no abbreviation of home directory.
881 adaptive Use relative path for files in the current directory and sub-
882 directories of it. For other files, use an absolute path."
890 (defcustom org-activate-links
'(bracket angle plain radio tag date
)
891 "Types of links that should be activated in Org-mode files.
892 This is a list of symbols, each leading to the activation of a certain link
893 type. In principle, it does not hurt to turn on most link types - there may
894 be a small gain when turning off unused link types. The types are:
896 bracket The recommended [[link][description]] or [[link]] links with hiding.
897 angular Links in angular brackets that may contain whitespace like
898 <bbdb:Carsten Dominik>.
899 plain Plain links in normal text, no whitespace, like http://google.com.
900 radio Text that is matched by a radio target, see manual for details.
901 tag Tag settings in a headline (link to tag search).
902 date Time stamps (link to calendar).
904 Changing this variable requires a restart of Emacs to become effective."
906 :type
'(set (const :tag
"Double bracket links (new style)" bracket
)
907 (const :tag
"Angular bracket links (old style)" angular
)
908 (const :tag
"Plain text links" plain
)
909 (const :tag
"Radio target matches" radio
)
910 (const :tag
"Tags" tag
)
911 (const :tag
"Timestamps" date
)))
913 (defcustom org-make-link-description-function nil
914 "Function to use to generate link descriptions from links. If
915 nil the link location will be used. This function must take two
916 parameters; the first is the link and the second the description
917 org-insert-link has generated, and should return the description
922 (defgroup org-link-store nil
923 "Options concerning storing links in Org-mode."
924 :tag
"Org Store Link"
927 (defcustom org-email-link-description-format
"Email %c: %.30s"
928 "Format of the description part of a link to an email or usenet message.
929 The following %-escapes will be replaced by corresponding information:
931 %F full \"From\" field
932 %f name, taken from \"From\" field, address if no name
934 %t first name in \"To\" field, address if no name
935 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
936 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
940 You may use normal field width specification between the % and the letter.
941 This is for example useful to limit the length of the subject.
943 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
944 :group
'org-link-store
947 (defcustom org-from-is-user-regexp
949 (when (and user-mail-address
(not (string= user-mail-address
"")))
950 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
951 (when (and user-full-name
(not (string= user-full-name
"")))
952 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
953 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
954 "Regexp matched against the \"From:\" header of an email or usenet message.
955 It should match if the message is from the user him/herself."
956 :group
'org-link-store
959 (defcustom org-link-to-org-use-id
'create-if-interactive
960 "Non-nil means, storing a link to an Org file will use entry IDs.
962 Note that before this variable is even considered, org-id must be loaded,
963 to please customize `org-modules' and turn it on.
965 The variable can have the following values:
967 t Create an ID if needed to make a link to the current entry.
969 create-if-interactive
970 If `org-store-link' is called directly (interactively, as a user
971 command), do create an ID to support the link. But when doing the
972 job for remember, only use the ID if it already exists. The
973 purpose of this setting is to avoid proliferation of unwanted
974 IDs, just because you happen to be in an Org file when you
975 call `org-remember' that automatically and preemptively
976 creates a link. If you do want to get an ID link in a remember
977 template to an entry not having an ID, create it first by
978 explicitly creating a link to it, using `C-c C-l' first.
981 Use existing ID, do not create one.
983 nil Never use an ID to make a link, instead link using a text search for
985 :group
'org-link-store
987 (const :tag
"Create ID to make link" t
)
988 (const :tag
"Create if string link interactively"
989 'create-if-interactive
)
990 (const :tag
"Only use existing" 'use-existing
)
991 (const :tag
"Do not use ID to create link" nil
)))
993 (defcustom org-context-in-file-links t
994 "Non-nil means, file links from `org-store-link' contain context.
995 A search string will be added to the file name with :: as separator and
996 used to find the context when the link is activated by the command
998 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
999 negates this setting for the duration of the command."
1000 :group
'org-link-store
1003 (defcustom org-keep-stored-link-after-insertion nil
1004 "Non-nil means, keep link in list for entire session.
1006 The command `org-store-link' adds a link pointing to the current
1007 location to an internal list. These links accumulate during a session.
1008 The command `org-insert-link' can be used to insert links into any
1009 Org-mode file (offering completion for all stored links). When this
1010 option is nil, every link which has been inserted once using \\[org-insert-link]
1011 will be removed from the list, to make completing the unused links
1013 :group
'org-link-store
1016 (defgroup org-link-follow nil
1017 "Options concerning following links in Org-mode."
1018 :tag
"Org Follow Link"
1021 (defcustom org-link-translation-function nil
1022 "Function to translate links with different syntax to Org syntax.
1023 This can be used to translate links created for example by the Planner
1024 or emacs-wiki packages to Org syntax.
1025 The function must accept two parameters, a TYPE containing the link
1026 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1027 which is everything after the link protocol. It should return a cons
1028 with possibly modified values of type and path.
1029 Org contains a function for this, so if you set this variable to
1030 `org-translate-link-from-planner', you should be able follow many
1031 links created by planner."
1032 :group
'org-link-follow
1035 (defcustom org-follow-link-hook nil
1036 "Hook that is run after a link has been followed."
1037 :group
'org-link-follow
1040 (defcustom org-tab-follows-link nil
1041 "Non-nil means, on links TAB will follow the link.
1042 Needs to be set before org.el is loaded."
1043 :group
'org-link-follow
1046 (defcustom org-return-follows-link nil
1047 "Non-nil means, on links RET will follow the link.
1048 Needs to be set before org.el is loaded."
1049 :group
'org-link-follow
1052 (defcustom org-mouse-1-follows-link
1053 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1054 "Non-nil means, mouse-1 on a link will follow the link.
1055 A longer mouse click will still set point. Does not work on XEmacs.
1056 Needs to be set before org.el is loaded."
1057 :group
'org-link-follow
1060 (defcustom org-mark-ring-length
4
1061 "Number of different positions to be recorded in the ring
1062 Changing this requires a restart of Emacs to work correctly."
1063 :group
'org-link-follow
1066 (defcustom org-link-frame-setup
1067 '((vm . vm-visit-folder-other-frame
)
1068 (gnus . gnus-other-frame
)
1069 (file . find-file-other-window
))
1070 "Setup the frame configuration for following links.
1071 When following a link with Emacs, it may often be useful to display
1072 this link in another window or frame. This variable can be used to
1073 set this up for the different types of links.
1076 `vm-visit-folder-other-frame'
1077 For Gnus, use any of
1080 `org-gnus-no-new-news'
1081 For FILE, use any of
1083 `find-file-other-window'
1084 `find-file-other-frame'
1085 For the calendar, use the variable `calendar-setup'.
1086 For BBDB, it is currently only possible to display the matches in
1088 :group
'org-link-follow
1092 (const vm-visit-folder
)
1093 (const vm-visit-folder-other-window
)
1094 (const vm-visit-folder-other-frame
)))
1098 (const gnus-other-frame
)
1099 (const org-gnus-no-new-news
)))
1103 (const find-file-other-window
)
1104 (const find-file-other-frame
)))))
1106 (defcustom org-display-internal-link-with-indirect-buffer nil
1107 "Non-nil means, use indirect buffer to display infile links.
1108 Activating internal links (from one location in a file to another location
1109 in the same file) normally just jumps to the location. When the link is
1110 activated with a C-u prefix (or with mouse-3), the link is displayed in
1111 another window. When this option is set, the other window actually displays
1112 an indirect buffer clone of the current buffer, to avoid any visibility
1113 changes to the current buffer."
1114 :group
'org-link-follow
1117 (defcustom org-open-non-existing-files nil
1118 "Non-nil means, `org-open-file' will open non-existing files.
1119 When nil, an error will be generated."
1120 :group
'org-link-follow
1123 (defcustom org-open-directory-means-index-dot-org nil
1124 "Non-nil means, a link to a directory really means to index.org.
1125 When nil, following a directory link will run dired or open a finder/explorer
1126 window on that directory."
1127 :group
'org-link-follow
1130 (defcustom org-link-mailto-program
'(browse-url "mailto:%a?subject=%s")
1131 "Function and arguments to call for following mailto links.
1132 This is a list with the first element being a lisp function, and the
1133 remaining elements being arguments to the function. In string arguments,
1134 %a will be replaced by the address, and %s will be replaced by the subject
1135 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1136 :group
'org-link-follow
1138 (const :tag
"browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1139 (const :tag
"compose-mail" (compose-mail "%a" "%s"))
1140 (const :tag
"message-mail" (message-mail "%a" "%s"))
1141 (cons :tag
"other" (function) (repeat :tag
"argument" sexp
))))
1143 (defcustom org-confirm-shell-link-function
'yes-or-no-p
1144 "Non-nil means, ask for confirmation before executing shell links.
1145 Shell links can be dangerous: just think about a link
1147 [[shell:rm -rf ~/*][Google Search]]
1149 This link would show up in your Org-mode document as \"Google Search\",
1150 but really it would remove your entire home directory.
1151 Therefore we advise against setting this variable to nil.
1152 Just change it to `y-or-n-p' of you want to confirm with a
1153 single keystroke rather than having to type \"yes\"."
1154 :group
'org-link-follow
1156 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
1157 (const :tag
"with y-or-n (faster)" y-or-n-p
)
1158 (const :tag
"no confirmation (dangerous)" nil
)))
1160 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
1161 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1162 Elisp links can be dangerous: just think about a link
1164 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1166 This link would show up in your Org-mode document as \"Google Search\",
1167 but really it would remove your entire home directory.
1168 Therefore we advise against setting this variable to nil.
1169 Just change it to `y-or-n-p' of you want to confirm with a
1170 single keystroke rather than having to type \"yes\"."
1171 :group
'org-link-follow
1173 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
1174 (const :tag
"with y-or-n (faster)" y-or-n-p
)
1175 (const :tag
"no confirmation (dangerous)" nil
)))
1177 (defconst org-file-apps-defaults-gnu
1181 "Default file applications on a UNIX or GNU/Linux system.
1182 See `org-file-apps'.")
1184 (defconst org-file-apps-defaults-macosx
1187 (system .
"open %s")
1189 ("eps.gz" .
"gv %s")
1191 ("fig" .
"xfig %s"))
1192 "Default file applications on a MacOS X system.
1193 The system \"open\" is known as a default, but we use X11 applications
1194 for some files for which the OS does not have a good default.
1195 See `org-file-apps'.")
1197 (defconst org-file-apps-defaults-windowsnt
1201 (list (if (featurep 'xemacs
)
1202 'mswindows-shell-execute
1206 (list (if (featurep 'xemacs
)
1207 'mswindows-shell-execute
1210 "Default file applications on a Windows NT system.
1211 The system \"open\" is used for most files.
1212 See `org-file-apps'.")
1214 (defcustom org-file-apps
1217 ("\\.x?html?\\'" . default
)
1218 ("\\.pdf\\'" . default
)
1220 "External applications for opening `file:path' items in a document.
1221 Org-mode uses system defaults for different file types, but
1222 you can use this variable to set the application for a given file
1223 extension. The entries in this list are cons cells where the car identifies
1224 files and the cdr the corresponding command. Possible values for the
1226 \"regex\" Regular expression matched against the file name. For backward
1227 compatibility, this can also be a string with only alphanumeric
1228 characters, which is then interpreted as an extension.
1229 `directory' Matches a directory
1230 `remote' Matches a remote file, accessible through tramp or efs.
1231 Remote files most likely should be visited through Emacs
1232 because external applications cannot handle such paths.
1233 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1234 so all files Emacs knows how to handle. Using this with
1235 command `emacs' will open most files in Emacs. Beware that this
1236 will also open html files inside Emacs, unless you add
1237 (\"html\" . default) to the list as well.
1238 t Default for files not matched by any of the other options.
1239 `system' The system command to open files, like `open' on Windows
1240 and Mac OS X, and mailcap under GNU/Linux. This is the command
1241 that will be selected if you call `C-c C-o' with a double
1244 Possible values for the command are:
1245 `emacs' The file will be visited by the current Emacs process.
1246 `default' Use the default application for this file type, which is the
1247 association for t in the list, most likely in the system-specific
1249 This can be used to overrule an unwanted setting in the
1250 system-specific variable.
1251 `system' Use the system command for opening files, like \"open\".
1252 This command is specified by the entry whose car is `system'.
1253 Most likely, the system-specific version of this variable
1254 does define this command, but you can overrule/replace it
1256 string A command to be executed by a shell; %s will be replaced
1257 by the path to the file.
1258 sexp A Lisp form which will be evaluated. The file path will
1259 be available in the Lisp variable `file'.
1260 For more examples, see the system specific constants
1261 `org-file-apps-defaults-macosx'
1262 `org-file-apps-defaults-windowsnt'
1263 `org-file-apps-defaults-gnu'."
1264 :group
'org-link-follow
1266 (cons (choice :value
""
1267 (string :tag
"Extension")
1268 (const :tag
"System command to open files" system
)
1269 (const :tag
"Default for unrecognized files" t
)
1270 (const :tag
"Remote file" remote
)
1271 (const :tag
"Links to a directory" directory
)
1272 (const :tag
"Any files that have Emacs modes"
1275 (const :tag
"Visit with Emacs" emacs
)
1276 (const :tag
"Use default" default
)
1277 (const :tag
"Use the system command" system
)
1278 (string :tag
"Command")
1279 (sexp :tag
"Lisp form")))))
1281 (defgroup org-refile nil
1282 "Options concerning refiling entries in Org-mode."
1286 (defcustom org-directory
"~/org"
1287 "Directory with org files.
1288 This directory will be used as default to prompt for org files.
1289 Used by the hooks for remember.el."
1291 :group
'org-remember
1294 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
1295 "Default target for storing notes.
1296 Used by the hooks for remember.el. This can be a string, or nil to mean
1297 the value of `remember-data-file'.
1298 You can set this on a per-template basis with the variable
1299 `org-remember-templates'."
1301 :group
'org-remember
1303 (const :tag
"Default from remember-data-file" nil
)
1306 (defcustom org-goto-interface
'outline
1307 "The default interface to be used for `org-goto'.
1309 outline The interface shows an outline of the relevant file
1310 and the correct heading is found by moving through
1311 the outline or by searching with incremental search.
1312 outline-path-completion Headlines in the current buffer are offered via
1313 completion. This is the interface also used by
1314 the refile command."
1317 (const :tag
"Outline" outline
)
1318 (const :tag
"Outline-path-completion" outline-path-completion
)))
1320 (defcustom org-goto-max-level
5
1321 "Maximum level to be considered when running org-goto with refile interface."
1325 (defcustom org-reverse-note-order nil
1326 "Non-nil means, store new notes at the beginning of a file or entry.
1327 When nil, new notes will be filed to the end of a file or entry.
1328 This can also be a list with cons cells of regular expressions that
1329 are matched against file names, and values."
1330 :group
'org-remember
1333 (const :tag
"Reverse always" t
)
1334 (const :tag
"Reverse never" nil
)
1335 (repeat :tag
"By file name regexp"
1336 (cons regexp boolean
))))
1338 (defcustom org-refile-targets nil
1339 "Targets for refiling entries with \\[org-refile].
1340 This is list of cons cells. Each cell contains:
1341 - a specification of the files to be considered, either a list of files,
1342 or a symbol whose function or variable value will be used to retrieve
1343 a file name or a list of file names. If you use `org-agenda-files' for
1344 that, all agenda files will be scanned for targets. Nil means, consider
1345 headings in the current buffer.
1346 - A specification of how to select find candidate refile targets. This
1348 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
1349 This tag has to be present in all target headlines, inheritance will
1351 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
1353 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
1354 headlines that are refiling targets.
1355 - a cons cell (:level . N). Any headline of level N is considered a target.
1356 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1358 When this variable is nil, all top-level headlines in the current buffer
1359 are used, equivalent to the value `((nil . (:level . 1))'."
1363 (choice :value org-agenda-files
1364 (const :tag
"All agenda files" org-agenda-files
)
1365 (const :tag
"Current buffer" nil
)
1366 (function) (variable) (file))
1367 (choice :tag
"Identify target headline by"
1368 (cons :tag
"Specific tag" (const :value
:tag
) (string))
1369 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
1370 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
1371 (cons :tag
"Level number" (const :value
:level
) (integer))
1372 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
1374 (defcustom org-refile-use-outline-path nil
1375 "Non-nil means, provide refile targets as paths.
1376 So a level 3 headline will be available as level1/level2/level3.
1377 When the value is `file', also include the file name (without directory)
1378 into the path. When `full-file-path', include the full file path."
1381 (const :tag
"Not" nil
)
1382 (const :tag
"Yes" t
)
1383 (const :tag
"Start with file name" file
)
1384 (const :tag
"Start with full file path" full-file-path
)))
1386 (defcustom org-outline-path-complete-in-steps t
1387 "Non-nil means, complete the outline path in hierarchical steps.
1388 When Org-mode uses the refile interface to select an outline path
1389 \(see variable `org-refile-use-outline-path'), the completion of
1390 the path can be done is a single go, or if can be done in steps down
1391 the headline hierarchy. Going in steps is probably the best if you
1392 do not use a special completion package like `ido' or `icicles'.
1393 However, when using these packages, going in one step can be very
1394 fast, while still showing the whole path to the entry."
1398 (defgroup org-todo nil
1399 "Options concerning TODO items in Org-mode."
1403 (defgroup org-progress nil
1404 "Options concerning Progress logging in Org-mode."
1408 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
1409 "List of TODO entry keyword sequences and their interpretation.
1410 \\<org-mode-map>This is a list of sequences.
1412 Each sequence starts with a symbol, either `sequence' or `type',
1413 indicating if the keywords should be interpreted as a sequence of
1414 action steps, or as different types of TODO items. The first
1415 keywords are states requiring action - these states will select a headline
1416 for inclusion into the global TODO list Org-mode produces. If one of
1417 the \"keywords\" is the vertical bat \"|\" the remaining keywords
1418 signify that no further action is necessary. If \"|\" is not found,
1419 the last keyword is treated as the only DONE state of the sequence.
1421 The command \\[org-todo] cycles an entry through these states, and one
1422 additional state where no keyword is present. For details about this
1423 cycling, see the manual.
1425 TODO keywords and interpretation can also be set on a per-file basis with
1426 the special #+SEQ_TODO and #+TYP_TODO lines.
1428 Each keyword can optionally specify a character for fast state selection
1429 \(in combination with the variable `org-use-fast-todo-selection')
1430 and specifiers for state change logging, using the same syntax
1431 that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
1432 that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
1433 indicates to record a time stamp each time this state is selected.
1435 Each keyword may also specify if a timestamp or a note should be
1436 recorded when entering or leaving the state, by adding additional
1437 characters in the parenthesis after the keyword. This looks like this:
1438 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
1439 record only the time of the state change. With X and Y being either
1440 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
1441 Y when leaving the state if and only if the *target* state does not
1442 define X. You may omit any of the fast-selection key or X or /Y,
1443 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1445 For backward compatibility, this variable may also be just a list
1446 of keywords - in this case the interpretation (sequence or type) will be
1447 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1449 :group
'org-keywords
1451 (repeat :tag
"Old syntax, just keywords"
1452 (string :tag
"Keyword"))
1453 (repeat :tag
"New syntax"
1456 :tag
"Interpretation"
1457 (const :tag
"Sequence (cycling hits every state)" sequence
)
1458 (const :tag
"Type (cycling directly to DONE)" type
))
1460 (string :tag
"Keyword"))))))
1462 (defvar org-todo-keywords-1 nil
1463 "All TODO and DONE keywords active in a buffer.")
1464 (make-variable-buffer-local 'org-todo-keywords-1
)
1465 (defvar org-todo-keywords-for-agenda nil
)
1466 (defvar org-done-keywords-for-agenda nil
)
1467 (defvar org-todo-keyword-alist-for-agenda nil
)
1468 (defvar org-tag-alist-for-agenda nil
)
1469 (defvar org-agenda-contributing-files nil
)
1470 (defvar org-not-done-keywords nil
)
1471 (make-variable-buffer-local 'org-not-done-keywords
)
1472 (defvar org-done-keywords nil
)
1473 (make-variable-buffer-local 'org-done-keywords
)
1474 (defvar org-todo-heads nil
)
1475 (make-variable-buffer-local 'org-todo-heads
)
1476 (defvar org-todo-sets nil
)
1477 (make-variable-buffer-local 'org-todo-sets
)
1478 (defvar org-todo-log-states nil
)
1479 (make-variable-buffer-local 'org-todo-log-states
)
1480 (defvar org-todo-kwd-alist nil
)
1481 (make-variable-buffer-local 'org-todo-kwd-alist
)
1482 (defvar org-todo-key-alist nil
)
1483 (make-variable-buffer-local 'org-todo-key-alist
)
1484 (defvar org-todo-key-trigger nil
)
1485 (make-variable-buffer-local 'org-todo-key-trigger
)
1487 (defcustom org-todo-interpretation
'sequence
1488 "Controls how TODO keywords are interpreted.
1489 This variable is in principle obsolete and is only used for
1490 backward compatibility, if the interpretation of todo keywords is
1491 not given already in `org-todo-keywords'. See that variable for
1494 :group
'org-keywords
1495 :type
'(choice (const sequence
)
1498 (defcustom org-use-fast-todo-selection
'prefix
1499 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1500 This variable describes if and under what circumstances the cycling
1501 mechanism for TODO keywords will be replaced by a single-key, direct
1504 When nil, fast selection is never used.
1506 When the symbol `prefix', it will be used when `org-todo' is called with
1507 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1508 in an agenda buffer.
1510 When t, fast selection is used by default. In this case, the prefix
1511 argument forces cycling instead.
1513 In all cases, the special interface is only used if access keys have actually
1514 been assigned by the user, i.e. if keywords in the configuration are followed
1515 by a letter in parenthesis, like TODO(t)."
1518 (const :tag
"Never" nil
)
1519 (const :tag
"By default" t
)
1520 (const :tag
"Only with C-u C-c C-t" prefix
)))
1522 (defcustom org-provide-todo-statistics t
1523 "Non-nil means, update todo statistics after insert and toggle.
1524 When this is set, todo statistics is updated in the parent of the current
1525 entry each time a todo state is changed."
1529 (defcustom org-after-todo-state-change-hook nil
1530 "Hook which is run after the state of a TODO item was changed.
1531 The new state (a string with a TODO keyword, or nil) is available in the
1532 Lisp variable `state'."
1536 (defcustom org-todo-state-tags-triggers nil
1537 "Tag changes that should be triggered by TODO state changes.
1538 This is a list. Each entry is
1540 (state-change (tag . flag) .......)
1542 State-change can be a string with a state, and empty string to indicate the
1543 state that has no TODO keyword, or it can be one of the symbols `todo'
1544 or `done', meaning any not-done or done state, respectively."
1548 (cons (choice :tag
"When changing to"
1549 (const :tag
"Not-done state" todo
)
1550 (const :tag
"Done state" done
)
1551 (string :tag
"State"))
1553 (cons :tag
"Tag action"
1555 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
1557 (defcustom org-log-done nil
1558 "Information to record when a task moves to the DONE state.
1560 Possible values are:
1562 nil Don't add anything, just change the keyword
1563 time Add a time stamp to the task
1564 note Prompt a closing note and add it with template `org-log-note-headings'
1566 This option can also be set with on a per-file-basis with
1568 #+STARTUP: nologdone
1570 #+STARTUP: lognotedone
1572 You can have local logging settings for a subtree by setting the LOGGING
1573 property to one or more of these keywords."
1575 :group
'org-progress
1577 (const :tag
"No logging" nil
)
1578 (const :tag
"Record CLOSED timestamp" time
)
1579 (const :tag
"Record CLOSED timestamp with closing note." note
)))
1581 ;; Normalize old uses of org-log-done.
1583 ((eq org-log-done t
) (setq org-log-done
'time
))
1584 ((and (listp org-log-done
) (memq 'done org-log-done
))
1585 (setq org-log-done
'note
)))
1587 (defcustom org-log-note-clock-out nil
1588 "Non-nil means, record a note when clocking out of an item.
1589 This can also be configured on a per-file basis by adding one of
1590 the following lines anywhere in the buffer:
1592 #+STARTUP: lognoteclock-out
1593 #+STARTUP: nolognoteclock-out"
1595 :group
'org-progress
1598 (defcustom org-log-done-with-time t
1599 "Non-nil means, the CLOSED time stamp will contain date and time.
1600 When nil, only the date will be recorded."
1601 :group
'org-progress
1604 (defcustom org-log-note-headings
1605 '((done .
"CLOSING NOTE %t")
1606 (state .
"State %-12s %t")
1607 (note .
"Note taken on %t")
1609 "Headings for notes added to entries.
1610 The value is an alist, with the car being a symbol indicating the note
1611 context, and the cdr is the heading to be used. The heading may also be the
1613 %t in the heading will be replaced by a time stamp.
1614 %s will be replaced by the new TODO state, in double quotes.
1615 %u will be replaced by the user name.
1616 %U will be replaced by the full user name."
1618 :group
'org-progress
1619 :type
'(list :greedy t
1620 (cons (const :tag
"Heading when closing an item" done
) string
)
1622 "Heading when changing todo state (todo sequence only)"
1624 (cons (const :tag
"Heading when just taking a note" note
) string
)
1625 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
1627 (unless (assq 'note org-log-note-headings
)
1628 (push '(note .
"%t") org-log-note-headings
))
1630 (defcustom org-log-state-notes-insert-after-drawers nil
1631 "Non-nil means, insert state change notes after any drawers in entry.
1632 Only the drawers that *immediately* follow the headline and the
1633 deadline/scheduled line are skipped.
1634 When nil, insert notes right after the heading and perhaps the line
1635 with deadline/scheduling if present."
1637 :group
'org-progress
1640 (defcustom org-log-states-order-reversed t
1641 "Non-nil means, the latest state change note will be directly after heading.
1642 When nil, the notes will be orderer according to time."
1644 :group
'org-progress
1647 (defcustom org-log-repeat
'time
1648 "Non-nil means, record moving through the DONE state when triggering repeat.
1649 An auto-repeating tasks is immediately switched back to TODO when marked
1650 done. If you are not logging state changes (by adding \"@\" or \"!\" to
1651 the TODO keyword definition, or recording a closing note by setting
1652 `org-log-done', there will be no record of the task moving through DONE.
1653 This variable forces taking a note anyway. Possible values are:
1655 nil Don't force a record
1656 time Record a time stamp
1659 This option can also be set with on a per-file-basis with
1661 #+STARTUP: logrepeat
1662 #+STARTUP: lognoterepeat
1663 #+STARTUP: nologrepeat
1665 You can have local logging settings for a subtree by setting the LOGGING
1666 property to one or more of these keywords."
1668 :group
'org-progress
1670 (const :tag
"Don't force a record" nil
)
1671 (const :tag
"Force recording the DONE state" time
)
1672 (const :tag
"Force recording a note with the DONE state" note
)))
1675 (defgroup org-priorities nil
1676 "Priorities in Org-mode."
1677 :tag
"Org Priorities"
1680 (defcustom org-highest-priority ?A
1681 "The highest priority of TODO items. A character like ?A, ?B etc.
1682 Must have a smaller ASCII number than `org-lowest-priority'."
1683 :group
'org-priorities
1686 (defcustom org-lowest-priority ?C
1687 "The lowest priority of TODO items. A character like ?A, ?B etc.
1688 Must have a larger ASCII number than `org-highest-priority'."
1689 :group
'org-priorities
1692 (defcustom org-default-priority ?B
1693 "The default priority of TODO items.
1694 This is the priority an item get if no explicit priority is given."
1695 :group
'org-priorities
1698 (defcustom org-priority-start-cycle-with-default t
1699 "Non-nil means, start with default priority when starting to cycle.
1700 When this is nil, the first step in the cycle will be (depending on the
1701 command used) one higher or lower that the default priority."
1702 :group
'org-priorities
1705 (defgroup org-time nil
1706 "Options concerning time stamps and deadlines in Org-mode."
1710 (defcustom org-insert-labeled-timestamps-at-point nil
1711 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1712 When nil, these labeled time stamps are forces into the second line of an
1713 entry, just after the headline. When scheduling from the global TODO list,
1714 the time stamp will always be forced into the second line."
1718 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
1719 "Formats for `format-time-string' which are used for time stamps.
1720 It is not recommended to change this constant.")
1722 (defcustom org-time-stamp-rounding-minutes
'(0 5)
1723 "Number of minutes to round time stamps to.
1724 These are two values, the first applies when first creating a time stamp.
1725 The second applies when changing it with the commands `S-up' and `S-down'.
1726 When changing the time stamp, this means that it will change in steps
1727 of N minutes, as given by the second value.
1729 When a setting is 0 or 1, insert the time unmodified. Useful rounding
1730 numbers should be factors of 60, so for example 5, 10, 15.
1732 When this is larger than 1, you can still force an exact time-stamp by using
1733 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
1734 and by using a prefix arg to `S-up/down' to specify the exact number
1735 of minutes to shift."
1737 :get
'(lambda (var) ; Make sure all entries have 5 elements
1738 (if (integerp (default-value var
))
1739 (list (default-value var
) 5)
1740 (default-value var
)))
1742 (integer :tag
"when inserting times")
1743 (integer :tag
"when modifying times")))
1745 ;; Normalize old customizations of this variable.
1746 (when (integerp org-time-stamp-rounding-minutes
)
1747 (setq org-time-stamp-rounding-minutes
1748 (list org-time-stamp-rounding-minutes
1749 org-time-stamp-rounding-minutes
)))
1751 (defcustom org-display-custom-times nil
1752 "Non-nil means, overlay custom formats over all time stamps.
1753 The formats are defined through the variable `org-time-stamp-custom-formats'.
1754 To turn this on on a per-file basis, insert anywhere in the file:
1755 #+STARTUP: customtime"
1759 (make-variable-buffer-local 'org-display-custom-times
)
1761 (defcustom org-time-stamp-custom-formats
1762 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
1763 "Custom formats for time stamps. See `format-time-string' for the syntax.
1764 These are overlayed over the default ISO format if the variable
1765 `org-display-custom-times' is set. Time like %H:%M should be at the
1766 end of the second format."
1770 (defun org-time-stamp-format (&optional long inactive
)
1771 "Get the right format for a time string."
1772 (let ((f (if long
(cdr org-time-stamp-formats
)
1773 (car org-time-stamp-formats
))))
1775 (concat "[" (substring f
1 -
1) "]")
1778 (defcustom org-time-clocksum-format
"%d:%02d"
1779 "The format string used when creating CLOCKSUM lines, or when
1780 org-mode generates a time duration."
1784 (defcustom org-deadline-warning-days
14
1785 "No. of days before expiration during which a deadline becomes active.
1786 This variable governs the display in sparse trees and in the agenda.
1787 When 0 or negative, it means use this number (the absolute value of it)
1788 even if a deadline has a different individual lead time specified."
1790 :group
'org-agenda-daily
/weekly
1793 (defcustom org-read-date-prefer-future t
1794 "Non-nil means, assume future for incomplete date input from user.
1795 This affects the following situations:
1796 1. The user gives a day, but no month.
1797 For example, if today is the 15th, and you enter \"3\", Org-mode will
1798 read this as the third of *next* month. However, if you enter \"17\",
1799 it will be considered as *this* month.
1800 2. The user gives a month but not a year.
1801 For example, if it is april and you enter \"feb 2\", this will be read
1802 as feb 2, *next* year. \"May 5\", however, will be this year.
1804 Currently this does not work for ISO week specifications.
1806 When this option is nil, the current month and year will always be used
1811 (defcustom org-read-date-display-live t
1812 "Non-nil means, display current interpretation of date prompt live.
1813 This display will be in an overlay, in the minibuffer."
1817 (defcustom org-read-date-popup-calendar t
1818 "Non-nil means, pop up a calendar when prompting for a date.
1819 In the calendar, the date can be selected with mouse-1. However, the
1820 minibuffer will also be active, and you can simply enter the date as well.
1821 When nil, only the minibuffer will be available."
1824 (if (fboundp 'defvaralias
)
1825 (defvaralias 'org-popup-calendar-for-date-prompt
1826 'org-read-date-popup-calendar
))
1828 (defcustom org-extend-today-until
0
1829 "The hour when your day really ends. Must be an integer.
1830 This has influence for the following applications:
1831 - When switching the agenda to \"today\". It it is still earlier than
1832 the time given here, the day recognized as TODAY is actually yesterday.
1833 - When a date is read from the user and it is still before the time given
1834 here, the current date and time will be assumed to be yesterday, 23:59.
1835 Also, timestamps inserted in remember templates follow this rule.
1837 IMPORTANT: This is a feature whose implementation is and likely will
1838 remain incomplete. Really, it is only here because past midnight seems to
1839 be the favorite working time of John Wiegley :-)"
1843 (defcustom org-edit-timestamp-down-means-later nil
1844 "Non-nil means, S-down will increase the time in a time stamp.
1845 When nil, S-up will increase."
1849 (defcustom org-calendar-follow-timestamp-change t
1850 "Non-nil means, make the calendar window follow timestamp changes.
1851 When a timestamp is modified and the calendar window is visible, it will be
1852 moved to the new date."
1856 (defgroup org-tags nil
1857 "Options concerning tags in Org-mode."
1861 (defcustom org-tag-alist nil
1862 "List of tags allowed in Org-mode files.
1863 When this list is nil, Org-mode will base TAG input on what is already in the
1865 The value of this variable is an alist, the car of each entry must be a
1866 keyword as a string, the cdr may be a character that is used to select
1867 that tag through the fast-tag-selection interface.
1868 See the manual for details."
1872 (cons (string :tag
"Tag name")
1873 (character :tag
"Access char"))
1874 (const :tag
"Start radio group" (:startgroup
))
1875 (const :tag
"End radio group" (:endgroup
)))))
1877 (defvar org-file-tags nil
1878 "List of tags that can be inherited by all entries in the file.
1879 The tags will be inherited if the variable `org-use-tag-inheritance'
1880 says they should be.
1881 This variable is populated from #+TAG lines.")
1883 (defcustom org-use-fast-tag-selection
'auto
1884 "Non-nil means, use fast tag selection scheme.
1885 This is a special interface to select and deselect tags with single keys.
1886 When nil, fast selection is never used.
1887 When the symbol `auto', fast selection is used if and only if selection
1888 characters for tags have been configured, either through the variable
1889 `org-tag-alist' or through a #+TAGS line in the buffer.
1890 When t, fast selection is always used and selection keys are assigned
1891 automatically if necessary."
1894 (const :tag
"Always" t
)
1895 (const :tag
"Never" nil
)
1896 (const :tag
"When selection characters are configured" 'auto
)))
1898 (defcustom org-fast-tag-selection-single-key nil
1899 "Non-nil means, fast tag selection exits after first change.
1900 When nil, you have to press RET to exit it.
1901 During fast tag selection, you can toggle this flag with `C-c'.
1902 This variable can also have the value `expert'. In this case, the window
1903 displaying the tags menu is not even shown, until you press C-c again."
1906 (const :tag
"No" nil
)
1907 (const :tag
"Yes" t
)
1908 (const :tag
"Expert" expert
)))
1910 (defvar org-fast-tag-selection-include-todo nil
1911 "Non-nil means, fast tags selection interface will also offer TODO states.
1912 This is an undocumented feature, you should not rely on it.")
1914 (defcustom org-tags-column
(if (featurep 'xemacs
) -
79 -
80)
1915 "The column to which tags should be indented in a headline.
1916 If this number is positive, it specifies the column. If it is negative,
1917 it means that the tags should be flushright to that column. For example,
1918 -80 works well for a normal 80 character screen."
1922 (defcustom org-auto-align-tags t
1923 "Non-nil means, realign tags after pro/demotion of TODO state change.
1924 These operations change the length of a headline and therefore shift
1925 the tags around. With this options turned on, after each such operation
1926 the tags are again aligned to `org-tags-column'."
1930 (defcustom org-use-tag-inheritance t
1931 "Non-nil means, tags in levels apply also for sublevels.
1932 When nil, only the tags directly given in a specific line apply there.
1933 This may also be a list of tags that should be inherited, or a regexp that
1934 matches tags that should be inherited. Additional control is possible
1935 with the variable `org-tags-exclude-from-inheritance' which gives an
1936 explicit list of tags to be excluded from inheritance., even if the value of
1937 `org-use-tag-inheritance' would select it for inheritance.
1939 If this option is t, a match early-on in a tree can lead to a large
1940 number of matches in the subtree when constructing the agenda or creating
1941 a sparse tree. If you only want to see the first match in a tree during
1942 a search, check out the variable `org-tags-match-list-sublevels'."
1945 (const :tag
"Not" nil
)
1946 (const :tag
"Always" t
)
1947 (repeat :tag
"Specific tags" (string :tag
"Tag"))
1948 (regexp :tag
"Tags matched by regexp")))
1950 (defcustom org-tags-exclude-from-inheritance nil
1951 "List of tags that should never be inherited.
1952 This is a way to exclude a few tags from inheritance. For way to do
1953 the opposite, to actively allow inheritance for selected tags,
1954 see the variable `org-use-tag-inheritance'."
1956 :type
'(repeat (string :tag
"Tag")))
1958 (defun org-tag-inherit-p (tag)
1959 "Check if TAG is one that should be inherited."
1961 ((member tag org-tags-exclude-from-inheritance
) nil
)
1962 ((eq org-use-tag-inheritance t
) t
)
1963 ((not org-use-tag-inheritance
) nil
)
1964 ((stringp org-use-tag-inheritance
)
1965 (string-match org-use-tag-inheritance tag
))
1966 ((listp org-use-tag-inheritance
)
1967 (member tag org-use-tag-inheritance
))
1968 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
1970 (defcustom org-tags-match-list-sublevels t
1971 "Non-nil means list also sublevels of headlines matching tag search.
1972 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1973 the sublevels of a headline matching a tag search often also match
1974 the same search. Listing all of them can create very long lists.
1975 Setting this variable to nil causes subtrees of a match to be skipped.
1976 This option is off by default, because inheritance in on. If you turn
1977 inheritance off, you very likely want to turn this option on.
1979 As a special case, if the tag search is restricted to TODO items, the
1980 value of this variable is ignored and sublevels are always checked, to
1981 make sure all corresponding TODO items find their way into the list.
1983 This variable is semi-obsolete and probably should always be true. It
1984 is better to limit inheritance to certain tags using the variables
1985 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
1989 (defvar org-tags-history nil
1990 "History of minibuffer reads for tags.")
1991 (defvar org-last-tags-completion-table nil
1992 "The last used completion table for tags.")
1993 (defvar org-after-tags-change-hook nil
1994 "Hook that is run after the tags in a line have changed.")
1996 (defgroup org-properties nil
1997 "Options concerning properties in Org-mode."
1998 :tag
"Org Properties"
2001 (defcustom org-property-format
"%-10s %s"
2002 "How property key/value pairs should be formatted by `indent-line'.
2003 When `indent-line' hits a property definition, it will format the line
2004 according to this format, mainly to make sure that the values are
2005 lined-up with respect to each other."
2006 :group
'org-properties
2009 (defcustom org-use-property-inheritance nil
2010 "Non-nil means, properties apply also for sublevels.
2012 This setting is chiefly used during property searches. Turning it on can
2013 cause significant overhead when doing a search, which is why it is not
2016 When nil, only the properties directly given in the current entry count.
2017 When t, every property is inherited. The value may also be a list of
2018 properties that should have inheritance, or a regular expression matching
2019 properties that should be inherited.
2021 However, note that some special properties use inheritance under special
2022 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2023 and the properties ending in \"_ALL\" when they are used as descriptor
2024 for valid values of a property.
2026 Note for programmers:
2027 When querying an entry with `org-entry-get', you can control if inheritance
2028 should be used. By default, `org-entry-get' looks only at the local
2029 properties. You can request inheritance by setting the inherit argument
2030 to t (to force inheritance) or to `selective' (to respect the setting
2032 :group
'org-properties
2034 (const :tag
"Not" nil
)
2035 (const :tag
"Always" t
)
2036 (repeat :tag
"Specific properties" (string :tag
"Property"))
2037 (regexp :tag
"Properties matched by regexp")))
2039 (defun org-property-inherit-p (property)
2040 "Check if PROPERTY is one that should be inherited."
2042 ((eq org-use-property-inheritance t
) t
)
2043 ((not org-use-property-inheritance
) nil
)
2044 ((stringp org-use-property-inheritance
)
2045 (string-match org-use-property-inheritance property
))
2046 ((listp org-use-property-inheritance
)
2047 (member property org-use-property-inheritance
))
2048 (t (error "Invalid setting of `org-use-property-inheritance'"))))
2050 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
2051 "The default column format, if no other format has been defined.
2052 This variable can be set on the per-file basis by inserting a line
2054 #+COLUMNS: %25ITEM ....."
2055 :group
'org-properties
2058 (defcustom org-columns-ellipses
".."
2059 "The ellipses to be used when a field in column view is truncated.
2060 When this is the empty string, as many characters as possible are shown,
2061 but then there will be no visual indication that the field has been truncated.
2062 When this is a string of length N, the last N characters of a truncated
2063 field are replaced by this string. If the column is narrower than the
2064 ellipses string, only part of the ellipses string will be shown."
2065 :group
'org-properties
2068 (defcustom org-columns-modify-value-for-display-function nil
2069 "Function that modifies values for display in column view.
2070 For example, it can be used to cut out a certain part from a time stamp.
2071 The function must take 2 arguments:
2073 column-title The title of the column (*not* the property name)
2074 value The value that should be modified.
2076 The function should return the value that should be displayed,
2077 or nil if the normal value should be used."
2078 :group
'org-properties
2081 (defcustom org-effort-property
"Effort"
2082 "The property that is being used to keep track of effort estimates.
2083 Effort estimates given in this property need to have the format H:MM."
2084 :group
'org-properties
2085 :group
'org-progress
2086 :type
'(string :tag
"Property"))
2088 (defconst org-global-properties-fixed
2089 '(("VISIBILITY_ALL" .
"folded children content all"))
2090 "List of property/value pairs that can be inherited by any entry.
2091 These are fixed values, for the preset properties.")
2094 (defcustom org-global-properties nil
2095 "List of property/value pairs that can be inherited by any entry.
2096 You can set buffer-local values for the same purpose in the variable
2097 `org-file-properties' this by adding lines like
2099 #+PROPERTY: NAME VALUE"
2100 :group
'org-properties
2102 (cons (string :tag
"Property")
2103 (string :tag
"Value"))))
2105 (defvar org-file-properties nil
2106 "List of property/value pairs that can be inherited by any entry.
2107 Valid for the current buffer.
2108 This variable is populated from #+PROPERTY lines.")
2109 (make-variable-buffer-local 'org-file-properties
)
2111 (defgroup org-agenda nil
2112 "Options concerning agenda views in Org-mode."
2116 (defvar org-category nil
2117 "Variable used by org files to set a category for agenda display.
2118 Such files should use a file variable to set it, for example
2120 # -*- mode: org; org-category: \"ELisp\"
2122 or contain a special line
2126 If the file does not specify a category, then file's base name
2128 (make-variable-buffer-local 'org-category
)
2129 (put 'org-category
'safe-local-variable
'(lambda (x) (or (symbolp x
) (stringp x
))))
2131 (defcustom org-agenda-files nil
2132 "The files to be used for agenda display.
2133 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
2134 \\[org-remove-file]. You can also use customize to edit the list.
2136 If an entry is a directory, all files in that directory that are matched by
2137 `org-agenda-file-regexp' will be part of the file list.
2139 If the value of the variable is not a list but a single file name, then
2140 the list of agenda files is actually stored and maintained in that file, one
2141 agenda file per line."
2144 (repeat :tag
"List of files and directories" file
)
2145 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
2147 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
2148 "Regular expression to match files for `org-agenda-files'.
2149 If any element in the list in that variable contains a directory instead
2150 of a normal file, all files in that directory that are matched by this
2151 regular expression will be included."
2155 (defcustom org-agenda-text-search-extra-files nil
2156 "List of extra files to be searched by text search commands.
2157 These files will be search in addition to the agenda files by the
2158 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2159 Note that these files will only be searched for text search commands,
2160 not for the other agenda views like todo lists, tag searches or the weekly
2161 agenda. This variable is intended to list notes and possibly archive files
2162 that should also be searched by these two commands.
2163 In fact, if the first element in the list is the symbol `agenda-archives',
2164 than all archive files of all agenda files will be added to the search
2167 :type
'(set :greedy t
2168 (const :tag
"Agenda Archives" agenda-archives
)
2169 (repeat :inline t
(file))))
2171 (if (fboundp 'defvaralias
)
2172 (defvaralias 'org-agenda-multi-occur-extra-files
2173 'org-agenda-text-search-extra-files
))
2175 (defcustom org-agenda-skip-unavailable-files nil
2176 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2177 A nil value means to remove them, after a query, from the list."
2181 (defcustom org-calendar-to-agenda-key
[?c
]
2182 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2183 The command `org-calendar-goto-agenda' will be bound to this key. The
2184 default is the character `c' because then `c' can be used to switch back and
2185 forth between agenda and calendar."
2189 (defcustom org-calendar-agenda-action-key
[?k
]
2190 "The key to be installed in `calendar-mode-map' for agenda-action.
2191 The command `org-agenda-action' will be bound to this key. The
2192 default is the character `k' because we use the same key in the agenda."
2196 (eval-after-load "calendar"
2198 (org-defkey calendar-mode-map org-calendar-to-agenda-key
2199 'org-calendar-goto-agenda
)
2200 (org-defkey calendar-mode-map org-calendar-agenda-action-key
2201 'org-agenda-action
)))
2203 (defgroup org-latex nil
2204 "Options for embedding LaTeX code into Org-mode."
2208 (defcustom org-format-latex-options
2209 '(:foreground default
:background default
:scale
1.0
2210 :html-foreground
"Black" :html-background
"Transparent" :html-scale
1.0
2211 :matchers
("begin" "$" "$$" "\\(" "\\["))
2212 "Options for creating images from LaTeX fragments.
2213 This is a property list with the following properties:
2214 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
2215 `default' means use the foreground of the default face.
2216 :background the background color, or \"Transparent\".
2217 `default' means use the background of the default face.
2218 :scale a scaling factor for the size of the images.
2219 :html-foreground, :html-background, :html-scale
2220 the same numbers for HTML export.
2221 :matchers a list indicating which matchers should be used to
2222 find LaTeX fragments. Valid members of this list are:
2223 \"begin\" find environments
2224 \"$\" find math expressions surrounded by $...$
2225 \"$$\" find math expressions surrounded by $$....$$
2226 \"\\(\" find math expressions surrounded by \\(...\\)
2227 \"\\ [\" find math expressions surrounded by \\ [...\\]"
2231 (defcustom org-format-latex-header
"\\documentclass{article}
2232 \\usepackage{fullpage} % do not remove
2233 \\usepackage{amssymb}
2234 \\usepackage[usenames]{color}
2235 \\usepackage{amsmath}
2236 \\usepackage{latexsym}
2237 \\usepackage[mathscr]{eucal}
2238 \\pagestyle{empty} % do not remove"
2239 "The document header used for processing LaTeX fragments."
2244 (defgroup org-font-lock nil
2245 "Font-lock settings for highlighting in Org-mode."
2246 :tag
"Org Font Lock"
2249 (defcustom org-level-color-stars-only nil
2250 "Non-nil means fontify only the stars in each headline.
2251 When nil, the entire headline is fontified.
2252 Changing it requires restart of `font-lock-mode' to become effective
2253 also in regions already fontified."
2254 :group
'org-font-lock
2257 (defcustom org-hide-leading-stars nil
2258 "Non-nil means, hide the first N-1 stars in a headline.
2259 This works by using the face `org-hide' for these stars. This
2260 face is white for a light background, and black for a dark
2261 background. You may have to customize the face `org-hide' to
2263 Changing it requires restart of `font-lock-mode' to become effective
2264 also in regions already fontified.
2265 You may also set this on a per-file basis by adding one of the following
2266 lines to the buffer:
2268 #+STARTUP: hidestars
2269 #+STARTUP: showstars"
2270 :group
'org-font-lock
2273 (defcustom org-fontify-done-headline nil
2274 "Non-nil means, change the face of a headline if it is marked DONE.
2275 Normally, only the TODO/DONE keyword indicates the state of a headline.
2276 When this is non-nil, the headline after the keyword is set to the
2277 `org-headline-done' as an additional indication."
2278 :group
'org-font-lock
2281 (defcustom org-fontify-emphasized-text t
2282 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2283 Changing this variable requires a restart of Emacs to take effect."
2284 :group
'org-font-lock
2287 (defcustom org-highlight-latex-fragments-and-specials nil
2288 "Non-nil means, fontify what is treated specially by the exporters."
2289 :group
'org-font-lock
2292 (defcustom org-hide-emphasis-markers nil
2293 "Non-nil mean font-lock should hide the emphasis marker characters."
2294 :group
'org-font-lock
2297 (defvar org-emph-re nil
2298 "Regular expression for matching emphasis.")
2299 (defvar org-verbatim-re nil
2300 "Regular expression for matching verbatim text.")
2301 (defvar org-emphasis-regexp-components
) ; defined just below
2302 (defvar org-emphasis-alist
) ; defined just below
2303 (defun org-set-emph-re (var val
)
2304 "Set variable and compute the emphasis regular expression."
2306 (when (and (boundp 'org-emphasis-alist
)
2307 (boundp 'org-emphasis-regexp-components
)
2308 org-emphasis-alist org-emphasis-regexp-components
)
2309 (let* ((e org-emphasis-regexp-components
)
2315 (stacked (and nil
(nth 5 e
))) ; stacked is no longer allowed, forced to nil
2316 (body1 (concat body
"*?"))
2317 (markers (mapconcat 'car org-emphasis-alist
""))
2318 (vmarkers (mapconcat
2319 (lambda (x) (if (eq (nth 4 x
) 'verbatim
) (car x
) ""))
2320 org-emphasis-alist
"")))
2321 ;; make sure special characters appear at the right position in the class
2322 (if (string-match "\\^" markers
)
2323 (setq markers
(concat (replace-match "" t t markers
) "^")))
2324 (if (string-match "-" markers
)
2325 (setq markers
(concat (replace-match "" t t markers
) "-")))
2326 (if (string-match "\\^" vmarkers
)
2327 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
2328 (if (string-match "-" vmarkers
)
2329 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
2331 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
2332 (int-to-string nl
) "\\}")))
2335 (concat "\\([" pre
(if (and nil stacked
) markers
) "]\\|^\\)"
2337 "\\([" markers
"]\\)"
2340 "[^" border
(if (and nil stacked
) markers
) "]"
2342 "[^" border
(if (and nil stacked
) markers
) "]"
2345 "\\([" post
(if (and nil stacked
) markers
) "]\\|$\\)"))
2346 (setq org-verbatim-re
2347 (concat "\\([" pre
"]\\|^\\)"
2349 "\\([" vmarkers
"]\\)"
2357 "\\([" post
"]\\|$\\)")))))
2359 (defcustom org-emphasis-regexp-components
2360 '(" \t('\"" "- \t.,:?;'\")" " \t\r\n,\"'" "." 1)
2361 "Components used to build the regular expression for emphasis.
2362 This is a list with 6 entries. Terminology: In an emphasis string
2363 like \" *strong word* \", we call the initial space PREMATCH, the final
2364 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
2365 and \"trong wor\" is the body. The different components in this variable
2366 specify what is allowed/forbidden in each part:
2368 pre Chars allowed as prematch. Beginning of line will be allowed too.
2369 post Chars allowed as postmatch. End of line will be allowed too.
2370 border The chars *forbidden* as border characters.
2371 body-regexp A regexp like \".\" to match a body character. Don't use
2372 non-shy groups here, and don't allow newline here.
2373 newline The maximum number of newlines allowed in an emphasis exp.
2375 Use customize to modify this, or restart Emacs after changing it."
2376 :group
'org-font-lock
2377 :set
'org-set-emph-re
2379 (sexp :tag
"Allowed chars in pre ")
2380 (sexp :tag
"Allowed chars in post ")
2381 (sexp :tag
"Forbidden chars in border ")
2382 (sexp :tag
"Regexp for body ")
2383 (integer :tag
"number of newlines allowed")
2384 (option (boolean :tag
"Please ignore this button"))))
2386 (defcustom org-emphasis-alist
2387 `(("*" bold
"<b>" "</b>")
2388 ("/" italic
"<i>" "</i>")
2389 ("_" underline
"<span style=\"text-decoration:underline;\">" "</span>")
2390 ("=" org-code
"<code>" "</code>" verbatim
)
2391 ("~" org-verbatim
"<code>" "</code>" verbatim
)
2392 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))
2395 "Special syntax for emphasized text.
2396 Text starting and ending with a special character will be emphasized, for
2397 example *bold*, _underlined_ and /italic/. This variable sets the marker
2398 characters, the face to be used by font-lock for highlighting in Org-mode
2399 Emacs buffers, and the HTML tags to be used for this.
2400 Use customize to modify this, or restart Emacs after changing it."
2401 :group
'org-font-lock
2402 :set
'org-set-emph-re
2405 (string :tag
"Marker character")
2407 (face :tag
"Font-lock-face")
2408 (plist :tag
"Face property list"))
2409 (string :tag
"HTML start tag")
2410 (string :tag
"HTML end tag")
2411 (option (const verbatim
)))))
2413 ;;; Miscellaneous options
2415 (defgroup org-completion nil
2416 "Completion in Org-mode."
2417 :tag
"Org Completion"
2420 (defcustom org-completion-use-ido nil
2421 "Non-nil means, use ido completion wherever possible."
2422 :group
'org-completion
2425 (defcustom org-completion-fallback-command
'hippie-expand
2426 "The expansion command called by \\[org-complete] in normal context.
2427 Normal means, no org-mode-specific context."
2428 :group
'org-completion
2431 ;;; Functions and variables from ther packages
2432 ;; Declared here to avoid compiler warnings
2435 (defvar outline-mode-menu-heading
)
2436 (defvar outline-mode-menu-show
)
2437 (defvar outline-mode-menu-hide
)
2438 (defvar zmacs-regions
) ; XEmacs regions
2441 (defvar mark-active
)
2444 (declare-function calendar-absolute-from-iso
"cal-iso" (date))
2445 (declare-function calendar-forward-day
"cal-move" (arg))
2446 (declare-function calendar-goto-date
"cal-move" (date))
2447 (declare-function calendar-goto-today
"cal-move" ())
2448 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
2449 (defvar calc-embedded-close-formula
)
2450 (defvar calc-embedded-open-formula
)
2451 (declare-function cdlatex-tab
"ext:cdlatex" ())
2452 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
2453 (defvar font-lock-unfontify-region-function
)
2454 (declare-function iswitchb-mode
"iswitchb" (&optional arg
))
2455 (declare-function iswitchb-read-buffer
(prompt &optional default require-match start matches-set
))
2456 (defvar iswitchb-temp-buflist
)
2457 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
2458 (declare-function org-agenda-skip
"org-agenda" ())
2459 (declare-function org-format-agenda-item
"org-agenda"
2460 (extra txt
&optional category tags dotime noprefix remove-re
))
2461 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
2462 (declare-function org-agenda-change-all-lines
"org-agenda"
2463 (newhead hdmarker
&optional fixface just-this
))
2464 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
2465 (declare-function org-agenda-maybe-redo
"org-agenda" ())
2466 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
2468 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
2469 (declare-function parse-time-string
"parse-time" (string))
2470 (declare-function remember
"remember" (&optional initial
))
2471 (declare-function remember-buffer-desc
"remember" ())
2472 (declare-function remember-finalize
"remember" ())
2473 (defvar remember-save-after-remembering
)
2474 (defvar remember-data-file
)
2475 (defvar remember-register
)
2476 (defvar remember-buffer
)
2477 (defvar remember-handler-functions
)
2478 (defvar remember-annotation-functions
)
2479 (defvar texmathp-why
)
2480 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
2481 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
2483 (defvar w3m-current-url
)
2484 (defvar w3m-current-title
)
2486 (defvar org-latex-regexps
)
2488 ;;; Autoload and prepare some org modules
2490 ;; Some table stuff that needs to be defined here, because it is used
2491 ;; by the functions setting up org-mode or checking for table context.
2493 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
2494 "Detects an org-type or table-type table.")
2495 (defconst org-table-line-regexp
"^[ \t]*|"
2496 "Detects an org-type table line.")
2497 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
2498 "Detects an org-type table line.")
2499 (defconst org-table-hline-regexp
"^[ \t]*|-"
2500 "Detects an org-type table hline.")
2501 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
2502 "Detects a table-type table hline.")
2503 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
2504 "Searching from within a table (any type) this finds the first line
2505 outside the table.")
2507 ;; Autoload the functions in org-table.el that are needed by functions here.
2510 (org-autoload "org-table"
2511 '(org-table-align org-table-begin org-table-blank-field
2512 org-table-convert org-table-convert-region org-table-copy-down
2513 org-table-copy-region org-table-create
2514 org-table-create-or-convert-from-region
2515 org-table-create-with-table.el org-table-current-dline
2516 org-table-cut-region org-table-delete-column org-table-edit-field
2517 org-table-edit-formulas org-table-end org-table-eval-formula
2518 org-table-export org-table-field-info
2519 org-table-get-stored-formulas org-table-goto-column
2520 org-table-hline-and-move org-table-import org-table-insert-column
2521 org-table-insert-hline org-table-insert-row org-table-iterate
2522 org-table-justify-field-maybe org-table-kill-row
2523 org-table-maybe-eval-formula org-table-maybe-recalculate-line
2524 org-table-move-column org-table-move-column-left
2525 org-table-move-column-right org-table-move-row
2526 org-table-move-row-down org-table-move-row-up
2527 org-table-next-field org-table-next-row org-table-paste-rectangle
2528 org-table-previous-field org-table-recalculate
2529 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
2530 org-table-toggle-coordinate-overlays
2531 org-table-toggle-formula-debugger org-table-wrap-region
2532 orgtbl-mode turn-on-orgtbl org-table-to-lisp
)))
2534 (defun org-at-table-p (&optional table-type
)
2535 "Return t if the cursor is inside an org-type table.
2536 If TABLE-TYPE is non-nil, also check for table.el-type tables."
2537 (if org-enable-table-editor
2539 (beginning-of-line 1)
2540 (looking-at (if table-type org-table-any-line-regexp
2541 org-table-line-regexp
)))
2543 (defsubst org-table-p
() (org-at-table-p))
2545 (defun org-at-table.el-p
()
2546 "Return t if and only if we are at a table.el table."
2547 (and (org-at-table-p 'any
)
2549 (goto-char (org-table-begin 'any
))
2550 (looking-at org-table1-hline-regexp
))))
2551 (defun org-table-recognize-table.el
()
2552 "If there is a table.el table nearby, recognize it and move into it."
2553 (if org-table-tab-recognizes-table.el
2554 (if (org-at-table.el-p
)
2556 (beginning-of-line 1)
2557 (if (looking-at org-table-dataline-regexp
)
2559 (if (looking-at org-table1-hline-regexp
)
2561 (beginning-of-line 2)
2562 (if (looking-at org-table-any-border-regexp
)
2563 (beginning-of-line -
1)))))
2564 (if (re-search-forward "|" (org-table-end t
) t
)
2567 (if (table--at-cell-p (point))
2569 (message "recognizing table.el table...")
2570 (table-recognize-table)
2571 (message "recognizing table.el table...done")))
2572 (error "This should not happen..."))
2577 (defun org-at-table-hline-p ()
2578 "Return t if the cursor is inside a hline in a table."
2579 (if org-enable-table-editor
2581 (beginning-of-line 1)
2582 (looking-at org-table-hline-regexp
))
2585 (defvar org-table-clean-did-remove-column nil
)
2587 (defun org-table-map-tables (function)
2588 "Apply FUNCTION to the start of all tables in the buffer."
2592 (goto-char (point-min))
2593 (while (re-search-forward org-table-any-line-regexp nil t
)
2594 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
2595 (beginning-of-line 1)
2596 (if (looking-at org-table-line-regexp
)
2597 (save-excursion (funcall function
)))
2598 (re-search-forward org-table-any-border-regexp nil
1))))
2599 (message "Mapping tables: done"))
2601 ;; Declare and autoload functions from org-exp.el
2603 (declare-function org-default-export-plist
"org-exp")
2604 (declare-function org-infile-export-plist
"org-exp")
2605 (declare-function org-get-current-options
"org-exp")
2607 (org-autoload "org-exp"
2608 '(org-export org-export-as-ascii org-export-visible
2609 org-insert-export-options-template org-export-as-html-and-open
2610 org-export-as-html-batch org-export-as-html-to-buffer
2611 org-replace-region-by-html org-export-region-as-html
2612 org-export-as-html org-export-icalendar-this-file
2613 org-export-icalendar-all-agenda-files
2614 org-table-clean-before-export
2615 org-export-icalendar-combine-agenda-files org-export-as-xoxo
)))
2617 ;; Declare and autoload functions from org-agenda.el
2620 (org-autoload "org-agenda"
2621 '(org-agenda org-agenda-list org-search-view
2622 org-todo-list org-tags-view org-agenda-list-stuck-projects
2623 org-diary org-agenda-to-appt
)))
2625 ;; Autoload org-remember
2628 (org-autoload "org-remember"
2629 '(org-remember-insinuate org-remember-annotation
2630 org-remember-apply-template org-remember org-remember-handler
)))
2632 ;; Autoload org-clock.el
2635 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock"
2637 (declare-function org-update-mode-line
"org-clock" ())
2638 (defvar org-clock-start-time
)
2639 (defvar org-clock-marker
(make-marker)
2640 "Marker recording the last clock-in.")
2645 '(org-clock-in org-clock-out org-clock-cancel
2646 org-clock-goto org-clock-sum org-clock-display
2647 org-remove-clock-overlays org-clock-report
2648 org-clocktable-shift org-dblock-write
:clocktable
2649 org-get-clocktable
)))
2651 (defun org-clock-update-time-maybe ()
2652 "If this is a CLOCK line, update it and return t.
2653 Otherwise, return nil."
2656 (beginning-of-line 1)
2657 (skip-chars-forward " \t")
2658 (when (looking-at org-clock-string
)
2659 (let ((re (concat "[ \t]*" org-clock-string
2660 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2661 "\\([ \t]*=>.*\\)?\\)?"))
2664 ((not (looking-at re
))
2666 ((not (match-end 2))
2667 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2668 (> org-clock-marker
(point))
2669 (<= org-clock-marker
(point-at-eol)))
2670 ;; The clock is running here
2671 (setq org-clock-start-time
2673 (org-parse-time-string (match-string 1))))
2674 (org-update-mode-line)))
2676 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2678 (setq ts
(match-string 1)
2679 te
(match-string 3))
2680 (setq s
(- (time-to-seconds
2681 (apply 'encode-time
(org-parse-time-string te
)))
2683 (apply 'encode-time
(org-parse-time-string ts
))))
2686 h
(floor (/ s
3600))
2690 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2693 (defun org-check-running-clock ()
2694 "Check if the current buffer contains the running clock.
2695 If yes, offer to stop it and to save the buffer with the changes."
2696 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2697 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
2700 (when (y-or-n-p "Save changed buffer?")
2703 (defun org-clocktable-try-shift (dir n
)
2704 "Check if this line starts a clock table, if yes, shift the time block."
2705 (when (org-match-line "#\\+BEGIN: clocktable\\>")
2706 (org-clocktable-shift dir n
)))
2708 ;; Autoload org-timer.el
2710 ;(declare-function org-timer "org-timer")
2715 '(org-timer-start org-timer org-timer-item
2716 org-timer-change-times-in-region
)))
2719 ;; Autoload archiving code
2720 ;; The stuff that is needed for cycling and tags has to be defined here.
2722 (defgroup org-archive nil
2723 "Options concerning archiving in Org-mode."
2725 :group
'org-structure
)
2727 (defcustom org-archive-location
"%s_archive::"
2728 "The location where subtrees should be archived.
2730 The value of this variable is a string, consisting of two parts,
2731 separated by a double-colon. The first part is a filename and
2732 the second part is a headline.
2734 When the filename is omitted, archiving happens in the same file.
2735 %s in the filename will be replaced by the current file
2736 name (without the directory part). Archiving to a different file
2737 is useful to keep archived entries from contributing to the
2740 The archived entries will be filed as subtrees of the specified
2741 headline. When the headline is omitted, the subtrees are simply
2742 filed away at the end of the file, as top-level entries.
2744 Here are a few examples:
2746 If the current file is Projects.org, archive in file
2747 Projects.org_archive, as top-level trees. This is the default.
2749 \"::* Archived Tasks\"
2750 Archive in the current file, under the top-level headline
2751 \"* Archived Tasks\".
2753 \"~/org/archive.org::\"
2754 Archive in file ~/org/archive.org (absolute path), as top-level trees.
2756 \"basement::** Finished Tasks\"
2757 Archive in file ./basement (relative path), as level 3 trees
2758 below the level 2 heading \"** Finished Tasks\".
2760 You may set this option on a per-file basis by adding to the buffer a
2763 #+ARCHIVE: basement::** Finished Tasks
2765 You may also define it locally for a subtree by setting an ARCHIVE property
2766 in the entry. If such a property is found in an entry, or anywhere up
2767 the hierarchy, it will be used."
2771 (defcustom org-archive-tag
"ARCHIVE"
2772 "The tag that marks a subtree as archived.
2773 An archived subtree does not open during visibility cycling, and does
2774 not contribute to the agenda listings.
2775 After changing this, font-lock must be restarted in the relevant buffers to
2776 get the proper fontification."
2778 :group
'org-keywords
2781 (defcustom org-agenda-skip-archived-trees t
2782 "Non-nil means, the agenda will skip any items located in archived trees.
2783 An archived tree is a tree marked with the tag ARCHIVE. The use of this
2784 variable is no longer recommended, you should leave it at the value t.
2785 Instead, use the key `v' to cycle the archives-mode in the agenda."
2787 :group
'org-agenda-skip
2790 (defcustom org-cycle-open-archived-trees nil
2791 "Non-nil means, `org-cycle' will open archived trees.
2792 An archived tree is a tree marked with the tag ARCHIVE.
2793 When nil, archived trees will stay folded. You can still open them with
2794 normal outline commands like `show-all', but not with the cycling commands."
2799 (defcustom org-sparse-tree-open-archived-trees nil
2800 "Non-nil means sparse tree construction shows matches in archived trees.
2801 When nil, matches in these trees are highlighted, but the trees are kept in
2804 :group
'org-sparse-trees
2807 (defun org-cycle-hide-archived-subtrees (state)
2808 "Re-hide all archived subtrees after a visibility state change."
2809 (when (and (not org-cycle-open-archived-trees
)
2810 (not (memq state
'(overview folded
))))
2812 (let* ((globalp (memq state
'(contents all
)))
2813 (beg (if globalp
(point-min) (point)))
2814 (end (if globalp
(point-max) (org-end-of-subtree t
))))
2815 (org-hide-archived-subtrees beg end
)
2817 (if (looking-at (concat ".*:" org-archive-tag
":"))
2818 (message "%s" (substitute-command-keys
2819 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
2821 (defun org-force-cycle-archived ()
2822 "Cycle subtree even if it is archived."
2824 (setq this-command
'org-cycle
)
2825 (let ((org-cycle-open-archived-trees t
))
2826 (call-interactively 'org-cycle
)))
2828 (defun org-hide-archived-subtrees (beg end
)
2829 "Re-hide all archived subtrees after a visibility state change."
2831 (let* ((re (concat ":" org-archive-tag
":")))
2833 (while (re-search-forward re end t
)
2834 (and (org-on-heading-p) (hide-subtree))
2835 (org-end-of-subtree t
)))))
2837 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
2840 (org-autoload "org-archive"
2841 '(org-add-archive-files org-archive-subtree
2842 org-archive-to-archive-sibling org-toggle-archive-tag
)))
2844 ;; Autoload Column View Code
2846 (declare-function org-columns-number-to-string
"org-colview")
2847 (declare-function org-columns-get-format-and-top-level
"org-colview")
2848 (declare-function org-columns-compute
"org-colview")
2850 (org-autoload (if (featurep 'xemacs
) "org-colview-xemacs" "org-colview")
2851 '(org-columns-number-to-string org-columns-get-format-and-top-level
2852 org-columns-compute org-agenda-columns org-columns-remove-overlays
2853 org-columns org-insert-columns-dblock org-dblock-write
:columnview
))
2857 (declare-function org-id-store-link
"org-id")
2858 (org-autoload "org-id"
2859 '(org-id-get-create org-id-new org-id-copy org-id-get
2860 org-id-get-with-outline-path-completion
2861 org-id-get-with-outline-drilling
2862 org-id-goto org-id-find org-id-store-link
))
2864 ;;; Variables for pre-computed regular expressions, all buffer local
2866 (defvar org-drawer-regexp nil
2867 "Matches first line of a hidden block.")
2868 (make-variable-buffer-local 'org-drawer-regexp
)
2869 (defvar org-todo-regexp nil
2870 "Matches any of the TODO state keywords.")
2871 (make-variable-buffer-local 'org-todo-regexp
)
2872 (defvar org-not-done-regexp nil
2873 "Matches any of the TODO state keywords except the last one.")
2874 (make-variable-buffer-local 'org-not-done-regexp
)
2875 (defvar org-todo-line-regexp nil
2876 "Matches a headline and puts TODO state into group 2 if present.")
2877 (make-variable-buffer-local 'org-todo-line-regexp
)
2878 (defvar org-complex-heading-regexp nil
2879 "Matches a headline and puts everything into groups:
2881 group 2: The todo keyword, maybe
2882 group 3: Priority cookie
2883 group 4: True headline
2885 (make-variable-buffer-local 'org-complex-heading-regexp
)
2886 (defvar org-todo-line-tags-regexp nil
2887 "Matches a headline and puts TODO state into group 2 if present.
2888 Also put tags into group 4 if tags are present.")
2889 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
2890 (defvar org-nl-done-regexp nil
2891 "Matches newline followed by a headline with the DONE keyword.")
2892 (make-variable-buffer-local 'org-nl-done-regexp
)
2893 (defvar org-looking-at-done-regexp nil
2894 "Matches the DONE keyword a point.")
2895 (make-variable-buffer-local 'org-looking-at-done-regexp
)
2896 (defvar org-ds-keyword-length
12
2897 "Maximum length of the Deadline and SCHEDULED keywords.")
2898 (make-variable-buffer-local 'org-ds-keyword-length
)
2899 (defvar org-deadline-regexp nil
2900 "Matches the DEADLINE keyword.")
2901 (make-variable-buffer-local 'org-deadline-regexp
)
2902 (defvar org-deadline-time-regexp nil
2903 "Matches the DEADLINE keyword together with a time stamp.")
2904 (make-variable-buffer-local 'org-deadline-time-regexp
)
2905 (defvar org-deadline-line-regexp nil
2906 "Matches the DEADLINE keyword and the rest of the line.")
2907 (make-variable-buffer-local 'org-deadline-line-regexp
)
2908 (defvar org-scheduled-regexp nil
2909 "Matches the SCHEDULED keyword.")
2910 (make-variable-buffer-local 'org-scheduled-regexp
)
2911 (defvar org-scheduled-time-regexp nil
2912 "Matches the SCHEDULED keyword together with a time stamp.")
2913 (make-variable-buffer-local 'org-scheduled-time-regexp
)
2914 (defvar org-closed-time-regexp nil
2915 "Matches the CLOSED keyword together with a time stamp.")
2916 (make-variable-buffer-local 'org-closed-time-regexp
)
2918 (defvar org-keyword-time-regexp nil
2919 "Matches any of the 4 keywords, together with the time stamp.")
2920 (make-variable-buffer-local 'org-keyword-time-regexp
)
2921 (defvar org-keyword-time-not-clock-regexp nil
2922 "Matches any of the 3 keywords, together with the time stamp.")
2923 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp
)
2924 (defvar org-maybe-keyword-time-regexp nil
2925 "Matches a timestamp, possibly preceeded by a keyword.")
2926 (make-variable-buffer-local 'org-maybe-keyword-time-regexp
)
2927 (defvar org-planning-or-clock-line-re nil
2928 "Matches a line with planning or clock info.")
2929 (make-variable-buffer-local 'org-planning-or-clock-line-re
)
2931 (defconst org-plain-time-of-day-regexp
2934 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
2937 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
2939 "Regular expression to match a plain time or time range.
2940 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
2941 groups carry important information:
2943 1 the first time, range or not
2944 8 the second time, if it is a range.")
2946 (defconst org-plain-time-extension-regexp
2949 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
2950 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
2951 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
2952 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
2953 groups carry important information:
2956 9 minutes of duration")
2958 (defconst org-stamp-time-of-day-regexp
2960 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
2961 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
2963 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
2964 "Regular expression to match a timestamp time or time range.
2965 After a match, the following groups carry important information:
2967 1 date plus weekday, for backreferencing to make sure both times on same day
2968 2 the first time, range or not
2969 4 the second time, if it is a range.")
2971 (defconst org-startup-options
2972 '(("fold" org-startup-folded t
)
2973 ("overview" org-startup-folded t
)
2974 ("nofold" org-startup-folded nil
)
2975 ("showall" org-startup-folded nil
)
2976 ("content" org-startup-folded content
)
2977 ("hidestars" org-hide-leading-stars t
)
2978 ("showstars" org-hide-leading-stars nil
)
2979 ("odd" org-odd-levels-only t
)
2980 ("oddeven" org-odd-levels-only nil
)
2981 ("align" org-startup-align-all-tables t
)
2982 ("noalign" org-startup-align-all-tables nil
)
2983 ("customtime" org-display-custom-times t
)
2984 ("logdone" org-log-done time
)
2985 ("lognotedone" org-log-done note
)
2986 ("nologdone" org-log-done nil
)
2987 ("lognoteclock-out" org-log-note-clock-out t
)
2988 ("nolognoteclock-out" org-log-note-clock-out nil
)
2989 ("logrepeat" org-log-repeat state
)
2990 ("lognoterepeat" org-log-repeat note
)
2991 ("nologrepeat" org-log-repeat nil
)
2992 ("constcgs" constants-unit-system cgs
)
2993 ("constSI" constants-unit-system SI
))
2994 "Variable associated with STARTUP options for org-mode.
2995 Each element is a list of three items: The startup options as written
2996 in the #+STARTUP line, the corresponding variable, and the value to
2997 set this variable to if the option is found. An optional forth element PUSH
2998 means to push this value onto the list in the variable.")
3000 (defun org-set-regexps-and-options ()
3001 "Precompute regular expressions for current buffer."
3003 (org-set-local 'org-todo-kwd-alist nil
)
3004 (org-set-local 'org-todo-key-alist nil
)
3005 (org-set-local 'org-todo-key-trigger nil
)
3006 (org-set-local 'org-todo-keywords-1 nil
)
3007 (org-set-local 'org-done-keywords nil
)
3008 (org-set-local 'org-todo-heads nil
)
3009 (org-set-local 'org-todo-sets nil
)
3010 (org-set-local 'org-todo-log-states nil
)
3011 (org-set-local 'org-file-properties nil
)
3012 (org-set-local 'org-file-tags nil
)
3013 (let ((re (org-make-options-regexp
3014 '("CATEGORY" "SEQ_TODO" "TYP_TODO" "TODO" "COLUMNS"
3015 "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
3016 "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE")))
3018 kwds kws0 kwsa key log value cat arch tags const links hw dws
3019 tail sep kws1 prio props ftags drawers
3020 ext-setup-or-nil setup-contents
(start 0))
3024 (goto-char (point-min))
3025 (while (or (and ext-setup-or-nil
3026 (string-match re ext-setup-or-nil start
)
3027 (setq start
(match-end 0)))
3028 (and (setq ext-setup-or-nil nil start
0)
3029 (re-search-forward re nil t
)))
3030 (setq key
(upcase (match-string 1 ext-setup-or-nil
))
3031 value
(org-match-string-no-properties 2 ext-setup-or-nil
))
3033 ((equal key
"CATEGORY")
3034 (if (string-match "[ \t]+$" value
)
3035 (setq value
(replace-match "" t t value
)))
3037 ((member key
'("SEQ_TODO" "TODO"))
3038 (push (cons 'sequence
(org-split-string value splitre
)) kwds
))
3039 ((equal key
"TYP_TODO")
3040 (push (cons 'type
(org-split-string value splitre
)) kwds
))
3042 (setq tags
(append tags
(org-split-string value splitre
))))
3043 ((equal key
"COLUMNS")
3044 (org-set-local 'org-columns-default-format value
))
3046 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
3047 (push (cons (match-string 1 value
)
3048 (org-trim (match-string 2 value
)))
3050 ((equal key
"PRIORITIES")
3051 (setq prio
(org-split-string value
" +")))
3052 ((equal key
"PROPERTY")
3053 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value
)
3054 (push (cons (match-string 1 value
) (match-string 2 value
))
3056 ((equal key
"FILETAGS")
3057 (when (string-match "\\S-" value
)
3062 (mapcar (lambda (x) (org-split-string x
":"))
3063 (org-split-string value
)))))))
3064 ((equal key
"DRAWERS")
3065 (setq drawers
(org-split-string value splitre
)))
3066 ((equal key
"CONSTANTS")
3067 (setq const
(append const
(org-split-string value splitre
))))
3068 ((equal key
"STARTUP")
3069 (let ((opts (org-split-string value splitre
))
3071 (while (setq l
(pop opts
))
3072 (when (setq l
(assoc l org-startup-options
))
3073 (setq var
(nth 1 l
) val
(nth 2 l
))
3075 (set (make-local-variable var
) val
)
3076 (if (not (listp (symbol-value var
)))
3077 (set (make-local-variable var
) nil
))
3078 (set (make-local-variable var
) (symbol-value var
))
3079 (add-to-list var val
))))))
3080 ((equal key
"ARCHIVE")
3081 (string-match " *$" value
)
3082 (setq arch
(replace-match "" t t value
))
3083 (remove-text-properties 0 (length arch
)
3084 '(face t fontified t
) arch
))
3085 ((equal key
"SETUPFILE")
3086 (setq setup-contents
(org-file-contents
3088 (org-remove-double-quotes value
))
3090 (if (not ext-setup-or-nil
)
3091 (setq ext-setup-or-nil setup-contents start
0)
3092 (setq ext-setup-or-nil
3093 (concat (substring ext-setup-or-nil
0 start
)
3094 "\n" setup-contents
"\n"
3095 (substring ext-setup-or-nil start
)))))
3098 (org-set-local 'org-category
(intern cat
))
3099 (push (cons "CATEGORY" cat
) props
))
3101 (if (< (length prio
) 3) (setq prio
'("A" "C" "B")))
3102 (setq prio
(mapcar 'string-to-char prio
))
3103 (org-set-local 'org-highest-priority
(nth 0 prio
))
3104 (org-set-local 'org-lowest-priority
(nth 1 prio
))
3105 (org-set-local 'org-default-priority
(nth 2 prio
)))
3106 (and props
(org-set-local 'org-file-properties
(nreverse props
)))
3107 (and ftags
(org-set-local 'org-file-tags ftags
))
3108 (and drawers
(org-set-local 'org-drawers drawers
))
3109 (and arch
(org-set-local 'org-archive-location arch
))
3110 (and links
(setq org-link-abbrev-alist-local
(nreverse links
)))
3111 ;; Process the TODO keywords
3113 ;; Use the global values as if they had been given locally.
3114 (setq kwds
(default-value 'org-todo-keywords
))
3115 (if (stringp (car kwds
))
3116 (setq kwds
(list (cons org-todo-interpretation
3117 (default-value 'org-todo-keywords
)))))
3118 (setq kwds
(reverse kwds
)))
3119 (setq kwds
(nreverse kwds
))
3121 (while (setq kws
(pop kwds
))
3122 (setq inter
(pop kws
) sep
(member "|" kws
)
3123 kws0
(delete "|" (copy-sequence kws
))
3128 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x
)
3130 (setq kw
(match-string 1 x
)
3131 key
(and (match-end 2) (match-string 2 x
))
3132 log
(org-extract-log-state-settings x
))
3133 (push (cons kw
(and key
(string-to-char key
))) kwsa
)
3134 (and log
(push log org-todo-log-states
))
3136 (error "Invalid TODO keyword %s" x
)))
3138 kwsa
(if kwsa
(append '((:startgroup
))
3142 dws
(if sep
(org-remove-keyword-keys (cdr sep
)) (last kws1
))
3143 tail
(list inter hw
(car dws
) (org-last dws
)))
3144 (add-to-list 'org-todo-heads hw
'append
)
3145 (push kws1 org-todo-sets
)
3146 (setq org-done-keywords
(append org-done-keywords dws nil
))
3147 (setq org-todo-key-alist
(append org-todo-key-alist kwsa
))
3148 (mapc (lambda (x) (push (cons x tail
) org-todo-kwd-alist
)) kws1
)
3149 (setq org-todo-keywords-1
(append org-todo-keywords-1 kws1 nil
)))
3150 (setq org-todo-sets
(nreverse org-todo-sets
)
3151 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
3152 org-todo-key-trigger
(delq nil
(mapcar 'cdr org-todo-key-alist
))
3153 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
)))
3154 ;; Process the constants
3157 (while (setq e
(pop const
))
3158 (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e
)
3159 (push (cons (match-string 1 e
) (match-string 2 e
)) cst
)))
3160 (setq org-table-formula-constants-local cst
)))
3162 ;; Process the tags.
3165 (while (setq e
(pop tags
))
3167 ((equal e
"{") (push '(:startgroup
) tgs
))
3168 ((equal e
"}") (push '(:endgroup
) tgs
))
3169 ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e
)
3170 (push (cons (match-string 1 e
)
3171 (string-to-char (match-string 2 e
)))
3173 (t (push (list e
) tgs
))))
3174 (org-set-local 'org-tag-alist nil
)
3175 (while (setq e
(pop tgs
))
3176 (or (and (stringp (car e
))
3177 (assoc (car e
) org-tag-alist
))
3178 (push e org-tag-alist
)))))
3180 ;; Compute the regular expressions and other local variables
3181 (if (not org-done-keywords
)
3182 (setq org-done-keywords
(list (org-last org-todo-keywords-1
))))
3183 (setq org-ds-keyword-length
(+ 2 (max (length org-deadline-string
)
3184 (length org-scheduled-string
)
3185 (length org-clock-string
)
3186 (length org-closed-string
)))
3188 (concat "^[ \t]*:\\("
3189 (mapconcat 'regexp-quote org-drawers
"\\|")
3191 org-not-done-keywords
3192 (org-delete-all org-done-keywords
(copy-sequence org-todo-keywords-1
))
3194 (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
3198 (mapconcat 'regexp-quote org-not-done-keywords
"\\|")
3200 org-todo-line-regexp
3201 (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
3202 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
3203 "\\)\\>\\)?[ \t]*\\(.*\\)")
3204 org-complex-heading-regexp
3205 (concat "^\\(\\*+\\)\\(?:[ \t]+\\("
3206 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
3207 "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
3208 "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
3210 (concat "\n\\*+[ \t]+"
3211 "\\(?:" (mapconcat 'regexp-quote org-done-keywords
"\\|")
3213 org-todo-line-tags-regexp
3214 (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
3215 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
3217 "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
3218 org-looking-at-done-regexp
3220 (mapconcat 'regexp-quote org-done-keywords
"\\|") "\\)"
3222 org-deadline-regexp
(concat "\\<" org-deadline-string
)
3223 org-deadline-time-regexp
3224 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
3225 org-deadline-line-regexp
3226 (concat "\\<\\(" org-deadline-string
"\\).*")
3227 org-scheduled-regexp
3228 (concat "\\<" org-scheduled-string
)
3229 org-scheduled-time-regexp
3230 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
3231 org-closed-time-regexp
3232 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
3233 org-keyword-time-regexp
3234 (concat "\\<\\(" org-scheduled-string
3235 "\\|" org-deadline-string
3236 "\\|" org-closed-string
3237 "\\|" org-clock-string
"\\)"
3238 " *[[<]\\([^]>]+\\)[]>]")
3239 org-keyword-time-not-clock-regexp
3240 (concat "\\<\\(" org-scheduled-string
3241 "\\|" org-deadline-string
3242 "\\|" org-closed-string
3244 " *[[<]\\([^]>]+\\)[]>]")
3245 org-maybe-keyword-time-regexp
3246 (concat "\\(\\<\\(" org-scheduled-string
3247 "\\|" org-deadline-string
3248 "\\|" org-closed-string
3249 "\\|" org-clock-string
"\\)\\)?"
3250 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
3251 org-planning-or-clock-line-re
3252 (concat "\\(?:^[ \t]*\\(" org-scheduled-string
3253 "\\|" org-deadline-string
3254 "\\|" org-closed-string
"\\|" org-clock-string
3257 (org-compute-latex-and-specials-regexp)
3258 (org-set-font-lock-defaults))))
3260 (defun org-file-contents (file &optional noerror
)
3261 "Return the contents of FILE, as a string."
3263 (not (file-readable-p file
)))
3266 (message "Cannot read file %s" file
)
3269 (error "Cannot read file %s" file
))
3271 (insert-file-contents file
)
3274 (defun org-extract-log-state-settings (x)
3275 "Extract the log state setting from a TODO keyword string.
3276 This will extract info from a string like \"WAIT(w@/!)\"."
3277 (let (kw key log1 log2
)
3278 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
3279 (setq kw
(match-string 1 x
)
3280 key
(and (match-end 2) (match-string 2 x
))
3281 log1
(and (match-end 3) (match-string 3 x
))
3282 log2
(and (match-end 4) (match-string 4 x
)))
3285 (and log1
(if (equal log1
"!") 'time
'note
))
3286 (and log2
(if (equal log2
"!") 'time
'note
)))))))
3288 (defun org-remove-keyword-keys (list)
3289 "Remove a pair of parenthesis at the end of each string in LIST."
3291 (if (string-match "(.*)$" x
)
3292 (substring x
0 (match-beginning 0))
3296 ;; FIXME: this could be done much better, using second characters etc.
3297 (defun org-assign-fast-keys (alist)
3298 "Assign fast keys to a keyword-key alist.
3299 Respect keys that are already there."
3300 (let (new e k c c1 c2
(char ?a
))
3301 (while (setq e
(pop alist
))
3303 ((equal e
'(:startgroup
)) (push e new
))
3304 ((equal e
'(:endgroup
)) (push e new
))
3306 (setq k
(car e
) c2 nil
)
3309 ;; automatically assign a character.
3310 (setq c1
(string-to-char
3311 (downcase (substring
3312 k
(if (= (string-to-char k
) ?
@) 1 0)))))
3313 (if (or (rassoc c1 new
) (rassoc c1 alist
))
3314 (while (or (rassoc char new
) (rassoc char alist
))
3315 (setq char
(1+ char
)))
3317 (setq c
(or c2 char
)))
3318 (push (cons k c
) new
))))
3321 ;;; Some variables used in various places
3323 (defvar org-window-configuration nil
3324 "Used in various places to store a window configuration.")
3325 (defvar org-finish-function nil
3326 "Function to be called when `C-c C-c' is used.
3327 This is for getting out of special buffers like remember.")
3330 ;; FIXME: Occasionally check by commenting these, to make sure
3331 ;; no other functions uses these, forgetting to let-bind them.
3336 (defvar description
)
3338 ;; Defined somewhere in this file, but used before definition.
3339 (defvar org-html-entities
)
3340 (defvar org-struct-menu
)
3341 (defvar org-org-menu
)
3342 (defvar org-tbl-menu
)
3343 (defvar org-agenda-keymap
)
3345 ;;;; Define the Org-mode
3347 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
3348 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22."))
3351 ;; We use a before-change function to check if a table might need
3353 (defvar org-table-may-need-update t
3354 "Indicates that a table might need an update.
3355 This variable is set by `org-before-change-function'.
3356 `org-table-align' sets it back to nil.")
3357 (defun org-before-change-function (beg end
)
3358 "Every change indicates that a table might need an update."
3359 (setq org-table-may-need-update t
))
3360 (defvar org-mode-map
)
3361 (defvar org-mode-hook nil
)
3362 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
3363 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
3364 (defvar org-table-buffer-is-an nil
)
3365 (defconst org-outline-regexp
"\\*+ ")
3368 (define-derived-mode org-mode outline-mode
"Org"
3369 "Outline-based notes management and organizer, alias
3370 \"Carsten's outline-mode for keeping track of everything.\"
3372 Org-mode develops organizational tasks around a NOTES file which
3373 contains information about projects as plain text. Org-mode is
3374 implemented on top of outline-mode, which is ideal to keep the content
3375 of large files well structured. It supports ToDo items, deadlines and
3376 time stamps, which magically appear in the diary listing of the Emacs
3377 calendar. Tables are easily created with a built-in table editor.
3378 Plain text URL-like links connect to websites, emails (VM), Usenet
3379 messages (Gnus), BBDB entries, and any files related to the project.
3380 For printing and sharing of notes, an Org-mode file (or a part of it)
3381 can be exported as a structured ASCII or HTML file.
3383 The following commands are available:
3387 ;; Get rid of Outline menus, they are not needed
3388 ;; Need to do this here because define-derived-mode sets up
3389 ;; the keymap so late. Still, it is a waste to call this each time
3390 ;; we switch another buffer into org-mode.
3391 (if (featurep 'xemacs
)
3392 (when (boundp 'outline-mode-menu-heading
)
3393 ;; Assume this is Greg's port, it used easymenu
3394 (easy-menu-remove outline-mode-menu-heading
)
3395 (easy-menu-remove outline-mode-menu-show
)
3396 (easy-menu-remove outline-mode-menu-hide
))
3397 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
3398 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
3399 (define-key org-mode-map
[menu-bar show
] 'undefined
))
3401 (org-load-modules-maybe)
3402 (easy-menu-add org-org-menu
)
3403 (easy-menu-add org-tbl-menu
)
3404 (org-install-agenda-files-menu)
3405 (if org-descriptive-links
(org-add-to-invisibility-spec '(org-link)))
3406 (org-add-to-invisibility-spec '(org-cwidth))
3407 (when (featurep 'xemacs
)
3408 (org-set-local 'line-move-ignore-invisible t
))
3409 (org-set-local 'outline-regexp org-outline-regexp
)
3410 (org-set-local 'outline-level
'org-outline-level
)
3411 (when (and org-ellipsis
3412 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
3413 (fboundp 'make-glyph-code
))
3414 (unless org-display-table
3415 (setq org-display-table
(make-display-table)))
3416 (set-display-table-slot
3419 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
3421 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
3422 (setq buffer-display-table org-display-table
))
3423 (org-set-regexps-and-options)
3424 (when (and org-tag-faces
(not org-tags-special-faces-re
))
3425 ;; tag faces set outside customize.... force initialization.
3426 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
3428 (org-set-local 'calc-embedded-open-mode
"# ")
3429 (modify-syntax-entry ?
# "<")
3430 (modify-syntax-entry ?
@ "w")
3431 (if org-startup-truncated
(setq truncate-lines t
))
3432 (org-set-local 'font-lock-unfontify-region-function
3433 'org-unfontify-region
)
3434 ;; Activate before-change-function
3435 (org-set-local 'org-table-may-need-update t
)
3436 (org-add-hook 'before-change-functions
'org-before-change-function nil
3438 ;; Check for running clock before killing a buffer
3439 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
3440 ;; Paragraphs and auto-filling
3441 (org-set-autofill-regexps)
3442 (setq indent-line-function
'org-indent-line-function
)
3443 (org-update-radio-target-regexp)
3445 ;; Comment characters
3446 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
3447 (org-set-local 'comment-padding
" ")
3449 ;; Align options lines
3451 'align-mode-rules-list
3452 '((org-in-buffer-settings
3453 (regexp .
"^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
3454 (modes .
'(org-mode)))))
3457 (org-set-local 'imenu-create-index-function
3458 'org-imenu-get-tree
)
3460 ;; Make isearch reveal context
3461 (if (or (featurep 'xemacs
)
3462 (not (boundp 'outline-isearch-open-invisible-function
)))
3463 ;; Emacs 21 and XEmacs make use of the hook
3464 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
3465 ;; Emacs 22 deals with this through a special variable
3466 (org-set-local 'outline-isearch-open-invisible-function
3467 (lambda (&rest ignore
) (org-show-context 'isearch
))))
3469 ;; If empty file that did not turn on org-mode automatically, make it to.
3470 (if (and org-insert-mode-line-in-empty-file
3472 (= (point-min) (point-max)))
3473 (insert "# -*- mode: org -*-\n\n"))
3475 (unless org-inhibit-startup
3476 (when org-startup-align-all-tables
3477 (let ((bmp (buffer-modified-p)))
3478 (org-table-map-tables 'org-table-align
)
3479 (set-buffer-modified-p bmp
)))
3480 (org-set-startup-visibility)))
3482 (put 'org-mode
'flyspell-mode-predicate
'org-mode-flyspell-verify
)
3484 (defun org-current-time ()
3485 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3486 (if (> (car org-time-stamp-rounding-minutes
) 1)
3487 (let ((r (car org-time-stamp-rounding-minutes
))
3488 (time (decode-time)))
3490 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
3494 ;;;; Font-Lock stuff, including the activators
3496 (defvar org-mouse-map
(make-sparse-keymap))
3497 (org-defkey org-mouse-map
3498 (if (featurep 'xemacs
) [button2] [mouse-2]) 'org-open-at-mouse)
3499 (org-defkey org-mouse-map
3500 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3501 (when org-mouse-1-follows-link
3502 (org-defkey org-mouse-map [follow-link] 'mouse-face))
3503 (when org-tab-follows-link
3504 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
3505 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
3506 (when org-return-follows-link
3507 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
3508 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
3510 (require 'font-lock)
3512 (defconst org-non-link-chars "]\t\n\r<>")
3513 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
3515 (defvar org-link-types-re nil
3516 "Matches a link that has a url-like prefix like \"http:\"")
3517 (defvar org-link-re-with-space nil
3518 "Matches a link with spaces, optional angular brackets around it.")
3519 (defvar org-link-re-with-space2 nil
3520 "Matches a link with spaces, optional angular brackets around it.")
3521 (defvar org-link-re-with-space3 nil
3522 "Matches a link with spaces, only for internal part in bracket links.")
3523 (defvar org-angle-link-re nil
3524 "Matches link with angular brackets, spaces are allowed.")
3525 (defvar org-plain-link-re nil
3526 "Matches plain link, without spaces.")
3527 (defvar org-bracket-link-regexp nil
3528 "Matches a link in double brackets.")
3529 (defvar org-bracket-link-analytic-regexp nil
3530 "Regular expression used to analyze links.
3531 Here is what the match groups contain after a match:
3537 (defvar org-any-link-re nil
3538 "Regular expression matching any link.")
3540 (defun org-make-link-regexps ()
3541 "Update the link regular expressions.
3542 This should be called after the variable `org-link-types' has changed."
3543 (setq org-link-types-re
3545 "\\`\\(" (mapconcat 'identity org-link-types "\\|") "\\):")
3546 org-link-re-with-space
3548 "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
3549 "\\([^" org-non-link-chars " ]"
3550 "[^" org-non-link-chars "]*"
3551 "[^" org-non-link-chars " ]\\)>?")
3552 org-link-re-with-space2
3554 "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
3555 "\\([^" org-non-link-chars " ]"
3557 "[^" org-non-link-chars " ]\\)>?")
3558 org-link-re-with-space3
3560 "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
3561 "\\([^" org-non-link-chars " ]"
3565 "<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
3566 "\\([^" org-non-link-chars " ]"
3567 "[^" org-non-link-chars "]*"
3571 "\\<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
3572 "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
3573 org-bracket-link-regexp
3574 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
3575 org-bracket-link-analytic-regexp
3578 "\\(\\(" (mapconcat 'identity org-link-types "\\|") "\\):\\)?"
3581 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
3584 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
3585 org-angle-link-re "\\)\\|\\("
3586 org-plain-link-re "\\)")))
3588 (org-make-link-regexps)
3590 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
3591 "Regular expression for fast time stamp matching.")
3592 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
3593 "Regular expression for fast time stamp matching.")
3594 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3595 "Regular expression matching time strings for analysis.
3596 This one does not require the space after the date, so it can be used
3597 on a string that terminates immediately after the date.")
3598 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3599 "Regular expression matching time strings for analysis.")
3600 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
3601 "Regular expression matching time stamps, with groups.")
3602 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
3603 "Regular expression matching time stamps (also [..]), with groups.")
3604 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
3605 "Regular expression matching a time stamp range.")
3606 (defconst org-tr-regexp-both
3607 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
3608 "Regular expression matching a time stamp range.")
3609 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
3610 org-ts-regexp "\\)?")
3611 "Regular expression matching a time stamp or time stamp range.")
3612 (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
3613 org-ts-regexp-both "\\)?")
3614 "Regular expression matching a time stamp or time stamp range.
3615 The time stamps may be either active or inactive.")
3617 (defvar org-emph-face nil)
3619 (defun org-do-emphasis-faces (limit)
3620 "Run through the buffer and add overlays to links."
3622 (while (and (not rtn) (re-search-forward org-emph-re limit t))
3623 (if (not (= (char-after (match-beginning 3))
3624 (char-after (match-beginning 4))))
3627 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
3629 (nth 1 (assoc (match-string 3)
3630 org-emphasis-alist)))
3631 (add-text-properties (match-beginning 2) (match-end 2)
3632 '(font-lock-multiline t))
3633 (when org-hide-emphasis-markers
3634 (add-text-properties (match-end 4) (match-beginning 5)
3635 '(invisible org-link))
3636 (add-text-properties (match-beginning 3) (match-end 3)
3637 '(invisible org-link)))))
3641 (defun org-emphasize (&optional char)
3642 "Insert or change an emphasis, i.e. a font like bold or italic.
3643 If there is an active region, change that region to a new emphasis.
3644 If there is no region, just insert the marker characters and position
3645 the cursor between them.
3646 CHAR should be either the marker character, or the first character of the
3647 HTML tag associated with that emphasis. If CHAR is a space, the means
3648 to remove the emphasis of the selected region.
3649 If char is not given (for example in an interactive call) it
3650 will be prompted for."
3652 (let ((eal org-emphasis-alist) e det
3653 (erc org-emphasis-regexp-components)
3655 (string "") beg end move tag c s)
3656 (if (org-region-active-p)
3657 (setq beg (region-beginning) end (region-end)
3658 string (buffer-substring beg end))
3661 (while (setq e (pop eal))
3662 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
3664 (push (cons c (string-to-char (car e))) det)
3665 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
3666 (substring tag 1)))))
3667 (setq det (nreverse det))
3669 (message "%s" (concat "Emphasis marker or tag:" prompt))
3670 (setq char (read-char-exclusive)))
3671 (setq char (or (cdr (assoc char det)) char))
3672 (if (equal char ?\ )
3673 (setq s "" move nil)
3674 (unless (assoc (char-to-string char) org-emphasis-alist)
3675 (error "No such emphasis marker: \"%c\"" char))
3676 (setq s (char-to-string char)))
3677 (while (and (> (length string) 1)
3678 (equal (substring string 0 1) (substring string -1))
3679 (assoc (substring string 0 1) org-emphasis-alist))
3680 (setq string (substring string 1 -1)))
3681 (setq string (concat s string s))
3682 (if beg (delete-region beg end))
3684 (string-match (concat "[" (nth 0 erc) "\n]")
3685 (char-to-string (char-before (point)))))
3687 (unless (string-match (concat "[" (nth 1 erc) "\n]")
3688 (char-to-string (char-after (point))))
3689 (insert " ") (backward-char 1))
3691 (and move (backward-char 1))))
3693 (defconst org-nonsticky-props
3694 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
3697 (defun org-activate-plain-links (limit)
3698 "Run through the buffer and add overlays to links."
3701 (while (re-search-forward org-plain-link-re limit t)
3702 (setq f (get-text-property (match-beginning 0) 'face))
3703 (if (or (eq f 'org-tag)
3704 (and (listp f) (memq 'org-tag f)))
3706 (add-text-properties (match-beginning 0) (match-end 0)
3707 (list 'mouse-face 'highlight
3708 'rear-nonsticky org-nonsticky-props
3709 'keymap org-mouse-map
3711 (throw 'exit t))))))
3713 (defun org-activate-code (limit)
3714 (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
3716 (remove-text-properties (match-beginning 0) (match-end 0)
3717 '(display t invisible t intangible t))
3720 (defun org-activate-angle-links (limit)
3721 "Run through the buffer and add overlays to links."
3722 (if (re-search-forward org-angle-link-re limit t)
3724 (add-text-properties (match-beginning 0) (match-end 0)
3725 (list 'mouse-face 'highlight
3726 'rear-nonsticky org-nonsticky-props
3727 'keymap org-mouse-map
3731 (defun org-activate-bracket-links (limit)
3732 "Run through the buffer and add overlays to bracketed links."
3733 (if (re-search-forward org-bracket-link-regexp limit t)
3734 (let* ((help (concat "LINK: "
3735 (org-match-string-no-properties 1)))
3736 ;; FIXME: above we should remove the escapes.
3737 ;; but that requires another match, protecting match data,
3738 ;; a lot of overhead for font-lock.
3739 (ip (org-maybe-intangible
3740 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
3741 'keymap org-mouse-map 'mouse-face 'highlight
3742 'font-lock-multiline t 'help-echo help)))
3743 (vp (list 'rear-nonsticky org-nonsticky-props
3744 'keymap org-mouse-map 'mouse-face 'highlight
3745 ' font-lock-multiline t 'help-echo help)))
3746 ;; We need to remove the invisible property here. Table narrowing
3747 ;; may have made some of this invisible.
3748 (remove-text-properties (match-beginning 0) (match-end 0)
3752 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
3753 (add-text-properties (match-beginning 3) (match-end 3) vp)
3754 (add-text-properties (match-end 3) (match-end 0) ip))
3755 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
3756 (add-text-properties (match-beginning 1) (match-end 1) vp)
3757 (add-text-properties (match-end 1) (match-end 0) ip))
3760 (defun org-activate-dates (limit)
3761 "Run through the buffer and add overlays to dates."
3762 (if (re-search-forward org-tsr-regexp-both limit t)
3764 (add-text-properties (match-beginning 0) (match-end 0)
3765 (list 'mouse-face 'highlight
3766 'rear-nonsticky org-nonsticky-props
3767 'keymap org-mouse-map))
3768 (when org-display-custom-times
3770 (org-display-custom-time (match-beginning 3) (match-end 3)))
3771 (org-display-custom-time (match-beginning 1) (match-end 1)))
3774 (defvar org-target-link-regexp nil
3775 "Regular expression matching radio targets in plain text.")
3776 (make-variable-buffer-local 'org-target-link-regexp)
3777 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
3778 "Regular expression matching a link target.")
3779 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
3780 "Regular expression matching a radio target.")
3781 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
3782 "Regular expression matching any target.")
3784 (defun org-activate-target-links (limit)
3785 "Run through the buffer and add overlays to target matches."
3786 (when org-target-link-regexp
3787 (let ((case-fold-search t))
3788 (if (re-search-forward org-target-link-regexp limit t)
3790 (add-text-properties (match-beginning 0) (match-end 0)
3791 (list 'mouse-face 'highlight
3792 'rear-nonsticky org-nonsticky-props
3793 'keymap org-mouse-map
3794 'help-echo "Radio target link"
3795 'org-linked-text t))
3798 (defun org-update-radio-target-regexp ()
3799 "Find all radio targets in this file and update the regular expression."
3801 (when (memq 'radio org-activate-links)
3802 (setq org-target-link-regexp
3803 (org-make-target-link-regexp (org-all-targets 'radio)))
3804 (org-restart-font-lock)))
3806 (defun org-hide-wide-columns (limit)
3808 (setq s (text-property-any (point) (or limit (point-max))
3811 (setq e (next-single-property-change s 'org-cwidth))
3812 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
3816 (defvar org-latex-and-specials-regexp nil
3817 "Regular expression for highlighting export special stuff.")
3818 (defvar org-match-substring-regexp)
3819 (defvar org-match-substring-with-braces-regexp)
3820 (defvar org-export-html-special-string-regexps)
3822 (defun org-compute-latex-and-specials-regexp ()
3823 "Compute regular expression for stuff treated specially by exporters."
3824 (if (not org-highlight-latex-fragments-and-specials)
3825 (org-set-local 'org-latex-and-specials-regexp nil)
3828 ((matchers (plist-get org-format-latex-options :matchers))
3829 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
3830 org-latex-regexps)))
3831 (options (org-combine-plists (org-default-export-plist)
3832 (org-infile-export-plist)))
3833 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
3834 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
3835 (org-export-with-TeX-macros (plist-get options :TeX-macros))
3836 (org-export-html-expand (plist-get options :expand-quoted-html))
3837 (org-export-with-special-strings (plist-get options :special-strings))
3840 ((equal org-export-with-sub-superscripts '{})
3841 (list org-match-substring-with-braces-regexp))
3842 (org-export-with-sub-superscripts
3843 (list org-match-substring-regexp))
3846 (if org-export-with-LaTeX-fragments
3847 (mapcar (lambda (x) (nth 1 x)) latexs)))
3849 (if org-export-with-TeX-macros
3850 (list (concat "\\\\"
3852 (append (mapcar 'car org-html-entities)
3853 (if (boundp 'org-latex-entities)
3854 org-latex-entities nil))
3857 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
3858 (re-special (if org-export-with-special-strings
3859 (mapcar (lambda (x) (car x))
3860 org-export-html-special-string-regexps)))
3864 (if org-export-html-expand "@<[^>\n]+>")
3867 'org-latex-and-specials-regexp
3868 (mapconcat 'identity (append re-latex re-sub re-macros re-special
3871 (defun org-do-latex-and-special-faces (limit)
3872 "Run through the buffer and add overlays to links."
3873 (when org-latex-and-specials-regexp
3875 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
3877 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
3879 '(org-code org-verbatim underline)))
3882 d (cond ((member (char-after (1+ (match-beginning 0)))
3885 (font-lock-prepend-text-property
3886 (+ d (match-beginning 0)) (match-end 0)
3887 'face 'org-latex-and-export-specials)
3888 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
3889 '(font-lock-multiline t)))))
3892 (defun org-restart-font-lock ()
3893 "Restart font-lock-mode, to force refontification."
3894 (when (and (boundp 'font-lock-mode) font-lock-mode)
3896 (font-lock-mode 1)))
3898 (defun org-all-targets (&optional radio)
3899 "Return a list of all targets in this file.
3900 With optional argument RADIO, only find radio targets."
3901 (let ((re (if radio org-radio-target-regexp org-target-regexp))
3904 (goto-char (point-min))
3905 (while (re-search-forward re nil t)
3906 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
3909 (defun org-make-target-link-regexp (targets)
3910 "Make regular expression matching all strings in TARGETS.
3911 The regular expression finds the targets also if there is a line break
3918 (while (string-match " +" x)
3919 (setq x (replace-match "\\s-+" t t x)))
3925 (defun org-activate-tags (limit)
3926 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
3928 (add-text-properties (match-beginning 1) (match-end 1)
3929 (list 'mouse-face 'highlight
3930 'rear-nonsticky org-nonsticky-props
3931 'keymap org-mouse-map))
3934 (defun org-outline-level ()
3936 (looking-at outline-regexp)
3937 (if (match-beginning 1)
3938 (+ (org-get-string-indentation (match-string 1)) 1000)
3939 (1- (- (match-end 0) (match-beginning 0))))))
3941 (defvar org-font-lock-keywords nil)
3943 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
3944 "Regular expression matching a property line.")
3946 (defvar org-font-lock-hook nil
3947 "Functions to be called for special font lock stuff.")
3949 (defun org-font-lock-hook (limit)
3950 (run-hook-with-args 'org-font-lock-hook limit))
3952 (defun org-set-font-lock-defaults ()
3953 (let* ((em org-fontify-emphasized-text)
3954 (lk org-activate-links)
3955 (org-font-lock-extra-keywords
3958 '(org-font-lock-hook)
3960 '("^\\(\\**\\)\\(\\* \\)\\(.*\\)" (1 (org-get-level-face 1))
3961 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
3963 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
3966 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
3967 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
3968 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
3970 (list org-drawer-regexp '(0 'org-special-keyword t))
3971 (list "^[ \t]*:END:" '(0 'org-special-keyword t))
3973 (list org-property-re
3974 '(1 'org-special-keyword t)
3975 '(3 'org-property-value t))
3976 (if org-format-transports-properties-p
3977 '("| *\\(<[0-9]+>\\) *" (1 'org-formula t)))
3979 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
3980 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
3981 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
3982 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
3983 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
3984 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
3985 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
3986 '(org-hide-wide-columns (0 nil append))
3988 (list (concat "^\\*+[ \t]+" org-todo-regexp)
3989 '(1 (org-get-todo-face 1) t))
3991 (if org-fontify-done-headline
3992 (list (concat "^[*]+ +\\<\\("
3993 (mapconcat 'regexp-quote org-done-keywords "\\|")
3995 '(2 'org-headline-done t))
3998 (list (concat "\\[#[A-Z0-9]\\]") '(0 'org-special-keyword t))
4000 '(org-font-lock-add-tag-faces)
4002 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
4003 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
4004 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
4005 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
4008 (if (featurep 'xemacs)
4009 '(org-do-emphasis-faces (0 nil append))
4010 '(org-do-emphasis-faces)))
4012 '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
4014 (if org-provide-checkbox-statistics
4015 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
4016 (0 (org-get-checkbox-statistics-face) t)))
4017 ;; Description list items
4018 '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
4020 (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
4021 '(1 'org-archived prepend))
4023 '(org-do-latex-and-special-faces)
4025 '(org-activate-code (1 'org-code t))
4027 (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
4028 "\\|" org-quote-string "\\)\\>")
4029 '(1 'org-special-keyword t))
4030 '("^#.*" (0 'font-lock-comment-face t))
4032 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4033 ;; Now set the full font-lock-keywords
4034 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4035 (org-set-local 'font-lock-defaults
4036 '(org-font-lock-keywords t nil nil backward-paragraph))
4037 (kill-local-variable 'font-lock-keywords) nil))
4042 (defun org-get-level-face (n)
4043 "Get the right face for match N in font-lock matching of headlines."
4044 (setq org-l (- (match-end 2) (match-beginning 1) 1))
4045 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4046 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
4048 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4050 (t (if org-level-color-stars-only nil org-f))))
4052 (defun org-get-todo-face (kwd)
4053 "Get the right face for a TODO keyword KWD.
4054 If KWD is a number, get the corresponding match group."
4055 (if (numberp kwd) (setq kwd (match-string kwd)))
4056 (or (cdr (assoc kwd org-todo-keyword-faces))
4057 (and (member kwd org-done-keywords) 'org-done)
4060 (defun org-font-lock-add-tag-faces (limit)
4061 "Add the special tag faces."
4062 (when (and org-tag-faces org-tags-special-faces-re)
4063 (while (re-search-forward org-tags-special-faces-re limit t)
4064 (add-text-properties (match-beginning 1) (match-end 1)
4065 (list 'face (org-get-tag-face 1)
4066 'font-lock-fontified t))
4067 (backward-char 1))))
4069 (defun org-get-tag-face (kwd)
4070 "Get the right face for a TODO keyword KWD.
4071 If KWD is a number, get the corresponding match group."
4072 (if (numberp kwd) (setq kwd (match-string kwd)))
4073 (or (cdr (assoc kwd org-tag-faces))
4076 (defun org-unfontify-region (beg end &optional maybe_loudly)
4077 "Remove fontification and activation overlays from links."
4078 (font-lock-default-unfontify-region beg end)
4079 (let* ((buffer-undo-list t)
4080 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4081 (inhibit-modification-hooks t)
4082 deactivate-mark buffer-file-name buffer-file-truename)
4083 (remove-text-properties beg end
4084 '(mouse-face t keymap t org-linked-text t
4085 invisible t intangible t))))
4087 ;;;; Visibility cycling, including org-goto and indirect buffer
4091 (defvar org-cycle-global-status nil)
4092 (make-variable-buffer-local 'org-cycle-global-status)
4093 (defvar org-cycle-subtree-status nil)
4094 (make-variable-buffer-local 'org-cycle-subtree-status)
4097 (defun org-cycle (&optional arg)
4098 "Visibility cycling for Org-mode.
4100 - When this function is called with a prefix argument, rotate the entire
4101 buffer through 3 states (global cycling)
4102 1. OVERVIEW: Show only top-level headlines.
4103 2. CONTENTS: Show all headlines of all levels, but no body text.
4104 3. SHOW ALL: Show everything.
4105 When called with two C-u C-u prefixes, switch to the startup visibility,
4106 determined by the variable `org-startup-folded', and by any VISIBILITY
4107 properties in the buffer.
4108 When called with three C-u C-u C-u prefixed, show the entire buffer,
4111 - When point is at the beginning of a headline, rotate the subtree started
4112 by this line through 3 different states (local cycling)
4113 1. FOLDED: Only the main headline is shown.
4114 2. CHILDREN: The main headline and the direct children are shown.
4115 From this state, you can move to one of the children
4116 and zoom in further.
4117 3. SUBTREE: Show the entire subtree, including body text.
4119 - When there is a numeric prefix, go up to a heading with level ARG, do
4120 a `show-subtree' and return to the previous cursor position. If ARG
4121 is negative, go up that many levels.
4123 - When point is not at the beginning of a headline, execute the global
4124 binding for TAB, which is re-indenting the line. See the option
4125 `org-cycle-emulate-tab' for details.
4127 - Special case: if point is at the beginning of the buffer and there is
4128 no headline in line 1, this function will act as if called with prefix arg.
4129 But only if also the variable `org-cycle-global-at-bob' is t."
4131 (org-load-modules-maybe)
4132 (let* ((outline-regexp
4133 (if (and (org-mode-p) org-cycle-include-plain-lists)
4134 "\\(?:\\*+ \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"
4136 (bob-special (and org-cycle-global-at-bob (bobp)
4137 (not (looking-at outline-regexp))))
4140 (delq 'org-optimize-window-after-visibility-change
4141 (copy-sequence org-cycle-hook))
4145 (if (or bob-special (equal arg '(4)))
4146 ;; special case: use global cycling
4152 (org-set-startup-visibility)
4153 (message "Startup visibility, plus VISIBILITY properties"))
4157 (message "Entire buffer visible, including drawers"))
4159 ((org-at-table-p 'any)
4160 ;; Enter the table or move to the next field in the table
4161 (or (org-table-recognize-table.el)
4163 (if arg (org-table-edit-field t)
4164 (org-table-justify-field-maybe)
4165 (call-interactively 'org-table-next-field)))))
4167 ((eq arg t) ;; Global cycling
4170 ((and (eq last-command this-command)
4171 (eq org-cycle-global-status 'overview))
4172 ;; We just created the overview - now do table of contents
4173 ;; This can be slow in very large buffers, so indicate action
4174 (message "CONTENTS...")
4176 (message "CONTENTS...done")
4177 (setq org-cycle-global-status 'contents)
4178 (run-hook-with-args 'org-cycle-hook 'contents))
4180 ((and (eq last-command this-command)
4181 (eq org-cycle-global-status 'contents))
4182 ;; We just showed the table of contents - now show everything
4184 (message "SHOW ALL")
4185 (setq org-cycle-global-status 'all)
4186 (run-hook-with-args 'org-cycle-hook 'all))
4189 ;; Default action: go to overview
4191 (message "OVERVIEW")
4192 (setq org-cycle-global-status 'overview)
4193 (run-hook-with-args 'org-cycle-hook 'overview))))
4195 ((and org-drawers org-drawer-regexp
4197 (beginning-of-line 1)
4198 (looking-at org-drawer-regexp)))
4199 ;; Toggle block visibility
4201 (not (get-char-property (match-end 0) 'invisible))))
4204 ;; Show-subtree, ARG levels up from here.
4206 (org-back-to-heading)
4207 (outline-up-heading (if (< arg 0) (- arg)
4208 (- (funcall outline-level) arg)))
4209 (org-show-subtree)))
4211 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4212 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4213 ;; At a heading: rotate between three different views
4214 (org-back-to-heading)
4215 (let ((goal-column 0) eoh eol eos)
4216 ;; First, some boundaries
4218 (org-back-to-heading)
4220 (beginning-of-line 2)
4221 (while (and (not (eobp)) ;; this is like `next-line'
4222 (get-char-property (1- (point)) 'invisible))
4223 (beginning-of-line 2)) (setq eol (point)))
4224 (outline-end-of-heading) (setq eoh (point))
4225 (org-end-of-subtree t)
4227 (skip-chars-forward " \t\n")
4228 (beginning-of-line 1) ; in case this is an item
4230 (setq eos (1- (point))))
4231 ;; Find out what to do next and set `this-command'
4234 ;; Nothing is hidden behind this heading
4235 (message "EMPTY ENTRY")
4236 (setq org-cycle-subtree-status nil)
4239 (outline-next-heading)
4240 (if (org-invisible-p) (org-flag-heading nil))))
4242 (not (string-match "\\S-" (buffer-substring eol eos))))
4243 ;; Entire subtree is hidden in one line: open it
4246 (message "CHILDREN")
4249 (outline-next-heading)
4250 (if (org-invisible-p) (org-flag-heading nil)))
4251 (setq org-cycle-subtree-status 'children)
4252 (run-hook-with-args 'org-cycle-hook 'children))
4253 ((and (eq last-command this-command)
4254 (eq org-cycle-subtree-status 'children))
4255 ;; We just showed the children, now show everything.
4258 (setq org-cycle-subtree-status 'subtree)
4259 (run-hook-with-args 'org-cycle-hook 'subtree))
4261 ;; Default action: hide the subtree.
4264 (setq org-cycle-subtree-status 'folded)
4265 (run-hook-with-args 'org-cycle-hook 'folded)))))
4267 ;; TAB emulation and template completion
4268 (buffer-read-only (org-back-to-heading))
4270 ((org-try-structure-completion))
4272 ((org-try-cdlatex-tab))
4274 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4276 (not (looking-at outline-regexp))))
4277 (call-interactively (global-key-binding "\t")))
4279 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4280 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
4281 (or (and (eq org-cycle-emulate-tab 'white)
4282 (= (match-end 0) (point-at-eol)))
4283 (and (eq org-cycle-emulate-tab 'whitestart)
4284 (>= (match-end 0) pos))))
4286 (eq org-cycle-emulate-tab t))
4287 (call-interactively (global-key-binding "\t")))
4290 (org-back-to-heading)
4294 (defun org-global-cycle (&optional arg)
4295 "Cycle the global visibility. For details see `org-cycle'.
4296 With C-u prefix arg, switch to startup visibility.
4297 With a numeric prefix, show all headlines up to that level."
4299 (let ((org-cycle-include-plain-lists
4300 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4304 (hide-sublevels arg)
4305 (setq org-cycle-global-status 'contents))
4307 (org-set-startup-visibility)
4308 (message "Startup visibility, plus VISIBILITY properties."))
4310 (org-cycle '(4))))))
4312 (defun org-set-startup-visibility ()
4313 "Set the visibility required by startup options and properties."
4315 ((eq org-startup-folded t)
4317 ((eq org-startup-folded 'content)
4318 (let ((this-command 'org-cycle) (last-command 'org-cycle))
4319 (org-cycle '(4)) (org-cycle '(4)))))
4320 (org-set-visibility-according-to-property 'no-cleanup)
4321 (org-cycle-hide-archived-subtrees 'all)
4322 (org-cycle-hide-drawers 'all)
4323 (org-cycle-show-empty-lines 'all))
4325 (defun org-set-visibility-according-to-property (&optional no-cleanup)
4326 "Switch subtree visibilities according to :VISIBILITY: property."
4330 (goto-char (point-min))
4331 (while (re-search-forward
4332 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
4334 (setq state (match-string 1))
4336 (org-back-to-heading t)
4340 ((equal state '("fold" "folded"))
4342 ((equal state "children")
4343 (org-show-hidden-entry)
4345 ((equal state "content")
4348 (org-narrow-to-subtree)
4350 ((member state '("all" "showall"))
4353 (org-cycle-hide-archived-subtrees 'all)
4354 (org-cycle-hide-drawers 'all)
4355 (org-cycle-show-empty-lines 'all)))))
4357 (defun org-overview ()
4358 "Switch to overview mode, showing only top-level headlines.
4359 Really, this shows all headlines with level equal or greater than the level
4360 of the first headline in the buffer. This is important, because if the
4361 first headline is not level one, then (hide-sublevels 1) gives confusing
4364 (let ((level (save-excursion
4365 (goto-char (point-min))
4366 (if (re-search-forward (concat "^" outline-regexp) nil t)
4368 (goto-char (match-beginning 0))
4369 (funcall outline-level))))))
4370 (and level (hide-sublevels level))))
4372 (defun org-content (&optional arg)
4373 "Show all headlines in the buffer, like a table of contents.
4374 With numerical argument N, show content up to level N."
4377 ;; Visit all headings and show their offspring
4378 (and (integerp arg) (org-overview))
4379 (goto-char (point-max))
4381 (while (and (progn (condition-case nil
4382 (outline-previous-visible-heading 1)
4383 (error (goto-char (point-min))))
4385 (looking-at outline-regexp))
4387 (show-children (1- arg))
4389 (if (bobp) (throw 'exit nil))))))
4392 (defun org-optimize-window-after-visibility-change (state)
4393 "Adjust the window after a change in outline visibility.
4394 This function is the default value of the hook `org-cycle-hook'."
4395 (when (get-buffer-window (current-buffer))
4397 ; ((eq state 'overview) (org-first-headline-recenter 1))
4398 ; ((eq state 'overview) (org-beginning-of-line))
4399 ((eq state 'content) nil)
4400 ((eq state 'all) nil)
4401 ((eq state 'folded) nil)
4402 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4403 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4405 (defun org-compact-display-after-subtree-move ()
4408 (if (org-up-heading-safe)
4413 (org-cycle-show-empty-lines 'children)
4414 (org-cycle-hide-drawers 'children))
4417 (defun org-cycle-show-empty-lines (state)
4418 "Show empty lines above all visible headlines.
4419 The region to be covered depends on STATE when called through
4420 `org-cycle-hook'. Lisp program can use t for STATE to get the
4421 entire buffer covered. Note that an empty line is only shown if there
4422 are at least `org-cycle-separator-lines' empty lines before the headline."
4423 (when (> org-cycle-separator-lines 0)
4425 (let* ((n org-cycle-separator-lines)
4427 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
4428 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
4429 (t (let ((ns (number-to-string (- n 2))))
4430 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
4431 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
4434 ((memq state '(overview contents t))
4435 (setq beg (point-min) end (point-max)))
4436 ((memq state '(children folded))
4437 (setq beg (point) end (progn (org-end-of-subtree t t)
4438 (beginning-of-line 2)
4442 (while (re-search-forward re end t)
4443 (if (not (get-char-property (match-end 1) 'invisible))
4444 (outline-flag-region
4445 (match-beginning 1) (match-end 1) nil)))))))
4446 ;; Never hide empty lines at the end of the file.
4448 (goto-char (point-max))
4449 (outline-previous-heading)
4450 (outline-end-of-heading)
4451 (if (and (looking-at "[ \t\n]+")
4452 (= (match-end 0) (point-max)))
4453 (outline-flag-region (point) (match-end 0) nil))))
4455 (defun org-show-empty-lines-in-parent ()
4456 "Move to the parent and re-show empty lines before visible headlines."
4458 (let ((context (if (org-up-heading-safe) 'children 'overview)))
4459 (org-cycle-show-empty-lines context))))
4461 (defun org-cycle-hide-drawers (state)
4462 "Re-hide all drawers after a visibility state change."
4463 (when (and (org-mode-p)
4464 (not (memq state '(overview folded))))
4466 (let* ((globalp (memq state '(contents all)))
4467 (beg (if globalp (point-min) (point)))
4468 (end (if globalp (point-max) (org-end-of-subtree t))))
4470 (while (re-search-forward org-drawer-regexp end t)
4471 (org-flag-drawer t))))))
4473 (defun org-flag-drawer (flag)
4475 (beginning-of-line 1)
4476 (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
4477 (let ((b (match-end 0))
4478 (outline-regexp org-outline-regexp))
4479 (if (re-search-forward
4481 (save-excursion (outline-next-heading) (point)) t)
4482 (outline-flag-region b (point-at-eol) flag)
4483 (error ":END: line missing"))))))
4485 (defun org-subtree-end-visible-p ()
4486 "Is the end of the current subtree visible?"
4487 (pos-visible-in-window-p
4488 (save-excursion (org-end-of-subtree t) (point))))
4490 (defun org-first-headline-recenter (&optional N)
4491 "Move cursor to the first headline and recenter the headline.
4492 Optional argument N means, put the headline into the Nth line of the window."
4493 (goto-char (point-min))
4494 (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
4496 (recenter (prefix-numeric-value N))))
4500 (defvar org-goto-window-configuration nil)
4501 (defvar org-goto-marker nil)
4502 (defvar org-goto-map
4503 (let ((map (make-sparse-keymap)))
4504 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
4505 (while (setq cmd (pop cmds))
4506 (substitute-key-definition cmd cmd map global-map)))
4507 (suppress-keymap map)
4508 (org-defkey map "\C-m" 'org-goto-ret)
4509 (org-defkey map [(return)] 'org-goto-ret)
4510 (org-defkey map [(left)] 'org-goto-left)
4511 (org-defkey map [(right)] 'org-goto-right)
4512 (org-defkey map [(control ?g)] 'org-goto-quit)
4513 (org-defkey map "\C-i" 'org-cycle)
4514 (org-defkey map [(tab)] 'org-cycle)
4515 (org-defkey map [(down)] 'outline-next-visible-heading)
4516 (org-defkey map [(up)] 'outline-previous-visible-heading)
4517 (if org-goto-auto-isearch
4518 (if (fboundp 'define-key-after)
4519 (define-key-after map [t] 'org-goto-local-auto-isearch)
4521 (org-defkey map "q" 'org-goto-quit)
4522 (org-defkey map "n" 'outline-next-visible-heading)
4523 (org-defkey map "p" 'outline-previous-visible-heading)
4524 (org-defkey map "f" 'outline-forward-same-level)
4525 (org-defkey map "b" 'outline-backward-same-level)
4526 (org-defkey map "u" 'outline-up-heading))
4527 (org-defkey map "/" 'org-occur)
4528 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
4529 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
4530 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
4531 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
4532 (org-defkey map "\C-c\C-u" 'outline-up-heading)
4535 (defconst org-goto-help
4536 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
4537 RET=jump to location [Q]uit and return to previous location
4538 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
4540 (defvar org-goto-start-pos) ; dynamically scoped parameter
4542 ;; FIXME: Docstring doe not mention both interfaces
4543 (defun org-goto (&optional alternative-interface)
4544 "Look up a different location in the current file, keeping current visibility.
4546 When you want look-up or go to a different location in a document, the
4547 fastest way is often to fold the entire buffer and then dive into the tree.
4548 This method has the disadvantage, that the previous location will be folded,
4549 which may not be what you want.
4551 This command works around this by showing a copy of the current buffer
4552 in an indirect buffer, in overview mode. You can dive into the tree in
4553 that copy, use org-occur and incremental search to find a location.
4554 When pressing RET or `Q', the command returns to the original buffer in
4555 which the visibility is still unchanged. After RET is will also jump to
4556 the location selected in the indirect buffer and expose the
4557 the headline hierarchy above."
4559 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
4560 (org-refile-use-outline-path t)
4562 (if (not alternative-interface)
4564 (if (eq org-goto-interface 'outline)
4565 'outline-path-completion
4567 (org-goto-start-pos (point))
4569 (if (eq interface 'outline)
4570 (car (org-get-location (current-buffer) org-goto-help))
4571 (nth 3 (org-refile-get-location "Goto: ")))))
4574 (org-mark-ring-push org-goto-start-pos)
4575 (goto-char selected-point)
4576 (if (or (org-invisible-p) (org-invisible-p2))
4577 (org-show-context 'org-goto)))
4580 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
4581 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
4582 (defvar org-goto-local-auto-isearch-map) ; defined below
4584 (defun org-get-location (buf help)
4585 "Let the user select a location in the Org-mode buffer BUF.
4586 This function uses a recursive edit. It returns the selected position
4588 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
4589 (isearch-hide-immediately nil)
4590 (isearch-search-fun-function
4591 (lambda () 'org-goto-local-search-headings))
4592 (org-goto-selected-point org-goto-exit-command))
4594 (save-window-excursion
4595 (delete-other-windows)
4596 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
4599 (make-indirect-buffer (current-buffer) "*org-goto*")
4600 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
4601 (with-output-to-temp-buffer "*Help*"
4603 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
4604 (setq buffer-read-only nil)
4605 (let ((org-startup-truncated t)
4606 (org-startup-folded nil)
4607 (org-startup-align-all-tables nil))
4610 (setq buffer-read-only t)
4611 (if (and (boundp 'org-goto-start-pos)
4612 (integer-or-marker-p org-goto-start-pos))
4613 (let ((org-show-hierarchy-above t)
4614 (org-show-siblings t)
4615 (org-show-following-heading t))
4616 (goto-char org-goto-start-pos)
4617 (and (org-invisible-p) (org-show-context)))
4618 (goto-char (point-min)))
4619 (org-beginning-of-line)
4620 (message "Select location and press RET")
4621 (use-local-map org-goto-map)
4624 (kill-buffer "*org-goto*")
4625 (cons org-goto-selected-point org-goto-exit-command)))
4627 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
4628 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
4629 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
4630 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
4632 (defun org-goto-local-search-headings (string bound noerror)
4633 "Search and make sure that any matches are in headlines."
4635 (while (if isearch-forward
4636 (search-forward string bound noerror)
4637 (search-backward string bound noerror))
4638 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
4639 (and (member :headline context)
4640 (not (member :tags context))))
4641 (throw 'return (point))))))
4643 (defun org-goto-local-auto-isearch ()
4646 (goto-char (point-min))
4647 (let ((keys (this-command-keys)))
4648 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
4650 (isearch-process-search-char (string-to-char keys)))))
4652 (defun org-goto-ret (&optional arg)
4653 "Finish `org-goto' by going to the new location."
4655 (setq org-goto-selected-point (point)
4656 org-goto-exit-command 'return)
4659 (defun org-goto-left ()
4660 "Finish `org-goto' by going to the new location."
4662 (if (org-on-heading-p)
4664 (beginning-of-line 1)
4665 (setq org-goto-selected-point (point)
4666 org-goto-exit-command 'left)
4668 (error "Not on a heading")))
4670 (defun org-goto-right ()
4671 "Finish `org-goto' by going to the new location."
4673 (if (org-on-heading-p)
4675 (setq org-goto-selected-point (point)
4676 org-goto-exit-command 'right)
4678 (error "Not on a heading")))
4680 (defun org-goto-quit ()
4681 "Finish `org-goto' without cursor motion."
4683 (setq org-goto-selected-point nil)
4684 (setq org-goto-exit-command 'quit)
4687 ;;; Indirect buffer display of subtrees
4689 (defvar org-indirect-dedicated-frame nil
4690 "This is the frame being used for indirect tree display.")
4691 (defvar org-last-indirect-buffer nil)
4693 (defun org-tree-to-indirect-buffer (&optional arg)
4694 "Create indirect buffer and narrow it to current subtree.
4695 With numerical prefix ARG, go up to this level and then take that tree.
4696 If ARG is negative, go up that many levels.
4697 If `org-indirect-buffer-display' is not `new-frame', the command removes the
4698 indirect buffer previously made with this command, to avoid proliferation of
4699 indirect buffers. However, when you call the command with a `C-u' prefix, or
4700 when `org-indirect-buffer-display' is `new-frame', the last buffer
4701 is kept so that you can work with several indirect buffers at the same time.
4702 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4703 requests that a new frame be made for the new buffer, so that the dedicated
4704 frame is not changed."
4706 (let ((cbuf (current-buffer))
4707 (cwin (selected-window))
4709 beg end level heading ibuf)
4711 (org-back-to-heading t)
4713 (setq level (org-outline-level))
4714 (if (< arg 0) (setq arg (+ level arg)))
4715 (while (> (setq level (org-outline-level)) arg)
4716 (outline-up-heading 1 t)))
4718 heading (org-get-heading))
4719 (org-end-of-subtree t) (setq end (point)))
4720 (if (and (buffer-live-p org-last-indirect-buffer)
4721 (not (eq org-indirect-buffer-display 'new-frame))
4723 (kill-buffer org-last-indirect-buffer))
4724 (setq ibuf (org-get-indirect-buffer cbuf)
4725 org-last-indirect-buffer ibuf)
4727 ((or (eq org-indirect-buffer-display 'new-frame)
4728 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
4729 (select-frame (make-frame))
4730 (delete-other-windows)
4731 (switch-to-buffer ibuf)
4732 (org-set-frame-title heading))
4733 ((eq org-indirect-buffer-display 'dedicated-frame)
4735 (select-frame (or (and org-indirect-dedicated-frame
4736 (frame-live-p org-indirect-dedicated-frame)
4737 org-indirect-dedicated-frame)
4738 (setq org-indirect-dedicated-frame (make-frame)))))
4739 (delete-other-windows)
4740 (switch-to-buffer ibuf)
4741 (org-set-frame-title (concat "Indirect: " heading)))
4742 ((eq org-indirect-buffer-display 'current-window)
4743 (switch-to-buffer ibuf))
4744 ((eq org-indirect-buffer-display 'other-window)
4745 (pop-to-buffer ibuf))
4746 (t (error "Invalid value.")))
4747 (if (featurep 'xemacs)
4748 (save-excursion (org-mode) (turn-on-font-lock)))
4749 (narrow-to-region beg end)
4752 (and (window-live-p cwin) (select-window cwin))))
4754 (defun org-get-indirect-buffer (&optional buffer)
4755 (setq buffer (or buffer (current-buffer)))
4756 (let ((n 1) (base (buffer-name buffer)) bname)
4757 (while (buffer-live-p
4758 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
4761 (make-indirect-buffer buffer bname 'clone)
4762 (error (make-indirect-buffer buffer bname)))))
4764 (defun org-set-frame-title (title)
4765 "Set the title of the current frame to the string TITLE."
4766 ;; FIXME: how to name a single frame in XEmacs???
4767 (unless (featurep 'xemacs)
4768 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
4770 ;;;; Structure editing
4772 ;;; Inserting headlines
4774 (defun org-insert-heading (&optional force-heading)
4775 "Insert a new heading or item with same depth at point.
4776 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
4777 If point is at the beginning of a headline, insert a sibling before the
4778 current headline. If point is not at the beginning, do not split the line,
4779 but create the new headline after the current line."
4781 (if (= (buffer-size) 0)
4783 (when (or force-heading (not (org-insert-item)))
4784 (let* ((head (save-excursion
4787 (org-back-to-heading)
4790 (blank (cdr (assq 'heading org-blank-before-new-entry)))
4791 pos hide-previous previous-pos)
4793 ((and (org-on-heading-p) (bolp)
4795 (save-excursion (backward-char 1) (not (org-invisible-p)))))
4796 ;; insert before the current line
4797 (open-line (if blank 2 1)))
4801 (backward-char 1) (not (org-invisible-p)))))
4802 ;; insert right here
4805 ;; somewhere in the line
4807 (setq previous-pos (point-at-bol))
4809 (setq hide-previous (org-invisible-p)))
4810 (and org-insert-heading-respect-content (org-show-subtree))
4812 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
4815 (goto-char (point-at-bol))
4816 (and (looking-at org-complex-heading-regexp)
4817 (> p (match-beginning 4)))))))
4820 (org-insert-heading-respect-content
4821 (org-end-of-subtree nil t)
4822 (or (bolp) (newline))
4828 (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
4829 (setq tags (and (match-end 2) (match-string 2)))
4831 (delete-region (match-beginning 1) (match-end 1)))
4832 (setq pos (point-at-bol))
4833 (or split (end-of-line 1))
4834 (delete-horizontal-space)
4835 (newline (if blank 2 1))
4841 (org-set-tags nil 'align))))
4843 (or split (end-of-line 1))
4844 (newline (if blank 2 1)))))))
4845 (insert head) (just-one-space)
4848 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
4849 (when (and org-insert-heading-respect-content hide-previous)
4851 (goto-char previous-pos)
4853 (run-hooks 'org-insert-heading-hook)))))
4855 (defun org-get-heading (&optional no-tags)
4856 "Return the heading of the current entry, without the stars."
4858 (org-back-to-heading t)
4861 (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
4862 "\\*+[ \t]+\\([^\r\n]*\\)"))
4863 (match-string 1) "")))
4865 (defun org-insert-heading-after-current ()
4866 "Insert a new heading with same level as current, after current subtree."
4868 (org-back-to-heading)
4869 (org-insert-heading)
4870 (org-move-subtree-down)
4873 (defun org-insert-heading-respect-content ()
4875 (let ((org-insert-heading-respect-content t))
4876 (org-insert-heading t)))
4878 (defun org-insert-todo-heading-respect-content (&optional force-state)
4880 (let ((org-insert-heading-respect-content t))
4881 (org-insert-todo-heading force-state t)))
4883 (defun org-insert-todo-heading (arg &optional force-heading)
4884 "Insert a new heading with the same level and TODO state as current heading.
4885 If the heading has no TODO state, or if the state is DONE, use the first
4886 state (TODO by default). Also with prefix arg, force first state."
4888 (when (or force-heading (not (org-insert-item 'checkbox)))
4889 (org-insert-heading force-heading)
4891 (org-back-to-heading)
4892 (outline-previous-heading)
4893 (looking-at org-todo-line-regexp))
4895 (not (match-beginning 2))
4896 (member (match-string 2) org-done-keywords))
4897 (insert (car org-todo-keywords-1) " ")
4898 (insert (match-string 2) " "))
4899 (when org-provide-todo-statistics
4900 (org-update-parent-todo-statistics))))
4902 (defun org-insert-subheading (arg)
4903 "Insert a new subheading and demote it.
4904 Works for outline headings and for plain lists alike."
4906 (org-insert-heading arg)
4908 ((org-on-heading-p) (org-do-demote))
4909 ((org-at-item-p) (org-indent-item 1))))
4911 (defun org-insert-todo-subheading (arg)
4912 "Insert a new subheading with TODO keyword or checkbox and demote it.
4913 Works for outline headings and for plain lists alike."
4915 (org-insert-todo-heading arg)
4917 ((org-on-heading-p) (org-do-demote))
4918 ((org-at-item-p) (org-indent-item 1))))
4920 ;;; Promotion and Demotion
4922 (defun org-promote-subtree ()
4923 "Promote the entire subtree.
4924 See also `org-promote'."
4927 (org-map-tree 'org-promote))
4928 (org-fix-position-after-promote))
4930 (defun org-demote-subtree ()
4931 "Demote the entire subtree. See `org-demote'.
4932 See also `org-promote'."
4935 (org-map-tree 'org-demote))
4936 (org-fix-position-after-promote))
4939 (defun org-do-promote ()
4940 "Promote the current heading higher up the tree.
4941 If the region is active in `transient-mark-mode', promote all headings
4945 (if (org-region-active-p)
4946 (org-map-region 'org-promote (region-beginning) (region-end))
4948 (org-fix-position-after-promote))
4950 (defun org-do-demote ()
4951 "Demote the current heading lower down the tree.
4952 If the region is active in `transient-mark-mode', demote all headings
4956 (if (org-region-active-p)
4957 (org-map-region 'org-demote (region-beginning) (region-end))
4959 (org-fix-position-after-promote))
4961 (defun org-fix-position-after-promote ()
4962 "Make sure that after pro/demotion cursor position is right."
4963 (let ((pos (point)))
4964 (when (save-excursion
4965 (beginning-of-line 1)
4966 (looking-at org-todo-line-regexp)
4967 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
4968 (cond ((eobp) (insert " "))
4969 ((eolp) (insert " "))
4970 ((equal (char-after) ?\ ) (forward-char 1))))))
4972 (defun org-reduced-level (l)
4973 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
4975 (defun org-get-valid-level (level &optional change)
4976 "Rectify a level change under the influence of `org-odd-levels-only'
4977 LEVEL is a current level, CHANGE is by how much the level should be
4978 modified. Even if CHANGE is nil, LEVEL may be returned modified because
4979 even level numbers will become the next higher odd number."
4980 (if org-odd-levels-only
4981 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
4982 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
4983 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
4984 (max 1 (+ level change))))
4986 (if (boundp 'define-obsolete-function-alias)
4987 (if (or (featurep 'xemacs) (< emacs-major-version 23))
4988 (define-obsolete-function-alias 'org-get-legal-level
4989 'org-get-valid-level)
4990 (define-obsolete-function-alias 'org-get-legal-level
4991 'org-get-valid-level "23.1")))
4993 (defun org-promote ()
4994 "Promote the current heading higher up the tree.
4995 If the region is active in `transient-mark-mode', promote all headings
4997 (org-back-to-heading t)
4998 (let* ((level (save-match-data (funcall outline-level)))
4999 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
5000 (diff (abs (- level (length up-head) -1))))
5001 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5002 (replace-match up-head nil t)
5003 ;; Fixup tag positioning
5004 (and org-auto-align-tags (org-set-tags nil t))
5005 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5007 (defun org-demote ()
5008 "Demote the current heading lower down the tree.
5009 If the region is active in `transient-mark-mode', demote all headings
5011 (org-back-to-heading t)
5012 (let* ((level (save-match-data (funcall outline-level)))
5013 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
5014 (diff (abs (- level (length down-head) -1))))
5015 (replace-match down-head nil t)
5016 ;; Fixup tag positioning
5017 (and org-auto-align-tags (org-set-tags nil t))
5018 (if org-adapt-indentation (org-fixup-indentation diff))))
5020 (defun org-map-tree (fun)
5021 "Call FUN for every heading underneath the current one."
5022 (org-back-to-heading)
5023 (let ((level (funcall outline-level)))
5027 (outline-next-heading)
5028 (> (funcall outline-level) level))
5032 (defun org-map-region (fun beg end)
5033 "Call FUN for every heading between BEG and END."
5034 (let ((org-ignore-region t))
5036 (setq end (copy-marker end))
5038 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5042 (outline-next-heading)
5047 (defun org-fixup-indentation (diff)
5048 "Change the indentation in the current entry by DIFF
5049 However, if any line in the current entry has no indentation, or if it
5050 would end up with no indentation after the change, nothing at all is done."
5052 (let ((end (save-excursion (outline-next-heading)
5054 (prohibit (if (> diff 0)
5056 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
5058 (unless (save-excursion (end-of-line 1)
5059 (re-search-forward prohibit end t))
5060 (while (and (< (point) end)
5061 (re-search-forward "^[ \t]+" end t))
5062 (goto-char (match-end 0))
5063 (setq col (current-column))
5064 (if (< diff 0) (replace-match ""))
5065 (org-indent-to-column (+ diff col))))
5066 (move-marker end nil))))
5068 (defun org-convert-to-odd-levels ()
5069 "Convert an org-mode file with all levels allowed to one with odd levels.
5070 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5073 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5074 (let ((org-odd-levels-only nil) n)
5076 (goto-char (point-min))
5077 (while (re-search-forward "^\\*\\*+ " nil t)
5078 (setq n (- (length (match-string 0)) 2))
5079 (while (>= (setq n (1- n)) 0)
5081 (end-of-line 1))))))
5084 (defun org-convert-to-oddeven-levels ()
5085 "Convert an org-mode file with only odd levels to one with odd and even levels.
5086 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5087 section with an even level, conversion would destroy the structure of the file. An error
5088 is signaled in this case."
5090 (goto-char (point-min))
5091 ;; First check if there are no even levels
5092 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
5093 (org-show-context t)
5094 (error "Not all levels are odd in this file. Conversion not possible."))
5095 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5096 (let ((org-odd-levels-only nil) n)
5098 (goto-char (point-min))
5099 (while (re-search-forward "^\\*\\*+ " nil t)
5100 (setq n (/ (1- (length (match-string 0))) 2))
5101 (while (>= (setq n (1- n)) 0)
5103 (end-of-line 1))))))
5105 (defun org-tr-level (n)
5106 "Make N odd if required."
5107 (if org-odd-levels-only (1+ (/ n 2)) n))
5109 ;;; Vertical tree motion, cutting and pasting of subtrees
5111 (defun org-move-subtree-up (&optional arg)
5112 "Move the current subtree up past ARG headlines of the same level."
5114 (org-move-subtree-down (- (prefix-numeric-value arg))))
5116 (defun org-move-subtree-down (&optional arg)
5117 "Move the current subtree down past ARG headlines of the same level."
5119 (setq arg (prefix-numeric-value arg))
5120 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5121 'outline-get-last-sibling))
5122 (ins-point (make-marker))
5124 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
5126 (org-back-to-heading)
5129 (setq ne-beg (org-back-over-empty-lines))
5132 (save-excursion (outline-end-of-heading)
5133 (setq folded (org-invisible-p)))
5134 (outline-end-of-subtree))
5135 (outline-next-heading)
5136 (setq ne-end (org-back-over-empty-lines))
5139 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
5140 ;; include less whitespace
5143 (forward-line (- ne-beg ne-end))
5144 (setq beg (point))))
5145 ;; Find insertion point, with error handling
5147 (or (and (funcall movfunc) (looking-at outline-regexp))
5148 (progn (goto-char beg0)
5149 (error "Cannot move past superior level or buffer limit")))
5150 (setq cnt (1- cnt)))
5152 ;; Moving forward - still need to move over subtree
5153 (progn (org-end-of-subtree t t)
5155 (org-back-over-empty-lines)
5156 (or (bolp) (newline)))))
5157 (setq ne-ins (org-back-over-empty-lines))
5158 (move-marker ins-point (point))
5159 (setq txt (buffer-substring beg end))
5160 (org-save-markers-in-region beg end)
5161 (delete-region beg end)
5162 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
5163 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
5164 (let ((bbb (point)))
5165 (insert-before-markers txt)
5166 (org-reinstall-markers-in-region bbb)
5167 (move-marker ins-point bbb))
5168 (or (bolp) (insert "\n"))
5169 (setq ins-end (point))
5170 (goto-char ins-point)
5171 (org-skip-whitespace)
5172 (when (and (< arg 0)
5173 (org-first-sibling-p)
5175 ;; Move whitespace back to beginning
5178 (let ((kill-whole-line t))
5179 (kill-line (- ne-ins ne-beg)) (point)))
5180 (insert (make-string (- ne-ins ne-beg) ?\n)))
5181 (move-marker ins-point nil)
5182 (org-compact-display-after-subtree-move)
5183 (org-show-empty-lines-in-parent)
5187 (org-cycle-hide-drawers 'children))))
5189 (defvar org-subtree-clip ""
5190 "Clipboard for cut and paste of subtrees.
5191 This is actually only a copy of the kill, because we use the normal kill
5192 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5194 (defvar org-subtree-clip-folded nil
5195 "Was the last copied subtree folded?
5196 This is used to fold the tree back after pasting.")
5198 (defun org-cut-subtree (&optional n)
5199 "Cut the current subtree into the clipboard.
5200 With prefix arg N, cut this many sequential subtrees.
5201 This is a short-hand for marking the subtree and then cutting it."
5203 (org-copy-subtree n 'cut))
5205 (defun org-copy-subtree (&optional n cut force-store-markers)
5206 "Cut the current subtree into the clipboard.
5207 With prefix arg N, cut this many sequential subtrees.
5208 This is a short-hand for marking the subtree and then copying it.
5209 If CUT is non-nil, actually cut the subtree.
5210 If FORCE-STORE-MARKERS is non-nil, store the relative locations
5211 of some markers in the region, even if CUT is non-nil. This is
5212 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
5214 (let (beg end folded (beg0 (point)))
5216 (org-back-to-heading nil) ; take what looks like a subtree
5217 (org-back-to-heading t)) ; take what is really there
5218 (org-back-over-empty-lines)
5220 (skip-chars-forward " \t\r\n")
5222 (save-excursion (outline-end-of-heading)
5223 (setq folded (org-invisible-p)))
5225 (outline-forward-same-level (1- n))
5227 (org-end-of-subtree t t))
5228 (org-back-over-empty-lines)
5232 (setq org-subtree-clip-folded folded)
5233 (when (or cut force-store-markers)
5234 (org-save-markers-in-region beg end))
5235 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5236 (setq org-subtree-clip (current-kill 0))
5237 (message "%s: Subtree(s) with %d characters"
5238 (if cut "Cut" "Copied")
5239 (length org-subtree-clip)))))
5241 (defun org-paste-subtree (&optional level tree for-yank)
5242 "Paste the clipboard as a subtree, with modification of headline level.
5243 The entire subtree is promoted or demoted in order to match a new headline
5246 If the cursor is at the beginning of a headline, the same level as
5247 that headline is used to paste the tree
5249 If not, the new level is derived from the *visible* headings
5250 before and after the insertion point, and taken to be the inferior headline
5251 level of the two. So if the previous visible heading is level 3 and the
5252 next is level 4 (or vice versa), level 4 will be used for insertion.
5253 This makes sure that the subtree remains an independent subtree and does
5254 not swallow low level entries.
5256 You can also force a different level, either by using a numeric prefix
5257 argument, or by inserting the heading marker by hand. For example, if the
5258 cursor is after \"*****\", then the tree will be shifted to level 5.
5260 If optional TREE is given, use this text instead of the kill ring.
5262 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
5263 move back over whitespace before inserting, and move point to the end of
5264 the inserted text when done."
5266 (unless (org-kill-is-subtree-p tree)
5268 (substitute-command-keys
5269 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
5270 (let* ((visp (not (org-invisible-p)))
5271 (txt (or tree (and kill-ring (current-kill 0))))
5272 (^re (concat "^\\(" outline-regexp "\\)"))
5273 (re (concat "\\(" outline-regexp "\\)"))
5274 (^re_ (concat "\\(\\*+\\)[ \t]*"))
5276 (old-level (if (string-match ^re txt)
5277 (- (match-end 0) (match-beginning 0) 1)
5279 (force-level (cond (level (prefix-numeric-value level))
5280 ((and (looking-at "[ \t]*$")
5282 ^re_ (buffer-substring
5283 (point-at-bol) (point))))
5284 (- (match-end 1) (match-beginning 1)))
5286 (looking-at org-outline-regexp))
5287 (- (match-end 0) (point) 1))
5289 (previous-level (save-excursion
5292 (outline-previous-visible-heading 1)
5294 (- (match-end 0) (match-beginning 0) 1)
5297 (next-level (save-excursion
5300 (or (looking-at outline-regexp)
5301 (outline-next-visible-heading 1))
5303 (- (match-end 0) (match-beginning 0) 1)
5306 (new-level (or force-level (max previous-level next-level)))
5307 (shift (if (or (= old-level -1)
5309 (= old-level new-level))
5311 (- new-level old-level)))
5312 (delta (if (> shift 0) -1 1))
5313 (func (if (> shift 0) 'org-demote 'org-promote))
5314 (org-odd-levels-only nil)
5316 ;; Remove the forced level indicator
5318 (delete-region (point-at-bol) (point)))
5320 (beginning-of-line 1)
5321 (unless for-yank (org-back-over-empty-lines))
5323 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
5324 (insert-before-markers txt)
5325 (unless (string-match "\n\\'" txt) (insert "\n"))
5326 (setq newend (point))
5327 (org-reinstall-markers-in-region beg)
5330 (skip-chars-forward " \t\n\r")
5332 (if (and (org-invisible-p) visp)
5333 (save-excursion (outline-show-heading)))
5334 ;; Shift if necessary
5337 (narrow-to-region beg end)
5338 (while (not (= shift 0))
5339 (org-map-region func (point-min) (point-max))
5340 (setq shift (+ delta shift)))
5341 (goto-char (point-min))
5342 (setq newend (point-max))))
5343 (when (or (interactive-p) for-yank)
5344 (message "Clipboard pasted as level %d subtree" new-level))
5345 (if (and (not for-yank) ; in this case, org-yank will decide about folding
5347 (eq org-subtree-clip (current-kill 0))
5348 org-subtree-clip-folded)
5349 ;; The tree was folded before it was killed/copied
5351 (and for-yank (goto-char newend))))
5353 (defun org-kill-is-subtree-p (&optional txt)
5354 "Check if the current kill is an outline subtree, or a set of trees.
5355 Returns nil if kill does not start with a headline, or if the first
5356 headline level is not the largest headline level in the tree.
5357 So this will actually accept several entries of equal levels as well,
5358 which is OK for `org-paste-subtree'.
5359 If optional TXT is given, check this string instead of the current kill."
5360 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
5361 (start-level (and kill
5362 (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
5363 org-outline-regexp "\\)")
5365 (- (match-end 2) (match-beginning 2) 1)))
5366 (re (concat "^" org-outline-regexp))
5367 (start (1+ (or (match-beginning 2) -1))))
5368 (if (not start-level)
5370 nil) ;; does not even start with a heading
5372 (while (setq start (string-match re kill (1+ start)))
5373 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
5377 (defvar org-markers-to-move nil
5378 "Markers that should be moved with a cut-and-paste operation.
5379 Those markers are stored together with their positions relative to
5380 the start of the region.")
5382 (defun org-save-markers-in-region (beg end)
5383 "Check markers in region.
5384 If these markers are between BEG and END, record their position relative
5385 to BEG, so that after moving the block of text, we can put the markers back
5387 This function gets called just before an entry or tree gets cut from the
5388 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
5389 called immediately, to move the markers with the entries."
5390 (setq org-markers-to-move nil)
5391 (when (featurep 'org-clock)
5392 (org-clock-save-markers-for-cut-and-paste beg end))
5393 (when (featurep 'org-agenda)
5394 (org-agenda-save-markers-for-cut-and-paste beg end)))
5396 (defun org-check-and-save-marker (marker beg end)
5397 "Check if MARKER is between BEG and END.
5398 If yes, remember the marker and the distance to BEG."
5399 (when (and (marker-buffer marker)
5400 (equal (marker-buffer marker) (current-buffer)))
5401 (if (and (>= marker beg) (< marker end))
5402 (push (cons marker (- marker beg)) org-markers-to-move))))
5404 (defun org-reinstall-markers-in-region (beg)
5405 "Move all remembered markers to their position relative to BEG."
5407 (move-marker (car x) (+ beg (cdr x))))
5408 org-markers-to-move)
5409 (setq org-markers-to-move nil))
5411 (defun org-narrow-to-subtree ()
5412 "Narrow buffer to the current subtree."
5417 (progn (org-back-to-heading) (point))
5418 (progn (org-end-of-subtree t) (point))))))
5423 (defun org-sort (with-case)
5424 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
5425 Optional argument WITH-CASE means sort case-sensitively."
5427 (if (org-at-table-p)
5428 (org-call-with-arg 'org-table-sort-lines with-case)
5429 (org-call-with-arg 'org-sort-entries-or-items with-case)))
5431 (defun org-sort-remove-invisible (s)
5432 (remove-text-properties 0 (length s) org-rm-props s)
5433 (while (string-match org-bracket-link-regexp s)
5434 (setq s (replace-match (if (match-end 2)
5436 (match-string 1 s)) t t s)))
5439 (defvar org-priority-regexp) ; defined later in the file
5441 (defun org-sort-entries-or-items
5442 (&optional with-case sorting-type getkey-func compare-func property)
5443 "Sort entries on a certain level of an outline tree.
5444 If there is an active region, the entries in the region are sorted.
5445 Else, if the cursor is before the first entry, sort the top-level items.
5446 Else, the children of the entry at point are sorted.
5448 Sorting can be alphabetically, numerically, and by date/time as given by
5449 the first time stamp in the entry. The command prompts for the sorting
5450 type unless it has been given to the function through the SORTING-TYPE
5451 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
5452 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
5453 called with point at the beginning of the record. It must return either
5454 a string or a number that should serve as the sorting key for that record.
5456 Comparing entries ignores case by default. However, with an optional argument
5457 WITH-CASE, the sorting considers case as well."
5459 (let ((case-func (if with-case 'identity 'downcase))
5460 start beg end stars re re2
5461 txt what tmp plain-list-p)
5462 ;; Find beginning and end of region to sort
5464 ((org-region-active-p)
5465 ;; we will sort the region
5466 (setq end (region-end)
5468 (goto-char (region-beginning))
5469 (if (not (org-on-heading-p)) (outline-next-heading))
5470 (setq start (point)))
5472 ;; we will sort this plain list
5473 (org-beginning-of-item-list) (setq start (point))
5474 (org-end-of-item-list) (setq end (point))
5476 (setq plain-list-p t
5478 ((or (org-on-heading-p)
5479 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
5480 ;; we will sort the children of the current headline
5481 (org-back-to-heading)
5483 end (progn (org-end-of-subtree t t)
5484 (org-back-over-empty-lines)
5489 (outline-next-heading))
5491 ;; we will sort the top-level entries in this file
5492 (goto-char (point-min))
5493 (or (org-on-heading-p) (outline-next-heading))
5494 (setq start (point) end (point-max) what "top-level")
5499 (if (>= beg end) (error "Nothing to sort"))
5501 (unless plain-list-p
5502 (looking-at "\\(\\*+\\)")
5503 (setq stars (match-string 1)
5504 re (concat "^" (regexp-quote stars) " +")
5505 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
5506 txt (buffer-substring beg end))
5507 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
5508 (if (and (not (equal stars "*")) (string-match re2 txt))
5509 (error "Region to sort contains a level above the first entry")))
5511 (unless sorting-type
5514 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
5515 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty todo[o]rder [f]unc A/N/T/P/O/F means reversed:")
5517 (setq sorting-type (read-char-exclusive))
5519 (and (= (downcase sorting-type) ?f)
5521 (org-ido-completing-read "Sort using function: "
5522 obarray 'fboundp t nil nil))
5523 (setq getkey-func (intern getkey-func)))
5525 (and (= (downcase sorting-type) ?r)
5527 (org-ido-completing-read "Property: "
5528 (mapcar 'list (org-buffer-property-keys t))
5531 (message "Sorting entries...")
5534 (narrow-to-region start end)
5536 (let ((dcst (downcase sorting-type))
5537 (now (current-time)))
5539 (/= dcst sorting-type)
5540 ;; This function moves to the beginning character of the "record" to
5544 (if (org-at-item-p) t (goto-char (point-max))))
5546 (if (re-search-forward re nil t)
5547 (goto-char (match-beginning 0))
5548 (goto-char (point-max)))))
5549 ;; This function moves to the last character of the "record" being
5556 (outline-forward-same-level 1)
5558 (goto-char (point-max)))))))
5560 ;; This function returns the value that gets sorted against.
5563 (when (looking-at "[ \t]*[-+*0-9.)]+[ \t]+")
5566 (string-to-number (buffer-substring (match-end 0)
5569 (buffer-substring (match-end 0) (point-at-eol)))
5571 (if (re-search-forward org-ts-regexp
5573 (org-time-string-to-time (match-string 0))
5578 (setq tmp (funcall getkey-func))
5579 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
5581 (error "Invalid key function `%s'" getkey-func)))
5582 (t (error "Invalid sorting type `%c'" sorting-type)))))
5586 (if (looking-at org-complex-heading-regexp)
5587 (string-to-number (match-string 4))
5590 (if (looking-at org-complex-heading-regexp)
5591 (funcall case-func (match-string 4))
5594 (if (re-search-forward org-ts-regexp
5598 (org-time-string-to-time (match-string 0))
5601 (if (re-search-forward org-priority-regexp (point-at-eol) t)
5602 (string-to-char (match-string 2))
5603 org-default-priority))
5605 (or (org-entry-get nil property) ""))
5607 (if (looking-at org-complex-heading-regexp)
5608 (- 9999 (length (member (match-string 2)
5609 org-todo-keywords-1)))))
5613 (setq tmp (funcall getkey-func))
5614 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
5616 (error "Invalid key function `%s'" getkey-func)))
5617 (t (error "Invalid sorting type `%c'" sorting-type)))))
5620 ((= dcst ?a) 'string<)
5621 ((= dcst ?t) 'time-less-p)
5622 ((= dcst ?f) compare-func)
5624 (message "Sorting entries...done")))
5626 (defun org-do-sort (table what &optional with-case sorting-type)
5627 "Sort TABLE of WHAT according to SORTING-TYPE.
5628 The user will be prompted for the SORTING-TYPE if the call to this
5629 function does not specify it. WHAT is only for the prompt, to indicate
5630 what is being sorted. The sorting key will be extracted from
5631 the car of the elements of the table.
5632 If WITH-CASE is non-nil, the sorting will be case-sensitive."
5633 (unless sorting-type
5635 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
5637 (setq sorting-type (read-char-exclusive)))
5638 (let ((dcst (downcase sorting-type))
5639 extractfun comparefun)
5640 ;; Define the appropriate functions
5643 (setq extractfun 'string-to-number
5644 comparefun (if (= dcst sorting-type) '< '>)))
5646 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
5647 (lambda(x) (downcase (org-sort-remove-invisible x))))
5648 comparefun (if (= dcst sorting-type)
5650 (lambda (a b) (and (not (string< a b))
5651 (not (string= a b)))))))
5655 (if (string-match org-ts-regexp x)
5657 (org-time-string-to-time (match-string 0 x)))
5659 comparefun (if (= dcst sorting-type) '< '>)))
5660 (t (error "Invalid sorting type `%c'" sorting-type)))
5662 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
5664 (lambda (a b) (funcall comparefun (car a) (car b))))))
5666 ;;; Editing source examples
5668 (defvar org-exit-edit-mode-map (make-sparse-keymap))
5669 (define-key org-exit-edit-mode-map "\C-c'" 'org-edit-src-exit)
5670 (defvar org-edit-src-force-single-line nil)
5671 (defvar org-edit-src-from-org-mode nil)
5672 (defvar org-edit-src-picture nil)
5674 (define-minor-mode org-exit-edit-mode
5675 "Minor mode installing a single key binding, \"C-c '\" to exit special edit.")
5677 (defun org-edit-src-code ()
5678 "Edit the source code example at point.
5679 An indirect buffer is created, and that buffer is then narrowed to the
5680 example at point and switched to the correct language mode. When done,
5681 exit by killing the buffer with \\[org-edit-src-exit]."
5683 (let ((line (org-current-line))
5684 (case-fold-search t)
5685 (msg (substitute-command-keys
5686 "Edit, then exit with C-c ' (C-c and single quote)"))
5687 (info (org-edit-src-find-region-and-lang))
5688 (org-mode-p (eq major-mode 'org-mode))
5689 beg end lang lang-f single)
5692 (setq beg (nth 0 info)
5696 lang-f (intern (concat lang "-mode")))
5697 (unless (functionp lang-f)
5698 (error "No such language mode: %s" lang-f))
5700 (if (get-buffer "*Org Edit Src Example*")
5701 (kill-buffer "*Org Edit Src Example*"))
5702 (switch-to-buffer (make-indirect-buffer (current-buffer)
5703 "*Org Edit Src Example*"))
5704 (narrow-to-region beg end)
5705 (remove-text-properties beg end '(display nil invisible nil
5707 (let ((org-inhibit-startup t))
5709 (set (make-local-variable 'org-edit-src-force-single-line) single)
5710 (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
5712 (goto-char (point-min))
5713 (while (re-search-forward "^," nil t)
5714 (replace-match "")))
5716 (org-exit-edit-mode)
5717 (org-set-local 'header-line-format msg)
5721 (defun org-edit-fixed-width-region ()
5722 "Edit the fixed-width ascii drawing at point.
5723 This must be a region where each line starts with a colon followed by
5725 An indirect buffer is created, and that buffer is then narrowed to the
5726 example at point and switched to artist-mode. When done,
5727 exit by killing the buffer with \\[org-edit-src-exit]."
5729 (let ((line (org-current-line))
5730 (case-fold-search t)
5731 (msg (substitute-command-keys
5732 "Edit, then exit with C-c ' (C-c and single quote)"))
5733 (org-mode-p (eq major-mode 'org-mode))
5734 beg end lang lang-f)
5735 (beginning-of-line 1)
5736 (if (looking-at "[ \t]*[^:\n \t]")
5738 (if (looking-at "[ \t]*\\(\n\\|\\'\\)")
5739 (setq beg (point) end beg)
5741 (if (re-search-backward "^[ \t]*[^:]" nil 'move)
5742 (setq beg (point-at-bol 2))
5743 (setq beg (point))))
5745 (if (re-search-forward "^[ \t]*[^:]" nil 'move)
5746 (setq end (1- (match-beginning 0)))
5747 (setq end (point))))
5749 (if (get-buffer "*Org Edit Picture*")
5750 (kill-buffer "*Org Edit Picture*"))
5751 (switch-to-buffer (make-indirect-buffer (current-buffer)
5752 "*Org Edit Picture*"))
5753 (narrow-to-region beg end)
5754 (remove-text-properties beg end '(display nil invisible nil
5756 (when (fboundp 'font-lock-unfontify-region)
5757 (font-lock-unfontify-region (point-min) (point-max)))
5759 ((eq org-edit-fixed-width-region-mode 'artist-mode)
5762 (t (funcall org-edit-fixed-width-region-mode)))
5763 (set (make-local-variable 'org-edit-src-force-single-line) nil)
5764 (set (make-local-variable 'org-edit-src-from-org-mode) org-mode-p)
5765 (set (make-local-variable 'org-edit-src-picture) t)
5766 (goto-char (point-min))
5767 (while (re-search-forward "^[ \t]*: ?" nil t)
5770 (org-exit-edit-mode)
5771 (org-set-local 'header-line-format msg)
5776 (defun org-edit-src-find-region-and-lang ()
5777 "Find the region and language for a local edit.
5778 Return a list with beginning and end of the region, a string representing
5779 the language, a switch telling of the content should be in a single line."
5782 org-edit-src-region-extra
5784 ("<src\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</src>" lang)
5785 ("<literal\\>[^<]*>[ \t]*\n?" "\n?[ \t]*</literal>" style)
5786 ("<example>[ \t]*\n?" "\n?[ \t]*</example>" "fundamental")
5787 ("<lisp>[ \t]*\n?" "\n?[ \t]*</lisp>" "emacs-lisp")
5788 ("<perl>[ \t]*\n?" "\n?[ \t]*</perl>" "perl")
5789 ("<python>[ \t]*\n?" "\n?[ \t]*</python>" "python")
5790 ("<ruby>[ \t]*\n?" "\n?[ \t]*</ruby>" "ruby")
5791 ("^#\\+begin_src\\( \\([^ \t\n]+\\)\\)?.*\n" "\n#\\+end_src" 2)
5792 ("^#\\+begin_example.*\n" "\n#\\+end_example" "fundamental")
5793 ("^#\\+html:" "\n" "html" single-line)
5794 ("^#\\+begin_html.*\n" "\n#\\+end_html" "html")
5795 ("^#\\+begin_latex.*\n" "\n#\\+end_latex" "latex")
5796 ("^#\\+latex:" "\n" "latex" single-line)
5797 ("^#\\+begin_ascii.*\n" "\n#\\+end_ascii" "fundamental")
5798 ("^#\\+ascii:" "\n" "ascii" single-line)
5801 re re1 re2 single beg end lang)
5803 (while (setq entry (pop re-list))
5804 (setq re1 (car entry) re2 (nth 1 entry) lang (nth 2 entry)
5805 single (nth 3 entry))
5807 (if (or (looking-at re1)
5808 (re-search-backward re1 nil t))
5810 (setq beg (match-end 0) lang (org-edit-src-get-lang lang))
5811 (if (and (re-search-forward re2 nil t)
5812 (>= (match-end 0) pos))
5813 (throw 'exit (list beg (match-beginning 0) lang single))))
5814 (if (or (looking-at re2)
5815 (re-search-forward re2 nil t))
5817 (setq end (match-beginning 0))
5818 (if (and (re-search-backward re1 nil t)
5819 (<= (match-beginning 0) pos))
5821 (list (match-end 0) end
5822 (org-edit-src-get-lang lang) single)))))))))))
5824 (defun org-edit-src-get-lang (lang)
5825 "Extract the src language."
5826 (let ((m (match-string 0)))
5828 ((stringp lang) lang)
5829 ((integerp lang) (match-string lang))
5830 ((and (eq lang 'lang)
5831 (string-match "\\<lang=\"\\([^ \t\n\"]+\\)\"" m))
5833 ((and (eq lang 'style)
5834 (string-match "\\<style=\"\\([^ \t\n\"]+\\)\"" m))
5836 (t "fundamental"))))
5838 (defun org-edit-src-exit ()
5839 "Exit special edit and protect problematic lines."
5841 (unless (buffer-base-buffer (current-buffer))
5842 (error "This is not an indirect buffer, something is wrong..."))
5843 (unless (> (point-min) 1)
5844 (error "This buffer is not narrowed, something is wrong..."))
5845 (goto-char (point-min))
5846 (if (looking-at "[ \t\n]*\n") (replace-match ""))
5847 (if (re-search-forward "\n[ \t\n]*\\'" nil t) (replace-match ""))
5848 (when (org-bound-and-true-p org-edit-src-force-single-line)
5849 (goto-char (point-min))
5850 (while (re-search-forward "\n" nil t)
5851 (replace-match " "))
5852 (goto-char (point-min))
5853 (if (looking-at "\\s-*") (replace-match " "))
5854 (if (re-search-forward "\\s-+\\'" nil t)
5855 (replace-match "")))
5856 (when (org-bound-and-true-p org-edit-src-from-org-mode)
5857 (goto-char (point-min))
5858 (while (re-search-forward (if (org-mode-p) "^\\(.\\)" "^\\([*#]\\)") nil t)
5859 (replace-match ",\\1"))
5860 (when font-lock-mode
5861 (font-lock-unfontify-region (point-min) (point-max)))
5862 (put-text-property (point-min) (point-max) 'font-lock-fontified t))
5863 (when (org-bound-and-true-p org-edit-src-picture)
5864 (untabify (point-min) (point-max))
5865 (goto-char (point-min))
5866 (while (re-search-forward "^" nil t)
5867 (replace-match ": "))
5868 (when font-lock-mode
5869 (font-lock-unfontify-region (point-min) (point-max)))
5870 (put-text-property (point-min) (point-max) 'font-lock-fontified t))
5871 (kill-buffer (current-buffer))
5872 (and (org-mode-p) (org-restart-font-lock)))
5875 ;;; The orgstruct minor mode
5877 ;; Define a minor mode which can be used in other modes in order to
5878 ;; integrate the org-mode structure editing commands.
5880 ;; This is really a hack, because the org-mode structure commands use
5881 ;; keys which normally belong to the major mode. Here is how it
5882 ;; works: The minor mode defines all the keys necessary to operate the
5883 ;; structure commands, but wraps the commands into a function which
5884 ;; tests if the cursor is currently at a headline or a plain list
5885 ;; item. If that is the case, the structure command is used,
5886 ;; temporarily setting many Org-mode variables like regular
5887 ;; expressions for filling etc. However, when any of those keys is
5888 ;; used at a different location, function uses `key-binding' to look
5889 ;; up if the key has an associated command in another currently active
5890 ;; keymap (minor modes, major mode, global), and executes that
5891 ;; command. There might be problems if any of the keys is otherwise
5892 ;; used as a prefix key.
5894 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
5895 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
5896 ;; addresses this by checking explicitly for both bindings.
5898 (defvar orgstruct-mode-map (make-sparse-keymap)
5899 "Keymap for the minor `orgstruct-mode'.")
5901 (defvar org-local-vars nil
5902 "List of local variables, for use by `orgstruct-mode'")
5905 (define-minor-mode orgstruct-mode
5906 "Toggle the minor more `orgstruct-mode'.
5907 This mode is for using Org-mode structure commands in other modes.
5908 The following key behave as if Org-mode was active, if the cursor
5909 is on a headline, or on a plain list item (both in the definition
5912 M-up Move entry/item up
5913 M-down Move entry/item down
5916 M-S-up Move entry/item up
5917 M-S-down Move entry/item down
5918 M-S-left Promote subtree
5919 M-S-right Demote subtree
5920 M-q Fill paragraph and items like in Org-mode
5922 C-c - Cycle list bullet
5923 TAB Cycle item visibility
5924 M-RET Insert new heading/item
5925 S-M-RET Insert new TODO heading / Checkbox item
5926 C-c C-c Set tags / toggle checkbox"
5927 nil " OrgStruct" nil
5928 (org-load-modules-maybe)
5929 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
5932 (defun turn-on-orgstruct ()
5933 "Unconditionally turn on `orgstruct-mode'."
5937 (defun turn-on-orgstruct++ ()
5938 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
5939 In addition to setting orgstruct-mode, this also exports all indentation and
5940 autofilling variables from org-mode into the buffer. Note that turning
5941 off orgstruct-mode will *not* remove these additional settings."
5947 "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
5948 (symbol-name (car x)))
5949 (setq var (car x) val (nth 1 x))
5950 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
5953 (defun orgstruct-error ()
5954 "Error when there is no default binding for a structure key."
5956 (error "This key has no function outside structure elements"))
5958 (defun orgstruct-setup ()
5959 "Setup orgstruct keymaps."
5963 '([(meta up)] org-metaup)
5964 '([(meta down)] org-metadown)
5965 '([(meta left)] org-metaleft)
5966 '([(meta right)] org-metaright)
5967 '([(meta shift up)] org-shiftmetaup)
5968 '([(meta shift down)] org-shiftmetadown)
5969 '([(meta shift left)] org-shiftmetaleft)
5970 '([(meta shift right)] org-shiftmetaright)
5971 '([(shift up)] org-shiftup)
5972 '([(shift down)] org-shiftdown)
5973 '([(shift left)] org-shiftleft)
5974 '([(shift right)] org-shiftright)
5975 '("\C-c\C-c" org-ctrl-c-ctrl-c)
5976 '("\M-q" fill-paragraph)
5978 '("\C-c-" org-cycle-list-bullet)))
5980 (while (setq elt (pop bindings))
5981 (setq nfunc (1+ nfunc))
5982 (setq key (org-key (car elt))
5984 cmd (orgstruct-make-binding fun nfunc key))
5985 (org-defkey orgstruct-mode-map key cmd))
5987 ;; Special treatment needed for TAB and RET
5988 (org-defkey orgstruct-mode-map [(tab)]
5989 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
5990 (org-defkey orgstruct-mode-map "\C-i"
5991 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
5993 (org-defkey orgstruct-mode-map "\M-\C-m"
5994 (orgstruct-make-binding 'org-insert-heading 105
5995 "\M-\C-m" [(meta return)]))
5996 (org-defkey orgstruct-mode-map [(meta return)]
5997 (orgstruct-make-binding 'org-insert-heading 106
5998 [(meta return)] "\M-\C-m"))
6000 (org-defkey orgstruct-mode-map [(shift meta return)]
6001 (orgstruct-make-binding 'org-insert-todo-heading 107
6002 [(meta return)] "\M-\C-m"))
6004 (unless org-local-vars
6005 (setq org-local-vars (org-get-local-variables)))
6009 (defun orgstruct-make-binding (fun n &rest keys)
6010 "Create a function for binding in the structure minor mode.
6011 FUN is the command to call inside a table. N is used to create a unique
6012 command name. KEYS are keys that should be checked in for a command
6013 to execute outside of tables."
6016 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
6018 (concat "In Structure, run `" (symbol-name fun) "'.\n"
6019 "Outside of structure, run the binding of `"
6020 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
6024 '(org-context-p 'headline 'item)
6025 (list 'org-run-like-in-org-mode (list 'quote fun))
6026 (list 'let '(orgstruct-mode)
6027 (list 'call-interactively
6030 (list 'key-binding k))
6032 '('orgstruct-error))))))))
6034 (defun org-context-p (&rest contexts)
6035 "Check if local context is any of CONTEXTS.
6036 Possible values in the list of contexts are `table', `headline', and `item'."
6037 (let ((pos (point)))
6038 (goto-char (point-at-bol))
6039 (prog1 (or (and (memq 'table contexts)
6040 (looking-at "[ \t]*|"))
6041 (and (memq 'headline contexts)
6042 ;;????????? (looking-at "\\*+"))
6043 (looking-at outline-regexp))
6044 (and (memq 'item contexts)
6045 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)")))
6048 (defun org-get-local-variables ()
6049 "Return a list of all local variables in an org-mode buffer."
6051 (with-current-buffer (get-buffer-create "*Org tmp*")
6054 (setq varlist (buffer-local-variables)))
6055 (kill-buffer "*Org tmp*")
6062 (list (car x) (list 'quote (cdr x)))))
6064 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
6065 (symbol-name (car x)))
6070 (defun org-run-like-in-org-mode (cmd)
6071 (org-load-modules-maybe)
6072 (unless org-local-vars
6073 (setq org-local-vars (org-get-local-variables)))
6074 (eval (list 'let org-local-vars
6075 (list 'call-interactively (list 'quote cmd)))))
6079 (defun org-get-category (&optional pos)
6080 "Get the category applying to position POS."
6081 (get-text-property (or pos (point)) 'org-category))
6083 (defun org-refresh-category-properties ()
6084 "Refresh category text properties in the buffer."
6085 (let ((def-cat (cond
6086 ((null org-category)
6087 (if buffer-file-name
6088 (file-name-sans-extension
6089 (file-name-nondirectory buffer-file-name))
6091 ((symbolp org-category) (symbol-name org-category))
6093 beg end cat pos optionp)
6098 (goto-char (point-min))
6099 (put-text-property (point) (point-max) 'org-category def-cat)
6100 (while (re-search-forward
6101 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
6102 (setq pos (match-end 0)
6103 optionp (equal (char-after (match-beginning 0)) ?#)
6104 cat (org-trim (match-string 2)))
6106 (setq beg (point-at-bol) end (point-max))
6107 (org-back-to-heading t)
6108 (setq beg (point) end (org-end-of-subtree t t)))
6109 (put-text-property beg end 'org-category cat)
6110 (goto-char pos)))))))
6115 ;;; Link abbreviations
6117 (defun org-link-expand-abbrev (link)
6118 "Apply replacements as defined in `org-link-abbrev-alist."
6119 (if (string-match "^\\([a-zA-Z][-_a-zA-Z0-9]*\\)\\(::?\\(.*\\)\\)?$" link)
6120 (let* ((key (match-string 1 link))
6121 (as (or (assoc key org-link-abbrev-alist-local)
6122 (assoc key org-link-abbrev-alist)))
6123 (tag (and (match-end 2) (match-string 3 link)))
6129 ((symbolp rpl) (funcall rpl tag))
6130 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
6131 ((string-match "%h" rpl)
6132 (replace-match (url-hexify-string (or tag "")) t t rpl))
6133 (t (concat rpl tag)))))
6136 ;;; Storing and inserting links
6138 (defvar org-insert-link-history nil
6139 "Minibuffer history for links inserted with `org-insert-link'.")
6141 (defvar org-stored-links nil
6142 "Contains the links stored with `org-store-link'.")
6144 (defvar org-store-link-plist nil
6145 "Plist with info about the most recently link created with `org-store-link'.")
6147 (defvar org-link-protocols nil
6148 "Link protocols added to Org-mode using `org-add-link-type'.")
6150 (defvar org-store-link-functions nil
6151 "List of functions that are called to create and store a link.
6152 Each function will be called in turn until one returns a non-nil
6153 value. Each function should check if it is responsible for creating
6154 this link (for example by looking at the major mode).
6155 If not, it must exit and return nil.
6156 If yes, it should return a non-nil value after a calling
6157 `org-store-link-props' with a list of properties and values.
6158 Special properties are:
6160 :type The link prefix. like \"http\". This must be given.
6161 :link The link, like \"http://www.astro.uva.nl/~dominik\".
6162 This is obligatory as well.
6163 :description Optional default description for the second pair
6164 of brackets in an Org-mode link. The user can still change
6165 this when inserting this link into an Org-mode buffer.
6167 In addition to these, any additional properties can be specified
6168 and then used in remember templates.")
6170 (defun org-add-link-type (type &optional follow export)
6171 "Add TYPE to the list of `org-link-types'.
6172 Re-compute all regular expressions depending on `org-link-types'
6174 FOLLOW and EXPORT are two functions.
6176 FOLLOW should take the link path as the single argument and do whatever
6177 is necessary to follow the link, for example find a file or display
6180 EXPORT should format the link path for export to one of the export formats.
6181 It should be a function accepting three arguments:
6183 path the path of the link, the text after the prefix (like \"http:\")
6184 desc the description of the link, if any, nil if there was no description
6185 format the export format, a symbol like `html' or `latex'.
6187 The function may use the FORMAT information to return different values
6188 depending on the format. The return value will be put literally into
6190 Org-mode has a built-in default for exporting links. If you are happy with
6191 this default, there is no need to define an export function for the link
6192 type. For a simple example of an export function, see `org-bbdb.el'."
6193 (add-to-list 'org-link-types type t)
6194 (org-make-link-regexps)
6195 (if (assoc type org-link-protocols)
6196 (setcdr (assoc type org-link-protocols) (list follow export))
6197 (push (list type follow export) org-link-protocols)))
6200 (defun org-store-link (arg)
6201 "\\<org-mode-map>Store an org-link to the current location.
6202 This link is added to `org-stored-links' and can later be inserted
6203 into an org-buffer with \\[org-insert-link].
6205 For some link types, a prefix arg is interpreted:
6206 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
6207 For file links, arg negates `org-context-in-file-links'."
6209 (org-load-modules-maybe)
6210 (setq org-store-link-plist nil) ; reset
6211 (let (link cpltxt desc description search txt)
6214 ((run-hook-with-args-until-success 'org-store-link-functions)
6215 (setq link (plist-get org-store-link-plist :link)
6216 desc (or (plist-get org-store-link-plist :description) link)))
6218 ((eq major-mode 'calendar-mode)
6219 (let ((cd (calendar-cursor-to-date)))
6222 (car org-time-stamp-formats)
6224 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
6226 (org-store-link-props :type "calendar" :date cd)))
6228 ((eq major-mode 'w3-mode)
6229 (setq cpltxt (url-view-url t)
6230 link (org-make-link cpltxt))
6231 (org-store-link-props :type "w3" :url (url-view-url t)))
6233 ((eq major-mode 'w3m-mode)
6234 (setq cpltxt (or w3m-current-title w3m-current-url)
6235 link (org-make-link w3m-current-url))
6236 (org-store-link-props :type "w3m" :url (url-view-url t)))
6238 ((setq search (run-hook-with-args-until-success
6239 'org-create-file-search-functions))
6240 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
6242 (setq cpltxt (or description link)))
6244 ((eq major-mode 'image-mode)
6245 (setq cpltxt (concat "file:"
6246 (abbreviate-file-name buffer-file-name))
6247 link (org-make-link cpltxt))
6248 (org-store-link-props :type "image" :file buffer-file-name))
6250 ((eq major-mode 'dired-mode)
6251 ;; link to the file in the current line
6252 (setq cpltxt (concat "file:"
6253 (abbreviate-file-name
6255 (dired-get-filename nil t))))
6256 link (org-make-link cpltxt)))
6258 ((and buffer-file-name (org-mode-p))
6260 ((org-in-regexp "<<\\(.*?\\)>>")
6263 (abbreviate-file-name buffer-file-name)
6264 "::" (match-string 1))
6265 link (org-make-link cpltxt)))
6266 ((and (featurep 'org-id)
6267 (or (eq org-link-to-org-use-id t)
6268 (and (eq org-link-to-org-use-id 'create-if-interactive)
6270 (and org-link-to-org-use-id
6272 (org-entry-get nil "ID")
6274 ;; We can make a link using the ID.
6275 (setq link (condition-case nil
6276 (prog1 (org-id-store-link)
6277 (setq desc (plist-get org-store-link-plist
6280 ;; probably before first headline, link to file only
6282 (abbreviate-file-name buffer-file-name))))))
6284 ;; Just link to current headline
6285 (setq cpltxt (concat "file:"
6286 (abbreviate-file-name buffer-file-name)))
6287 ;; Add a context search string
6288 (when (org-xor org-context-in-file-links arg)
6290 ((org-on-heading-p) nil)
6291 ((org-region-active-p)
6292 (buffer-substring (region-beginning) (region-end)))
6294 (when (or (null txt) (string-match "\\S-" txt))
6298 (org-make-org-heading-search-string txt)
6301 (if (string-match "::\\'" cpltxt)
6302 (setq cpltxt (substring cpltxt 0 -2)))
6303 (setq link (org-make-link cpltxt)))))
6305 ((buffer-file-name (buffer-base-buffer))
6306 ;; Just link to this file here.
6307 (setq cpltxt (concat "file:"
6308 (abbreviate-file-name
6309 (buffer-file-name (buffer-base-buffer)))))
6310 ;; Add a context string
6311 (when (org-xor org-context-in-file-links arg)
6312 (setq txt (if (org-region-active-p)
6313 (buffer-substring (region-beginning) (region-end))
6314 (buffer-substring (point-at-bol) (point-at-eol))))
6315 ;; Only use search option if there is some text.
6316 (when (string-match "\\S-" txt)
6318 (concat cpltxt "::" (org-make-org-heading-search-string txt))
6320 (setq link (org-make-link cpltxt)))
6323 (error "Cannot link to a buffer which is not visiting a file"))
6325 (t (setq link nil)))
6327 (if (consp link) (setq cpltxt (car link) link (cdr link)))
6328 (setq link (or link cpltxt)
6329 desc (or desc cpltxt))
6330 (if (equal desc "NONE") (setq desc nil))
6332 (if (and (interactive-p) link)
6334 (setq org-stored-links
6335 (cons (list link desc) org-stored-links))
6336 (message "Stored: %s" (or desc link)))
6337 (and link (org-make-link-string link desc)))))
6339 (defun org-store-link-props (&rest plist)
6340 "Store link properties, extract names and addresses."
6342 (when (setq x (plist-get plist :from))
6343 (setq adr (mail-extract-address-components x))
6344 (setq plist (plist-put plist :fromname (car adr)))
6345 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
6346 (when (setq x (plist-get plist :to))
6347 (setq adr (mail-extract-address-components x))
6348 (setq plist (plist-put plist :toname (car adr)))
6349 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
6350 (let ((from (plist-get plist :from))
6351 (to (plist-get plist :to)))
6352 (when (and from to org-from-is-user-regexp)
6354 (plist-put plist :fromto
6355 (if (string-match org-from-is-user-regexp from)
6357 (concat "from %f"))))))
6358 (setq org-store-link-plist plist))
6360 (defun org-add-link-props (&rest plist)
6361 "Add these properties to the link property list."
6364 (setq key (pop plist) value (pop plist))
6365 (setq org-store-link-plist
6366 (plist-put org-store-link-plist key value)))))
6368 (defun org-email-link-description (&optional fmt)
6369 "Return the description part of an email link.
6370 This takes information from `org-store-link-plist' and formats it
6371 according to FMT (default from `org-email-link-description-format')."
6372 (setq fmt (or fmt org-email-link-description-format))
6373 (let* ((p org-store-link-plist)
6374 (to (plist-get p :toaddress))
6375 (from (plist-get p :fromaddress))
6378 (cons "%c" (plist-get p :fromto))
6379 (cons "%F" (plist-get p :from))
6380 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
6381 (cons "%T" (plist-get p :to))
6382 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
6383 (cons "%s" (plist-get p :subject))
6384 (cons "%m" (plist-get p :message-id)))))
6385 (when (string-match "%c" fmt)
6386 ;; Check if the user wrote this message
6387 (if (and org-from-is-user-regexp from to
6388 (save-match-data (string-match org-from-is-user-regexp from)))
6389 (setq fmt (replace-match "to %t" t t fmt))
6390 (setq fmt (replace-match "from %f" t t fmt))))
6391 (org-replace-escapes fmt table)))
6393 (defun org-make-org-heading-search-string (&optional string heading)
6394 "Make search string for STRING or current headline."
6396 (let ((s (or string (org-get-heading))))
6397 (unless (and string (not heading))
6398 ;; We are using a headline, clean up garbage in there.
6399 (if (string-match org-todo-regexp s)
6400 (setq s (replace-match "" t t s)))
6401 (if (string-match (org-re ":[[:alnum:]_@:]+:[ \t]*$") s)
6402 (setq s (replace-match "" t t s)))
6403 (setq s (org-trim s))
6404 (if (string-match (concat "^\\(" org-quote-string "\\|"
6405 org-comment-string "\\)") s)
6406 (setq s (replace-match "" t t s)))
6407 (while (string-match org-ts-regexp s)
6408 (setq s (replace-match "" t t s))))
6409 (while (string-match "[^a-zA-Z_0-9 \t]+" s)
6410 (setq s (replace-match " " t t s)))
6411 (or string (setq s (concat "*" s))) ; Add * for headlines
6412 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
6414 (defun org-make-link (&rest strings)
6415 "Concatenate STRINGS."
6416 (apply 'concat strings))
6418 (defun org-make-link-string (link &optional description)
6419 "Make a link with brackets, consisting of LINK and DESCRIPTION."
6420 (unless (string-match "\\S-" link)
6421 (error "Empty link"))
6422 (when (stringp description)
6423 ;; Remove brackets from the description, they are fatal.
6424 (while (string-match "\\[" description)
6425 (setq description (replace-match "{" t t description)))
6426 (while (string-match "\\]" description)
6427 (setq description (replace-match "}" t t description))))
6428 (when (equal (org-link-escape link) description)
6429 ;; No description needed, it is identical
6430 (setq description nil))
6431 (when (and (not description)
6432 (not (equal link (org-link-escape link))))
6433 (setq description (org-extract-attributes link)))
6434 (concat "[[" (org-link-escape link) "]"
6435 (if description (concat "[" description "]") "")
6438 (defconst org-link-escape-chars
6442 (?\340 . "%E0") ; `a
6443 (?\342 . "%E2") ; ^a
6444 (?\347 . "%E7") ; ,c
6445 (?\350 . "%E8") ; `e
6446 (?\351 . "%E9") ; 'e
6447 (?\352 . "%EA") ; ^e
6448 (?\356 . "%EE") ; ^i
6449 (?\364 . "%F4") ; ^o
6450 (?\371 . "%F9") ; `u
6451 (?\373 . "%FB") ; ^u
6457 "Association list of escapes for some characters problematic in links.
6458 This is the list that is used for internal purposes.")
6460 (defconst org-link-escape-chars-browser
6461 '((?\ . "%20")) ; 32 for the SPC char
6462 "Association list of escapes for some characters problematic in links.
6463 This is the list that is used before handing over to the browser.")
6465 (defun org-link-escape (text &optional table)
6466 "Escape characters in TEXT that are problematic for links."
6467 (setq table (or table org-link-escape-chars))
6469 (let ((re (mapconcat (lambda (x) (regexp-quote
6470 (char-to-string (car x))))
6472 (while (string-match re text)
6475 (cdr (assoc (string-to-char (match-string 0 text))
6480 (defun org-link-unescape (text &optional table)
6481 "Reverse the action of `org-link-escape'."
6482 (setq table (or table org-link-escape-chars))
6484 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
6486 (while (string-match re text)
6489 (char-to-string (car (rassoc (match-string 0 text) table)))
6493 (defun org-xor (a b)
6497 (defun org-get-header (header)
6498 "Find a header field in the current buffer."
6500 (goto-char (point-min))
6501 (let ((case-fold-search t) s)
6504 (if (re-search-forward "^From:\\s-+\\(.*\\)" nil t)
6505 (setq s (match-string 1)))
6506 (while (string-match "\"" s)
6507 (setq s (replace-match "" t t s)))
6508 (if (string-match "[<(].*" s)
6509 (setq s (replace-match "" t t s))))
6510 ((eq header 'message-id)
6511 (if (re-search-forward "^message-id:\\s-+\\(.*\\)" nil t)
6512 (setq s (match-string 1))))
6513 ((eq header 'subject)
6514 (if (re-search-forward "^subject:\\s-+\\(.*\\)" nil t)
6515 (setq s (match-string 1)))))
6516 (if (string-match "\\`[ \t\]+" s) (setq s (replace-match "" t t s)))
6517 (if (string-match "[ \t\]+\\'" s) (setq s (replace-match "" t t s)))
6521 (defun org-fixup-message-id-for-http (s)
6522 "Replace special characters in a message id, so it can be used in an http query."
6523 (while (string-match "<" s)
6524 (setq s (replace-match "%3C" t t s)))
6525 (while (string-match ">" s)
6526 (setq s (replace-match "%3E" t t s)))
6527 (while (string-match "@" s)
6528 (setq s (replace-match "%40" t t s)))
6532 (defun org-insert-link-global ()
6533 "Insert a link like Org-mode does.
6534 This command can be called in any mode to insert a link in Org-mode syntax."
6536 (org-load-modules-maybe)
6537 (org-run-like-in-org-mode 'org-insert-link))
6539 (defun org-insert-link (&optional complete-file link-location)
6540 "Insert a link. At the prompt, enter the link.
6542 Completion can be used to insert any of the link protocol prefixes like
6545 The history can be used to select a link previously stored with
6546 `org-store-link'. When the empty string is entered (i.e. if you just
6547 press RET at the prompt), the link defaults to the most recently
6548 stored link. As SPC triggers completion in the minibuffer, you need to
6549 use M-SPC or C-q SPC to force the insertion of a space character.
6551 You will also be prompted for a description, and if one is given, it will
6552 be displayed in the buffer instead of the link.
6554 If there is already a link at point, this command will allow you to edit link
6555 and description parts.
6557 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
6558 be selected using completion. The path to the file will be relative to the
6559 current directory if the file is in the current directory or a subdirectory.
6560 Otherwise, the link will be the absolute path as completed in the minibuffer
6561 \(i.e. normally ~/path/to/file). You can configure this behavior using the
6562 option `org-link-file-path-type'.
6564 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
6565 the current directory or below.
6567 With three \\[universal-argument] prefixes, negate the meaning of
6568 `org-keep-stored-link-after-insertion'.
6570 If `org-make-link-description-function' is non-nil, this function will be
6571 called with the link target, and the result will be the default
6574 If the LINK-LOCATION parameter is non-nil, this value will be
6575 used as the link location instead of reading one interactively."
6577 (let* ((wcf (current-window-configuration))
6578 (region (if (org-region-active-p)
6579 (buffer-substring (region-beginning) (region-end))))
6580 (remove (and region (list (region-beginning) (region-end))))
6582 tmphist ; byte-compile incorrectly complains about this
6583 (link link-location)
6586 (link-location) ; specified by arg, just use it.
6587 ((org-in-regexp org-bracket-link-regexp 1)
6588 ;; We do have a link at point, and we are going to edit it.
6589 (setq remove (list (match-beginning 0) (match-end 0)))
6590 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
6591 (setq link (read-string "Link: "
6593 (org-match-string-no-properties 1)))))
6594 ((or (org-in-regexp org-angle-link-re)
6595 (org-in-regexp org-plain-link-re))
6596 ;; Convert to bracket link
6597 (setq remove (list (match-beginning 0) (match-end 0))
6598 link (read-string "Link: "
6599 (org-remove-angle-brackets (match-string 0)))))
6600 ((member complete-file '((4) (16)))
6601 ;; Completing read for file names.
6602 (setq file (read-file-name "File: "))
6603 (let ((pwd (file-name-as-directory (expand-file-name ".")))
6604 (pwd1 (file-name-as-directory (abbreviate-file-name
6605 (expand-file-name ".")))))
6607 ((equal complete-file '(16))
6608 (setq link (org-make-link
6610 (abbreviate-file-name (expand-file-name file)))))
6611 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
6612 (setq link (org-make-link "file:" (match-string 1 file))))
6613 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
6614 (expand-file-name file))
6615 (setq link (org-make-link
6616 "file:" (match-string 1 (expand-file-name file)))))
6617 (t (setq link (org-make-link "file:" file))))))
6619 ;; Read link, with completion for stored links.
6620 (with-output-to-temp-buffer "*Org Links*"
6621 (princ "Insert a link. Use TAB to complete valid link prefixes.\n")
6622 (when org-stored-links
6623 (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
6626 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
6627 (reverse org-stored-links) "\n"))))
6628 (let ((cw (selected-window)))
6629 (select-window (get-buffer-window "*Org Links*"))
6630 (org-fit-window-to-buffer)
6631 (setq truncate-lines t)
6633 ;; Fake a link history, containing the stored links.
6634 (setq tmphist (append (mapcar 'car org-stored-links)
6635 org-insert-link-history))
6637 (setq link (org-completing-read
6640 (mapcar (lambda (x) (list (concat (car x) ":")))
6641 (append org-link-abbrev-alist-local org-link-abbrev-alist))
6642 (mapcar (lambda (x) (list (concat x ":")))
6646 (or (car (car org-stored-links)))))
6647 (set-window-configuration wcf)
6648 (kill-buffer "*Org Links*"))
6649 (setq entry (assoc link org-stored-links))
6650 (or entry (push link org-insert-link-history))
6651 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
6652 (not org-keep-stored-link-after-insertion))
6653 (setq org-stored-links (delq (assoc link org-stored-links)
6655 (setq desc (or desc (nth 1 entry)))))
6657 (if (string-match org-plain-link-re link)
6658 ;; URL-like link, normalize the use of angular brackets.
6659 (setq link (org-make-link (org-remove-angle-brackets link))))
6661 ;; Check if we are linking to the current file with a search option
6662 ;; If yes, simplify the link by using only the search option.
6663 (when (and buffer-file-name
6664 (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
6665 (let* ((path (match-string 1 link))
6666 (case-fold-search nil)
6667 (search (match-string 2 link)))
6669 (if (equal (file-truename buffer-file-name) (file-truename path))
6670 ;; We are linking to this same file, with a search option
6671 (setq link search)))))
6673 ;; Check if we can/should use a relative path. If yes, simplify the link
6674 (when (string-match "^file:\\(.*\\)" link)
6675 (let* ((path (match-string 1 link))
6677 (case-fold-search nil))
6679 ((or (eq org-link-file-path-type 'absolute)
6680 (equal complete-file '(16)))
6681 (setq path (abbreviate-file-name (expand-file-name path))))
6682 ((eq org-link-file-path-type 'noabbrev)
6683 (setq path (expand-file-name path)))
6684 ((eq org-link-file-path-type 'relative)
6685 (setq path (file-relative-name path)))
6688 (if (string-match (concat "^" (regexp-quote
6689 (file-name-as-directory
6690 (expand-file-name "."))))
6691 (expand-file-name path))
6692 ;; We are linking a file with relative path name.
6693 (setq path (substring (expand-file-name path)
6695 (setq path (abbreviate-file-name (expand-file-name path)))))))
6696 (setq link (concat "file:" path))
6697 (if (equal desc origpath)
6700 (if org-make-link-description-function
6701 (setq desc (funcall org-make-link-description-function link desc)))
6703 (setq desc (read-string "Description: " desc))
6704 (unless (string-match "\\S-" desc) (setq desc nil))
6705 (if remove (apply 'delete-region remove))
6706 (insert (org-make-link-string link desc))))
6708 (defun org-completing-read (&rest args)
6709 "Completing-read with SPACE being a normal character."
6710 (let ((minibuffer-local-completion-map
6711 (copy-keymap minibuffer-local-completion-map)))
6712 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
6713 (apply 'org-ido-completing-read args)))
6715 (defun org-ido-completing-read (&rest args)
6716 "Completing-read using `ido-mode' speedups if available"
6717 (if (and org-completion-use-ido
6718 (fboundp 'ido-completing-read)
6719 (boundp 'ido-mode) ido-mode
6720 (listp (second args)))
6721 (apply 'ido-completing-read (concat (car args)) (cdr args))
6722 (apply 'completing-read args)))
6724 (defun org-extract-attributes (s)
6725 "Extract the attributes cookie from a string and set as text property."
6726 (let (a attr (start 0) key value)
6728 (when (string-match "{{\\([^}]+\\)}}$" s)
6729 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
6730 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
6731 (setq key (match-string 1 a) value (match-string 2 a)
6733 attr (plist-put attr (intern key) value))))
6734 (org-add-props s nil 'org-attr attr))
6737 (defun org-attributes-to-string (plist)
6738 "Format a property list into an HTML attribute list."
6739 (let ((s "") key value)
6741 (setq key (pop plist) value (pop plist))
6743 (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
6746 ;;; Opening/following a link
6748 (defvar org-link-search-failed nil)
6750 (defun org-next-link ()
6751 "Move forward to the next link.
6752 If the link is in hidden text, expose it."
6754 (when (and org-link-search-failed (eq this-command last-command))
6755 (goto-char (point-min))
6756 (message "Link search wrapped back to beginning of buffer"))
6757 (setq org-link-search-failed nil)
6758 (let* ((pos (point))
6760 (a (assoc :link ct)))
6761 (if a (goto-char (nth 2 a)))
6762 (if (re-search-forward org-any-link-re nil t)
6764 (goto-char (match-beginning 0))
6765 (if (org-invisible-p) (org-show-context)))
6767 (setq org-link-search-failed t)
6768 (error "No further link found"))))
6770 (defun org-previous-link ()
6771 "Move backward to the previous link.
6772 If the link is in hidden text, expose it."
6774 (when (and org-link-search-failed (eq this-command last-command))
6775 (goto-char (point-max))
6776 (message "Link search wrapped back to end of buffer"))
6777 (setq org-link-search-failed nil)
6778 (let* ((pos (point))
6780 (a (assoc :link ct)))
6781 (if a (goto-char (nth 1 a)))
6782 (if (re-search-backward org-any-link-re nil t)
6784 (goto-char (match-beginning 0))
6785 (if (org-invisible-p) (org-show-context)))
6787 (setq org-link-search-failed t)
6788 (error "No further link found"))))
6790 (defun org-translate-link (s)
6791 "Translate a link string if a translation function has been defined."
6792 (if (and org-link-translation-function
6793 (fboundp org-link-translation-function)
6794 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
6796 (setq s (funcall org-link-translation-function
6797 (match-string 1) (match-string 2)))
6798 (concat (car s) ":" (cdr s)))
6801 (defun org-translate-link-from-planner (type path)
6802 "Translate a link from Emacs Planner syntax so that Org can follow it.
6803 This is still an experimental function, your mileage may vary."
6805 ((member type '("http" "https" "news" "ftp"))
6806 ;; standard Internet links are the same.
6808 ((and (equal type "irc") (string-match "^//" path))
6809 ;; Planner has two / at the beginning of an irc link, we have 1.
6810 ;; We should have zero, actually....
6811 (setq path (substring path 1)))
6812 ((and (equal type "lisp") (string-match "^/" path))
6813 ;; Planner has a slash, we do not.
6814 (setq type "elisp" path (substring path 1)))
6815 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
6816 ;; A typical message link. Planner has the id after the fina slash,
6817 ;; we separate it with a hash mark
6818 (setq path (concat (match-string 1 path) "#"
6819 (org-remove-angle-brackets (match-string 2 path)))))
6823 (defun org-find-file-at-mouse (ev)
6824 "Open file link or URL at mouse."
6826 (mouse-set-point ev)
6827 (org-open-at-point 'in-emacs))
6829 (defun org-open-at-mouse (ev)
6830 "Open file link or URL at mouse."
6832 (mouse-set-point ev)
6833 (if (eq major-mode 'org-agenda-mode)
6834 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
6835 (org-open-at-point))
6837 (defvar org-window-config-before-follow-link nil
6838 "The window configuration before following a link.
6839 This is saved in case the need arises to restore it.")
6841 (defvar org-open-link-marker (make-marker)
6842 "Marker pointing to the location where `org-open-at-point; was called.")
6845 (defun org-open-at-point-global ()
6846 "Follow a link like Org-mode does.
6847 This command can be called in any mode to follow a link that has
6850 (org-run-like-in-org-mode 'org-open-at-point))
6853 (defun org-open-link-from-string (s &optional arg)
6854 "Open a link in the string S, as if it was in Org-mode."
6855 (interactive "sLink: \nP")
6857 (let ((org-inhibit-startup t))
6860 (goto-char (point-min))
6861 (org-open-at-point arg))))
6863 (defun org-open-at-point (&optional in-emacs)
6864 "Open link at or after point.
6865 If there is no link at point, this function will search forward up to
6866 the end of the current subtree.
6867 Normally, files will be opened by an appropriate application. If the
6868 optional argument IN-EMACS is non-nil, Emacs will visit the file.
6869 With a double prefix argument, try to open outside of Emacs, in the
6870 application the system uses for this file type."
6872 (org-load-modules-maybe)
6873 (move-marker org-open-link-marker (point))
6874 (setq org-window-config-before-follow-link (current-window-configuration))
6875 (org-remove-occur-highlights nil nil t)
6876 (if (org-at-timestamp-p t)
6877 (org-follow-timestamp-link)
6878 (let (type path link line search (pos (point)))
6881 (skip-chars-forward "^]\n\r")
6882 (when (org-in-regexp org-bracket-link-regexp)
6883 (setq link (org-extract-attributes
6884 (org-link-unescape (org-match-string-no-properties 1))))
6885 (while (string-match " *\n *" link)
6886 (setq link (replace-match " " t t link)))
6887 (setq link (org-link-expand-abbrev link))
6889 ((or (file-name-absolute-p link)
6890 (string-match "^\\.\\.?/" link))
6891 (setq type "file" path link))
6892 ((string-match org-link-re-with-space3 link)
6893 (setq type (match-string 1 link) path (match-string 2 link)))
6894 (t (setq type "thisfile" path link)))
6897 (when (get-text-property (point) 'org-linked-text)
6898 (setq type "thisfile"
6899 pos (if (get-text-property (1+ (point)) 'org-linked-text)
6900 (1+ (point)) (point))
6901 path (buffer-substring
6902 (previous-single-property-change pos 'org-linked-text)
6903 (next-single-property-change pos 'org-linked-text)))
6907 (when (or (org-in-regexp org-angle-link-re)
6908 (org-in-regexp org-plain-link-re))
6909 (setq type (match-string 1) path (match-string 2))
6911 (when (org-in-regexp "\\<\\([^><\n]+\\)\\>")
6912 (setq type "tree-match"
6913 path (match-string 1))
6916 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
6918 path (match-string 1))
6919 (while (string-match ":" path)
6920 (setq path (replace-match "+" t t path)))
6923 (error "No link found"))
6924 ;; Remove any trailing spaces in path
6925 (if (string-match " +\\'" path)
6926 (setq path (replace-match "" t t path)))
6927 (if (and org-link-translation-function
6928 (fboundp org-link-translation-function))
6929 ;; Check if we need to translate the link
6930 (let ((tmp (funcall org-link-translation-function type path)))
6931 (setq type (car tmp) path (cdr tmp))))
6935 ((assoc type org-link-protocols)
6936 (funcall (nth 1 (assoc type org-link-protocols)) path))
6938 ((equal type "mailto")
6939 (let ((cmd (car org-link-mailto-program))
6940 (args (cdr org-link-mailto-program)) args1
6941 (address path) (subject "") a)
6942 (if (string-match "\\(.*\\)::\\(.*\\)" path)
6943 (setq address (match-string 1 path)
6944 subject (org-link-escape (match-string 2 path))))
6947 ((not (stringp (car args))) (push (pop args) args1))
6948 (t (setq a (pop args))
6949 (if (string-match "%a" a)
6950 (setq a (replace-match address t t a)))
6951 (if (string-match "%s" a)
6952 (setq a (replace-match subject t t a)))
6954 (apply cmd (nreverse args1))))
6956 ((member type '("http" "https" "ftp" "news"))
6957 (browse-url (concat type ":" (org-link-escape
6958 path org-link-escape-chars-browser))))
6960 ((member type '("message"))
6961 (browse-url (concat type ":" path)))
6963 ((string= type "tags")
6964 (org-tags-view in-emacs path))
6965 ((string= type "thisfile")
6967 (switch-to-buffer-other-window
6968 (org-get-buffer-for-internal-link (current-buffer)))
6969 (org-mark-ring-push))
6970 (let ((cmd `(org-link-search
6972 ,(cond ((equal in-emacs '(4)) 'occur)
6973 ((equal in-emacs '(16)) 'org-occur)
6976 (condition-case nil (eval cmd)
6977 (error (progn (widen) (eval cmd))))))
6979 ((string= type "tree-match")
6980 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
6982 ((string= type "file")
6983 (if (string-match "::\\([0-9]+\\)\\'" path)
6984 (setq line (string-to-number (match-string 1 path))
6985 path (substring path 0 (match-beginning 0)))
6986 (if (string-match "::\\(.+\\)\\'" path)
6987 (setq search (match-string 1 path)
6988 path (substring path 0 (match-beginning 0)))))
6989 (if (string-match "[*?{]" (file-name-nondirectory path))
6991 (org-open-file path in-emacs line search)))
6993 ((string= type "news")
6995 (org-gnus-follow-link path))
6997 ((string= type "shell")
6999 (if (or (not org-confirm-shell-link-function)
7000 (funcall org-confirm-shell-link-function
7001 (format "Execute \"%s\" in shell? "
7002 (org-add-props cmd nil
7003 'face 'org-warning))))
7005 (message "Executing %s" cmd)
7006 (shell-command cmd))
7009 ((string= type "elisp")
7011 (if (or (not org-confirm-elisp-link-function)
7012 (funcall org-confirm-elisp-link-function
7013 (format "Execute \"%s\" as elisp? "
7014 (org-add-props cmd nil
7015 'face 'org-warning))))
7016 (message "%s => %s" cmd
7017 (if (equal (string-to-char cmd) ?\()
7019 (call-interactively (read cmd))))
7023 (browse-url-at-point)))))
7024 (move-marker org-open-link-marker nil)
7025 (run-hook-with-args 'org-follow-link-hook))
7029 (defun org-get-effort (&optional pom)
7030 "Get the effort estimate for the current entry."
7031 (org-entry-get pom org-effort-property))
7035 (defvar org-create-file-search-functions nil
7036 "List of functions to construct the right search string for a file link.
7037 These functions are called in turn with point at the location to
7038 which the link should point.
7040 A function in the hook should first test if it would like to
7041 handle this file type, for example by checking the major-mode or
7042 the file extension. If it decides not to handle this file, it
7043 should just return nil to give other functions a chance. If it
7044 does handle the file, it must return the search string to be used
7045 when following the link. The search string will be part of the
7046 file link, given after a double colon, and `org-open-at-point'
7047 will automatically search for it. If special measures must be
7048 taken to make the search successful, another function should be
7049 added to the companion hook `org-execute-file-search-functions',
7052 A function in this hook may also use `setq' to set the variable
7053 `description' to provide a suggestion for the descriptive text to
7054 be used for this link when it gets inserted into an Org-mode
7055 buffer with \\[org-insert-link].")
7057 (defvar org-execute-file-search-functions nil
7058 "List of functions to execute a file search triggered by a link.
7060 Functions added to this hook must accept a single argument, the
7061 search string that was part of the file link, the part after the
7062 double colon. The function must first check if it would like to
7063 handle this search, for example by checking the major-mode or the
7064 file extension. If it decides not to handle this search, it
7065 should just return nil to give other functions a chance. If it
7066 does handle the search, it must return a non-nil value to keep
7067 other functions from trying.
7069 Each function can access the current prefix argument through the
7070 variable `current-prefix-argument'. Note that a single prefix is
7071 used to force opening a link in Emacs, so it may be good to only
7072 use a numeric or double prefix to guide the search function.
7074 In case this is needed, a function in this hook can also restore
7075 the window configuration before `org-open-at-point' was called using:
7077 (set-window-configuration org-window-config-before-follow-link)")
7079 (defun org-link-search (s &optional type avoid-pos)
7080 "Search for a link search option.
7081 If S is surrounded by forward slashes, it is interpreted as a
7082 regular expression. In org-mode files, this will create an `org-occur'
7083 sparse tree. In ordinary files, `occur' will be used to list matches.
7084 If the current buffer is in `dired-mode', grep will be used to search
7085 in all files. If AVOID-POS is given, ignore matches near that position."
7086 (let ((case-fold-search t)
7087 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
7088 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
7089 (append '(("") (" ") ("\t") ("\n"))
7093 (pre nil) (post nil)
7094 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
7096 ;; First check if there are any special
7097 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
7098 ;; Now try the builtin stuff
7100 (goto-char (point-min))
7103 (concat "<<" (regexp-quote s0) ">>") nil t)
7104 (setq type 'dedicated
7105 pos (match-beginning 0))))
7106 ;; There is an exact target for this
7108 ((string-match "^/\\(.*\\)/$" s)
7109 ;; A regular expression
7112 (org-occur (match-string 1 s)))
7113 ;;((eq major-mode 'dired-mode)
7114 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
7115 (t (org-do-occur (match-string 1 s)))))
7117 ;; A normal search strings
7118 (when (equal (string-to-char s) ?*)
7119 ;; Anchor on headlines, post may include tags.
7120 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
7121 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@:+]:[ \t]*\\)?$")
7123 (remove-text-properties
7125 '(face nil mouse-face nil keymap nil fontified nil) s)
7126 ;; Make a series of regular expressions to find a match
7127 (setq words (org-split-string s "[ \n\r\t]+")
7129 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
7130 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
7132 re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
7133 re2a (concat "[ \t\r\n]" re2a_)
7134 re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
7135 re4 (concat "[^a-zA-Z_]" re4_)
7137 re1 (concat pre re2 post)
7138 re3 (concat pre (if pre re4_ re4) post)
7139 re5 (concat pre ".*" re4)
7140 re2 (concat pre re2)
7141 re2a (concat pre (if pre re2a_ re2a))
7142 re4 (concat pre (if pre re4_ re4))
7143 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
7144 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
7148 ((eq type 'org-occur) (org-occur reall))
7149 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
7150 (t (goto-char (point-min))
7152 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
7153 (org-search-not-self 1 re1 nil t)
7154 (org-search-not-self 1 re2 nil t)
7155 (org-search-not-self 1 re2a nil t)
7156 (org-search-not-self 1 re3 nil t)
7157 (org-search-not-self 1 re4 nil t)
7158 (org-search-not-self 1 re5 nil t)
7160 (goto-char (match-beginning 1))
7162 (error "No match")))))
7164 ;; Normal string-search
7165 (goto-char (point-min))
7166 (if (search-forward s nil t)
7167 (goto-char (match-beginning 0))
7168 (error "No match"))))
7169 (and (org-mode-p) (org-show-context 'link-search))
7172 (defun org-search-not-self (group &rest args)
7173 "Execute `re-search-forward', but only accept matches that do not
7174 enclose the position of `org-open-link-marker'."
7175 (let ((m org-open-link-marker))
7177 (while (apply 're-search-forward args)
7178 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
7179 (goto-char (match-end group))
7180 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
7181 (> (match-beginning 0) (marker-position m))
7182 (< (match-end 0) (marker-position m)))
7184 (or (not (org-in-regexp
7185 org-bracket-link-analytic-regexp 1))
7186 (not (match-end 4)) ; no description
7187 (and (<= (match-beginning 4) (point))
7188 (>= (match-end 4) (point))))))
7189 (throw 'exit (point))))))))
7191 (defun org-get-buffer-for-internal-link (buffer)
7192 "Return a buffer to be used for displaying the link target of internal links."
7194 ((not org-display-internal-link-with-indirect-buffer)
7196 ((string-match "(Clone)$" (buffer-name buffer))
7197 (message "Buffer is already a clone, not making another one")
7198 ;; we also do not modify visibility in this case
7200 (t ; make a new indirect buffer for displaying the link
7201 (let* ((bn (buffer-name buffer))
7202 (ibn (concat bn "(Clone)"))
7203 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
7204 (with-current-buffer ib (org-overview))
7207 (defun org-do-occur (regexp &optional cleanup)
7208 "Call the Emacs command `occur'.
7209 If CLEANUP is non-nil, remove the printout of the regular expression
7210 in the *Occur* buffer. This is useful if the regex is long and not useful
7214 (let ((cwin (selected-window)) win beg end)
7215 (when (setq win (get-buffer-window "*Occur*"))
7216 (select-window win))
7217 (goto-char (point-min))
7218 (when (re-search-forward "match[a-z]+" nil t)
7219 (setq beg (match-end 0))
7220 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
7221 (setq end (1- (match-beginning 0)))))
7222 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
7223 (goto-char (point-min))
7224 (select-window cwin))))
7226 ;;; The mark ring for links jumps
7228 (defvar org-mark-ring nil
7229 "Mark ring for positions before jumps in Org-mode.")
7230 (defvar org-mark-ring-last-goto nil
7231 "Last position in the mark ring used to go back.")
7232 ;; Fill and close the ring
7233 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
7234 (loop for i from 1 to org-mark-ring-length do
7235 (push (make-marker) org-mark-ring))
7236 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
7239 (defun org-mark-ring-push (&optional pos buffer)
7240 "Put the current position or POS into the mark ring and rotate it."
7242 (setq pos (or pos (point)))
7243 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
7244 (move-marker (car org-mark-ring)
7246 (or buffer (current-buffer)))
7248 (substitute-command-keys
7249 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
7251 (defun org-mark-ring-goto (&optional n)
7252 "Jump to the previous position in the mark ring.
7253 With prefix arg N, jump back that many stored positions. When
7254 called several times in succession, walk through the entire ring.
7255 Org-mode commands jumping to a different position in the current file,
7256 or to another Org-mode file, automatically push the old position
7260 (if (eq last-command this-command)
7261 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
7262 (setq p org-mark-ring))
7263 (setq org-mark-ring-last-goto p)
7265 (switch-to-buffer (marker-buffer m))
7267 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
7269 (defun org-remove-angle-brackets (s)
7270 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
7271 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
7273 (defun org-add-angle-brackets (s)
7274 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
7275 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
7277 (defun org-remove-double-quotes (s)
7278 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
7279 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
7282 ;;; Following specific links
7284 (defun org-follow-timestamp-link ()
7286 ((org-at-date-range-p t)
7287 (let ((org-agenda-start-on-weekday)
7288 (t1 (match-string 1))
7289 (t2 (match-string 2)))
7290 (setq t1 (time-to-days (org-time-string-to-time t1))
7291 t2 (time-to-days (org-time-string-to-time t2)))
7292 (org-agenda-list nil t1 (1+ (- t2 t1)))))
7293 ((org-at-timestamp-p t)
7294 (org-agenda-list nil (time-to-days (org-time-string-to-time
7295 (substring (match-string 1) 0 10)))
7297 (t (error "This should not happen"))))
7300 ;;; Following file links
7301 (defvar org-wait nil)
7302 (defun org-open-file (path &optional in-emacs line search)
7303 "Open the file at PATH.
7304 First, this expands any special file name abbreviations. Then the
7305 configuration variable `org-file-apps' is checked if it contains an
7306 entry for this file type, and if yes, the corresponding command is launched.
7308 If no application is found, Emacs simply visits the file.
7310 With optional prefix argument IN-EMACS, Emacs will visit the file.
7311 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
7312 and o use an external application to visit the file.
7314 Optional LINE specifies a line to go to, optional SEARCH a string to
7315 search for. If LINE or SEARCH is given, the file will always be
7317 If the file does not exist, an error is thrown."
7318 (setq in-emacs (or in-emacs line search))
7319 (let* ((file (if (equal path "")
7321 (substitute-in-file-name (expand-file-name path))))
7322 (apps (append org-file-apps (org-default-apps)))
7323 (remp (and (assq 'remote apps) (org-file-remote-p file)))
7324 (dirp (if remp nil (file-directory-p file)))
7325 (file (if (and dirp org-open-directory-means-index-dot-org)
7326 (concat (file-name-as-directory file) "index.org")
7328 (a-m-a-p (assq 'auto-mode apps))
7329 (dfile (downcase file))
7330 (old-buffer (current-buffer))
7332 (old-mode major-mode)
7334 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
7335 (setq ext (match-string 1 dfile))
7336 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
7337 (setq ext (match-string 1 dfile))))
7339 ((equal in-emacs '(16))
7340 (setq cmd (cdr (assoc 'system apps))))
7341 (in-emacs (setq cmd 'emacs))
7343 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
7344 (and dirp (cdr (assoc 'directory apps)))
7345 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
7347 (cdr (assoc ext apps))
7348 (cdr (assoc t apps))))))
7349 (when (eq cmd 'system)
7350 (setq cmd (cdr (assoc 'system apps))))
7351 (when (eq cmd 'default)
7352 (setq cmd (cdr (assoc t apps))))
7353 (when (eq cmd 'mailcap)
7355 (mailcap-parse-mailcaps)
7356 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
7357 (command (mailcap-mime-info mime-type)))
7358 (if (stringp command)
7360 (setq cmd 'emacs))))
7361 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
7362 (not (file-exists-p file))
7363 (not org-open-non-existing-files))
7364 (error "No such file: %s" file))
7366 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
7367 ;; Remove quotes around the file name - we'll use shell-quote-argument.
7368 (while (string-match "['\"]%s['\"]" cmd)
7369 (setq cmd (replace-match "%s" t t cmd)))
7370 (while (string-match "%s" cmd)
7371 (setq cmd (replace-match
7373 (shell-quote-argument
7374 (convert-standard-filename file)))
7376 (save-window-excursion
7377 (start-process-shell-command cmd nil cmd)
7378 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
7382 (funcall (cdr (assq 'file org-link-frame-setup)) file)
7384 (if line (goto-line line)
7385 (if search (org-link-search search))))
7387 (let ((file (convert-standard-filename file)))
7389 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
7390 (and (org-mode-p) (eq old-mode 'org-mode)
7391 (or (not (equal old-buffer (current-buffer)))
7392 (not (equal old-pos (point))))
7393 (org-mark-ring-push old-pos old-buffer))))
7395 (defun org-default-apps ()
7396 "Return the default applications for this operating system."
7398 ((eq system-type 'darwin)
7399 org-file-apps-defaults-macosx)
7400 ((eq system-type 'windows-nt)
7401 org-file-apps-defaults-windowsnt)
7402 (t org-file-apps-defaults-gnu)))
7404 (defun org-apps-regexp-alist (list &optional add-auto-mode)
7405 "Convert extensions to regular expressions in the cars of LIST.
7406 Also, weed out any non-string entries, because the return value is used
7407 only for regexp matching.
7408 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
7409 point to the symbol `emacs', indicating that the file should
7410 be opened in Emacs."
7414 (if (not (stringp (car x)))
7416 (if (string-match "\\W" (car x))
7418 (cons (concat "\\." (car x) "\\'") (cdr x)))))
7421 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
7423 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
7424 (defun org-file-remote-p (file)
7425 "Test whether FILE specifies a location on a remote system.
7426 Return non-nil if the location is indeed remote.
7428 For example, the filename \"/user@host:/foo\" specifies a location
7429 on the system \"/user@host:\"."
7430 (cond ((fboundp 'file-remote-p)
7431 (file-remote-p file))
7432 ((fboundp 'tramp-handle-file-remote-p)
7433 (tramp-handle-file-remote-p file))
7434 ((and (boundp 'ange-ftp-name-format)
7435 (string-match (car ange-ftp-name-format) file))
7442 (defun org-get-org-file ()
7443 "Read a filename, with default directory `org-directory'."
7444 (let ((default (or org-default-notes-file remember-data-file)))
7445 (read-file-name (format "File name [%s]: " default)
7446 (file-name-as-directory org-directory)
7449 (defun org-notes-order-reversed-p ()
7450 "Check if the current file should receive notes in reversed order."
7452 ((not org-reverse-note-order) nil)
7453 ((eq t org-reverse-note-order) t)
7454 ((not (listp org-reverse-note-order)) nil)
7456 (let ((all org-reverse-note-order)
7458 (while (setq entry (pop all))
7459 (if (string-match (car entry) buffer-file-name)
7460 (throw 'exit (cdr entry))))
7463 (defvar org-refile-target-table nil
7464 "The list of refile targets, created by `org-refile'.")
7466 (defvar org-agenda-new-buffers nil
7467 "Buffers created to visit agenda files.")
7469 (defun org-get-refile-targets (&optional default-buffer)
7470 "Produce a table with refile targets."
7471 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
7472 targets txt re files f desc descre fast-path-p level)
7473 (message "Getting targets...")
7474 (with-current-buffer (or default-buffer (current-buffer))
7475 (while (setq entry (pop entries))
7476 (setq files (car entry) desc (cdr entry))
7477 (setq fast-path-p nil)
7479 ((null files) (setq files (list (current-buffer))))
7480 ((eq files 'org-agenda-files)
7481 (setq files (org-agenda-files 'unrestricted)))
7482 ((and (symbolp files) (fboundp files))
7483 (setq files (funcall files)))
7484 ((and (symbolp files) (boundp files))
7485 (setq files (symbol-value files))))
7486 (if (stringp files) (setq files (list files)))
7488 ((eq (car desc) :tag)
7489 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
7490 ((eq (car desc) :todo)
7491 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
7492 ((eq (car desc) :regexp)
7493 (setq descre (cdr desc)))
7494 ((eq (car desc) :level)
7495 (setq descre (concat "^\\*\\{" (number-to-string
7496 (if org-odd-levels-only
7497 (1- (* 2 (cdr desc)))
7500 ((eq (car desc) :maxlevel)
7501 (setq fast-path-p t)
7502 (setq descre (concat "^\\*\\{1," (number-to-string
7503 (if org-odd-levels-only
7504 (1- (* 2 (cdr desc)))
7507 (t (error "Bad refiling target description %s" desc)))
7508 (while (setq f (pop files))
7510 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
7511 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
7512 (setq f (expand-file-name f))
7516 (goto-char (point-min))
7517 (while (re-search-forward descre nil t)
7518 (goto-char (point-at-bol))
7519 (when (looking-at org-complex-heading-regexp)
7520 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
7521 txt (org-link-display-format (match-string 4))
7522 re (concat "^" (regexp-quote
7523 (buffer-substring (match-beginning 1)
7525 (if (match-end 5) (setq re (concat re "[ \t]+"
7527 (match-string 5)))))
7528 (setq re (concat re "[ \t]*$"))
7529 (when org-refile-use-outline-path
7530 (setq txt (mapconcat 'org-protect-slash
7532 (if (eq org-refile-use-outline-path 'file)
7533 (list (file-name-nondirectory
7534 (buffer-file-name (buffer-base-buffer))))
7535 (if (eq org-refile-use-outline-path 'full-file-path)
7536 (list (buffer-file-name (buffer-base-buffer)))))
7537 (org-get-outline-path fast-path-p level txt)
7540 (push (list txt f re (point)) targets))
7541 (goto-char (point-at-eol))))))))
7542 (message "Getting targets...done")
7543 (nreverse targets))))
7545 (defun org-protect-slash (s)
7546 (while (string-match "/" s)
7547 (setq s (replace-match "\\" t t s)))
7550 (defvar org-olpa (make-vector 20 nil))
7552 (defun org-get-outline-path (&optional fastp level heading)
7553 "Return the outline path to the current entry, as a list."
7557 (error "Outline path failure, more than 19 levels."))
7558 (loop for i from level upto 19 do
7559 (aset org-olpa i nil))
7561 (delq nil (append org-olpa nil))
7562 (aset org-olpa level heading)))
7565 (while (org-up-heading-safe)
7566 (when (looking-at org-complex-heading-regexp)
7567 (push (org-match-string-no-properties 4) rtn)))
7570 (defvar org-refile-history nil
7571 "History for refiling operations.")
7573 (defun org-refile (&optional goto default-buffer)
7574 "Move the entry at point to another heading.
7575 The list of target headings is compiled using the information in
7576 `org-refile-targets', which see. This list is created before each use
7577 and will therefore always be up-to-date.
7579 At the target location, the entry is filed as a subitem of the target heading.
7580 Depending on `org-reverse-note-order', the new subitem will either be the
7581 first or the last subitem.
7583 If there is an active region, all entries in that region will be moved.
7584 However, the region must fulfil the requirement that the first heading
7585 is the first one sets the top-level of the moved text - at most siblings
7586 below it are allowed.
7588 With prefix arg GOTO, the command will only visit the target location,
7589 not actually move anything.
7590 With a double prefix `C-u C-u', go to the location where the last refiling
7591 operation has put the subtree."
7593 (let* ((cbuf (current-buffer))
7594 (regionp (org-region-active-p))
7595 (region-start (and regionp (region-beginning)))
7596 (region-end (and regionp (region-end)))
7597 (region-length (and regionp (- region-end region-start)))
7598 (filename (buffer-file-name (buffer-base-buffer cbuf)))
7599 pos it nbuf file re level reversed)
7600 (when regionp (goto-char region-start)
7601 (unless (org-kill-is-subtree-p
7602 (buffer-substring region-start region-end))
7603 (error "The region is not a (sequence of) subtree(s)")))
7604 (if (equal goto '(16))
7605 (org-refile-goto-last-stored)
7606 (when (setq it (org-refile-get-location
7607 (if goto "Goto: " "Refile to: ") default-buffer))
7608 (setq file (nth 1 it)
7611 (if (and (equal (buffer-file-name) file)
7613 (and (>= pos region-start)
7614 (<= pos region-end))
7615 (and (>= pos (point))
7616 (< pos (save-excursion
7617 (org-end-of-subtree t t))))))
7618 (error "Cannot refile to position inside the tree or region"))
7620 (setq nbuf (or (find-buffer-visiting file)
7621 (find-file-noselect file)))
7624 (switch-to-buffer nbuf)
7626 (org-show-context 'org-goto))
7629 (kill-new (buffer-substring region-start region-end))
7630 (org-save-markers-in-region region-start region-end))
7631 (org-copy-subtree 1 nil t))
7633 (set-buffer (setq nbuf (or (find-buffer-visiting file)
7634 (find-file-noselect file))))
7635 (setq reversed (org-notes-order-reversed-p))
7640 (looking-at outline-regexp)
7641 (setq level (org-get-valid-level (funcall outline-level) 1))
7644 (or (outline-next-heading) (point-max))
7645 (or (save-excursion (outline-get-next-sibling))
7646 (org-end-of-subtree t t)
7648 (if (not (bolp)) (newline))
7649 (bookmark-set "org-refile-last-stored")
7650 (org-paste-subtree level))))
7652 (delete-region (point) (+ (point) region-length))
7654 (setq org-markers-to-move nil)
7655 (message "Refiled to \"%s\"" (car it)))))))
7657 (defun org-refile-goto-last-stored ()
7658 "Go to the location where the last refile was stored."
7660 (bookmark-jump "org-refile-last-stored")
7661 (message "This is the location of the last refile"))
7663 (defun org-refile-get-location (&optional prompt default-buffer)
7664 "Prompt the user for a refile location, using PROMPT."
7665 (let ((org-refile-targets org-refile-targets)
7666 (org-refile-use-outline-path org-refile-use-outline-path))
7667 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
7668 (unless org-refile-target-table
7669 (error "No refile targets"))
7670 (let* ((cbuf (current-buffer))
7671 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
7672 (cfunc (if (and org-refile-use-outline-path
7673 org-outline-path-complete-in-steps)
7674 'org-olpath-completing-read
7675 'org-ido-completing-read))
7676 (extra (if org-refile-use-outline-path "/" ""))
7677 (filename (and cfn (expand-file-name cfn)))
7680 (if (not (equal filename (nth 1 x)))
7681 (cons (concat (car x) extra " ("
7682 (file-name-nondirectory (nth 1 x)) ")")
7684 (cons (concat (car x) extra) (cdr x))))
7685 org-refile-target-table))
7686 (completion-ignore-case t))
7687 (assoc (funcall cfunc prompt tbl nil t nil 'org-refile-history)
7690 (defun org-olpath-completing-read (prompt collection &rest args)
7691 "Read an outline path like a file name."
7692 (let ((thetable collection))
7694 'org-ido-completing-read prompt
7695 (lambda (string predicate &optional flag)
7696 (let (rtn r s f (l (length string)))
7700 (try-completion string thetable))
7703 (setq rtn (all-completions string thetable predicate))
7706 (setq r (substring x l))
7707 (if (string-match " ([^)]*)$" x)
7708 (setq f (match-string 0 x))
7710 (if (string-match "/" r)
7711 (concat string (substring r 0 (match-end 0)) f)
7716 (assoc string thetable)))
7722 (defun org-find-dblock (name)
7723 "Find the first dynamic block with name NAME in the buffer.
7724 If not found, stay at current position and return nil."
7727 (goto-char (point-min))
7728 (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
7730 (match-beginning 0))))
7731 (if pos (goto-char pos))
7734 (defconst org-dblock-start-re
7735 "^#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
7736 "Matches the startline of a dynamic block, with parameters.")
7738 (defconst org-dblock-end-re "^#\\+END\\([: \t\r\n]\\|$\\)"
7739 "Matches the end of a dynamic block.")
7741 (defun org-create-dblock (plist)
7742 "Create a dynamic block section, with parameters taken from PLIST.
7743 PLIST must contain a :name entry which is used as name of the block."
7744 (unless (bolp) (newline))
7745 (let ((name (plist-get plist :name)))
7746 (insert "#+BEGIN: " name)
7748 (if (eq (car plist) :name)
7749 (setq plist (cddr plist))
7750 (insert " " (prin1-to-string (pop plist)))))
7751 (insert "\n\n#+END:\n")
7752 (beginning-of-line -2)))
7754 (defun org-prepare-dblock ()
7755 "Prepare dynamic block for refresh.
7756 This empties the block, puts the cursor at the insert position and returns
7757 the property list including an extra property :name with the block name."
7758 (unless (looking-at org-dblock-start-re)
7759 (error "Not at a dynamic block"))
7760 (let* ((begdel (1+ (match-end 0)))
7761 (name (org-no-properties (match-string 1)))
7762 (params (append (list :name name)
7763 (read (concat "(" (match-string 3) ")")))))
7764 (unless (re-search-forward org-dblock-end-re nil t)
7765 (error "Dynamic block not terminated"))
7768 (list :content (buffer-substring
7769 begdel (match-beginning 0)))))
7770 (delete-region begdel (match-beginning 0))
7775 (defun org-map-dblocks (&optional command)
7776 "Apply COMMAND to all dynamic blocks in the current buffer.
7777 If COMMAND is not given, use `org-update-dblock'."
7778 (let ((cmd (or command 'org-update-dblock))
7781 (goto-char (point-min))
7782 (while (re-search-forward org-dblock-start-re nil t)
7783 (goto-char (setq pos (match-beginning 0)))
7786 (error (message "Error during update of dynamic block")))
7788 (unless (re-search-forward org-dblock-end-re nil t)
7789 (error "Dynamic block not terminated"))))))
7791 (defun org-dblock-update (&optional arg)
7792 "User command for updating dynamic blocks.
7793 Update the dynamic block at point. With prefix ARG, update all dynamic
7794 blocks in the buffer."
7797 (org-update-all-dblocks)
7798 (or (looking-at org-dblock-start-re)
7799 (org-beginning-of-dblock))
7800 (org-update-dblock)))
7802 (defun org-update-dblock ()
7803 "Update the dynamic block at point
7804 This means to empty the block, parse for parameters and then call
7805 the correct writing function."
7806 (save-window-excursion
7807 (let* ((pos (point))
7808 (line (org-current-line))
7809 (params (org-prepare-dblock))
7810 (name (plist-get params :name))
7811 (cmd (intern (concat "org-dblock-write:" name))))
7812 (message "Updating dynamic block `%s' at line %d..." name line)
7813 (funcall cmd params)
7814 (message "Updating dynamic block `%s' at line %d...done" name line)
7817 (defun org-beginning-of-dblock ()
7818 "Find the beginning of the dynamic block at point.
7819 Error if there is no such block at point."
7823 (if (and (re-search-backward org-dblock-start-re nil t)
7824 (setq beg (match-beginning 0))
7825 (re-search-forward org-dblock-end-re nil t)
7826 (> (match-end 0) pos))
7829 (error "Not in a dynamic block"))))
7831 (defun org-update-all-dblocks ()
7832 "Update all dynamic blocks in the buffer.
7833 This function can be used in a hook."
7835 (org-map-dblocks 'org-update-dblock)))
7840 (defconst org-additional-option-like-keywords
7841 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
7842 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "TBLFM"
7843 "BEGIN_EXAMPLE" "END_EXAMPLE"
7844 "BEGIN_QUOTE" "END_QUOTE"
7845 "BEGIN_VERSE" "END_VERSE"
7846 "BEGIN_SRC" "END_SRC"
7847 "CAPTION" "LABEL" "ATTR_HTML" "ATTR_LaTeX"))
7849 (defcustom org-structure-template-alist
7851 ("s" "#+begin_src ?\n\n#+end_src"
7852 "<src lang=\"?\">\n\n</src>")
7853 ("e" "#+begin_example\n?\n#+end_example"
7854 "<example>\n?\n</example>")
7855 ("q" "#+begin_quote\n?\n#+end_quote"
7856 "<quote>\n?\n</quote>")
7857 ("v" "#+begin_verse\n?\n#+end_verse"
7858 "<verse>\n?\n/verse>")
7859 ("l" "#+begin_latex\n?\n#+end_latex"
7860 "<literal style=\"latex\">\n?\n</literal>")
7862 "<literal style=\"latex\">?</literal>")
7863 ("h" "#+begin_html\n?\n#+end_html"
7864 "<literal style=\"html\">\n?\n</literal>")
7866 "<literal style=\"html\">?</literal>")
7867 ("a" "#+begin_ascii\n?\n#+end_ascii")
7869 ("i" "#+include %file ?"
7870 "<include file=%file markup=\"?\">")
7872 "Structure completion elements.
7873 This is a list of abbreviation keys and values. The value gets inserted
7874 it you type @samp{.} followed by the key and then the completion key,
7875 usually `M-TAB'. %file will be replaced by a file name after prompting
7876 for the file using completion.
7877 There are two templates for each key, the first uses the original Org syntax,
7878 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
7879 the default when the /org-mtags.el/ module has been loaded. See also the
7880 variable `org-mtags-prefer-muse-templates'.
7881 This is an experimental feature, it is undecided if it is going to stay in."
7882 :group 'org-completion
7885 (string :tag "Template")
7886 (string :tag "Muse Template")))
7888 (defun org-try-structure-completion ()
7889 "Try to complete a structure template before point.
7890 This looks for strings like \"<e\" on an otherwise empty line and
7892 (let ((l (buffer-substring (point-at-bol) (point)))
7894 (when (and (looking-at "[ \t]*$")
7895 (string-match "^[ \t]*<\\([a-z]+\\)$"l)
7896 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
7897 (org-complete-expand-structure-template (+ -1 (point-at-bol)
7898 (match-beginning 1)) a)
7901 (defun org-complete-expand-structure-template (start cell)
7902 "Expand a structure template."
7903 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
7904 (rpl (nth (if musep 2 1) cell)))
7905 (delete-region start (point))
7906 (when (string-match "\\`#\\+" rpl)
7909 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
7910 (delete-region (point-at-bol) (point)))
7912 (setq start (point))
7913 (if (string-match "%file" rpl)
7914 (setq rpl (replace-match
7918 (abbreviate-file-name (read-file-name "Include file: ")))
7922 (if (re-search-backward "\\?" start t) (delete-char 1))))
7925 (defun org-complete (&optional arg)
7926 "Perform completion on word at point.
7927 At the beginning of a headline, this completes TODO keywords as given in
7928 `org-todo-keywords'.
7929 If the current word is preceded by a backslash, completes the TeX symbols
7930 that are supported for HTML support.
7931 If the current word is preceded by \"#+\", completes special words for
7932 setting file options.
7933 In the line after \"#+STARTUP:, complete valid keywords.\"
7934 At all other locations, this simply calls the value of
7935 `org-completion-fallback-command'."
7937 (org-without-partial-completion
7941 (beg1 (save-excursion
7942 (skip-chars-backward (org-re "[:alnum:]_@"))
7944 (beg (save-excursion
7945 (skip-chars-backward "a-zA-Z0-9_:$")
7947 (confirm (lambda (x) (stringp (car x))))
7948 (searchhead (equal (char-before beg) ?*))
7950 (when (and (member (char-before beg1) '(?. ?<))
7951 (setq a (assoc (buffer-substring beg1 (point))
7952 org-structure-template-alist)))
7953 (org-complete-expand-structure-template (1- beg1) a)
7955 (tag (and (equal (char-before beg1) ?:)
7956 (equal (char-after (point-at-bol)) ?*)))
7957 (prop (and (equal (char-before beg1) ?:)
7958 (not (equal (char-after (point-at-bol)) ?*))))
7959 (texp (equal (char-before beg) ?\\))
7960 (link (equal (char-before beg) ?\[))
7961 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
7964 (startup (string-match "^#\\+STARTUP:.*"
7965 (buffer-substring (point-at-bol) (point))))
7966 (completion-ignore-case opt)
7976 (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
7977 (cons (match-string 2 x) (match-string 1 x)))
7978 (org-split-string (org-get-current-options) "\n"))
7979 (mapcar 'list org-additional-option-like-keywords)))
7981 (setq type :startup)
7982 org-startup-options)
7983 (link (append org-link-abbrev-alist-local
7984 org-link-abbrev-alist))
7988 ((string-match "\\`\\*+[ \t]+\\'"
7989 (buffer-substring (point-at-bol) beg))
7991 (mapcar 'list org-todo-keywords-1))
7993 (setq type :searchhead)
7995 (goto-char (point-min))
7996 (while (re-search-forward org-todo-line-regexp nil t)
7998 (org-make-org-heading-search-string
7999 (match-string 3) t))
8002 (tag (setq type :tag beg beg1)
8003 (or org-tag-alist (org-get-buffer-tags)))
8004 (prop (setq type :prop beg beg1)
8005 (mapcar 'list (org-buffer-property-keys nil t t)))
8007 (call-interactively org-completion-fallback-command)
8008 (throw 'exit nil)))))
8009 (pattern (buffer-substring-no-properties beg end))
8010 (completion (try-completion pattern table confirm)))
8011 (cond ((eq completion t)
8012 (if (not (assoc (upcase pattern) table))
8013 (message "Already complete")
8014 (if (and (equal type :opt)
8015 (not (member (car (assoc (upcase pattern) table))
8016 org-additional-option-like-keywords)))
8017 (insert (substring (cdr (assoc (upcase pattern) table))
8019 (if (memq type '(:tag :prop)) (insert ":")))))
8021 (message "Can't find completion for \"%s\"" pattern)
8023 ((not (string= pattern completion))
8024 (delete-region beg end)
8025 (if (string-match " +$" completion)
8026 (setq completion (replace-match "" t t completion)))
8028 (if (get-buffer-window "*Completions*")
8029 (delete-window (get-buffer-window "*Completions*")))
8030 (if (assoc completion table)
8031 (if (eq type :todo) (insert " ")
8032 (if (memq type '(:tag :prop)) (insert ":"))))
8033 (if (and (equal type :opt) (assoc completion table))
8034 (message "%s" (substitute-command-keys
8035 "Press \\[org-complete] again to insert example settings"))))
8037 (message "Making completion list...")
8038 (let ((list (sort (all-completions pattern table confirm)
8040 (with-output-to-temp-buffer "*Completions*"
8042 ;; Protection needed for XEmacs and emacs 21
8043 (display-completion-list list pattern)
8044 (error (display-completion-list list)))))
8045 (message "Making completion list...%s" "done")))))))
8047 ;;;; TODO, DEADLINE, Comments
8049 (defun org-toggle-comment ()
8050 "Change the COMMENT state of an entry."
8053 (org-back-to-heading)
8054 (let (case-fold-search)
8055 (if (looking-at (concat outline-regexp
8056 "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
8057 (replace-match "" t t nil 1)
8058 (if (looking-at outline-regexp)
8060 (goto-char (match-end 0))
8061 (insert org-comment-string " ")))))))
8063 (defvar org-last-todo-state-is-todo nil
8064 "This is non-nil when the last TODO state change led to a TODO state.
8065 If the last change removed the TODO tag or switched to DONE, then
8068 (defvar org-setting-tags nil) ; dynamically skipped
8070 (defun org-parse-local-options (string var)
8071 "Parse STRING for startup setting relevant for variable VAR."
8072 (let ((rtn (symbol-value var))
8075 (if (or (not string) (not (string-match "\\S-" string)))
8077 (setq opts (delq nil (mapcar (lambda (x)
8078 (setq e (assoc x org-startup-options))
8079 (if (eq (nth 1 e) var) e nil))
8080 (org-split-string string "[ \t]+"))))
8084 (while (setq e (pop opts))
8086 (setq rtn (nth 2 e))
8087 (if (not (listp rtn)) (setq rtn nil))
8088 (push (nth 2 e) rtn)))
8091 (defvar org-blocker-hook nil
8092 "Hook for functions that are allowed to block a state change.
8094 Each function gets as its single argument a property list, see
8095 `org-trigger-hook' for more information about this list.
8097 If any of the functions in this hook returns nil, the state change
8100 (defvar org-trigger-hook nil
8101 "Hook for functions that are triggered by a state change.
8103 Each function gets as its single argument a property list with at least
8104 the following elements:
8106 (:type type-of-change :position pos-at-entry-start
8107 :from old-state :to new-state)
8109 Depending on the type, more properties may be present.
8111 This mechanism is currently implemented for:
8115 :type todo-state-change
8116 :from previous state (keyword as a string), or nil
8117 :to new state (keyword as a string), or nil")
8119 (defvar org-agenda-headline-snapshot-before-repeat)
8120 (defun org-todo (&optional arg)
8121 "Change the TODO state of an item.
8122 The state of an item is given by a keyword at the start of the heading,
8124 *** TODO Write paper
8127 The different keywords are specified in the variable `org-todo-keywords'.
8128 By default the available states are \"TODO\" and \"DONE\".
8129 So for this example: when the item starts with TODO, it is changed to DONE.
8130 When it starts with DONE, the DONE is removed. And when neither TODO nor
8131 DONE are present, add TODO at the beginning of the heading.
8133 With C-u prefix arg, use completion to determine the new state.
8134 With numeric prefix arg, switch to that state.
8136 For calling through lisp, arg is also interpreted in the following way:
8137 'none -> empty state
8138 \"\"(empty string) -> switch to empty state
8139 'done -> switch to DONE
8140 'nextset -> switch to the next set of keywords
8141 'previousset -> switch to the previous set of keywords
8142 \"WAITING\" -> switch to the specified keyword, but only if it
8143 really is a member of `org-todo-keywords'."
8147 (org-back-to-heading)
8148 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
8149 (or (looking-at (concat " +" org-todo-regexp " *"))
8151 (let* ((match-data (match-data))
8152 (startpos (point-at-bol))
8153 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
8154 (org-log-done org-log-done)
8155 (org-log-repeat org-log-repeat)
8156 (org-todo-log-states org-todo-log-states)
8157 (this (match-string 1))
8158 (hl-pos (match-beginning 0))
8159 (head (org-get-todo-sequence-head this))
8160 (ass (assoc head org-todo-kwd-alist))
8161 (interpret (nth 1 ass))
8162 (done-word (nth 3 ass))
8163 (final-done-word (nth 4 ass))
8164 (last-state (or this ""))
8165 (completion-ignore-case t)
8166 (member (member this org-todo-keywords-1))
8169 ((and org-todo-key-trigger
8170 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
8171 (and (not arg) org-use-fast-todo-selection
8172 (not (eq org-use-fast-todo-selection 'prefix)))))
8173 ;; Use fast selection
8174 (org-fast-todo-selection))
8175 ((and (equal arg '(4))
8176 (or (not org-use-fast-todo-selection)
8177 (not org-todo-key-trigger)))
8178 ;; Read a state with completion
8179 (org-ido-completing-read "State: " (mapcar (lambda(x) (list x))
8180 org-todo-keywords-1)
8184 (if tail (car tail) nil)
8185 (car org-todo-keywords-1)))
8187 (if (equal member org-todo-keywords-1)
8190 (nth (- (length org-todo-keywords-1) (length tail) 2)
8191 org-todo-keywords-1)
8192 (org-last org-todo-keywords-1))))
8193 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
8194 (setq arg nil))) ; hack to fall back to cycling
8196 ;; user or caller requests a specific state
8198 ((equal arg "") nil)
8199 ((eq arg 'none) nil)
8200 ((eq arg 'done) (or done-word (car org-done-keywords)))
8202 (or (car (cdr (member head org-todo-heads)))
8203 (car org-todo-heads)))
8204 ((eq arg 'previousset)
8205 (let ((org-todo-heads (reverse org-todo-heads)))
8206 (or (car (cdr (member head org-todo-heads)))
8207 (car org-todo-heads))))
8208 ((car (member arg org-todo-keywords-1)))
8209 ((nth (1- (prefix-numeric-value arg))
8210 org-todo-keywords-1))))
8211 ((null member) (or head (car org-todo-keywords-1)))
8212 ((equal this final-done-word) nil) ;; -> make empty
8213 ((null tail) nil) ;; -> first entry
8214 ((eq interpret 'sequence)
8216 ((memq interpret '(type priority))
8217 (if (eq this-command last-command)
8219 (if (> (length tail) 0)
8220 (or done-word (car org-done-keywords))
8223 (next (if state (concat " " state " ") " "))
8224 (change-plist (list :type 'todo-state-change :from this :to state
8225 :position startpos))
8227 (when org-blocker-hook
8228 (unless (save-excursion
8230 (run-hook-with-args-until-failure
8231 'org-blocker-hook change-plist)))
8233 (error "TODO state change from %s to %s blocked" this state)
8235 (message "TODO state change from %s to %s blocked" this state)
8236 (throw 'exit nil))))
8237 (store-match-data match-data)
8238 (replace-match next t t)
8239 (unless (pos-visible-in-window-p hl-pos)
8240 (message "TODO state changed to %s" (org-trim next)))
8242 (setq head (org-get-todo-sequence-head state)
8243 ass (assoc head org-todo-kwd-alist)
8244 interpret (nth 1 ass)
8245 done-word (nth 3 ass)
8246 final-done-word (nth 4 ass)))
8247 (when (memq arg '(nextset previousset))
8248 (message "Keyword-Set %d/%d: %s"
8249 (- (length org-todo-sets) -1
8250 (length (memq (assoc state org-todo-sets) org-todo-sets)))
8251 (length org-todo-sets)
8252 (mapconcat 'identity (assoc state org-todo-sets) " ")))
8253 (setq org-last-todo-state-is-todo
8254 (not (member state org-done-keywords)))
8255 (setq now-done-p (and (member state org-done-keywords)
8256 (not (member this org-done-keywords))))
8257 (and logging (org-local-logging logging))
8258 (when (and (or org-todo-log-states org-log-done)
8259 (not (memq arg '(nextset previousset))))
8260 ;; we need to look at recording a time and note
8261 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
8262 (nth 2 (assoc this org-todo-log-states))))
8264 (member state org-not-done-keywords)
8265 (not (member this org-not-done-keywords)))
8266 ;; This is now a todo state and was not one before
8267 ;; If there was a CLOSED time stamp, get rid of it.
8268 (org-add-planning-info nil nil 'closed))
8269 (when (and now-done-p org-log-done)
8270 ;; It is now done, and it was not done before
8271 (org-add-planning-info 'closed (org-current-time))
8272 (if (and (not dolog) (eq 'note org-log-done))
8273 (org-add-log-setup 'done state 'findpos 'note)))
8274 (when (and state dolog)
8275 ;; This is a non-nil state, and we need to log it
8276 (org-add-log-setup 'state state 'findpos dolog)))
8277 ;; Fixup tag positioning
8278 (org-todo-trigger-tag-changes state)
8279 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
8280 (when org-provide-todo-statistics
8281 (org-update-parent-todo-statistics))
8282 (run-hooks 'org-after-todo-state-change-hook)
8283 (if (and arg (not (member state org-done-keywords)))
8284 (setq head (org-get-todo-sequence-head state)))
8285 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
8286 ;; Do we need to trigger a repeat?
8288 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
8289 ;; This is for the agenda, take a snapshot of the headline.
8291 (setq org-agenda-headline-snapshot-before-repeat
8292 (org-get-heading))))
8293 (org-auto-repeat-maybe state))
8294 ;; Fixup cursor location if close to the keyword
8295 (if (and (outline-on-heading-p)
8297 (save-excursion (beginning-of-line 1)
8298 (looking-at org-todo-line-regexp))
8299 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
8301 (goto-char (or (match-end 2) (match-end 1)))
8303 (when org-trigger-hook
8305 (run-hook-with-args 'org-trigger-hook change-plist)))))))
8307 (defun org-update-parent-todo-statistics ()
8308 "Update any statistics cookie in the parent of the current headline."
8310 (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
8311 level (cnt-all 0) (cnt-done 0) is-percent kwd)
8314 (setq level (org-up-heading-safe))
8316 (re-search-forward box-re (point-at-eol) t))
8318 (setq is-percent (match-end 2))
8320 (unless (outline-next-heading) (throw 'exit nil))
8321 (while (looking-at org-todo-line-regexp)
8322 (setq kwd (match-string 2))
8323 (and kwd (setq cnt-all (1+ cnt-all)))
8324 (and (member kwd org-done-keywords)
8325 (setq cnt-done (1+ cnt-done)))
8327 (org-forward-same-level 1)
8328 (error (end-of-line 1)))))
8331 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
8332 (format "[%d/%d]" cnt-done cnt-all)))
8333 (run-hook-with-args 'org-after-todo-statistics-hook
8334 cnt-done (- cnt-all cnt-done))))))
8336 (defvar org-after-todo-statistics-hook nil
8337 "Hook that is called after a TODO statistics cookie has been updated.
8338 Each function is called with two arguments: the number of not-done entries
8339 and the number of done entries.
8341 For example, the following function, when added to this hook, will switch
8342 an entry to DONE when all children are done, and back to TODO when new
8343 entries are set to a TODO status. Note that this hook is only called
8344 when there is a statistics cookie in the headline!
8346 (defun org-summary-todo (n-done n-not-done)
8347 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
8348 (let (org-log-done org-log-states) ; turn off logging
8349 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
8352 (defun org-todo-trigger-tag-changes (state)
8353 "Apply the changes defined in `org-todo-state-tags-triggers'."
8354 (let ((l org-todo-state-tags-triggers)
8356 (when (or (not state) (equal state ""))
8357 (setq changes (append changes (cdr (assoc "" l)))))
8358 (when (and (stringp state) (> (length state) 0))
8359 (setq changes (append changes (cdr (assoc state l)))))
8360 (when (member state org-not-done-keywords)
8361 (setq changes (append changes (cdr (assoc 'todo l)))))
8362 (when (member state org-done-keywords)
8363 (setq changes (append changes (cdr (assoc 'done l)))))
8365 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
8367 (defun org-local-logging (value)
8368 "Get logging settings from a property VALUE."
8370 ;; directly set the variables, they are already local.
8371 (setq org-log-done nil
8373 org-todo-log-states nil)
8374 (setq words (org-split-string value))
8375 (while (setq w (pop words))
8377 ((setq a (assoc w org-startup-options))
8378 (and (member (nth 1 a) '(org-log-done org-log-repeat))
8379 (set (nth 1 a) (nth 2 a))))
8380 ((setq a (org-extract-log-state-settings w))
8381 (and (member (car a) org-todo-keywords-1)
8382 (push a org-todo-log-states)))))))
8384 (defun org-get-todo-sequence-head (kwd)
8385 "Return the head of the TODO sequence to which KWD belongs.
8386 If KWD is not set, check if there is a text property remembering the
8391 (or (get-text-property (point-at-bol) 'org-todo-head)
8393 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
8394 nil (point-at-eol)))
8395 (get-text-property p 'org-todo-head))))
8396 ((not (member kwd org-todo-keywords-1))
8397 (car org-todo-keywords-1))
8398 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
8400 (defun org-fast-todo-selection ()
8401 "Fast TODO keyword selection with single keys.
8402 Returns the new TODO keyword, or nil if no state change should occur."
8403 (let* ((fulltable org-todo-key-alist)
8404 (done-keywords org-done-keywords) ;; needed for the faces.
8405 (maxlen (apply 'max (mapcar
8407 (if (stringp (car x)) (string-width (car x)) 0))
8410 (fwidth (+ maxlen 3 1 3))
8411 (ncol (/ (- (window-width) 4) fwidth))
8414 (save-window-excursion
8416 (set-buffer (get-buffer-create " *Org todo*"))
8417 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
8419 (org-set-local 'org-done-keywords done-keywords)
8420 (setq tbl fulltable cnt 0)
8421 (while (setq e (pop tbl))
8423 ((equal e '(:startgroup))
8424 (push '() groups) (setq ingroup t)
8425 (when (not (= cnt 0))
8429 ((equal e '(:endgroup))
8430 (setq ingroup nil cnt 0)
8433 (setq tg (car e) c (cdr e))
8434 (if ingroup (push tg (car groups)))
8435 (setq tg (org-add-props tg nil 'face
8436 (org-get-todo-face tg)))
8437 (if (and (= cnt 0) (not ingroup)) (insert " "))
8438 (insert "[" c "] " tg (make-string
8439 (- fwidth 4 (length tg)) ?\ ))
8440 (when (= (setq cnt (1+ cnt)) ncol)
8442 (if ingroup (insert " "))
8445 (goto-char (point-min))
8446 (if (not expert) (org-fit-window-to-buffer))
8447 (message "[a-z..]:Set [SPC]:clear")
8448 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
8451 (and (= c ?q) (not (rassoc c fulltable))))
8454 ((setq e (rassoc c fulltable) tg (car e))
8456 (t (setq quit-flag t))))))
8458 (defun org-entry-is-todo-p ()
8459 (member (org-get-todo-state) org-not-done-keywords))
8461 (defun org-entry-is-done-p ()
8462 (member (org-get-todo-state) org-done-keywords))
8464 (defun org-get-todo-state ()
8466 (org-back-to-heading t)
8467 (and (looking-at org-todo-line-regexp)
8471 (defun org-at-date-range-p (&optional inactive-ok)
8472 "Is the cursor inside a date range?"
8476 (let ((pos (point)))
8477 (skip-chars-backward "^[<\r\n")
8478 (skip-chars-backward "<[")
8479 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
8480 (>= (match-end 0) pos)
8482 (skip-chars-backward "^<[\r\n")
8483 (skip-chars-backward "<[")
8484 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
8485 (>= (match-end 0) pos)
8489 (defun org-get-repeat ()
8490 "Check if there is a deadline/schedule with repeater in this entry."
8493 (org-back-to-heading t)
8494 (if (re-search-forward
8495 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
8496 (match-string 1)))))
8498 (defvar org-last-changed-timestamp)
8499 (defvar org-last-inserted-timestamp)
8500 (defvar org-log-post-message)
8501 (defvar org-log-note-purpose)
8502 (defvar org-log-note-how)
8503 (defvar org-log-note-extra)
8504 (defun org-auto-repeat-maybe (done-word)
8505 "Check if the current headline contains a repeated deadline/schedule.
8506 If yes, set TODO state back to what it was and change the base date
8507 of repeating deadline/scheduled time stamps to new date.
8508 This function is run automatically after each state change to a DONE state."
8509 ;; last-state is dynamically scoped into this function
8510 (let* ((repeat (org-get-repeat))
8511 (aa (assoc last-state org-todo-kwd-alist))
8512 (interpret (nth 1 aa))
8514 (whata '(("d" . day) ("m" . month) ("y" . year)))
8515 (msg "Entry repeats: ")
8517 (org-todo-log-states nil)
8518 (nshiftmax 10) (nshift 0)
8519 re type n what ts mb0 time)
8521 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
8522 (org-todo (if (eq interpret 'type) last-state head))
8523 (when org-log-repeat
8524 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
8525 (memq 'org-add-log-note post-command-hook))
8526 ;; OK, we are already setup for some record
8527 (if (eq org-log-repeat 'note)
8528 ;; make sure we take a note, not only a time stamp
8529 (setq org-log-note-how 'note))
8530 ;; Set up for taking a record
8531 (org-add-log-setup 'state (or done-word (car org-done-keywords))
8532 'findpos org-log-repeat)))
8533 (org-back-to-heading t)
8534 (org-add-planning-info nil nil 'closed)
8535 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
8536 org-deadline-time-regexp "\\)\\|\\("
8537 org-ts-regexp "\\)"))
8538 (while (re-search-forward
8539 re (save-excursion (outline-next-heading) (point)) t)
8540 (setq type (if (match-end 1) org-scheduled-string
8541 (if (match-end 3) org-deadline-string "Plain:"))
8542 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0)))
8543 mb0 (match-beginning 0))
8544 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
8545 (setq n (string-to-number (match-string 2 ts))
8546 what (match-string 3 ts))
8547 (if (equal what "w") (setq n (* n 7) what "d"))
8548 ;; Preparation, see if we need to modify the start date for the change
8550 (setq time (save-match-data (org-time-string-to-time ts)))
8552 ((equal (match-string 1 ts) ".")
8553 ;; Shift starting date to today
8554 (org-timestamp-change
8555 (- (time-to-days (current-time)) (time-to-days time))
8557 ((equal (match-string 1 ts) "+")
8558 (while (or (= nshift 0)
8559 (<= (time-to-days time) (time-to-days (current-time))))
8560 (when (= (incf nshift) nshiftmax)
8561 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
8563 (org-timestamp-change n (cdr (assoc what whata)))
8564 (org-at-timestamp-p t)
8565 (setq ts (match-string 1))
8566 (setq time (save-match-data (org-time-string-to-time ts))))
8567 (org-timestamp-change (- n) (cdr (assoc what whata)))
8568 ;; rematch, so that we have everything in place for the real shift
8569 (org-at-timestamp-p t)
8570 (setq ts (match-string 1))
8571 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
8572 (org-timestamp-change n (cdr (assoc what whata)))
8573 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
8574 (setq org-log-post-message msg)
8575 (message "%s" msg))))
8577 (defun org-show-todo-tree (arg)
8578 "Make a compact tree which shows all headlines marked with TODO.
8579 The tree will show the lines where the regexp matches, and all higher
8580 headlines above the match.
8581 With a \\[universal-argument] prefix, also show the DONE entries.
8582 With a numeric prefix N, construct a sparse tree for the Nth element
8583 of `org-todo-keywords-1'."
8585 (let ((case-fold-search nil)
8587 (cond ((null arg) org-not-done-regexp)
8589 (let ((kwd (org-ido-completing-read "Keyword (or KWD1|KWD2|...): "
8590 (mapcar 'list org-todo-keywords-1))))
8592 (mapconcat 'identity (org-split-string kwd "|") "\\|")
8594 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
8595 (regexp-quote (nth (1- (prefix-numeric-value arg))
8596 org-todo-keywords-1)))
8597 (t (error "Invalid prefix argument: %s" arg)))))
8598 (message "%d TODO entries found"
8599 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
8601 (defun org-deadline (&optional remove time)
8602 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
8603 With argument REMOVE, remove any deadline from the item.
8604 When TIME is set, it should be an internal time specification, and the
8605 scheduling will use the corresponding date."
8609 (org-remove-timestamp-with-keyword org-deadline-string)
8610 (message "Item no longer has a deadline."))
8611 (if (org-get-repeat)
8612 (error "Cannot change deadline on task with repeater, please do that by hand")
8613 (org-add-planning-info 'deadline time 'closed)
8614 (message "Deadline on %s" org-last-inserted-timestamp))))
8616 (defun org-schedule (&optional remove time)
8617 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
8618 With argument REMOVE, remove any scheduling date from the item.
8619 When TIME is set, it should be an internal time specification, and the
8620 scheduling will use the corresponding date."
8624 (org-remove-timestamp-with-keyword org-scheduled-string)
8625 (message "Item is no longer scheduled."))
8626 (if (org-get-repeat)
8627 (error "Cannot reschedule task with repeater, please do that by hand")
8628 (org-add-planning-info 'scheduled time 'closed)
8629 (message "Scheduled to %s" org-last-inserted-timestamp))))
8631 (defun org-remove-timestamp-with-keyword (keyword)
8632 "Remove all time stamps with KEYWORD in the current entry."
8633 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
8636 (org-back-to-heading t)
8638 (org-end-of-subtree t t)
8639 (while (re-search-backward re beg t)
8641 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
8642 (equal (char-before) ?\ ))
8643 (backward-delete-char 1)
8644 (if (string-match "^[ \t]*$" (buffer-substring
8645 (point-at-bol) (point-at-eol)))
8646 (delete-region (point-at-bol)
8647 (min (point-max) (1+ (point-at-eol))))))))))
8649 (defun org-add-planning-info (what &optional time &rest remove)
8650 "Insert new timestamp with keyword in the line directly after the headline.
8651 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
8652 If non is given, the user is prompted for a date.
8653 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
8656 (let (org-time-was-given org-end-time-was-given ts
8657 end default-time default-input)
8659 (when (and (not time) (memq what '(scheduled deadline)))
8660 ;; Try to get a default date/time from existing timestamp
8662 (org-back-to-heading t)
8663 (setq end (save-excursion (outline-next-heading) (point)))
8664 (when (re-search-forward (if (eq what 'scheduled)
8665 org-scheduled-time-regexp
8666 org-deadline-time-regexp)
8668 (setq ts (match-string 1)
8670 (apply 'encode-time (org-parse-time-string ts))
8671 default-input (and ts (org-get-compact-tod ts))))))
8673 ;; If necessary, get the time from the user
8674 (setq time (or time (org-read-date nil 'to-time nil nil
8675 default-time default-input))))
8677 (when (and org-insert-labeled-timestamps-at-point
8678 (member what '(scheduled deadline)))
8680 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
8681 (org-insert-time-stamp time org-time-was-given
8682 nil nil nil (list org-end-time-was-given))
8686 (let (col list elt ts buffer-invisibility-spec)
8687 (org-back-to-heading t)
8688 (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
8689 (goto-char (match-end 1))
8690 (setq col (current-column))
8691 (goto-char (match-end 0))
8692 (if (eobp) (insert "\n") (forward-char 1))
8693 (if (and (not (looking-at outline-regexp))
8694 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
8696 (not (equal (match-string 1) org-clock-string)))
8697 (narrow-to-region (match-beginning 0) (match-end 0))
8698 (insert-before-markers "\n")
8700 (narrow-to-region (point) (point))
8701 (and org-adapt-indentation (org-indent-to-column col)))
8702 ;; Check if we have to remove something.
8703 (setq list (cons what remove))
8705 (setq elt (pop list))
8706 (goto-char (point-min))
8707 (when (or (and (eq elt 'scheduled)
8708 (re-search-forward org-scheduled-time-regexp nil t))
8709 (and (eq elt 'deadline)
8710 (re-search-forward org-deadline-time-regexp nil t))
8711 (and (eq elt 'closed)
8712 (re-search-forward org-closed-time-regexp nil t)))
8714 (if (looking-at "--+<[^>]+>") (replace-match ""))
8715 (if (looking-at " +") (replace-match ""))))
8716 (goto-char (point-max))
8719 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
8720 (cond ((eq what 'scheduled) org-scheduled-string)
8721 ((eq what 'deadline) org-deadline-string)
8722 ((eq what 'closed) org-closed-string))
8724 (setq ts (org-insert-time-stamp
8726 (or org-time-was-given
8727 (and (eq what 'closed) org-log-done-with-time))
8729 nil nil (list org-end-time-was-given)))
8731 (goto-char (point-min))
8733 (if (and (looking-at "[ \t]+\n")
8734 (equal (char-before) ?\n))
8735 (delete-region (1- (point)) (point-at-eol)))
8738 (defvar org-log-note-marker (make-marker))
8739 (defvar org-log-note-purpose nil)
8740 (defvar org-log-note-state nil)
8741 (defvar org-log-note-how nil)
8742 (defvar org-log-note-extra nil)
8743 (defvar org-log-note-window-configuration nil)
8744 (defvar org-log-note-return-to (make-marker))
8745 (defvar org-log-post-message nil
8746 "Message to be displayed after a log note has been stored.
8747 The auto-repeater uses this.")
8749 (defun org-add-note ()
8750 "Add a note to the current entry.
8751 This is done in the same way as adding a state change note."
8753 (org-add-log-setup 'note nil 'findpos nil))
8755 (defvar org-property-end-re)
8756 (defun org-add-log-setup (&optional purpose state findpos how &optional extra)
8757 "Set up the post command hook to take a note.
8758 If this is about to TODO state change, the new state is expected in STATE.
8759 When FINDPOS is non-nil, find the correct position for the note in
8760 the current entry. If not, assume that it can be inserted at point.
8761 HOW is an indicator what kind of note should be created.
8762 EXTRA is additional text that will be inserted into the notes buffer."
8766 (org-back-to-heading t)
8767 (narrow-to-region (point) (save-excursion
8768 (outline-next-heading) (point)))
8769 (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
8770 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
8772 (goto-char (match-end 0))
8773 (when (and org-log-state-notes-insert-after-drawers
8775 (forward-line) (looking-at org-drawer-regexp)))
8776 (progn (forward-line)
8777 (while (looking-at org-drawer-regexp)
8778 (goto-char (match-end 0))
8779 (re-search-forward org-property-end-re (point-max) t)
8782 (unless org-log-states-order-reversed
8783 (and (= (char-after) ?\n) (forward-char 1))
8784 (org-skip-over-state-notes)
8785 (skip-chars-backward " \t\n\r")))
8786 (move-marker org-log-note-marker (point))
8787 (setq org-log-note-purpose purpose
8788 org-log-note-state state
8789 org-log-note-how how
8790 org-log-note-extra extra)
8791 (add-hook 'post-command-hook 'org-add-log-note 'append))))
8793 (defun org-skip-over-state-notes ()
8794 "Skip past the list of State notes in an entry."
8795 (if (looking-at "\n[ \t]*- State") (forward-char 1))
8796 (while (looking-at "[ \t]*- State")
8799 (error (org-end-of-item)))))
8801 (defun org-add-log-note (&optional purpose)
8802 "Pop up a window for taking a note, and add this note later at point."
8803 (remove-hook 'post-command-hook 'org-add-log-note)
8804 (setq org-log-note-window-configuration (current-window-configuration))
8805 (delete-other-windows)
8806 (move-marker org-log-note-return-to (point))
8807 (switch-to-buffer (marker-buffer org-log-note-marker))
8808 (goto-char org-log-note-marker)
8809 (org-switch-to-buffer-other-window "*Org Note*")
8811 (if (memq org-log-note-how '(time state))
8812 (let (current-prefix-arg) (org-store-log-note))
8813 (let ((org-inhibit-startup t)) (org-mode))
8814 (insert (format "# Insert note for %s.
8815 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
8817 ((eq org-log-note-purpose 'clock-out) "stopped clock")
8818 ((eq org-log-note-purpose 'done) "closed todo item")
8819 ((eq org-log-note-purpose 'state)
8820 (format "state change to \"%s\"" org-log-note-state))
8821 ((eq org-log-note-purpose 'note)
8823 (t (error "This should not happen")))))
8824 (if org-log-note-extra (insert org-log-note-extra))
8825 (org-set-local 'org-finish-function 'org-store-log-note)))
8827 (defvar org-note-abort nil) ; dynamically scoped
8828 (defun org-store-log-note ()
8829 "Finish taking a log note, and insert it to where it belongs."
8830 (let ((txt (buffer-string))
8831 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
8833 (kill-buffer (current-buffer))
8834 (while (string-match "\\`#.*\n[ \t\n]*" txt)
8835 (setq txt (replace-match "" t t txt)))
8836 (if (string-match "\\s-+\\'" txt)
8837 (setq txt (replace-match "" t t txt)))
8838 (setq lines (org-split-string txt "\n"))
8839 (when (and note (string-match "\\S-" note))
8841 (org-replace-escapes
8843 (list (cons "%u" (user-login-name))
8844 (cons "%U" user-full-name)
8845 (cons "%t" (format-time-string
8846 (org-time-stamp-format 'long 'inactive)
8848 (cons "%s" (if org-log-note-state
8849 (concat "\"" org-log-note-state "\"")
8851 (if lines (setq note (concat note " \\\\")))
8853 (when (or current-prefix-arg org-note-abort) (setq lines nil))
8856 (set-buffer (marker-buffer org-log-note-marker))
8858 (goto-char org-log-note-marker)
8859 (move-marker org-log-note-marker nil)
8861 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
8862 (indent-relative nil)
8863 (insert "- " (pop lines))
8864 (org-indent-line-function)
8865 (beginning-of-line 1)
8866 (looking-at "[ \t]*")
8867 (setq ind (concat (match-string 0) " "))
8869 (while lines (insert "\n" ind (pop lines)))))))
8870 (set-window-configuration org-log-note-window-configuration)
8871 (with-current-buffer (marker-buffer org-log-note-return-to)
8872 (goto-char org-log-note-return-to))
8873 (move-marker org-log-note-return-to nil)
8874 (and org-log-post-message (message "%s" org-log-post-message)))
8876 (defun org-sparse-tree (&optional arg)
8877 "Create a sparse tree, prompt for the details.
8878 This command can create sparse trees. You first need to select the type
8879 of match used to create the tree:
8881 t Show entries with a specific TODO keyword.
8882 T Show entries selected by a tags match.
8883 p Enter a property name and its value (both with completion on existing
8884 names/values) and show entries with that property.
8885 r Show entries matching a regular expression
8886 d Show deadlines due within `org-deadline-warning-days'."
8888 (let (ans kwd value)
8889 (message "Sparse tree: [/]regexp [t]odo-kwd [T]ag [p]roperty [d]eadlines [b]efore-date")
8890 (setq ans (read-char-exclusive))
8893 (call-interactively 'org-check-deadlines))
8895 (call-interactively 'org-check-before-date))
8897 (org-show-todo-tree '(4)))
8899 (call-interactively 'org-tags-sparse-tree))
8900 ((member ans '(?p ?P))
8901 (setq kwd (org-ido-completing-read "Property: "
8902 (mapcar 'list (org-buffer-property-keys))))
8903 (setq value (org-ido-completing-read "Value: "
8904 (mapcar 'list (org-property-values kwd))))
8905 (unless (string-match "\\`{.*}\\'" value)
8906 (setq value (concat "\"" value "\"")))
8907 (org-tags-sparse-tree arg (concat kwd "=" value)))
8908 ((member ans '(?r ?R ?/))
8909 (call-interactively 'org-occur))
8910 (t (error "No such sparse tree command \"%c\"" ans)))))
8912 (defvar org-occur-highlights nil
8913 "List of overlays used for occur matches.")
8914 (make-variable-buffer-local 'org-occur-highlights)
8915 (defvar org-occur-parameters nil
8916 "Parameters of the active org-occur calls.
8917 This is a list, each call to org-occur pushes as cons cell,
8918 containing the regular expression and the callback, onto the list.
8919 The list can contain several entries if `org-occur' has been called
8920 several time with the KEEP-PREVIOUS argument. Otherwise, this list
8921 will only contain one set of parameters. When the highlights are
8922 removed (for example with `C-c C-c', or with the next edit (depending
8923 on `org-remove-highlights-with-change'), this variable is emptied
8925 (make-variable-buffer-local 'org-occur-parameters)
8927 (defun org-occur (regexp &optional keep-previous callback)
8928 "Make a compact tree which shows all matches of REGEXP.
8929 The tree will show the lines where the regexp matches, and all higher
8930 headlines above the match. It will also show the heading after the match,
8931 to make sure editing the matching entry is easy.
8932 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
8933 call to `org-occur' will be kept, to allow stacking of calls to this
8935 If CALLBACK is non-nil, it is a function which is called to confirm
8936 that the match should indeed be shown."
8937 (interactive "sRegexp: \nP")
8938 (unless keep-previous
8939 (org-remove-occur-highlights nil nil t))
8940 (push (cons regexp callback) org-occur-parameters)
8943 (goto-char (point-min))
8944 (if (or (not keep-previous) ; do not want to keep
8945 (not org-occur-highlights)) ; no previous matches
8948 (while (re-search-forward regexp nil t)
8949 (when (or (not callback)
8950 (save-match-data (funcall callback)))
8952 (when org-highlight-sparse-tree-matches
8953 (org-highlight-new-match (match-beginning 0) (match-end 0)))
8954 (org-show-context 'occur-tree))))
8955 (when org-remove-highlights-with-change
8956 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
8958 (unless org-sparse-tree-open-archived-trees
8959 (org-hide-archived-subtrees (point-min) (point-max)))
8960 (run-hooks 'org-occur-hook)
8962 (message "%d match(es) for regexp %s" cnt regexp))
8965 (defun org-show-context (&optional key)
8966 "Make sure point and context and visible.
8967 How much context is shown depends upon the variables
8968 `org-show-hierarchy-above', `org-show-following-heading'. and
8969 `org-show-siblings'."
8970 (let ((heading-p (org-on-heading-p t))
8971 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
8972 (following-p (org-get-alist-option org-show-following-heading key))
8973 (entry-p (org-get-alist-option org-show-entry-below key))
8974 (siblings-p (org-get-alist-option org-show-siblings key)))
8976 ;; Show heading or entry text
8977 (if (and heading-p (not entry-p))
8978 (org-flag-heading nil) ; only show the heading
8979 (and (or entry-p (org-invisible-p) (org-invisible-p2))
8980 (org-show-hidden-entry))) ; show entire entry
8982 ;; Show next sibling, or heading below text
8984 (and (if heading-p (org-goto-sibling) (outline-next-heading))
8985 (org-flag-heading nil))))
8986 (when siblings-p (org-show-siblings))
8988 ;; show all higher headings, possibly with siblings
8990 (while (and (condition-case nil
8991 (progn (org-up-heading-all 1) t)
8994 (org-flag-heading nil)
8995 (when siblings-p (org-show-siblings))))))))
8997 (defun org-reveal (&optional siblings)
8998 "Show current entry, hierarchy above it, and the following headline.
8999 This can be used to show a consistent set of context around locations
9000 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
9001 not t for the search context.
9003 With optional argument SIBLINGS, on each level of the hierarchy all
9004 siblings are shown. This repairs the tree structure to what it would
9005 look like when opened with hierarchical calls to `org-cycle'."
9007 (let ((org-show-hierarchy-above t)
9008 (org-show-following-heading t)
9009 (org-show-siblings (if siblings t org-show-siblings)))
9010 (org-show-context nil)))
9012 (defun org-highlight-new-match (beg end)
9013 "Highlight from BEG to END and mark the highlight is an occur headline."
9014 (let ((ov (org-make-overlay beg end)))
9015 (org-overlay-put ov 'face 'secondary-selection)
9016 (push ov org-occur-highlights)))
9018 (defun org-remove-occur-highlights (&optional beg end noremove)
9019 "Remove the occur highlights from the buffer.
9020 BEG and END are ignored. If NOREMOVE is nil, remove this function
9021 from the `before-change-functions' in the current buffer."
9023 (unless org-inhibit-highlight-removal
9024 (mapc 'org-delete-overlay org-occur-highlights)
9025 (setq org-occur-highlights nil)
9026 (setq org-occur-parameters nil)
9028 (remove-hook 'before-change-functions
9029 'org-remove-occur-highlights 'local))))
9033 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
9034 "Regular expression matching the priority indicator.")
9036 (defvar org-remove-priority-next-time nil)
9038 (defun org-priority-up ()
9039 "Increase the priority of the current item."
9043 (defun org-priority-down ()
9044 "Decrease the priority of the current item."
9046 (org-priority 'down))
9048 (defun org-priority (&optional action)
9049 "Change the priority of an item by ARG.
9050 ACTION can be `set', `up', `down', or a character."
9052 (setq action (or action 'set))
9053 (let (current new news have remove)
9055 (org-back-to-heading)
9056 (if (looking-at org-priority-regexp)
9057 (setq current (string-to-char (match-string 2))
9059 (setq current org-default-priority))
9061 ((or (eq action 'set)
9062 (if (featurep 'xemacs) (characterp action) (integerp action)))
9063 (if (not (eq action 'set))
9065 (message "Priority %c-%c, SPC to remove: "
9066 org-highest-priority org-lowest-priority)
9067 (setq new (read-char-exclusive)))
9068 (if (and (= (upcase org-highest-priority) org-highest-priority)
9069 (= (upcase org-lowest-priority) org-lowest-priority))
9070 (setq new (upcase new)))
9071 (cond ((equal new ?\ ) (setq remove t))
9072 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
9073 (error "Priority must be between `%c' and `%c'"
9074 org-highest-priority org-lowest-priority))))
9076 (if (and (not have) (eq last-command this-command))
9077 (setq new org-lowest-priority)
9078 (setq new (if (and org-priority-start-cycle-with-default (not have))
9079 org-default-priority (1- current)))))
9081 (if (and (not have) (eq last-command this-command))
9082 (setq new org-highest-priority)
9083 (setq new (if (and org-priority-start-cycle-with-default (not have))
9084 org-default-priority (1+ current)))))
9085 (t (error "Invalid action")))
9086 (if (or (< (upcase new) org-highest-priority)
9087 (> (upcase new) org-lowest-priority))
9089 (setq news (format "%c" new))
9092 (replace-match "" t t nil 1)
9093 (replace-match news t t nil 2))
9095 (error "No priority cookie found in line")
9096 (looking-at org-todo-line-regexp)
9099 (goto-char (match-end 2))
9100 (insert " [#" news "]"))
9101 (goto-char (match-beginning 3))
9102 (insert "[#" news "] ")))))
9103 (org-preserve-lc (org-set-tags nil 'align))
9105 (message "Priority removed")
9106 (message "Priority of current item set to %s" news))))
9109 (defun org-get-priority (s)
9110 "Find priority cookie and return priority."
9112 (if (not (string-match org-priority-regexp s))
9113 (* 1000 (- org-lowest-priority org-default-priority))
9114 (* 1000 (- org-lowest-priority
9115 (string-to-char (match-string 2 s)))))))
9119 (defvar org-agenda-archives-mode)
9120 (defun org-scan-tags (action matcher &optional todo-only)
9121 "Scan headline tags with inheritance and produce output ACTION.
9123 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
9124 or `agenda' to produce an entry list for an agenda view. It can also be
9125 a Lisp form or a function that should be called at each matched headline, in
9126 this case the return value is a list of all return values from these calls.
9128 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
9129 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
9130 only lines with a TODO keyword are included in the output."
9131 (let* ((re (concat "[\n\r]" outline-regexp " *\\(\\<\\("
9132 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
9134 "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
9135 (props (list 'face 'default
9136 'done-face 'org-done
9137 'undone-face 'default
9138 'mouse-face 'highlight
9139 'org-not-done-regexp org-not-done-regexp
9140 'org-todo-regexp org-todo-regexp
9141 'keymap org-agenda-keymap
9143 (format "mouse-2 or RET jump to org file %s"
9144 (abbreviate-file-name
9145 (or (buffer-file-name (buffer-base-buffer))
9146 (buffer-name (buffer-base-buffer)))))))
9147 (case-fold-search nil)
9148 lspos tags tags-list
9149 (tags-alist (list (cons 0 (mapcar 'downcase org-file-tags))))
9150 (llast 0) rtn rtn1 level category i txt
9151 todo marker entry priority)
9152 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
9153 (setq action (list 'lambda nil action)))
9155 (goto-char (point-min))
9156 (when (eq action 'sparse-tree)
9158 (org-remove-occur-highlights))
9159 (while (re-search-forward re nil t)
9161 (setq todo (if (match-end 1) (match-string 2))
9162 tags (if (match-end 4) (match-string 4)))
9163 (goto-char (setq lspos (1+ (match-beginning 0))))
9164 (setq level (org-reduced-level (funcall outline-level))
9165 category (org-get-category))
9166 (setq i llast llast level)
9167 ;; remove tag lists from same and sublevels
9169 (when (setq entry (assoc i tags-alist))
9170 (setq tags-alist (delete entry tags-alist)))
9172 ;; add the next tags
9174 (setq tags (mapcar 'downcase (org-split-string tags ":"))
9176 (cons (cons level tags) tags-alist)))
9177 ;; compile tags for current headline
9179 (if org-use-tag-inheritance
9180 (apply 'append (mapcar 'cdr (reverse tags-alist)))
9182 (when org-use-tag-inheritance
9183 (setcdr (car tags-alist)
9185 (setq x (copy-sequence x))
9186 (org-add-prop-inherited x))
9187 (cdar tags-alist))))
9188 (when (and tags org-use-tag-inheritance
9189 (not (eq t org-use-tag-inheritance)))
9190 ;; selective inheritance, remove uninherited ones
9191 (setcdr (car tags-alist)
9192 (org-remove-uniherited-tags (cdar tags-alist))))
9193 (when (and (or (not todo-only) (member todo org-not-done-keywords))
9194 (let ((case-fold-search t)) (eval matcher))
9196 (not (member org-archive-tag tags-list))
9197 ;; we have an archive tag, should we use this anyway?
9198 (or (not org-agenda-skip-archived-trees)
9199 (and (eq action 'agenda) org-agenda-archives-mode))))
9200 (unless (eq action 'sparse-tree) (org-agenda-skip))
9202 ;; select this headline
9205 ((eq action 'sparse-tree)
9206 (and org-highlight-sparse-tree-matches
9207 (org-get-heading) (match-end 0)
9208 (org-highlight-new-match
9209 (match-beginning 0) (match-beginning 1)))
9210 (org-show-context 'tags-tree))
9211 ((eq action 'agenda)
9212 (setq txt (org-format-agenda-item
9215 (if org-tags-match-list-sublevels
9216 (make-string (1- level) ?.) "")
9218 category (org-get-tags-at))
9219 priority (org-get-priority txt))
9221 (setq marker (org-agenda-new-marker))
9222 (org-add-props txt props
9223 'org-marker marker 'org-hd-marker marker 'org-category category
9224 'priority priority 'type "tagsmatch")
9228 (setq rtn1 (funcall action))
9230 (goto-char (point-at-eol)))
9231 (t (error "Invalid action")))
9233 ;; if we are to skip sublevels, jump to end of subtree
9234 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
9235 (when (and (eq action 'sparse-tree)
9236 (not org-sparse-tree-open-archived-trees))
9237 (org-hide-archived-subtrees (point-min) (point-max)))
9240 (defun org-remove-uniherited-tags (tags)
9241 "Remove all tags that are not inherited from the list TAGS."
9243 ((eq org-use-tag-inheritance t)
9244 (if org-tags-exclude-from-inheritance
9245 (org-delete-all org-tags-exclude-from-inheritance tags)
9247 ((not org-use-tag-inheritance) nil)
9248 ((stringp org-use-tag-inheritance)
9251 (if (and (string-match org-use-tag-inheritance x)
9252 (not (member x org-tags-exclude-from-inheritance)))
9255 ((listp org-use-tag-inheritance)
9258 (if (member x org-use-tag-inheritance) x nil))
9261 (defvar todo-only) ;; dynamically scoped
9263 (defun org-tags-sparse-tree (&optional todo-only match)
9264 "Create a sparse tree according to tags string MATCH.
9265 MATCH can contain positive and negative selection of tags, like
9266 \"+WORK+URGENT-WITHBOSS\".
9267 If optional argument TODO-ONLY is non-nil, only select lines that are
9270 (org-prepare-agenda-buffers (list (current-buffer)))
9271 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
9273 (defvar org-cached-props nil)
9274 (defun org-cached-entry-get (pom property)
9275 (if (or (eq t org-use-property-inheritance)
9276 (and (stringp org-use-property-inheritance)
9277 (string-match org-use-property-inheritance property))
9278 (and (listp org-use-property-inheritance)
9279 (member property org-use-property-inheritance)))
9280 ;; Caching is not possible, check it directly
9281 (org-entry-get pom property 'inherit)
9282 ;; Get all properties, so that we can do complicated checks easily
9283 (cdr (assoc property (or org-cached-props
9284 (setq org-cached-props
9285 (org-entry-properties pom)))))))
9287 (defun org-global-tags-completion-table (&optional files)
9288 "Return the list of all tags in all agenda buffer/files."
9295 (set-buffer (find-file-noselect file))
9296 (append (org-get-buffer-tags)
9297 (mapcar (lambda (x) (if (stringp (car-safe x))
9298 (list (car-safe x)) nil))
9300 (if (and files (car files))
9302 (org-agenda-files))))))))
9304 (defun org-make-tags-matcher (match)
9305 "Create the TAGS//TODO matcher form for the selection string MATCH."
9306 ;; todo-only is scoped dynamically into this function, and the function
9307 ;; may change it if the matcher asks for it.
9309 ;; Get a new match request, with completion
9310 (let ((org-last-tags-completion-table
9311 (org-global-tags-completion-table)))
9312 (setq match (org-ido-completing-read
9313 "Match: " 'org-tags-completion-function nil nil nil
9314 'org-tags-history))))
9316 ;; Parse the string and create a lisp form
9317 (let ((match0 match)
9318 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
9320 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
9321 orterms term orlist re-p str-p level-p level-op time-p
9322 prop-p pn pv po cat-p gv rest)
9323 (if (string-match "/+" match)
9324 ;; match contains also a todo-matching request
9326 (setq tagsmatch (substring match 0 (match-beginning 0))
9327 todomatch (substring match (match-end 0)))
9328 (if (string-match "^!" todomatch)
9329 (setq todo-only t todomatch (substring todomatch 1)))
9330 (if (string-match "^\\s-*$" todomatch)
9331 (setq todomatch nil)))
9332 ;; only matching tags
9333 (setq tagsmatch match todomatch nil))
9335 ;; Make the tags matcher
9336 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
9337 (setq tagsmatcher t)
9338 (setq orterms (org-split-string tagsmatch "|") orlist nil)
9339 (while (setq term (pop orterms))
9340 (while (and (equal (substring term -1) "\\") orterms)
9341 (setq term (concat term "|" (pop orterms)))) ; repair bad split
9342 (while (string-match re term)
9343 (setq rest (substring term (match-end 0))
9344 minus (and (match-end 1)
9345 (equal (match-string 1 term) "-"))
9346 tag (match-string 2 term)
9347 re-p (equal (string-to-char tag) ?{)
9348 level-p (match-end 4)
9349 prop-p (match-end 5)
9351 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
9353 (setq level-op (org-op-to-function (match-string 3 term)))
9354 `(,level-op level ,(string-to-number
9355 (match-string 4 term))))
9357 (setq pn (match-string 5 term)
9358 po (match-string 6 term)
9359 pv (match-string 7 term)
9360 cat-p (equal pn "CATEGORY")
9361 re-p (equal (string-to-char pv) ?{)
9362 str-p (equal (string-to-char pv) ?\")
9363 time-p (save-match-data
9364 (string-match "^\"[[<].*[]>]\"$" pv))
9365 pv (if (or re-p str-p) (substring pv 1 -1) pv))
9366 (if time-p (setq pv (org-matcher-time pv)))
9367 (setq po (org-op-to-function po (if time-p 'time str-p)))
9369 ((equal pn "CATEGORY")
9370 (setq gv '(get-text-property (point) 'org-category)))
9374 (setq gv `(org-cached-entry-get nil ,pn))))
9377 `(not (string-match ,pv (or ,gv "")))
9378 `(string-match ,pv (or ,gv "")))
9380 `(,po (or ,gv "") ,pv)
9381 `(,po (string-to-number (or ,gv ""))
9382 ,(string-to-number pv) ))))
9383 (t `(member ,(downcase tag) tags-list)))
9384 mm (if minus (list 'not mm) mm)
9386 (push mm tagsmatcher))
9387 (push (if (> (length tagsmatcher) 1)
9388 (cons 'and tagsmatcher)
9391 (setq tagsmatcher nil))
9392 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
9394 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
9395 ;; Make the todo matcher
9396 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
9397 (setq todomatcher t)
9398 (setq orterms (org-split-string todomatch "|") orlist nil)
9399 (while (setq term (pop orterms))
9400 (while (string-match re term)
9401 (setq minus (and (match-end 1)
9402 (equal (match-string 1 term) "-"))
9403 kwd (match-string 2 term)
9404 re-p (equal (string-to-char kwd) ?{)
9405 term (substring term (match-end 0))
9407 `(string-match ,(substring kwd 1 -1) todo)
9408 (list 'equal 'todo kwd))
9409 mm (if minus (list 'not mm) mm))
9410 (push mm todomatcher))
9411 (push (if (> (length todomatcher) 1)
9412 (cons 'and todomatcher)
9415 (setq todomatcher nil))
9416 (setq todomatcher (if (> (length orlist) 1)
9417 (cons 'or orlist) (car orlist))))
9419 ;; Return the string and lisp forms of the matcher
9420 (setq matcher (if todomatcher
9421 (list 'and tagsmatcher todomatcher)
9423 (cons match0 matcher)))
9425 (defun org-op-to-function (op &optional stringp)
9426 "Turn an operator into the appropriate function."
9429 ((equal op "<" ) '(< string< org-time<))
9430 ((equal op ">" ) '(> org-string> org-time>))
9431 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
9432 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
9433 ((member op '("=" "==")) '(= string= org-time=))
9434 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
9435 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
9437 (defun org<> (a b) (not (= a b)))
9438 (defun org-string<= (a b) (or (string= a b) (string< a b)))
9439 (defun org-string>= (a b) (not (string< a b)))
9440 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
9441 (defun org-string<> (a b) (not (string= a b)))
9442 (defun org-time= (a b) (= (org-2ft a) (org-2ft b)))
9443 (defun org-time< (a b) (< (org-2ft a) (org-2ft b)))
9444 (defun org-time<= (a b) (<= (org-2ft a) (org-2ft b)))
9445 (defun org-time> (a b) (> (org-2ft a) (org-2ft b)))
9446 (defun org-time>= (a b) (>= (org-2ft a) (org-2ft b)))
9447 (defun org-time<> (a b) (org<> (org-2ft a) (org-2ft b)))
9449 "Convert S to a floating point time.
9450 If S is already a number, just return it. If it is a string, parse
9451 it as a time string and apply `float-time' to it. f S is nil, just return 0."
9456 (float-time (apply 'encode-time (org-parse-time-string s)))
9460 (defun org-time-today ()
9461 "Time in seconds today at 0:00.
9462 Returns the float number of seconds since the beginning of the
9463 epoch to the beginning of today (00:00)."
9464 (float-time (apply 'encode-time
9465 (append '(0 0 0) (nthcdr 3 (decode-time))))))
9467 (defun org-matcher-time (s)
9468 "Interpret a time comparison value."
9471 ((string= s "<now>") (float-time))
9472 ((string= s "<today>") (org-time-today))
9473 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
9474 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
9475 ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
9477 (* (string-to-number (match-string 1 s))
9478 (cdr (assoc (match-string 2 s)
9479 '(("d" . 86400.0) ("w" . 604800.0)
9480 ("m" . 2678400.0) ("y" . 31557600.0)))))))
9483 (defun org-match-any-p (re list)
9484 "Does re match any element of list?"
9485 (setq list (mapcar (lambda (x) (string-match re x)) list))
9488 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
9489 (defvar org-tags-overlay (org-make-overlay 1 1))
9490 (org-detach-overlay org-tags-overlay)
9492 (defun org-get-local-tags-at (&optional pos)
9493 "Get a list of tags defined in the current headline."
9494 (org-get-tags-at pos 'local))
9496 (defun org-get-local-tags ()
9497 "Get a list of tags defined in the current headline."
9498 (org-get-tags-at nil 'local))
9500 (defun org-get-tags-at (&optional pos local)
9501 "Get a list of all headline tags applicable at POS.
9502 POS defaults to point. If tags are inherited, the list contains
9503 the targets in the same sequence as the headlines appear, i.e.
9504 the tags of the current headline come last.
9505 When LOCAL is non-nil, only return tags from the current headline,
9506 ignore inherited ones."
9508 (let (tags ltags lastpos parent)
9512 (goto-char (or pos (point)))
9517 (org-back-to-heading t)
9518 (while (not (equal lastpos (point)))
9519 (setq lastpos (point))
9520 (when (looking-at (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
9521 (setq ltags (org-split-string
9522 (org-match-string-no-properties 1) ":"))
9524 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
9527 (org-remove-uniherited-tags ltags)
9530 (or org-use-tag-inheritance (throw 'done t))
9531 (if local (throw 'done t))
9532 (org-up-heading-all 1)
9535 (append (org-remove-uniherited-tags org-file-tags) tags))))
9537 (defun org-add-prop-inherited (s)
9538 (add-text-properties 0 (length s) '(inherited t) s)
9541 (defun org-toggle-tag (tag &optional onoff)
9542 "Toggle the tag TAG for the current line.
9543 If ONOFF is `on' or `off', don't toggle but set to this state."
9546 (org-back-to-heading t)
9547 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t]*$")
9550 (setq current (match-string 1))
9553 (setq current (nreverse (org-split-string current ":")))
9557 (or (member tag current) (push tag current)))
9559 (or (not (member tag current)) (setq current (delete tag current))))
9560 (t (if (member tag current)
9561 (setq current (delete tag current))
9563 (push tag current))))
9567 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
9568 (org-set-tags nil t))
9569 (delete-horizontal-space))
9570 (run-hooks 'org-after-tags-change-hook))
9573 (defun org-align-tags-here (to-col)
9574 ;; Assumes that this is a headline
9575 (let ((pos (point)) (col (current-column)) ncol tags-l p)
9576 (beginning-of-line 1)
9577 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
9578 (< pos (match-beginning 2)))
9580 (setq tags-l (- (match-end 2) (match-beginning 2)))
9581 (goto-char (match-beginning 1))
9583 (delete-region (point) (1+ (match-beginning 2)))
9584 (setq ncol (max (1+ (current-column))
9588 (- (abs to-col) tags-l))))
9590 (insert (make-string (- ncol (current-column)) ?\ ))
9591 (setq ncol (current-column))
9592 (when indent-tabs-mode (tabify p (point-at-eol)))
9593 (org-move-to-column (min ncol col) t))
9596 (defun org-set-tags-command (&optional arg just-align)
9597 "Call the set-tags command for the current entry."
9599 (if (org-on-heading-p)
9600 (org-set-tags arg just-align)
9602 (org-back-to-heading t)
9603 (org-set-tags arg just-align))))
9605 (defun org-set-tags (&optional arg just-align)
9606 "Set the tags for the current headline.
9607 With prefix ARG, realign all tags in headings in the current buffer."
9609 (let* ((re (concat "^" outline-regexp))
9610 (current (org-get-tags-string))
9611 (col (current-column))
9612 (org-setting-tags t)
9613 table current-tags inherited-tags ; computed below when needed
9617 (goto-char (point-min))
9618 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
9619 (while (re-search-forward re nil t)
9620 (org-set-tags nil t)
9622 (message "All tags realigned to column %d" org-tags-column))
9625 ;; Get a new set of tags from the user
9627 (setq table (or org-tag-alist (org-get-buffer-tags))
9628 org-last-tags-completion-table table
9629 current-tags (org-split-string current ":")
9630 inherited-tags (nreverse
9631 (nthcdr (length current-tags)
9632 (nreverse (org-get-tags-at))))
9634 (if (or (eq t org-use-fast-tag-selection)
9635 (and org-use-fast-tag-selection
9636 (delq nil (mapcar 'cdr table))))
9637 (org-fast-tag-selection
9638 current-tags inherited-tags table
9639 (if org-fast-tag-selection-include-todo org-todo-key-alist))
9640 (let ((org-add-colon-after-tag-completion t))
9642 (org-without-partial-completion
9643 (org-ido-completing-read "Tags: " 'org-tags-completion-function
9644 nil nil current 'org-tags-history)))))))
9645 (while (string-match "[-+&]+" tags)
9646 ;; No boolean logic, just a list
9647 (setq tags (replace-match ":" t t tags))))
9649 (if (string-match "\\`[\t ]*\\'" tags)
9651 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
9652 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
9654 ;; Insert new tags at the correct column
9655 (beginning-of-line 1)
9657 ((and (equal current "") (equal tags "")))
9659 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
9663 (goto-char (match-beginning 0))
9664 (setq c0 (current-column) p0 (point)
9665 c1 (max (1+ c0) (if (> org-tags-column 0)
9667 (- (- org-tags-column) (length tags))))
9668 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
9669 (replace-match rpl t t)
9670 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
9672 (t (error "Tags alignment failed")))
9673 (org-move-to-column col)
9675 (run-hooks 'org-after-tags-change-hook)))))
9677 (defun org-change-tag-in-region (beg end tag off)
9678 "Add or remove TAG for each entry in the region.
9679 This works in the agenda, and also in an org-mode buffer."
9681 (list (region-beginning) (region-end)
9682 (let ((org-last-tags-completion-table
9684 (org-get-buffer-tags)
9685 (org-global-tags-completion-table))))
9686 (org-ido-completing-read
9687 "Tag: " 'org-tags-completion-function nil nil nil
9690 (message "[s]et or [r]emove? ")
9691 (equal (read-char-exclusive) ?r))))
9692 (if (fboundp 'deactivate-mark) (deactivate-mark))
9693 (let ((agendap (equal major-mode 'org-agenda-mode))
9694 l1 l2 m buf pos newhead (cnt 0))
9696 (setq l2 (1- (org-current-line)))
9698 (setq l1 (org-current-line))
9699 (loop for l from l1 to l2 do
9701 (setq m (get-text-property (point) 'org-hd-marker))
9702 (when (or (and (org-mode-p) (org-on-heading-p))
9704 (setq buf (if agendap (marker-buffer m) (current-buffer))
9705 pos (if agendap m (point)))
9706 (with-current-buffer buf
9711 (org-toggle-tag tag (if off 'off 'on))
9712 (setq newhead (org-get-heading)))))
9713 (and agendap (org-agenda-change-all-lines newhead m))))
9714 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
9716 (defun org-tags-completion-function (string predicate &optional flag)
9717 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
9718 (confirm (lambda (x) (stringp (car x)))))
9719 (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
9720 (setq s1 (match-string 1 string)
9721 s2 (match-string 2 string))
9722 (setq s1 "" s2 string))
9726 (setq rtn (try-completion s2 ctable confirm))
9729 (concat s1 s2 (substring rtn (length s2))
9730 (if (and org-add-colon-after-tag-completion
9736 (all-completions s2 ctable confirm)
9743 (defun org-fast-tag-insert (kwd tags face &optional end)
9744 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
9745 (insert (format "%-12s" (concat kwd ":"))
9746 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
9749 (defun org-fast-tag-show-exit (flag)
9752 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
9756 (org-move-to-column (- (window-width) 19) t)
9757 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
9759 (defun org-set-current-tags-overlay (current prefix)
9760 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
9761 (if (featurep 'xemacs)
9762 (org-overlay-display org-tags-overlay (concat prefix s)
9763 'secondary-selection)
9764 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
9765 (org-overlay-display org-tags-overlay (concat prefix s)))))
9767 (defun org-fast-tag-selection (current inherited table &optional todo-table)
9768 "Fast tag selection with single keys.
9769 CURRENT is the current list of tags in the headline, INHERITED is the
9770 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
9771 possibly with grouping information. TODO-TABLE is a similar table with
9772 TODO keywords, should these have keys assigned to them.
9773 If the keys are nil, a-z are automatically assigned.
9774 Returns the new tags string, or nil to not change the current settings."
9775 (let* ((fulltable (append table todo-table))
9776 (maxlen (apply 'max (mapcar
9778 (if (stringp (car x)) (string-width (car x)) 0))
9780 (buf (current-buffer))
9781 (expert (eq org-fast-tag-selection-single-key 'expert))
9783 (fwidth (+ maxlen 3 1 3))
9784 (ncol (/ (- (window-width) 4) fwidth))
9787 tg cnt e c char c1 c2 ntable tbl rtn
9788 ov-start ov-end ov-prefix
9789 (exit-after-next org-fast-tag-selection-single-key)
9790 (done-keywords org-done-keywords)
9793 (beginning-of-line 1)
9795 (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
9796 (setq ov-start (match-beginning 1)
9797 ov-end (match-end 1)
9799 (setq ov-start (1- (point-at-eol))
9800 ov-end (1+ ov-start))
9801 (skip-chars-forward "^\n\r")
9804 (buffer-substring (1- (point)) (point))
9805 (if (> (current-column) org-tags-column)
9807 (make-string (- org-tags-column (current-column)) ?\ ))))))
9808 (org-move-overlay org-tags-overlay ov-start ov-end)
9809 (save-window-excursion
9811 (set-buffer (get-buffer-create " *Org tags*"))
9812 (delete-other-windows)
9813 (split-window-vertically)
9814 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
9816 (org-set-local 'org-done-keywords done-keywords)
9817 (org-fast-tag-insert "Inherited" inherited i-face "\n")
9818 (org-fast-tag-insert "Current" current c-face "\n\n")
9819 (org-fast-tag-show-exit exit-after-next)
9820 (org-set-current-tags-overlay current ov-prefix)
9821 (setq tbl fulltable char ?a cnt 0)
9822 (while (setq e (pop tbl))
9824 ((equal e '(:startgroup))
9825 (push '() groups) (setq ingroup t)
9826 (when (not (= cnt 0))
9830 ((equal e '(:endgroup))
9831 (setq ingroup nil cnt 0)
9834 (setq tg (car e) c2 nil)
9837 ;; automatically assign a character.
9838 (setq c1 (string-to-char
9839 (downcase (substring
9840 tg (if (= (string-to-char tg) ?@) 1 0)))))
9841 (if (or (rassoc c1 ntable) (rassoc c1 table))
9842 (while (or (rassoc char ntable) (rassoc char table))
9843 (setq char (1+ char)))
9845 (setq c (or c2 char)))
9846 (if ingroup (push tg (car groups)))
9847 (setq tg (org-add-props tg nil 'face
9849 ((not (assoc tg table))
9850 (org-get-todo-face tg))
9851 ((member tg current) c-face)
9852 ((member tg inherited) i-face)
9854 (if (and (= cnt 0) (not ingroup)) (insert " "))
9855 (insert "[" c "] " tg (make-string
9856 (- fwidth 4 (length tg)) ?\ ))
9857 (push (cons tg c) ntable)
9858 (when (= (setq cnt (1+ cnt)) ncol)
9860 (if ingroup (insert " "))
9862 (setq ntable (nreverse ntable))
9864 (goto-char (point-min))
9865 (if (not expert) (org-fit-window-to-buffer))
9869 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
9870 (if groups " [!] no groups" " [!]groups")
9871 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
9872 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
9874 ((= c ?\r) (throw 'exit t))
9876 (setq groups (not groups))
9877 (goto-char (point-min))
9878 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
9881 (org-fast-tag-show-exit
9882 (setq exit-after-next (not exit-after-next)))
9884 (delete-other-windows)
9885 (split-window-vertically)
9886 (org-switch-to-buffer-other-window " *Org tags*")
9887 (org-fit-window-to-buffer)))
9889 (and (= c ?q) (not (rassoc c ntable))))
9890 (org-detach-overlay org-tags-overlay)
9894 (if exit-after-next (setq exit-after-next 'now)))
9897 (setq tg (org-ido-completing-read
9900 (with-current-buffer buf
9901 (org-get-buffer-tags)))))
9902 (quit (setq tg "")))
9903 (when (string-match "\\S-" tg)
9904 (add-to-list 'buffer-tags (list tg))
9905 (if (member tg current)
9906 (setq current (delete tg current))
9908 (if exit-after-next (setq exit-after-next 'now)))
9909 ((setq e (rassoc c todo-table) tg (car e))
9910 (with-current-buffer buf
9911 (save-excursion (org-todo tg)))
9912 (if exit-after-next (setq exit-after-next 'now)))
9913 ((setq e (rassoc c ntable) tg (car e))
9914 (if (member tg current)
9915 (setq current (delete tg current))
9916 (loop for g in groups do
9919 (setq current (delete x current)))
9922 (if exit-after-next (setq exit-after-next 'now))))
9924 ;; Create a sorted list
9928 (assoc b (cdr (memq (assoc a ntable) ntable))))))
9929 (if (eq exit-after-next 'now) (throw 'exit t))
9930 (goto-char (point-min))
9931 (beginning-of-line 2)
9932 (delete-region (point) (point-at-eol))
9933 (org-fast-tag-insert "Current" current c-face)
9934 (org-set-current-tags-overlay current ov-prefix)
9935 (while (re-search-forward
9936 (org-re "\\[.\\] \\([[:alnum:]_@]+\\)") nil t)
9937 (setq tg (match-string 1))
9938 (add-text-properties
9939 (match-beginning 1) (match-end 1)
9942 ((member tg current) c-face)
9943 ((member tg inherited) i-face)
9944 (t (get-text-property (match-beginning 1) 'face))))))
9945 (goto-char (point-min)))))
9946 (org-detach-overlay org-tags-overlay)
9948 (mapconcat 'identity current ":")
9951 (defun org-get-tags-string ()
9952 "Get the TAGS string in the current headline."
9953 (unless (org-on-heading-p t)
9954 (error "Not on a heading"))
9956 (beginning-of-line 1)
9957 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
9958 (org-match-string-no-properties 1)
9961 (defun org-get-tags ()
9962 "Get the list of tags specified in the current headline."
9963 (org-split-string (org-get-tags-string) ":"))
9965 (defun org-get-buffer-tags ()
9966 "Get a table of all tags used in the buffer, for completion."
9969 (goto-char (point-min))
9970 (while (re-search-forward
9971 (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t\r\n]") nil t)
9972 (when (equal (char-after (point-at-bol 0)) ?*)
9973 (mapc (lambda (x) (add-to-list 'tags x))
9974 (org-split-string (org-match-string-no-properties 1) ":")))))
9975 (mapcar 'list tags)))
9977 ;;;; The mapping API
9980 (defun org-map-entries (func &optional match scope &rest skip)
9981 "Call FUNC at each headline selected by MATCH in SCOPE.
9983 FUNC is a function or a lisp form. The function will be called without
9984 arguments, with the cursor positioned at the beginning of the headline.
9985 The return values of all calls to the function will be collected and
9988 MATCH is a tags/property/todo match as it is used in the agenda tags view.
9989 Only headlines that are matched by this query will be considered during
9990 the iteration. When MATCH is nil or t, all headlines will be
9991 visited by the iteration.
9993 SCOPE determines the scope of this command. It can be any of:
9995 nil The current buffer, respecting the restriction if any
9996 tree The subtree started with the entry at point
9997 file The current buffer, without restriction
9999 The current buffer, and any archives associated with it
10000 agenda All agenda files
10001 agenda-with-archives
10002 All agenda files with any archive files associated with them
10004 If this is a list, all files in the list will be scanned
10006 The remaining args are treated as settings for the skipping facilities of
10007 the scanner. The following items can be given here:
10009 archive skip trees with the archive tag.
10010 comment skip trees with the COMMENT keyword
10011 function or Emacs Lisp form:
10012 will be used as value for `org-agenda-skip-function', so whenever
10013 the the function returns t, FUNC will not be called for that
10014 entry and search will continue from the point where the
10015 function leaves it."
10016 (let* ((org-agenda-archives-mode nil) ; just to make sure
10017 (org-agenda-skip-archived-trees (memq 'archive skip))
10018 (org-agenda-skip-comment-trees (memq 'comment skip))
10019 (org-agenda-skip-function
10020 (car (org-delete-all '(comment archive) skip)))
10021 (org-tags-match-list-sublevels t)
10022 matcher pos file res
10023 org-todo-keywords-for-agenda
10024 org-done-keywords-for-agenda
10025 org-todo-keyword-alist-for-agenda
10026 org-tag-alist-for-agenda)
10029 ((eq match t) (setq matcher t))
10030 ((eq match nil) (setq matcher t))
10031 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
10033 (when (eq scope 'tree)
10034 (org-back-to-heading t)
10035 (org-narrow-to-subtree)
10040 (org-prepare-agenda-buffers
10041 (list (buffer-file-name (current-buffer))))
10042 (org-scan-tags func matcher))
10043 ;; Get the right scope
10046 ((and scope (listp scope) (symbolp (car scope)))
10047 (setq scope (eval scope)))
10048 ((eq scope 'agenda)
10049 (setq scope (org-agenda-files t)))
10050 ((eq scope 'agenda-with-archives)
10051 (setq scope (org-agenda-files t))
10052 (setq scope (org-add-archive-files scope)))
10054 (setq scope (list (buffer-file-name))))
10055 ((eq scope 'file-with-archives)
10056 (setq scope (org-add-archive-files (list (buffer-file-name))))))
10057 (org-prepare-agenda-buffers scope)
10058 (while (setq file (pop scope))
10059 (with-current-buffer (org-find-base-buffer-visiting file)
10063 (goto-char (point-min))
10064 (setq res (append res (org-scan-tags func matcher)))))))
10069 ;;; Setting and retrieving properties
10071 (defconst org-special-properties
10072 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
10073 "TIMESTAMP" "TIMESTAMP_IA")
10074 "The special properties valid in Org-mode.
10076 These are properties that are not defined in the property drawer,
10077 but in some other way.")
10079 (defconst org-default-properties
10080 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
10081 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
10082 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
10083 "EXPORT_FILE_NAME" "EXPORT_TITLE")
10084 "Some properties that are used by Org-mode for various purposes.
10085 Being in this list makes sure that they are offered for completion.")
10087 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
10088 "Regular expression matching the first line of a property drawer.")
10090 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
10091 "Regular expression matching the first line of a property drawer.")
10093 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
10094 "Regular expression matching the first line of a property drawer.")
10096 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
10097 "Regular expression matching the first line of a property drawer.")
10099 (defconst org-property-drawer-re
10100 (concat "\\(" org-property-start-re "\\)[^\000]*\\("
10101 org-property-end-re "\\)\n?")
10102 "Matches an entire property drawer.")
10104 (defconst org-clock-drawer-re
10105 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
10106 org-property-end-re "\\)\n?")
10107 "Matches an entire clock drawer.")
10109 (defun org-property-action ()
10110 "Do an action on properties."
10113 (org-at-property-p)
10114 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
10115 (setq c (read-char-exclusive))
10118 (call-interactively 'org-set-property))
10120 (call-interactively 'org-delete-property))
10122 (call-interactively 'org-delete-property-globally))
10124 (call-interactively 'org-compute-property-at-point))
10125 (t (error "No such property action %c" c)))))
10127 (defun org-at-property-p ()
10128 "Is the cursor in a property line?"
10129 ;; FIXME: Does not check if we are actually in the drawer.
10130 ;; FIXME: also returns true on any drawers.....
10131 ;; This is used by C-c C-c for property action.
10133 (beginning-of-line 1)
10134 (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))))
10136 (defun org-get-property-block (&optional beg end force)
10137 "Return the (beg . end) range of the body of the property drawer.
10138 BEG and END can be beginning and end of subtree, if not given
10139 they will be found.
10140 If the drawer does not exist and FORCE is non-nil, create the drawer."
10143 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
10144 (end (or end (progn (outline-next-heading) (point)))))
10146 (if (re-search-forward org-property-start-re end t)
10147 (setq beg (1+ (match-end 0)))
10150 (org-insert-property-drawer)
10151 (setq end (progn (outline-next-heading) (point))))
10154 (if (re-search-forward org-property-start-re end t)
10155 (setq beg (1+ (match-end 0)))))
10156 (if (re-search-forward org-property-end-re end t)
10157 (setq end (match-beginning 0))
10158 (or force (throw 'exit nil))
10161 (org-indent-line-function)
10162 (insert ":END:\n"))
10165 (defun org-entry-properties (&optional pom which)
10166 "Get all properties of the entry at point-or-marker POM.
10167 This includes the TODO keyword, the tags, time strings for deadline,
10168 scheduled, and clocking, and any additional properties defined in the
10169 entry. The return value is an alist, keys may occur multiple times
10170 if the property key was used several times.
10171 POM may also be nil, in which case the current entry is used.
10172 If WHICH is nil or `all', get all properties. If WHICH is
10173 `special' or `standard', only get that subclass."
10174 (setq which (or which 'all))
10175 (org-with-point-at pom
10176 (let ((clockstr (substring org-clock-string 0 -1))
10177 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
10178 beg end range props sum-props key value string clocksum)
10180 (when (condition-case nil (org-back-to-heading t) (error nil))
10182 (setq sum-props (get-text-property (point) 'org-summaries))
10183 (setq clocksum (get-text-property (point) :org-clock-minutes))
10184 (outline-next-heading)
10186 (when (memq which '(all special))
10187 ;; Get the special properties, like TODO and tags
10189 (when (and (looking-at org-todo-line-regexp) (match-end 2))
10190 (push (cons "TODO" (org-match-string-no-properties 2)) props))
10191 (when (looking-at org-priority-regexp)
10192 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
10193 (when (and (setq value (org-get-tags-string))
10194 (string-match "\\S-" value))
10195 (push (cons "TAGS" value) props))
10196 (when (setq value (org-get-tags-at))
10197 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
10199 (while (re-search-forward org-maybe-keyword-time-regexp end t)
10200 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
10201 string (if (equal key clockstr)
10205 (match-beginning 3) (goto-char (point-at-eol)))))
10206 (substring (org-match-string-no-properties 3) 1 -1)))
10208 (if (= (char-after (match-beginning 3)) ?\[)
10209 (setq key "TIMESTAMP_IA")
10210 (setq key "TIMESTAMP")))
10211 (when (or (equal key clockstr) (not (assoc key props)))
10212 (push (cons key string) props)))
10216 (when (memq which '(all standard))
10217 ;; Get the standard properties, like :PORP: ...
10218 (setq range (org-get-property-block beg end))
10220 (goto-char (car range))
10221 (while (re-search-forward
10222 (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
10224 (setq key (org-match-string-no-properties 1)
10225 value (org-trim (or (org-match-string-no-properties 2) "")))
10226 (unless (member key excluded)
10227 (push (cons key (or value "")) props)))))
10229 (push (cons "CLOCKSUM"
10230 (org-columns-number-to-string (/ (float clocksum) 60.)
10233 (unless (assoc "CATEGORY" props)
10234 (setq value (or (org-get-category)
10235 (progn (org-refresh-category-properties)
10236 (org-get-category))))
10237 (push (cons "CATEGORY" value) props))
10238 (append sum-props (nreverse props)))))))
10240 (defun org-entry-get (pom property &optional inherit)
10241 "Get value of PROPERTY for entry at point-or-marker POM.
10242 If INHERIT is non-nil and the entry does not have the property,
10243 then also check higher levels of the hierarchy.
10244 If INHERIT is the symbol `selective', use inheritance only if the setting
10245 in `org-use-property-inheritance' selects PROPERTY for inheritance.
10246 If the property is present but empty, the return value is the empty string.
10247 If the property is not present at all, nil is returned."
10248 (org-with-point-at pom
10249 (if (and inherit (if (eq inherit 'selective)
10250 (org-property-inherit-p property)
10252 (org-entry-get-with-inheritance property)
10253 (if (member property org-special-properties)
10254 ;; We need a special property. Use brute force, get all properties.
10255 (cdr (assoc property (org-entry-properties nil 'special)))
10256 (let ((range (org-get-property-block)))
10258 (goto-char (car range))
10260 (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)?")
10262 ;; Found the property, return it.
10264 (org-match-string-no-properties 1)
10267 (defun org-property-or-variable-value (var &optional inherit)
10268 "Check if there is a property fixing the value of VAR.
10269 If yes, return this value. If not, return the current value of the variable."
10270 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
10271 (if (and prop (stringp prop) (string-match "\\S-" prop))
10273 (symbol-value var))))
10275 (defun org-entry-delete (pom property)
10276 "Delete the property PROPERTY from entry at point-or-marker POM."
10277 (org-with-point-at pom
10278 (if (member property org-special-properties)
10279 nil ; cannot delete these properties.
10280 (let ((range (org-get-property-block)))
10282 (goto-char (car range))
10284 (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)")
10287 (delete-region (match-beginning 0) (1+ (point-at-eol)))
10291 ;; Multi-values properties are properties that contain multiple values
10292 ;; These values are assumed to be single words, separated by whitespace.
10293 (defun org-entry-add-to-multivalued-property (pom property value)
10294 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
10295 (let* ((old (org-entry-get pom property))
10296 (values (and old (org-split-string old "[ \t]"))))
10297 (setq value (org-entry-protect-space value))
10298 (unless (member value values)
10299 (setq values (cons value values))
10300 (org-entry-put pom property
10301 (mapconcat 'identity values " ")))))
10303 (defun org-entry-remove-from-multivalued-property (pom property value)
10304 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
10305 (let* ((old (org-entry-get pom property))
10306 (values (and old (org-split-string old "[ \t]"))))
10307 (setq value (org-entry-protect-space value))
10308 (when (member value values)
10309 (setq values (delete value values))
10310 (org-entry-put pom property
10311 (mapconcat 'identity values " ")))))
10313 (defun org-entry-member-in-multivalued-property (pom property value)
10314 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
10315 (let* ((old (org-entry-get pom property))
10316 (values (and old (org-split-string old "[ \t]"))))
10317 (setq value (org-entry-protect-space value))
10318 (member value values)))
10320 (defun org-entry-get-multivalued-property (pom property)
10321 "Return a list of values in a multivalued property."
10322 (let* ((value (org-entry-get pom property))
10323 (values (and value (org-split-string value "[ \t]"))))
10324 (mapcar 'org-entry-restore-space values)))
10326 (defun org-entry-put-multivalued-property (pom property &rest values)
10327 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
10328 VALUES should be a list of strings. Spaces will be protected."
10329 (org-entry-put pom property
10330 (mapconcat 'org-entry-protect-space values " "))
10331 (let* ((value (org-entry-get pom property))
10332 (values (and value (org-split-string value "[ \t]"))))
10333 (mapcar 'org-entry-restore-space values)))
10335 (defun org-entry-protect-space (s)
10336 "Protect spaces and newline in string S."
10337 (while (string-match " " s)
10338 (setq s (replace-match "%20" t t s)))
10339 (while (string-match "\n" s)
10340 (setq s (replace-match "%0A" t t s)))
10343 (defun org-entry-restore-space (s)
10344 "Restore spaces and newline in string S."
10345 (while (string-match "%20" s)
10346 (setq s (replace-match " " t t s)))
10347 (while (string-match "%0A" s)
10348 (setq s (replace-match "\n" t t s)))
10351 (defvar org-entry-property-inherited-from (make-marker)
10352 "Marker pointing to the entry from where a property was inherited.
10353 Each call to `org-entry-get-with-inheritance' will set this marker to the
10354 location of the entry where the inheritance search matched. If there was
10355 no match, the marker will point nowhere.
10356 Note that also `org-entry-get' calls this function, if the INHERIT flag
10359 (defun org-entry-get-with-inheritance (property)
10360 "Get entry property, and search higher levels if not present."
10361 (move-marker org-entry-property-inherited-from nil)
10368 (when (setq tmp (org-entry-get nil property))
10369 (org-back-to-heading t)
10370 (move-marker org-entry-property-inherited-from (point))
10372 (or (org-up-heading-safe) (throw 'ex nil)))))
10374 (cdr (assoc property org-file-properties))
10375 (cdr (assoc property org-global-properties))
10376 (cdr (assoc property org-global-properties-fixed))))))
10378 (defun org-entry-put (pom property value)
10379 "Set PROPERTY to VALUE for entry at point-or-marker POM."
10380 (org-with-point-at pom
10381 (org-back-to-heading t)
10382 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
10385 ((equal property "TODO")
10386 (when (and (stringp value) (string-match "\\S-" value)
10387 (not (member value org-todo-keywords-1)))
10388 (error "\"%s\" is not a valid TODO state" value))
10389 (if (or (not value)
10390 (not (string-match "\\S-" value)))
10391 (setq value 'none))
10393 (org-set-tags nil 'align))
10394 ((equal property "PRIORITY")
10395 (org-priority (if (and value (stringp value) (string-match "\\S-" value))
10396 (string-to-char value) ?\ ))
10397 (org-set-tags nil 'align))
10398 ((equal property "SCHEDULED")
10399 (if (re-search-forward org-scheduled-time-regexp end t)
10401 ((eq value 'earlier) (org-timestamp-change -1 'day))
10402 ((eq value 'later) (org-timestamp-change 1 'day))
10403 (t (call-interactively 'org-schedule)))
10404 (call-interactively 'org-schedule)))
10405 ((equal property "DEADLINE")
10406 (if (re-search-forward org-deadline-time-regexp end t)
10408 ((eq value 'earlier) (org-timestamp-change -1 'day))
10409 ((eq value 'later) (org-timestamp-change 1 'day))
10410 (t (call-interactively 'org-deadline)))
10411 (call-interactively 'org-deadline)))
10412 ((member property org-special-properties)
10413 (error "The %s property can not yet be set with `org-entry-put'"
10415 (t ; a non-special property
10416 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
10417 (setq range (org-get-property-block beg end 'force))
10418 (goto-char (car range))
10419 (if (re-search-forward
10420 (concat "^[ \t]*:" property ":\\(.*\\)") (cdr range) t)
10422 (delete-region (match-beginning 1) (match-end 1))
10423 (goto-char (match-beginning 1)))
10424 (goto-char (cdr range))
10427 (org-indent-line-function)
10428 (insert ":" property ":"))
10429 (and value (insert " " value))
10430 (org-indent-line-function)))))))
10432 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
10433 "Get all property keys in the current buffer.
10434 With INCLUDE-SPECIALS, also list the special properties that reflect things
10435 like tags and TODO state.
10436 With INCLUDE-DEFAULTS, also include properties that has special meaning
10437 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
10438 With INCLUDE-COLUMNS, also include property names given in COLUMN
10439 formats in the current buffer."
10440 (let (rtn range cfmt cols s p)
10444 (goto-char (point-min))
10445 (while (re-search-forward org-property-start-re nil t)
10446 (setq range (org-get-property-block))
10447 (goto-char (car range))
10448 (while (re-search-forward
10449 (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
10451 (add-to-list 'rtn (org-match-string-no-properties 1)))
10452 (outline-next-heading))))
10454 (when include-specials
10455 (setq rtn (append org-special-properties rtn)))
10457 (when include-defaults
10458 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
10460 (when include-columns
10464 (goto-char (point-min))
10465 (while (re-search-forward
10466 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
10468 (setq cfmt (match-string 2) s 0)
10469 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
10471 (setq s (match-end 0)
10472 p (match-string 1 cfmt))
10473 (unless (or (equal p "ITEM")
10474 (member p org-special-properties))
10475 (add-to-list 'rtn (match-string 1 cfmt))))))))
10477 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
10479 (defun org-property-values (key)
10480 "Return a list of all values of property KEY."
10484 (goto-char (point-min))
10485 (let ((re (concat "^[ \t]*:" key ":[ \t]*\\(\\S-.*\\)"))
10487 (while (re-search-forward re nil t)
10488 (add-to-list 'values (org-trim (match-string 1))))
10489 (delete "" values)))))
10491 (defun org-insert-property-drawer ()
10492 "Insert a property drawer into the current entry."
10494 (org-back-to-heading t)
10495 (looking-at outline-regexp)
10496 (let ((indent (- (match-end 0)(match-beginning 0)))
10498 (re (concat "^[ \t]*" org-keyword-time-regexp))
10500 (outline-next-heading)
10503 (while (re-search-forward re end t))
10504 (setq hiddenp (org-invisible-p))
10506 (and (equal (char-after) ?\n) (forward-char 1))
10507 (while (looking-at "^[ \t]*\\(:CLOCK:\\|CLOCK\\|:END:\\)")
10508 (beginning-of-line 2))
10509 (org-skip-over-state-notes)
10510 (skip-chars-backward " \t\n\r")
10511 (if (eq (char-before) ?*) (forward-char 1))
10512 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
10513 (beginning-of-line 0)
10514 (org-indent-to-column indent)
10515 (beginning-of-line 2)
10516 (org-indent-to-column indent)
10517 (beginning-of-line 0)
10520 (org-back-to-heading t)
10522 (org-flag-drawer t))))
10524 (defun org-set-property (property value)
10525 "In the current entry, set PROPERTY to VALUE.
10526 When called interactively, this will prompt for a property name, offering
10527 completion on existing and default properties. And then it will prompt
10528 for a value, offering completion either on allowed values (via an inherited
10529 xxx_ALL property) or on existing values in other instances of this property
10530 in the current file."
10532 (let* ((completion-ignore-case t)
10533 (keys (org-buffer-property-keys nil t t))
10534 (prop0 (org-ido-completing-read "Property: " (mapcar 'list keys)))
10535 (prop (if (member prop0 keys)
10537 (or (cdr (assoc (downcase prop0)
10538 (mapcar (lambda (x) (cons (downcase x) x))
10541 (cur (org-entry-get nil prop))
10542 (allowed (org-property-get-allowed-values nil prop 'table))
10543 (existing (mapcar 'list (org-property-values prop)))
10545 (org-completing-read "Value: " allowed nil 'req-match)
10546 (org-completing-read
10547 (concat "Value" (if (and cur (string-match "\\S-" cur))
10548 (concat "[" cur "]") "")
10550 existing nil nil "" nil cur))))
10551 (list prop (if (equal val "") cur val))))
10552 (unless (equal (org-entry-get nil property) value)
10553 (org-entry-put nil property value)))
10555 (defun org-delete-property (property)
10556 "In the current entry, delete PROPERTY."
10558 (let* ((completion-ignore-case t)
10559 (prop (org-ido-completing-read
10560 "Property: " (org-entry-properties nil 'standard))))
10562 (message "Property %s %s" property
10563 (if (org-entry-delete nil property)
10565 "was not present in the entry")))
10567 (defun org-delete-property-globally (property)
10568 "Remove PROPERTY globally, from all entries."
10570 (let* ((completion-ignore-case t)
10571 (prop (org-ido-completing-read
10572 "Globally remove property: "
10573 (mapcar 'list (org-buffer-property-keys)))))
10578 (goto-char (point-min))
10580 (while (re-search-forward
10581 (concat "^[ \t]*:" (regexp-quote property) ":.*\n?")
10583 (setq cnt (1+ cnt))
10584 (replace-match ""))
10585 (message "Property \"%s\" removed from %d entries" property cnt)))))
10587 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
10589 (defun org-compute-property-at-point ()
10590 "Compute the property at point.
10591 This looks for an enclosing column format, extracts the operator and
10592 then applies it to the property in the column format's scope."
10594 (unless (org-at-property-p)
10595 (error "Not at a property"))
10596 (let ((prop (org-match-string-no-properties 2)))
10597 (org-columns-get-format-and-top-level)
10598 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
10599 (error "No operator defined for property %s" prop))
10600 (org-columns-compute prop)))
10602 (defun org-property-get-allowed-values (pom property &optional table)
10603 "Get allowed values for the property PROPERTY.
10604 When TABLE is non-nil, return an alist that can directly be used for
10608 ((equal property "TODO")
10609 (setq vals (org-with-point-at pom
10610 (append org-todo-keywords-1 '("")))))
10611 ((equal property "PRIORITY")
10612 (let ((n org-lowest-priority))
10613 (while (>= n org-highest-priority)
10614 (push (char-to-string n) vals)
10616 ((member property org-special-properties))
10618 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
10620 (when (and vals (string-match "\\S-" vals))
10621 (setq vals (car (read-from-string (concat "(" vals ")"))))
10622 (setq vals (mapcar (lambda (x)
10623 (cond ((stringp x) x)
10624 ((numberp x) (number-to-string x))
10625 ((symbolp x) (symbol-name x))
10628 (if table (mapcar 'list vals) vals)))
10630 (defun org-property-previous-allowed-value (&optional previous)
10631 "Switch to the next allowed value for this property."
10633 (org-property-next-allowed-value t))
10635 (defun org-property-next-allowed-value (&optional previous)
10636 "Switch to the next allowed value for this property."
10638 (unless (org-at-property-p)
10639 (error "Not at a property"))
10640 (let* ((key (match-string 2))
10641 (value (match-string 3))
10642 (allowed (or (org-property-get-allowed-values (point) key)
10643 (and (member value '("[ ]" "[-]" "[X]"))
10647 (error "Allowed values for this property have not been defined"))
10648 (if previous (setq allowed (reverse allowed)))
10649 (if (member value allowed)
10650 (setq nval (car (cdr (member value allowed)))))
10651 (setq nval (or nval (car allowed)))
10652 (if (equal nval value)
10653 (error "Only one allowed value for this property"))
10654 (org-at-property-p)
10655 (replace-match (concat " :" key ": " nval) t t)
10656 (org-indent-line-function)
10657 (beginning-of-line 1)
10658 (skip-chars-forward " \t")))
10660 (defun org-find-entry-with-id (ident)
10661 "Locate the entry that contains the ID property with exact value IDENT.
10662 IDENT can be a string, a symbol or a number, this function will search for
10663 the string representation of it.
10664 Return the position where this entry starts, or nil if there is no such entry."
10665 (interactive "sID: ")
10667 ((stringp ident) ident)
10668 ((symbol-name ident) (symbol-name ident))
10669 ((numberp ident) (number-to-string ident))
10670 (t (error "IDENT %s must be a string, symbol or number" ident))))
10671 (case-fold-search nil))
10675 (goto-char (point-min))
10676 (when (re-search-forward
10677 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
10679 (org-back-to-heading)
10684 (defvar org-last-changed-timestamp nil)
10685 (defvar org-last-inserted-timestamp nil
10686 "The last time stamp inserted with `org-insert-time-stamp'.")
10687 (defvar org-time-was-given) ; dynamically scoped parameter
10688 (defvar org-end-time-was-given) ; dynamically scoped parameter
10689 (defvar org-ts-what) ; dynamically scoped parameter
10691 (defun org-time-stamp (arg &optional inactive)
10692 "Prompt for a date/time and insert a time stamp.
10693 If the user specifies a time like HH:MM, or if this command is called
10694 with a prefix argument, the time stamp will contain date and time.
10695 Otherwise, only the date will be included. All parts of a date not
10696 specified by the user will be filled in from the current date/time.
10697 So if you press just return without typing anything, the time stamp
10698 will represent the current date/time. If there is already a timestamp
10699 at the cursor, it will be modified."
10703 ;; Default time is either today, or, when entering a range,
10704 ;; the range start.
10705 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
10707 (re-search-backward
10708 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
10709 (- (point) 20) t)))
10710 (apply 'encode-time (org-parse-time-string (match-string 1)))
10712 (default-input (and ts (org-get-compact-tod ts)))
10713 org-time-was-given org-end-time-was-given time)
10715 ((and (org-at-timestamp-p t)
10716 (memq last-command '(org-time-stamp org-time-stamp-inactive))
10717 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
10719 (setq time (let ((this-command this-command))
10720 (org-read-date arg 'totime nil nil
10721 default-time default-input)))
10722 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
10723 ((org-at-timestamp-p t)
10724 (setq time (let ((this-command this-command))
10725 (org-read-date arg 'totime nil nil default-time default-input)))
10726 (when (org-at-timestamp-p t) ; just to get the match data
10727 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
10729 (setq org-last-changed-timestamp
10730 (org-insert-time-stamp
10731 time (or org-time-was-given arg)
10732 inactive nil nil (list org-end-time-was-given))))
10733 (message "Timestamp updated"))
10735 (setq time (let ((this-command this-command))
10736 (org-read-date arg 'totime nil nil default-time default-input)))
10737 (org-insert-time-stamp time (or org-time-was-given arg) inactive
10738 nil nil (list org-end-time-was-given))))))
10740 ;; FIXME: can we use this for something else, like computing time differences?
10741 (defun org-get-compact-tod (s)
10742 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
10743 (let* ((t1 (match-string 1 s))
10744 (h1 (string-to-number (match-string 2 s)))
10745 (m1 (string-to-number (match-string 3 s)))
10746 (t2 (and (match-end 4) (match-string 5 s)))
10747 (h2 (and t2 (string-to-number (match-string 6 s))))
10748 (m2 (and t2 (string-to-number (match-string 7 s))))
10752 (setq dh (- h2 h1) dm (- m2 m1))
10753 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
10754 (concat t1 "+" (number-to-string dh)
10755 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
10757 (defun org-time-stamp-inactive (&optional arg)
10758 "Insert an inactive time stamp.
10759 An inactive time stamp is enclosed in square brackets instead of angle
10760 brackets. It is inactive in the sense that it does not trigger agenda entries,
10761 does not link to the calendar and cannot be changed with the S-cursor keys.
10762 So these are more for recording a certain time/date."
10764 (org-time-stamp arg 'inactive))
10766 (defvar org-date-ovl (org-make-overlay 1 1))
10767 (org-overlay-put org-date-ovl 'face 'org-warning)
10768 (org-detach-overlay org-date-ovl)
10770 (defvar org-ans1) ; dynamically scoped parameter
10771 (defvar org-ans2) ; dynamically scoped parameter
10773 (defvar org-plain-time-of-day-regexp) ; defined below
10775 (defvar org-overriding-default-time nil) ; dynamically scoped
10776 (defvar org-read-date-overlay nil)
10777 (defvar org-dcst nil) ; dynamically scoped
10779 (defun org-read-date (&optional with-time to-time from-string prompt
10780 default-time default-input)
10781 "Read a date, possibly a time, and make things smooth for the user.
10782 The prompt will suggest to enter an ISO date, but you can also enter anything
10783 which will at least partially be understood by `parse-time-string'.
10784 Unrecognized parts of the date will default to the current day, month, year,
10785 hour and minute. If this command is called to replace a timestamp at point,
10786 of to enter the second timestamp of a range, the default time is taken from the
10787 existing stamp. For example,
10788 3-2-5 --> 2003-02-05
10789 feb 15 --> currentyear-02-15
10790 sep 12 9 --> 2009-09-12
10791 12:45 --> today 12:45
10792 22 sept 0:34 --> currentyear-09-22 0:34
10793 12 --> currentyear-currentmonth-12
10794 Fri --> nearest Friday (today or later)
10797 Furthermore you can specify a relative date by giving, as the *first* thing
10798 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
10799 change in days weeks, months, years.
10800 With a single plus or minus, the date is relative to today. With a double
10801 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
10802 +4d --> four days from today
10803 +4 --> same as above
10804 +2w --> two weeks from today
10805 ++5 --> five days from default date
10807 The function understands only English month and weekday abbreviations,
10808 but this can be configured with the variables `parse-time-months' and
10809 `parse-time-weekdays'.
10811 While prompting, a calendar is popped up - you can also select the
10812 date with the mouse (button 1). The calendar shows a period of three
10813 months. To scroll it to other months, use the keys `>' and `<'.
10814 If you don't like the calendar, turn it off with
10815 \(setq org-read-date-popup-calendar nil)
10817 With optional argument TO-TIME, the date will immediately be converted
10818 to an internal time.
10819 With an optional argument WITH-TIME, the prompt will suggest to also
10820 insert a time. Note that when WITH-TIME is not set, you can still
10821 enter a time, and this function will inform the calling routine about
10822 this change. The calling routine may then choose to change the format
10823 used to insert the time stamp into the buffer to include the time.
10824 With optional argument FROM-STRING, read from this string instead from
10825 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
10826 the time/date that is used for everything that is not specified by the
10828 (require 'parse-time)
10829 (let* ((org-time-stamp-rounding-minutes
10830 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
10831 (org-dcst org-display-custom-times)
10832 (ct (org-current-time))
10833 (def (or org-overriding-default-time default-time ct))
10834 (defdecode (decode-time def))
10836 (when (< (nth 2 defdecode) org-extend-today-until)
10837 (setcar (nthcdr 2 defdecode) -1)
10838 (setcar (nthcdr 1 defdecode) 59)
10839 (setq def (apply 'encode-time defdecode)
10840 defdecode (decode-time def)))))
10841 (calendar-move-hook nil)
10842 (calendar-view-diary-initially-flag nil)
10843 (view-diary-entries-initially nil)
10844 (calendar-view-holidays-initially-flag nil)
10845 (view-calendar-holidays-initially nil)
10846 (timestr (format-time-string
10847 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
10848 (prompt (concat (if prompt (concat prompt " ") "")
10849 (format "Date+time [%s]: " timestr)))
10850 ans (org-ans0 "") org-ans1 org-ans2 final)
10853 (from-string (setq ans from-string))
10854 (org-read-date-popup-calendar
10856 (save-window-excursion
10858 (calendar-forward-day (- (time-to-days def)
10859 (calendar-absolute-from-gregorian
10860 (calendar-current-date))))
10861 (org-eval-in-calendar nil t)
10862 (let* ((old-map (current-local-map))
10863 (map (copy-keymap calendar-mode-map))
10864 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
10865 (org-defkey map (kbd "RET") 'org-calendar-select)
10866 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
10867 'org-calendar-select-mouse)
10868 (org-defkey map (if (featurep 'xemacs) [button2] [mouse-2
])
10869 'org-calendar-select-mouse
)
10870 (org-defkey minibuffer-local-map
[(meta shift left
)]
10871 (lambda () (interactive)
10872 (org-eval-in-calendar '(calendar-backward-month 1))))
10873 (org-defkey minibuffer-local-map
[(meta shift right
)]
10874 (lambda () (interactive)
10875 (org-eval-in-calendar '(calendar-forward-month 1))))
10876 (org-defkey minibuffer-local-map
[(meta shift up
)]
10877 (lambda () (interactive)
10878 (org-eval-in-calendar '(calendar-backward-year 1))))
10879 (org-defkey minibuffer-local-map
[(meta shift down
)]
10880 (lambda () (interactive)
10881 (org-eval-in-calendar '(calendar-forward-year 1))))
10882 (org-defkey minibuffer-local-map
[(shift up
)]
10883 (lambda () (interactive)
10884 (org-eval-in-calendar '(calendar-backward-week 1))))
10885 (org-defkey minibuffer-local-map
[(shift down
)]
10886 (lambda () (interactive)
10887 (org-eval-in-calendar '(calendar-forward-week 1))))
10888 (org-defkey minibuffer-local-map
[(shift left
)]
10889 (lambda () (interactive)
10890 (org-eval-in-calendar '(calendar-backward-day 1))))
10891 (org-defkey minibuffer-local-map
[(shift right
)]
10892 (lambda () (interactive)
10893 (org-eval-in-calendar '(calendar-forward-day 1))))
10894 (org-defkey minibuffer-local-map
">"
10895 (lambda () (interactive)
10896 (org-eval-in-calendar '(scroll-calendar-left 1))))
10897 (org-defkey minibuffer-local-map
"<"
10898 (lambda () (interactive)
10899 (org-eval-in-calendar '(scroll-calendar-right 1))))
10902 (use-local-map map
)
10903 (add-hook 'post-command-hook
'org-read-date-display
)
10904 (setq org-ans0
(read-string prompt default-input nil nil
))
10905 ;; org-ans0: from prompt
10906 ;; org-ans1: from mouse click
10907 ;; org-ans2: from calendar motion
10908 (setq ans
(concat org-ans0
" " (or org-ans1 org-ans2
))))
10909 (remove-hook 'post-command-hook
'org-read-date-display
)
10910 (use-local-map old-map
)
10911 (when org-read-date-overlay
10912 (org-delete-overlay org-read-date-overlay
)
10913 (setq org-read-date-overlay nil
)))))))
10915 (t ; Naked prompt only
10917 (setq ans
(read-string prompt default-input nil timestr
))
10918 (when org-read-date-overlay
10919 (org-delete-overlay org-read-date-overlay
)
10920 (setq org-read-date-overlay nil
)))))
10922 (setq final
(org-read-date-analyze ans def defdecode
))
10925 (apply 'encode-time final
)
10926 (if (and (boundp 'org-time-was-given
) org-time-was-given
)
10927 (format "%04d-%02d-%02d %02d:%02d"
10928 (nth 5 final
) (nth 4 final
) (nth 3 final
)
10929 (nth 2 final
) (nth 1 final
))
10930 (format "%04d-%02d-%02d" (nth 5 final
) (nth 4 final
) (nth 3 final
))))))
10934 (defun org-read-date-display ()
10935 "Display the current date prompt interpretation in the minibuffer."
10936 (when org-read-date-display-live
10937 (when org-read-date-overlay
10938 (org-delete-overlay org-read-date-overlay
))
10941 (while (not (equal (buffer-substring
10942 (max (point-min) (- (point) 4)) (point))
10946 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
10947 " " (or org-ans1 org-ans2
)))
10948 (org-end-time-was-given nil
)
10949 (f (org-read-date-analyze ans def defdecode
))
10951 org-time-stamp-custom-formats
10952 org-time-stamp-formats
))
10953 (fmt (if (or with-time
10954 (and (boundp 'org-time-was-given
) org-time-was-given
))
10957 (txt (concat "=> " (format-time-string fmt
(apply 'encode-time f
)))))
10958 (when (and org-end-time-was-given
10959 (string-match org-plain-time-of-day-regexp txt
))
10960 (setq txt
(concat (substring txt
0 (match-end 0)) "-"
10961 org-end-time-was-given
10962 (substring txt
(match-end 0)))))
10963 (setq org-read-date-overlay
10964 (org-make-overlay (1- (point-at-eol)) (point-at-eol)))
10965 (org-overlay-display org-read-date-overlay txt
'secondary-selection
))))
10967 (defun org-read-date-analyze (ans def defdecode
)
10968 "Analyse the combined answer of the date prompt."
10969 ;; FIXME: cleanup and comment
10970 (let (delta deltan deltaw deltadef year month day
10971 hour minute second wday pm h2 m2 tl wday1
10972 iso-year iso-weekday iso-week iso-year iso-date
)
10974 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans
)
10977 (when (setq delta
(org-read-date-get-relative ans
(current-time) def
))
10978 (setq ans
(replace-match "" t t ans
)
10980 deltaw
(nth 1 delta
)
10981 deltadef
(nth 2 delta
)))
10983 ;; Check if there is an iso week date in there
10984 ;; If yes, sore the info and postpone interpreting it until the rest
10985 ;; of the parsing is done
10986 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans
)
10987 (setq iso-year
(if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans
))))
10988 iso-weekday
(if (match-end 3) (string-to-number (match-string 3 ans
)))
10989 iso-week
(string-to-number (match-string 2 ans
)))
10990 (setq ans
(replace-match "" t t ans
)))
10992 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
10993 (when (string-match
10994 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans
)
10995 (setq year
(if (match-end 2)
10996 (string-to-number (match-string 2 ans
))
10997 (string-to-number (format-time-string "%Y")))
10998 month
(string-to-number (match-string 3 ans
))
10999 day
(string-to-number (match-string 4 ans
)))
11000 (if (< year
100) (setq year
(+ 2000 year
)))
11001 (setq ans
(replace-match (format "%04d-%02d-%02d\\5" year month day
)
11003 ;; Help matching am/pm times, because `parse-time-string' does not do that.
11004 ;; If there is a time with am/pm, and *no* time without it, we convert
11005 ;; so that matching will be successful.
11006 (loop for i from
1 to
2 do
; twice, for end time as well
11007 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans
))
11008 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans
))
11009 (setq hour
(string-to-number (match-string 1 ans
))
11010 minute
(if (match-end 3)
11011 (string-to-number (match-string 3 ans
))
11014 (string-to-char (downcase (match-string 4 ans
)))))
11015 (if (and (= hour
12) (not pm
))
11017 (if (and pm
(< hour
12)) (setq hour
(+ 12 hour
))))
11018 (setq ans
(replace-match (format "%02d:%02d" hour minute
)
11021 ;; Check if a time range is given as a duration
11022 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans
)
11023 (setq hour
(string-to-number (match-string 1 ans
))
11024 h2
(+ hour
(string-to-number (match-string 3 ans
)))
11025 minute
(string-to-number (match-string 2 ans
))
11026 m2
(+ minute
(if (match-end 5) (string-to-number
11027 (match-string 5 ans
))0)))
11028 (if (>= m2
60) (setq h2
(1+ h2
) m2
(- m2
60)))
11029 (setq ans
(replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2
)
11032 ;; Check if there is a time range
11033 (when (boundp 'org-end-time-was-given
)
11034 (setq org-time-was-given nil
)
11035 (when (and (string-match org-plain-time-of-day-regexp ans
)
11037 (setq org-end-time-was-given
(match-string 8 ans
))
11038 (setq ans
(concat (substring ans
0 (match-beginning 7))
11039 (substring ans
(match-end 7))))))
11041 (setq tl
(parse-time-string ans
)
11042 day
(or (nth 3 tl
) (nth 3 defdecode
))
11043 month
(or (nth 4 tl
)
11044 (if (and org-read-date-prefer-future
11045 (nth 3 tl
) (< (nth 3 tl
) (nth 3 defdecode
)))
11046 (1+ (nth 4 defdecode
))
11047 (nth 4 defdecode
)))
11048 year
(or (nth 5 tl
)
11049 (if (and org-read-date-prefer-future
11050 (nth 4 tl
) (< (nth 4 tl
) (nth 4 defdecode
)))
11051 (1+ (nth 5 defdecode
))
11052 (nth 5 defdecode
)))
11053 hour
(or (nth 2 tl
) (nth 2 defdecode
))
11054 minute
(or (nth 1 tl
) (nth 1 defdecode
))
11055 second
(or (nth 0 tl
) 0)
11058 ;; Special date definitions below
11061 ;; There was an iso week
11062 (setq year
(or iso-year year
)
11063 day
(or iso-weekday wday
1)
11064 wday nil
; to make sure that the trigger below does not match
11065 iso-date
(calendar-gregorian-from-absolute
11066 (calendar-absolute-from-iso
11067 (list iso-week day year
))))
11068 ; FIXME: Should we also push ISO weeks into the future?
11069 ; (when (and org-read-date-prefer-future
11071 ; (< (calendar-absolute-from-gregorian iso-date)
11072 ; (time-to-days (current-time))))
11073 ; (setq year (1+ year)
11074 ; iso-date (calendar-gregorian-from-absolute
11075 ; (calendar-absolute-from-iso
11076 ; (list iso-week day year)))))
11077 (setq month
(car iso-date
)
11078 year
(nth 2 iso-date
)
11079 day
(nth 1 iso-date
)))
11082 (let ((now (decode-time (current-time))))
11083 (setq day
(nth 3 now
) month
(nth 4 now
) year
(nth 5 now
))))
11084 (cond ((member deltaw
'("d" "")) (setq day
(+ day deltan
)))
11085 ((equal deltaw
"w") (setq day
(+ day
(* 7 deltan
))))
11086 ((equal deltaw
"m") (setq month
(+ month deltan
)))
11087 ((equal deltaw
"y") (setq year
(+ year deltan
)))))
11088 ((and wday
(not (nth 3 tl
)))
11089 ;; Weekday was given, but no day, so pick that day in the week
11090 ;; on or after the derived date.
11091 (setq wday1
(nth 6 (decode-time (encode-time 0 0 0 day month year
))))
11092 (unless (equal wday wday1
)
11093 (setq day
(+ day
(%
(- wday wday1 -
7) 7))))))
11094 (if (and (boundp 'org-time-was-given
)
11096 (setq org-time-was-given t
))
11097 (if (< year
100) (setq year
(+ 2000 year
)))
11098 (if (< year
1970) (setq year
(nth 5 defdecode
))) ; not representable
11099 (list second minute hour day month year
)))
11101 (defvar parse-time-weekdays
)
11103 (defun org-read-date-get-relative (s today default
)
11104 "Check string S for special relative date string.
11105 TODAY and DEFAULT are internal times, for today and for a default.
11106 Return shift list (N what def-flag)
11107 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
11108 N is the number of WHATs to shift.
11109 DEF-FLAG is t when a double ++ or -- indicates shift relative to
11110 the DEFAULT date rather than TODAY."
11114 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
11116 "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays
"\\|") "\\)\\)?"
11117 "\\([ \t]\\|$\\)") s
)
11118 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
11119 (let* ((dir (if (> (match-end 1) (match-beginning 1))
11120 (string-to-char (substring (match-string 1 s
) -
1))
11122 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
11123 (n (if (match-end 2) (string-to-number (match-string 2 s
)) 1))
11124 (what (if (match-end 3) (match-string 3 s
) "d"))
11125 (wday1 (cdr (assoc (downcase what
) parse-time-weekdays
)))
11126 (date (if rel default today
))
11127 (wday (nth 6 (decode-time date
)))
11131 (setq delta
(mod (+ 7 (- wday1 wday
)) 7))
11132 (if (= dir ?-
) (setq delta
(- delta
7)))
11133 (if (> n
1) (setq delta
(+ delta
(* (1- n
) (if (= dir ?-
) -
7 7)))))
11134 (list delta
"d" rel
))
11135 (list (* n
(if (= dir ?-
) -
1 1)) what rel
)))))
11137 (defun org-eval-in-calendar (form &optional keepdate
)
11138 "Eval FORM in the calendar window and return to current window.
11139 Also, store the cursor date in variable org-ans2."
11140 (let ((sw (selected-window)))
11141 (select-window (get-buffer-window "*Calendar*"))
11143 (when (and (not keepdate
) (calendar-cursor-to-date))
11144 (let* ((date (calendar-cursor-to-date))
11145 (time (encode-time 0 0 0 (nth 1 date
) (nth 0 date
) (nth 2 date
))))
11146 (setq org-ans2
(format-time-string "%Y-%m-%d" time
))))
11147 (org-move-overlay org-date-ovl
(1- (point)) (1+ (point)) (current-buffer))
11148 (select-window sw
)))
11150 (defun org-calendar-select ()
11151 "Return to `org-read-date' with the date currently selected.
11152 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
11154 (when (calendar-cursor-to-date)
11155 (let* ((date (calendar-cursor-to-date))
11156 (time (encode-time 0 0 0 (nth 1 date
) (nth 0 date
) (nth 2 date
))))
11157 (setq org-ans1
(format-time-string "%Y-%m-%d" time
)))
11158 (if (active-minibuffer-window) (exit-minibuffer))))
11160 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra
)
11161 "Insert a date stamp for the date given by the internal TIME.
11162 WITH-HM means, use the stamp format that includes the time of the day.
11163 INACTIVE means use square brackets instead of angular ones, so that the
11164 stamp will not contribute to the agenda.
11165 PRE and POST are optional strings to be inserted before and after the
11167 The command returns the inserted time stamp."
11168 (let ((fmt (funcall (if with-hm
'cdr
'car
) org-time-stamp-formats
))
11170 (if inactive
(setq fmt
(concat "[" (substring fmt
1 -
1) "]")))
11171 (insert-before-markers (or pre
""))
11172 (insert-before-markers (setq stamp
(format-time-string fmt time
)))
11173 (when (listp extra
)
11174 (setq extra
(car extra
))
11175 (if (and (stringp extra
)
11176 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra
))
11177 (setq extra
(format "-%02d:%02d"
11178 (string-to-number (match-string 1 extra
))
11179 (string-to-number (match-string 2 extra
))))
11183 (insert-before-markers extra
)
11185 (insert-before-markers (or post
""))
11186 (setq org-last-inserted-timestamp stamp
)))
11188 (defun org-toggle-time-stamp-overlays ()
11189 "Toggle the use of custom time stamp formats."
11191 (setq org-display-custom-times
(not org-display-custom-times
))
11192 (unless org-display-custom-times
11193 (let ((p (point-min)) (bmp (buffer-modified-p)))
11194 (while (setq p
(next-single-property-change p
'display
))
11195 (if (and (get-text-property p
'display
)
11196 (eq (get-text-property p
'face
) 'org-date
))
11197 (remove-text-properties
11198 p
(setq p
(next-single-property-change p
'display
))
11200 (set-buffer-modified-p bmp
)))
11201 (if (featurep 'xemacs
)
11202 (remove-text-properties (point-min) (point-max) '(end-glyph t
)))
11203 (org-restart-font-lock)
11204 (setq org-table-may-need-update t
)
11205 (if org-display-custom-times
11206 (message "Time stamps are overlayed with custom format")
11207 (message "Time stamp overlays removed")))
11209 (defun org-display-custom-time (beg end
)
11210 "Overlay modified time stamp format over timestamp between BEG and END."
11211 (let* ((ts (buffer-substring beg end
))
11212 t1 w1 with-hm tf time str w2
(off 0))
11214 (setq t1
(org-parse-time-string ts t
))
11215 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\)?\\'" ts
)
11216 (setq off
(- (match-end 0) (match-beginning 0)))))
11217 (setq end
(- end off
))
11218 (setq w1
(- end beg
)
11219 with-hm
(and (nth 1 t1
) (nth 2 t1
))
11220 tf
(funcall (if with-hm
'cdr
'car
) org-time-stamp-custom-formats
)
11221 time
(org-fix-decoded-time t1
)
11223 (format-time-string
11224 (substring tf
1 -
1) (apply 'encode-time time
))
11225 nil
'mouse-face
'highlight
)
11227 (if (not (= w2 w1
))
11228 (add-text-properties (1+ beg
) (+ 2 beg
)
11229 (list 'org-dwidth t
'org-dwidth-n
(- w1 w2
))))
11230 (if (featurep 'xemacs
)
11232 (put-text-property beg end
'invisible t
)
11233 (put-text-property beg end
'end-glyph
(make-glyph str
)))
11234 (put-text-property beg end
'display str
))))
11236 (defun org-translate-time (string)
11237 "Translate all timestamps in STRING to custom format.
11238 But do this only if the variable `org-display-custom-times' is set."
11239 (when org-display-custom-times
11242 (re org-ts-regexp-both
)
11243 t1 with-hm inactive tf time str beg end
)
11244 (while (setq start
(string-match re string start
))
11245 (setq beg
(match-beginning 0)
11247 t1
(save-match-data
11248 (org-parse-time-string (substring string beg end
) t
))
11249 with-hm
(and (nth 1 t1
) (nth 2 t1
))
11250 inactive
(equal (substring string beg
(1+ beg
)) "[")
11251 tf
(funcall (if with-hm
'cdr
'car
)
11252 org-time-stamp-custom-formats
)
11253 time
(org-fix-decoded-time t1
)
11254 str
(format-time-string
11256 (if inactive
"[" "<") (substring tf
1 -
1)
11257 (if inactive
"]" ">"))
11258 (apply 'encode-time time
))
11259 string
(replace-match str t t string
)
11260 start
(+ start
(length str
)))))))
11263 (defun org-fix-decoded-time (time)
11264 "Set 0 instead of nil for the first 6 elements of time.
11265 Don't touch the rest."
11267 (mapcar (lambda (x) (if (< (setq n
(1+ n
)) 7) (or x
0) x
)) time
)))
11269 (defun org-days-to-time (timestamp-string)
11270 "Difference between TIMESTAMP-STRING and now in days."
11271 (- (time-to-days (org-time-string-to-time timestamp-string
))
11272 (time-to-days (current-time))))
11274 (defun org-deadline-close (timestamp-string &optional ndays
)
11275 "Is the time in TIMESTAMP-STRING close to the current date?"
11276 (setq ndays
(or ndays
(org-get-wdays timestamp-string
)))
11277 (and (< (org-days-to-time timestamp-string
) ndays
)
11278 (not (org-entry-is-done-p))))
11280 (defun org-get-wdays (ts)
11281 "Get the deadline lead time appropriate for timestring TS."
11283 ((<= org-deadline-warning-days
0)
11284 ;; 0 or negative, enforce this value no matter what
11285 (- org-deadline-warning-days
))
11286 ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\)" ts
)
11287 ;; lead time is specified.
11288 (floor (* (string-to-number (match-string 1 ts
))
11289 (cdr (assoc (match-string 2 ts
)
11290 '(("d" .
1) ("w" .
7)
11291 ("m" .
30.4) ("y" .
365.25)))))))
11292 ;; go for the default.
11293 (t org-deadline-warning-days
)))
11295 (defun org-calendar-select-mouse (ev)
11296 "Return to `org-read-date' with the date currently selected.
11297 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
11299 (mouse-set-point ev
)
11300 (when (calendar-cursor-to-date)
11301 (let* ((date (calendar-cursor-to-date))
11302 (time (encode-time 0 0 0 (nth 1 date
) (nth 0 date
) (nth 2 date
))))
11303 (setq org-ans1
(format-time-string "%Y-%m-%d" time
)))
11304 (if (active-minibuffer-window) (exit-minibuffer))))
11306 (defun org-check-deadlines (ndays)
11307 "Check if there are any deadlines due or past due.
11308 A deadline is considered due if it happens within `org-deadline-warning-days'
11309 days from today's date. If the deadline appears in an entry marked DONE,
11310 it is not shown. The prefix arg NDAYS can be used to test that many
11311 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
11313 (let* ((org-warn-days
11315 ((equal ndays
'(4)) 100000)
11316 (ndays (prefix-numeric-value ndays
))
11317 (t (abs org-deadline-warning-days
))))
11318 (case-fold-search nil
)
11319 (regexp (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>"))
11321 (lambda () (org-deadline-close (match-string 1) org-warn-days
))))
11323 (message "%d deadlines past-due or due within %d days"
11324 (org-occur regexp nil callback
)
11327 (defun org-check-before-date (date)
11328 "Check if there are deadlines or scheduled entries before DATE."
11329 (interactive (list (org-read-date)))
11330 (let ((case-fold-search nil
)
11331 (regexp (concat "\\<\\(" org-deadline-string
11332 "\\|" org-scheduled-string
11333 "\\) *<\\([^>]+\\)>"))
11335 (lambda () (time-less-p
11336 (org-time-string-to-time (match-string 2))
11337 (org-time-string-to-time date
)))))
11338 (message "%d entries before %s"
11339 (org-occur regexp nil callback
) date
)))
11341 (defun org-evaluate-time-range (&optional to-buffer
)
11342 "Evaluate a time range by computing the difference between start and end.
11343 Normally the result is just printed in the echo area, but with prefix arg
11344 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
11345 If the time range is actually in a table, the result is inserted into the
11347 For time difference computation, a year is assumed to be exactly 365
11348 days in order to avoid rounding problems."
11351 (org-clock-update-time-maybe)
11353 (unless (org-at-date-range-p t
)
11354 (goto-char (point-at-bol))
11355 (re-search-forward org-tr-regexp-both
(point-at-eol) t
))
11356 (if (not (org-at-date-range-p t
))
11357 (error "Not at a time-stamp range, and none found in current line")))
11358 (let* ((ts1 (match-string 1))
11359 (ts2 (match-string 2))
11360 (havetime (or (> (length ts1
) 15) (> (length ts2
) 15)))
11361 (match-end (match-end 0))
11362 (time1 (org-time-string-to-time ts1
))
11363 (time2 (org-time-string-to-time ts2
))
11364 (t1 (time-to-seconds time1
))
11365 (t2 (time-to-seconds time2
))
11366 (diff (abs (- t2 t1
)))
11367 (negative (< (- t2 t1
) 0))
11368 ;; (ys (floor (* 365 24 60 60)))
11371 (fy "%dy %dd %02d:%02d")
11373 (fd "%dd %02d:%02d")
11378 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
11380 d
(floor (/ diff ds
)) diff
(mod diff ds
)
11381 h
(floor (/ diff hs
)) diff
(mod diff hs
)
11382 m
(floor (/ diff
60)))
11383 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
11385 d
(floor (+ (/ diff ds
) 0.5))
11387 (if (not to-buffer
)
11388 (message "%s" (org-make-tdiff-string y d h m
))
11389 (if (org-at-table-p)
11391 (goto-char match-end
)
11393 (and (looking-at " *|") (goto-char (match-end 0))))
11394 (goto-char match-end
))
11396 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
11397 (replace-match ""))
11398 (if negative
(insert " -"))
11399 (if (> y
0) (insert " " (format (if havetime fy fy1
) y d h m
))
11400 (if (> d
0) (insert " " (format (if havetime fd fd1
) d h m
))
11401 (insert " " (format fh h m
))))
11402 (if align
(org-table-align))
11403 (message "Time difference inserted")))))
11405 (defun org-make-tdiff-string (y d h m
)
11408 (if (> y
0) (setq fmt
(concat fmt
"%d year" (if (> y
1) "s" "") " ")
11410 (if (> d
0) (setq fmt
(concat fmt
"%d day" (if (> d
1) "s" "") " ")
11412 (if (> h
0) (setq fmt
(concat fmt
"%d hour" (if (> h
1) "s" "") " ")
11414 (if (> m
0) (setq fmt
(concat fmt
"%d minute" (if (> m
1) "s" "") " ")
11416 (apply 'format fmt
(nreverse l
))))
11418 (defun org-time-string-to-time (s)
11419 (apply 'encode-time
(org-parse-time-string s
)))
11421 (defun org-time-string-to-absolute (s &optional daynr prefer show-all
)
11422 "Convert a time stamp to an absolute day number.
11423 If there is a specifyer for a cyclic time stamp, get the closest date to
11425 PREFER and SHOW-ALL are passed through to `org-closest-date'."
11427 ((and daynr
(string-match "\\`%%\\((.*)\\)" s
))
11428 (if (org-diary-sexp-entry (match-string 1 s
) "" date
)
11431 ((and daynr
(string-match "\\+[0-9]+[dwmy]" s
))
11432 (org-closest-date s
(if (and (boundp 'daynr
) (integerp daynr
)) daynr
11433 (time-to-days (current-time))) (match-string 0 s
)
11435 (t (time-to-days (apply 'encode-time
(org-parse-time-string s
))))))
11437 (defun org-days-to-iso-week (days)
11438 "Return the iso week number."
11440 (car (calendar-iso-from-absolute days
)))
11442 (defun org-small-year-to-year (year)
11443 "Convert 2-digit years into 4-digit years.
11444 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
11445 The year 2000 cannot be abbreviated. Any year larger than 99
11446 is returned unchanged."
11448 (setq year
(+ 2000 year
))
11450 (setq year
(+ 1900 year
))))
11453 (defun org-time-from-absolute (d)
11454 "Return the time corresponding to date D.
11455 D may be an absolute day number, or a calendar-type list (month day year)."
11456 (if (numberp d
) (setq d
(calendar-gregorian-from-absolute d
)))
11457 (encode-time 0 0 0 (nth 1 d
) (car d
) (nth 2 d
)))
11459 (defun org-calendar-holiday ()
11460 "List of holidays, for Diary display in Org-mode."
11461 (require 'holidays
)
11463 (if (fboundp 'calendar-check-holidays
)
11464 'calendar-check-holidays
'check-calendar-holidays
) date
)))
11465 (if hl
(mapconcat 'identity hl
"; "))))
11467 (defun org-diary-sexp-entry (sexp entry date
)
11468 "Process a SEXP diary ENTRY for DATE."
11469 (require 'diary-lib
)
11470 (let ((result (if calendar-debug-sexp
11471 (let ((stack-trace-on-error t
))
11472 (eval (car (read-from-string sexp
))))
11473 (condition-case nil
11474 (eval (car (read-from-string sexp
)))
11477 (message "Bad sexp at line %d in %s: %s"
11479 (buffer-file-name) sexp
)
11481 (cond ((stringp result
) result
)
11482 ((and (consp result
)
11483 (stringp (cdr result
))) (cdr result
))
11487 (defun org-diary-to-ical-string (frombuf)
11488 "Get iCalendar entries from diary entries in buffer FROMBUF.
11489 This uses the icalendar.el library."
11490 (let* ((tmpdir (if (featurep 'xemacs
)
11492 temporary-file-directory
))
11493 (tmpfile (make-temp-name
11494 (expand-file-name "orgics" tmpdir
)))
11497 (set-buffer frombuf
)
11498 (icalendar-export-region (point-min) (point-max) tmpfile
)
11499 (setq buf
(find-buffer-visiting tmpfile
))
11501 (goto-char (point-min))
11502 (if (re-search-forward "^BEGIN:VEVENT" nil t
)
11503 (setq b
(match-beginning 0)))
11504 (goto-char (point-max))
11505 (if (re-search-backward "^END:VEVENT" nil t
)
11506 (setq e
(match-end 0)))
11507 (setq rtn
(if (and b e
) (concat (buffer-substring b e
) "\n") "")))
11509 (delete-file tmpfile
)
11512 (defun org-closest-date (start current change prefer show-all
)
11513 "Find the date closest to CURRENT that is consistent with START and CHANGE.
11514 When PREFER is `past' return a date that is either CURRENT or past.
11515 When PREFER is `future', return a date that is either CURRENT or future.
11516 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
11517 ;; Make the proper lists from the dates
11519 (let ((a1 '(("d" . day
) ("w" . week
) ("m" . month
) ("y" . year
)))
11520 dn dw sday cday n1 n2
11521 d m y y1 y2 date1 date2 nmonths nm ny m2
)
11523 (setq start
(org-date-to-gregorian start
)
11524 current
(org-date-to-gregorian
11527 (time-to-days (current-time))))
11528 sday
(calendar-absolute-from-gregorian start
)
11529 cday
(calendar-absolute-from-gregorian current
))
11531 (if (<= cday sday
) (throw 'exit sday
))
11533 (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change
)
11534 (setq dn
(string-to-number (match-string 1 change
))
11535 dw
(cdr (assoc (match-string 2 change
) a1
)))
11536 (error "Invalid change specifyer: %s" change
))
11537 (if (eq dw
'week
) (setq dw
'day dn
(* 7 dn
)))
11540 (setq n1
(+ sday
(* dn
(floor (/ (- cday sday
) dn
))))
11543 (setq d
(nth 1 start
) m
(car start
) y1
(nth 2 start
) y2
(nth 2 current
))
11544 (setq y1
(+ (* (floor (/ (- y2 y1
) dn
)) dn
) y1
))
11545 (setq date1
(list m d y1
)
11546 n1
(calendar-absolute-from-gregorian date1
)
11547 date2
(list m d
(+ y1
(* (if (< n1 cday
) 1 -
1) dn
)))
11548 n2
(calendar-absolute-from-gregorian date2
)))
11550 ;; approx number of month between the two dates
11551 (setq nmonths
(floor (/ (- cday sday
) 30.436875)))
11552 ;; How often does dn fit in there?
11553 (setq d
(nth 1 start
) m
(car start
) y
(nth 2 start
)
11554 nm
(* dn
(max 0 (1- (floor (/ nmonths dn
)))))
11556 ny
(floor (/ m
12))
11559 (while (> m
12) (setq m
(- m
12) y
(1+ y
)))
11560 (setq n1
(calendar-absolute-from-gregorian (list m d y
)))
11561 (setq m2
(+ m dn
) y2 y
)
11562 (if (> m2
12) (setq y2
(1+ y2
) m2
(- m2
12)))
11563 (setq n2
(calendar-absolute-from-gregorian (list m2 d y2
)))
11564 (while (<= n2 cday
)
11565 (setq n1 n2 m m2 y y2
)
11566 (setq m2
(+ m dn
) y2 y
)
11567 (if (> m2
12) (setq y2
(1+ y2
) m2
(- m2
12)))
11568 (setq n2
(calendar-absolute-from-gregorian (list m2 d y2
))))))
11571 ((eq prefer
'past
) n1
)
11572 ((eq prefer
'future
) (if (= cday n1
) n1 n2
))
11573 (t (if (> (abs (- cday n1
)) (abs (- cday n2
))) n2 n1
)))
11575 ((eq prefer
'past
) n1
)
11576 ((eq prefer
'future
) (if (= cday n1
) n1 n2
))
11577 (t (if (= cday n1
) n1 n2
)))))))
11579 (defun org-date-to-gregorian (date)
11580 "Turn any specification of DATE into a gregorian date for the calendar."
11581 (cond ((integerp date
) (calendar-gregorian-from-absolute date
))
11582 ((and (listp date
) (= (length date
) 3)) date
)
11584 (setq date
(org-parse-time-string date
))
11585 (list (nth 4 date
) (nth 3 date
) (nth 5 date
)))
11587 (list (nth 4 date
) (nth 3 date
) (nth 5 date
)))))
11589 (defun org-parse-time-string (s &optional nodefault
)
11590 "Parse the standard Org-mode time string.
11591 This should be a lot faster than the normal `parse-time-string'.
11592 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
11593 hour and minute fields will be nil if not given."
11594 (if (string-match org-ts-regexp0 s
)
11596 (if (or (match-beginning 8) (not nodefault
))
11597 (string-to-number (or (match-string 8 s
) "0")))
11598 (if (or (match-beginning 7) (not nodefault
))
11599 (string-to-number (or (match-string 7 s
) "0")))
11600 (string-to-number (match-string 4 s
))
11601 (string-to-number (match-string 3 s
))
11602 (string-to-number (match-string 2 s
))
11606 (defun org-timestamp-up (&optional arg
)
11607 "Increase the date item at the cursor by one.
11608 If the cursor is on the year, change the year. If it is on the month or
11609 the day, change that.
11610 With prefix ARG, change by that many units."
11612 (org-timestamp-change (prefix-numeric-value arg
)))
11614 (defun org-timestamp-down (&optional arg
)
11615 "Decrease the date item at the cursor by one.
11616 If the cursor is on the year, change the year. If it is on the month or
11617 the day, change that.
11618 With prefix ARG, change by that many units."
11620 (org-timestamp-change (- (prefix-numeric-value arg
))))
11622 (defun org-timestamp-up-day (&optional arg
)
11623 "Increase the date in the time stamp by one day.
11624 With prefix ARG, change that many days."
11626 (if (and (not (org-at-timestamp-p t
))
11627 (org-on-heading-p))
11629 (org-timestamp-change (prefix-numeric-value arg
) 'day
)))
11631 (defun org-timestamp-down-day (&optional arg
)
11632 "Decrease the date in the time stamp by one day.
11633 With prefix ARG, change that many days."
11635 (if (and (not (org-at-timestamp-p t
))
11636 (org-on-heading-p))
11638 (org-timestamp-change (- (prefix-numeric-value arg
)) 'day
)))
11640 (defun org-at-timestamp-p (&optional inactive-ok
)
11641 "Determine if the cursor is in or at a timestamp."
11643 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2
))
11645 (ans (or (looking-at tsr
)
11647 (skip-chars-backward "^[<\n\r\t")
11648 (if (> (point) (point-min)) (backward-char 1))
11649 (and (looking-at tsr
)
11650 (> (- (match-end 0) pos
) -
1))))))
11652 (boundp 'org-ts-what
)
11655 ((= pos
(match-beginning 0)) 'bracket
)
11656 ((= pos
(1- (match-end 0))) 'bracket
)
11657 ((org-pos-in-match-range pos
2) 'year
)
11658 ((org-pos-in-match-range pos
3) 'month
)
11659 ((org-pos-in-match-range pos
7) 'hour
)
11660 ((org-pos-in-match-range pos
8) 'minute
)
11661 ((or (org-pos-in-match-range pos
4)
11662 (org-pos-in-match-range pos
5)) 'day
)
11663 ((and (> pos
(or (match-end 8) (match-end 5)))
11664 (< pos
(match-end 0)))
11665 (- pos
(or (match-end 8) (match-end 5))))
11669 (defun org-toggle-timestamp-type ()
11670 "Toggle the type (<active> or [inactive]) of a time stamp."
11672 (when (org-at-timestamp-p t
)
11673 (let ((beg (match-beginning 0)) (end (match-end 0))
11674 (map '((?\
[ .
"<") (?\
] .
">") (?
< .
"[") (?
> .
"]"))))
11677 (while (re-search-forward "[][<>]" end t
)
11678 (replace-match (cdr (assoc (char-after (match-beginning 0)) map
))
11680 (message "Timestamp is now %sactive"
11681 (if (equal (char-after beg
) ?
<) "" "in")))))
11683 (defun org-timestamp-change (n &optional what
)
11684 "Change the date in the time stamp at point.
11685 The date will be changed by N times WHAT. WHAT can be `day', `month',
11686 `year', `minute', `second'. If WHAT is not given, the cursor position
11687 in the timestamp determines what will be changed."
11688 (let ((pos (point))
11690 (dm (max (nth 1 org-time-stamp-rounding-minutes
) 1))
11694 (if (not (org-at-timestamp-p t
))
11695 (error "Not at a timestamp"))
11696 (if (and (not what
) (eq org-ts-what
'bracket
))
11697 (org-toggle-timestamp-type)
11698 (if (and (not what
) (not (eq org-ts-what
'day
))
11699 org-display-custom-times
11700 (get-text-property (point) 'display
)
11701 (not (get-text-property (1- (point)) 'display
)))
11702 (setq org-ts-what
'day
))
11703 (setq org-ts-what
(or what org-ts-what
)
11704 inactive
(= (char-after (match-beginning 0)) ?\
[)
11705 ts
(match-string 0))
11708 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\)*\\)[]>]"
11710 (setq extra
(match-string 1 ts
)))
11711 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts
)
11713 (setq time0
(org-parse-time-string ts
))
11714 (when (and (eq org-ts-what
'minute
)
11715 (eq current-prefix-arg nil
))
11716 (setq n
(* dm
(cond ((> n
0) 1) ((< n
0) -
1) (t 0))))
11717 (when (not (= 0 (setq rem
(%
(nth 1 time0
) dm
))))
11718 (setcar (cdr time0
) (+ (nth 1 time0
)
11719 (if (> n
0) (- rem
) (- dm rem
))))))
11721 (encode-time (or (car time0
) 0)
11722 (+ (if (eq org-ts-what
'minute
) n
0) (nth 1 time0
))
11723 (+ (if (eq org-ts-what
'hour
) n
0) (nth 2 time0
))
11724 (+ (if (eq org-ts-what
'day
) n
0) (nth 3 time0
))
11725 (+ (if (eq org-ts-what
'month
) n
0) (nth 4 time0
))
11726 (+ (if (eq org-ts-what
'year
) n
0) (nth 5 time0
))
11728 (when (integerp org-ts-what
)
11729 (setq extra
(org-modify-ts-extra extra org-ts-what n dm
)))
11730 (if (eq what
'calendar
)
11731 (let ((cal-date (org-get-date-from-calendar)))
11732 (setcar (nthcdr 4 time0
) (nth 0 cal-date
)) ; month
11733 (setcar (nthcdr 3 time0
) (nth 1 cal-date
)) ; day
11734 (setcar (nthcdr 5 time0
) (nth 2 cal-date
)) ; year
11735 (setcar time0
(or (car time0
) 0))
11736 (setcar (nthcdr 1 time0
) (or (nth 1 time0
) 0))
11737 (setcar (nthcdr 2 time0
) (or (nth 2 time0
) 0))
11738 (setq time
(apply 'encode-time time0
))))
11739 (setq org-last-changed-timestamp
11740 (org-insert-time-stamp time with-hm inactive nil nil extra
))
11741 (org-clock-update-time-maybe)
11743 ;; Try to recenter the calendar window, if any
11744 (if (and org-calendar-follow-timestamp-change
11745 (get-buffer-window "*Calendar*" t
)
11746 (memq org-ts-what
'(day month year
)))
11747 (org-recenter-calendar (time-to-days time
))))))
11749 (defun org-modify-ts-extra (s pos n dm
)
11750 "Change the different parts of the lead-time and repeat fields in timestamp."
11751 (let ((idx '(("d" .
0) ("w" .
1) ("m" .
2) ("y" .
3) ("d" . -
1) ("y" .
4)))
11753 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s
)
11755 ((or (org-pos-in-match-range pos
2)
11756 (org-pos-in-match-range pos
3))
11757 (setq m
(string-to-number (match-string 3 s
))
11758 h
(string-to-number (match-string 2 s
)))
11759 (if (org-pos-in-match-range pos
2)
11761 (setq n
(* dm
(org-no-warnings (signum n
))))
11762 (when (not (= 0 (setq rem
(% m dm
))))
11763 (setq m
(+ m
(if (> n
0) (- rem
) (- dm rem
)))))
11765 (if (< m
0) (setq m
(+ m
60) h
(1- h
)))
11766 (if (> m
59) (setq m
(- m
60) h
(1+ h
)))
11767 (setq h
(min 24 (max 0 h
)))
11768 (setq ng
1 new
(format "-%02d:%02d" h m
)))
11769 ((org-pos-in-match-range pos
6)
11770 (setq ng
6 new
(car (rassoc (+ n
(cdr (assoc (match-string 6 s
) idx
))) idx
))))
11771 ((org-pos-in-match-range pos
5)
11772 (setq ng
5 new
(format "%d" (max 1 (+ n
(string-to-number (match-string 5 s
)))))))
11774 ((org-pos-in-match-range pos
9)
11775 (setq ng
9 new
(car (rassoc (+ n
(cdr (assoc (match-string 9 s
) idx
))) idx
))))
11776 ((org-pos-in-match-range pos
8)
11777 (setq ng
8 new
(format "%d" (max 0 (+ n
(string-to-number (match-string 8 s
))))))))
11781 (substring s
0 (match-beginning ng
))
11783 (substring s
(match-end ng
))))))
11786 (defun org-recenter-calendar (date)
11787 "If the calendar is visible, recenter it to DATE."
11788 (let* ((win (selected-window))
11789 (cwin (get-buffer-window "*Calendar*" t
))
11790 (calendar-move-hook nil
))
11792 (select-window cwin
)
11793 (calendar-goto-date (if (listp date
) date
11794 (calendar-gregorian-from-absolute date
)))
11795 (select-window win
))))
11797 (defun org-goto-calendar (&optional arg
)
11798 "Go to the Emacs calendar at the current date.
11799 If there is a time stamp in the current line, go to that date.
11800 A prefix ARG can be used to force the current date."
11802 (let ((tsr org-ts-regexp
) diff
11803 (calendar-move-hook nil
)
11804 (calendar-view-holidays-initially-flag nil
)
11805 (view-calendar-holidays-initially nil
)
11806 (calendar-view-diary-initially-flag nil
)
11807 (view-diary-entries-initially nil
))
11808 (if (or (org-at-timestamp-p)
11810 (beginning-of-line 1)
11811 (looking-at (concat ".*" tsr
))))
11812 (let ((d1 (time-to-days (current-time)))
11814 (org-time-string-to-time (match-string 1)))))
11815 (setq diff
(- d2 d1
))))
11817 (calendar-goto-today)
11818 (if (and diff
(not arg
)) (calendar-forward-day diff
))))
11820 (defun org-get-date-from-calendar ()
11821 "Return a list (month day year) of date at point in calendar."
11822 (with-current-buffer "*Calendar*"
11824 (calendar-cursor-to-date))))
11826 (defun org-date-from-calendar ()
11827 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
11828 If there is already a time stamp at the cursor position, update it."
11830 (if (org-at-timestamp-p t
)
11831 (org-timestamp-change 0 'calendar
)
11832 (let ((cal-date (org-get-date-from-calendar)))
11833 (org-insert-time-stamp
11834 (encode-time 0 0 0 (nth 1 cal-date
) (car cal-date
) (nth 2 cal-date
))))))
11836 (defun org-minutes-to-hh:mm-string
(m)
11837 "Compute H:MM from a number of minutes."
11838 (let ((h (/ m
60)))
11839 (setq m
(- m
(* 60 h
)))
11840 (format org-time-clocksum-format h m
)))
11842 (defun org-hh:mm-string-to-minutes
(s)
11843 "Convert a string H:MM to a number of minutes."
11844 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
11845 (+ (* (string-to-number (match-string 1 s
)) 60)
11846 (string-to-number (match-string 2 s
)))
11852 (defun org-iswitchb (&optional arg
)
11853 "Use `iswitchb-read-buffer' to prompt for an Org buffer to switch to.
11854 With a prefix argument, restrict available to files.
11855 With two prefix arguments, restrict available buffers to agenda files.
11857 Due to some yet unresolved reason, the global function
11858 `iswitchb-mode' needs to be active for this function to work."
11860 (require 'iswitchb
)
11861 (let ((enabled iswitchb-mode
) blist
)
11862 (or enabled
(iswitchb-mode 1))
11863 (setq blist
(cond ((equal arg
'(4)) (org-buffer-list 'files
))
11864 ((equal arg
'(16)) (org-buffer-list 'agenda
))
11865 (t (org-buffer-list))))
11867 (let ((iswitchb-make-buflist-hook
11869 (setq iswitchb-temp-buflist
11870 (mapcar 'buffer-name blist
)))))
11872 (iswitchb-read-buffer
11873 "Switch-to: " nil t
))
11874 (or enabled
(iswitchb-mode -
1))))))
11877 (defun org-ido-switchb (&optional arg
)
11878 "Use `org-ido-completing-read' to prompt for an Org buffer to switch to.
11879 With a prefix argument, restrict available to files.
11880 With two prefix arguments, restrict available buffers to agenda files."
11882 (let ((blist (cond ((equal arg
'(4)) (org-buffer-list 'files
))
11883 ((equal arg
'(16)) (org-buffer-list 'agenda
))
11884 (t (org-buffer-list)))))
11886 (org-ido-completing-read "Org buffer: "
11887 (mapcar 'buffer-name blist
)
11890 (defun org-buffer-list (&optional predicate exclude-tmp
)
11891 "Return a list of Org buffers.
11892 PREDICATE can be `export', `files' or `agenda'.
11894 export restrict the list to Export buffers.
11895 files restrict the list to buffers visiting Org files.
11896 agenda restrict the list to buffers visiting agenda files.
11898 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
11900 (agenda-files (and (eq predicate
'agenda
)
11901 (mapcar 'file-truename
(org-agenda-files t
))))
11904 ((eq predicate
'files
)
11905 (lambda (b) (with-current-buffer b
(eq major-mode
'org-mode
))))
11906 ((eq predicate
'export
)
11907 (lambda (b) (string-match "\*Org .*Export" (buffer-name b
))))
11908 ((eq predicate
'agenda
)
11910 (with-current-buffer b
11911 (and (eq major-mode
'org-mode
)
11912 (setq bfn
(buffer-file-name b
))
11913 (member (file-truename bfn
) agenda-files
)))))
11914 (t (lambda (b) (with-current-buffer b
11915 (or (eq major-mode
'org-mode
)
11916 (string-match "\*Org .*Export"
11917 (buffer-name b
)))))))))
11921 (if (and (funcall filter b
)
11922 (or (not exclude-tmp
)
11923 (not (string-match "tmp" (buffer-name b
)))))
11928 (defun org-agenda-files (&optional unrestricted archives
)
11929 "Get the list of agenda files.
11930 Optional UNRESTRICTED means return the full list even if a restriction
11931 is currently in place.
11932 When ARCHIVES is t, include all archive files hat are really being
11933 used by the agenda files. If ARCHIVE is `ifmode', do this only if
11934 `org-agenda-archives-mode' is t."
11937 ((and (not unrestricted
) (get 'org-agenda-files
'org-restrict
)))
11938 ((stringp org-agenda-files
) (org-read-agenda-file-list))
11939 ((listp org-agenda-files
) org-agenda-files
)
11940 (t (error "Invalid value of `org-agenda-files'")))))
11941 (setq files
(apply 'append
11942 (mapcar (lambda (f)
11943 (if (file-directory-p f
)
11945 f t org-agenda-file-regexp
)
11948 (when org-agenda-skip-unavailable-files
11949 (setq files
(delq nil
11952 (and (file-readable-p file
) file
)))
11954 (when (or (eq archives t
)
11955 (and (eq archives
'ifmode
) (eq org-agenda-archives-mode t
)))
11956 (setq files
(org-add-archive-files files
)))
11959 (defun org-edit-agenda-file-list ()
11960 "Edit the list of agenda files.
11961 Depending on setup, this either uses customize to edit the variable
11962 `org-agenda-files', or it visits the file that is holding the list. In the
11963 latter case, the buffer is set up in a way that saving it automatically kills
11964 the buffer and restores the previous window configuration."
11966 (if (stringp org-agenda-files
)
11967 (let ((cw (current-window-configuration)))
11968 (find-file org-agenda-files
)
11969 (org-set-local 'org-window-configuration cw
)
11970 (org-add-hook 'after-save-hook
11972 (set-window-configuration
11973 (prog1 org-window-configuration
11974 (kill-buffer (current-buffer))))
11975 (org-install-agenda-files-menu)
11976 (message "New agenda file list installed"))
11978 (message "%s" (substitute-command-keys
11979 "Edit list and finish with \\[save-buffer]")))
11980 (customize-variable 'org-agenda-files
)))
11982 (defun org-store-new-agenda-file-list (list)
11983 "Set new value for the agenda file list and save it correctly."
11984 (if (stringp org-agenda-files
)
11985 (let ((f org-agenda-files
) b
)
11986 (while (setq b
(find-buffer-visiting f
)) (kill-buffer b
))
11988 (insert (mapconcat 'identity list
"\n") "\n")))
11989 (let ((org-mode-hook nil
) (default-major-mode 'fundamental-mode
))
11990 (setq org-agenda-files list
)
11991 (customize-save-variable 'org-agenda-files org-agenda-files
))))
11993 (defun org-read-agenda-file-list ()
11994 "Read the list of agenda files from a file."
11995 (when (file-directory-p org-agenda-files
)
11996 (error "`org-agenda-files' cannot be a single directory"))
11997 (when (stringp org-agenda-files
)
11999 (insert-file-contents org-agenda-files
)
12000 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*"))))
12004 (defun org-cycle-agenda-files ()
12005 "Cycle through the files in `org-agenda-files'.
12006 If the current buffer visits an agenda file, find the next one in the list.
12007 If the current buffer does not, find the first agenda file."
12009 (let* ((fs (org-agenda-files t
))
12010 (files (append fs
(list (car fs
))))
12011 (tcf (if buffer-file-name
(file-truename buffer-file-name
)))
12013 (unless files
(error "No agenda files"))
12015 (while (setq file
(pop files
))
12016 (if (equal (file-truename file
) tcf
)
12018 (find-file (car files
))
12020 (find-file (car fs
)))
12021 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
12023 (defun org-agenda-file-to-front (&optional to-end
)
12024 "Move/add the current file to the top of the agenda file list.
12025 If the file is not present in the list, it is added to the front. If it is
12026 present, it is moved there. With optional argument TO-END, add/move to the
12029 (let ((org-agenda-skip-unavailable-files nil
)
12030 (file-alist (mapcar (lambda (x)
12031 (cons (file-truename x
) x
))
12032 (org-agenda-files t
)))
12033 (ctf (file-truename buffer-file-name
))
12035 (setq x
(assoc ctf file-alist
) had x
)
12037 (if (not x
) (setq x
(cons ctf
(abbreviate-file-name buffer-file-name
))))
12039 (setq file-alist
(append (delq x file-alist
) (list x
)))
12040 (setq file-alist
(cons x
(delq x file-alist
))))
12041 (org-store-new-agenda-file-list (mapcar 'cdr file-alist
))
12042 (org-install-agenda-files-menu)
12043 (message "File %s to %s of agenda file list"
12044 (if had
"moved" "added") (if to-end
"end" "front"))))
12046 (defun org-remove-file (&optional file
)
12047 "Remove current file from the list of files in variable `org-agenda-files'.
12048 These are the files which are being checked for agenda entries.
12049 Optional argument FILE means, use this file instead of the current."
12051 (let* ((org-agenda-skip-unavailable-files nil
)
12052 (file (or file buffer-file-name
))
12053 (true-file (file-truename file
))
12054 (afile (abbreviate-file-name file
))
12055 (files (delq nil
(mapcar
12057 (if (equal true-file
12060 (org-agenda-files t
)))))
12061 (if (not (= (length files
) (length (org-agenda-files t
))))
12063 (org-store-new-agenda-file-list files
)
12064 (org-install-agenda-files-menu)
12065 (message "Removed file: %s" afile
))
12066 (message "File was not in list: %s (not removed)" afile
))))
12068 (defun org-file-menu-entry (file)
12069 (vector file
(list 'find-file file
) t
))
12071 (defun org-check-agenda-file (file)
12072 "Make sure FILE exists. If not, ask user what to do."
12073 (when (not (file-exists-p file
))
12074 (message "non-existent file %s. [R]emove from list or [A]bort?"
12075 (abbreviate-file-name file
))
12076 (let ((r (downcase (read-char-exclusive))))
12079 (org-remove-file file
)
12080 (throw 'nextfile t
))
12081 (t (error "Abort"))))))
12083 (defun org-get-agenda-file-buffer (file)
12084 "Get a buffer visiting FILE. If the buffer needs to be created, add
12085 it to the list of buffers which might be released later."
12086 (let ((buf (org-find-base-buffer-visiting file
)))
12088 buf
; just return it
12089 ;; Make a new buffer and remember it
12090 (setq buf
(find-file-noselect file
))
12091 (if buf
(push buf org-agenda-new-buffers
))
12094 (defun org-release-buffers (blist)
12095 "Release all buffers in list, asking the user for confirmation when needed.
12096 When a buffer is unmodified, it is just killed. When modified, it is saved
12097 \(if the user agrees) and then killed."
12099 (while (setq buf
(pop blist
))
12100 (setq file
(buffer-file-name buf
))
12101 (when (and (buffer-modified-p buf
)
12103 (y-or-n-p (format "Save file %s? " file
)))
12104 (with-current-buffer buf
(save-buffer)))
12105 (kill-buffer buf
))))
12107 (defun org-prepare-agenda-buffers (files)
12108 "Create buffers for all agenda files, protect archived trees and comments."
12110 (let ((pa '(:org-archived t
))
12111 (pc '(:org-comment t
))
12112 (pall '(:org-archived t
:org-comment t
))
12113 (inhibit-read-only t
)
12114 (rea (concat ":" org-archive-tag
":"))
12118 (while (setq file
(pop files
))
12121 (org-check-agenda-file file
)
12122 (set-buffer (org-get-agenda-file-buffer file
)))
12124 (setq bmp
(buffer-modified-p))
12125 (org-refresh-category-properties)
12126 (setq org-todo-keywords-for-agenda
12127 (append org-todo-keywords-for-agenda org-todo-keywords-1
))
12128 (setq org-done-keywords-for-agenda
12129 (append org-done-keywords-for-agenda org-done-keywords
))
12130 (setq org-todo-keyword-alist-for-agenda
12131 (append org-todo-keyword-alist-for-agenda org-todo-key-alist
))
12132 (setq org-tag-alist-for-agenda
12133 (append org-tag-alist-for-agenda org-tag-alist
))
12136 (remove-text-properties (point-min) (point-max) pall
)
12137 (when org-agenda-skip-archived-trees
12138 (goto-char (point-min))
12139 (while (re-search-forward rea nil t
)
12140 (if (org-on-heading-p t
)
12141 (add-text-properties (point-at-bol) (org-end-of-subtree t
) pa
))))
12142 (goto-char (point-min))
12143 (setq re
(concat "^\\*+ +" org-comment-string
"\\>"))
12144 (while (re-search-forward re nil t
)
12145 (add-text-properties
12146 (match-beginning 0) (org-end-of-subtree t
) pc
)))
12147 (set-buffer-modified-p bmp
))))
12148 (setq org-todo-keyword-alist-for-agenda
12149 (org-uniquify org-todo-keyword-alist-for-agenda
)
12150 org-tag-alist-for-agenda
(org-uniquify org-tag-alist-for-agenda
))))
12152 ;;;; Embedded LaTeX
12154 (defvar org-cdlatex-mode-map
(make-sparse-keymap)
12155 "Keymap for the minor `org-cdlatex-mode'.")
12157 (org-defkey org-cdlatex-mode-map
"_" 'org-cdlatex-underscore-caret
)
12158 (org-defkey org-cdlatex-mode-map
"^" 'org-cdlatex-underscore-caret
)
12159 (org-defkey org-cdlatex-mode-map
"`" 'cdlatex-math-symbol
)
12160 (org-defkey org-cdlatex-mode-map
"'" 'org-cdlatex-math-modify
)
12161 (org-defkey org-cdlatex-mode-map
"\C-c{" 'cdlatex-environment
)
12163 (defvar org-cdlatex-texmathp-advice-is-done nil
12164 "Flag remembering if we have applied the advice to texmathp already.")
12166 (define-minor-mode org-cdlatex-mode
12167 "Toggle the minor `org-cdlatex-mode'.
12168 This mode supports entering LaTeX environment and math in LaTeX fragments
12170 \\{org-cdlatex-mode-map}"
12172 (when org-cdlatex-mode
(require 'cdlatex
))
12173 (unless org-cdlatex-texmathp-advice-is-done
12174 (setq org-cdlatex-texmathp-advice-is-done t
)
12175 (defadvice texmathp
(around org-math-always-on activate
)
12176 "Always return t in org-mode buffers.
12177 This is because we want to insert math symbols without dollars even outside
12178 the LaTeX math segments. If Orgmode thinks that point is actually inside
12179 an embedded LaTeX fragment, let texmathp do its job.
12180 \\[org-cdlatex-mode-map]"
12184 ((not (org-mode-p)) ad-do-it
)
12185 ((eq this-command
'cdlatex-math-symbol
)
12186 (setq ad-return-value t
12187 texmathp-why
'("cdlatex-math-symbol in org-mode" .
0)))
12189 (let ((p (org-inside-LaTeX-fragment-p)))
12190 (if (and p
(member (car p
) (plist-get org-format-latex-options
:matchers
)))
12191 (setq ad-return-value t
12192 texmathp-why
'("Org-mode embedded math" .
0))
12193 (if p ad-do-it
)))))))))
12195 (defun turn-on-org-cdlatex ()
12196 "Unconditionally turn on `org-cdlatex-mode'."
12197 (org-cdlatex-mode 1))
12199 (defun org-inside-LaTeX-fragment-p ()
12200 "Test if point is inside a LaTeX fragment.
12201 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
12202 sequence appearing also before point.
12203 Even though the matchers for math are configurable, this function assumes
12204 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
12205 delimiters are skipped when they have been removed by customization.
12206 The return value is nil, or a cons cell with the delimiter and
12207 and the position of this delimiter.
12209 This function does a reasonably good job, but can locally be fooled by
12210 for example currency specifications. For example it will assume being in
12211 inline math after \"$22.34\". The LaTeX fragment formatter will only format
12212 fragments that are properly closed, but during editing, we have to live
12213 with the uncertainty caused by missing closing delimiters. This function
12214 looks only before point, not after."
12216 (let ((pos (point))
12217 (dodollar (member "$" (plist-get org-format-latex-options
:matchers
)))
12219 (re-search-backward (concat "^\\(" paragraph-start
"\\)") nil t
)
12221 dd-on str
(start 0) m re
)
12224 (setq str
(concat (buffer-substring lim
(point)) "\000 X$.")
12225 re
(nth 1 (assoc "$" org-latex-regexps
)))
12226 (while (string-match re str start
)
12228 ((= (match-end 0) (length str
))
12229 (throw 'exit
(cons "$" (+ lim
(match-beginning 0) 1))))
12230 ((= (match-end 0) (- (length str
) 5))
12232 (t (setq start
(match-end 0))))))
12233 (when (setq m
(re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t
))
12235 (and (match-beginning 1) (throw 'exit
(cons (match-string 1) m
)))
12236 (and (match-beginning 2) (throw 'exit nil
))
12238 (while (re-search-backward "\\$\\$" lim t
)
12239 (setq dd-on
(not dd-on
)))
12241 (if dd-on
(cons "$$" m
))))))
12244 (defun org-try-cdlatex-tab ()
12245 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
12246 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
12247 - inside a LaTeX fragment, or
12248 - after the first word in a line, where an abbreviation expansion could
12249 insert a LaTeX environment."
12250 (when org-cdlatex-mode
12253 (skip-chars-backward "a-zA-Z0-9*")
12254 (skip-chars-backward " \t")
12257 ((org-inside-LaTeX-fragment-p)
12261 (defun org-cdlatex-underscore-caret (&optional arg
)
12262 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
12263 Revert to the normal definition outside of these fragments."
12265 (if (org-inside-LaTeX-fragment-p)
12266 (call-interactively 'cdlatex-sub-superscript
)
12267 (let (org-cdlatex-mode)
12268 (call-interactively (key-binding (vector last-input-event
))))))
12270 (defun org-cdlatex-math-modify (&optional arg
)
12271 "Execute `cdlatex-math-modify' in LaTeX fragments.
12272 Revert to the normal definition outside of these fragments."
12274 (if (org-inside-LaTeX-fragment-p)
12275 (call-interactively 'cdlatex-math-modify
)
12276 (let (org-cdlatex-mode)
12277 (call-interactively (key-binding (vector last-input-event
))))))
12279 (defvar org-latex-fragment-image-overlays nil
12280 "List of overlays carrying the images of latex fragments.")
12281 (make-variable-buffer-local 'org-latex-fragment-image-overlays
)
12283 (defun org-remove-latex-fragment-image-overlays ()
12284 "Remove all overlays with LaTeX fragment images in current buffer."
12285 (mapc 'org-delete-overlay org-latex-fragment-image-overlays
)
12286 (setq org-latex-fragment-image-overlays nil
))
12288 (defun org-preview-latex-fragment (&optional subtree
)
12289 "Preview the LaTeX fragment at point, or all locally or globally.
12290 If the cursor is in a LaTeX fragment, create the image and overlay
12291 it over the source code. If there is no fragment at point, display
12292 all fragments in the current text, from one headline to the next. With
12293 prefix SUBTREE, display all fragments in the current subtree. With a
12294 double prefix `C-u C-u', or when the cursor is before the first headline,
12295 display all fragments in the buffer.
12296 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
12298 (org-remove-latex-fragment-image-overlays)
12301 (let (beg end at msg
)
12303 ((or (equal subtree
'(16))
12304 (not (save-excursion
12305 (re-search-backward (concat "^" outline-regexp
) nil t
))))
12306 (setq beg
(point-min) end
(point-max)
12307 msg
"Creating images for buffer...%s"))
12308 ((equal subtree
'(4))
12309 (org-back-to-heading)
12310 (setq beg
(point) end
(org-end-of-subtree t
)
12311 msg
"Creating images for subtree...%s"))
12313 (if (setq at
(org-inside-LaTeX-fragment-p))
12314 (goto-char (max (point-min) (- (cdr at
) 2)))
12315 (org-back-to-heading))
12316 (setq beg
(point) end
(progn (outline-next-heading) (point))
12317 msg
(if at
"Creating image...%s"
12318 "Creating images for entry...%s"))))
12320 (narrow-to-region beg end
)
12323 (concat "ltxpng/" (file-name-sans-extension
12324 (file-name-nondirectory
12325 buffer-file-name
)))
12326 default-directory
'overlays msg at
'forbuffer
)
12327 (message msg
"done. Use `C-c C-c' to remove images.")))))
12329 (defvar org-latex-regexps
12330 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
12331 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
12332 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
12333 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil
)
12334 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
12335 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 t
)
12336 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 t
))
12337 "Regular expressions for matching embedded LaTeX.")
12339 (defun org-format-latex (prefix &optional dir overlays msg at forbuffer
)
12340 "Replace LaTeX fragments with links to an image, and produce images."
12341 (if (and overlays
(fboundp 'clear-image-cache
)) (clear-image-cache))
12342 (let* ((prefixnodir (file-name-nondirectory prefix
))
12343 (absprefix (expand-file-name prefix dir
))
12344 (todir (file-name-directory absprefix
))
12345 (opt org-format-latex-options
)
12346 (matchers (plist-get opt
:matchers
))
12347 (re-list org-latex-regexps
)
12348 (cnt 0) txt link beg end re e checkdir
12349 m n block linkfile movefile ov
)
12350 ;; Check if there are old images files with this prefix, and remove them
12351 (when (file-directory-p todir
)
12355 (concat (regexp-quote prefixnodir
) "_[0-9]+\\.png$"))))
12356 ;; Check the different regular expressions
12357 (while (setq e
(pop re-list
))
12358 (setq m
(car e
) re
(nth 1 e
) n
(nth 2 e
)
12359 block
(if (nth 3 e
) "\n\n" ""))
12360 (when (member m matchers
)
12361 (goto-char (point-min))
12362 (while (re-search-forward re nil t
)
12363 (when (or (not at
) (equal (cdr at
) (match-beginning n
)))
12364 (setq txt
(match-string n
)
12365 beg
(match-beginning n
) end
(match-end n
)
12367 linkfile
(format "%s_%04d.png" prefix cnt
)
12368 movefile
(format "%s_%04d.png" absprefix cnt
)
12369 link
(concat block
"[[file:" linkfile
"]]" block
))
12370 (if msg
(message msg cnt
))
12372 (unless checkdir
; make sure the directory exists
12374 (or (file-directory-p todir
) (make-directory todir
)))
12375 (org-create-formula-image
12376 txt movefile opt forbuffer
)
12379 (setq ov
(org-make-overlay beg end
))
12380 (if (featurep 'xemacs
)
12382 (org-overlay-put ov
'invisible t
)
12385 (make-glyph (vector 'png
:file movefile
))))
12388 (list 'image
:type
'png
:file movefile
:ascent
'center
)))
12389 (push ov org-latex-fragment-image-overlays
)
12391 (delete-region beg end
)
12392 (insert link
))))))))
12394 ;; This function borrows from Ganesh Swami's latex2png.el
12395 (defun org-create-formula-image (string tofile options buffer
)
12396 (let* ((tmpdir (if (featurep 'xemacs
)
12398 temporary-file-directory
))
12399 (texfilebase (make-temp-name
12400 (expand-file-name "orgtex" tmpdir
)))
12401 (texfile (concat texfilebase
".tex"))
12402 (dvifile (concat texfilebase
".dvi"))
12403 (pngfile (concat texfilebase
".png"))
12404 (fnh (if (featurep 'xemacs
)
12405 (font-height (get-face-font 'default
))
12406 (face-attribute 'default
:height nil
)))
12407 (scale (or (plist-get options
(if buffer
:scale
:html-scale
)) 1.0))
12408 (dpi (number-to-string (* scale
(floor (* 0.9 (if buffer fnh
140.
))))))
12409 (fg (or (plist-get options
(if buffer
:foreground
:html-foreground
))
12411 (bg (or (plist-get options
(if buffer
:background
:html-background
))
12413 (if (eq fg
'default
) (setq fg
(org-dvipng-color :foreground
)))
12414 (if (eq bg
'default
) (setq bg
(org-dvipng-color :background
)))
12415 (with-temp-file texfile
12416 (insert org-format-latex-header
12417 "\n\\begin{document}\n" string
"\n\\end{document}\n"))
12418 (let ((dir default-directory
))
12419 (condition-case nil
12422 (call-process "latex" nil nil nil texfile
))
12425 (if (not (file-exists-p dvifile
))
12426 (progn (message "Failed to create dvi file from %s" texfile
) nil
)
12427 (condition-case nil
12428 (call-process "dvipng" nil nil nil
12429 "-E" "-fg" fg
"-bg" bg
12431 ;;"-x" scale "-y" scale
12436 (if (not (file-exists-p pngfile
))
12437 (progn (message "Failed to create png file from %s" texfile
) nil
)
12438 ;; Use the requested file name and clean up
12439 (copy-file pngfile tofile
'replace
)
12440 (loop for e in
'(".dvi" ".tex" ".aux" ".log" ".png") do
12441 (delete-file (concat texfilebase e
)))
12444 (defun org-dvipng-color (attr)
12445 "Return an rgb color specification for dvipng."
12446 (apply 'format
"rgb %s %s %s"
12447 (mapcar 'org-normalize-color
12448 (color-values (face-attribute 'default attr nil
)))))
12450 (defun org-normalize-color (value)
12451 "Return string to be used as color value for an RGB component."
12452 (format "%g" (/ value
65535.0)))
12457 ;; Make `C-c C-x' a prefix key
12458 (org-defkey org-mode-map
"\C-c\C-x" (make-sparse-keymap))
12460 ;; TAB key with modifiers
12461 (org-defkey org-mode-map
"\C-i" 'org-cycle
)
12462 (org-defkey org-mode-map
[(tab)] 'org-cycle
)
12463 (org-defkey org-mode-map
[(control tab
)] 'org-force-cycle-archived
)
12464 (org-defkey org-mode-map
[(meta tab
)] 'org-complete
)
12465 (org-defkey org-mode-map
"\M-\t" 'org-complete
)
12466 (org-defkey org-mode-map
"\M-\C-i" 'org-complete
)
12467 ;; The following line is necessary under Suse GNU/Linux
12468 (unless (featurep 'xemacs
)
12469 (org-defkey org-mode-map
[S-iso-lefttab
] 'org-shifttab
))
12470 (org-defkey org-mode-map
[(shift tab
)] 'org-shifttab
)
12471 (define-key org-mode-map
[backtab] 'org-shifttab)
12473 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
12474 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
12475 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
12477 ;; Cursor keys with modifiers
12478 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
12479 (org-defkey org-mode-map [(meta right)] 'org-metaright)
12480 (org-defkey org-mode-map [(meta up)] 'org-metaup)
12481 (org-defkey org-mode-map [(meta down)] 'org-metadown)
12483 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
12484 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
12485 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
12486 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
12488 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
12489 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
12490 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
12491 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
12493 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
12494 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
12496 ;;; Extra keys for tty access.
12497 ;; We only set them when really needed because otherwise the
12498 ;; menus don't show the simple keys
12500 (when (or org-use-extra-keys
12501 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
12502 (not window-system))
12503 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
12504 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
12505 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
12506 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
12507 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
12508 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
12509 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
12510 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
12511 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
12512 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
12513 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
12514 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
12515 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
12516 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
12517 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
12518 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
12519 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
12520 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
12521 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
12522 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
12523 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
12524 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
12526 ;; All the other keys
12528 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
12529 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
12530 (if (boundp 'narrow-map)
12531 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
12532 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
12533 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
12534 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
12535 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
12536 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
12537 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
12538 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
12539 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
12540 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
12541 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
12542 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
12543 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
12544 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
12545 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
12546 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
12547 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
12548 (org-defkey org-mode-map "\C-c\\" 'org-tags-sparse-tree) ; Minor-mode res.
12549 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
12550 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
12551 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
12552 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
12553 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
12554 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
12555 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
12556 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
12557 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
12558 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
12559 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
12560 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
12561 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
12562 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
12563 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
12564 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
12565 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
12566 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
12567 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
12568 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
12569 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
12570 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
12571 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
12572 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
12573 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
12574 (org-defkey org-mode-map "\C-c^" 'org-sort)
12575 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
12576 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
12577 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
12578 (org-defkey org-mode-map "\C-m" 'org-return)
12579 (org-defkey org-mode-map "\C-j" 'org-return-indent)
12580 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
12581 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
12582 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
12583 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
12584 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
12585 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
12586 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
12587 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
12588 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
12589 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
12590 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
12591 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
12592 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
12593 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
12594 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
12596 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
12597 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
12598 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
12599 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
12601 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
12602 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
12603 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
12604 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
12605 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
12606 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
12607 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
12608 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
12609 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
12610 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
12611 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
12612 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
12614 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
12615 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
12616 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
12618 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
12620 (when (featurep 'xemacs)
12621 (org-defkey org-mode-map 'button3 'popup-mode-menu))
12623 (defvar org-table-auto-blank-field) ; defined in org-table.el
12624 (defun org-self-insert-command (N)
12625 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
12626 If the cursor is in a table looking at whitespace, the whitespace is
12627 overwritten, and the table is not marked as requiring realignment."
12629 (if (and (org-table-p)
12631 ;; check if we blank the field, and if that triggers align
12632 (and (featurep 'org-table) org-table-auto-blank-field
12633 (member last-command
12634 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
12635 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
12636 ;; got extra space, this field does not determine column width
12637 (let (org-table-may-need-update) (org-table-blank-field))
12638 ;; no extra space, this field may determine column width
12639 (org-table-blank-field)))
12642 (looking-at "[^|\n]* |"))
12643 (let (org-table-may-need-update)
12644 (goto-char (1- (match-end 0)))
12645 (delete-backward-char 1)
12646 (goto-char (match-beginning 0))
12647 (self-insert-command N))
12648 (setq org-table-may-need-update t)
12649 (self-insert-command N)
12650 (org-fix-tags-on-the-fly)))
12652 (defun org-fix-tags-on-the-fly ()
12653 (when (and (equal (char-after (point-at-bol)) ?*)
12654 (org-on-heading-p))
12655 (org-align-tags-here org-tags-column)))
12657 (defun org-delete-backward-char (N)
12658 "Like `delete-backward-char', insert whitespace at field end in tables.
12659 When deleting backwards, in tables this function will insert whitespace in
12660 front of the next \"|\" separator, to keep the table aligned. The table will
12661 still be marked for re-alignment if the field did fill the entire column,
12662 because, in this case the deletion might narrow the column."
12664 (if (and (org-table-p)
12666 (string-match "|" (buffer-substring (point-at-bol) (point)))
12667 (looking-at ".*?|"))
12668 (let ((pos (point))
12669 (noalign (looking-at "[^|\n\r]* |"))
12670 (c org-table-may-need-update))
12671 (backward-delete-char N)
12672 (skip-chars-forward "^|")
12674 (goto-char (1- pos))
12675 ;; noalign: if there were two spaces at the end, this field
12676 ;; does not determine the width of the column.
12677 (if noalign (setq org-table-may-need-update c)))
12678 (backward-delete-char N)
12679 (org-fix-tags-on-the-fly)))
12681 (defun org-delete-char (N)
12682 "Like `delete-char', but insert whitespace at field end in tables.
12683 When deleting characters, in tables this function will insert whitespace in
12684 front of the next \"|\" separator, to keep the table aligned. The table will
12685 still be marked for re-alignment if the field did fill the entire column,
12686 because, in this case the deletion might narrow the column."
12688 (if (and (org-table-p)
12690 (not (= (char-after) ?|))
12692 (if (looking-at ".*?|")
12693 (let ((pos (point))
12694 (noalign (looking-at "[^|\n\r]* |"))
12695 (c org-table-may-need-update))
12696 (replace-match (concat
12697 (substring (match-string 0) 1 -1)
12700 ;; noalign: if there were two spaces at the end, this field
12701 ;; does not determine the width of the column.
12702 (if noalign (setq org-table-may-need-update c)))
12705 (org-fix-tags-on-the-fly)))
12707 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
12708 (put 'org-self-insert-command 'delete-selection t)
12709 (put 'orgtbl-self-insert-command 'delete-selection t)
12710 (put 'org-delete-char 'delete-selection 'supersede)
12711 (put 'org-delete-backward-char 'delete-selection 'supersede)
12713 ;; Make `flyspell-mode' delay after some commands
12714 (put 'org-self-insert-command 'flyspell-delayed t)
12715 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
12716 (put 'org-delete-char 'flyspell-delayed t)
12717 (put 'org-delete-backward-char 'flyspell-delayed t)
12719 ;; Make pabbrev-mode expand after org-mode commands
12720 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
12721 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
12723 ;; How to do this: Measure non-white length of current string
12724 ;; If equal to column width, we should realign.
12726 (defun org-remap (map &rest commands)
12727 "In MAP, remap the functions given in COMMANDS.
12728 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
12731 (setq old (pop commands) new (pop commands))
12732 (if (fboundp 'command-remapping)
12733 (org-defkey map (vector 'remap old) new)
12734 (substitute-key-definition old new map global-map)))))
12736 (when (eq org-enable-table-editor 'optimized)
12737 ;; If the user wants maximum table support, we need to hijack
12738 ;; some standard editing functions
12739 (org-remap org-mode-map
12740 'self-insert-command 'org-self-insert-command
12741 'delete-char 'org-delete-char
12742 'delete-backward-char 'org-delete-backward-char)
12743 (org-defkey org-mode-map "|" 'org-force-self-insert))
12745 (defun org-shiftcursor-error ()
12746 "Throw an error because Shift-Cursor command was applied in wrong context."
12747 (error "This command is active in special context like tables, headlines or timestamps"))
12749 (defun org-shifttab (&optional arg)
12750 "Global visibility cycling or move to previous table field.
12751 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
12753 See the individual commands for more information."
12756 ((org-at-table-p) (call-interactively 'org-table-previous-field))
12758 (message "Content view to level: %d" arg)
12759 (org-content (prefix-numeric-value arg))
12760 (setq org-cycle-global-status 'overview))
12761 (t (call-interactively 'org-global-cycle))))
12763 (defun org-shiftmetaleft ()
12764 "Promote subtree or delete table column.
12765 Calls `org-promote-subtree', `org-outdent-item',
12766 or `org-table-delete-column', depending on context.
12767 See the individual commands for more information."
12770 ((org-at-table-p) (call-interactively 'org-table-delete-column))
12771 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
12772 ((org-at-item-p) (call-interactively 'org-outdent-item))
12773 (t (org-shiftcursor-error))))
12775 (defun org-shiftmetaright ()
12776 "Demote subtree or insert table column.
12777 Calls `org-demote-subtree', `org-indent-item',
12778 or `org-table-insert-column', depending on context.
12779 See the individual commands for more information."
12782 ((org-at-table-p) (call-interactively 'org-table-insert-column))
12783 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
12784 ((org-at-item-p) (call-interactively 'org-indent-item))
12785 (t (org-shiftcursor-error))))
12787 (defun org-shiftmetaup (&optional arg)
12788 "Move subtree up or kill table row.
12789 Calls `org-move-subtree-up' or `org-table-kill-row' or
12790 `org-move-item-up' depending on context. See the individual commands
12791 for more information."
12794 ((org-at-table-p) (call-interactively 'org-table-kill-row))
12795 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
12796 ((org-at-item-p) (call-interactively 'org-move-item-up))
12797 (t (org-shiftcursor-error))))
12798 (defun org-shiftmetadown (&optional arg)
12799 "Move subtree down or insert table row.
12800 Calls `org-move-subtree-down' or `org-table-insert-row' or
12801 `org-move-item-down', depending on context. See the individual
12802 commands for more information."
12805 ((org-at-table-p) (call-interactively 'org-table-insert-row))
12806 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
12807 ((org-at-item-p) (call-interactively 'org-move-item-down))
12808 (t (org-shiftcursor-error))))
12810 (defun org-metaleft (&optional arg)
12811 "Promote heading or move table column to left.
12812 Calls `org-do-promote' or `org-table-move-column', depending on context.
12813 With no specific context, calls the Emacs default `backward-word'.
12814 See the individual commands for more information."
12817 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
12818 ((or (org-on-heading-p) (org-region-active-p))
12819 (call-interactively 'org-do-promote))
12820 ((org-at-item-p) (call-interactively 'org-outdent-item))
12821 (t (call-interactively 'backward-word))))
12823 (defun org-metaright (&optional arg)
12824 "Demote subtree or move table column to right.
12825 Calls `org-do-demote' or `org-table-move-column', depending on context.
12826 With no specific context, calls the Emacs default `forward-word'.
12827 See the individual commands for more information."
12830 ((org-at-table-p) (call-interactively 'org-table-move-column))
12831 ((or (org-on-heading-p) (org-region-active-p))
12832 (call-interactively 'org-do-demote))
12833 ((org-at-item-p) (call-interactively 'org-indent-item))
12834 (t (call-interactively 'forward-word))))
12836 (defun org-metaup (&optional arg)
12837 "Move subtree up or move table row up.
12838 Calls `org-move-subtree-up' or `org-table-move-row' or
12839 `org-move-item-up', depending on context. See the individual commands
12840 for more information."
12843 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
12844 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
12845 ((org-at-item-p) (call-interactively 'org-move-item-up))
12846 (t (transpose-lines 1) (beginning-of-line -1))))
12848 (defun org-metadown (&optional arg)
12849 "Move subtree down or move table row down.
12850 Calls `org-move-subtree-down' or `org-table-move-row' or
12851 `org-move-item-down', depending on context. See the individual
12852 commands for more information."
12855 ((org-at-table-p) (call-interactively 'org-table-move-row))
12856 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
12857 ((org-at-item-p) (call-interactively 'org-move-item-down))
12858 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
12860 (defun org-shiftup (&optional arg)
12861 "Increase item in timestamp or increase priority of current headline.
12862 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
12863 depending on context. See the individual commands for more information."
12866 ((org-at-timestamp-p t)
12867 (call-interactively (if org-edit-timestamp-down-means-later
12868 'org-timestamp-down 'org-timestamp-up)))
12869 ((org-on-heading-p) (call-interactively 'org-priority-up))
12870 ((org-at-item-p) (call-interactively 'org-previous-item))
12871 ((org-clocktable-try-shift 'up arg))
12872 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
12874 (defun org-shiftdown (&optional arg)
12875 "Decrease item in timestamp or decrease priority of current headline.
12876 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
12877 depending on context. See the individual commands for more information."
12880 ((org-at-timestamp-p t)
12881 (call-interactively (if org-edit-timestamp-down-means-later
12882 'org-timestamp-up 'org-timestamp-down)))
12883 ((org-on-heading-p) (call-interactively 'org-priority-down))
12884 ((org-clocktable-try-shift 'down arg))
12885 (t (call-interactively 'org-next-item))))
12887 (defun org-shiftright (&optional arg)
12888 "Cycle the thing at point or in the current line, depending on context.
12889 Depending on context, this does one of the following:
12891 - switch a timestamp at point one day into the future
12892 - on a headline, switch to the next TODO keyword.
12893 - on an item, switch entire list to the next bullet type
12894 - on a property line, switch to the next allowed value
12895 - on a clocktable definition line, move time block into the future"
12898 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
12899 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
12900 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
12901 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
12902 ((org-clocktable-try-shift 'right arg))
12903 (t (org-shiftcursor-error))))
12905 (defun org-shiftleft (&optional arg)
12906 "Cycle the thing at point or in the current line, depending on context.
12907 Depending on context, this does one of the following:
12909 - switch a timestamp at point one day into the past
12910 - on a headline, switch to the previous TODO keyword.
12911 - on an item, switch entire list to the previous bullet type
12912 - on a property line, switch to the previous allowed value
12913 - on a clocktable definition line, move time block into the past"
12916 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
12917 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
12918 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
12919 ((org-at-property-p)
12920 (call-interactively 'org-property-previous-allowed-value))
12921 ((org-clocktable-try-shift 'left arg))
12922 (t (org-shiftcursor-error))))
12924 (defun org-shiftcontrolright ()
12925 "Switch to next TODO set."
12928 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
12929 (t (org-shiftcursor-error))))
12931 (defun org-shiftcontrolleft ()
12932 "Switch to previous TODO set."
12935 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
12936 (t (org-shiftcursor-error))))
12938 (defun org-ctrl-c-ret ()
12939 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
12942 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
12943 (t (call-interactively 'org-insert-heading))))
12945 (defun org-copy-special ()
12946 "Copy region in table or copy current subtree.
12947 Calls `org-table-copy' or `org-copy-subtree', depending on context.
12948 See the individual commands for more information."
12950 (call-interactively
12951 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
12953 (defun org-cut-special ()
12954 "Cut region in table or cut current subtree.
12955 Calls `org-table-copy' or `org-cut-subtree', depending on context.
12956 See the individual commands for more information."
12958 (call-interactively
12959 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
12961 (defun org-paste-special (arg)
12962 "Paste rectangular region into table, or past subtree relative to level.
12963 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
12964 See the individual commands for more information."
12966 (if (org-at-table-p)
12967 (org-table-paste-rectangle)
12968 (org-paste-subtree arg)))
12970 (defun org-edit-special ()
12971 "Call a special editor for the stuff at point.
12972 When at a table, call the formula editor with `org-table-edit-formulas'.
12973 When at the first line of an src example, call `org-edit-src-code'.
12974 When in an #+include line, visit the include file. Otherwise call
12975 `ffap' to visit the file at point."
12979 (call-interactively 'org-table-edit-formulas))
12981 (beginning-of-line 1)
12982 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
12983 (find-file (org-trim (match-string 1))))
12984 ((org-edit-src-code))
12985 ((org-edit-fixed-width-region))
12986 (t (call-interactively 'ffap))))
12988 (defun org-ctrl-c-ctrl-c (&optional arg)
12989 "Set tags in headline, or update according to changed information at point.
12991 This command does many different things, depending on context:
12993 - If the cursor is in a headline, prompt for tags and insert them
12994 into the current line, aligned to `org-tags-column'. When called
12995 with prefix arg, realign all tags in the current buffer.
12997 - If the cursor is in one of the special #+KEYWORD lines, this
12998 triggers scanning the buffer for these lines and updating the
13001 - If the cursor is inside a table, realign the table. This command
13002 works even if the automatic table editor has been turned off.
13004 - If the cursor is on a #+TBLFM line, re-apply the formulas to
13007 - If the cursor is a the beginning of a dynamic block, update it.
13009 - If the cursor is inside a table created by the table.el package,
13010 activate that table.
13012 - If the current buffer is a remember buffer, close note and file
13013 it. A prefix argument of 1 files to the default location
13014 without further interaction. A prefix argument of 2 files to
13015 the currently clocking task.
13017 - If the cursor is on a <<<target>>>, update radio targets and corresponding
13018 links in this buffer.
13020 - If the cursor is on a numbered item in a plain list, renumber the
13023 - If the cursor is on a checkbox, toggle it."
13025 (let ((org-enable-table-editor t))
13027 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
13028 org-occur-highlights
13029 org-latex-fragment-image-overlays)
13030 (and (boundp 'org-clock-overlays) (org-remove-clock-overlays))
13031 (org-remove-occur-highlights)
13032 (org-remove-latex-fragment-image-overlays)
13033 (message "Temporary highlights/overlays removed from current buffer"))
13034 ((and (local-variable-p 'org-finish-function (current-buffer))
13035 (fboundp org-finish-function))
13036 (funcall org-finish-function))
13037 ((org-at-property-p)
13038 (call-interactively 'org-property-action))
13039 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
13040 ((org-on-heading-p) (call-interactively 'org-set-tags))
13041 ((org-at-table.el-p)
13043 (beginning-of-line 1)
13044 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
13045 (call-interactively 'table-recognize-table))
13047 (org-table-maybe-eval-formula)
13049 (call-interactively 'org-table-recalculate)
13050 (org-table-maybe-recalculate-line))
13051 (call-interactively 'org-table-align))
13052 ((org-at-item-checkbox-p)
13053 (call-interactively 'org-toggle-checkbox))
13055 (call-interactively 'org-maybe-renumber-ordered-list))
13056 ((save-excursion (beginning-of-line 1) (looking-at "#\\+BEGIN:"))
13058 (beginning-of-line 1)
13059 (save-excursion (org-update-dblock)))
13060 ((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
13062 ((equal (match-string 1) "TBLFM")
13063 ;; Recalculate the table before this line
13065 (beginning-of-line 1)
13066 (skip-chars-backward " \r\n\t")
13067 (if (org-at-table-p)
13068 (org-call-with-arg 'org-table-recalculate t))))
13070 ; (org-set-regexps-and-options)
13071 ; (org-restart-font-lock)
13072 (let ((org-inhibit-startup t)) (org-mode-restart))
13073 (message "Local setup has been refreshed"))))
13074 (t (error "C-c C-c can do nothing useful at this location.")))))
13076 (defun org-mode-restart ()
13077 "Restart Org-mode, to scan again for special lines.
13078 Also updates the keyword regular expressions."
13081 (message "Org-mode restarted"))
13083 (defun org-kill-note-or-show-branches ()
13084 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
13086 (if (not org-finish-function)
13087 (call-interactively 'show-branches)
13088 (let ((org-note-abort t))
13089 (funcall org-finish-function))))
13091 (defun org-return (&optional indent)
13092 "Goto next table row or insert a newline.
13093 Calls `org-table-next-row' or `newline', depending on context.
13094 See the individual commands for more information."
13097 ((bobp) (if indent (newline-and-indent) (newline)))
13098 ((and (org-at-heading-p)
13100 (org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
13105 (org-table-justify-field-maybe)
13106 (call-interactively 'org-table-next-row))
13107 (t (if indent (newline-and-indent) (newline)))))
13109 (defun org-return-indent ()
13110 "Goto next table row or insert a newline and indent.
13111 Calls `org-table-next-row' or `newline-and-indent', depending on
13112 context. See the individual commands for more information."
13116 (defun org-ctrl-c-star ()
13117 "Compute table, or change heading status of lines.
13118 Calls `org-table-recalculate' or `org-toggle-region-headings',
13119 depending on context. This will also turn a plain list item or a normal
13120 line into a subheading."
13124 (call-interactively 'org-table-recalculate))
13125 ((org-region-active-p)
13126 ;; Convert all lines in region to list items
13127 (call-interactively 'org-toggle-region-headings))
13128 ((org-on-heading-p)
13129 (org-toggle-region-headings (point-at-bol)
13130 (min (1+ (point-at-eol)) (point-max))))
13132 ;; Convert to heading
13133 (let ((level (save-match-data
13135 (condition-case nil
13137 (org-back-to-heading t)
13138 (funcall outline-level))
13141 (concat (make-string (org-get-valid-level level 1) ?*) " ") t t)))
13142 (t (org-toggle-region-headings (point-at-bol)
13143 (min (1+ (point-at-eol)) (point-max))))))
13145 (defun org-ctrl-c-minus ()
13146 "Insert separator line in table or modify bullet status of line.
13147 Also turns a plain line or a region of lines into list items.
13148 Calls `org-table-insert-hline', `org-toggle-region-items', or
13149 `org-cycle-list-bullet', depending on context."
13153 (call-interactively 'org-table-insert-hline))
13154 ((org-on-heading-p)
13157 (beginning-of-line 1)
13158 (if (looking-at "\\*+ ")
13159 (replace-match (concat (make-string (- (match-end 0) (point) 1) ?\ ) "- ")))))
13160 ((org-region-active-p)
13161 ;; Convert all lines in region to list items
13162 (call-interactively 'org-toggle-region-items))
13164 (call-interactively 'org-cycle-list-bullet))
13165 (t (org-toggle-region-items (point-at-bol)
13166 (min (1+ (point-at-eol)) (point-max))))))
13168 (defun org-toggle-region-items (beg end)
13169 "Convert all lines in region to list items.
13170 If the first line is already an item, convert all list items in the region
13176 (setq l2 (org-current-line))
13178 (beginning-of-line 1)
13179 (setq l (1- (org-current-line)))
13180 (if (org-at-item-p)
13181 ;; We already have items, de-itemize
13182 (while (< (setq l (1+ l)) l2)
13183 (when (org-at-item-p)
13184 (goto-char (match-beginning 2))
13185 (delete-region (match-beginning 2) (match-end 2))
13186 (and (looking-at "[ \t]+") (replace-match "")))
13187 (beginning-of-line 2))
13188 (while (< (setq l (1+ l)) l2)
13189 (unless (org-at-item-p)
13190 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
13191 (replace-match "\\1- \\2")))
13192 (beginning-of-line 2))))))
13194 (defun org-toggle-region-headings (beg end)
13195 "Convert all lines in region to list items.
13196 If the first line is already an item, convert all list items in the region
13202 (setq l2 (org-current-line))
13204 (beginning-of-line 1)
13205 (setq l (1- (org-current-line)))
13206 (if (org-on-heading-p)
13207 ;; We already have headlines, de-star them
13208 (while (< (setq l (1+ l)) l2)
13209 (when (org-on-heading-p t)
13210 (and (looking-at outline-regexp) (replace-match "")))
13211 (beginning-of-line 2))
13212 (let* ((stars (save-excursion
13213 (re-search-backward org-complex-heading-regexp nil t)
13214 (or (match-string 1) "*")))
13215 (add-stars (if org-odd-levels-only "**" "*"))
13216 (rpl (concat stars add-stars " \\2")))
13217 (while (< (setq l (1+ l)) l2)
13218 (unless (org-on-heading-p)
13219 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
13220 (replace-match rpl)))
13221 (beginning-of-line 2)))))))
13223 (defun org-meta-return (&optional arg)
13224 "Insert a new heading or wrap a region in a table.
13225 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
13226 See the individual commands for more information."
13230 (call-interactively 'org-table-wrap-region))
13231 (t (call-interactively 'org-insert-heading))))
13235 ;; Define the Org-mode menus
13236 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
13238 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
13239 ["Next Field" org-cycle (org-at-table-p)]
13240 ["Previous Field" org-shifttab (org-at-table-p)]
13241 ["Next Row" org-return (org-at-table-p)]
13243 ["Blank Field" org-table-blank-field (org-at-table-p)]
13244 ["Edit Field" org-table-edit-field (org-at-table-p)]
13245 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
13248 ["Move Column Left" org-metaleft (org-at-table-p)]
13249 ["Move Column Right" org-metaright (org-at-table-p)]
13250 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
13251 ["Insert Column" org-shiftmetaright (org-at-table-p)])
13253 ["Move Row Up" org-metaup (org-at-table-p)]
13254 ["Move Row Down" org-metadown (org-at-table-p)]
13255 ["Delete Row" org-shiftmetaup (org-at-table-p)]
13256 ["Insert Row" org-shiftmetadown (org-at-table-p)]
13257 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
13259 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
13261 ["Copy Rectangle" org-copy-special (org-at-table-p)]
13262 ["Cut Rectangle" org-cut-special (org-at-table-p)]
13263 ["Paste Rectangle" org-paste-special (org-at-table-p)]
13264 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
13267 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
13268 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
13269 ["Edit Formulas" org-edit-special (org-at-table-p)]
13271 ["Recalculate line" org-table-recalculate (org-at-table-p)]
13272 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
13273 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
13275 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
13277 ["Sum Column/Rectangle" org-table-sum
13278 (or (org-at-table-p) (org-region-active-p))]
13279 ["Which Column?" org-table-current-column (org-at-table-p)])
13281 org-table-toggle-formula-debugger
13282 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
13283 ["Show Col/Row Numbers"
13284 org-table-toggle-coordinate-overlays
13286 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
13288 ["Create" org-table-create (and (not (org-at-table-p))
13289 org-enable-table-editor)]
13290 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
13291 ["Import from File" org-table-import (not (org-at-table-p))]
13292 ["Export to File" org-table-export (org-at-table-p)]
13294 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
13296 (easy-menu-define org-org-menu org-mode-map "Org menu"
13299 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
13300 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
13301 ["Sparse Tree..." org-sparse-tree t]
13302 ["Reveal Context" org-reveal t]
13303 ["Show All" show-all t]
13305 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
13307 ["New Heading" org-insert-heading t]
13308 ("Navigate Headings"
13309 ["Up" outline-up-heading t]
13310 ["Next" outline-next-visible-heading t]
13311 ["Previous" outline-previous-visible-heading t]
13312 ["Next Same Level" outline-forward-same-level t]
13313 ["Previous Same Level" outline-backward-same-level t]
13315 ["Jump" org-goto t])
13317 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
13318 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
13320 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
13321 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
13322 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
13324 ["Promote Heading" org-metaleft (not (org-at-table-p))]
13325 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
13326 ["Demote Heading" org-metaright (not (org-at-table-p))]
13327 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
13329 ["Sort Region/Children" org-sort (not (org-at-table-p))]
13331 ["Convert to odd levels" org-convert-to-odd-levels t]
13332 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
13334 ["Emphasis..." org-emphasize t]
13335 ["Edit Source Example" org-edit-special t])
13337 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
13338 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
13339 ; :active t :keys "C-u C-c C-x C-a"]
13340 ["Sparse trees open ARCHIVE trees"
13341 (setq org-sparse-tree-open-archived-trees
13342 (not org-sparse-tree-open-archived-trees))
13343 :style toggle :selected org-sparse-tree-open-archived-trees]
13344 ["Cycling opens ARCHIVE trees"
13345 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
13346 :style toggle :selected org-cycle-open-archived-trees]
13348 ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
13349 ["Move Subtree to Archive" org-advertized-archive-subtree t]
13350 ; ["Check and Move Children" (org-archive-subtree '(4))
13351 ; :active t :keys "C-u C-c C-x C-s"]
13355 ["TODO/DONE/-" org-todo t]
13357 ["Next keyword" org-shiftright (org-on-heading-p)]
13358 ["Previous keyword" org-shiftleft (org-on-heading-p)]
13359 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
13360 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
13361 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
13362 ["Show TODO Tree" org-show-todo-tree t]
13363 ["Global TODO list" org-todo-list t]
13365 ["Set Priority" org-priority t]
13366 ["Priority Up" org-shiftup t]
13367 ["Priority Down" org-shiftdown t])
13368 ("TAGS and Properties"
13369 ["Set Tags" org-set-tags-command t]
13370 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
13372 ["Set property" org-set-property t]
13373 ["Column view of properties" org-columns t]
13374 ["Insert Column View DBlock" org-insert-columns-dblock t])
13375 ("Dates and Scheduling"
13376 ["Timestamp" org-time-stamp t]
13377 ["Timestamp (inactive)" org-time-stamp-inactive t]
13379 ["1 Day Later" org-shiftright t]
13380 ["1 Day Earlier" org-shiftleft t]
13381 ["1 ... Later" org-shiftup t]
13382 ["1 ... Earlier" org-shiftdown t])
13383 ["Compute Time Range" org-evaluate-time-range t]
13384 ["Schedule Item" org-schedule t]
13385 ["Deadline" org-deadline t]
13387 ["Custom time format" org-toggle-time-stamp-overlays
13388 :style radio :selected org-display-custom-times]
13390 ["Goto Calendar" org-goto-calendar t]
13391 ["Date from Calendar" org-date-from-calendar t]
13393 ["Start/restart timer" org-timer-start t]
13394 ["Insert timer string" org-timer t]
13395 ["Insert timer item" org-timer-item t])
13397 ["Clock in" org-clock-in t]
13398 ["Clock out" org-clock-out t]
13399 ["Clock cancel" org-clock-cancel t]
13400 ["Goto running clock" org-clock-goto t]
13401 ["Display times" org-clock-display t]
13402 ["Create clock table" org-clock-report t]
13404 ["Record DONE time"
13405 (progn (setq org-log-done (not org-log-done))
13406 (message "Switching to %s will %s record a timestamp"
13407 (car org-done-keywords)
13408 (if org-log-done "automatically" "not")))
13409 :style toggle :selected org-log-done])
13411 ["Agenda Command..." org-agenda t]
13412 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
13413 ("File List for Agenda")
13414 ("Special views current file"
13415 ["TODO Tree" org-show-todo-tree t]
13416 ["Check Deadlines" org-check-deadlines t]
13417 ["Timeline" org-timeline t]
13418 ["Tags Tree" org-tags-sparse-tree t])
13421 ["Store Link (Global)" org-store-link t]
13422 ["Insert Link" org-insert-link t]
13423 ["Follow Link" org-open-at-point t]
13425 ["Next link" org-next-link t]
13426 ["Previous link" org-previous-link t]
13428 ["Descriptive Links"
13429 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
13431 :selected (member '(org-link) buffer-invisibility-spec)]
13434 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
13436 :selected (not (member '(org-link) buffer-invisibility-spec))])
13438 ["Export/Publish..." org-export t]
13440 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
13441 :selected org-cdlatex-mode]
13442 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
13443 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
13444 ["Modify math symbol" org-cdlatex-math-modify
13445 (org-inside-LaTeX-fragment-p)]
13446 ["Export LaTeX fragments as images"
13447 (if (featurep 'org-exp)
13448 (setq org-export-with-LaTeX-fragments
13449 (not org-export-with-LaTeX-fragments))
13450 (require 'org-exp))
13451 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
13452 org-export-with-LaTeX-fragments)])
13455 ["Show Version" org-version t]
13456 ["Info Documentation" org-info t])
13458 ["Browse Org Group" org-customize t]
13460 ["Expand This Menu" org-create-customize-menu
13461 (fboundp 'customize-menu-create)])
13463 ["Refresh setup" org-mode-restart t]
13466 (defun org-info (&optional node)
13467 "Read documentation for Org-mode in the info system.
13468 With optional NODE, go directly to that node."
13470 (info (format "(org)%s" (or node ""))))
13472 (defun org-install-agenda-files-menu ()
13473 (let ((bl (buffer-list)))
13476 (set-buffer (pop bl))
13477 (if (org-mode-p) (setq bl nil)))
13480 '("Org") "File List for Agenda"
13483 ["Edit File List" (org-edit-agenda-file-list) t]
13484 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
13485 ["Remove Current File from List" org-remove-file t]
13486 ["Cycle through agenda files" org-cycle-agenda-files t]
13487 ["Occur in all agenda files" org-occur-in-agenda-files t]
13489 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
13494 (defun org-require-autoloaded-modules ()
13497 '(org-agenda org-archive org-clock org-colview
13498 org-exp org-id org-export-latex org-publish
13499 org-remember org-table)))
13502 (defun org-customize ()
13503 "Call the customize function with org as argument."
13505 (org-load-modules-maybe)
13506 (org-require-autoloaded-modules)
13507 (customize-browse 'org))
13509 (defun org-create-customize-menu ()
13510 "Create a full customization menu for Org-mode, insert it into the menu."
13512 (org-load-modules-maybe)
13513 (org-require-autoloaded-modules)
13514 (if (fboundp 'customize-menu-create)
13517 '("Org") "Customize"
13518 `(["Browse Org group" org-customize t]
13520 ,(customize-menu-create 'org)
13521 ["Set" Custom-set t]
13522 ["Save" Custom-save t]
13523 ["Reset to Current" Custom-reset-current t]
13524 ["Reset to Saved" Custom-reset-saved t]
13525 ["Reset to Standard Settings" Custom-reset-standard t]))
13526 (message "\"Org\"-menu now contains full customization menu"))
13527 (error "Cannot expand menu (outdated version of cus-edit.el)")))
13529 ;;;; Miscellaneous stuff
13531 ;;; Generally useful functions
13533 (defun org-find-text-property-in-string (prop s)
13534 "Return the first non-nil value of property PROP in string S."
13535 (or (get-text-property 0 prop s)
13536 (get-text-property (or (next-single-property-change 0 prop s) 0)
13539 (defun org-display-warning (message) ;; Copied from Emacs-Muse
13540 "Display the given MESSAGE as a warning."
13541 (if (fboundp 'display-warning)
13542 (display-warning 'org message
13543 (if (featurep 'xemacs)
13546 (let ((buf (get-buffer-create "*Org warnings*")))
13547 (with-current-buffer buf
13548 (goto-char (point-max))
13549 (insert "Warning (Org): " message)
13552 (display-buffer buf)
13555 (defun org-goto-marker-or-bmk (marker &optional bookmark)
13556 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
13557 (if (and marker (marker-buffer marker)
13558 (buffer-live-p (marker-buffer marker)))
13560 (switch-to-buffer (marker-buffer marker))
13561 (if (or (> marker (point-max)) (< marker (point-min)))
13563 (goto-char marker))
13565 (bookmark-jump bookmark)
13566 (error "Cannot find location"))))
13568 (defun org-quote-csv-field (s)
13569 "Quote field for inclusion in CSV material."
13570 (if (string-match "[\",]" s)
13571 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
13574 (defun org-plist-delete (plist property)
13575 "Delete PROPERTY from PLIST.
13576 This is in contrast to merely setting it to 0."
13579 (if (not (eq property (car plist)))
13580 (setq p (plist-put p (car plist) (nth 1 plist))))
13581 (setq plist (cddr plist)))
13584 (defun org-force-self-insert (N)
13585 "Needed to enforce self-insert under remapping."
13587 (self-insert-command N))
13589 (defun org-string-width (s)
13590 "Compute width of string, ignoring invisible characters.
13591 This ignores character with invisibility property `org-link', and also
13592 characters with property `org-cwidth', because these will become invisible
13593 upon the next fontification round."
13595 (when (or (eq t buffer-invisibility-spec)
13596 (assq 'org-link buffer-invisibility-spec))
13597 (while (setq b (text-property-any 0 (length s)
13598 'invisible 'org-link s))
13599 (setq s (concat (substring s 0 b)
13600 (substring s (or (next-single-property-change
13601 b 'invisible s) (length s)))))))
13602 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
13603 (setq s (concat (substring s 0 b)
13604 (substring s (or (next-single-property-change
13605 b 'org-cwidth s) (length s))))))
13606 (setq l (string-width s) b -1)
13607 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
13608 (setq l (- l (get-text-property b 'org-dwidth-n s))))
13611 (defun org-get-indentation (&optional line)
13612 "Get the indentation of the current line, interpreting tabs.
13613 When LINE is given, assume it represents a line and compute its indentation."
13615 (if (string-match "^ *" (org-remove-tabs line))
13618 (beginning-of-line 1)
13619 (skip-chars-forward " \t")
13620 (current-column))))
13622 (defun org-remove-tabs (s &optional width)
13623 "Replace tabulators in S with spaces.
13624 Assumes that s is a single line, starting in column 0."
13625 (setq width (or width tab-width))
13626 (while (string-match "\t" s)
13627 (setq s (replace-match
13629 (- (* width (/ (+ (match-beginning 0) width) width))
13630 (match-beginning 0)) ?\ )
13634 (defun org-fix-indentation (line ind)
13635 "Fix indentation in LINE.
13636 IND is a cons cell with target and minimum indentation.
13637 If the current indentation in LINE is smaller than the minimum,
13638 leave it alone. If it is larger than ind, set it to the target."
13639 (let* ((l (org-remove-tabs line))
13640 (i (org-get-indentation l))
13641 (i1 (car ind)) (i2 (cdr ind)))
13642 (if (>= i i2) (setq l (substring line i2)))
13644 (concat (make-string i1 ?\ ) l)
13647 (defun org-base-buffer (buffer)
13648 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
13651 (or (buffer-base-buffer buffer)
13654 (defun org-trim (s)
13655 "Remove whitespace at beginning and end of string."
13656 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
13657 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
13660 (defun org-wrap (string &optional width lines)
13661 "Wrap string to either a number of lines, or a width in characters.
13662 If WIDTH is non-nil, the string is wrapped to that width, however many lines
13663 that costs. If there is a word longer than WIDTH, the text is actually
13664 wrapped to the length of that word.
13665 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
13666 many lines, whatever width that takes.
13667 The return value is a list of lines, without newlines at the end."
13668 (let* ((words (org-split-string string "[ \t\n]+"))
13669 (maxword (apply 'max (mapcar 'org-string-width words)))
13672 (org-do-wrap words (max maxword width)))
13675 (setq ll (org-do-wrap words maxword))
13676 (if (<= (length ll) lines)
13679 (while (> (length ll) lines)
13681 (setq ll (org-do-wrap words w)))
13683 (t (error "Cannot wrap this")))))
13685 (defun org-do-wrap (words width)
13686 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
13689 (setq line (pop words))
13690 (while (and words (< (+ (length line) (length (car words))) width))
13691 (setq line (concat line " " (pop words))))
13692 (setq lines (push line lines)))
13695 (defun org-split-string (string &optional separators)
13696 "Splits STRING into substrings at SEPARATORS.
13697 No empty strings are returned if there are matches at the beginning
13698 and end of string."
13699 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
13703 (while (and (string-match rexp string
13705 (= start (match-beginning 0))
13706 (< start (length string)))
13708 (< (match-beginning 0) (length string)))
13710 (or (eq (match-beginning 0) 0)
13711 (and (eq (match-beginning 0) (match-end 0))
13712 (eq (match-beginning 0) start))
13714 (cons (substring string start (match-beginning 0))
13716 (setq start (match-end 0)))
13717 (or (eq start (length string))
13719 (cons (substring string start)
13723 (defun org-context ()
13724 "Return a list of contexts of the current cursor position.
13725 If several contexts apply, all are returned.
13726 Each context entry is a list with a symbol naming the context, and
13727 two positions indicating start and end of the context. Possible
13730 :headline anywhere in a headline
13731 :headline-stars on the leading stars in a headline
13732 :todo-keyword on a TODO keyword (including DONE) in a headline
13733 :tags on the TAGS in a headline
13734 :priority on the priority cookie in a headline
13735 :item on the first line of a plain list item
13736 :item-bullet on the bullet/number of a plain list item
13737 :checkbox on the checkbox in a plain list item
13738 :table in an org-mode table
13739 :table-special on a special filed in a table
13740 :table-table in a table.el table
13741 :link on a hyperlink
13742 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
13743 :target on a <<target>>
13744 :radio-target on a <<<radio-target>>>
13745 :latex-fragment on a LaTeX fragment
13746 :latex-preview on a LaTeX fragment with overlayed preview image
13748 This function expects the position to be visible because it uses font-lock
13749 faces as a help to recognize the following contexts: :table-special, :link,
13751 (let* ((f (get-text-property (point) 'face))
13752 (faces (if (listp f) f (list f)))
13753 (p (point)) clist o)
13754 ;; First the large context
13756 ((org-on-heading-p t)
13757 (push (list :headline (point-at-bol) (point-at-eol)) clist)
13759 (beginning-of-line 1)
13760 (looking-at org-todo-line-tags-regexp))
13761 (push (org-point-in-group p 1 :headline-stars) clist)
13762 (push (org-point-in-group p 2 :todo-keyword) clist)
13763 (push (org-point-in-group p 4 :tags) clist))
13765 (skip-chars-backward "^[\n\r \t") (or (eobp) (backward-char 1))
13766 (if (looking-at "\\[#[A-Z0-9]\\]")
13767 (push (org-point-in-group p 0 :priority) clist)))
13770 (push (org-point-in-group p 2 :item-bullet) clist)
13771 (push (list :item (point-at-bol)
13772 (save-excursion (org-end-of-item) (point)))
13774 (and (org-at-item-checkbox-p)
13775 (push (org-point-in-group p 0 :checkbox) clist)))
13778 (push (list :table (org-table-begin) (org-table-end)) clist)
13779 (if (memq 'org-formula faces)
13780 (push (list :table-special
13781 (previous-single-property-change p 'face)
13782 (next-single-property-change p 'face)) clist)))
13783 ((org-at-table-p 'any)
13784 (push (list :table-table) clist)))
13787 ;; Now the small context
13789 ((org-at-timestamp-p)
13790 (push (org-point-in-group p 0 :timestamp) clist))
13791 ((memq 'org-link faces)
13793 (previous-single-property-change p 'face)
13794 (next-single-property-change p 'face)) clist))
13795 ((memq 'org-special-keyword faces)
13796 (push (list :keyword
13797 (previous-single-property-change p 'face)
13798 (next-single-property-change p 'face)) clist))
13800 (push (org-point-in-group p 0 :target) clist)
13801 (goto-char (1- (match-beginning 0)))
13802 (if (looking-at org-radio-target-regexp)
13803 (push (org-point-in-group p 0 :radio-target) clist))
13805 ((setq o (car (delq nil
13808 (if (memq x org-latex-fragment-image-overlays) x))
13809 (org-overlays-at (point))))))
13810 (push (list :latex-fragment
13811 (org-overlay-start o) (org-overlay-end o)) clist)
13812 (push (list :latex-preview
13813 (org-overlay-start o) (org-overlay-end o)) clist))
13814 ((org-inside-LaTeX-fragment-p)
13815 ;; FIXME: positions wrong.
13816 (push (list :latex-fragment (point) (point)) clist)))
13818 (setq clist (nreverse (delq nil clist)))
13821 ;; FIXME: Compare with at-regexp-p Do we need both?
13822 (defun org-in-regexp (re &optional nlines visually)
13823 "Check if point is inside a match of regexp.
13824 Normally only the current line is checked, but you can include NLINES extra
13825 lines both before and after point into the search.
13826 If VISUALLY is set, require that the cursor is not after the match but
13827 really on, so that the block visually is on the match."
13829 (let ((pos (point))
13830 (eol (point-at-eol (+ 1 (or nlines 0))))
13831 (inc (if visually 1 0)))
13833 (beginning-of-line (- 1 (or nlines 0)))
13834 (while (re-search-forward re eol t)
13835 (if (and (<= (match-beginning 0) pos)
13836 (>= (+ inc (match-end 0)) pos))
13837 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
13839 (defun org-at-regexp-p (regexp)
13840 "Is point inside a match of REGEXP in the current line?"
13843 (let ((pos (point)) (end (point-at-eol)))
13844 (beginning-of-line 1)
13845 (while (re-search-forward regexp end t)
13846 (if (and (<= (match-beginning 0) pos)
13847 (>= (match-end 0) pos))
13851 (defun org-occur-in-agenda-files (regexp &optional nlines)
13852 "Call `multi-occur' with buffers for all agenda files."
13853 (interactive "sOrg-files matching: \np")
13854 (let* ((files (org-agenda-files))
13855 (tnames (mapcar 'file-truename files))
13856 (extra org-agenda-text-search-extra-files)
13858 (when (eq (car extra) 'agenda-archives)
13859 (setq extra (cdr extra))
13860 (setq files (org-add-archive-files files)))
13861 (while (setq f (pop extra))
13862 (unless (member (file-truename f) tnames)
13863 (add-to-list 'files f 'append)
13864 (add-to-list 'tnames (file-truename f) 'append)))
13866 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
13869 (if (boundp 'occur-mode-find-occurrence-hook)
13871 (add-hook 'occur-mode-find-occurrence-hook
13876 (defadvice occur-mode-goto-occurrence
13877 (after org-occur-reveal activate)
13878 (and (org-mode-p) (org-reveal)))
13879 (defadvice occur-mode-goto-occurrence-other-window
13880 (after org-occur-reveal activate)
13881 (and (org-mode-p) (org-reveal)))
13882 (defadvice occur-mode-display-occurrence
13883 (after org-occur-reveal activate)
13885 (let ((pos (occur-mode-find-occurrence)))
13886 (with-current-buffer (marker-buffer pos)
13891 (defun org-uniquify (list)
13892 "Remove duplicate elements from LIST."
13894 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
13897 (defun org-delete-all (elts list)
13898 "Remove all elements in ELTS from LIST."
13900 (setq list (delete (pop elts) list)))
13903 (defun org-back-over-empty-lines ()
13904 "Move backwards over whitespace, to the beginning of the first empty line.
13905 Returns the number of empty lines passed."
13906 (let ((pos (point)))
13907 (skip-chars-backward " \t\n\r")
13908 (beginning-of-line 2)
13909 (goto-char (min (point) pos))
13910 (count-lines (point) pos)))
13912 (defun org-skip-whitespace ()
13913 (skip-chars-forward " \t\n\r"))
13915 (defun org-point-in-group (point group &optional context)
13916 "Check if POINT is in match-group GROUP.
13917 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
13918 match. If the match group does ot exist or point is not inside it,
13920 (and (match-beginning group)
13921 (>= point (match-beginning group))
13922 (<= point (match-end group))
13924 (list context (match-beginning group) (match-end group))
13927 (defun org-switch-to-buffer-other-window (&rest args)
13928 "Switch to buffer in a second window on the current frame.
13929 In particular, do not allow pop-up frames."
13930 (let (pop-up-frames special-display-buffer-names special-display-regexps
13931 special-display-function)
13932 (apply 'switch-to-buffer-other-window args)))
13934 (defun org-combine-plists (&rest plists)
13935 "Create a single property list from all plists in PLISTS.
13936 The process starts by copying the first list, and then setting properties
13937 from the other lists. Settings in the last list are the most significant
13938 ones and overrule settings in the other lists."
13939 (let ((rtn (copy-sequence (pop plists)))
13942 (setq ls (pop plists))
13944 (setq p (pop ls) v (pop ls))
13945 (setq rtn (plist-put rtn p v))))
13948 (defun org-move-line-down (arg)
13949 "Move the current line down. With prefix argument, move it past ARG lines."
13951 (let ((col (current-column))
13953 (beginning-of-line 1) (setq beg (point))
13954 (beginning-of-line 2) (setq end (point))
13955 (beginning-of-line (+ 1 arg))
13956 (setq pos (move-marker (make-marker) (point)))
13957 (insert (delete-and-extract-region beg end))
13959 (org-move-to-column col)))
13961 (defun org-move-line-up (arg)
13962 "Move the current line up. With prefix argument, move it past ARG lines."
13964 (let ((col (current-column))
13966 (beginning-of-line 1) (setq beg (point))
13967 (beginning-of-line 2) (setq end (point))
13968 (beginning-of-line (- arg))
13969 (setq pos (move-marker (make-marker) (point)))
13970 (insert (delete-and-extract-region beg end))
13972 (org-move-to-column col)))
13974 (defun org-replace-escapes (string table)
13975 "Replace %-escapes in STRING with values in TABLE.
13976 TABLE is an association list with keys like \"%a\" and string values.
13977 The sequences in STRING may contain normal field width and padding information,
13978 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
13979 so values can contain further %-escapes if they are define later in TABLE."
13980 (let ((case-fold-search nil)
13982 (while (setq e (pop table))
13983 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
13984 (while (string-match re string)
13985 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
13987 (setq string (replace-match rpl t t string))))
13991 (defun org-sublist (list start end)
13992 "Return a section of LIST, from START to END.
13993 Counting starts at 1."
13994 (let (rtn (c start))
13995 (setq list (nthcdr (1- start) list))
13996 (while (and list (<= c end))
13997 (push (pop list) rtn)
14001 (defun org-find-base-buffer-visiting (file)
14002 "Like `find-buffer-visiting' but alway return the base buffer and
14003 not an indirect buffer."
14004 (let ((buf (find-buffer-visiting file)))
14006 (or (buffer-base-buffer buf) buf)
14009 (defun org-image-file-name-regexp ()
14010 "Return regexp matching the file names of images."
14011 (if (fboundp 'image-file-name-regexp)
14012 (image-file-name-regexp)
14013 (let ((image-file-name-extensions
14014 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
14015 "xbm" "xpm" "pbm" "pgm" "ppm")))
14017 (regexp-opt (nconc (mapcar 'upcase
14018 image-file-name-extensions)
14019 image-file-name-extensions)
14023 (defun org-file-image-p (file)
14024 "Return non-nil if FILE is an image."
14026 (string-match (org-image-file-name-regexp) file)))
14028 (defun org-get-cursor-date ()
14029 "Return the date at cursor in as a time.
14030 This works in the calendar and in the agenda, anywhere else it just
14031 returns the current time."
14032 (let (date day defd)
14034 ((eq major-mode 'calendar-mode)
14035 (setq date (calendar-cursor-to-date)
14036 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14037 ((eq major-mode 'org-agenda-mode)
14038 (setq day (get-text-property (point) 'day))
14040 (setq date (calendar-gregorian-from-absolute day)
14041 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
14043 (or defd (current-time))))
14045 (defvar org-agenda-action-marker (make-marker)
14046 "Marker pointing to the entry for the next agenda action.")
14048 (defun org-mark-entry-for-agenda-action ()
14049 "Mark the current entry as target of an agenda action.
14050 Agenda actions are actions executed from the agenda with the key `k',
14051 which make use of the date at the cursor."
14053 (move-marker org-agenda-action-marker
14054 (save-excursion (org-back-to-heading t) (point))
14057 "Entry marked for action; press `k' at desired date in agenda or calendar"))
14059 ;;; Paragraph filling stuff.
14060 ;; We want this to be just right, so use the full arsenal.
14062 (defun org-indent-line-function ()
14063 "Indent line like previous, but further if previous was headline or item."
14065 (let* ((pos (point))
14066 (itemp (org-at-item-p))
14067 column bpos bcol tpos tcol bullet btype bullet-type)
14068 ;; Find the previous relevant line
14069 (beginning-of-line 1)
14071 ((looking-at "#") (setq column 0))
14072 ((looking-at "\\*+ ") (setq column 0))
14074 (beginning-of-line 0)
14075 (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]"))
14076 (beginning-of-line 0))
14078 ((looking-at "\\*+[ \t]+")
14079 (if (not org-adapt-indentation)
14081 (goto-char (match-end 0))
14082 (setq column (current-column))))
14084 (org-beginning-of-item)
14085 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
14086 (setq bpos (match-beginning 1) tpos (match-end 0)
14087 bcol (progn (goto-char bpos) (current-column))
14088 tcol (progn (goto-char tpos) (current-column))
14089 bullet (match-string 1)
14090 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
14091 (if (> tcol (+ bcol org-description-max-indent))
14092 (setq tcol (+ bcol 5)))
14096 (beginning-of-line 1)
14097 (if (looking-at "\\S-")
14099 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*")
14100 (setq bullet (match-string 1)
14101 btype (if (string-match "[0-9]" bullet) "n" bullet))
14102 (setq column (if (equal btype bullet-type) bcol tcol)))
14103 (setq column (org-get-indentation)))))
14104 (t (setq column (org-get-indentation))))))
14106 (if (<= (current-column) (current-indentation))
14107 (org-indent-line-to column)
14108 (save-excursion (org-indent-line-to column)))
14109 (setq column (current-column))
14110 (beginning-of-line 1)
14112 "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
14113 (replace-match (concat "\\1" (format org-property-format
14114 (match-string 2) (match-string 3)))
14116 (org-move-to-column column)))
14118 (defun org-set-autofill-regexps ()
14120 ;; In the paragraph separator we include headlines, because filling
14121 ;; text in a line directly attached to a headline would otherwise
14122 ;; fill the headline as well.
14123 (org-set-local 'comment-start-skip "^#+[ \t]*")
14124 (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|]")
14125 ;; The paragraph starter includes hand-formatted lists.
14126 (org-set-local 'paragraph-start
14127 "\f\\|[ ]*$\\|\\*+ \\|\f\\|[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
14128 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
14129 ;; But only if the user has not turned off tables or fixed-width regions
14131 'auto-fill-inhibit-regexp
14132 (concat "\\*+ \\|#\\+"
14133 "\\|[ \t]*" org-keyword-time-regexp
14134 (if (or org-enable-table-editor org-enable-fixed-width-editor)
14137 (if org-enable-table-editor "|" "")
14138 (if org-enable-fixed-width-editor ":" "")
14140 ;; We use our own fill-paragraph function, to make sure that tables
14141 ;; and fixed-width regions are not wrapped. That function will pass
14142 ;; through to `fill-paragraph' when appropriate.
14143 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
14144 ; Adaptive filling: To get full control, first make sure that
14145 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
14146 (org-set-local 'adaptive-fill-regexp "\000")
14147 (org-set-local 'adaptive-fill-function
14148 'org-adaptive-fill-function)
14150 'align-mode-rules-list
14151 '((org-in-buffer-settings
14152 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
14153 (modes . '(org-mode))))))
14155 (defun org-fill-paragraph (&optional justify)
14156 "Re-align a table, pass through to fill-paragraph if no table."
14157 (let ((table-p (org-at-table-p))
14158 (table.el-p (org-at-table.el-p)))
14159 (cond ((and (equal (char-after (point-at-bol)) ?*)
14160 (save-excursion (goto-char (point-at-bol))
14161 (looking-at outline-regexp)))
14162 t) ; skip headlines
14163 (table.el-p t) ; skip table.el tables
14164 (table-p (org-table-align) t) ; align org-mode tables
14165 (t nil)))) ; call paragraph-fill
14167 ;; For reference, this is the default value of adaptive-fill-regexp
14168 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
14170 (defun org-adaptive-fill-function ()
14171 "Return a fill prefix for org-mode files.
14172 In particular, this makes sure hanging paragraphs for hand-formatted lists
14174 (cond ((looking-at "#[ \t]+")
14176 ((looking-at "[ \t]*\\([-*+] .*? :: \\)")
14178 (if (> (match-end 1) (+ (match-beginning 1)
14179 org-description-max-indent))
14180 (goto-char (+ (match-beginning 1) 5))
14181 (goto-char (match-end 0)))
14182 (make-string (current-column) ?\ )))
14183 ((looking-at "[ \t]*\\([-*+] \\|[0-9]+[.)] ?\\)?")
14185 (goto-char (match-end 0))
14186 (make-string (current-column) ?\ )))
14191 (defun org-toggle-fixed-width-section (arg)
14192 "Toggle the fixed-width export.
14193 If there is no active region, the QUOTE keyword at the current headline is
14194 inserted or removed. When present, it causes the text between this headline
14195 and the next to be exported as fixed-width text, and unmodified.
14196 If there is an active region, this command adds or removes a colon as the
14197 first character of this line. If the first character of a line is a colon,
14198 this line is also exported in fixed-width font."
14201 (regionp (org-region-active-p))
14202 (beg (if regionp (region-beginning) (point)))
14203 (end (if regionp (region-end)))
14204 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
14205 (case-fold-search nil)
14206 (re "[ \t]*\\(:\\)")
14211 (setq cc (current-column))
14212 (beginning-of-line 1)
14213 (setq off (looking-at re))
14214 (while (> nlines 0)
14215 (setq nlines (1- nlines))
14216 (beginning-of-line 1)
14219 (org-move-to-column cc t)
14222 ((and off (looking-at re))
14223 (replace-match "" t t nil 1))
14224 ((not off) (org-move-to-column cc t) (insert ":")))
14227 (org-back-to-heading)
14228 (if (looking-at (concat outline-regexp
14229 "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
14230 (replace-match "" t t nil 1)
14231 (if (looking-at outline-regexp)
14233 (goto-char (match-end 0))
14234 (insert org-quote-string " "))))))))
14236 ;;;; Functions extending outline functionality
14238 (defun org-beginning-of-line (&optional arg)
14239 "Go to the beginning of the current line. If that is invisible, continue
14240 to a visible line beginning. This makes the function of C-a more intuitive.
14241 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
14242 first attempt, and only move to after the tags when the cursor is already
14243 beyond the end of the headline."
14245 (let ((pos (point)) refpos)
14246 (beginning-of-line 1)
14250 (if (org-invisible-p)
14251 (while (and (not (bobp)) (org-invisible-p))
14253 (beginning-of-line 1))
14255 (when org-special-ctrl-a/e
14257 ((and (looking-at org-complex-heading-regexp)
14258 (= (char-after (match-end 1)) ?\ ))
14259 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
14262 (if (eq org-special-ctrl-a/e t)
14263 (cond ((> pos refpos) refpos)
14264 ((= pos (point)) refpos)
14266 (cond ((> pos (point)) (point))
14267 ((not (eq last-command this-command)) (point))
14271 (if (eq org-special-ctrl-a/e t)
14272 (cond ((> pos (match-end 4)) (match-end 4))
14273 ((= pos (point)) (match-end 4))
14275 (cond ((> pos (point)) (point))
14276 ((not (eq last-command this-command)) (point))
14277 (t (match-end 4))))))))
14279 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
14281 (defun org-end-of-line (&optional arg)
14282 "Go to the end of the line.
14283 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
14284 first attempt, and only move to after the tags when the cursor is already
14285 beyond the end of the headline."
14287 (if (or (not org-special-ctrl-a/e)
14288 (not (org-on-heading-p)))
14290 (let ((pos (point)))
14291 (beginning-of-line 1)
14292 (if (looking-at (org-re ".*?\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
14293 (if (eq org-special-ctrl-a/e t)
14294 (if (or (< pos (match-beginning 1))
14295 (= pos (match-end 0)))
14296 (goto-char (match-beginning 1))
14297 (goto-char (match-end 0)))
14298 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
14299 (goto-char (match-end 0))
14300 (goto-char (match-beginning 1))))
14301 (end-of-line arg))))
14303 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
14306 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
14307 (define-key org-mode-map "\C-e" 'org-end-of-line)
14309 (defun org-kill-line (&optional arg)
14310 "Kill line, to tags or end of line."
14313 ((or (not org-special-ctrl-k)
14315 (not (org-on-heading-p)))
14316 (call-interactively 'kill-line))
14317 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$"))
14318 (kill-region (point) (match-beginning 1))
14319 (org-set-tags nil t))
14320 (t (kill-region (point) (point-at-eol)))))
14322 (define-key org-mode-map "\C-k" 'org-kill-line)
14324 (defun org-yank (&optional arg)
14325 "Yank. If the kill is a subtree, treat it specially.
14326 This command will look at the current kill and check if is a single
14327 subtree, or a series of subtrees[1]. If it passes the test, and if the
14328 cursor is at the beginning of a line or after the stars of a currently
14329 empty headline, then the yank is handled specially. How exactly depends
14330 on the value of the following variables, both set by default.
14332 org-yank-folded-subtrees
14333 When set, the subtree(s) will be folded after insertion, but only
14334 if doing so would now swallow text after the yanked text.
14336 org-yank-adjusted-subtrees
14337 When set, the subtree will be promoted or demoted in order to
14338 fit into the local outline tree structure, which means that the level
14339 will be adjusted so that it becomes the smaller one of the two
14340 *visible* surrounding headings.
14342 Any prefix to this command will cause `yank' to be called directly with
14343 no special treatment. In particular, a simple `C-u' prefix will just
14344 plainly yank the text as it is.
14346 \[1] Basically, the test checks if the first non-white line is a heading
14347 and if there are no other headings with fewer stars."
14349 (setq this-command 'yank)
14351 (call-interactively 'yank)
14352 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
14353 (and (org-kill-is-subtree-p)
14355 (and (looking-at "[ \t]*$")
14358 (buffer-substring (point-at-bol) (point)))))))
14361 ((and subtreep org-yank-folded-subtrees)
14362 (let ((beg (point))
14364 (if (and subtreep org-yank-adjusted-subtrees)
14365 (org-paste-subtree nil nil 'for-yank)
14366 (call-interactively 'yank))
14369 (when (and (bolp) subtreep
14370 (not (setq swallowp
14371 (org-yank-folding-would-swallow-text beg end))))
14372 (or (looking-at outline-regexp)
14373 (re-search-forward (concat "^" outline-regexp) end t))
14374 (while (and (< (point) end) (looking-at outline-regexp))
14376 (org-cycle-show-empty-lines 'folded)
14377 (condition-case nil
14378 (outline-forward-same-level 1)
14379 (error (goto-char end)))))
14382 "Yanked text not folded because that would swallow text"))
14384 (skip-chars-forward " \t\n\r")
14385 (beginning-of-line 1)
14386 (push-mark beg 'nomsg)))
14387 ((and subtreep org-yank-adjusted-subtrees)
14388 (let ((beg (point-at-bol)))
14389 (org-paste-subtree nil nil 'for-yank)
14390 (push-mark beg 'nomsg)))
14392 (call-interactively 'yank))))))
14394 (defun org-yank-folding-would-swallow-text (beg end)
14395 "Would hide-subtree at BEG swallow any text after END?"
14399 (when (or (looking-at outline-regexp)
14400 (re-search-forward (concat "^" outline-regexp) end t))
14401 (setq level (org-outline-level)))
14403 (skip-chars-forward " \t\r\n\v\f")
14405 (and (bolp) (looking-at org-outline-regexp)
14406 (<= (org-outline-level) level)))
14407 nil ; Nothing would be swallowed
14408 t)))) ; something would swallow
14410 (define-key org-mode-map "\C-y" 'org-yank)
14412 (defun org-invisible-p ()
14413 "Check if point is at a character currently not visible."
14414 ;; Early versions of noutline don't have `outline-invisible-p'.
14415 (if (fboundp 'outline-invisible-p)
14416 (outline-invisible-p)
14417 (get-char-property (point) 'invisible)))
14419 (defun org-invisible-p2 ()
14420 "Check if point is at a character currently not visible."
14422 (if (and (eolp) (not (bobp))) (backward-char 1))
14423 ;; Early versions of noutline don't have `outline-invisible-p'.
14424 (if (fboundp 'outline-invisible-p)
14425 (outline-invisible-p)
14426 (get-char-property (point) 'invisible))))
14428 (defun org-back-to-heading (&optional invisible-ok)
14429 "Call `outline-back-to-heading', but provide a better error message."
14430 (condition-case nil
14431 (outline-back-to-heading invisible-ok)
14432 (error (error "Before first headline at position %d in buffer %s"
14433 (point) (current-buffer)))))
14435 (defun org-before-first-heading-p ()
14436 "Before first heading?"
14438 (null (re-search-backward "^\\*+ " nil t))))
14440 (defalias 'org-on-heading-p 'outline-on-heading-p)
14441 (defalias 'org-at-heading-p 'outline-on-heading-p)
14442 (defun org-at-heading-or-item-p ()
14443 (or (org-on-heading-p) (org-at-item-p)))
14445 (defun org-on-target-p ()
14446 (or (org-in-regexp org-radio-target-regexp)
14447 (org-in-regexp org-target-regexp)))
14449 (defun org-up-heading-all (arg)
14450 "Move to the heading line of which the present line is a subheading.
14451 This function considers both visible and invisible heading lines.
14452 With argument, move up ARG levels."
14453 (if (fboundp 'outline-up-heading-all)
14454 (outline-up-heading-all arg) ; emacs 21 version of outline.el
14455 (outline-up-heading arg t))) ; emacs 22 version of outline.el
14457 (defun org-up-heading-safe ()
14458 "Move to the heading line of which the present line is a subheading.
14459 This version will not throw an error. It will return the level of the
14460 headline found, or nil if no higher level is found."
14461 (let (start-level re)
14462 (org-back-to-heading t)
14463 (setq start-level (funcall outline-level))
14464 (if (equal start-level 1)
14466 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
14467 (if (re-search-backward re nil t)
14468 (funcall outline-level)))))
14470 (defun org-first-sibling-p ()
14471 "Is this heading the first child of its parents?"
14473 (let ((re (concat "^" outline-regexp))
14475 (unless (org-at-heading-p t)
14476 (error "Not at a heading"))
14477 (setq level (funcall outline-level))
14479 (if (not (re-search-backward re nil t))
14481 (setq l (funcall outline-level))
14484 (defun org-goto-sibling (&optional previous)
14485 "Goto the next sibling, even if it is invisible.
14486 When PREVIOUS is set, go to the previous sibling instead. Returns t
14487 when a sibling was found. When none is found, return nil and don't
14489 (let ((fun (if previous 're-search-backward 're-search-forward))
14491 (re (concat "^" outline-regexp))
14493 (when (condition-case nil (org-back-to-heading t) (error nil))
14494 (setq level (funcall outline-level))
14496 (or previous (forward-char 1))
14497 (while (funcall fun re nil t)
14498 (setq l (funcall outline-level))
14499 (when (< l level) (goto-char pos) (throw 'exit nil))
14500 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
14504 (defun org-show-siblings ()
14505 "Show all siblings of the current headline."
14507 (while (org-goto-sibling) (org-flag-heading nil)))
14509 (while (org-goto-sibling 'previous)
14510 (org-flag-heading nil))))
14512 (defun org-show-hidden-entry ()
14513 "Show an entry where even the heading is hidden."
14517 (defun org-flag-heading (flag &optional entry)
14518 "Flag the current heading. FLAG non-nil means make invisible.
14519 When ENTRY is non-nil, show the entire entry."
14521 (org-back-to-heading t)
14522 ;; Check if we should show the entire entry
14527 (and (outline-next-heading)
14528 (org-flag-heading nil))))
14529 (outline-flag-region (max (point-min) (1- (point)))
14530 (save-excursion (outline-end-of-heading) (point))
14533 (defun org-forward-same-level (arg)
14534 "Move forward to the ARG'th subheading at same level as this one.
14535 Stop at the first and last subheadings of a superior heading.
14536 This is like outline-forward-same-level, but invisible headings are ok."
14538 (org-back-to-heading t)
14540 (let ((point-to-move-to (save-excursion
14541 (org-get-next-sibling))))
14542 (if point-to-move-to
14544 (goto-char point-to-move-to)
14545 (setq arg (1- arg)))
14548 (error "No following same-level heading"))))))
14550 (defun org-get-next-sibling ()
14551 "Move to next heading of the same level, and return point.
14552 If there is no such heading, return nil.
14553 This is like outline-next-sibling, but invisible headings are ok."
14554 (let ((level (funcall outline-level)))
14555 (outline-next-heading)
14556 (while (and (not (eobp)) (> (funcall outline-level) level))
14557 (outline-next-heading))
14558 (if (or (eobp) (< (funcall outline-level) level))
14562 (defun org-end-of-subtree (&optional invisible-OK to-heading)
14563 ;; This is an exact copy of the original function, but it uses
14564 ;; `org-back-to-heading', to make it work also in invisible
14565 ;; trees. And is uses an invisible-OK argument.
14566 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
14567 (org-back-to-heading invisible-OK)
14569 (level (funcall outline-level)))
14570 (while (and (not (eobp))
14571 (or first (> (funcall outline-level) level)))
14573 (outline-next-heading))
14575 (if (memq (preceding-char) '(?\n ?\^M))
14577 ;; Go to end of line before heading
14579 (if (memq (preceding-char) '(?\n ?\^M))
14580 ;; leave blank line before heading
14581 (forward-char -1))))))
14584 (defun org-show-subtree ()
14585 "Show everything after this heading at deeper levels."
14586 (outline-flag-region
14589 (outline-end-of-subtree) (outline-next-heading) (point))
14592 (defun org-show-entry ()
14593 "Show the body directly following this heading.
14594 Show the heading too, if it is currently invisible."
14597 (condition-case nil
14599 (org-back-to-heading t)
14600 (outline-flag-region
14601 (max (point-min) (1- (point)))
14604 (concat "[\r\n]\\(" outline-regexp "\\)") nil 'move)
14605 (or (match-beginning 1) (point-max)))
14609 (defun org-make-options-regexp (kwds)
14610 "Make a regular expression for keyword lines."
14614 (mapconcat 'regexp-quote kwds "\\|")
14618 ;; Make isearch reveal the necessary context
14619 (defun org-isearch-end ()
14620 "Reveal context after isearch exits."
14621 (when isearch-success ; only if search was successful
14622 (if (featurep 'xemacs)
14623 ;; Under XEmacs, the hook is run in the correct place,
14624 ;; we directly show the context.
14625 (org-show-context 'isearch)
14626 ;; In Emacs the hook runs *before* restoring the overlays.
14627 ;; So we have to use a one-time post-command-hook to do this.
14628 ;; (Emacs 22 has a special variable, see function `org-mode')
14629 (unless (and (boundp 'isearch-mode-end-hook-quit)
14630 isearch-mode-end-hook-quit)
14631 ;; Only when the isearch was not quitted.
14632 (org-add-hook 'post-command-hook 'org-isearch-post-command
14633 'append 'local)))))
14635 (defun org-isearch-post-command ()
14636 "Remove self from hook, and show context."
14637 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
14638 (org-show-context 'isearch))
14641 ;;;; Integration with and fixes for other packages
14645 (defvar org-imenu-markers nil
14646 "All markers currently used by Imenu.")
14647 (make-variable-buffer-local 'org-imenu-markers)
14649 (defun org-imenu-new-marker (&optional pos)
14650 "Return a new marker for use by Imenu, and remember the marker."
14651 (let ((m (make-marker)))
14652 (move-marker m (or pos (point)))
14653 (push m org-imenu-markers)
14656 (defun org-imenu-get-tree ()
14657 "Produce the index for Imenu."
14658 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
14659 (setq org-imenu-markers nil)
14660 (let* ((n org-imenu-depth)
14661 (re (concat "^" outline-regexp))
14662 (subs (make-vector (1+ n) nil))
14668 (goto-char (point-max))
14669 (while (re-search-backward re nil t)
14670 (setq level (org-reduced-level (funcall outline-level)))
14672 (looking-at org-complex-heading-regexp)
14673 (setq head (org-link-display-format
14674 (org-match-string-no-properties 4))
14675 m (org-imenu-new-marker))
14676 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
14677 (if (>= level last-level)
14678 (push (cons head m) (aref subs level))
14679 (push (cons head (aref subs (1+ level))) (aref subs level))
14680 (loop for i from (1+ level) to n do (aset subs i nil)))
14681 (setq last-level level)))))
14684 (eval-after-load "imenu"
14686 (add-hook 'imenu-after-jump-hook
14688 (if (eq major-mode 'org-mode)
14689 (org-show-context 'org-goto))))))
14691 (defun org-link-display-format (link)
14692 "Replace a link with either the description, or the link target
14693 if no description is present"
14695 (if (string-match org-bracket-link-analytic-regexp link)
14696 (replace-match (or (match-string 5 link)
14697 (concat (match-string 1 link)
14698 (match-string 3 link)))
14702 ;; Speedbar support
14704 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
14705 "Overlay marking the agenda restriction line in speedbar.")
14706 (org-overlay-put org-speedbar-restriction-lock-overlay
14707 'face 'org-agenda-restriction-lock)
14708 (org-overlay-put org-speedbar-restriction-lock-overlay
14709 'help-echo "Agendas are currently limited to this item.")
14710 (org-detach-overlay org-speedbar-restriction-lock-overlay)
14712 (defun org-speedbar-set-agenda-restriction ()
14713 "Restrict future agenda commands to the location at point in speedbar.
14714 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
14716 (require 'org-agenda)
14717 (let (p m tp np dir txt w)
14719 ((setq p (text-property-any (point-at-bol) (point-at-eol)
14721 (setq m (get-text-property p 'org-imenu-marker))
14724 (set-buffer (marker-buffer m))
14726 (org-agenda-set-restriction-lock 'subtree))))
14727 ((setq p (text-property-any (point-at-bol) (point-at-eol)
14728 'speedbar-function 'speedbar-find-file))
14729 (setq tp (previous-single-property-change
14730 (1+ p) 'speedbar-function)
14731 np (next-single-property-change
14732 tp 'speedbar-function)
14733 dir (speedbar-line-directory)
14734 txt (buffer-substring-no-properties (or tp (point-min))
14735 (or np (point-max))))
14738 (set-buffer (find-file-noselect
14739 (let ((default-directory dir))
14740 (expand-file-name txt))))
14741 (unless (org-mode-p)
14742 (error "Cannot restrict to non-Org-mode file"))
14743 (org-agenda-set-restriction-lock 'file))))
14744 (t (error "Don't know how to restrict Org-mode's agenda")))
14745 (org-move-overlay org-speedbar-restriction-lock-overlay
14746 (point-at-bol) (point-at-eol))
14747 (setq current-prefix-arg nil)
14748 (org-agenda-maybe-redo)))
14750 (eval-after-load "speedbar"
14752 (speedbar-add-supported-extension ".org")
14753 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
14754 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
14755 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
14756 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
14757 (add-hook 'speedbar-visiting-tag-hook
14758 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
14761 ;;; Fixes and Hacks for problems with other packages
14763 ;; Make flyspell not check words in links, to not mess up our keymap
14764 (defun org-mode-flyspell-verify ()
14765 "Don't let flyspell put overlays at active buttons."
14766 (not (get-text-property (point) 'keymap)))
14768 ;; Make `bookmark-jump' show the jump location if it was hidden.
14769 (eval-after-load "bookmark"
14770 '(if (boundp 'bookmark-after-jump-hook)
14771 ;; We can use the hook
14772 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
14773 ;; Hook not available, use advice
14774 (defadvice bookmark-jump (after org-make-visible activate)
14775 "Make the position visible."
14776 (org-bookmark-jump-unhide))))
14778 ;; Make sure saveplace show the location if it was hidden
14779 (eval-after-load "saveplace"
14780 '(defadvice save-place-find-file-hook (after org-make-visible activate)
14781 "Make the position visible."
14782 (org-bookmark-jump-unhide)))
14784 (defun org-bookmark-jump-unhide ()
14785 "Unhide the current position, to show the bookmark location."
14787 (or (org-invisible-p)
14788 (save-excursion (goto-char (max (point-min) (1- (point))))
14789 (org-invisible-p)))
14790 (org-show-context 'bookmark-jump)))
14792 ;; Make session.el ignore our circular variable
14793 (eval-after-load "session"
14794 '(add-to-list 'session-globals-exclude 'org-mark-ring))
14796 ;;;; Experimental code
14798 (defun org-closed-in-range ()
14799 "Sparse tree of items closed in a certain time range.
14800 Still experimental, may disappear in the future."
14802 ;; Get the time interval from the user.
14803 (let* ((time1 (time-to-seconds
14804 (org-read-date nil 'to-time nil "Starting date: ")))
14805 (time2 (time-to-seconds
14806 (org-read-date nil 'to-time nil "End date:")))
14807 ;; callback function
14808 (callback (lambda ()
14811 (apply 'encode-time
14812 (org-parse-time-string
14813 (match-string 1))))))
14814 ;; check if time in interval
14815 (and (>= time time1) (<= time time2))))))
14816 ;; make tree, check each match with the callback
14817 (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
14824 (run-hooks 'org-load-hook)
14826 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
14828 ;;; org.el ends here