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, 2010, 2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
51 ;; http://orgmode.org/org.html#Installation
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
66 (defvar org-inhibit-highlight-removal nil
) ; dynamically scoped param
67 (defvar org-table-formula-constants-local nil
68 "Local version of `org-table-formula-constants'.")
69 (make-variable-buffer-local 'org-table-formula-constants-local
)
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
80 (when (fboundp 'defvaralias
)
81 (unless (boundp 'calendar-view-holidays-initially-flag
)
82 (defvaralias 'calendar-view-holidays-initially-flag
83 'view-calendar-holidays-initially
))
84 (unless (boundp 'calendar-view-diary-initially-flag
)
85 (defvaralias 'calendar-view-diary-initially-flag
86 'view-diary-entries-initially
))
87 (unless (boundp 'diary-fancy-buffer
)
88 (defvaralias 'diary-fancy-buffer
'fancy-diary-buffer
)))
90 (require 'outline
) (require 'noutline
)
91 ;; Other stuff we need.
93 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
98 (require 'org-entities
)
102 (require 'org-pcomplete
)
104 (require 'org-footnote
)
106 (declare-function org-inlinetask-at-task-p
"org-inlinetask" ())
107 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
108 (declare-function org-inlinetask-toggle-visibility
"org-inlinetask" ())
109 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
110 (declare-function org-at-clock-log-p
"org-clock" ())
111 (declare-function org-clock-timestamps-up
"org-clock" ())
112 (declare-function org-clock-timestamps-down
"org-clock" ())
123 ;; load languages based on value of `org-babel-load-languages'
124 (defvar org-babel-load-languages
)
126 (defun org-babel-do-load-languages (sym value
)
127 "Load the languages defined in `org-babel-load-languages'."
128 (set-default sym value
)
130 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
133 (require (intern (concat "ob-" lang
))))
135 (funcall 'fmakunbound
136 (intern (concat "org-babel-execute:" lang
)))
137 (funcall 'fmakunbound
138 (intern (concat "org-babel-expand-body:" lang
)))))))
139 org-babel-load-languages
))
141 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
146 \"loaded\", then code blocks in that language can be evaluated
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
153 :set
'org-babel-do-load-languages
154 :type
'(alist :tag
"Babel Languages"
157 (const :tag
"Awk" awk
)
160 (const :tag
"Asymptote" asymptote
)
161 (const :tag
"Calc" calc
)
162 (const :tag
"Clojure" clojure
)
163 (const :tag
"CSS" css
)
164 (const :tag
"Ditaa" ditaa
)
165 (const :tag
"Dot" dot
)
166 (const :tag
"Emacs Lisp" emacs-lisp
)
167 (const :tag
"Gnuplot" gnuplot
)
168 (const :tag
"Haskell" haskell
)
169 (const :tag
"Java" java
)
170 (const :tag
"Javascript" js
)
171 (const :tag
"Latex" latex
)
172 (const :tag
"Ledger" ledger
)
173 (const :tag
"Lilypond" lilypond
)
174 (const :tag
"Maxima" maxima
)
175 (const :tag
"Matlab" matlab
)
176 (const :tag
"Mscgen" mscgen
)
177 (const :tag
"Ocaml" ocaml
)
178 (const :tag
"Octave" octave
)
179 (const :tag
"Org" org
)
180 (const :tag
"Perl" perl
)
181 (const :tag
"PlantUML" plantuml
)
182 (const :tag
"Python" python
)
183 (const :tag
"Ruby" ruby
)
184 (const :tag
"Sass" sass
)
185 (const :tag
"Scheme" scheme
)
186 (const :tag
"Screen" screen
)
187 (const :tag
"Shell Script" sh
)
188 (const :tag
"Sql" sql
)
189 (const :tag
"Sqlite" sqlite
))
190 :value-type
(boolean :tag
"Activate" :value t
)))
192 ;;;; Customization variables
193 (defcustom org-clone-delete-id nil
194 "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
203 (defconst org-version
"7.6"
204 "The version number of the file org.el.")
206 (defun org-version (&optional here
)
207 "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
210 (let* ((origin default-directory
)
211 (version org-version
)
213 (dir (concat (file-name-directory (locate-library "org")) "../" )))
214 (when (and (file-exists-p (expand-file-name ".git" dir
))
215 (executable-find "git"))
219 (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
220 (with-current-buffer "*Shell Command Output*"
221 (goto-char (point-min))
222 (setq git-version
(buffer-substring (point) (point-at-eol))))
223 (subst-char-in-string ?- ?. git-version t
)
224 (when (string-match "\\S-"
225 (shell-command-to-string
226 "git diff-index --name-only HEAD --"))
227 (setq git-version
(concat git-version
".dirty")))
228 (setq version
(concat version
" (" git-version
")"))))
230 (setq version
(format "Org-mode version %s" version
))
231 (if here
(insert version
))
234 ;;; Compatibility constants
236 ;;; The custom variables
239 "Outline-based notes management and organizer."
244 (defcustom org-mode-hook nil
245 "Mode hook for Org-mode, run after the mode was turned on."
249 (defcustom org-load-hook nil
250 "Hook that is run after org.el has been loaded."
254 (defvar org-modules
) ; defined below
255 (defvar org-modules-loaded nil
256 "Have the modules been loaded already?")
258 (defun org-load-modules-maybe (&optional force
)
259 "Load all extensions listed in `org-modules'."
260 (when (or force
(not org-modules-loaded
))
262 (condition-case nil
(require ext
)
263 (error (message "Problems while trying to load feature `%s'" ext
))))
265 (setq org-modules-loaded t
)))
267 (defun org-set-modules (var value
)
268 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
270 (when (featurep 'org
)
271 (org-load-modules-maybe 'force
)))
273 (when (org-bound-and-true-p org-modules
)
274 (let ((a (member 'org-infojs org-modules
)))
275 (and a
(setcar a
'org-jsinfo
))))
277 (defcustom org-modules
'(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl
)
278 "Modules that should always be loaded together with org.el.
279 If a description starts with <C>, the file is not part of Emacs
280 and loading it will require that you have downloaded and properly installed
281 the org-mode distribution.
283 You can also use this system to load external packages (i.e. neither Org
284 core modules, nor modules from the CONTRIB directory). Just add symbols
285 to the end of the list. If the package is called org-xyz.el, then you need
286 to add the symbol `xyz', and the package must have a call to
290 :set
'org-set-modules
293 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
294 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
295 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
296 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
297 (const :tag
" docview: Links to doc-view buffers" org-docview
)
298 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
299 (const :tag
" id: Global IDs for identifying entries" org-id
)
300 (const :tag
" info: Links to Info nodes" org-info
)
301 (const :tag
" jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo
)
302 (const :tag
" habit: Track your consistency with habits" org-habit
)
303 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
304 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
305 (const :tag
" mac-message: Links to messages in Apple Mail" org-mac-message
)
306 (const :tag
" mew Links to Mew folders/messages" org-mew
)
307 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
308 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
309 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
310 (const :tag
" special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks
)
311 (const :tag
" vm: Links to VM folders/messages" org-vm
)
312 (const :tag
" wl: Links to Wanderlust folders/messages" org-wl
)
313 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
314 (const :tag
" mouse: Additional mouse support" org-mouse
)
315 (const :tag
" TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler
)
317 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
318 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
319 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
320 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
321 (const :tag
"C collector: Collect properties into tables" org-collector
)
322 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
323 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
324 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
325 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
326 (const :tag
"C eval: Include command output as text" org-eval
)
327 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
328 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
329 (const :tag
"C exp-bibtex: Export citations using BibTeX" org-exp-bibtex
)
330 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
331 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
333 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
335 (const :tag
"C jira: Add a jira:ticket protocol to Org-mode" org-jira
)
336 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
337 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
338 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
339 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
340 (const :tag
"C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber
)
341 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
342 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
343 (const :tag
"C odt: OpenDocumentText exporter for Org-mode" org-odt
)
344 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
345 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
346 (const :tag
"C org2rem: Convert org appointments into reminders" org2rem
)
347 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
348 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
349 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
350 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
351 (const :tag
"C track: Keep up with Org-mode development" org-track
)
352 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
353 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
354 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
356 (defcustom org-support-shift-select nil
357 "Non-nil means make shift-cursor commands select text when possible.
359 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
360 selecting a region, or enlarge regions started in this way.
361 In Org-mode, in special contexts, these same keys are used for other
362 purposes, important enough to compete with shift selection. Org tries
363 to balance these needs by supporting `shift-select-mode' outside these
364 special contexts, under control of this variable.
366 The default of this variable is nil, to avoid confusing behavior. Shifted
367 cursor keys will then execute Org commands in the following contexts:
368 - on a headline, changing TODO state (left/right) and priority (up/down)
369 - on a time stamp, changing the time
370 - in a plain list item, changing the bullet type
371 - in a property definition line, switching between allowed values
372 - in the BEGIN line of a clock table (changing the time block).
373 Outside these contexts, the commands will throw an error.
375 When this variable is t and the cursor is not in a special context,
376 Org-mode will support shift-selection for making and enlarging regions.
377 To make this more effective, the bullet cycling will no longer happen
378 anywhere in an item line, but only if the cursor is exactly on the bullet.
380 If you set this variable to the symbol `always', then the keys
381 will not be special in headlines, property lines, and item lines, to make
382 shift selection work there as well. If this is what you want, you can
383 use the following alternative commands: `C-c C-t' and `C-c ,' to
384 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
385 TODO sets, `C-c -' to cycle item bullet types, and properties can be
386 edited by hand or in column view.
388 However, when the cursor is on a timestamp, shift-cursor commands
389 will still edit the time stamp - this is just too good to give up.
391 XEmacs user should have this variable set to nil, because shift-select-mode
395 (const :tag
"Never" nil
)
396 (const :tag
"When outside special context" t
)
397 (const :tag
"Everywhere except timestamps" always
)))
399 (defgroup org-startup nil
400 "Options concerning startup of Org-mode."
404 (defcustom org-startup-folded t
405 "Non-nil means entering Org-mode will switch to OVERVIEW.
406 This can also be configured on a per-file basis by adding one of
407 the following lines anywhere in the buffer:
409 #+STARTUP: fold (or `overview', this is equivalent)
410 #+STARTUP: nofold (or `showall', this is equivalent)
412 #+STARTUP: showeverything"
415 (const :tag
"nofold: show all" nil
)
416 (const :tag
"fold: overview" t
)
417 (const :tag
"content: all headlines" content
)
418 (const :tag
"show everything, even drawers" showeverything
)))
420 (defcustom org-startup-truncated t
421 "Non-nil means entering Org-mode will set `truncate-lines'.
422 This is useful since some lines containing links can be very long and
423 uninteresting. Also tables look terrible when wrapped."
427 (defcustom org-startup-indented nil
428 "Non-nil means turn on `org-indent-mode' on startup.
429 This can also be configured on a per-file basis by adding one of
430 the following lines anywhere in the buffer:
434 :group
'org-structure
436 (const :tag
"Not" nil
)
437 (const :tag
"Globally (slow on startup in large files)" t
)))
439 (defcustom org-use-sub-superscripts t
440 "Non-nil means interpret \"_\" and \"^\" for export.
441 When this option is turned on, you can use TeX-like syntax for sub- and
442 superscripts. Several characters after \"_\" or \"^\" will be
443 considered as a single item - so grouping with {} is normally not
444 needed. For example, the following things will be parsed as single
445 sub- or superscripts.
447 10^24 or 10^tau several digits will be considered 1 item.
448 10^-12 or 10^-tau a leading sign with digits or a word
449 x^2-y^3 will be read as x^2 - y^3, because items are
450 terminated by almost any nonword/nondigit char.
451 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
453 Still, ambiguity is possible - so when in doubt use {} to enclose the
454 sub/superscript. If you set this variable to the symbol `{}',
455 the braces are *required* in order to trigger interpretations as
456 sub/superscript. This can be helpful in documents that need \"_\"
457 frequently in plain text.
459 Not all export backends support this, but HTML does.
461 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
463 :group
'org-export-translation
465 (const :tag
"Always interpret" t
)
466 (const :tag
"Only with braces" {})
467 (const :tag
"Never interpret" nil
)))
469 (if (fboundp 'defvaralias
)
470 (defvaralias 'org-export-with-sub-superscripts
'org-use-sub-superscripts
))
473 (defcustom org-startup-with-beamer-mode nil
474 "Non-nil means turn on `org-beamer-mode' on startup.
475 This can also be configured on a per-file basis by adding one of
476 the following lines anywhere in the buffer:
482 (defcustom org-startup-align-all-tables nil
483 "Non-nil means align all tables when visiting a file.
484 This is useful when the column width in tables is forced with <N> cookies
485 in table fields. Such tables will look correct only after the first re-align.
486 This can also be configured on a per-file basis by adding one of
487 the following lines anywhere in the buffer:
493 (defcustom org-startup-with-inline-images nil
494 "Non-nil means show inline images when loading a new Org file.
495 This can also be configured on a per-file basis by adding one of
496 the following lines anywhere in the buffer:
497 #+STARTUP: inlineimages
498 #+STARTUP: noinlineimages"
502 (defcustom org-insert-mode-line-in-empty-file nil
503 "Non-nil means insert the first line setting Org-mode in empty files.
504 When the function `org-mode' is called interactively in an empty file, this
505 normally means that the file name does not automatically trigger Org-mode.
506 To ensure that the file will always be in Org-mode in the future, a
507 line enforcing Org-mode will be inserted into the buffer, if this option
512 (defcustom org-replace-disputed-keys nil
513 "Non-nil means use alternative key bindings for some keys.
514 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
515 These keys are also used by other packages like shift-selection-mode'
516 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
517 If you want to use Org-mode together with one of these other modes,
518 or more generally if you would like to move some Org-mode commands to
519 other keys, set this variable and configure the keys with the variable
522 This option is only relevant at load-time of Org-mode, and must be set
523 *before* org.el is loaded. Changing it requires a restart of Emacs to
528 (defcustom org-use-extra-keys nil
529 "Non-nil means use extra key sequence definitions for certain commands.
530 This happens automatically if you run XEmacs or if `window-system'
531 is nil. This variable lets you do the same manually. You must
532 set it before loading org.
534 Example: on Carbon Emacs 22 running graphically, with an external
535 keyboard on a Powerbook, the default way of setting M-left might
536 not work for either Alt or ESC. Setting this variable will make
541 (if (fboundp 'defvaralias
)
542 (defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
))
544 (defcustom org-disputed-keys
545 '(([(shift up
)] .
[(meta p
)])
546 ([(shift down
)] .
[(meta n
)])
547 ([(shift left
)] .
[(meta -
)])
548 ([(shift right
)] .
[(meta +)])
549 ([(control shift right
)] .
[(meta shift
+)])
550 ([(control shift left
)] .
[(meta shift -
)]))
551 "Keys for which Org-mode and other modes compete.
552 This is an alist, cars are the default keys, second element specifies
553 the alternative to use when `org-replace-disputed-keys' is t.
555 Keys can be specified in any syntax supported by `define-key'.
556 The value of this option takes effect only at Org-mode's startup,
557 therefore you'll have to restart Emacs to apply it after changing."
562 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
563 Or return the original if not disputed.
564 Also apply the translations defined in `org-xemacs-key-equivalents'."
565 (when org-replace-disputed-keys
566 (let* ((nkey (key-description key
))
567 (x (org-find-if (lambda (x)
568 (equal (key-description (car x
)) nkey
))
570 (setq key
(if x
(cdr x
) key
))))
571 (when (featurep 'xemacs
)
572 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
575 (defun org-find-if (predicate seq
)
578 (if (funcall predicate
(car seq
))
579 (throw 'exit
(car seq
))
582 (defun org-defkey (keymap key def
)
583 "Define a key, possibly translated, as returned by `org-key'."
584 (define-key keymap
(org-key key
) def
))
586 (defcustom org-ellipsis nil
587 "The ellipsis to use in the Org-mode outline.
588 When nil, just use the standard three dots. When a string, use that instead,
589 When a face, use the standard 3 dots, but with the specified face.
590 The change affects only Org-mode (which will then use its own display table).
591 Changing this requires executing `M-x org-mode' in a buffer to become
594 :type
'(choice (const :tag
"Default" nil
)
595 (face :tag
"Face" :value org-warning
)
596 (string :tag
"String" :value
"...#")))
598 (defvar org-display-table nil
599 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
601 (defgroup org-keywords nil
602 "Keywords in Org-mode."
606 (defcustom org-deadline-string
"DEADLINE:"
607 "String to mark deadline entries.
608 A deadline is this string, followed by a time stamp. Should be a word,
609 terminated by a colon. You can insert a schedule keyword and
610 a timestamp with \\[org-deadline].
611 Changes become only effective after restarting Emacs."
615 (defcustom org-scheduled-string
"SCHEDULED:"
616 "String to mark scheduled TODO entries.
617 A schedule is this string, followed by a time stamp. Should be a word,
618 terminated by a colon. You can insert a schedule keyword and
619 a timestamp with \\[org-schedule].
620 Changes become only effective after restarting Emacs."
624 (defcustom org-closed-string
"CLOSED:"
625 "String used as the prefix for timestamps logging closing a TODO entry."
629 (defcustom org-clock-string
"CLOCK:"
630 "String used as prefix for timestamps clocking work hours on an item."
634 (defcustom org-comment-string
"COMMENT"
635 "Entries starting with this keyword will never be exported.
636 An entry can be toggled between COMMENT and normal with
637 \\[org-toggle-comment].
638 Changes become only effective after restarting Emacs."
642 (defcustom org-quote-string
"QUOTE"
643 "Entries starting with this keyword will be exported in fixed-width font.
644 Quoting applies only to the text in the entry following the headline, and does
645 not extend beyond the next headline, even if that is lower level.
646 An entry can be toggled between QUOTE and normal with
647 \\[org-toggle-fixed-width-section]."
651 (defconst org-repeat-re
652 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
653 "Regular expression for specifying repeated events.
654 After a match, group 1 contains the repeat expression.")
656 (defgroup org-structure nil
657 "Options concerning the general structure of Org-mode files."
661 (defgroup org-reveal-location nil
662 "Options about how to make context of a location visible."
663 :tag
"Org Reveal Location"
664 :group
'org-structure
)
666 (defconst org-context-choice
668 (const :tag
"Always" t
)
669 (const :tag
"Never" nil
)
670 (repeat :greedy t
:tag
"Individual contexts"
672 (choice :tag
"Context"
679 (const bookmark-jump
)
683 "Contexts for the reveal options.")
685 (defcustom org-show-hierarchy-above
'((default . t
))
686 "Non-nil means show full hierarchy when revealing a location.
687 Org-mode often shows locations in an org-mode file which might have
688 been invisible before. When this is set, the hierarchy of headings
689 above the exposed location is shown.
690 Turning this off for example for sparse trees makes them very compact.
691 Instead of t, this can also be an alist specifying this option for different
692 contexts. Valid contexts are
693 agenda when exposing an entry from the agenda
694 org-goto when using the command `org-goto' on key C-c C-j
695 occur-tree when using the command `org-occur' on key C-c /
696 tags-tree when constructing a sparse tree based on tags matches
697 link-search when exposing search matches associated with a link
698 mark-goto when exposing the jump goal of a mark
699 bookmark-jump when exposing a bookmark location
700 isearch when exiting from an incremental search
701 default default for all contexts not set explicitly"
702 :group
'org-reveal-location
703 :type org-context-choice
)
705 (defcustom org-show-following-heading
'((default . nil
))
706 "Non-nil means show following heading when revealing a location.
707 Org-mode often shows locations in an org-mode file which might have
708 been invisible before. When this is set, the heading following the
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
712 use the command \\[org-reveal] to show more context.
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
715 :group
'org-reveal-location
716 :type org-context-choice
)
718 (defcustom org-show-siblings
'((default . nil
) (isearch t
))
719 "Non-nil means show all sibling heading when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the sibling of the current entry
722 heading are all made visible. If `org-show-hierarchy-above' is t,
723 the same happens on each level of the hierarchy above the current entry.
725 By default this is on for the isearch context, off for all other contexts.
726 Turning this off for example for sparse trees makes them very compact,
727 but makes it harder to edit the location of the match. In such a case,
728 use the command \\[org-reveal] to show more context.
729 Instead of t, this can also be an alist specifying this option for different
730 contexts. See `org-show-hierarchy-above' for valid contexts."
731 :group
'org-reveal-location
732 :type org-context-choice
)
734 (defcustom org-show-entry-below
'((default . nil
))
735 "Non-nil means show the entry below a headline when revealing a location.
736 Org-mode often shows locations in an org-mode file which might have
737 been invisible before. When this is set, the text below the headline that is
738 exposed is also shown.
740 By default this is off for all contexts.
741 Instead of t, this can also be an alist specifying this option for different
742 contexts. See `org-show-hierarchy-above' for valid contexts."
743 :group
'org-reveal-location
744 :type org-context-choice
)
746 (defcustom org-indirect-buffer-display
'other-window
747 "How should indirect tree buffers be displayed?
748 This applies to indirect buffers created with the commands
749 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
751 current-window Display in the current window
752 other-window Just display in another window.
753 dedicated-frame Create one new frame, and re-use it each time.
754 new-frame Make a new frame each time. Note that in this case
755 previously-made indirect buffers are kept, and you need to
756 kill these buffers yourself."
757 :group
'org-structure
758 :group
'org-agenda-windows
760 (const :tag
"In current window" current-window
)
761 (const :tag
"In current frame, other window" other-window
)
762 (const :tag
"Each time a new frame" new-frame
)
763 (const :tag
"One dedicated frame" dedicated-frame
)))
765 (defcustom org-use-speed-commands nil
766 "Non-nil means activate single letter commands at beginning of a headline.
767 This may also be a function to test for appropriate locations where speed
768 commands should be active."
769 :group
'org-structure
771 (const :tag
"Never" nil
)
772 (const :tag
"At beginning of headline stars" t
)
775 (defcustom org-speed-commands-user nil
776 "Alist of additional speed commands.
777 This list will be checked before `org-speed-commands-default'
778 when the variable `org-use-speed-commands' is non-nil
779 and when the cursor is at the beginning of a headline.
780 The car if each entry is a string with a single letter, which must
781 be assigned to `self-insert-command' in the global map.
782 The cdr is either a command to be called interactively, a function
783 to be called, or a form to be evaluated.
784 An entry that is just a list with a single string will be interpreted
785 as a descriptive headline that will be added when listing the speed
786 commands in the Help buffer using the `?' speed command."
787 :group
'org-structure
788 :type
'(repeat :value
("k" . ignore
)
789 (choice :value
("k" . ignore
)
790 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
791 (cons :tag
"Letter and Command"
792 (string :tag
"Command letter")
797 (defgroup org-cycle nil
798 "Options concerning visibility cycling in Org-mode."
800 :group
'org-structure
)
802 (defcustom org-cycle-skip-children-state-if-no-children t
803 "Non-nil means skip CHILDREN state in entries that don't have any."
807 (defcustom org-cycle-max-level nil
808 "Maximum level which should still be subject to visibility cycling.
809 Levels higher than this will, for cycling, be treated as text, not a headline.
810 When `org-odd-levels-only' is set, a value of N in this variable actually
811 means 2N-1 stars as the limiting headline.
812 When nil, cycle all levels.
813 Note that the limiting level of cycling is also influenced by
814 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
815 `org-inlinetask-min-level' is, cycling will be limited to levels one less
819 (const :tag
"No limit" nil
)
820 (integer :tag
"Maximum level")))
822 (defcustom org-drawers
'("PROPERTIES" "CLOCK" "LOGBOOK")
823 "Names of drawers. Drawers are not opened by cycling on the headline above.
824 Drawers only open with a TAB on the drawer line itself. A drawer looks like
829 The drawer \"PROPERTIES\" is special for capturing properties through
832 Drawers can be defined on the per-file basis with a line like:
834 #+DRAWERS: HIDDEN STATE PROPERTIES"
835 :group
'org-structure
837 :type
'(repeat (string :tag
"Drawer Name")))
839 (defcustom org-hide-block-startup nil
840 "Non-nil means entering Org-mode will fold all blocks.
841 This can also be set in on a per-file basis with
843 #+STARTUP: hideblocks
844 #+STARTUP: showblocks"
849 (defcustom org-cycle-global-at-bob nil
850 "Cycle globally if cursor is at beginning of buffer and not at a headline.
851 This makes it possible to do global cycling without having to use S-TAB or
852 \\[universal-argument] TAB. For this special case to work, the first line \
854 must not be a headline - it may be empty or some other text. When used in
855 this way, `org-cycle-hook' is disables temporarily, to make sure the
856 cursor stays at the beginning of the buffer.
857 When this option is nil, don't do anything special at the beginning
862 (defcustom org-cycle-level-after-item
/entry-creation t
863 "Non-nil means cycle entry level or item indentation in new empty entries.
865 When the cursor is at the end of an empty headline, i.e with only stars
866 and maybe a TODO keyword, TAB will then switch the entry to become a child,
867 and then all possible ancestor states, before returning to the original state.
868 This makes data entry extremely fast: M-RET to create a new headline,
869 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
871 When the cursor is at the end of an empty plain list item, one TAB will
872 make it a subitem, two or more tabs will back up to make this an item
873 higher up in the item hierarchy."
877 (defcustom org-cycle-emulate-tab t
878 "Where should `org-cycle' emulate TAB.
880 white Only in completely white lines
881 whitestart Only at the beginning of lines, before the first non-white char
882 t Everywhere except in headlines
883 exc-hl-bol Everywhere except at the start of a headline
884 If TAB is used in a place where it does not emulate TAB, the current subtree
885 visibility is cycled."
887 :type
'(choice (const :tag
"Never" nil
)
888 (const :tag
"Only in completely white lines" white
)
889 (const :tag
"Before first char in a line" whitestart
)
890 (const :tag
"Everywhere except in headlines" t
)
891 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)
894 (defcustom org-cycle-separator-lines
2
895 "Number of empty lines needed to keep an empty line between collapsed trees.
896 If you leave an empty line between the end of a subtree and the following
897 headline, this empty line is hidden when the subtree is folded.
898 Org-mode will leave (exactly) one empty line visible if the number of
899 empty lines is equal or larger to the number given in this variable.
900 So the default 2 means at least 2 empty lines after the end of a subtree
901 are needed to produce free space between a collapsed subtree and the
904 If the number is negative, and the number of empty lines is at least -N,
905 all empty lines are shown.
907 Special case: when 0, never leave empty lines in collapsed view."
910 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
912 (defcustom org-pre-cycle-hook nil
913 "Hook that is run before visibility cycling is happening.
914 The function(s) in this hook must accept a single argument which indicates
915 the new state that will be set right after running this hook. The
916 argument is a symbol. Before a global state change, it can have the values
917 `overview', `content', or `all'. Before a local state change, it can have
918 the values `folded', `children', or `subtree'."
922 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
923 org-cycle-hide-drawers
924 org-cycle-show-empty-lines
925 org-optimize-window-after-visibility-change
)
926 "Hook that is run after `org-cycle' has changed the buffer visibility.
927 The function(s) in this hook must accept a single argument which indicates
928 the new state that was set by the most recent `org-cycle' command. The
929 argument is a symbol. After a global state change, it can have the values
930 `overview', `content', or `all'. After a local state change, it can have
931 the values `folded', `children', or `subtree'."
935 (defgroup org-edit-structure nil
936 "Options concerning structure editing in Org-mode."
937 :tag
"Org Edit Structure"
938 :group
'org-structure
)
940 (defcustom org-odd-levels-only nil
941 "Non-nil means skip even levels and only use odd levels for the outline.
942 This has the effect that two stars are being added/taken away in
943 promotion/demotion commands. It also influences how levels are
944 handled by the exporters.
945 Changing it requires restart of `font-lock-mode' to become effective
946 for fontification also in regions already fontified.
947 You may also set this on a per-file basis by adding one of the following
952 :group
'org-edit-structure
953 :group
'org-appearance
956 (defcustom org-adapt-indentation t
957 "Non-nil means adapt indentation to outline node level.
959 When this variable is set, Org assumes that you write outlines by
960 indenting text in each node to align with the headline (after the stars).
961 The following issues are influenced by this variable:
963 - When this is set and the *entire* text in an entry is indented, the
964 indentation is increased by one space in a demotion command, and
965 decreased by one in a promotion command. If any line in the entry
966 body starts with text at column 0, indentation is not changed at all.
968 - Property drawers and planning information is inserted indented when
969 this variable s set. When nil, they will not be indented.
971 - TAB indents a line relative to context. The lines below a headline
972 will be indented when this variable is set.
974 Note that this is all about true indentation, by adding and removing
975 space characters. See also `org-indent.el' which does level-dependent
976 indentation in a virtual way, i.e. at display time in Emacs."
977 :group
'org-edit-structure
980 (defcustom org-special-ctrl-a
/e nil
981 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
983 When t, `C-a' will bring back the cursor to the beginning of the
984 headline text, i.e. after the stars and after a possible TODO keyword.
985 In an item, this will be the position after the bullet.
986 When the cursor is already at that position, another `C-a' will bring
987 it to the beginning of the line.
989 `C-e' will jump to the end of the headline, ignoring the presence of tags
990 in the headline. A second `C-e' will then jump to the true end of the
991 line, after any tags. This also means that, when this variable is
992 non-nil, `C-e' also will never jump beyond the end of the heading of a
993 folded section, i.e. not after the ellipses.
995 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
996 going to the true line boundary first. Only a directly following, identical
997 keypress will bring the cursor to the special positions.
999 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1001 :group
'org-edit-structure
1003 (const :tag
"off" nil
)
1004 (const :tag
"on: after stars/bullet and before tags first" t
)
1005 (const :tag
"reversed: true line boundary first" reversed
)
1006 (cons :tag
"Set C-a and C-e separately"
1007 (choice :tag
"Special C-a"
1008 (const :tag
"off" nil
)
1009 (const :tag
"on: after stars/bullet first" t
)
1010 (const :tag
"reversed: before stars/bullet first" reversed
))
1011 (choice :tag
"Special C-e"
1012 (const :tag
"off" nil
)
1013 (const :tag
"on: before tags first" t
)
1014 (const :tag
"reversed: after tags first" reversed
)))))
1015 (if (fboundp 'defvaralias
)
1016 (defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
))
1018 (defcustom org-special-ctrl-k nil
1019 "Non-nil means `C-k' will behave specially in headlines.
1020 When nil, `C-k' will call the default `kill-line' command.
1021 When t, the following will happen while the cursor is in the headline:
1023 - When the cursor is at the beginning of a headline, kill the entire
1024 line and possible the folded subtree below the line.
1025 - When in the middle of the headline text, kill the headline up to the tags.
1026 - When after the headline text, kill the tags."
1027 :group
'org-edit-structure
1030 (defcustom org-ctrl-k-protect-subtree nil
1031 "Non-nil means, do not delete a hidden subtree with C-k.
1032 When set to the symbol `error', simply throw an error when C-k is
1033 used to kill (part-of) a headline that has hidden text behind it.
1034 Any other non-nil value will result in a query to the user, if it is
1035 OK to kill that hidden subtree. When nil, kill without remorse."
1036 :group
'org-edit-structure
1038 (const :tag
"Do not protect hidden subtrees" nil
)
1039 (const :tag
"Protect hidden subtrees with a security query" t
)
1040 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1042 (defcustom org-yank-folded-subtrees t
1043 "Non-nil means when yanking subtrees, fold them.
1044 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1045 it starts with a heading and all other headings in it are either children
1046 or siblings, then fold all the subtrees. However, do this only if no
1047 text after the yank would be swallowed into a folded tree by this action."
1048 :group
'org-edit-structure
1051 (defcustom org-yank-adjusted-subtrees nil
1052 "Non-nil means when yanking subtrees, adjust the level.
1053 With this setting, `org-paste-subtree' is used to insert the subtree, see
1054 this function for details."
1055 :group
'org-edit-structure
1058 (defcustom org-M-RET-may-split-line
'((default . t
))
1059 "Non-nil means M-RET will split the line at the cursor position.
1060 When nil, it will go to the end of the line before making a
1062 You may also set this option in a different way for different
1063 contexts. Valid contexts are:
1065 headline when creating a new headline
1066 item when creating a new item
1067 table in a table field
1068 default the value to be used for all contexts not explicitly
1070 :group
'org-structure
1073 (const :tag
"Always" t
)
1074 (const :tag
"Never" nil
)
1075 (repeat :greedy t
:tag
"Individual contexts"
1077 (choice :tag
"Context"
1085 (defcustom org-insert-heading-respect-content nil
1086 "Non-nil means insert new headings after the current subtree.
1087 When nil, the new heading is created directly after the current line.
1088 The commands \\[org-insert-heading-respect-content] and
1089 \\[org-insert-todo-heading-respect-content] turn this variable on
1090 for the duration of the command."
1091 :group
'org-structure
1094 (defcustom org-blank-before-new-entry
'((heading . auto
)
1095 (plain-list-item . auto
))
1096 "Should `org-insert-heading' leave a blank line before new heading/item?
1097 The value is an alist, with `heading' and `plain-list-item' as CAR,
1098 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1099 which case Org will look at the surrounding headings/items and try to
1100 make an intelligent decision whether to insert a blank line or not.
1102 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1103 set, the setting here is ignored and no empty line is inserted, to avoid
1104 breaking the list structure."
1105 :group
'org-edit-structure
1107 (cons (const heading
)
1108 (choice (const :tag
"Never" nil
)
1109 (const :tag
"Always" t
)
1110 (const :tag
"Auto" auto
)))
1111 (cons (const plain-list-item
)
1112 (choice (const :tag
"Never" nil
)
1113 (const :tag
"Always" t
)
1114 (const :tag
"Auto" auto
)))))
1116 (defcustom org-insert-heading-hook nil
1117 "Hook being run after inserting a new heading."
1118 :group
'org-edit-structure
1121 (defcustom org-enable-fixed-width-editor t
1122 "Non-nil means lines starting with \":\" are treated as fixed-width.
1123 This currently only means they are never auto-wrapped.
1124 When nil, such lines will be treated like ordinary lines.
1125 See also the QUOTE keyword."
1126 :group
'org-edit-structure
1129 (defcustom org-goto-auto-isearch t
1130 "Non-nil means typing characters in `org-goto' starts incremental search."
1131 :group
'org-edit-structure
1134 (defgroup org-sparse-trees nil
1135 "Options concerning sparse trees in Org-mode."
1136 :tag
"Org Sparse Trees"
1137 :group
'org-structure
)
1139 (defcustom org-highlight-sparse-tree-matches t
1140 "Non-nil means highlight all matches that define a sparse tree.
1141 The highlights will automatically disappear the next time the buffer is
1142 changed by an edit command."
1143 :group
'org-sparse-trees
1146 (defcustom org-remove-highlights-with-change t
1147 "Non-nil means any change to the buffer will remove temporary highlights.
1148 Such highlights are created by `org-occur' and `org-clock-display'.
1149 When nil, `C-c C-c needs to be used to get rid of the highlights.
1150 The highlights created by `org-preview-latex-fragment' always need
1151 `C-c C-c' to be removed."
1152 :group
'org-sparse-trees
1157 (defcustom org-occur-hook
'(org-first-headline-recenter)
1158 "Hook that is run after `org-occur' has constructed a sparse tree.
1159 This can be used to recenter the window to show as much of the structure
1161 :group
'org-sparse-trees
1164 (defgroup org-imenu-and-speedbar nil
1165 "Options concerning imenu and speedbar in Org-mode."
1166 :tag
"Org Imenu and Speedbar"
1167 :group
'org-structure
)
1169 (defcustom org-imenu-depth
2
1170 "The maximum level for Imenu access to Org-mode headlines.
1171 This also applied for speedbar access."
1172 :group
'org-imenu-and-speedbar
1175 (defgroup org-table nil
1176 "Options concerning tables in Org-mode."
1180 (defcustom org-enable-table-editor
'optimized
1181 "Non-nil means lines starting with \"|\" are handled by the table editor.
1182 When nil, such lines will be treated like ordinary lines.
1184 When equal to the symbol `optimized', the table editor will be optimized to
1186 - Automatic overwrite mode in front of whitespace in table fields.
1187 This makes the structure of the table stay in tact as long as the edited
1188 field does not exceed the column width.
1189 - Minimize the number of realigns. Normally, the table is aligned each time
1190 TAB or RET are pressed to move to another field. With optimization this
1191 happens only if changes to a field might have changed the column width.
1192 Optimization requires replacing the functions `self-insert-command',
1193 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1194 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1195 very good at guessing when a re-align will be necessary, but you can always
1196 force one with \\[org-ctrl-c-ctrl-c].
1198 If you would like to use the optimized version in Org-mode, but the
1199 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1201 This variable can be used to turn on and off the table editor during a session,
1202 but in order to toggle optimization, a restart is required.
1204 See also the variable `org-table-auto-blank-field'."
1207 (const :tag
"off" nil
)
1209 (const :tag
"on, optimized" optimized
)))
1211 (defcustom org-self-insert-cluster-for-undo t
1212 "Non-nil means cluster self-insert commands for undo when possible.
1213 If this is set, then, like in the Emacs command loop, 20 consecutive
1214 characters will be undone together.
1215 This is configurable, because there is some impact on typing performance."
1219 (defcustom org-table-tab-recognizes-table.el t
1220 "Non-nil means TAB will automatically notice a table.el table.
1221 When it sees such a table, it moves point into it and - if necessary -
1222 calls `table-recognize-table'."
1223 :group
'org-table-editing
1226 (defgroup org-link nil
1227 "Options concerning links in Org-mode."
1231 (defvar org-link-abbrev-alist-local nil
1232 "Buffer-local version of `org-link-abbrev-alist', which see.
1233 The value of this is taken from the #+LINK lines.")
1234 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1236 (defcustom org-link-abbrev-alist nil
1237 "Alist of link abbreviations.
1238 The car of each element is a string, to be replaced at the start of a link.
1239 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1240 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1242 [[linkkey:tag][description]]
1244 The 'linkkey' must be a word word, starting with a letter, followed
1245 by letters, numbers, '-' or '_'.
1247 If REPLACE is a string, the tag will simply be appended to create the link.
1248 If the string contains \"%s\", the tag will be inserted there. Alternatively,
1249 the placeholder \"%h\" will cause a url-encoded version of the tag to
1250 be inserted at that point (see the function `url-hexify-string').
1252 REPLACE may also be a function that will be called with the tag as the
1253 only argument to create the link, which should be returned as a string.
1255 See the manual for examples."
1259 (string :tag
"Protocol")
1261 (string :tag
"Format")
1264 (defcustom org-descriptive-links t
1265 "Non-nil means hide link part and only show description of bracket links.
1266 Bracket links are like [[link][description]]. This variable sets the initial
1267 state in new org-mode buffers. The setting can then be toggled on a
1268 per-buffer basis from the Org->Hyperlinks menu."
1272 (defcustom org-link-file-path-type
'adaptive
1273 "How the path name in file links should be stored.
1276 relative Relative to the current directory, i.e. the directory of the file
1277 into which the link is being inserted.
1278 absolute Absolute path, if possible with ~ for home directory.
1279 noabbrev Absolute path, no abbreviation of home directory.
1280 adaptive Use relative path for files in the current directory and sub-
1281 directories of it. For other files, use an absolute path."
1289 (defcustom org-activate-links
'(bracket angle plain radio tag date footnote
)
1290 "Types of links that should be activated in Org-mode files.
1291 This is a list of symbols, each leading to the activation of a certain link
1292 type. In principle, it does not hurt to turn on most link types - there may
1293 be a small gain when turning off unused link types. The types are:
1295 bracket The recommended [[link][description]] or [[link]] links with hiding.
1296 angle Links in angular brackets that may contain whitespace like
1297 <bbdb:Carsten Dominik>.
1298 plain Plain links in normal text, no whitespace, like http://google.com.
1299 radio Text that is matched by a radio target, see manual for details.
1300 tag Tag settings in a headline (link to tag search).
1301 date Time stamps (link to calendar).
1302 footnote Footnote labels.
1304 Changing this variable requires a restart of Emacs to become effective."
1306 :type
'(set :greedy t
1307 (const :tag
"Double bracket links" bracket
)
1308 (const :tag
"Angular bracket links" angle
)
1309 (const :tag
"Plain text links" plain
)
1310 (const :tag
"Radio target matches" radio
)
1311 (const :tag
"Tags" tag
)
1312 (const :tag
"Timestamps" date
)
1313 (const :tag
"Footnotes" footnote
)))
1315 (defcustom org-make-link-description-function nil
1316 "Function to use to generate link descriptions from links.
1317 If nil the link location will be used. This function must take
1318 two parameters; the first is the link and the second the
1319 description `org-insert-link' has generated, and should return the
1320 description to use."
1324 (defgroup org-link-store nil
1325 "Options concerning storing links in Org-mode."
1326 :tag
"Org Store Link"
1329 (defcustom org-email-link-description-format
"Email %c: %.30s"
1330 "Format of the description part of a link to an email or usenet message.
1331 The following %-escapes will be replaced by corresponding information:
1333 %F full \"From\" field
1334 %f name, taken from \"From\" field, address if no name
1335 %T full \"To\" field
1336 %t first name in \"To\" field, address if no name
1337 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1338 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1343 You may use normal field width specification between the % and the letter.
1344 This is for example useful to limit the length of the subject.
1346 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1347 :group
'org-link-store
1350 (defcustom org-from-is-user-regexp
1352 (when (and user-mail-address
(not (string= user-mail-address
"")))
1353 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1354 (when (and user-full-name
(not (string= user-full-name
"")))
1355 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1356 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1357 "Regexp matched against the \"From:\" header of an email or usenet message.
1358 It should match if the message is from the user him/herself."
1359 :group
'org-link-store
1362 (defcustom org-link-to-org-use-id
'create-if-interactive-and-no-custom-id
1363 "Non-nil means storing a link to an Org file will use entry IDs.
1365 Note that before this variable is even considered, org-id must be loaded,
1366 so please customize `org-modules' and turn it on.
1368 The variable can have the following values:
1370 t Create an ID if needed to make a link to the current entry.
1372 create-if-interactive
1373 If `org-store-link' is called directly (interactively, as a user
1374 command), do create an ID to support the link. But when doing the
1375 job for remember, only use the ID if it already exists. The
1376 purpose of this setting is to avoid proliferation of unwanted
1377 IDs, just because you happen to be in an Org file when you
1378 call `org-remember' that automatically and preemptively
1379 creates a link. If you do want to get an ID link in a remember
1380 template to an entry not having an ID, create it first by
1381 explicitly creating a link to it, using `C-c C-l' first.
1383 create-if-interactive-and-no-custom-id
1384 Like create-if-interactive, but do not create an ID if there is
1385 a CUSTOM_ID property defined in the entry. This is the default.
1388 Use existing ID, do not create one.
1390 nil Never use an ID to make a link, instead link using a text search for
1392 :group
'org-link-store
1394 (const :tag
"Create ID to make link" t
)
1395 (const :tag
"Create if storing link interactively"
1396 create-if-interactive
)
1397 (const :tag
"Create if storing link interactively and no CUSTOM_ID is present"
1398 create-if-interactive-and-no-custom-id
)
1399 (const :tag
"Only use existing" use-existing
)
1400 (const :tag
"Do not use ID to create link" nil
)))
1402 (defcustom org-context-in-file-links t
1403 "Non-nil means file links from `org-store-link' contain context.
1404 A search string will be added to the file name with :: as separator and
1405 used to find the context when the link is activated by the command
1406 `org-open-at-point'. When this option is t, the entire active region
1407 will be placed in the search string of the file link. If set to a
1408 positive integer, only the first n lines of context will be stored.
1410 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1411 negates this setting for the duration of the command."
1412 :group
'org-link-store
1413 :type
'(choice boolean integer
))
1415 (defcustom org-keep-stored-link-after-insertion nil
1416 "Non-nil means keep link in list for entire session.
1418 The command `org-store-link' adds a link pointing to the current
1419 location to an internal list. These links accumulate during a session.
1420 The command `org-insert-link' can be used to insert links into any
1421 Org-mode file (offering completion for all stored links). When this
1422 option is nil, every link which has been inserted once using \\[org-insert-link]
1423 will be removed from the list, to make completing the unused links
1425 :group
'org-link-store
1428 (defgroup org-link-follow nil
1429 "Options concerning following links in Org-mode."
1430 :tag
"Org Follow Link"
1433 (defcustom org-link-translation-function nil
1434 "Function to translate links with different syntax to Org syntax.
1435 This can be used to translate links created for example by the Planner
1436 or emacs-wiki packages to Org syntax.
1437 The function must accept two parameters, a TYPE containing the link
1438 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1439 which is everything after the link protocol. It should return a cons
1440 with possibly modified values of type and path.
1441 Org contains a function for this, so if you set this variable to
1442 `org-translate-link-from-planner', you should be able follow many
1443 links created by planner."
1444 :group
'org-link-follow
1447 (defcustom org-follow-link-hook nil
1448 "Hook that is run after a link has been followed."
1449 :group
'org-link-follow
1452 (defcustom org-tab-follows-link nil
1453 "Non-nil means on links TAB will follow the link.
1454 Needs to be set before org.el is loaded.
1455 This really should not be used, it does not make sense, and the
1456 implementation is bad."
1457 :group
'org-link-follow
1460 (defcustom org-return-follows-link nil
1461 "Non-nil means on links RET will follow the link."
1462 :group
'org-link-follow
1465 (defcustom org-mouse-1-follows-link
1466 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1467 "Non-nil means mouse-1 on a link will follow the link.
1468 A longer mouse click will still set point. Does not work on XEmacs.
1469 Needs to be set before org.el is loaded."
1470 :group
'org-link-follow
1473 (defcustom org-mark-ring-length
4
1474 "Number of different positions to be recorded in the ring.
1475 Changing this requires a restart of Emacs to work correctly."
1476 :group
'org-link-follow
1479 (defcustom org-link-search-must-match-exact-headline
'query-to-create
1480 "Non-nil means internal links in Org files must exactly match a headline.
1481 When nil, the link search tries to match a phrase with all words
1482 in the search text."
1483 :group
'org-link-follow
1485 (const :tag
"Use fuzy text search" nil
)
1486 (const :tag
"Match only exact headline" t
)
1487 (const :tag
"Match extact headline or query to create it"
1490 (defcustom org-link-frame-setup
1491 '((vm . vm-visit-folder-other-frame
)
1492 (gnus . org-gnus-no-new-news
)
1493 (file . find-file-other-window
)
1494 (wl . wl-other-frame
))
1495 "Setup the frame configuration for following links.
1496 When following a link with Emacs, it may often be useful to display
1497 this link in another window or frame. This variable can be used to
1498 set this up for the different types of links.
1501 `vm-visit-folder-other-window'
1502 `vm-visit-folder-other-frame'
1503 For Gnus, use any of
1506 `org-gnus-no-new-news'
1507 For FILE, use any of
1509 `find-file-other-window'
1510 `find-file-other-frame'
1511 For Wanderlust use any of
1514 For the calendar, use the variable `calendar-setup'.
1515 For BBDB, it is currently only possible to display the matches in
1517 :group
'org-link-follow
1521 (const vm-visit-folder
)
1522 (const vm-visit-folder-other-window
)
1523 (const vm-visit-folder-other-frame
)))
1527 (const gnus-other-frame
)
1528 (const org-gnus-no-new-news
)))
1532 (const find-file-other-window
)
1533 (const find-file-other-frame
)))
1537 (const wl-other-frame
)))))
1539 (defcustom org-display-internal-link-with-indirect-buffer nil
1540 "Non-nil means use indirect buffer to display infile links.
1541 Activating internal links (from one location in a file to another location
1542 in the same file) normally just jumps to the location. When the link is
1543 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1545 another window. When this option is set, the other window actually displays
1546 an indirect buffer clone of the current buffer, to avoid any visibility
1547 changes to the current buffer."
1548 :group
'org-link-follow
1551 (defcustom org-open-non-existing-files nil
1552 "Non-nil means `org-open-file' will open non-existing files.
1553 When nil, an error will be generated.
1554 This variable applies only to external applications because they
1555 might choke on non-existing files. If the link is to a file that
1556 will be opened in Emacs, the variable is ignored."
1557 :group
'org-link-follow
1560 (defcustom org-open-directory-means-index-dot-org nil
1561 "Non-nil means a link to a directory really means to index.org.
1562 When nil, following a directory link will run dired or open a finder/explorer
1563 window on that directory."
1564 :group
'org-link-follow
1567 (defcustom org-link-mailto-program
'(browse-url "mailto:%a?subject=%s")
1568 "Function and arguments to call for following mailto links.
1569 This is a list with the first element being a Lisp function, and the
1570 remaining elements being arguments to the function. In string arguments,
1571 %a will be replaced by the address, and %s will be replaced by the subject
1572 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1573 :group
'org-link-follow
1575 (const :tag
"browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1576 (const :tag
"compose-mail" (compose-mail "%a" "%s"))
1577 (const :tag
"message-mail" (message-mail "%a" "%s"))
1578 (cons :tag
"other" (function) (repeat :tag
"argument" sexp
))))
1580 (defcustom org-confirm-shell-link-function
'yes-or-no-p
1581 "Non-nil means ask for confirmation before executing shell links.
1582 Shell links can be dangerous: just think about a link
1584 [[shell:rm -rf ~/*][Google Search]]
1586 This link would show up in your Org-mode document as \"Google Search\",
1587 but really it would remove your entire home directory.
1588 Therefore we advise against setting this variable to nil.
1589 Just change it to `y-or-n-p' if you want to confirm with a
1590 single keystroke rather than having to type \"yes\"."
1591 :group
'org-link-follow
1593 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
1594 (const :tag
"with y-or-n (faster)" y-or-n-p
)
1595 (const :tag
"no confirmation (dangerous)" nil
)))
1596 (put 'org-confirm-shell-link-function
1597 'safe-local-variable
1598 #'(lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
1600 (defcustom org-confirm-shell-link-not-regexp
""
1601 "A regexp to skip confirmation for shell links."
1602 :group
'org-link-follow
1605 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
1606 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1607 Elisp links can be dangerous: just think about a link
1609 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1611 This link would show up in your Org-mode document as \"Google Search\",
1612 but really it would remove your entire home directory.
1613 Therefore we advise against setting this variable to nil.
1614 Just change it to `y-or-n-p' if you want to confirm with a
1615 single keystroke rather than having to type \"yes\"."
1616 :group
'org-link-follow
1618 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
1619 (const :tag
"with y-or-n (faster)" y-or-n-p
)
1620 (const :tag
"no confirmation (dangerous)" nil
)))
1621 (put 'org-confirm-shell-link-function
1622 'safe-local-variable
1623 #'(lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
1625 (defcustom org-confirm-elisp-link-not-regexp
""
1626 "A regexp to skip confirmation for Elisp links."
1627 :group
'org-link-follow
1630 (defconst org-file-apps-defaults-gnu
1634 "Default file applications on a UNIX or GNU/Linux system.
1635 See `org-file-apps'.")
1637 (defconst org-file-apps-defaults-macosx
1640 (system .
"open %s")
1642 ("eps.gz" .
"gv %s")
1644 ("fig" .
"xfig %s"))
1645 "Default file applications on a MacOS X system.
1646 The system \"open\" is known as a default, but we use X11 applications
1647 for some files for which the OS does not have a good default.
1648 See `org-file-apps'.")
1650 (defconst org-file-apps-defaults-windowsnt
1654 (list (if (featurep 'xemacs
)
1655 'mswindows-shell-execute
1659 (list (if (featurep 'xemacs
)
1660 'mswindows-shell-execute
1663 "Default file applications on a Windows NT system.
1664 The system \"open\" is used for most files.
1665 See `org-file-apps'.")
1667 (defcustom org-file-apps
1670 ("\\.mm\\'" . default
)
1671 ("\\.x?html?\\'" . default
)
1672 ("\\.pdf\\'" . default
)
1674 "External applications for opening `file:path' items in a document.
1675 Org-mode uses system defaults for different file types, but
1676 you can use this variable to set the application for a given file
1677 extension. The entries in this list are cons cells where the car identifies
1678 files and the cdr the corresponding command. Possible values for the
1680 \"string\" A string as a file identifier can be interpreted in different
1681 ways, depending on its contents:
1683 - Alphanumeric characters only:
1684 Match links with this file extension.
1685 Example: (\"pdf\" . \"evince %s\")
1686 to open PDFs with evince.
1688 - Regular expression: Match links where the
1689 filename matches the regexp. If you want to
1690 use groups here, use shy groups.
1692 Example: (\"\\.x?html\\'\" . \"firefox %s\")
1693 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
1694 to open *.html and *.xhtml with firefox.
1696 - Regular expression which contains (non-shy) groups:
1697 Match links where the whole link, including \"::\", and
1698 anything after that, matches the regexp.
1699 In a custom command string, %1, %2, etc. are replaced with
1700 the parts of the link that were matched by the groups.
1701 For backwards compatibility, if a command string is given
1702 that does not use any of the group matches, this case is
1703 handled identically to the second one (i.e. match against
1705 In a custom lisp form, you can access the group matches with
1706 (match-string n link).
1708 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
1709 to open [[file:document.pdf::5]] with evince at page 5.
1711 `directory' Matches a directory
1712 `remote' Matches a remote file, accessible through tramp or efs.
1713 Remote files most likely should be visited through Emacs
1714 because external applications cannot handle such paths.
1715 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1716 so all files Emacs knows how to handle. Using this with
1717 command `emacs' will open most files in Emacs. Beware that this
1718 will also open html files inside Emacs, unless you add
1719 (\"html\" . default) to the list as well.
1720 t Default for files not matched by any of the other options.
1721 `system' The system command to open files, like `open' on Windows
1722 and Mac OS X, and mailcap under GNU/Linux. This is the command
1723 that will be selected if you call `C-c C-o' with a double
1724 \\[universal-argument] \\[universal-argument] prefix.
1726 Possible values for the command are:
1727 `emacs' The file will be visited by the current Emacs process.
1728 `default' Use the default application for this file type, which is the
1729 association for t in the list, most likely in the system-specific
1731 This can be used to overrule an unwanted setting in the
1732 system-specific variable.
1733 `system' Use the system command for opening files, like \"open\".
1734 This command is specified by the entry whose car is `system'.
1735 Most likely, the system-specific version of this variable
1736 does define this command, but you can overrule/replace it
1738 string A command to be executed by a shell; %s will be replaced
1739 by the path to the file.
1740 sexp A Lisp form which will be evaluated. The file path will
1741 be available in the Lisp variable `file'.
1742 For more examples, see the system specific constants
1743 `org-file-apps-defaults-macosx'
1744 `org-file-apps-defaults-windowsnt'
1745 `org-file-apps-defaults-gnu'."
1746 :group
'org-link-follow
1748 (cons (choice :value
""
1749 (string :tag
"Extension")
1750 (const :tag
"System command to open files" system
)
1751 (const :tag
"Default for unrecognized files" t
)
1752 (const :tag
"Remote file" remote
)
1753 (const :tag
"Links to a directory" directory
)
1754 (const :tag
"Any files that have Emacs modes"
1757 (const :tag
"Visit with Emacs" emacs
)
1758 (const :tag
"Use default" default
)
1759 (const :tag
"Use the system command" system
)
1760 (string :tag
"Command")
1761 (sexp :tag
"Lisp form")))))
1765 (defgroup org-refile nil
1766 "Options concerning refiling entries in Org-mode."
1770 (defcustom org-directory
"~/org"
1771 "Directory with org files.
1772 This is just a default location to look for Org files. There is no need
1773 at all to put your files into this directory. It is only used in the
1774 following situations:
1776 1. When a remember template specifies a target file that is not an
1777 absolute path. The path will then be interpreted relative to
1779 2. When a remember note is filed away in an interactive way (when exiting the
1780 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1781 with `org-directory' as the default path."
1783 :group
'org-remember
1786 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
1787 "Default target for storing notes.
1788 Used as a fall back file for org-remember.el and org-capture.el, for
1789 templates that do not specify a target file."
1791 :group
'org-remember
1793 (const :tag
"Default from remember-data-file" nil
)
1796 (defcustom org-goto-interface
'outline
1797 "The default interface to be used for `org-goto'.
1799 outline The interface shows an outline of the relevant file
1800 and the correct heading is found by moving through
1801 the outline or by searching with incremental search.
1802 outline-path-completion Headlines in the current buffer are offered via
1803 completion. This is the interface also used by
1804 the refile command."
1807 (const :tag
"Outline" outline
)
1808 (const :tag
"Outline-path-completion" outline-path-completion
)))
1810 (defcustom org-goto-max-level
5
1811 "Maximum target level when running `org-goto' with refile interface."
1815 (defcustom org-reverse-note-order nil
1816 "Non-nil means store new notes at the beginning of a file or entry.
1817 When nil, new notes will be filed to the end of a file or entry.
1818 This can also be a list with cons cells of regular expressions that
1819 are matched against file names, and values."
1820 :group
'org-remember
1823 (const :tag
"Reverse always" t
)
1824 (const :tag
"Reverse never" nil
)
1825 (repeat :tag
"By file name regexp"
1826 (cons regexp boolean
))))
1828 (defcustom org-log-refile nil
1829 "Information to record when a task is refiled.
1831 Possible values are:
1833 nil Don't add anything
1834 time Add a time stamp to the task
1835 note Prompt for a note and add it with template `org-log-note-headings'
1837 This option can also be set with on a per-file-basis with
1839 #+STARTUP: nologrefile
1840 #+STARTUP: logrefile
1841 #+STARTUP: lognoterefile
1843 You can have local logging settings for a subtree by setting the LOGGING
1844 property to one or more of these keywords.
1846 When bulk-refiling from the agenda, the value `note' is forbidden and
1847 will temporarily be changed to `time'."
1849 :group
'org-progress
1851 (const :tag
"No logging" nil
)
1852 (const :tag
"Record timestamp" time
)
1853 (const :tag
"Record timestamp with note." note
)))
1855 (defcustom org-refile-targets nil
1856 "Targets for refiling entries with \\[org-refile].
1857 This is list of cons cells. Each cell contains:
1858 - a specification of the files to be considered, either a list of files,
1859 or a symbol whose function or variable value will be used to retrieve
1860 a file name or a list of file names. If you use `org-agenda-files' for
1861 that, all agenda files will be scanned for targets. Nil means consider
1862 headings in the current buffer.
1863 - A specification of how to find candidate refile targets. This may be
1865 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
1866 This tag has to be present in all target headlines, inheritance will
1868 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
1870 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
1871 headlines that are refiling targets.
1872 - a cons cell (:level . N). Any headline of level N is considered a target.
1873 Note that, when `org-odd-levels-only' is set, level corresponds to
1874 order in hierarchy, not to the number of stars.
1875 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1876 Note that, when `org-odd-levels-only' is set, level corresponds to
1877 order in hierarchy, not to the number of stars.
1879 You can set the variable `org-refile-target-verify-function' to a function
1880 to verify each headline found by the simple criteria above.
1882 When this variable is nil, all top-level headlines in the current buffer
1883 are used, equivalent to the value `((nil . (:level . 1))'."
1887 (choice :value org-agenda-files
1888 (const :tag
"All agenda files" org-agenda-files
)
1889 (const :tag
"Current buffer" nil
)
1890 (function) (variable) (file))
1891 (choice :tag
"Identify target headline by"
1892 (cons :tag
"Specific tag" (const :value
:tag
) (string))
1893 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
1894 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
1895 (cons :tag
"Level number" (const :value
:level
) (integer))
1896 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
1898 (defcustom org-refile-target-verify-function nil
1899 "Function to verify if the headline at point should be a refile target.
1900 The function will be called without arguments, with point at the
1901 beginning of the headline. It should return t and leave point
1902 where it is if the headline is a valid target for refiling.
1904 If the target should not be selected, the function must return nil.
1905 In addition to this, it may move point to a place from where the search
1906 should be continued. For example, the function may decide that the entire
1907 subtree of the current entry should be excluded and move point to the end
1912 (defcustom org-refile-use-cache nil
1913 "Non-nil means cache refile targets to speed up the process.
1914 The cache for a particular file will be updated automatically when
1915 the buffer has been killed, or when any of the marker used for flagging
1916 refile targets no longer points at a live buffer.
1917 If you have added new entries to a buffer that might themselves be targets,
1918 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1919 find that easier, `C-u C-u C-u C-c C-w'."
1923 (defcustom org-refile-use-outline-path nil
1924 "Non-nil means provide refile targets as paths.
1925 So a level 3 headline will be available as level1/level2/level3.
1927 When the value is `file', also include the file name (without directory)
1928 into the path. In this case, you can also stop the completion after
1929 the file name, to get entries inserted as top level in the file.
1931 When `full-file-path', include the full file path."
1934 (const :tag
"Not" nil
)
1935 (const :tag
"Yes" t
)
1936 (const :tag
"Start with file name" file
)
1937 (const :tag
"Start with full file path" full-file-path
)))
1939 (defcustom org-outline-path-complete-in-steps t
1940 "Non-nil means complete the outline path in hierarchical steps.
1941 When Org-mode uses the refile interface to select an outline path
1942 \(see variable `org-refile-use-outline-path'), the completion of
1943 the path can be done is a single go, or if can be done in steps down
1944 the headline hierarchy. Going in steps is probably the best if you
1945 do not use a special completion package like `ido' or `icicles'.
1946 However, when using these packages, going in one step can be very
1947 fast, while still showing the whole path to the entry."
1951 (defcustom org-refile-allow-creating-parent-nodes nil
1952 "Non-nil means allow to create new nodes as refile targets.
1953 New nodes are then created by adding \"/new node name\" to the completion
1954 of an existing node. When the value of this variable is `confirm',
1955 new node creation must be confirmed by the user (recommended)
1956 When nil, the completion must match an existing entry.
1958 Note that, if the new heading is not seen by the criteria
1959 listed in `org-refile-targets', multiple instances of the same
1960 heading would be created by trying again to file under the new
1964 (const :tag
"Never" nil
)
1965 (const :tag
"Always" t
)
1966 (const :tag
"Prompt for confirmation" confirm
)))
1968 (defgroup org-todo nil
1969 "Options concerning TODO items in Org-mode."
1973 (defgroup org-progress nil
1974 "Options concerning Progress logging in Org-mode."
1978 (defvar org-todo-interpretation-widgets
1979 '((:tag
"Sequence (cycling hits every state)" sequence
)
1980 (:tag
"Type (cycling directly to DONE)" type
))
1981 "The available interpretation symbols for customizing `org-todo-keywords'.
1982 Interested libraries should add to this list.")
1984 (defcustom org-loop-over-siblings-within-active-region-p nil
1985 "Shall some commands act upon siblings in the active region?
1986 The list of commands is:
1989 - `org-archive-subtree'
1990 - `org-archive-to-archive-sibling'
1991 - `org-archive-set-tag'
1992 - `org-toggle-archive-tag'"
1994 :group
'org-archive
)
1996 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
1997 "List of TODO entry keyword sequences and their interpretation.
1998 \\<org-mode-map>This is a list of sequences.
2000 Each sequence starts with a symbol, either `sequence' or `type',
2001 indicating if the keywords should be interpreted as a sequence of
2002 action steps, or as different types of TODO items. The first
2003 keywords are states requiring action - these states will select a headline
2004 for inclusion into the global TODO list Org-mode produces. If one of
2005 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2006 signify that no further action is necessary. If \"|\" is not found,
2007 the last keyword is treated as the only DONE state of the sequence.
2009 The command \\[org-todo] cycles an entry through these states, and one
2010 additional state where no keyword is present. For details about this
2011 cycling, see the manual.
2013 TODO keywords and interpretation can also be set on a per-file basis with
2014 the special #+SEQ_TODO and #+TYP_TODO lines.
2016 Each keyword can optionally specify a character for fast state selection
2017 \(in combination with the variable `org-use-fast-todo-selection')
2018 and specifiers for state change logging, using the same syntax
2019 that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
2020 that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2021 indicates to record a time stamp each time this state is selected.
2023 Each keyword may also specify if a timestamp or a note should be
2024 recorded when entering or leaving the state, by adding additional
2025 characters in the parenthesis after the keyword. This looks like this:
2026 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2027 record only the time of the state change. With X and Y being either
2028 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2029 Y when leaving the state if and only if the *target* state does not
2030 define X. You may omit any of the fast-selection key or X or /Y,
2031 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2033 For backward compatibility, this variable may also be just a list
2034 of keywords - in this case the interpretation (sequence or type) will be
2035 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2037 :group
'org-keywords
2039 (repeat :tag
"Old syntax, just keywords"
2040 (string :tag
"Keyword"))
2041 (repeat :tag
"New syntax"
2044 :tag
"Interpretation"
2045 ;;Quick and dirty way to see
2046 ;;`org-todo-interpretations'. This takes the
2047 ;;place of item arguments
2055 org-todo-interpretation-widgets
))
2058 (string :tag
"Keyword"))))))
2060 (defvar org-todo-keywords-1 nil
2061 "All TODO and DONE keywords active in a buffer.")
2062 (make-variable-buffer-local 'org-todo-keywords-1
)
2063 (defvar org-todo-keywords-for-agenda nil
)
2064 (defvar org-done-keywords-for-agenda nil
)
2065 (defvar org-drawers-for-agenda nil
)
2066 (defvar org-todo-keyword-alist-for-agenda nil
)
2067 (defvar org-tag-alist-for-agenda nil
)
2068 (defvar org-agenda-contributing-files nil
)
2069 (defvar org-not-done-keywords nil
)
2070 (make-variable-buffer-local 'org-not-done-keywords
)
2071 (defvar org-done-keywords nil
)
2072 (make-variable-buffer-local 'org-done-keywords
)
2073 (defvar org-todo-heads nil
)
2074 (make-variable-buffer-local 'org-todo-heads
)
2075 (defvar org-todo-sets nil
)
2076 (make-variable-buffer-local 'org-todo-sets
)
2077 (defvar org-todo-log-states nil
)
2078 (make-variable-buffer-local 'org-todo-log-states
)
2079 (defvar org-todo-kwd-alist nil
)
2080 (make-variable-buffer-local 'org-todo-kwd-alist
)
2081 (defvar org-todo-key-alist nil
)
2082 (make-variable-buffer-local 'org-todo-key-alist
)
2083 (defvar org-todo-key-trigger nil
)
2084 (make-variable-buffer-local 'org-todo-key-trigger
)
2086 (defcustom org-todo-interpretation
'sequence
2087 "Controls how TODO keywords are interpreted.
2088 This variable is in principle obsolete and is only used for
2089 backward compatibility, if the interpretation of todo keywords is
2090 not given already in `org-todo-keywords'. See that variable for
2093 :group
'org-keywords
2094 :type
'(choice (const sequence
)
2097 (defcustom org-use-fast-todo-selection t
2098 "Non-nil means use the fast todo selection scheme with C-c C-t.
2099 This variable describes if and under what circumstances the cycling
2100 mechanism for TODO keywords will be replaced by a single-key, direct
2103 When nil, fast selection is never used.
2105 When the symbol `prefix', it will be used when `org-todo' is called with
2106 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2107 in an agenda buffer.
2109 When t, fast selection is used by default. In this case, the prefix
2110 argument forces cycling instead.
2112 In all cases, the special interface is only used if access keys have actually
2113 been assigned by the user, i.e. if keywords in the configuration are followed
2114 by a letter in parenthesis, like TODO(t)."
2117 (const :tag
"Never" nil
)
2118 (const :tag
"By default" t
)
2119 (const :tag
"Only with C-u C-c C-t" prefix
)))
2121 (defcustom org-provide-todo-statistics t
2122 "Non-nil means update todo statistics after insert and toggle.
2123 ALL-HEADLINES means update todo statistics by including headlines
2124 with no TODO keyword as well, counting them as not done.
2125 A list of TODO keywords means the same, but skip keywords that are
2128 When this is set, todo statistics is updated in the parent of the
2129 current entry each time a todo state is changed."
2132 (const :tag
"Yes, only for TODO entries" t
)
2133 (const :tag
"Yes, including all entries" 'all-headlines
)
2134 (repeat :tag
"Yes, for TODOs in this list"
2135 (string :tag
"TODO keyword"))
2136 (other :tag
"No TODO statistics" nil
)))
2138 (defcustom org-hierarchical-todo-statistics t
2139 "Non-nil means TODO statistics covers just direct children.
2140 When nil, all entries in the subtree are considered.
2141 This has only an effect if `org-provide-todo-statistics' is set.
2142 To set this to nil for only a single subtree, use a COOKIE_DATA
2143 property and include the word \"recursive\" into the value."
2147 (defcustom org-after-todo-state-change-hook nil
2148 "Hook which is run after the state of a TODO item was changed.
2149 The new state (a string with a TODO keyword, or nil) is available in the
2150 Lisp variable `state'."
2154 (defvar org-blocker-hook nil
2155 "Hook for functions that are allowed to block a state change.
2157 Each function gets as its single argument a property list, see
2158 `org-trigger-hook' for more information about this list.
2160 If any of the functions in this hook returns nil, the state change
2163 (defvar org-trigger-hook nil
2164 "Hook for functions that are triggered by a state change.
2166 Each function gets as its single argument a property list with at least
2167 the following elements:
2169 (:type type-of-change :position pos-at-entry-start
2170 :from old-state :to new-state)
2172 Depending on the type, more properties may be present.
2174 This mechanism is currently implemented for:
2178 :type todo-state-change
2179 :from previous state (keyword as a string), or nil, or a symbol
2180 'todo' or 'done', to indicate the general type of state.
2181 :to new state, like in :from")
2183 (defcustom org-enforce-todo-dependencies nil
2184 "Non-nil means undone TODO entries will block switching the parent to DONE.
2185 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2186 be blocked if any prior sibling is not yet done.
2187 Finally, if the parent is blocked because of ordered siblings of its own,
2188 the child will also be blocked.
2189 This variable needs to be set before org.el is loaded, and you need to
2190 restart Emacs after a change to make the change effective. The only way
2191 to change is while Emacs is running is through the customize interface."
2192 :set
(lambda (var val
)
2195 (add-hook 'org-blocker-hook
2196 'org-block-todo-from-children-or-siblings-or-parent
)
2197 (remove-hook 'org-blocker-hook
2198 'org-block-todo-from-children-or-siblings-or-parent
)))
2202 (defcustom org-enforce-todo-checkbox-dependencies nil
2203 "Non-nil means unchecked boxes will block switching the parent to DONE.
2204 When this is nil, checkboxes have no influence on switching TODO states.
2205 When non-nil, you first need to check off all check boxes before the TODO
2206 entry can be switched to DONE.
2207 This variable needs to be set before org.el is loaded, and you need to
2208 restart Emacs after a change to make the change effective. The only way
2209 to change is while Emacs is running is through the customize interface."
2210 :set
(lambda (var val
)
2213 (add-hook 'org-blocker-hook
2214 'org-block-todo-from-checkboxes
)
2215 (remove-hook 'org-blocker-hook
2216 'org-block-todo-from-checkboxes
)))
2220 (defcustom org-treat-insert-todo-heading-as-state-change nil
2221 "Non-nil means inserting a TODO heading is treated as state change.
2222 So when the command \\[org-insert-todo-heading] is used, state change
2223 logging will apply if appropriate. When nil, the new TODO item will
2224 be inserted directly, and no logging will take place."
2228 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2229 "Non-nil means switching TODO states with S-cursor counts as state change.
2230 This is the default behavior. However, setting this to nil allows a
2231 convenient way to select a TODO state and bypass any logging associated
2236 (defcustom org-todo-state-tags-triggers nil
2237 "Tag changes that should be triggered by TODO state changes.
2238 This is a list. Each entry is
2240 (state-change (tag . flag) .......)
2242 State-change can be a string with a state, and empty string to indicate the
2243 state that has no TODO keyword, or it can be one of the symbols `todo'
2244 or `done', meaning any not-done or done state, respectively."
2248 (cons (choice :tag
"When changing to"
2249 (const :tag
"Not-done state" todo
)
2250 (const :tag
"Done state" done
)
2251 (string :tag
"State"))
2253 (cons :tag
"Tag action"
2255 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2257 (defcustom org-log-done nil
2258 "Information to record when a task moves to the DONE state.
2260 Possible values are:
2262 nil Don't add anything, just change the keyword
2263 time Add a time stamp to the task
2264 note Prompt for a note and add it with template `org-log-note-headings'
2266 This option can also be set with on a per-file-basis with
2268 #+STARTUP: nologdone
2270 #+STARTUP: lognotedone
2272 You can have local logging settings for a subtree by setting the LOGGING
2273 property to one or more of these keywords."
2275 :group
'org-progress
2277 (const :tag
"No logging" nil
)
2278 (const :tag
"Record CLOSED timestamp" time
)
2279 (const :tag
"Record CLOSED timestamp with note." note
)))
2281 ;; Normalize old uses of org-log-done.
2283 ((eq org-log-done t
) (setq org-log-done
'time
))
2284 ((and (listp org-log-done
) (memq 'done org-log-done
))
2285 (setq org-log-done
'note
)))
2287 (defcustom org-log-reschedule nil
2288 "Information to record when the scheduling date of a tasks is modified.
2290 Possible values are:
2292 nil Don't add anything, just change the date
2293 time Add a time stamp to the task
2294 note Prompt for a note and add it with template `org-log-note-headings'
2296 This option can also be set with on a per-file-basis with
2298 #+STARTUP: nologreschedule
2299 #+STARTUP: logreschedule
2300 #+STARTUP: lognotereschedule"
2302 :group
'org-progress
2304 (const :tag
"No logging" nil
)
2305 (const :tag
"Record timestamp" time
)
2306 (const :tag
"Record timestamp with note." note
)))
2308 (defcustom org-log-redeadline nil
2309 "Information to record when the deadline date of a tasks is modified.
2311 Possible values are:
2313 nil Don't add anything, just change the date
2314 time Add a time stamp to the task
2315 note Prompt for a note and add it with template `org-log-note-headings'
2317 This option can also be set with on a per-file-basis with
2319 #+STARTUP: nologredeadline
2320 #+STARTUP: logredeadline
2321 #+STARTUP: lognoteredeadline
2323 You can have local logging settings for a subtree by setting the LOGGING
2324 property to one or more of these keywords."
2326 :group
'org-progress
2328 (const :tag
"No logging" nil
)
2329 (const :tag
"Record timestamp" time
)
2330 (const :tag
"Record timestamp with note." note
)))
2332 (defcustom org-log-note-clock-out nil
2333 "Non-nil means record a note when clocking out of an item.
2334 This can also be configured on a per-file basis by adding one of
2335 the following lines anywhere in the buffer:
2337 #+STARTUP: lognoteclock-out
2338 #+STARTUP: nolognoteclock-out"
2340 :group
'org-progress
2343 (defcustom org-log-done-with-time t
2344 "Non-nil means the CLOSED time stamp will contain date and time.
2345 When nil, only the date will be recorded."
2346 :group
'org-progress
2349 (defcustom org-log-note-headings
2350 '((done .
"CLOSING NOTE %t")
2351 (state .
"State %-12s from %-12S %t")
2352 (note .
"Note taken on %t")
2353 (reschedule .
"Rescheduled from %S on %t")
2354 (delschedule .
"Not scheduled, was %S on %t")
2355 (redeadline .
"New deadline from %S on %t")
2356 (deldeadline .
"Removed deadline, was %S on %t")
2357 (refile .
"Refiled on %t")
2359 "Headings for notes added to entries.
2360 The value is an alist, with the car being a symbol indicating the note
2361 context, and the cdr is the heading to be used. The heading may also be the
2363 %t in the heading will be replaced by a time stamp.
2364 %T will be an active time stamp instead the default inactive one
2365 %s will be replaced by the new TODO state, in double quotes.
2366 %S will be replaced by the old TODO state, in double quotes.
2367 %u will be replaced by the user name.
2368 %U will be replaced by the full user name.
2370 In fact, it is not a good idea to change the `state' entry, because
2371 agenda log mode depends on the format of these entries."
2373 :group
'org-progress
2374 :type
'(list :greedy t
2375 (cons (const :tag
"Heading when closing an item" done
) string
)
2377 "Heading when changing todo state (todo sequence only)"
2379 (cons (const :tag
"Heading when just taking a note" note
) string
)
2380 (cons (const :tag
"Heading when clocking out" clock-out
) string
)
2381 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2382 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2383 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2384 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2385 (cons (const :tag
"Heading when refiling" refile
) string
)))
2387 (unless (assq 'note org-log-note-headings
)
2388 (push '(note .
"%t") org-log-note-headings
))
2390 (defcustom org-log-into-drawer nil
2391 "Non-nil means insert state change notes and time stamps into a drawer.
2392 When nil, state changes notes will be inserted after the headline and
2393 any scheduling and clock lines, but not inside a drawer.
2395 The value of this variable should be the name of the drawer to use.
2396 LOGBOOK is proposed as the default drawer for this purpose, you can
2397 also set this to a string to define the drawer of your choice.
2399 A value of t is also allowed, representing \"LOGBOOK\".
2401 If this variable is set, `org-log-state-notes-insert-after-drawers'
2404 You can set the property LOG_INTO_DRAWER to overrule this setting for
2407 :group
'org-progress
2409 (const :tag
"Not into a drawer" nil
)
2410 (const :tag
"LOGBOOK" t
)
2411 (string :tag
"Other")))
2413 (if (fboundp 'defvaralias
)
2414 (defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
))
2416 (defun org-log-into-drawer ()
2417 "Return the value of `org-log-into-drawer', but let properties overrule.
2418 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2419 used instead of the default value."
2420 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit
)))
2422 ((or (not p
) (equal p
"nil")) org-log-into-drawer
)
2423 ((equal p
"t") "LOGBOOK")
2426 (defcustom org-log-state-notes-insert-after-drawers nil
2427 "Non-nil means insert state change notes after any drawers in entry.
2428 Only the drawers that *immediately* follow the headline and the
2429 deadline/scheduled line are skipped.
2430 When nil, insert notes right after the heading and perhaps the line
2431 with deadline/scheduling if present.
2433 This variable will have no effect if `org-log-into-drawer' is
2436 :group
'org-progress
2439 (defcustom org-log-states-order-reversed t
2440 "Non-nil means the latest state note will be directly after heading.
2441 When nil, the state change notes will be ordered according to time."
2443 :group
'org-progress
2446 (defcustom org-todo-repeat-to-state nil
2447 "The TODO state to which a repeater should return the repeating task.
2448 By default this is the first task in a TODO sequence, or the previous state
2449 in a TODO_TYP set. But you can specify another task here.
2450 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2452 :type
'(choice (const :tag
"Head of sequence" nil
)
2453 (string :tag
"Specific state")))
2455 (defcustom org-log-repeat
'time
2456 "Non-nil means record moving through the DONE state when triggering repeat.
2457 An auto-repeating task is immediately switched back to TODO when
2458 marked DONE. If you are not logging state changes (by adding \"@\"
2459 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2460 record a closing note, there will be no record of the task moving
2461 through DONE. This variable forces taking a note anyway.
2463 nil Don't force a record
2464 time Record a time stamp
2467 This option can also be set with on a per-file-basis with
2469 #+STARTUP: logrepeat
2470 #+STARTUP: lognoterepeat
2471 #+STARTUP: nologrepeat
2473 You can have local logging settings for a subtree by setting the LOGGING
2474 property to one or more of these keywords."
2476 :group
'org-progress
2478 (const :tag
"Don't force a record" nil
)
2479 (const :tag
"Force recording the DONE state" time
)
2480 (const :tag
"Force recording a note with the DONE state" note
)))
2483 (defgroup org-priorities nil
2484 "Priorities in Org-mode."
2485 :tag
"Org Priorities"
2488 (defcustom org-enable-priority-commands t
2489 "Non-nil means priority commands are active.
2490 When nil, these commands will be disabled, so that you never accidentally
2492 :group
'org-priorities
2495 (defcustom org-highest-priority ?A
2496 "The highest priority of TODO items. A character like ?A, ?B etc.
2497 Must have a smaller ASCII number than `org-lowest-priority'."
2498 :group
'org-priorities
2501 (defcustom org-lowest-priority ?C
2502 "The lowest priority of TODO items. A character like ?A, ?B etc.
2503 Must have a larger ASCII number than `org-highest-priority'."
2504 :group
'org-priorities
2507 (defcustom org-default-priority ?B
2508 "The default priority of TODO items.
2509 This is the priority an item gets if no explicit priority is given.
2510 When starting to cycle on an empty priority the first step in the cycle
2511 depends on `org-priority-start-cycle-with-default'. The resulting first
2512 step priority must not exceed the range from `org-highest-priority' to
2513 `org-lowest-priority' which means that `org-default-priority' has to be
2514 in this range exclusive or inclusive the range boundaries. Else the
2515 first step refuses to set the default and the second will fall back
2516 to (depending on the command used) the highest or lowest priority."
2517 :group
'org-priorities
2520 (defcustom org-priority-start-cycle-with-default t
2521 "Non-nil means start with default priority when starting to cycle.
2522 When this is nil, the first step in the cycle will be (depending on the
2523 command used) one higher or lower than the default priority.
2524 See also `org-default-priority'."
2525 :group
'org-priorities
2528 (defcustom org-get-priority-function nil
2529 "Function to extract the priority from a string.
2530 The string is normally the headline. If this is nil Org computes the
2531 priority from the priority cookie like [#A] in the headline. It returns
2532 an integer, increasing by 1000 for each priority level.
2533 The user can set a different function here, which should take a string
2534 as an argument and return the numeric priority."
2535 :group
'org-priorities
2538 (defgroup org-time nil
2539 "Options concerning time stamps and deadlines in Org-mode."
2543 (defcustom org-insert-labeled-timestamps-at-point nil
2544 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2545 When nil, these labeled time stamps are forces into the second line of an
2546 entry, just after the headline. When scheduling from the global TODO list,
2547 the time stamp will always be forced into the second line."
2551 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
2552 "Formats for `format-time-string' which are used for time stamps.
2553 It is not recommended to change this constant.")
2555 (defcustom org-time-stamp-rounding-minutes
'(0 5)
2556 "Number of minutes to round time stamps to.
2557 These are two values, the first applies when first creating a time stamp.
2558 The second applies when changing it with the commands `S-up' and `S-down'.
2559 When changing the time stamp, this means that it will change in steps
2560 of N minutes, as given by the second value.
2562 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2563 numbers should be factors of 60, so for example 5, 10, 15.
2565 When this is larger than 1, you can still force an exact time stamp by using
2566 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2567 and by using a prefix arg to `S-up/down' to specify the exact number
2568 of minutes to shift."
2570 :get
#'(lambda (var) ; Make sure both elements are there
2571 (if (integerp (default-value var
))
2572 (list (default-value var
) 5)
2573 (default-value var
)))
2575 (integer :tag
"when inserting times")
2576 (integer :tag
"when modifying times")))
2578 ;; Normalize old customizations of this variable.
2579 (when (integerp org-time-stamp-rounding-minutes
)
2580 (setq org-time-stamp-rounding-minutes
2581 (list org-time-stamp-rounding-minutes
2582 org-time-stamp-rounding-minutes
)))
2584 (defcustom org-display-custom-times nil
2585 "Non-nil means overlay custom formats over all time stamps.
2586 The formats are defined through the variable `org-time-stamp-custom-formats'.
2587 To turn this on on a per-file basis, insert anywhere in the file:
2588 #+STARTUP: customtime"
2592 (make-variable-buffer-local 'org-display-custom-times
)
2594 (defcustom org-time-stamp-custom-formats
2595 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
2596 "Custom formats for time stamps. See `format-time-string' for the syntax.
2597 These are overlayed over the default ISO format if the variable
2598 `org-display-custom-times' is set. Time like %H:%M should be at the
2599 end of the second format. The custom formats are also honored by export
2600 commands, if custom time display is turned on at the time of export."
2604 (defun org-time-stamp-format (&optional long inactive
)
2605 "Get the right format for a time string."
2606 (let ((f (if long
(cdr org-time-stamp-formats
)
2607 (car org-time-stamp-formats
))))
2609 (concat "[" (substring f
1 -
1) "]")
2612 (defcustom org-time-clocksum-format
"%d:%02d"
2613 "The format string used when creating CLOCKSUM lines.
2614 This is also used when org-mode generates a time duration."
2618 (defcustom org-time-clocksum-use-fractional nil
2619 "If non-nil, \\[org-clock-display] uses fractional times.
2620 org-mode generates a time duration."
2624 (defcustom org-time-clocksum-fractional-format
"%.2f"
2625 "The format string used when creating CLOCKSUM lines, or when
2626 org-mode generates a time duration."
2630 (defcustom org-deadline-warning-days
14
2631 "No. of days before expiration during which a deadline becomes active.
2632 This variable governs the display in sparse trees and in the agenda.
2633 When 0 or negative, it means use this number (the absolute value of it)
2634 even if a deadline has a different individual lead time specified.
2636 Custom commands can set this variable in the options section."
2638 :group
'org-agenda-daily
/weekly
2641 (defcustom org-read-date-prefer-future t
2642 "Non-nil means assume future for incomplete date input from user.
2643 This affects the following situations:
2644 1. The user gives a month but not a year.
2645 For example, if it is April and you enter \"feb 2\", this will be read
2646 as Feb 2, *next* year. \"May 5\", however, will be this year.
2647 2. The user gives a day, but no month.
2648 For example, if today is the 15th, and you enter \"3\", Org-mode will
2649 read this as the third of *next* month. However, if you enter \"17\",
2650 it will be considered as *this* month.
2652 If you set this variable to the symbol `time', then also the following
2655 3. If the user gives a time, but no day. If the time is before now,
2656 to will be interpreted as tomorrow.
2658 Currently none of this works for ISO week specifications.
2660 When this option is nil, the current day, month and year will always be
2663 See also `org-agenda-jump-prefer-future'."
2666 (const :tag
"Never" nil
)
2667 (const :tag
"Check month and day" t
)
2668 (const :tag
"Check month, day, and time" time
)))
2670 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
2671 "Should the agenda jump command prefer the future for incomplete dates?
2672 The default is to do the same as configured in `org-read-date-prefer-future'.
2673 But you can also set a deviating value here.
2674 This may t or nil, or the symbol `org-read-date-prefer-future'."
2678 (const :tag
"Use org-read-date-prefer-future"
2679 org-read-date-prefer-future
)
2680 (const :tag
"Never" nil
)
2681 (const :tag
"Always" t
)))
2683 (defcustom org-read-date-force-compatible-dates t
2684 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2686 Depending on the system Emacs is running on, certain dates cannot
2687 be represented with the type used internally to represent time.
2688 Dates between 1970-1-1 and 2038-1-1 can always be represented
2689 correctly. Some systems allow for earlier dates, some for later,
2690 some for both. One way to find out it to insert any date into an
2691 Org buffer, putting the cursor on the year and hitting S-up and
2692 S-down to test the range.
2694 When this variable is set to t, the date/time prompt will not let
2695 you specify dates outside the 1970-2037 range, so it is certain that
2696 these dates will work in whatever version of Emacs you are
2697 running, and also that you can move a file from one Emacs implementation
2698 to another. WHenever Org is forcing the year for you, it will display
2701 When this variable is nil, Org will check if the date is
2702 representable in the specific Emacs implementation you are using.
2703 If not, it will force a year, usually the current year, and beep
2704 to remind you. Currently this setting is not recommended because
2705 the likelihood that you will open your Org files in an Emacs that
2706 has limited date range is not negligible.
2708 A workaround for this problem is to use diary sexp dates for time
2709 stamps outside of this range."
2713 (defcustom org-read-date-display-live t
2714 "Non-nil means display current interpretation of date prompt live.
2715 This display will be in an overlay, in the minibuffer."
2719 (defcustom org-read-date-popup-calendar t
2720 "Non-nil means pop up a calendar when prompting for a date.
2721 In the calendar, the date can be selected with mouse-1. However, the
2722 minibuffer will also be active, and you can simply enter the date as well.
2723 When nil, only the minibuffer will be available."
2726 (if (fboundp 'defvaralias
)
2727 (defvaralias 'org-popup-calendar-for-date-prompt
2728 'org-read-date-popup-calendar
))
2730 (defcustom org-read-date-minibuffer-setup-hook nil
2731 "Hook to be used to set up keys for the date/time interface.
2732 Add key definitions to `minibuffer-local-map', which will be a temporary
2737 (defcustom org-extend-today-until
0
2738 "The hour when your day really ends. Must be an integer.
2739 This has influence for the following applications:
2740 - When switching the agenda to \"today\". It it is still earlier than
2741 the time given here, the day recognized as TODAY is actually yesterday.
2742 - When a date is read from the user and it is still before the time given
2743 here, the current date and time will be assumed to be yesterday, 23:59.
2744 Also, timestamps inserted in remember templates follow this rule.
2746 IMPORTANT: This is a feature whose implementation is and likely will
2747 remain incomplete. Really, it is only here because past midnight seems to
2748 be the favorite working time of John Wiegley :-)"
2752 (defcustom org-edit-timestamp-down-means-later nil
2753 "Non-nil means S-down will increase the time in a time stamp.
2754 When nil, S-up will increase."
2758 (defcustom org-calendar-follow-timestamp-change t
2759 "Non-nil means make the calendar window follow timestamp changes.
2760 When a timestamp is modified and the calendar window is visible, it will be
2761 moved to the new date."
2765 (defgroup org-tags nil
2766 "Options concerning tags in Org-mode."
2770 (defcustom org-tag-alist nil
2771 "List of tags allowed in Org-mode files.
2772 When this list is nil, Org-mode will base TAG input on what is already in the
2774 The value of this variable is an alist, the car of each entry must be a
2775 keyword as a string, the cdr may be a character that is used to select
2776 that tag through the fast-tag-selection interface.
2777 See the manual for details."
2781 (cons (string :tag
"Tag name")
2782 (character :tag
"Access char"))
2783 (list :tag
"Start radio group"
2785 (option (string :tag
"Group description")))
2786 (list :tag
"End radio group"
2788 (option (string :tag
"Group description")))
2789 (const :tag
"New line" (:newline
)))))
2791 (defcustom org-tag-persistent-alist nil
2792 "List of tags that will always appear in all Org-mode files.
2793 This is in addition to any in buffer settings or customizations
2795 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2796 The value of this variable is an alist, the car of each entry must be a
2797 keyword as a string, the cdr may be a character that is used to select
2798 that tag through the fast-tag-selection interface.
2799 See the manual for details.
2800 To disable these tags on a per-file basis, insert anywhere in the file:
2805 (cons (string :tag
"Tag name")
2806 (character :tag
"Access char"))
2807 (const :tag
"Start radio group" (:startgroup
))
2808 (const :tag
"End radio group" (:endgroup
))
2809 (const :tag
"New line" (:newline
)))))
2811 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
2812 "If non-nil, always offer completion for all tags of all agenda files.
2813 Instead of customizing this variable directly, you might want to
2814 set it locally for capture buffers, because there no list of
2815 tags in that file can be created dynamically (there are none).
2817 (add-hook 'org-capture-mode-hook
2819 (set (make-local-variable
2820 'org-complete-tags-always-offer-all-agenda-tags)
2825 (defvar org-file-tags nil
2826 "List of tags that can be inherited by all entries in the file.
2827 The tags will be inherited if the variable `org-use-tag-inheritance'
2828 says they should be.
2829 This variable is populated from #+FILETAGS lines.")
2831 (defcustom org-use-fast-tag-selection
'auto
2832 "Non-nil means use fast tag selection scheme.
2833 This is a special interface to select and deselect tags with single keys.
2834 When nil, fast selection is never used.
2835 When the symbol `auto', fast selection is used if and only if selection
2836 characters for tags have been configured, either through the variable
2837 `org-tag-alist' or through a #+TAGS line in the buffer.
2838 When t, fast selection is always used and selection keys are assigned
2839 automatically if necessary."
2842 (const :tag
"Always" t
)
2843 (const :tag
"Never" nil
)
2844 (const :tag
"When selection characters are configured" 'auto
)))
2846 (defcustom org-fast-tag-selection-single-key nil
2847 "Non-nil means fast tag selection exits after first change.
2848 When nil, you have to press RET to exit it.
2849 During fast tag selection, you can toggle this flag with `C-c'.
2850 This variable can also have the value `expert'. In this case, the window
2851 displaying the tags menu is not even shown, until you press C-c again."
2854 (const :tag
"No" nil
)
2855 (const :tag
"Yes" t
)
2856 (const :tag
"Expert" expert
)))
2858 (defvar org-fast-tag-selection-include-todo nil
2859 "Non-nil means fast tags selection interface will also offer TODO states.
2860 This is an undocumented feature, you should not rely on it.")
2862 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
2863 "The column to which tags should be indented in a headline.
2864 If this number is positive, it specifies the column. If it is negative,
2865 it means that the tags should be flushright to that column. For example,
2866 -80 works well for a normal 80 character screen."
2870 (defcustom org-auto-align-tags t
2871 "Non-nil keeps tags aligned when modifying headlines.
2872 Some operations (i.e. demoting) change the length of a headline and
2873 therefore shift the tags around. With this option turned on, after
2874 each such operation the tags are again aligned to `org-tags-column'."
2878 (defcustom org-use-tag-inheritance t
2879 "Non-nil means tags in levels apply also for sublevels.
2880 When nil, only the tags directly given in a specific line apply there.
2881 This may also be a list of tags that should be inherited, or a regexp that
2882 matches tags that should be inherited. Additional control is possible
2883 with the variable `org-tags-exclude-from-inheritance' which gives an
2884 explicit list of tags to be excluded from inheritance., even if the value of
2885 `org-use-tag-inheritance' would select it for inheritance.
2887 If this option is t, a match early-on in a tree can lead to a large
2888 number of matches in the subtree when constructing the agenda or creating
2889 a sparse tree. If you only want to see the first match in a tree during
2890 a search, check out the variable `org-tags-match-list-sublevels'."
2893 (const :tag
"Not" nil
)
2894 (const :tag
"Always" t
)
2895 (repeat :tag
"Specific tags" (string :tag
"Tag"))
2896 (regexp :tag
"Tags matched by regexp")))
2898 (defcustom org-tags-exclude-from-inheritance nil
2899 "List of tags that should never be inherited.
2900 This is a way to exclude a few tags from inheritance. For way to do
2901 the opposite, to actively allow inheritance for selected tags,
2902 see the variable `org-use-tag-inheritance'."
2904 :type
'(repeat (string :tag
"Tag")))
2906 (defun org-tag-inherit-p (tag)
2907 "Check if TAG is one that should be inherited."
2909 ((member tag org-tags-exclude-from-inheritance
) nil
)
2910 ((eq org-use-tag-inheritance t
) t
)
2911 ((not org-use-tag-inheritance
) nil
)
2912 ((stringp org-use-tag-inheritance
)
2913 (string-match org-use-tag-inheritance tag
))
2914 ((listp org-use-tag-inheritance
)
2915 (member tag org-use-tag-inheritance
))
2916 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
2918 (defcustom org-tags-match-list-sublevels t
2919 "Non-nil means list also sublevels of headlines matching a search.
2920 This variable applies to tags/property searches, and also to stuck
2921 projects because this search is based on a tags match as well.
2923 When set to the symbol `indented', sublevels are indented with
2926 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2927 the sublevels of a headline matching a tag search often also match
2928 the same search. Listing all of them can create very long lists.
2929 Setting this variable to nil causes subtrees of a match to be skipped.
2931 This variable is semi-obsolete and probably should always be true. It
2932 is better to limit inheritance to certain tags using the variables
2933 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2936 (const :tag
"No, don't list them" nil
)
2937 (const :tag
"Yes, do list them" t
)
2938 (const :tag
"List them, indented with leading dots" indented
)))
2940 (defcustom org-tags-sort-function nil
2941 "When set, tags are sorted using this function as a comparator."
2944 (const :tag
"No sorting" nil
)
2945 (const :tag
"Alphabetical" string
<)
2946 (const :tag
"Reverse alphabetical" string
>)
2947 (function :tag
"Custom function" nil
)))
2949 (defvar org-tags-history nil
2950 "History of minibuffer reads for tags.")
2951 (defvar org-last-tags-completion-table nil
2952 "The last used completion table for tags.")
2953 (defvar org-after-tags-change-hook nil
2954 "Hook that is run after the tags in a line have changed.")
2956 (defgroup org-properties nil
2957 "Options concerning properties in Org-mode."
2958 :tag
"Org Properties"
2961 (defcustom org-property-format
"%-10s %s"
2962 "How property key/value pairs should be formatted by `indent-line'.
2963 When `indent-line' hits a property definition, it will format the line
2964 according to this format, mainly to make sure that the values are
2965 lined-up with respect to each other."
2966 :group
'org-properties
2969 (defcustom org-use-property-inheritance nil
2970 "Non-nil means properties apply also for sublevels.
2972 This setting is chiefly used during property searches. Turning it on can
2973 cause significant overhead when doing a search, which is why it is not
2976 When nil, only the properties directly given in the current entry count.
2977 When t, every property is inherited. The value may also be a list of
2978 properties that should have inheritance, or a regular expression matching
2979 properties that should be inherited.
2981 However, note that some special properties use inheritance under special
2982 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2983 and the properties ending in \"_ALL\" when they are used as descriptor
2984 for valid values of a property.
2986 Note for programmers:
2987 When querying an entry with `org-entry-get', you can control if inheritance
2988 should be used. By default, `org-entry-get' looks only at the local
2989 properties. You can request inheritance by setting the inherit argument
2990 to t (to force inheritance) or to `selective' (to respect the setting
2992 :group
'org-properties
2994 (const :tag
"Not" nil
)
2995 (const :tag
"Always" t
)
2996 (repeat :tag
"Specific properties" (string :tag
"Property"))
2997 (regexp :tag
"Properties matched by regexp")))
2999 (defun org-property-inherit-p (property)
3000 "Check if PROPERTY is one that should be inherited."
3002 ((eq org-use-property-inheritance t
) t
)
3003 ((not org-use-property-inheritance
) nil
)
3004 ((stringp org-use-property-inheritance
)
3005 (string-match org-use-property-inheritance property
))
3006 ((listp org-use-property-inheritance
)
3007 (member property org-use-property-inheritance
))
3008 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3010 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3011 "The default column format, if no other format has been defined.
3012 This variable can be set on the per-file basis by inserting a line
3014 #+COLUMNS: %25ITEM ....."
3015 :group
'org-properties
3018 (defcustom org-columns-ellipses
".."
3019 "The ellipses to be used when a field in column view is truncated.
3020 When this is the empty string, as many characters as possible are shown,
3021 but then there will be no visual indication that the field has been truncated.
3022 When this is a string of length N, the last N characters of a truncated
3023 field are replaced by this string. If the column is narrower than the
3024 ellipses string, only part of the ellipses string will be shown."
3025 :group
'org-properties
3028 (defcustom org-columns-modify-value-for-display-function nil
3029 "Function that modifies values for display in column view.
3030 For example, it can be used to cut out a certain part from a time stamp.
3031 The function must take 2 arguments:
3033 column-title The title of the column (*not* the property name)
3034 value The value that should be modified.
3036 The function should return the value that should be displayed,
3037 or nil if the normal value should be used."
3038 :group
'org-properties
3041 (defcustom org-effort-property
"Effort"
3042 "The property that is being used to keep track of effort estimates.
3043 Effort estimates given in this property need to have the format H:MM."
3044 :group
'org-properties
3045 :group
'org-progress
3046 :type
'(string :tag
"Property"))
3048 (defconst org-global-properties-fixed
3049 '(("VISIBILITY_ALL" .
"folded children content all")
3050 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3051 "List of property/value pairs that can be inherited by any entry.
3053 These are fixed values, for the preset properties. The user variable
3054 that can be used to add to this list is `org-global-properties'.
3056 The entries in this list are cons cells where the car is a property
3057 name and cdr is a string with the value. If the value represents
3058 multiple items like an \"_ALL\" property, separate the items by
3061 (defcustom org-global-properties nil
3062 "List of property/value pairs that can be inherited by any entry.
3064 This list will be combined with the constant `org-global-properties-fixed'.
3066 The entries in this list are cons cells where the car is a property
3067 name and cdr is a string with the value.
3069 You can set buffer-local values for the same purpose in the variable
3070 `org-file-properties' this by adding lines like
3072 #+PROPERTY: NAME VALUE"
3073 :group
'org-properties
3075 (cons (string :tag
"Property")
3076 (string :tag
"Value"))))
3078 (defvar org-file-properties nil
3079 "List of property/value pairs that can be inherited by any entry.
3080 Valid for the current buffer.
3081 This variable is populated from #+PROPERTY lines.")
3082 (make-variable-buffer-local 'org-file-properties
)
3084 (defgroup org-agenda nil
3085 "Options concerning agenda views in Org-mode."
3089 (defvar org-category nil
3090 "Variable used by org files to set a category for agenda display.
3091 Such files should use a file variable to set it, for example
3093 # -*- mode: org; org-category: \"ELisp\"
3095 or contain a special line
3099 If the file does not specify a category, then file's base name
3101 (make-variable-buffer-local 'org-category
)
3102 (put 'org-category
'safe-local-variable
#'(lambda (x) (or (symbolp x
) (stringp x
))))
3104 (defcustom org-agenda-files nil
3105 "The files to be used for agenda display.
3106 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3107 \\[org-remove-file]. You can also use customize to edit the list.
3109 If an entry is a directory, all files in that directory that are matched by
3110 `org-agenda-file-regexp' will be part of the file list.
3112 If the value of the variable is not a list but a single file name, then
3113 the list of agenda files is actually stored and maintained in that file, one
3114 agenda file per line. In this file paths can be given relative to
3115 `org-directory'. Tilde expansion and environment variable substitution
3119 (repeat :tag
"List of files and directories" file
)
3120 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3122 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3123 "Regular expression to match files for `org-agenda-files'.
3124 If any element in the list in that variable contains a directory instead
3125 of a normal file, all files in that directory that are matched by this
3126 regular expression will be included."
3130 (defcustom org-agenda-text-search-extra-files nil
3131 "List of extra files to be searched by text search commands.
3132 These files will be search in addition to the agenda files by the
3133 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3134 Note that these files will only be searched for text search commands,
3135 not for the other agenda views like todo lists, tag searches or the weekly
3136 agenda. This variable is intended to list notes and possibly archive files
3137 that should also be searched by these two commands.
3138 In fact, if the first element in the list is the symbol `agenda-archives',
3139 than all archive files of all agenda files will be added to the search
3142 :type
'(set :greedy t
3143 (const :tag
"Agenda Archives" agenda-archives
)
3144 (repeat :inline t
(file))))
3146 (if (fboundp 'defvaralias
)
3147 (defvaralias 'org-agenda-multi-occur-extra-files
3148 'org-agenda-text-search-extra-files
))
3150 (defcustom org-agenda-skip-unavailable-files nil
3151 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3152 A nil value means to remove them, after a query, from the list."
3156 (defcustom org-calendar-to-agenda-key
[?c
]
3157 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3158 The command `org-calendar-goto-agenda' will be bound to this key. The
3159 default is the character `c' because then `c' can be used to switch back and
3160 forth between agenda and calendar."
3164 (defcustom org-calendar-agenda-action-key
[?k
]
3165 "The key to be installed in `calendar-mode-map' for agenda-action.
3166 The command `org-agenda-action' will be bound to this key. The
3167 default is the character `k' because we use the same key in the agenda."
3171 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3172 "The key to be installed in `calendar-mode-map' for adding diary entries.
3173 This option is irrelevant until `org-agenda-diary-file' has been configured
3174 to point to an Org-mode file. When that is the case, the command
3175 `org-agenda-diary-entry' will be bound to the key given here, by default
3176 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3177 if you want to continue doing this, you need to change this to a different
3182 (defcustom org-agenda-diary-file
'diary-file
3183 "File to which to add new entries with the `i' key in agenda and calendar.
3184 When this is the symbol `diary-file', the functionality in the Emacs
3185 calendar will be used to add entries to the `diary-file'. But when this
3186 points to a file, `org-agenda-diary-entry' will be used instead."
3189 (const :tag
"The standard Emacs diary file" diary-file
)
3190 (file :tag
"Special Org file diary entries")))
3192 (eval-after-load "calendar"
3194 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3195 'org-calendar-goto-agenda
)
3196 (org-defkey calendar-mode-map org-calendar-agenda-action-key
3198 (add-hook 'calendar-mode-hook
3200 (unless (eq org-agenda-diary-file
'diary-file
)
3201 (define-key calendar-mode-map
3202 org-calendar-insert-diary-entry-key
3203 'org-agenda-diary-entry
))))))
3205 (defgroup org-latex nil
3206 "Options for embedding LaTeX code into Org-mode."
3210 (defcustom org-format-latex-options
3211 '(:foreground default
:background default
:scale
1.0
3212 :html-foreground
"Black" :html-background
"Transparent"
3213 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3214 "Options for creating images from LaTeX fragments.
3215 This is a property list with the following properties:
3216 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3217 `default' means use the foreground of the default face.
3218 :background the background color, or \"Transparent\".
3219 `default' means use the background of the default face.
3220 :scale a scaling factor for the size of the images, to get more pixels
3221 :html-foreground, :html-background, :html-scale
3222 the same numbers for HTML export.
3223 :matchers a list indicating which matchers should be used to
3224 find LaTeX fragments. Valid members of this list are:
3225 \"begin\" find environments
3226 \"$1\" find single characters surrounded by $.$
3227 \"$\" find math expressions surrounded by $...$
3228 \"$$\" find math expressions surrounded by $$....$$
3229 \"\\(\" find math expressions surrounded by \\(...\\)
3230 \"\\ [\" find math expressions surrounded by \\ [...\\]"
3234 (defcustom org-format-latex-signal-error t
3235 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3236 When nil, just push out a message."
3240 (defcustom org-format-latex-header
"\\documentclass{article}
3241 \\usepackage[usenames]{color}
3242 \\usepackage{amsmath}
3243 \\usepackage[mathscr]{eucal}
3244 \\pagestyle{empty} % do not remove
3247 % The settings below are copied from fullpage.sty
3248 \\setlength{\\textwidth}{\\paperwidth}
3249 \\addtolength{\\textwidth}{-3cm}
3250 \\setlength{\\oddsidemargin}{1.5cm}
3251 \\addtolength{\\oddsidemargin}{-2.54cm}
3252 \\setlength{\\evensidemargin}{\\oddsidemargin}
3253 \\setlength{\\textheight}{\\paperheight}
3254 \\addtolength{\\textheight}{-\\headheight}
3255 \\addtolength{\\textheight}{-\\headsep}
3256 \\addtolength{\\textheight}{-\\footskip}
3257 \\addtolength{\\textheight}{-3cm}
3258 \\setlength{\\topmargin}{1.5cm}
3259 \\addtolength{\\topmargin}{-2.54cm}"
3260 "The document header used for processing LaTeX fragments.
3261 It is imperative that this header make sure that no page number
3262 appears on the page. The package defined in the variables
3263 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3264 will either replace the placeholder \"[PACKAGES]\" in this header, or they
3269 (defvar org-format-latex-header-extra nil
)
3271 (defun org-set-packages-alist (var val
)
3272 "Set the packages alist and make sure it has 3 elements per entry."
3273 (set var
(mapcar (lambda (x)
3274 (if (and (consp x
) (= (length x
) 2))
3275 (list (car x
) (nth 1 x
) t
)
3279 (defun org-get-packages-alist (var)
3281 "Get the packages alist and make sure it has 3 elements per entry."
3283 (if (and (consp x
) (= (length x
) 2))
3284 (list (car x
) (nth 1 x
) t
)
3286 (default-value var
)))
3288 ;; The following variables are defined here because is it also used
3289 ;; when formatting latex fragments. Originally it was part of the
3290 ;; LaTeX exporter, which is why the name includes "export".
3291 (defcustom org-export-latex-default-packages-alist
3292 '(("AUTO" "inputenc" t
)
3296 ("" "longtable" nil
)
3308 "Alist of default packages to be inserted in the header.
3309 Change this only if one of the packages here causes an incompatibility
3310 with another package you are using.
3311 The packages in this list are needed by one part or another of Org-mode
3312 to function properly.
3314 - inputenc, fontenc: for basic font and character selection
3315 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3316 for interpreting the entities in `org-entities'. You can skip some of these
3317 packages if you don't use any of the symbols in it.
3318 - graphicx: for including images
3319 - float, wrapfig: for figure placement
3320 - longtable: for long tables
3321 - hyperref: for cross references
3323 Therefore you should not modify this variable unless you know what you
3324 are doing. The one reason to change it anyway is that you might be loading
3325 some other package that conflicts with one of the default packages.
3326 Each cell is of the format \( \"options\" \"package\" snippet-flag\).
3327 If SNIPPET-FLAG is t, the package also needs to be included when
3328 compiling LaTeX snippets into images for inclusion into HTML."
3329 :group
'org-export-latex
3330 :set
'org-set-packages-alist
3331 :get
'org-get-packages-alist
3334 (list :tag
"options/package pair"
3335 (string :tag
"options")
3336 (string :tag
"package")
3337 (boolean :tag
"Snippet"))
3338 (string :tag
"A line of LaTeX"))))
3340 (defcustom org-export-latex-packages-alist nil
3341 "Alist of packages to be inserted in every LaTeX header.
3342 These will be inserted after `org-export-latex-default-packages-alist'.
3343 Each cell is of the format \( \"options\" \"package\" snippet-flag \).
3344 SNIPPET-FLAG, when t, indicates that this package is also needed when
3345 turning LaTeX snippets into images for inclusion into HTML.
3346 Make sure that you only list packages here which:
3347 - you want in every file
3348 - do not conflict with the default packages in
3349 `org-export-latex-default-packages-alist'
3350 - do not conflict with the setup in `org-format-latex-header'."
3351 :group
'org-export-latex
3352 :set
'org-set-packages-alist
3353 :get
'org-get-packages-alist
3356 (list :tag
"options/package pair"
3357 (string :tag
"options")
3358 (string :tag
"package")
3359 (boolean :tag
"Snippet"))
3360 (string :tag
"A line of LaTeX"))))
3363 (defgroup org-appearance nil
3364 "Settings for Org-mode appearance."
3365 :tag
"Org Appearance"
3368 (defcustom org-level-color-stars-only nil
3369 "Non-nil means fontify only the stars in each headline.
3370 When nil, the entire headline is fontified.
3371 Changing it requires restart of `font-lock-mode' to become effective
3372 also in regions already fontified."
3373 :group
'org-appearance
3376 (defcustom org-hide-leading-stars nil
3377 "Non-nil means hide the first N-1 stars in a headline.
3378 This works by using the face `org-hide' for these stars. This
3379 face is white for a light background, and black for a dark
3380 background. You may have to customize the face `org-hide' to
3382 Changing it requires restart of `font-lock-mode' to become effective
3383 also in regions already fontified.
3384 You may also set this on a per-file basis by adding one of the following
3385 lines to the buffer:
3387 #+STARTUP: hidestars
3388 #+STARTUP: showstars"
3389 :group
'org-appearance
3392 (defcustom org-hidden-keywords nil
3393 "List of symbols corresponding to keywords to be hidden the org buffer.
3394 For example, a value '(title) for this list will make the document's title
3395 appear in the buffer without the initial #+TITLE: keyword."
3396 :group
'org-appearance
3397 :type
'(set (const :tag
"#+AUTHOR" author
)
3398 (const :tag
"#+DATE" date
)
3399 (const :tag
"#+EMAIL" email
)
3400 (const :tag
"#+TITLE" title
)))
3402 (defcustom org-fontify-done-headline nil
3403 "Non-nil means change the face of a headline if it is marked DONE.
3404 Normally, only the TODO/DONE keyword indicates the state of a headline.
3405 When this is non-nil, the headline after the keyword is set to the
3406 `org-headline-done' as an additional indication."
3407 :group
'org-appearance
3410 (defcustom org-fontify-emphasized-text t
3411 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3412 Changing this variable requires a restart of Emacs to take effect."
3413 :group
'org-appearance
3416 (defcustom org-fontify-whole-heading-line nil
3417 "Non-nil means fontify the whole line for headings.
3418 This is useful when setting a background color for the
3420 :group
'org-appearance
3423 (defcustom org-highlight-latex-fragments-and-specials nil
3424 "Non-nil means fontify what is treated specially by the exporters."
3425 :group
'org-appearance
3428 (defcustom org-hide-emphasis-markers nil
3429 "Non-nil mean font-lock should hide the emphasis marker characters."
3430 :group
'org-appearance
3433 (defcustom org-pretty-entities nil
3434 "Non-nil means show entities as UTF8 characters.
3435 When nil, the \\name form remains in the buffer."
3436 :group
'org-appearance
3439 (defcustom org-pretty-entities-include-sub-superscripts t
3440 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3441 :group
'org-appearance
3444 (defvar org-emph-re nil
3445 "Regular expression for matching emphasis.
3446 After a match, the match groups contain these elements:
3447 0 The match of the full regular expression, including the characters
3448 before and after the proper match
3449 1 The character before the proper match, or empty at beginning of line
3450 2 The proper match, including the leading and trailing markers
3451 3 The leading marker like * or /, indicating the type of highlighting
3452 4 The text between the emphasis markers, not including the markers
3453 5 The character after the match, empty at the end of a line")
3454 (defvar org-verbatim-re nil
3455 "Regular expression for matching verbatim text.")
3456 (defvar org-emphasis-regexp-components
) ; defined just below
3457 (defvar org-emphasis-alist
) ; defined just below
3458 (defun org-set-emph-re (var val
)
3459 "Set variable and compute the emphasis regular expression."
3461 (when (and (boundp 'org-emphasis-alist
)
3462 (boundp 'org-emphasis-regexp-components
)
3463 org-emphasis-alist org-emphasis-regexp-components
)
3464 (let* ((e org-emphasis-regexp-components
)
3470 (body1 (concat body
"*?"))
3471 (markers (mapconcat 'car org-emphasis-alist
""))
3472 (vmarkers (mapconcat
3473 (lambda (x) (if (eq (nth 4 x
) 'verbatim
) (car x
) ""))
3474 org-emphasis-alist
"")))
3475 ;; make sure special characters appear at the right position in the class
3476 (if (string-match "\\^" markers
)
3477 (setq markers
(concat (replace-match "" t t markers
) "^")))
3478 (if (string-match "-" markers
)
3479 (setq markers
(concat (replace-match "" t t markers
) "-")))
3480 (if (string-match "\\^" vmarkers
)
3481 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
3482 (if (string-match "-" vmarkers
)
3483 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
3485 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
3486 (int-to-string nl
) "\\}")))
3489 (concat "\\([" pre
"]\\|^\\)"
3491 "\\([" markers
"]\\)"
3499 "\\([" post
"]\\|$\\)"))
3500 (setq org-verbatim-re
3501 (concat "\\([" pre
"]\\|^\\)"
3503 "\\([" vmarkers
"]\\)"
3511 "\\([" post
"]\\|$\\)")))))
3513 (defcustom org-emphasis-regexp-components
3514 '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
3515 "Components used to build the regular expression for emphasis.
3516 This is a list with five entries. Terminology: In an emphasis string
3517 like \" *strong word* \", we call the initial space PREMATCH, the final
3518 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
3519 and \"trong wor\" is the body. The different components in this variable
3520 specify what is allowed/forbidden in each part:
3522 pre Chars allowed as prematch. Beginning of line will be allowed too.
3523 post Chars allowed as postmatch. End of line will be allowed too.
3524 border The chars *forbidden* as border characters.
3525 body-regexp A regexp like \".\" to match a body character. Don't use
3526 non-shy groups here, and don't allow newline here.
3527 newline The maximum number of newlines allowed in an emphasis exp.
3529 Use customize to modify this, or restart Emacs after changing it."
3530 :group
'org-appearance
3531 :set
'org-set-emph-re
3533 (sexp :tag
"Allowed chars in pre ")
3534 (sexp :tag
"Allowed chars in post ")
3535 (sexp :tag
"Forbidden chars in border ")
3536 (sexp :tag
"Regexp for body ")
3537 (integer :tag
"number of newlines allowed")
3538 (option (boolean :tag
"Please ignore this button"))))
3540 (defcustom org-emphasis-alist
3541 `(("*" bold
"<b>" "</b>")
3542 ("/" italic
"<i>" "</i>")
3543 ("_" underline
"<span style=\"text-decoration:underline;\">" "</span>")
3544 ("=" org-code
"<code>" "</code>" verbatim
)
3545 ("~" org-verbatim
"<code>" "</code>" verbatim
)
3546 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))
3549 "Special syntax for emphasized text.
3550 Text starting and ending with a special character will be emphasized, for
3551 example *bold*, _underlined_ and /italic/. This variable sets the marker
3552 characters, the face to be used by font-lock for highlighting in Org-mode
3553 Emacs buffers, and the HTML tags to be used for this.
3554 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3555 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3556 Use customize to modify this, or restart Emacs after changing it."
3557 :group
'org-appearance
3558 :set
'org-set-emph-re
3561 (string :tag
"Marker character")
3563 (face :tag
"Font-lock-face")
3564 (plist :tag
"Face property list"))
3565 (string :tag
"HTML start tag")
3566 (string :tag
"HTML end tag")
3567 (option (const verbatim
)))))
3569 (defvar org-protecting-blocks
3570 '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
3571 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3572 This is needed for font-lock setup.")
3574 ;;; Miscellaneous options
3576 (defgroup org-completion nil
3577 "Completion in Org-mode."
3578 :tag
"Org Completion"
3581 (defcustom org-completion-use-ido nil
3582 "Non-nil means use ido completion wherever possible.
3583 Note that `ido-mode' must be active for this variable to be relevant.
3584 If you decide to turn this variable on, you might well want to turn off
3585 `org-outline-path-complete-in-steps'.
3586 See also `org-completion-use-iswitchb'."
3587 :group
'org-completion
3590 (defcustom org-completion-use-iswitchb nil
3591 "Non-nil means use iswitchb completion wherever possible.
3592 Note that `iswitchb-mode' must be active for this variable to be relevant.
3593 If you decide to turn this variable on, you might well want to turn off
3594 `org-outline-path-complete-in-steps'.
3595 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3596 :group
'org-completion
3599 (defcustom org-completion-fallback-command
'hippie-expand
3600 "The expansion command called by \\[pcomplete] in normal context.
3601 Normal means, no org-mode-specific context."
3602 :group
'org-completion
3605 ;;; Functions and variables from their packages
3606 ;; Declared here to avoid compiler warnings
3609 (defvar outline-mode-menu-heading
)
3610 (defvar outline-mode-menu-show
)
3611 (defvar outline-mode-menu-hide
)
3612 (defvar zmacs-regions
) ; XEmacs regions
3615 (defvar mark-active
)
3618 (declare-function calendar-absolute-from-iso
"cal-iso" (date))
3619 (declare-function calendar-forward-day
"cal-move" (arg))
3620 (declare-function calendar-goto-date
"cal-move" (date))
3621 (declare-function calendar-goto-today
"cal-move" ())
3622 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
3623 (defvar calc-embedded-close-formula
)
3624 (defvar calc-embedded-open-formula
)
3625 (declare-function cdlatex-tab
"ext:cdlatex" ())
3626 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
3627 (defvar font-lock-unfontify-region-function
)
3628 (declare-function iswitchb-read-buffer
"iswitchb"
3629 (prompt &optional default require-match start matches-set
))
3630 (defvar iswitchb-temp-buflist
)
3631 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
3632 (defvar org-agenda-tags-todo-honor-ignore-options
)
3633 (declare-function org-agenda-skip
"org-agenda" ())
3635 org-format-agenda-item
"org-agenda"
3636 (extra txt
&optional category tags dotime noprefix remove-re habitp
))
3637 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
3638 (declare-function org-agenda-change-all-lines
"org-agenda"
3639 (newhead hdmarker
&optional fixface just-this
))
3640 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
3641 (declare-function org-agenda-maybe-redo
"org-agenda" ())
3642 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
3644 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
3645 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
3646 "org-agenda" (&optional end
))
3647 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
3648 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
3649 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
3650 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
3651 (declare-function org-indent-mode
"org-indent" (&optional arg
))
3652 (declare-function parse-time-string
"parse-time" (string))
3653 (declare-function org-attach-reveal
"org-attach" (&optional if-exists
))
3654 (declare-function org-export-latex-fix-inputenc
"org-latex" ())
3655 (declare-function orgtbl-send-table
"org-table" (&optional maybe
))
3656 (defvar remember-data-file
)
3657 (defvar texmathp-why
)
3658 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
3659 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
3661 (defvar w3m-current-url
)
3662 (defvar w3m-current-title
)
3664 (defvar org-latex-regexps
)
3666 ;;; Autoload and prepare some org modules
3668 ;; Some table stuff that needs to be defined here, because it is used
3669 ;; by the functions setting up org-mode or checking for table context.
3671 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
3672 "Detect an org-type or table-type table.")
3673 (defconst org-table-line-regexp
"^[ \t]*|"
3674 "Detect an org-type table line.")
3675 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
3676 "Detect an org-type table line.")
3677 (defconst org-table-hline-regexp
"^[ \t]*|-"
3678 "Detect an org-type table hline.")
3679 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
3680 "Detect a table-type table hline.")
3681 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
3682 "Detect the first line outside a table when searching from within it.
3683 This works for both table types.")
3685 ;; Autoload the functions in org-table.el that are needed by functions here.
3688 (org-autoload "org-table"
3689 '(org-table-align org-table-begin org-table-blank-field
3690 org-table-convert org-table-convert-region org-table-copy-down
3691 org-table-copy-region org-table-create
3692 org-table-create-or-convert-from-region
3693 org-table-create-with-table.el org-table-current-dline
3694 org-table-cut-region org-table-delete-column org-table-edit-field
3695 org-table-edit-formulas org-table-end org-table-eval-formula
3696 org-table-export org-table-field-info
3697 org-table-get-stored-formulas org-table-goto-column
3698 org-table-hline-and-move org-table-import org-table-insert-column
3699 org-table-insert-hline org-table-insert-row org-table-iterate
3700 org-table-justify-field-maybe org-table-kill-row
3701 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3702 org-table-move-column org-table-move-column-left
3703 org-table-move-column-right org-table-move-row
3704 org-table-move-row-down org-table-move-row-up
3705 org-table-next-field org-table-next-row org-table-paste-rectangle
3706 org-table-previous-field org-table-recalculate
3707 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3708 org-table-toggle-coordinate-overlays
3709 org-table-toggle-formula-debugger org-table-wrap-region
3710 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3711 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3712 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo
)))
3714 (defun org-at-table-p (&optional table-type
)
3715 "Return t if the cursor is inside an org-type table.
3716 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3717 (if org-enable-table-editor
3719 (beginning-of-line 1)
3720 (looking-at (if table-type org-table-any-line-regexp
3721 org-table-line-regexp
)))
3723 (defsubst org-table-p
() (org-at-table-p))
3725 (defun org-at-table.el-p
()
3726 "Return t if and only if we are at a table.el table."
3727 (and (org-at-table-p 'any
)
3729 (goto-char (org-table-begin 'any
))
3730 (looking-at org-table1-hline-regexp
))))
3731 (defun org-table-recognize-table.el
()
3732 "If there is a table.el table nearby, recognize it and move into it."
3733 (if org-table-tab-recognizes-table.el
3734 (if (org-at-table.el-p
)
3736 (beginning-of-line 1)
3737 (if (looking-at org-table-dataline-regexp
)
3739 (if (looking-at org-table1-hline-regexp
)
3741 (beginning-of-line 2)
3742 (if (looking-at org-table-any-border-regexp
)
3743 (beginning-of-line -
1)))))
3744 (if (re-search-forward "|" (org-table-end t
) t
)
3747 (if (table--at-cell-p (point))
3749 (message "recognizing table.el table...")
3750 (table-recognize-table)
3751 (message "recognizing table.el table...done")))
3752 (error "This should not happen"))
3757 (defun org-at-table-hline-p ()
3758 "Return t if the cursor is inside a hline in a table."
3759 (if org-enable-table-editor
3761 (beginning-of-line 1)
3762 (looking-at org-table-hline-regexp
))
3765 (defvar org-table-clean-did-remove-column nil
)
3767 (defun org-table-map-tables (function &optional quietly
)
3768 "Apply FUNCTION to the start of all tables in the buffer."
3772 (goto-char (point-min))
3773 (while (re-search-forward org-table-any-line-regexp nil t
)
3775 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
3776 (beginning-of-line 1)
3777 (when (looking-at org-table-line-regexp
)
3778 (save-excursion (funcall function
))
3779 (or (looking-at org-table-line-regexp
)
3781 (re-search-forward org-table-any-border-regexp nil
1))))
3782 (unless quietly
(message "Mapping tables: done")))
3784 ;; Declare and autoload functions from org-exp.el & Co
3786 (declare-function org-default-export-plist
"org-exp")
3787 (declare-function org-infile-export-plist
"org-exp")
3788 (declare-function org-get-current-options
"org-exp")
3790 (org-autoload "org-exp"
3791 '(org-export org-export-visible
3792 org-insert-export-options-template
3793 org-table-clean-before-export
))
3794 (org-autoload "org-ascii"
3795 '(org-export-as-ascii org-export-ascii-preprocess
3796 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3797 org-export-region-as-ascii
))
3798 (org-autoload "org-latex"
3799 '(org-export-as-latex-batch org-export-as-latex-to-buffer
3800 org-replace-region-by-latex org-export-region-as-latex
3801 org-export-as-latex org-export-as-pdf
3802 org-export-as-pdf-and-open
))
3803 (org-autoload "org-html"
3804 '(org-export-as-html-and-open
3805 org-export-as-html-batch org-export-as-html-to-buffer
3806 org-replace-region-by-html org-export-region-as-html
3807 org-export-as-html
))
3808 (org-autoload "org-docbook"
3809 '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
3810 org-replace-region-by-docbook org-export-region-as-docbook
3811 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3812 org-export-as-docbook
))
3813 (org-autoload "org-icalendar"
3814 '(org-export-icalendar-this-file
3815 org-export-icalendar-all-agenda-files
3816 org-export-icalendar-combine-agenda-files
))
3817 (org-autoload "org-xoxo" '(org-export-as-xoxo))
3818 (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning
)))
3820 ;; Declare and autoload functions from org-agenda.el
3823 (org-autoload "org-agenda"
3824 '(org-agenda org-agenda-list org-search-view
3825 org-todo-list org-tags-view org-agenda-list-stuck-projects
3826 org-diary org-agenda-to-appt
3827 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
)))
3829 ;; Autoload org-remember
3832 (org-autoload "org-remember"
3833 '(org-remember-insinuate org-remember-annotation
3834 org-remember-apply-template org-remember org-remember-handler
)))
3837 (org-autoload "org-capture"
3838 '(org-capture org-capture-insert-template-here
3839 org-capture-import-remember-templates
)))
3841 ;; Autoload org-clock.el
3843 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock"
3845 (declare-function org-clock-update-mode-line
"org-clock" ())
3846 (declare-function org-resolve-clocks
"org-clock"
3847 (&optional also-non-dangling-p prompt last-valid
))
3848 (defvar org-clock-start-time
)
3849 (defvar org-clock-marker
(make-marker)
3850 "Marker recording the last clock-in.")
3851 (defvar org-clock-hd-marker
(make-marker)
3852 "Marker recording the last clock-in, but the headline position.")
3853 (defvar org-clock-heading
""
3854 "The heading of the current clock entry.")
3855 (defun org-clock-is-active ()
3856 "Return non-nil if clock is currently running.
3857 The return value is actually the clock marker."
3858 (marker-buffer org-clock-marker
))
3863 '(org-clock-in org-clock-out org-clock-cancel
3864 org-clock-goto org-clock-sum org-clock-display
3865 org-clock-remove-overlays org-clock-report
3866 org-clocktable-shift org-dblock-write
:clocktable
3867 org-get-clocktable org-resolve-clocks
)))
3869 (defun org-clock-update-time-maybe ()
3870 "If this is a CLOCK line, update it and return t.
3871 Otherwise, return nil."
3874 (beginning-of-line 1)
3875 (skip-chars-forward " \t")
3876 (when (looking-at org-clock-string
)
3877 (let ((re (concat "[ \t]*" org-clock-string
3878 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
3879 "\\([ \t]*=>.*\\)?\\)?"))
3882 ((not (looking-at re
))
3884 ((not (match-end 2))
3885 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
3886 (> org-clock-marker
(point))
3887 (<= org-clock-marker
(point-at-eol)))
3888 ;; The clock is running here
3889 (setq org-clock-start-time
3891 (org-parse-time-string (match-string 1))))
3892 (org-clock-update-mode-line)))
3894 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
3896 (setq ts
(match-string 1)
3897 te
(match-string 3))
3898 (setq s
(- (org-float-time
3899 (apply 'encode-time
(org-parse-time-string te
)))
3901 (apply 'encode-time
(org-parse-time-string ts
))))
3904 h
(floor (/ s
3600))
3908 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
3911 (defun org-check-running-clock ()
3912 "Check if the current buffer contains the running clock.
3913 If yes, offer to stop it and to save the buffer with the changes."
3914 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
3915 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
3918 (when (y-or-n-p "Save changed buffer?")
3921 (defun org-clocktable-try-shift (dir n
)
3922 "Check if this line starts a clock table, if yes, shift the time block."
3923 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
3924 (org-clocktable-shift dir n
)))
3926 ;; Autoload org-timer.el
3931 '(org-timer-start org-timer org-timer-item
3932 org-timer-change-times-in-region
3934 org-timer-reset-timers
3935 org-timer-show-remaining-time
)))
3937 ;; Autoload org-feed.el
3942 '(org-feed-update org-feed-update-all org-feed-goto-inbox
)))
3945 ;; Autoload org-indent.el
3947 ;; Define the variable already here, to make sure we have it.
3948 (defvar org-indent-mode nil
3949 "Non-nil if Org-Indent mode is enabled.
3950 Use the command `org-indent-mode' to change this variable.")
3955 '(org-indent-mode)))
3957 ;; Autoload org-mobile.el
3962 '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda
)))
3964 ;; Autoload archiving code
3965 ;; The stuff that is needed for cycling and tags has to be defined here.
3967 (defgroup org-archive nil
3968 "Options concerning archiving in Org-mode."
3970 :group
'org-structure
)
3972 (defcustom org-archive-location
"%s_archive::"
3973 "The location where subtrees should be archived.
3975 The value of this variable is a string, consisting of two parts,
3976 separated by a double-colon. The first part is a filename and
3977 the second part is a headline.
3979 When the filename is omitted, archiving happens in the same file.
3980 %s in the filename will be replaced by the current file
3981 name (without the directory part). Archiving to a different file
3982 is useful to keep archived entries from contributing to the
3985 The archived entries will be filed as subtrees of the specified
3986 headline. When the headline is omitted, the subtrees are simply
3987 filed away at the end of the file, as top-level entries. Also in
3988 the heading you can use %s to represent the file name, this can be
3989 useful when using the same archive for a number of different files.
3991 Here are a few examples:
3993 If the current file is Projects.org, archive in file
3994 Projects.org_archive, as top-level trees. This is the default.
3996 \"::* Archived Tasks\"
3997 Archive in the current file, under the top-level headline
3998 \"* Archived Tasks\".
4000 \"~/org/archive.org::\"
4001 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4003 \"~/org/archive.org::From %s\"
4004 Archive in file ~/org/archive.org (absolute path), under headlines
4005 \"From FILENAME\" where file name is the current file name.
4007 \"basement::** Finished Tasks\"
4008 Archive in file ./basement (relative path), as level 3 trees
4009 below the level 2 heading \"** Finished Tasks\".
4011 You may set this option on a per-file basis by adding to the buffer a
4014 #+ARCHIVE: basement::** Finished Tasks
4016 You may also define it locally for a subtree by setting an ARCHIVE property
4017 in the entry. If such a property is found in an entry, or anywhere up
4018 the hierarchy, it will be used."
4022 (defcustom org-archive-tag
"ARCHIVE"
4023 "The tag that marks a subtree as archived.
4024 An archived subtree does not open during visibility cycling, and does
4025 not contribute to the agenda listings.
4026 After changing this, font-lock must be restarted in the relevant buffers to
4027 get the proper fontification."
4029 :group
'org-keywords
4032 (defcustom org-agenda-skip-archived-trees t
4033 "Non-nil means the agenda will skip any items located in archived trees.
4034 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4035 variable is no longer recommended, you should leave it at the value t.
4036 Instead, use the key `v' to cycle the archives-mode in the agenda."
4038 :group
'org-agenda-skip
4041 (defcustom org-columns-skip-archived-trees t
4042 "Non-nil means ignore archived trees when creating column view."
4044 :group
'org-properties
4047 (defcustom org-cycle-open-archived-trees nil
4048 "Non-nil means `org-cycle' will open archived trees.
4049 An archived tree is a tree marked with the tag ARCHIVE.
4050 When nil, archived trees will stay folded. You can still open them with
4051 normal outline commands like `show-all', but not with the cycling commands."
4056 (defcustom org-sparse-tree-open-archived-trees nil
4057 "Non-nil means sparse tree construction shows matches in archived trees.
4058 When nil, matches in these trees are highlighted, but the trees are kept in
4061 :group
'org-sparse-trees
4064 (defun org-cycle-hide-archived-subtrees (state)
4065 "Re-hide all archived subtrees after a visibility state change."
4066 (when (and (not org-cycle-open-archived-trees
)
4067 (not (memq state
'(overview folded
))))
4069 (let* ((globalp (memq state
'(contents all
)))
4070 (beg (if globalp
(point-min) (point)))
4071 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4072 (org-hide-archived-subtrees beg end
)
4074 (if (looking-at (concat ".*:" org-archive-tag
":"))
4075 (message "%s" (substitute-command-keys
4076 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4078 (defun org-force-cycle-archived ()
4079 "Cycle subtree even if it is archived."
4081 (setq this-command
'org-cycle
)
4082 (let ((org-cycle-open-archived-trees t
))
4083 (call-interactively 'org-cycle
)))
4085 (defun org-hide-archived-subtrees (beg end
)
4086 "Re-hide all archived subtrees after a visibility state change."
4088 (let* ((re (concat ":" org-archive-tag
":")))
4090 (while (re-search-forward re end t
)
4091 (when (org-on-heading-p)
4092 (org-flag-subtree t
)
4093 (org-end-of-subtree t
))))))
4095 (defun org-flag-subtree (flag)
4097 (org-back-to-heading t
)
4098 (outline-end-of-heading)
4099 (outline-flag-region (point)
4100 (progn (org-end-of-subtree t
) (point))
4103 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4106 (org-autoload "org-archive"
4107 '(org-add-archive-files org-archive-subtree
4108 org-archive-to-archive-sibling org-toggle-archive-tag
4109 org-archive-subtree-default
4110 org-archive-subtree-default-with-confirmation
)))
4112 ;; Autoload Column View Code
4114 (declare-function org-columns-number-to-string
"org-colview")
4115 (declare-function org-columns-get-format-and-top-level
"org-colview")
4116 (declare-function org-columns-compute
"org-colview")
4118 (org-autoload (if (featurep 'xemacs
) "org-colview-xemacs" "org-colview")
4119 '(org-columns-number-to-string org-columns-get-format-and-top-level
4120 org-columns-compute org-agenda-columns org-columns-remove-overlays
4121 org-columns org-insert-columns-dblock org-dblock-write
:columnview
))
4125 (declare-function org-id-store-link
"org-id")
4126 (declare-function org-id-locations-load
"org-id")
4127 (declare-function org-id-locations-save
"org-id")
4128 (defvar org-id-track-globally
)
4129 (org-autoload "org-id"
4130 '(org-id-get-create org-id-new org-id-copy org-id-get
4131 org-id-get-with-outline-path-completion
4132 org-id-get-with-outline-drilling org-id-store-link
4133 org-id-goto org-id-find org-id-store-link
))
4135 ;; Autoload Plotting Code
4137 (org-autoload "org-plot"
4138 '(org-plot/gnuplot
))
4140 ;;; Variables for pre-computed regular expressions, all buffer local
4142 (defvar org-drawer-regexp nil
4143 "Matches first line of a hidden block.")
4144 (make-variable-buffer-local 'org-drawer-regexp
)
4145 (defvar org-todo-regexp nil
4146 "Matches any of the TODO state keywords.")
4147 (make-variable-buffer-local 'org-todo-regexp
)
4148 (defvar org-not-done-regexp nil
4149 "Matches any of the TODO state keywords except the last one.")
4150 (make-variable-buffer-local 'org-not-done-regexp
)
4151 (defvar org-not-done-heading-regexp nil
4152 "Matches a TODO headline that is not done.")
4153 (make-variable-buffer-local 'org-not-done-regexp
)
4154 (defvar org-todo-line-regexp nil
4155 "Matches a headline and puts TODO state into group 2 if present.")
4156 (make-variable-buffer-local 'org-todo-line-regexp
)
4157 (defvar org-complex-heading-regexp nil
4158 "Matches a headline and puts everything into groups:
4160 group 2: The todo keyword, maybe
4161 group 3: Priority cookie
4162 group 4: True headline
4164 (make-variable-buffer-local 'org-complex-heading-regexp
)
4165 (defvar org-complex-heading-regexp-format nil
4166 "Printf format to make regexp to match an exact headline.
4167 This regexp will match the headline of any node which hase the exact
4168 headline text that is put into the format, but may have any TODO state,
4169 priority and tags.")
4170 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4171 (defvar org-todo-line-tags-regexp nil
4172 "Matches a headline and puts TODO state into group 2 if present.
4173 Also put tags into group 4 if tags are present.")
4174 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4175 (defvar org-nl-done-regexp nil
4176 "Matches newline followed by a headline with the DONE keyword.")
4177 (make-variable-buffer-local 'org-nl-done-regexp
)
4178 (defvar org-looking-at-done-regexp nil
4179 "Matches the DONE keyword a point.")
4180 (make-variable-buffer-local 'org-looking-at-done-regexp
)
4181 (defvar org-ds-keyword-length
12
4182 "Maximum length of the Deadline and SCHEDULED keywords.")
4183 (make-variable-buffer-local 'org-ds-keyword-length
)
4184 (defvar org-deadline-regexp nil
4185 "Matches the DEADLINE keyword.")
4186 (make-variable-buffer-local 'org-deadline-regexp
)
4187 (defvar org-deadline-time-regexp nil
4188 "Matches the DEADLINE keyword together with a time stamp.")
4189 (make-variable-buffer-local 'org-deadline-time-regexp
)
4190 (defvar org-deadline-line-regexp nil
4191 "Matches the DEADLINE keyword and the rest of the line.")
4192 (make-variable-buffer-local 'org-deadline-line-regexp
)
4193 (defvar org-scheduled-regexp nil
4194 "Matches the SCHEDULED keyword.")
4195 (make-variable-buffer-local 'org-scheduled-regexp
)
4196 (defvar org-scheduled-time-regexp nil
4197 "Matches the SCHEDULED keyword together with a time stamp.")
4198 (make-variable-buffer-local 'org-scheduled-time-regexp
)
4199 (defvar org-closed-time-regexp nil
4200 "Matches the CLOSED keyword together with a time stamp.")
4201 (make-variable-buffer-local 'org-closed-time-regexp
)
4203 (defvar org-keyword-time-regexp nil
4204 "Matches any of the 4 keywords, together with the time stamp.")
4205 (make-variable-buffer-local 'org-keyword-time-regexp
)
4206 (defvar org-keyword-time-not-clock-regexp nil
4207 "Matches any of the 3 keywords, together with the time stamp.")
4208 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp
)
4209 (defvar org-maybe-keyword-time-regexp nil
4210 "Matches a timestamp, possibly preceded by a keyword.")
4211 (make-variable-buffer-local 'org-maybe-keyword-time-regexp
)
4212 (defvar org-planning-or-clock-line-re nil
4213 "Matches a line with planning or clock info.")
4214 (make-variable-buffer-local 'org-planning-or-clock-line-re
)
4215 (defvar org-all-time-keywords nil
4216 "List of time keywords.")
4217 (make-variable-buffer-local 'org-all-time-keywords
)
4219 (defconst org-plain-time-of-day-regexp
4222 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4225 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4227 "Regular expression to match a plain time or time range.
4228 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4229 groups carry important information:
4231 1 the first time, range or not
4232 8 the second time, if it is a range.")
4234 (defconst org-plain-time-extension-regexp
4237 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4238 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4239 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4240 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4241 groups carry important information:
4244 9 minutes of duration")
4246 (defconst org-stamp-time-of-day-regexp
4248 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4249 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4251 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4252 "Regular expression to match a timestamp time or time range.
4253 After a match, the following groups carry important information:
4255 1 date plus weekday, for back referencing to make sure both times are on the same day
4256 2 the first time, range or not
4257 4 the second time, if it is a range.")
4259 (defconst org-startup-options
4260 '(("fold" org-startup-folded t
)
4261 ("overview" org-startup-folded t
)
4262 ("nofold" org-startup-folded nil
)
4263 ("showall" org-startup-folded nil
)
4264 ("showeverything" org-startup-folded showeverything
)
4265 ("content" org-startup-folded content
)
4266 ("indent" org-startup-indented t
)
4267 ("noindent" org-startup-indented nil
)
4268 ("hidestars" org-hide-leading-stars t
)
4269 ("showstars" org-hide-leading-stars nil
)
4270 ("odd" org-odd-levels-only t
)
4271 ("oddeven" org-odd-levels-only nil
)
4272 ("align" org-startup-align-all-tables t
)
4273 ("noalign" org-startup-align-all-tables nil
)
4274 ("inlineimages" org-startup-with-inline-images t
)
4275 ("noinlineimages" org-startup-with-inline-images nil
)
4276 ("customtime" org-display-custom-times t
)
4277 ("logdone" org-log-done time
)
4278 ("lognotedone" org-log-done note
)
4279 ("nologdone" org-log-done nil
)
4280 ("lognoteclock-out" org-log-note-clock-out t
)
4281 ("nolognoteclock-out" org-log-note-clock-out nil
)
4282 ("logrepeat" org-log-repeat state
)
4283 ("lognoterepeat" org-log-repeat note
)
4284 ("nologrepeat" org-log-repeat nil
)
4285 ("logreschedule" org-log-reschedule time
)
4286 ("lognotereschedule" org-log-reschedule note
)
4287 ("nologreschedule" org-log-reschedule nil
)
4288 ("logredeadline" org-log-redeadline time
)
4289 ("lognoteredeadline" org-log-redeadline note
)
4290 ("nologredeadline" org-log-redeadline nil
)
4291 ("logrefile" org-log-refile time
)
4292 ("lognoterefile" org-log-refile note
)
4293 ("nologrefile" org-log-refile nil
)
4294 ("fninline" org-footnote-define-inline t
)
4295 ("nofninline" org-footnote-define-inline nil
)
4296 ("fnlocal" org-footnote-section nil
)
4297 ("fnauto" org-footnote-auto-label t
)
4298 ("fnprompt" org-footnote-auto-label nil
)
4299 ("fnconfirm" org-footnote-auto-label confirm
)
4300 ("fnplain" org-footnote-auto-label plain
)
4301 ("fnadjust" org-footnote-auto-adjust t
)
4302 ("nofnadjust" org-footnote-auto-adjust nil
)
4303 ("constcgs" constants-unit-system cgs
)
4304 ("constSI" constants-unit-system SI
)
4305 ("noptag" org-tag-persistent-alist nil
)
4306 ("hideblocks" org-hide-block-startup t
)
4307 ("nohideblocks" org-hide-block-startup nil
)
4308 ("beamer" org-startup-with-beamer-mode t
)
4309 ("entitiespretty" org-pretty-entities t
)
4310 ("entitiesplain" org-pretty-entities nil
))
4311 "Variable associated with STARTUP options for org-mode.
4312 Each element is a list of three items: The startup options as written
4313 in the #+STARTUP line, the corresponding variable, and the value to
4314 set this variable to if the option is found. An optional forth element PUSH
4315 means to push this value onto the list in the variable.")
4317 (defun org-set-regexps-and-options ()
4318 "Precompute regular expressions for current buffer."
4320 (org-set-local 'org-todo-kwd-alist nil
)
4321 (org-set-local 'org-todo-key-alist nil
)
4322 (org-set-local 'org-todo-key-trigger nil
)
4323 (org-set-local 'org-todo-keywords-1 nil
)
4324 (org-set-local 'org-done-keywords nil
)
4325 (org-set-local 'org-todo-heads nil
)
4326 (org-set-local 'org-todo-sets nil
)
4327 (org-set-local 'org-todo-log-states nil
)
4328 (org-set-local 'org-file-properties nil
)
4329 (org-set-local 'org-file-tags nil
)
4330 (let ((re (org-make-options-regexp
4331 '("CATEGORY" "TODO" "COLUMNS"
4332 "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
4333 "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
4335 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4337 (scripts org-use-sub-superscripts
)
4338 kwds kws0 kwsa key log value cat arch tags const links hw dws
4339 tail sep kws1 prio props ftags drawers beamer-p
4340 ext-setup-or-nil setup-contents
(start 0))
4344 (goto-char (point-min))
4345 (while (or (and ext-setup-or-nil
4346 (string-match re ext-setup-or-nil start
)
4347 (setq start
(match-end 0)))
4348 (and (setq ext-setup-or-nil nil start
0)
4349 (re-search-forward re nil t
)))
4350 (setq key
(upcase (match-string 1 ext-setup-or-nil
))
4351 value
(org-match-string-no-properties 2 ext-setup-or-nil
))
4352 (if (stringp value
) (setq value
(org-trim value
)))
4354 ((equal key
"CATEGORY")
4356 ((member key
'("SEQ_TODO" "TODO"))
4357 (push (cons 'sequence
(org-split-string value splitre
)) kwds
))
4358 ((equal key
"TYP_TODO")
4359 (push (cons 'type
(org-split-string value splitre
)) kwds
))
4360 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key
)
4361 ;; general TODO-like setup
4362 (push (cons (intern (downcase (match-string 1 key
)))
4363 (org-split-string value splitre
)) kwds
))
4365 (setq tags
(append tags
(if tags
'("\\n") nil
)
4366 (org-split-string value splitre
))))
4367 ((equal key
"COLUMNS")
4368 (org-set-local 'org-columns-default-format value
))
4370 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
4371 (push (cons (match-string 1 value
)
4372 (org-trim (match-string 2 value
)))
4374 ((equal key
"PRIORITIES")
4375 (setq prio
(org-split-string value
" +")))
4376 ((equal key
"PROPERTY")
4377 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value
)
4378 (push (cons (match-string 1 value
) (match-string 2 value
))
4380 ((equal key
"FILETAGS")
4381 (when (string-match "\\S-" value
)
4386 (mapcar (lambda (x) (org-split-string x
":"))
4387 (org-split-string value
)))))))
4388 ((equal key
"DRAWERS")
4389 (setq drawers
(org-split-string value splitre
)))
4390 ((equal key
"CONSTANTS")
4391 (setq const
(append const
(org-split-string value splitre
))))
4392 ((equal key
"STARTUP")
4393 (let ((opts (org-split-string value splitre
))
4395 (while (setq l
(pop opts
))
4396 (when (setq l
(assoc l org-startup-options
))
4397 (setq var
(nth 1 l
) val
(nth 2 l
))
4399 (set (make-local-variable var
) val
)
4400 (if (not (listp (symbol-value var
)))
4401 (set (make-local-variable var
) nil
))
4402 (set (make-local-variable var
) (symbol-value var
))
4403 (add-to-list var val
))))))
4404 ((equal key
"ARCHIVE")
4406 (remove-text-properties 0 (length arch
)
4407 '(face t fontified t
) arch
))
4408 ((equal key
"LATEX_CLASS")
4409 (setq beamer-p
(equal value
"beamer")))
4410 ((equal key
"OPTIONS")
4411 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value
)
4412 (setq scripts
(read (match-string 2 value
)))))
4413 ((equal key
"SETUPFILE")
4414 (setq setup-contents
(org-file-contents
4416 (org-remove-double-quotes value
))
4418 (if (not ext-setup-or-nil
)
4419 (setq ext-setup-or-nil setup-contents start
0)
4420 (setq ext-setup-or-nil
4421 (concat (substring ext-setup-or-nil
0 start
)
4422 "\n" setup-contents
"\n"
4423 (substring ext-setup-or-nil start
)))))
4425 (org-set-local 'org-use-sub-superscripts scripts
)
4427 (org-set-local 'org-category
(intern cat
))
4428 (push (cons "CATEGORY" cat
) props
))
4430 (if (< (length prio
) 3) (setq prio
'("A" "C" "B")))
4431 (setq prio
(mapcar 'string-to-char prio
))
4432 (org-set-local 'org-highest-priority
(nth 0 prio
))
4433 (org-set-local 'org-lowest-priority
(nth 1 prio
))
4434 (org-set-local 'org-default-priority
(nth 2 prio
)))
4435 (and props
(org-set-local 'org-file-properties
(nreverse props
)))
4436 (and ftags
(org-set-local 'org-file-tags
4437 (mapcar 'org-add-prop-inherited ftags
)))
4438 (and drawers
(org-set-local 'org-drawers drawers
))
4439 (and arch
(org-set-local 'org-archive-location arch
))
4440 (and links
(setq org-link-abbrev-alist-local
(nreverse links
)))
4441 ;; Process the TODO keywords
4443 ;; Use the global values as if they had been given locally.
4444 (setq kwds
(default-value 'org-todo-keywords
))
4445 (if (stringp (car kwds
))
4446 (setq kwds
(list (cons org-todo-interpretation
4447 (default-value 'org-todo-keywords
)))))
4448 (setq kwds
(reverse kwds
)))
4449 (setq kwds
(nreverse kwds
))
4451 (while (setq kws
(pop kwds
))
4453 (run-hook-with-args-until-success
4454 'org-todo-setup-filter-hook kws
)
4456 (setq inter
(pop kws
) sep
(member "|" kws
)
4457 kws0
(delete "|" (copy-sequence kws
))
4462 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x
)
4464 (setq kw
(match-string 1 x
)
4465 key
(and (match-end 2) (match-string 2 x
))
4466 log
(org-extract-log-state-settings x
))
4467 (push (cons kw
(and key
(string-to-char key
))) kwsa
)
4468 (and log
(push log org-todo-log-states
))
4470 (error "Invalid TODO keyword %s" x
)))
4472 kwsa
(if kwsa
(append '((:startgroup
))
4476 dws
(if sep
(org-remove-keyword-keys (cdr sep
)) (last kws1
))
4477 tail
(list inter hw
(car dws
) (org-last dws
))))
4478 (add-to-list 'org-todo-heads hw
'append
)
4479 (push kws1 org-todo-sets
)
4480 (setq org-done-keywords
(append org-done-keywords dws nil
))
4481 (setq org-todo-key-alist
(append org-todo-key-alist kwsa
))
4482 (mapc (lambda (x) (push (cons x tail
) org-todo-kwd-alist
)) kws1
)
4483 (setq org-todo-keywords-1
(append org-todo-keywords-1 kws1 nil
)))
4484 (setq org-todo-sets
(nreverse org-todo-sets
)
4485 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
4486 org-todo-key-trigger
(delq nil
(mapcar 'cdr org-todo-key-alist
))
4487 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
)))
4488 ;; Process the constants
4491 (while (setq e
(pop const
))
4492 (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e
)
4493 (push (cons (match-string 1 e
) (match-string 2 e
)) cst
)))
4494 (setq org-table-formula-constants-local cst
)))
4496 ;; Process the tags.
4499 (while (setq e
(pop tags
))
4501 ((equal e
"{") (push '(:startgroup
) tgs
))
4502 ((equal e
"}") (push '(:endgroup
) tgs
))
4503 ((equal e
"\\n") (push '(:newline
) tgs
))
4504 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e
)
4505 (push (cons (match-string 1 e
)
4506 (string-to-char (match-string 2 e
)))
4508 (t (push (list e
) tgs
))))
4509 (org-set-local 'org-tag-alist nil
)
4510 (while (setq e
(pop tgs
))
4511 (or (and (stringp (car e
))
4512 (assoc (car e
) org-tag-alist
))
4513 (push e org-tag-alist
)))))
4515 ;; Compute the regular expressions and other local variables
4516 (if (not org-done-keywords
)
4517 (setq org-done-keywords
(and org-todo-keywords-1
4518 (list (org-last org-todo-keywords-1
)))))
4519 (setq org-ds-keyword-length
(+ 2 (max (length org-deadline-string
)
4520 (length org-scheduled-string
)
4521 (length org-clock-string
)
4522 (length org-closed-string
)))
4524 (concat "^[ \t]*:\\("
4525 (mapconcat 'regexp-quote org-drawers
"\\|")
4527 org-not-done-keywords
4528 (org-delete-all org-done-keywords
(copy-sequence org-todo-keywords-1
))
4530 (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
4534 (mapconcat 'regexp-quote org-not-done-keywords
"\\|")
4536 org-not-done-heading-regexp
4537 (concat "^\\(\\*+\\)[ \t]+\\("
4538 (mapconcat 'regexp-quote org-not-done-keywords
"\\|")
4540 org-todo-line-regexp
4541 (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
4542 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
4543 "\\)\\>\\)?[ \t]*\\(.*\\)")
4544 org-complex-heading-regexp
4545 (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
4546 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
4547 "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
4548 "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
4549 org-complex-heading-regexp-format
4550 (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
4551 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
4553 "\\(?:[ \t]*\\(\\[#.\\]\\)\\)?"
4554 "\\(?:[ \t]*\\(?:\\[[0-9%%/]+\\]\\)\\)?" ;; stats cookie
4556 "\\(?:[ \t]*\\(?:\\[[0-9%%/]+\\]\\)\\)?" ;; stats cookie
4557 "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?[ \t]*$")
4559 (concat "\n\\*+[ \t]+"
4560 "\\(?:" (mapconcat 'regexp-quote org-done-keywords
"\\|")
4562 org-todo-line-tags-regexp
4563 (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
4564 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
4566 "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@#%]+:[ \t]*\\)?$\\)"))
4567 org-looking-at-done-regexp
4569 (mapconcat 'regexp-quote org-done-keywords
"\\|") "\\)"
4571 org-deadline-regexp
(concat "\\<" org-deadline-string
)
4572 org-deadline-time-regexp
4573 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
4574 org-deadline-line-regexp
4575 (concat "\\<\\(" org-deadline-string
"\\).*")
4576 org-scheduled-regexp
4577 (concat "\\<" org-scheduled-string
)
4578 org-scheduled-time-regexp
4579 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
4580 org-closed-time-regexp
4581 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
4582 org-keyword-time-regexp
4583 (concat "\\<\\(" org-scheduled-string
4584 "\\|" org-deadline-string
4585 "\\|" org-closed-string
4586 "\\|" org-clock-string
"\\)"
4587 " *[[<]\\([^]>]+\\)[]>]")
4588 org-keyword-time-not-clock-regexp
4589 (concat "\\<\\(" org-scheduled-string
4590 "\\|" org-deadline-string
4591 "\\|" org-closed-string
4593 " *[[<]\\([^]>]+\\)[]>]")
4594 org-maybe-keyword-time-regexp
4595 (concat "\\(\\<\\(" org-scheduled-string
4596 "\\|" org-deadline-string
4597 "\\|" org-closed-string
4598 "\\|" org-clock-string
"\\)\\)?"
4599 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
4600 org-planning-or-clock-line-re
4601 (concat "\\(?:^[ \t]*\\(" org-scheduled-string
4602 "\\|" org-deadline-string
4603 "\\|" org-closed-string
"\\|" org-clock-string
4605 org-all-time-keywords
4606 (mapcar (lambda (w) (substring w
0 -
1))
4607 (list org-scheduled-string org-deadline-string
4608 org-clock-string org-closed-string
))
4610 (org-compute-latex-and-specials-regexp)
4611 (org-set-font-lock-defaults))))
4613 (defun org-file-contents (file &optional noerror
)
4614 "Return the contents of FILE, as a string."
4616 (not (file-readable-p file
)))
4619 (message "Cannot read file \"%s\"" file
)
4622 (error "Cannot read file \"%s\"" file
))
4624 (insert-file-contents file
)
4627 (defun org-extract-log-state-settings (x)
4628 "Extract the log state setting from a TODO keyword string.
4629 This will extract info from a string like \"WAIT(w@/!)\"."
4630 (let (kw key log1 log2
)
4631 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
4632 (setq kw
(match-string 1 x
)
4633 key
(and (match-end 2) (match-string 2 x
))
4634 log1
(and (match-end 3) (match-string 3 x
))
4635 log2
(and (match-end 4) (match-string 4 x
)))
4638 (and log1
(if (equal log1
"!") 'time
'note
))
4639 (and log2
(if (equal log2
"!") 'time
'note
)))))))
4641 (defun org-remove-keyword-keys (list)
4642 "Remove a pair of parenthesis at the end of each string in LIST."
4644 (if (string-match "(.*)$" x
)
4645 (substring x
0 (match-beginning 0))
4649 (defun org-assign-fast-keys (alist)
4650 "Assign fast keys to a keyword-key alist.
4651 Respect keys that are already there."
4652 (let (new e
(alt ?
0))
4653 (while (setq e
(pop alist
))
4654 (if (or (memq (car e
) '(:newline
:endgroup
:startgroup
))
4655 (cdr e
)) ;; Key already assigned.
4657 (let ((clist (string-to-list (downcase (car e
))))
4658 (used (append new alist
)))
4659 (when (= (car clist
) ?
@)
4661 (while (and clist
(rassoc (car clist
) used
))
4664 (while (rassoc alt used
)
4666 (push (cons (car e
) (or (car clist
) alt
)) new
))))
4669 ;;; Some variables used in various places
4671 (defvar org-window-configuration nil
4672 "Used in various places to store a window configuration.")
4673 (defvar org-selected-window nil
4674 "Used in various places to store a window configuration.")
4675 (defvar org-finish-function nil
4676 "Function to be called when `C-c C-c' is used.
4677 This is for getting out of special buffers like remember.")
4680 ;; FIXME: Occasionally check by commenting these, to make sure
4681 ;; no other functions uses these, forgetting to let-bind them.
4686 ;; Defined somewhere in this file, but used before definition.
4687 (defvar org-entities
) ;; defined in org-entities.el
4688 (defvar org-struct-menu
)
4689 (defvar org-org-menu
)
4690 (defvar org-tbl-menu
)
4692 ;;;; Define the Org-mode
4694 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
4695 (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"))
4698 ;; We use a before-change function to check if a table might need
4700 (defvar org-table-may-need-update t
4701 "Indicates that a table might need an update.
4702 This variable is set by `org-before-change-function'.
4703 `org-table-align' sets it back to nil.")
4704 (defun org-before-change-function (beg end
)
4705 "Every change indicates that a table might need an update."
4706 (setq org-table-may-need-update t
))
4707 (defvar org-mode-map
)
4708 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4709 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
4710 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
4711 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
4712 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
4713 (defvar org-table-buffer-is-an nil
)
4715 ;; org-outline-regexp ought to be a defconst but is let-binding
4716 ;; in some places -- e.g. see the macro org-with-limited-levels
4717 (defvar org-outline-regexp
"\\*+ ")
4718 (defconst org-outline-regexp-bol
"^\\*+ ")
4721 (define-derived-mode org-mode outline-mode
"Org"
4722 "Outline-based notes management and organizer, alias
4723 \"Carsten's outline-mode for keeping track of everything.\"
4725 Org-mode develops organizational tasks around a NOTES file which
4726 contains information about projects as plain text. Org-mode is
4727 implemented on top of outline-mode, which is ideal to keep the content
4728 of large files well structured. It supports ToDo items, deadlines and
4729 time stamps, which magically appear in the diary listing of the Emacs
4730 calendar. Tables are easily created with a built-in table editor.
4731 Plain text URL-like links connect to websites, emails (VM), Usenet
4732 messages (Gnus), BBDB entries, and any files related to the project.
4733 For printing and sharing of notes, an Org-mode file (or a part of it)
4734 can be exported as a structured ASCII or HTML file.
4736 The following commands are available:
4740 ;; Get rid of Outline menus, they are not needed
4741 ;; Need to do this here because define-derived-mode sets up
4742 ;; the keymap so late. Still, it is a waste to call this each time
4743 ;; we switch another buffer into org-mode.
4744 (if (featurep 'xemacs
)
4745 (when (boundp 'outline-mode-menu-heading
)
4746 ;; Assume this is Greg's port, it uses easymenu
4747 (easy-menu-remove outline-mode-menu-heading
)
4748 (easy-menu-remove outline-mode-menu-show
)
4749 (easy-menu-remove outline-mode-menu-hide
))
4750 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
4751 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
4752 (define-key org-mode-map
[menu-bar show
] 'undefined
))
4754 (org-load-modules-maybe)
4755 (easy-menu-add org-org-menu
)
4756 (easy-menu-add org-tbl-menu
)
4757 (org-install-agenda-files-menu)
4758 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
4759 (add-to-invisibility-spec '(org-cwidth))
4760 (add-to-invisibility-spec '(org-hide-block . t
))
4761 (when (featurep 'xemacs
)
4762 (org-set-local 'line-move-ignore-invisible t
))
4763 (org-set-local 'outline-regexp org-outline-regexp
)
4764 (org-set-local 'outline-level
'org-outline-level
)
4765 (when (and org-ellipsis
4766 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
4767 (fboundp 'make-glyph-code
))
4768 (unless org-display-table
4769 (setq org-display-table
(make-display-table)))
4770 (set-display-table-slot
4773 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
4775 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
4776 (setq buffer-display-table org-display-table
))
4777 (org-set-regexps-and-options)
4778 (when (and org-tag-faces
(not org-tags-special-faces-re
))
4779 ;; tag faces set outside customize.... force initialization.
4780 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
4782 (org-set-local 'calc-embedded-open-mode
"# ")
4783 (modify-syntax-entry ?
@ "w")
4784 (if org-startup-truncated
(setq truncate-lines t
))
4785 (org-set-local 'font-lock-unfontify-region-function
4786 'org-unfontify-region
)
4787 ;; Activate before-change-function
4788 (org-set-local 'org-table-may-need-update t
)
4789 (org-add-hook 'before-change-functions
'org-before-change-function nil
4791 ;; Check for running clock before killing a buffer
4792 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
4793 ;; Paragraphs and auto-filling
4794 (org-set-autofill-regexps)
4795 (setq indent-line-function
'org-indent-line-function
)
4796 (org-update-radio-target-regexp)
4797 ;; Beginning/end of defun
4798 (org-set-local 'beginning-of-defun-function
'org-beginning-of-defun
)
4799 (org-set-local 'end-of-defun-function
'org-end-of-defun
)
4800 ;; Next error for sparse trees
4801 (org-set-local 'next-error-function
'org-occur-next-match
)
4802 ;; Make sure dependence stuff works reliably, even for users who set it
4804 (if org-enforce-todo-dependencies
4805 (add-hook 'org-blocker-hook
4806 'org-block-todo-from-children-or-siblings-or-parent
)
4807 (remove-hook 'org-blocker-hook
4808 'org-block-todo-from-children-or-siblings-or-parent
))
4809 (if org-enforce-todo-checkbox-dependencies
4810 (add-hook 'org-blocker-hook
4811 'org-block-todo-from-checkboxes
)
4812 (remove-hook 'org-blocker-hook
4813 'org-block-todo-from-checkboxes
))
4815 ;; Comment characters
4816 (org-set-local 'comment-start
"#")
4817 (org-set-local 'comment-padding
" ")
4819 ;; Align options lines
4821 'align-mode-rules-list
4822 '((org-in-buffer-settings
4823 (regexp .
"^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
4824 (modes .
'(org-mode)))))
4827 (org-set-local 'imenu-create-index-function
4828 'org-imenu-get-tree
)
4830 ;; Make isearch reveal context
4831 (if (or (featurep 'xemacs
)
4832 (not (boundp 'outline-isearch-open-invisible-function
)))
4833 ;; Emacs 21 and XEmacs make use of the hook
4834 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
4835 ;; Emacs 22 deals with this through a special variable
4836 (org-set-local 'outline-isearch-open-invisible-function
4837 (lambda (&rest ignore
) (org-show-context 'isearch
))))
4839 ;; Turn on org-beamer-mode?
4840 (and org-startup-with-beamer-mode
(org-beamer-mode 1))
4842 ;; Setup the pcomplete hooks
4843 (set (make-local-variable 'pcomplete-command-completion-function
)
4844 'org-pcomplete-initial
)
4845 (set (make-local-variable 'pcomplete-command-name-function
)
4846 'org-command-at-point
)
4847 (set (make-local-variable 'pcomplete-default-completion-function
)
4849 (set (make-local-variable 'pcomplete-parse-arguments-function
)
4850 'org-parse-arguments
)
4851 (set (make-local-variable 'pcomplete-termination-string
) "")
4852 (set (make-local-variable 'face-remapping-alist
)
4853 '((default org-default
)))
4855 ;; If empty file that did not turn on org-mode automatically, make it to.
4856 (if (and org-insert-mode-line-in-empty-file
4857 (org-called-interactively-p 'any
)
4858 (= (point-min) (point-max)))
4859 (insert "# -*- mode: org -*-\n\n"))
4860 (unless org-inhibit-startup
4861 (when org-startup-align-all-tables
4862 (let ((bmp (buffer-modified-p)))
4863 (org-table-map-tables 'org-table-align
'quietly
)
4864 (set-buffer-modified-p bmp
)))
4865 (when org-startup-with-inline-images
4866 (org-display-inline-images))
4867 (when org-startup-indented
4868 (require 'org-indent
)
4869 (org-indent-mode 1))
4870 (unless org-inhibit-startup-visibility-stuff
4871 (org-set-startup-visibility))))
4873 (when (fboundp 'abbrev-table-put
)
4874 (abbrev-table-put org-mode-abbrev-table
4875 :parents
(list text-mode-abbrev-table
)))
4877 (put 'org-mode
'flyspell-mode-predicate
'org-mode-flyspell-verify
)
4879 (defun org-current-time ()
4880 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4881 (if (> (car org-time-stamp-rounding-minutes
) 1)
4882 (let ((r (car org-time-stamp-rounding-minutes
))
4883 (time (decode-time)))
4885 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
4890 "Return today date, considering `org-extend-today-until'."
4892 (time-subtract (current-time)
4893 (list 0 (* 3600 org-extend-today-until
) 0))))
4895 ;;;; Font-Lock stuff, including the activators
4897 (defvar org-mouse-map
(make-sparse-keymap))
4898 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
4899 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
4900 (when org-mouse-1-follows-link
4901 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
4902 (when org-tab-follows-link
4903 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
4904 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
4906 (require 'font-lock
)
4908 (defconst org-non-link-chars
"]\t\n\r<>")
4909 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "news"
4910 "shell" "elisp" "doi" "message"))
4911 (defvar org-link-types-re nil
4912 "Matches a link that has a url-like prefix like \"http:\"")
4913 (defvar org-link-re-with-space nil
4914 "Matches a link with spaces, optional angular brackets around it.")
4915 (defvar org-link-re-with-space2 nil
4916 "Matches a link with spaces, optional angular brackets around it.")
4917 (defvar org-link-re-with-space3 nil
4918 "Matches a link with spaces, only for internal part in bracket links.")
4919 (defvar org-angle-link-re nil
4920 "Matches link with angular brackets, spaces are allowed.")
4921 (defvar org-plain-link-re nil
4922 "Matches plain link, without spaces.")
4923 (defvar org-bracket-link-regexp nil
4924 "Matches a link in double brackets.")
4925 (defvar org-bracket-link-analytic-regexp nil
4926 "Regular expression used to analyze links.
4927 Here is what the match groups contain after a match:
4933 (defvar org-bracket-link-analytic-regexp
++ nil
4934 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
4935 (defvar org-any-link-re nil
4936 "Regular expression matching any link.")
4938 (defcustom org-match-sexp-depth
3
4939 "Number of stacked braces for sub/superscript matching.
4940 This has to be set before loading org.el to be effective."
4941 :group
'org-export-translation
; ??????????????????????????/
4944 (defun org-create-multibrace-regexp (left right n
)
4945 "Create a regular expression which will match a balanced sexp.
4946 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4947 as single character strings.
4948 The regexp returned will match the entire expression including the
4949 delimiters. It will also define a single group which contains the
4950 match except for the outermost delimiters. The maximum depth of
4951 stacked delimiters is N. Escaping delimiters is not possible."
4952 (let* ((nothing (concat "[^" left right
"]*?"))
4955 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
4958 re
(concat re or next
)
4959 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
4960 (concat left
"\\(" re
"\\)" right
)))
4962 (defvar org-match-substring-regexp
4964 "\\([^\\]\\)\\([_^]\\)\\("
4965 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
4967 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
4969 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
4970 "The regular expression matching a sub- or superscript.")
4972 (defvar org-match-substring-with-braces-regexp
4974 "\\([^\\]\\)\\([_^]\\)\\("
4975 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
4977 "The regular expression matching a sub- or superscript, forcing braces.")
4979 (defun org-make-link-regexps ()
4980 "Update the link regular expressions.
4981 This should be called after the variable `org-link-types' has changed."
4982 (setq org-link-types-re
4984 "\\`\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):")
4985 org-link-re-with-space
4987 "<?\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):"
4988 "\\([^" org-non-link-chars
" ]"
4989 "[^" org-non-link-chars
"]*"
4990 "[^" org-non-link-chars
" ]\\)>?")
4991 org-link-re-with-space2
4993 "<?\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):"
4994 "\\([^" org-non-link-chars
" ]"
4996 "[^" org-non-link-chars
" ]\\)>?")
4997 org-link-re-with-space3
4999 "<?\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):"
5000 "\\([^" org-non-link-chars
" ]"
5004 "<\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):"
5005 "\\([^" org-non-link-chars
" ]"
5006 "[^" org-non-link-chars
"]*"
5010 "\\<\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):"
5011 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5012 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5013 org-bracket-link-regexp
5014 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5015 org-bracket-link-analytic-regexp
5018 "\\(\\(" (mapconcat 'regexp-quote org-link-types
"\\|") "\\):\\)?"
5021 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5023 org-bracket-link-analytic-regexp
++
5026 "\\(\\(" (mapconcat 'regexp-quote
(cons "coderef" org-link-types
) "\\|") "\\):\\)?"
5029 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5032 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5033 org-angle-link-re
"\\)\\|\\("
5034 org-plain-link-re
"\\)")))
5036 (org-make-link-regexps)
5038 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
5039 "Regular expression for fast time stamp matching.")
5040 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5041 "Regular expression for fast time stamp matching.")
5042 (defconst org-ts-regexp0
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5043 "Regular expression matching time strings for analysis.
5044 This one does not require the space after the date, so it can be used
5045 on a string that terminates immediately after the date.")
5046 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5047 "Regular expression matching time strings for analysis.")
5048 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
5049 "Regular expression matching time stamps, with groups.")
5050 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
5051 "Regular expression matching time stamps (also [..]), with groups.")
5052 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
5053 "Regular expression matching a time stamp range.")
5054 (defconst org-tr-regexp-both
5055 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
5056 "Regular expression matching a time stamp range.")
5057 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
5058 org-ts-regexp
"\\)?")
5059 "Regular expression matching a time stamp or time stamp range.")
5060 (defconst org-tsr-regexp-both
(concat org-ts-regexp-both
"\\(--?-?"
5061 org-ts-regexp-both
"\\)?")
5062 "Regular expression matching a time stamp or time stamp range.
5063 The time stamps may be either active or inactive.")
5065 (defvar org-emph-face nil
)
5067 (defun org-do-emphasis-faces (limit)
5068 "Run through the buffer and add overlays to emphasised strings."
5070 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5071 (if (not (= (char-after (match-beginning 3))
5072 (char-after (match-beginning 4))))
5075 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5076 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5080 (org-remove-flyspell-overlays-in
5081 (match-beginning 0) (match-end 0)))
5082 (add-text-properties (match-beginning 2) (match-end 2)
5083 '(font-lock-multiline t org-emphasis t
))
5084 (when org-hide-emphasis-markers
5085 (add-text-properties (match-end 4) (match-beginning 5)
5086 '(invisible org-link
))
5087 (add-text-properties (match-beginning 3) (match-end 3)
5088 '(invisible org-link
)))))
5092 (defun org-emphasize (&optional char
)
5093 "Insert or change an emphasis, i.e. a font like bold or italic.
5094 If there is an active region, change that region to a new emphasis.
5095 If there is no region, just insert the marker characters and position
5096 the cursor between them.
5097 CHAR should be either the marker character, or the first character of the
5098 HTML tag associated with that emphasis. If CHAR is a space, the means
5099 to remove the emphasis of the selected region.
5100 If char is not given (for example in an interactive call) it
5101 will be prompted for."
5103 (let ((eal org-emphasis-alist
) e det
5104 (erc org-emphasis-regexp-components
)
5106 (string "") beg end move tag c s
)
5107 (if (org-region-active-p)
5108 (setq beg
(region-beginning) end
(region-end)
5109 string
(buffer-substring beg end
))
5112 (while (setq e
(pop eal
))
5113 (setq tag
(car (org-split-string (nth 2 e
) "[ <>/]+"))
5115 (push (cons c
(string-to-char (car e
))) det
)
5116 (setq prompt
(concat prompt
(format " [%s%c]%s" (car e
) c
5117 (substring tag
1)))))
5118 (setq det
(nreverse det
))
5120 (message "%s" (concat "Emphasis marker or tag:" prompt
))
5121 (setq char
(read-char-exclusive)))
5122 (setq char
(or (cdr (assoc char det
)) char
))
5123 (if (equal char ?\
)
5124 (setq s
"" move nil
)
5125 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5126 (error "No such emphasis marker: \"%c\"" char
))
5127 (setq s
(char-to-string char
)))
5128 (while (and (> (length string
) 1)
5129 (equal (substring string
0 1) (substring string -
1))
5130 (assoc (substring string
0 1) org-emphasis-alist
))
5131 (setq string
(substring string
1 -
1)))
5132 (setq string
(concat s string s
))
5133 (if beg
(delete-region beg end
))
5135 (string-match (concat "[" (nth 0 erc
) "\n]")
5136 (char-to-string (char-before (point)))))
5139 (string-match (concat "[" (nth 1 erc
) "\n]")
5140 (char-to-string (char-after (point)))))
5141 (insert " ") (backward-char 1))
5143 (and move
(backward-char 1))))
5145 (defconst org-nonsticky-props
5146 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text
))
5148 (defsubst org-rear-nonsticky-at
(pos)
5149 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5151 (defun org-activate-plain-links (limit)
5152 "Run through the buffer and add overlays to links."
5155 (if (re-search-forward org-plain-link-re limit t
)
5157 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5158 (setq f
(get-text-property (match-beginning 0) 'face
))
5159 (if (or (eq f
'org-tag
)
5160 (and (listp f
) (memq 'org-tag f
)))
5162 (add-text-properties (match-beginning 0) (match-end 0)
5163 (list 'mouse-face
'highlight
5165 'keymap org-mouse-map
))
5166 (org-rear-nonsticky-at (match-end 0)))
5169 (defun org-activate-code (limit)
5170 (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t
)
5172 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5173 (remove-text-properties (match-beginning 0) (match-end 0)
5174 '(display t invisible t intangible t
))
5177 (defcustom org-src-fontify-natively nil
5178 "When non-nil, fontify code in code blocks."
5180 :group
'org-appearance
5183 (defun org-fontify-meta-lines-and-blocks (limit)
5185 (org-fontify-meta-lines-and-blocks-1 limit
)
5186 (error (message "org-mode fontification error"))))
5188 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5189 "Fontify #+ lines and blocks, in the correct ways."
5190 (let ((case-fold-search t
))
5191 (if (re-search-forward
5192 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5194 (let ((beg (match-beginning 0))
5195 (block-start (match-end 0))
5197 (lang (match-string 7))
5198 (beg1 (line-beginning-position 2))
5199 (dc1 (downcase (match-string 2)))
5200 (dc3 (downcase (match-string 3)))
5201 end end1 quoting block-type ovl
)
5203 ((member dc1
'("html:" "ascii:" "latex:" "docbook:"))
5204 ;; a single line of backend-specific content
5205 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5206 (remove-text-properties (match-beginning 0) (match-end 0)
5207 '(display t invisible t intangible t
))
5208 (add-text-properties (match-beginning 1) (match-end 3)
5209 '(font-lock-fontified t face org-meta-line
))
5210 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5211 '(font-lock-fontified t face org-block
))
5212 ; for backend-specific code
5214 ((and (match-end 4) (equal dc3
"begin"))
5216 (setq block-type
(downcase (match-string 5))
5217 quoting
(member block-type org-protecting-blocks
))
5218 (when (re-search-forward
5219 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5220 nil t
) ;; on purpose, we look further than LIMIT
5221 (setq end
(match-end 0) end1
(1- (match-beginning 0)))
5222 (setq block-end
(match-beginning 0))
5224 (remove-text-properties beg end
5225 '(display t invisible t intangible t
)))
5226 (add-text-properties
5228 '(font-lock-fontified t font-lock-multiline t
))
5229 (add-text-properties beg beg1
'(face org-meta-line
))
5230 (add-text-properties end1
(min (point-max) (1+ end
))
5231 '(face org-meta-line
)) ; for end_src
5233 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5234 (org-src-font-lock-fontify-block lang block-start block-end
)
5235 ;; remove old background overlays
5237 (if (eq (overlay-get ov
'face
) 'org-block-background
)
5238 (delete-overlay ov
)))
5239 (overlays-at (/ (+ beg1 block-end
) 2)))
5240 ;; add a background overlay
5241 (setq ovl
(make-overlay beg1 block-end
))
5242 (overlay-put ovl
'face
'org-block-background
)
5243 (overlay-put ovl
'evaporate t
)) ;; make it go away when empty
5245 (add-text-properties beg1
(min (point-max) (1+ end1
))
5246 '(face org-block
))) ; end of source block
5247 ((not org-fontify-quote-and-verse-blocks
))
5248 ((string= block-type
"quote")
5249 (add-text-properties beg1
(1+ end1
) '(face org-quote
)))
5250 ((string= block-type
"verse")
5251 (add-text-properties beg1
(1+ end1
) '(face org-verse
))))
5252 (add-text-properties beg beg1
'(face org-block-begin-line
))
5253 (add-text-properties (1+ end
) (1+ end1
) '(face org-block-end-line
))
5255 ((member dc1
'("title:" "author:" "email:" "date:"))
5256 (add-text-properties
5258 (if (member (intern (substring dc1
0 -
1)) org-hidden-keywords
)
5259 '(font-lock-fontified t invisible t
)
5260 '(font-lock-fontified t face org-document-info-keyword
)))
5261 (add-text-properties
5262 (match-beginning 6) (match-end 6)
5263 (if (string-equal dc1
"title:")
5264 '(font-lock-fontified t face org-document-title
)
5265 '(font-lock-fontified t face org-document-info
))))
5266 ((not (member (char-after beg
) '(?\ ?
\t)))
5267 ;; just any other in-buffer setting, but not indented
5268 (add-text-properties
5269 beg
(1+ (match-end 0))
5270 '(font-lock-fontified t face org-meta-line
))
5272 ((or (member dc1
'("begin:" "end:" "caption:" "label:"
5273 "orgtbl:" "tblfm:" "tblname:" "result:"
5274 "results:" "source:" "srcname:" "call:"
5275 "data:" "header:" "headers:"))
5276 (and (match-end 4) (equal dc3
"attr")))
5277 (add-text-properties
5279 '(font-lock-fontified t face org-meta-line
))
5281 ((member dc3
'(" " ""))
5282 (add-text-properties
5284 '(font-lock-fontified t face font-lock-comment-face
)))
5287 (defun org-activate-angle-links (limit)
5288 "Run through the buffer and add overlays to links."
5289 (if (re-search-forward org-angle-link-re limit t
)
5291 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5292 (add-text-properties (match-beginning 0) (match-end 0)
5293 (list 'mouse-face
'highlight
5294 'keymap org-mouse-map
))
5295 (org-rear-nonsticky-at (match-end 0))
5298 (defun org-activate-footnote-links (limit)
5299 "Run through the buffer and add overlays to footnotes."
5300 (let ((fn (org-footnote-next-reference-or-definition limit
)))
5302 (let ((beg (nth 1 fn
)) (end (nth 2 fn
)))
5303 (org-remove-flyspell-overlays-in beg end
)
5304 (add-text-properties beg end
5305 (list 'mouse-face
'highlight
5306 'keymap org-mouse-map
5308 (if (= (point-at-bol) beg
)
5309 "Footnote definition"
5310 "Footnote reference")
5311 'font-lock-fontified t
5312 'font-lock-multiline t
5313 'face
'org-footnote
))))))
5315 (defun org-activate-bracket-links (limit)
5316 "Run through the buffer and add overlays to bracketed links."
5317 (if (re-search-forward org-bracket-link-regexp limit t
)
5318 (let* ((help (concat "LINK: "
5319 (org-match-string-no-properties 1)))
5320 ;; FIXME: above we should remove the escapes.
5321 ;; but that requires another match, protecting match data,
5322 ;; a lot of overhead for font-lock.
5323 (ip (org-maybe-intangible
5324 (list 'invisible
'org-link
5325 'keymap org-mouse-map
'mouse-face
'highlight
5326 'font-lock-multiline t
'help-echo help
)))
5327 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
5328 'font-lock-multiline t
'help-echo help
)))
5329 ;; We need to remove the invisible property here. Table narrowing
5330 ;; may have made some of this invisible.
5331 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5332 (remove-text-properties (match-beginning 0) (match-end 0)
5336 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
5337 (org-rear-nonsticky-at (match-beginning 3))
5338 (add-text-properties (match-beginning 3) (match-end 3) vp
)
5339 (org-rear-nonsticky-at (match-end 3))
5340 (add-text-properties (match-end 3) (match-end 0) ip
)
5341 (org-rear-nonsticky-at (match-end 0)))
5342 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
5343 (org-rear-nonsticky-at (match-beginning 1))
5344 (add-text-properties (match-beginning 1) (match-end 1) vp
)
5345 (org-rear-nonsticky-at (match-end 1))
5346 (add-text-properties (match-end 1) (match-end 0) ip
)
5347 (org-rear-nonsticky-at (match-end 0)))
5350 (defun org-activate-dates (limit)
5351 "Run through the buffer and add overlays to dates."
5352 (if (re-search-forward org-tsr-regexp-both limit t
)
5354 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5355 (add-text-properties (match-beginning 0) (match-end 0)
5356 (list 'mouse-face
'highlight
5357 'keymap org-mouse-map
))
5358 (org-rear-nonsticky-at (match-end 0))
5359 (when org-display-custom-times
5361 (org-display-custom-time (match-beginning 3) (match-end 3)))
5362 (org-display-custom-time (match-beginning 1) (match-end 1)))
5365 (defvar org-target-link-regexp nil
5366 "Regular expression matching radio targets in plain text.")
5367 (make-variable-buffer-local 'org-target-link-regexp
)
5368 (defvar org-target-regexp
"<<\\([^<>\n\r]+\\)>>"
5369 "Regular expression matching a link target.")
5370 (defvar org-radio-target-regexp
"<<<\\([^<>\n\r]+\\)>>>"
5371 "Regular expression matching a radio target.")
5372 (defvar org-any-target-regexp
"<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5373 "Regular expression matching any target.")
5375 (defun org-activate-target-links (limit)
5376 "Run through the buffer and add overlays to target matches."
5377 (when org-target-link-regexp
5378 (let ((case-fold-search t
))
5379 (if (re-search-forward org-target-link-regexp limit t
)
5381 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5382 (add-text-properties (match-beginning 0) (match-end 0)
5383 (list 'mouse-face
'highlight
5384 'keymap org-mouse-map
5385 'help-echo
"Radio target link"
5386 'org-linked-text t
))
5387 (org-rear-nonsticky-at (match-end 0))
5390 (defun org-update-radio-target-regexp ()
5391 "Find all radio targets in this file and update the regular expression."
5393 (when (memq 'radio org-activate-links
)
5394 (setq org-target-link-regexp
5395 (org-make-target-link-regexp (org-all-targets 'radio
)))
5396 (org-restart-font-lock)))
5398 (defun org-hide-wide-columns (limit)
5400 (setq s
(text-property-any (point) (or limit
(point-max))
5403 (setq e
(next-single-property-change s
'org-cwidth
))
5404 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
5408 (defvar org-latex-and-specials-regexp nil
5409 "Regular expression for highlighting export special stuff.")
5410 (defvar org-match-substring-regexp
)
5411 (defvar org-match-substring-with-braces-regexp
)
5413 ;; This should be with the exporter code, but we also use if for font-locking
5414 (defconst org-export-html-special-string-regexps
5415 '(("\\\\-" .
"­")
5416 ("---\\([^-]\\)" .
"—\\1")
5417 ("--\\([^-]\\)" .
"–\\1")
5418 ("\\.\\.\\." .
"…"))
5419 "Regular expressions for special string conversion.")
5422 (defun org-compute-latex-and-specials-regexp ()
5423 "Compute regular expression for stuff treated specially by exporters."
5424 (if (not org-highlight-latex-fragments-and-specials
)
5425 (org-set-local 'org-latex-and-specials-regexp nil
)
5428 ((matchers (plist-get org-format-latex-options
:matchers
))
5429 (latexs (delq nil
(mapcar (lambda (x) (if (member (car x
) matchers
) x
))
5430 org-latex-regexps
)))
5431 (org-export-allow-BIND nil
)
5432 (options (org-combine-plists (org-default-export-plist)
5433 (org-infile-export-plist)))
5434 (org-export-with-sub-superscripts (plist-get options
:sub-superscript
))
5435 (org-export-with-LaTeX-fragments (plist-get options
:LaTeX-fragments
))
5436 (org-export-with-TeX-macros (plist-get options
:TeX-macros
))
5437 (org-export-html-expand (plist-get options
:expand-quoted-html
))
5438 (org-export-with-special-strings (plist-get options
:special-strings
))
5441 ((equal org-export-with-sub-superscripts
'{})
5442 (list org-match-substring-with-braces-regexp
))
5443 (org-export-with-sub-superscripts
5444 (list org-match-substring-regexp
))
5447 (if org-export-with-LaTeX-fragments
5448 (mapcar (lambda (x) (nth 1 x
)) latexs
)))
5450 (if org-export-with-TeX-macros
5451 (list (concat "\\\\"
5457 (append org-entities-user
5459 (if (boundp 'org-latex-entities
)
5461 (or (car-safe x
) x
))
5466 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5467 (re-special (if org-export-with-special-strings
5468 (mapcar (lambda (x) (car x
))
5469 org-export-html-special-string-regexps
)))
5473 (if org-export-html-expand
"@<[^>\n]+>")
5476 'org-latex-and-specials-regexp
5477 (mapconcat 'identity
(append re-latex re-sub re-macros re-special
5480 (defun org-do-latex-and-special-faces (limit)
5481 "Run through the buffer and add overlays to links."
5482 (when org-latex-and-specials-regexp
5484 (while (and (not rtn
) (re-search-forward org-latex-and-specials-regexp
5486 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
5488 '(org-code org-verbatim underline
)))
5491 d
(cond ((member (char-after (1+ (match-beginning 0)))
5494 (font-lock-prepend-text-property
5495 (+ d
(match-beginning 0)) (match-end 0)
5496 'face
'org-latex-and-export-specials
)
5497 (add-text-properties (+ d
(match-beginning 0)) (match-end 0)
5498 '(font-lock-multiline t
)))))
5501 (defun org-restart-font-lock ()
5502 "Restart `font-lock-mode', to force refontification."
5503 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
5505 (font-lock-mode 1)))
5507 (defun org-all-targets (&optional radio
)
5508 "Return a list of all targets in this file.
5509 With optional argument RADIO, only find radio targets."
5510 (let ((re (if radio org-radio-target-regexp org-target-regexp
))
5513 (goto-char (point-min))
5514 (while (re-search-forward re nil t
)
5515 (add-to-list 'rtn
(downcase (org-match-string-no-properties 1))))
5518 (defun org-make-target-link-regexp (targets)
5519 "Make regular expression matching all strings in TARGETS.
5520 The regular expression finds the targets also if there is a line break
5527 (setq x
(regexp-quote x
))
5528 (while (string-match " +" x
)
5529 (setq x
(replace-match "\\s-+" t t x
)))
5535 (defun org-activate-tags (limit)
5536 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
5538 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
5539 (add-text-properties (match-beginning 1) (match-end 1)
5540 (list 'mouse-face
'highlight
5541 'keymap org-mouse-map
))
5542 (org-rear-nonsticky-at (match-end 1))
5545 (defun org-outline-level ()
5546 "Compute the outline level of the heading at point.
5547 This function assumes that the cursor is at the beginning of a line matched
5548 by `outline-regexp'. Otherwise it returns garbage.
5549 If this is called at a normal headline, the level is the number of stars.
5550 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5552 (looking-at org-outline-regexp
)
5553 (1- (- (match-end 0) (match-beginning 0)))))
5555 (defvar org-font-lock-keywords nil
)
5557 (defconst org-property-re
(org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5558 "Regular expression matching a property line.")
5560 (defvar org-font-lock-hook nil
5561 "Functions to be called for special font lock stuff.")
5563 (defvar org-font-lock-set-keywords-hook nil
5564 "Functions that can manipulate `org-font-lock-extra-keywords'.
5565 This is calles after `org-font-lock-extra-keywords' is defined, but before
5566 it is installed to be used by font lock. This can be useful if something
5567 needs to be inserted at a specific position in the font-lock sequence.")
5569 (defun org-font-lock-hook (limit)
5570 (run-hook-with-args 'org-font-lock-hook limit
))
5572 (defun org-set-font-lock-defaults ()
5573 (let* ((em org-fontify-emphasized-text
)
5574 (lk org-activate-links
)
5575 (org-font-lock-extra-keywords
5578 '(org-font-lock-hook)
5580 `(,(if org-fontify-whole-heading-line
5581 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
5582 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
5583 (1 (org-get-level-face 1))
5584 (2 (org-get-level-face 2))
5585 (3 (org-get-level-face 3)))
5587 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
5590 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
5591 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
5592 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
5593 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
5595 (list org-drawer-regexp
'(0 'org-special-keyword t
))
5596 (list "^[ \t]*:END:" '(0 'org-special-keyword t
))
5598 (list org-property-re
5599 '(1 'org-special-keyword t
)
5600 '(3 'org-property-value t
))
5602 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
5603 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
5604 (if (memq 'plain lk
) '(org-activate-plain-links))
5605 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
5606 (if (memq 'radio lk
) '(org-activate-target-links (0 'org-link t
)))
5607 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
5608 (if (memq 'footnote lk
) '(org-activate-footnote-links))
5609 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
5610 '(org-hide-wide-columns (0 nil append
))
5612 (list (concat "^\\*+[ \t]+" org-todo-regexp
"\\([ \t]\\|$\\)")
5613 '(1 (org-get-todo-face 1) t
))
5615 (if org-fontify-done-headline
5616 (list (concat "^[*]+ +\\<\\("
5617 (mapconcat 'regexp-quote org-done-keywords
"\\|")
5619 '(2 'org-headline-done t
))
5622 '(org-font-lock-add-priority-faces)
5624 '(org-font-lock-add-tag-faces)
5626 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
5627 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
5628 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
5629 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
5632 (if (featurep 'xemacs
)
5633 '(org-do-emphasis-faces (0 nil append
))
5634 '(org-do-emphasis-faces)))
5636 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5637 1 'org-checkbox prepend
)
5638 (if (cdr (assq 'checkbox org-list-automatic-rules
))
5639 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
5640 (0 (org-get-checkbox-statistics-face) t
)))
5641 ;; Description list items
5642 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
5644 ;; ARCHIVEd headings
5646 org-outline-regexp-bol
5647 "\\(.*:" org-archive-tag
":.*\\)")
5648 '(1 'org-archived prepend
))
5650 '(org-do-latex-and-special-faces)
5651 '(org-fontify-entities)
5652 '(org-raise-scripts)
5654 '(org-activate-code (1 'org-code t
))
5656 (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
5657 "\\|" org-quote-string
"\\)\\>")
5658 '(1 'org-special-keyword t
))
5659 '("^#.*" (0 'font-lock-comment-face t
))
5660 ;; Blocks and meta lines
5661 '(org-fontify-meta-lines-and-blocks)
5663 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
5664 (run-hooks 'org-font-lock-set-keywords-hook
)
5665 ;; Now set the full font-lock-keywords
5666 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
5667 (org-set-local 'font-lock-defaults
5668 '(org-font-lock-keywords t nil nil backward-paragraph
))
5669 (kill-local-variable 'font-lock-keywords
) nil
))
5671 (defun org-toggle-pretty-entities ()
5672 "Toggle the composition display of entities as UTF8 characters."
5674 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
5675 (org-restart-font-lock)
5676 (if org-pretty-entities
5677 (message "Entities are displayed as UTF8 characers")
5680 (org-decompose-region (point-min) (point-max))
5681 (message "Entities are displayed plain"))))
5683 (defun org-fontify-entities (limit)
5684 "Find an entity to fontify."
5686 (when org-pretty-entities
5688 (while (re-search-forward
5689 "\\\\\\([a-zA-Z][a-zA-Z0-9]*\\)\\($\\|[^[:alnum:]\n]\\)"
5691 (if (and (not (org-in-indented-comment-line))
5692 (setq ee
(org-entity-get (match-string 1)))
5693 (= (length (nth 6 ee
)) 1))
5695 (add-text-properties
5696 (match-beginning 0) (match-end 1)
5697 (list 'font-lock-fontified t
))
5698 (compose-region (match-beginning 0) (match-end 1)
5704 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
5705 "Fontify string S like in Org-mode."
5708 (let ((org-odd-levels-only odd-levels
))
5710 (font-lock-fontify-buffer)
5716 (defun org-get-level-face (n)
5717 "Get the right face for match N in font-lock matching of headlines."
5718 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
5719 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
5720 (if org-cycle-level-faces
5721 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
5722 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
5724 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
5726 (t (if org-level-color-stars-only nil org-f
))))
5729 (defun org-get-todo-face (kwd)
5730 "Get the right face for a TODO keyword KWD.
5731 If KWD is a number, get the corresponding match group."
5732 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
5733 (or (org-face-from-face-or-color
5734 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
5735 (and (member kwd org-done-keywords
) 'org-done
)
5738 (defun org-face-from-face-or-color (context inherit face-or-color
)
5739 "Create a face list that inherits INHERIT, but sets the foreground color.
5740 When FACE-OR-COLOR is not a string, just return it."
5741 (if (stringp face-or-color
)
5742 (list :inherit inherit
5743 (cdr (assoc context org-faces-easy-properties
))
5747 (defun org-font-lock-add-tag-faces (limit)
5748 "Add the special tag faces."
5749 (when (and org-tag-faces org-tags-special-faces-re
)
5750 (while (re-search-forward org-tags-special-faces-re limit t
)
5751 (add-text-properties (match-beginning 1) (match-end 1)
5752 (list 'face
(org-get-tag-face 1)
5753 'font-lock-fontified t
))
5754 (backward-char 1))))
5756 (defun org-font-lock-add-priority-faces (limit)
5757 "Add the special priority faces."
5758 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
5759 (add-text-properties
5760 (match-beginning 0) (match-end 0)
5761 (list 'face
(or (org-face-from-face-or-color
5762 'priority
'org-special-keyword
5763 (cdr (assoc (char-after (match-beginning 1))
5764 org-priority-faces
)))
5765 'org-special-keyword
)
5766 'font-lock-fontified t
))))
5768 (defun org-get-tag-face (kwd)
5769 "Get the right face for a TODO keyword KWD.
5770 If KWD is a number, get the corresponding match group."
5771 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
5772 (or (org-face-from-face-or-color
5773 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
5776 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
5777 "Remove fontification and activation overlays from links."
5778 (font-lock-default-unfontify-region beg end
)
5779 (let* ((buffer-undo-list t
)
5780 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
5781 (inhibit-modification-hooks t
)
5782 deactivate-mark buffer-file-name buffer-file-truename
)
5783 (org-decompose-region beg end
)
5784 (remove-text-properties
5787 ;; also remove line-prefix and wrap-prefix properties
5788 '(mouse-face t keymap t org-linked-text t
5789 invisible t intangible t
5790 line-prefix t wrap-prefix t
5791 org-no-flyspell t org-emphasis t
)
5792 '(mouse-face t keymap t org-linked-text t
5793 invisible t intangible t
5794 org-no-flyspell t org-emphasis t
)))
5795 (org-remove-font-lock-display-properties beg end
)))
5797 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
5798 ((raise 0.3) (height 0.7))
5801 "Display properties for showing superscripts and subscripts.")
5803 (defun org-remove-font-lock-display-properties (beg end
)
5804 "Remove specific display properties that have been added by font lock.
5805 The will remove the raise properties that are used to show superscripts
5809 (setq next
(next-single-property-change beg
'display nil end
)
5810 prop
(get-text-property beg
'display
))
5811 (if (member prop org-script-display
)
5812 (put-text-property beg next
'display nil
))
5815 (defun org-raise-scripts (limit)
5816 "Add raise properties to sub/superscripts."
5817 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
5818 (if (re-search-forward
5819 (if (eq org-use-sub-superscripts t
)
5820 org-match-substring-regexp
5821 org-match-substring-with-braces-regexp
)
5823 (let* ((pos (point)) table-p comment-p
5824 (mpos (match-beginning 3))
5825 (emph-p (get-text-property mpos
'org-emphasis
))
5826 (link-p (get-text-property mpos
'mouse-face
))
5827 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
5828 (goto-char (point-at-bol))
5829 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
5830 comment-p
(org-looking-at-p "[ \t]*#"))
5832 ;; FIXME: Should we go back one character here, for a_b^c
5833 ;; (goto-char (1- pos)) ;????????????????????
5834 (if (or comment-p emph-p link-p keyw-p
)
5836 (put-text-property (match-beginning 3) (match-end 0)
5838 (if (equal (char-after (match-beginning 2)) ?^
)
5839 (nth (if table-p
3 1) org-script-display
)
5840 (nth (if table-p
2 0) org-script-display
)))
5841 (add-text-properties (match-beginning 2) (match-end 2)
5843 'org-dwidth t
'org-dwidth-n
1))
5844 (if (and (eq (char-after (match-beginning 3)) ?
{)
5845 (eq (char-before (match-end 3)) ?
}))
5847 (add-text-properties
5848 (match-beginning 3) (1+ (match-beginning 3))
5849 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
5850 (add-text-properties
5851 (1- (match-end 3)) (match-end 3)
5852 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
5855 ;;;; Visibility cycling, including org-goto and indirect buffer
5859 (defvar org-cycle-global-status nil
)
5860 (make-variable-buffer-local 'org-cycle-global-status
)
5861 (defvar org-cycle-subtree-status nil
)
5862 (make-variable-buffer-local 'org-cycle-subtree-status
)
5866 (defvar org-inlinetask-min-level
)
5868 (defun org-cycle (&optional arg
)
5869 "TAB-action and visibility cycling for Org-mode.
5871 This is the command invoked in Org-mode by the TAB key. Its main purpose
5872 is outline visibility cycling, but it also invokes other actions
5873 in special contexts.
5875 - When this function is called with a prefix argument, rotate the entire
5876 buffer through 3 states (global cycling)
5877 1. OVERVIEW: Show only top-level headlines.
5878 2. CONTENTS: Show all headlines of all levels, but no body text.
5879 3. SHOW ALL: Show everything.
5880 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5881 determined by the variable `org-startup-folded', and by any VISIBILITY
5882 properties in the buffer.
5883 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5884 including any drawers.
5886 - When inside a table, re-align the table and move to the next field.
5888 - When point is at the beginning of a headline, rotate the subtree started
5889 by this line through 3 different states (local cycling)
5890 1. FOLDED: Only the main headline is shown.
5891 2. CHILDREN: The main headline and the direct children are shown.
5892 From this state, you can move to one of the children
5893 and zoom in further.
5894 3. SUBTREE: Show the entire subtree, including body text.
5895 If there is no subtree, switch directly from CHILDREN to FOLDED.
5897 - When point is at the beginning of an empty headline and the variable
5898 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5899 of the headline by demoting and promoting it to likely levels. This
5900 speeds up creation document structure by pressing TAB once or several
5901 times right after creating a new headline.
5903 - When there is a numeric prefix, go up to a heading with level ARG, do
5904 a `show-subtree' and return to the previous cursor position. If ARG
5905 is negative, go up that many levels.
5907 - When point is not at the beginning of a headline, execute the global
5908 binding for TAB, which is re-indenting the line. See the option
5909 `org-cycle-emulate-tab' for details.
5911 - Special case: if point is at the beginning of the buffer and there is
5912 no headline in line 1, this function will act as if called with prefix arg
5913 (C-u TAB, same as S-TAB) also when called without prefix arg.
5914 But only if also the variable `org-cycle-global-at-bob' is t."
5916 (org-load-modules-maybe)
5917 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
5918 (and org-cycle-level-after-item
/entry-creation
5919 (or (org-cycle-level)
5920 (org-cycle-item-indentation))))
5922 (or org-cycle-max-level
5923 (and (boundp 'org-inlinetask-min-level
)
5924 org-inlinetask-min-level
5925 (1- org-inlinetask-min-level
))))
5926 (nstars (and limit-level
5927 (if org-odd-levels-only
5928 (and limit-level
(1- (* limit-level
2)))
5931 (if (not (org-mode-p))
5933 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
5934 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
5935 (not (looking-at org-outline-regexp
))))
5938 (delq 'org-optimize-window-after-visibility-change
5939 (copy-sequence org-cycle-hook
))
5943 (if (or bob-special
(equal arg
'(4)))
5944 ;; special case: use global cycling
5950 (setq last-command
'dummy
)
5951 (org-set-startup-visibility)
5952 (message "Startup visibility, plus VISIBILITY properties"))
5956 (message "Entire buffer visible, including drawers"))
5958 ;; Table: enter it or move to the next field.
5959 ((org-at-table-p 'any
)
5960 (if (org-at-table.el-p
)
5961 (message "Use C-c ' to edit table.el tables")
5962 (if arg
(org-table-edit-field t
)
5963 (org-table-justify-field-maybe)
5964 (call-interactively 'org-table-next-field
))))
5966 ((run-hook-with-args-until-success
5967 'org-tab-after-check-for-table-hook
))
5969 ;; Global cycling: delegate to `org-cycle-internal-global'.
5970 ((eq arg t
) (org-cycle-internal-global))
5972 ;; Drawers: delegate to `org-flag-drawer'.
5973 ((and org-drawers org-drawer-regexp
5975 (beginning-of-line 1)
5976 (looking-at org-drawer-regexp
)))
5977 (org-flag-drawer ; toggle block visibility
5978 (not (get-char-property (match-end 0) 'invisible
))))
5980 ;; Show-subtree, ARG levels up from here.
5983 (org-back-to-heading)
5984 (outline-up-heading (if (< arg
0) (- arg
)
5985 (- (funcall outline-level
) arg
)))
5986 (org-show-subtree)))
5988 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5989 ((and (featurep 'org-inlinetask
)
5990 (org-inlinetask-at-task-p)
5991 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
5992 (org-inlinetask-toggle-visibility))
5994 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5995 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
5996 (save-excursion (beginning-of-line 1)
5997 (looking-at org-outline-regexp
)))
5998 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
5999 (org-cycle-internal-local))
6001 ;; From there: TAB emulation and template completion.
6002 (buffer-read-only (org-back-to-heading))
6004 ((run-hook-with-args-until-success
6005 'org-tab-after-check-for-cycling-hook
))
6007 ((org-try-structure-completion))
6009 ((org-try-cdlatex-tab))
6011 ((run-hook-with-args-until-success
6012 'org-tab-before-tab-emulation-hook
))
6014 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6016 (not (looking-at org-outline-regexp
))))
6017 (call-interactively (global-key-binding "\t")))
6019 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6020 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6021 (or (and (eq org-cycle-emulate-tab
'white
)
6022 (= (match-end 0) (point-at-eol)))
6023 (and (eq org-cycle-emulate-tab
'whitestart
)
6024 (>= (match-end 0) pos
))))
6026 (eq org-cycle-emulate-tab t
))
6027 (call-interactively (global-key-binding "\t")))
6030 (org-back-to-heading)
6033 (defun org-cycle-internal-global ()
6034 "Do the global cycling action."
6036 ((and (eq last-command this-command
)
6037 (eq org-cycle-global-status
'overview
))
6038 ;; We just created the overview - now do table of contents
6039 ;; This can be slow in very large buffers, so indicate action
6040 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6041 (message "CONTENTS...")
6043 (message "CONTENTS...done")
6044 (setq org-cycle-global-status
'contents
)
6045 (run-hook-with-args 'org-cycle-hook
'contents
))
6047 ((and (eq last-command this-command
)
6048 (eq org-cycle-global-status
'contents
))
6049 ;; We just showed the table of contents - now show everything
6050 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6052 (message "SHOW ALL")
6053 (setq org-cycle-global-status
'all
)
6054 (run-hook-with-args 'org-cycle-hook
'all
))
6057 ;; Default action: go to overview
6058 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6060 (message "OVERVIEW")
6061 (setq org-cycle-global-status
'overview
)
6062 (run-hook-with-args 'org-cycle-hook
'overview
))))
6064 (defun org-cycle-internal-local ()
6065 "Do the local cycling action."
6066 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6067 ;; First, determine end of headline (EOH), end of subtree or item
6068 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6073 (setq struct
(org-list-struct))
6074 (setq eoh
(point-at-eol))
6075 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6076 (setq has-children
(org-list-has-child-p (point) struct
)))
6077 (org-back-to-heading)
6078 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6079 (setq eos
(save-excursion
6080 (org-end-of-subtree t
)
6082 (skip-chars-forward " \t\n"))
6083 (if (eobp) (point) (1- (point)))))
6086 (let ((level (funcall outline-level
)))
6087 (outline-next-heading)
6088 (and (org-at-heading-p t
)
6089 (> (funcall outline-level
) level
))))
6091 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6092 ;; Determine end invisible part of buffer (EOL)
6093 (beginning-of-line 2)
6094 ;; XEmacs doesn't have `next-single-char-property-change'
6095 (if (featurep 'xemacs
)
6096 (while (and (not (eobp)) ;; this is like `next-line'
6097 (get-char-property (1- (point)) 'invisible
))
6098 (beginning-of-line 2))
6099 (while (and (not (eobp)) ;; this is like `next-line'
6100 (get-char-property (1- (point)) 'invisible
))
6101 (goto-char (next-single-char-property-change (point) 'invisible
))
6102 (and (eolp) (beginning-of-line 2))))
6104 ;; Find out what to do next and set `this-command'
6107 ;; Nothing is hidden behind this heading
6108 (run-hook-with-args 'org-pre-cycle-hook
'empty
)
6109 (message "EMPTY ENTRY")
6110 (setq org-cycle-subtree-status nil
)
6113 (outline-next-heading)
6114 (if (outline-invisible-p) (org-flag-heading nil
))))
6115 ((and (or (>= eol eos
)
6116 (not (string-match "\\S-" (buffer-substring eol eos
))))
6118 (not (setq children-skipped
6119 org-cycle-skip-children-state-if-no-children
))))
6120 ;; Entire subtree is hidden in one line: children view
6121 (run-hook-with-args 'org-pre-cycle-hook
'children
)
6123 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6126 ;; Fold every list in subtree to top-level items.
6127 (when (eq org-cycle-include-plain-lists
'integrate
)
6129 (org-back-to-heading)
6130 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6131 (beginning-of-line 1)
6132 (let* ((struct (org-list-struct))
6133 (prevs (org-list-prevs-alist struct
))
6134 (end (org-list-get-bottom-point struct
)))
6135 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6136 (org-list-get-all-items (point) struct prevs
))
6137 (goto-char end
))))))
6138 (message "CHILDREN")
6141 (outline-next-heading)
6142 (if (outline-invisible-p) (org-flag-heading nil
)))
6143 (setq org-cycle-subtree-status
'children
)
6144 (run-hook-with-args 'org-cycle-hook
'children
))
6145 ((or children-skipped
6146 (and (eq last-command this-command
)
6147 (eq org-cycle-subtree-status
'children
)))
6148 ;; We just showed the children, or no children are there,
6149 ;; now show everything.
6150 (run-hook-with-args 'org-pre-cycle-hook
'subtree
)
6151 (outline-flag-region eoh eos nil
)
6152 (message (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6153 (setq org-cycle-subtree-status
'subtree
)
6154 (run-hook-with-args 'org-cycle-hook
'subtree
))
6156 ;; Default action: hide the subtree.
6157 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6158 (outline-flag-region eoh eos t
)
6160 (setq org-cycle-subtree-status
'folded
)
6161 (run-hook-with-args 'org-cycle-hook
'folded
)))))
6164 (defun org-global-cycle (&optional arg
)
6165 "Cycle the global visibility. For details see `org-cycle'.
6166 With \\[universal-argument] prefix arg, switch to startup visibility.
6167 With a numeric prefix, show all headlines up to that level."
6169 (let ((org-cycle-include-plain-lists
6170 (if (org-mode-p) org-cycle-include-plain-lists nil
)))
6174 (hide-sublevels arg
)
6175 (setq org-cycle-global-status
'contents
))
6177 (org-set-startup-visibility)
6178 (message "Startup visibility, plus VISIBILITY properties."))
6180 (org-cycle '(4))))))
6182 (defun org-set-startup-visibility ()
6183 "Set the visibility required by startup options and properties."
6185 ((eq org-startup-folded t
)
6187 ((eq org-startup-folded
'content
)
6188 (let ((this-command 'org-cycle
) (last-command 'org-cycle
))
6189 (org-cycle '(4)) (org-cycle '(4)))))
6190 (unless (eq org-startup-folded
'showeverything
)
6191 (if org-hide-block-startup
(org-hide-block-all))
6192 (org-set-visibility-according-to-property 'no-cleanup
)
6193 (org-cycle-hide-archived-subtrees 'all
)
6194 (org-cycle-hide-drawers 'all
)
6195 (org-cycle-show-empty-lines t
)))
6197 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
6198 "Switch subtree visibilities according to :VISIBILITY: property."
6200 (let (org-show-entry-below state
)
6202 (goto-char (point-min))
6203 (while (re-search-forward
6204 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6206 (setq state
(match-string 1))
6208 (org-back-to-heading t
)
6212 ((equal state
'("fold" "folded"))
6214 ((equal state
"children")
6215 (org-show-hidden-entry)
6217 ((equal state
"content")
6220 (org-narrow-to-subtree)
6222 ((member state
'("all" "showall"))
6225 (org-cycle-hide-archived-subtrees 'all
)
6226 (org-cycle-hide-drawers 'all
)
6227 (org-cycle-show-empty-lines 'all
)))))
6229 (defun org-overview ()
6230 "Switch to overview mode, showing only top-level headlines.
6231 Really, this shows all headlines with level equal or greater than the level
6232 of the first headline in the buffer. This is important, because if the
6233 first headline is not level one, then (hide-sublevels 1) gives confusing
6236 (let ((level (save-excursion
6237 (goto-char (point-min))
6238 (if (re-search-forward org-outline-regexp-bol nil t
)
6240 (goto-char (match-beginning 0))
6241 (funcall outline-level
))))))
6242 (and level
(hide-sublevels level
))))
6244 (defun org-content (&optional arg
)
6245 "Show all headlines in the buffer, like a table of contents.
6246 With numerical argument N, show content up to level N."
6249 ;; Visit all headings and show their offspring
6250 (and (integerp arg
) (org-overview))
6251 (goto-char (point-max))
6253 (while (and (progn (condition-case nil
6254 (outline-previous-visible-heading 1)
6255 (error (goto-char (point-min))))
6257 (looking-at org-outline-regexp
))
6259 (show-children (1- arg
))
6261 (if (bobp) (throw 'exit nil
))))))
6264 (defun org-optimize-window-after-visibility-change (state)
6265 "Adjust the window after a change in outline visibility.
6266 This function is the default value of the hook `org-cycle-hook'."
6267 (when (get-buffer-window (current-buffer))
6269 ((eq state
'content
) nil
)
6270 ((eq state
'all
) nil
)
6271 ((eq state
'folded
) nil
)
6272 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
6273 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
6275 (defun org-remove-empty-overlays-at (pos)
6276 "Remove outline overlays that do not contain non-white stuff."
6279 (and (eq 'outline
(overlay-get o
'invisible
))
6280 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
6282 (delete-overlay o
)))
6285 (defun org-clean-visibility-after-subtree-move ()
6286 "Fix visibility issues after moving a subtree."
6287 ;; First, find a reasonable region to look at:
6288 ;; Start two siblings above, end three below
6289 (let* ((beg (save-excursion
6290 (and (org-get-last-sibling)
6291 (org-get-last-sibling))
6293 (end (save-excursion
6294 (and (org-get-next-sibling)
6295 (org-get-next-sibling)
6296 (org-get-next-sibling))
6297 (if (org-at-heading-p)
6300 (level (looking-at "\\*+"))
6301 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
6304 (narrow-to-region beg end
)
6306 ;; Properly fold already folded siblings
6307 (goto-char (point-min))
6308 (while (re-search-forward re nil t
)
6309 (if (and (not (outline-invisible-p))
6311 (goto-char (point-at-eol)) (outline-invisible-p)))
6313 (org-cycle-show-empty-lines 'overview
)
6314 (org-cycle-hide-drawers 'overview
)))))
6316 (defun org-cycle-show-empty-lines (state)
6317 "Show empty lines above all visible headlines.
6318 The region to be covered depends on STATE when called through
6319 `org-cycle-hook'. Lisp program can use t for STATE to get the
6320 entire buffer covered. Note that an empty line is only shown if there
6321 are at least `org-cycle-separator-lines' empty lines before the headline."
6322 (when (not (= org-cycle-separator-lines
0))
6324 (let* ((n (abs org-cycle-separator-lines
))
6326 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
6327 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
6328 (t (let ((ns (number-to-string (- n
2))))
6329 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
6330 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
6333 ((memq state
'(overview contents t
))
6334 (setq beg
(point-min) end
(point-max)))
6335 ((memq state
'(children folded
))
6336 (setq beg
(point) end
(progn (org-end-of-subtree t t
)
6337 (beginning-of-line 2)
6341 (while (re-search-forward re end t
)
6342 (unless (get-char-property (match-end 1) 'invisible
)
6343 (setq e
(match-end 1))
6344 (if (< org-cycle-separator-lines
0)
6345 (setq b
(save-excursion
6346 (goto-char (match-beginning 0))
6347 (org-back-over-empty-lines)
6349 (goto-char (max (point-min) (1- (point))))
6353 (setq b
(match-beginning 1)))
6354 (outline-flag-region b e nil
)))))))
6355 ;; Never hide empty lines at the end of the file.
6357 (goto-char (point-max))
6358 (outline-previous-heading)
6359 (outline-end-of-heading)
6360 (if (and (looking-at "[ \t\n]+")
6361 (= (match-end 0) (point-max)))
6362 (outline-flag-region (point) (match-end 0) nil
))))
6364 (defun org-show-empty-lines-in-parent ()
6365 "Move to the parent and re-show empty lines before visible headlines."
6367 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
6368 (org-cycle-show-empty-lines context
))))
6370 (defun org-files-list ()
6371 "Return `org-agenda-files' list, plus all open org-mode files.
6372 This is useful for operations that need to scan all of a user's
6373 open and agenda-wise Org files."
6374 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
6375 (dolist (buf (buffer-list))
6376 (with-current-buffer buf
6377 (if (and (org-mode-p) (buffer-file-name))
6378 (let ((file (expand-file-name (buffer-file-name))))
6379 (unless (member file files
)
6380 (push file files
))))))
6383 (defsubst org-entry-beginning-position
()
6384 "Return the beginning position of the current entry."
6385 (save-excursion (outline-back-to-heading t
) (point)))
6387 (defsubst org-entry-end-position
()
6388 "Return the end position of the current entry."
6389 (save-excursion (outline-next-heading) (point)))
6391 (defun org-cycle-hide-drawers (state)
6392 "Re-hide all drawers after a visibility state change."
6393 (when (and (org-mode-p)
6394 (not (memq state
'(overview folded contents
))))
6396 (let* ((globalp (memq state
'(contents all
)))
6397 (beg (if globalp
(point-min) (point)))
6398 (end (if globalp
(point-max)
6399 (if (eq state
'children
)
6400 (save-excursion (outline-next-heading) (point))
6401 (org-end-of-subtree t
)))))
6403 (while (re-search-forward org-drawer-regexp end t
)
6404 (org-flag-drawer t
))))))
6406 (defun org-flag-drawer (flag)
6408 (beginning-of-line 1)
6409 (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
6410 (let ((b (match-end 0)))
6411 (if (re-search-forward
6413 (save-excursion (outline-next-heading) (point)) t
)
6414 (outline-flag-region b
(point-at-eol) flag
)
6415 (error ":END: line missing at position %s" b
))))))
6417 (defun org-subtree-end-visible-p ()
6418 "Is the end of the current subtree visible?"
6419 (pos-visible-in-window-p
6420 (save-excursion (org-end-of-subtree t
) (point))))
6422 (defun org-first-headline-recenter (&optional N
)
6423 "Move cursor to the first headline and recenter the headline.
6424 Optional argument N means put the headline into the Nth line of the window."
6425 (goto-char (point-min))
6426 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
6428 (recenter (prefix-numeric-value N
))))
6430 ;;; Saving and restoring visibility
6432 (defun org-outline-overlay-data (&optional use-markers
)
6433 "Return a list of the locations of all outline overlays.
6434 These are overlays with the `invisible' property value `outline'.
6435 The return value is a list of cons cells, with start and stop
6436 positions for each overlay.
6437 If USE-MARKERS is set, return the positions as markers."
6444 (when (eq (overlay-get o
'invisible
) 'outline
)
6445 (setq beg
(overlay-start o
)
6446 end
(overlay-end o
))
6447 (and beg end
(> end beg
)
6449 (cons (move-marker (make-marker) beg
)
6450 (move-marker (make-marker) end
))
6452 (overlays-in (point-min) (point-max))))))))
6454 (defun org-set-outline-overlay-data (data)
6455 "Create visibility overlays for all positions in DATA.
6456 DATA should have been made by `org-outline-overlay-data'."
6463 (setq o
(make-overlay (car c
) (cdr c
)))
6464 (overlay-put o
'invisible
'outline
))
6467 ;;; Folding of blocks
6469 (defconst org-block-regexp
6470 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
6471 "Regular expression for hiding blocks.")
6473 (defvar org-hide-block-overlays nil
6474 "Overlays hiding blocks.")
6475 (make-variable-buffer-local 'org-hide-block-overlays
)
6477 (defun org-block-map (function &optional start end
)
6478 "Call FUNCTION at the head of all source blocks in the current buffer.
6479 Optional arguments START and END can be used to limit the range."
6480 (let ((start (or start
(point-min)))
6481 (end (or end
(point-max))))
6484 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
6487 (goto-char (match-beginning 0))
6488 (funcall function
)))))))
6490 (defun org-hide-block-toggle-all ()
6491 "Toggle the visibility of all blocks in the current buffer."
6492 (org-block-map #'org-hide-block-toggle
))
6494 (defun org-hide-block-all ()
6495 "Fold all blocks in the current buffer."
6497 (org-show-block-all)
6498 (org-block-map #'org-hide-block-toggle-maybe
))
6500 (defun org-show-block-all ()
6501 "Unfold all blocks in the current buffer."
6503 (mapc 'delete-overlay org-hide-block-overlays
)
6504 (setq org-hide-block-overlays nil
))
6506 (defun org-hide-block-toggle-maybe ()
6507 "Toggle visibility of block at point."
6509 (let ((case-fold-search t
))
6511 (beginning-of-line 1)
6512 (looking-at org-block-regexp
))
6513 (progn (org-hide-block-toggle)
6514 t
) ;; to signal that we took action
6515 nil
))) ;; to signal that we did not
6517 (defun org-hide-block-toggle (&optional force
)
6518 "Toggle the visibility of the current block."
6522 (if (re-search-forward org-block-regexp nil t
)
6523 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
6524 (end (match-end 0)) ;; end of entire body
6526 (if (memq t
(mapcar (lambda (overlay)
6527 (eq (overlay-get overlay
'invisible
)
6529 (overlays-at start
)))
6530 (if (or (not force
) (eq force
'off
))
6532 (when (member ov org-hide-block-overlays
)
6533 (setq org-hide-block-overlays
6534 (delq ov org-hide-block-overlays
)))
6535 (when (eq (overlay-get ov
'invisible
)
6537 (delete-overlay ov
)))
6538 (overlays-at start
)))
6539 (setq ov
(make-overlay start end
))
6540 (overlay-put ov
'invisible
'org-hide-block
)
6541 ;; make the block accessible to isearch
6543 ov
'isearch-open-invisible
6545 (when (member ov org-hide-block-overlays
)
6546 (setq org-hide-block-overlays
6547 (delq ov org-hide-block-overlays
)))
6548 (when (eq (overlay-get ov
'invisible
)
6550 (delete-overlay ov
))))
6551 (push ov org-hide-block-overlays
)))
6552 (error "Not looking at a source block"))))
6554 ;; org-tab-after-check-for-cycling-hook
6555 (add-hook 'org-tab-first-hook
'org-hide-block-toggle-maybe
)
6556 ;; Remove overlays when changing major mode
6557 (add-hook 'org-mode-hook
6558 (lambda () (org-add-hook 'change-major-mode-hook
6559 'org-show-block-all
'append
'local
)))
6563 (defvar org-goto-window-configuration nil
)
6564 (defvar org-goto-marker nil
)
6565 (defvar org-goto-map
6566 (let ((map (make-sparse-keymap)))
6567 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur
)) cmd
)
6568 (while (setq cmd
(pop cmds
))
6569 (substitute-key-definition cmd cmd map global-map
)))
6570 (suppress-keymap map
)
6571 (org-defkey map
"\C-m" 'org-goto-ret
)
6572 (org-defkey map
[(return)] 'org-goto-ret
)
6573 (org-defkey map
[(left)] 'org-goto-left
)
6574 (org-defkey map
[(right)] 'org-goto-right
)
6575 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
6576 (org-defkey map
"\C-i" 'org-cycle
)
6577 (org-defkey map
[(tab)] 'org-cycle
)
6578 (org-defkey map
[(down)] 'outline-next-visible-heading
)
6579 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
6580 (if org-goto-auto-isearch
6581 (if (fboundp 'define-key-after
)
6582 (define-key-after map
[t] 'org-goto-local-auto-isearch)
6584 (org-defkey map "q" 'org-goto-quit)
6585 (org-defkey map "n" 'outline-next-visible-heading)
6586 (org-defkey map "p" 'outline-previous-visible-heading)
6587 (org-defkey map "f" 'outline-forward-same-level)
6588 (org-defkey map "b" 'outline-backward-same-level)
6589 (org-defkey map "u" 'outline-up-heading))
6590 (org-defkey map "/" 'org-occur)
6591 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6592 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6593 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6594 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6595 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6598 (defconst org-goto-help
6599 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6600 RET=jump to location [Q]uit and return to previous location
6601 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6603 (defvar org-goto-start-pos) ; dynamically scoped parameter
6605 ;; FIXME: Docstring does not mention both interfaces
6606 (defun org-goto (&optional alternative-interface)
6607 "Look up a different location in the current file, keeping current visibility.
6609 When you want look-up or go to a different location in a document, the
6610 fastest way is often to fold the entire buffer and then dive into the tree.
6611 This method has the disadvantage, that the previous location will be folded,
6612 which may not be what you want.
6614 This command works around this by showing a copy of the current buffer
6615 in an indirect buffer, in overview mode. You can dive into the tree in
6616 that copy, use org-occur and incremental search to find a location.
6617 When pressing RET or `Q', the command returns to the original buffer in
6618 which the visibility is still unchanged. After RET is will also jump to
6619 the location selected in the indirect buffer and expose the headline
6622 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6623 (org-refile-use-outline-path t)
6624 (org-refile-target-verify-function nil)
6626 (if (not alternative-interface)
6628 (if (eq org-goto-interface 'outline)
6629 'outline-path-completion
6631 (org-goto-start-pos (point))
6633 (if (eq interface 'outline)
6634 (car (org-get-location (current-buffer) org-goto-help))
6635 (let ((pa (org-refile-get-location "Goto")))
6636 (org-refile-check-position pa)
6640 (org-mark-ring-push org-goto-start-pos)
6641 (goto-char selected-point)
6642 (if (or (outline-invisible-p) (org-invisible-p2))
6643 (org-show-context 'org-goto)))
6646 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6647 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6648 (defvar org-goto-local-auto-isearch-map) ; defined below
6650 (defun org-get-location (buf help)
6651 "Let the user select a location in the Org-mode buffer BUF.
6652 This function uses a recursive edit. It returns the selected position
6654 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6655 (isearch-hide-immediately nil)
6656 (isearch-search-fun-function
6657 (lambda () 'org-goto-local-search-headings))
6658 (org-goto-selected-point org-goto-exit-command)
6660 (special-display-buffer-names nil)
6661 (special-display-regexps nil)
6662 (special-display-function nil))
6664 (save-window-excursion
6665 (delete-other-windows)
6666 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6667 (org-pop-to-buffer-same-window
6669 (make-indirect-buffer (current-buffer) "*org-goto*")
6670 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6671 (with-output-to-temp-buffer "*Help*"
6673 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6674 (setq buffer-read-only nil)
6675 (let ((org-startup-truncated t)
6676 (org-startup-folded nil)
6677 (org-startup-align-all-tables nil))
6680 (setq buffer-read-only t)
6681 (if (and (boundp 'org-goto-start-pos)
6682 (integer-or-marker-p org-goto-start-pos))
6683 (let ((org-show-hierarchy-above t)
6684 (org-show-siblings t)
6685 (org-show-following-heading t))
6686 (goto-char org-goto-start-pos)
6687 (and (outline-invisible-p) (org-show-context)))
6688 (goto-char (point-min)))
6689 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6690 (message "Select location and press RET")
6691 (use-local-map org-goto-map)
6694 (kill-buffer "*org-goto*")
6695 (cons org-goto-selected-point org-goto-exit-command)))
6697 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6698 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6699 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6700 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6702 (defun org-goto-local-search-headings (string bound noerror)
6703 "Search and make sure that any matches are in headlines."
6705 (while (if isearch-forward
6706 (search-forward string bound noerror)
6707 (search-backward string bound noerror))
6708 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6709 (and (member :headline context)
6710 (not (member :tags context))))
6711 (throw 'return (point))))))
6713 (defun org-goto-local-auto-isearch ()
6716 (goto-char (point-min))
6717 (let ((keys (this-command-keys)))
6718 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6720 (isearch-process-search-char (string-to-char keys)))))
6722 (defun org-goto-ret (&optional arg)
6723 "Finish `org-goto' by going to the new location."
6725 (setq org-goto-selected-point (point)
6726 org-goto-exit-command 'return)
6729 (defun org-goto-left ()
6730 "Finish `org-goto' by going to the new location."
6732 (if (org-on-heading-p)
6734 (beginning-of-line 1)
6735 (setq org-goto-selected-point (point)
6736 org-goto-exit-command 'left)
6738 (error "Not on a heading")))
6740 (defun org-goto-right ()
6741 "Finish `org-goto' by going to the new location."
6743 (if (org-on-heading-p)
6745 (setq org-goto-selected-point (point)
6746 org-goto-exit-command 'right)
6748 (error "Not on a heading")))
6750 (defun org-goto-quit ()
6751 "Finish `org-goto' without cursor motion."
6753 (setq org-goto-selected-point nil)
6754 (setq org-goto-exit-command 'quit)
6757 ;;; Indirect buffer display of subtrees
6759 (defvar org-indirect-dedicated-frame nil
6760 "This is the frame being used for indirect tree display.")
6761 (defvar org-last-indirect-buffer nil)
6763 (defun org-tree-to-indirect-buffer (&optional arg)
6764 "Create indirect buffer and narrow it to current subtree.
6765 With numerical prefix ARG, go up to this level and then take that tree.
6766 If ARG is negative, go up that many levels.
6767 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6768 indirect buffer previously made with this command, to avoid proliferation of
6769 indirect buffers. However, when you call the command with a \
6770 \\[universal-argument] prefix, or
6771 when `org-indirect-buffer-display' is `new-frame', the last buffer
6772 is kept so that you can work with several indirect buffers at the same time.
6773 If `org-indirect-buffer-display' is `dedicated-frame', the \
6774 \\[universal-argument] prefix also
6775 requests that a new frame be made for the new buffer, so that the dedicated
6776 frame is not changed."
6778 (let ((cbuf (current-buffer))
6779 (cwin (selected-window))
6781 beg end level heading ibuf)
6783 (org-back-to-heading t)
6785 (setq level (org-outline-level))
6786 (if (< arg 0) (setq arg (+ level arg)))
6787 (while (> (setq level (org-outline-level)) arg)
6788 (outline-up-heading 1 t)))
6790 heading (org-get-heading))
6791 (org-end-of-subtree t t)
6792 (if (org-on-heading-p) (backward-char 1))
6794 (if (and (buffer-live-p org-last-indirect-buffer)
6795 (not (eq org-indirect-buffer-display 'new-frame))
6797 (kill-buffer org-last-indirect-buffer))
6798 (setq ibuf (org-get-indirect-buffer cbuf)
6799 org-last-indirect-buffer ibuf)
6801 ((or (eq org-indirect-buffer-display 'new-frame)
6802 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6803 (select-frame (make-frame))
6804 (delete-other-windows)
6805 (org-pop-to-buffer-same-window ibuf)
6806 (org-set-frame-title heading))
6807 ((eq org-indirect-buffer-display 'dedicated-frame)
6809 (select-frame (or (and org-indirect-dedicated-frame
6810 (frame-live-p org-indirect-dedicated-frame)
6811 org-indirect-dedicated-frame)
6812 (setq org-indirect-dedicated-frame (make-frame)))))
6813 (delete-other-windows)
6814 (org-pop-to-buffer-same-window ibuf)
6815 (org-set-frame-title (concat "Indirect: " heading)))
6816 ((eq org-indirect-buffer-display 'current-window)
6817 (org-pop-to-buffer-same-window ibuf))
6818 ((eq org-indirect-buffer-display 'other-window)
6819 (pop-to-buffer ibuf))
6820 (t (error "Invalid value")))
6821 (if (featurep 'xemacs)
6822 (save-excursion (org-mode) (turn-on-font-lock)))
6823 (narrow-to-region beg end)
6826 (and (window-live-p cwin) (select-window cwin))))
6828 (defun org-get-indirect-buffer (&optional buffer)
6829 (setq buffer (or buffer (current-buffer)))
6830 (let ((n 1) (base (buffer-name buffer)) bname)
6831 (while (buffer-live-p
6832 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6835 (make-indirect-buffer buffer bname 'clone)
6836 (error (make-indirect-buffer buffer bname)))))
6838 (defun org-set-frame-title (title)
6839 "Set the title of the current frame to the string TITLE."
6840 ;; FIXME: how to name a single frame in XEmacs???
6841 (unless (featurep 'xemacs)
6842 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6844 ;;;; Structure editing
6846 ;;; Inserting headlines
6848 (defun org-previous-line-empty-p ()
6851 (or (beginning-of-line 0) t)
6853 (looking-at "[ \t]*$")))))
6855 (defun org-insert-heading (&optional force-heading invisible-ok)
6856 "Insert a new heading or item with same depth at point.
6857 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6858 If point is at the beginning of a headline, insert a sibling before the
6859 current headline. If point is not at the beginning, split the line,
6860 create the new headline with the text in the current line after point
6861 \(but see also the variable `org-M-RET-may-split-line').
6863 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6864 This is important for non-interactive uses of the command."
6866 (if (or (= (buffer-size) 0)
6867 (and (not (save-excursion
6868 (and (ignore-errors (org-back-to-heading invisible-ok))
6869 (org-on-heading-p))))
6870 (not (org-in-item-p))))
6873 (run-hooks 'org-insert-heading-hook))
6874 (when (or force-heading (not (org-insert-item)))
6875 (let* ((empty-line-p nil)
6877 (on-heading (org-on-heading-p))
6878 (head (save-excursion
6881 (org-back-to-heading invisible-ok)
6882 (when (and (not on-heading)
6883 (featurep 'org-inlinetask)
6884 (integerp org-inlinetask-min-level)
6885 (>= (length (match-string 0))
6886 org-inlinetask-min-level))
6887 ;; Find a heading level before the inline task
6888 (while (and (setq level (org-up-heading-safe))
6889 (>= level org-inlinetask-min-level)))
6890 (if (org-on-heading-p)
6891 (org-back-to-heading invisible-ok)
6892 (error "This should not happen")))
6893 (setq empty-line-p (org-previous-line-empty-p))
6896 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6897 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6898 pos hide-previous previous-pos)
6900 ((and (org-on-heading-p) (bolp)
6902 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6903 ;; insert before the current line
6904 (open-line (if blank 2 1)))
6906 (not org-insert-heading-respect-content)
6909 (backward-char 1) (not (outline-invisible-p)))))
6910 ;; insert right here
6913 ;; somewhere in the line
6915 (setq previous-pos (point-at-bol))
6917 (setq hide-previous (outline-invisible-p)))
6918 (and org-insert-heading-respect-content (org-show-subtree))
6920 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6923 (goto-char (point-at-bol))
6924 (and (looking-at org-complex-heading-regexp)
6925 (> p (match-beginning 4)))))))
6928 (org-insert-heading-respect-content
6929 (org-end-of-subtree nil t)
6930 (when (featurep 'org-inlinetask)
6931 (while (and (not (eobp))
6932 (looking-at "\\(\\*+\\)[ \t]+")
6933 (>= (length (match-string 1))
6934 org-inlinetask-min-level))
6935 (org-end-of-subtree nil t)))
6936 (or (bolp) (newline))
6937 (or (org-previous-line-empty-p)
6938 (and blank (newline)))
6944 (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
6945 (setq tags (and (match-end 2) (match-string 2)))
6947 (delete-region (match-beginning 1) (match-end 1)))
6948 (setq pos (point-at-bol))
6949 (or split (end-of-line 1))
6950 (delete-horizontal-space)
6951 (if (string-match "\\`\\*+\\'"
6952 (buffer-substring (point-at-bol) (point)))
6954 (newline (if blank 2 1))
6960 (org-set-tags nil 'align))))
6962 (or split (end-of-line 1))
6963 (newline (if blank 2 1)))))))
6964 (insert head) (just-one-space)
6967 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6968 (when (and org-insert-heading-respect-content hide-previous)
6970 (goto-char previous-pos)
6972 (run-hooks 'org-insert-heading-hook)))))
6974 (defun org-get-heading (&optional no-tags)
6975 "Return the heading of the current entry, without the stars."
6977 (org-back-to-heading t)
6980 (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@#%]+:[ \t]*\\)?$")
6981 "\\*+[ \t]+\\([^\r\n]*\\)"))
6982 (match-string 1) "")))
6984 (defun org-heading-components ()
6985 "Return the components of the current heading.
6986 This is a list with the following elements:
6987 - the level as an integer
6988 - the reduced level, different if `org-odd-levels-only' is set.
6989 - the TODO keyword, or nil
6990 - the priority character, like ?A, or nil if no priority is given
6991 - the headline text itself, or the tags string if no headline text
6992 - the tags string, or nil."
6994 (org-back-to-heading t)
6995 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6996 (list (length (match-string 1))
6997 (org-reduced-level (length (match-string 1)))
6998 (org-match-string-no-properties 2)
6999 (and (match-end 3) (aref (match-string 3) 2))
7000 (org-match-string-no-properties 4)
7001 (org-match-string-no-properties 5)))))
7003 (defun org-get-entry ()
7004 "Get the entry text, after heading, entire subtree."
7006 (org-back-to-heading t)
7007 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7009 (defun org-insert-heading-after-current ()
7010 "Insert a new heading with same level as current, after current subtree."
7012 (org-back-to-heading)
7013 (org-insert-heading)
7014 (org-move-subtree-down)
7017 (defun org-insert-heading-respect-content ()
7019 (let ((org-insert-heading-respect-content t))
7020 (org-insert-heading t)))
7022 (defun org-insert-todo-heading-respect-content (&optional force-state)
7024 (let ((org-insert-heading-respect-content t))
7025 (org-insert-todo-heading force-state t)))
7027 (defun org-insert-todo-heading (arg &optional force-heading)
7028 "Insert a new heading with the same level and TODO state as current heading.
7029 If the heading has no TODO state, or if the state is DONE, use the first
7030 state (TODO by default). Also with prefix arg, force first state."
7032 (when (or force-heading (not (org-insert-item 'checkbox)))
7033 (org-insert-heading force-heading)
7035 (org-back-to-heading)
7036 (outline-previous-heading)
7037 (looking-at org-todo-line-regexp))
7041 (not (match-beginning 2))
7042 (member (match-string 2) org-done-keywords))
7043 (car org-todo-keywords-1)
7047 (run-hook-with-args-until-success
7048 'org-todo-get-default-hook new-mark-x nil)
7050 (beginning-of-line 1)
7051 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7052 (if org-treat-insert-todo-heading-as-state-change
7054 (insert new-mark " "))))
7055 (when org-provide-todo-statistics
7056 (org-update-parent-todo-statistics))))
7058 (defun org-insert-subheading (arg)
7059 "Insert a new subheading and demote it.
7060 Works for outline headings and for plain lists alike."
7062 (org-insert-heading arg)
7064 ((org-on-heading-p) (org-do-demote))
7065 ((org-at-item-p) (org-indent-item))))
7067 (defun org-insert-todo-subheading (arg)
7068 "Insert a new subheading with TODO keyword or checkbox and demote it.
7069 Works for outline headings and for plain lists alike."
7071 (org-insert-todo-heading arg)
7073 ((org-on-heading-p) (org-do-demote))
7074 ((org-at-item-p) (org-indent-item))))
7076 ;;; Promotion and Demotion
7078 (defvar org-after-demote-entry-hook nil
7079 "Hook run after an entry has been demoted.
7080 The cursor will be at the beginning of the entry.
7081 When a subtree is being demoted, the hook will be called for each node.")
7083 (defvar org-after-promote-entry-hook nil
7084 "Hook run after an entry has been promoted.
7085 The cursor will be at the beginning of the entry.
7086 When a subtree is being promoted, the hook will be called for each node.")
7088 (defun org-promote-subtree ()
7089 "Promote the entire subtree.
7090 See also `org-promote'."
7093 (org-with-limited-levels (org-map-tree 'org-promote)))
7094 (org-fix-position-after-promote))
7096 (defun org-demote-subtree ()
7097 "Demote the entire subtree. See `org-demote'.
7098 See also `org-promote'."
7101 (org-with-limited-levels (org-map-tree 'org-demote)))
7102 (org-fix-position-after-promote))
7105 (defun org-do-promote ()
7106 "Promote the current heading higher up the tree.
7107 If the region is active in `transient-mark-mode', promote all headings
7111 (if (org-region-active-p)
7112 (org-map-region 'org-promote (region-beginning) (region-end))
7114 (org-fix-position-after-promote))
7116 (defun org-do-demote ()
7117 "Demote the current heading lower down the tree.
7118 If the region is active in `transient-mark-mode', demote all headings
7122 (if (org-region-active-p)
7123 (org-map-region 'org-demote (region-beginning) (region-end))
7125 (org-fix-position-after-promote))
7127 (defun org-fix-position-after-promote ()
7128 "Make sure that after pro/demotion cursor position is right."
7129 (let ((pos (point)))
7130 (when (save-excursion
7131 (beginning-of-line 1)
7132 (looking-at org-todo-line-regexp)
7133 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7134 (cond ((eobp) (insert " "))
7135 ((eolp) (insert " "))
7136 ((equal (char-after) ?\ ) (forward-char 1))))))
7138 (defun org-current-level ()
7139 "Return the level of the current entry, or nil if before the first headline.
7140 The level is the number of stars at the beginning of the headline."
7142 (org-with-limited-levels
7144 (org-back-to-heading t)
7145 (funcall outline-level)))))
7147 (defun org-get-previous-line-level ()
7148 "Return the outline depth of the last headline before the current line.
7149 Returns 0 for the first headline in the buffer, and nil if before the
7151 (let ((current-level (org-current-level))
7152 (prev-level (when (> (line-number-at-pos) 1)
7154 (beginning-of-line 0)
7155 (org-current-level)))))
7156 (cond ((null current-level) nil) ; Before first headline
7157 ((null prev-level) 0) ; At first headline
7160 (defun org-reduced-level (l)
7161 "Compute the effective level of a heading.
7162 This takes into account the setting of `org-odd-levels-only'."
7165 (org-odd-levels-only (1+ (floor (/ l 2))))
7168 (defun org-level-increment ()
7169 "Return the number of stars that will be added or removed at a
7170 time to headlines when structure editing, based on the value of
7171 `org-odd-levels-only'."
7172 (if org-odd-levels-only 2 1))
7174 (defun org-get-valid-level (level &optional change)
7175 "Rectify a level change under the influence of `org-odd-levels-only'
7176 LEVEL is a current level, CHANGE is by how much the level should be
7177 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7178 even level numbers will become the next higher odd number."
7179 (if org-odd-levels-only
7180 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7181 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7182 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7183 (max 1 (+ level (or change 0)))))
7185 (if (boundp 'define-obsolete-function-alias)
7186 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7187 (define-obsolete-function-alias 'org-get-legal-level
7188 'org-get-valid-level)
7189 (define-obsolete-function-alias 'org-get-legal-level
7190 'org-get-valid-level "23.1")))
7192 (defun org-promote ()
7193 "Promote the current heading higher up the tree.
7194 If the region is active in `transient-mark-mode', promote all headings
7196 (org-back-to-heading t)
7197 (let* ((level (save-match-data (funcall outline-level)))
7198 (after-change-functions (remove 'flyspell-after-change-function
7199 after-change-functions))
7200 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7201 (diff (abs (- level (length up-head) -1))))
7202 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7203 (replace-match up-head nil t)
7204 ;; Fixup tag positioning
7205 (and org-auto-align-tags (org-set-tags nil t))
7206 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7207 (run-hooks 'org-after-promote-entry-hook)))
7209 (defun org-demote ()
7210 "Demote the current heading lower down the tree.
7211 If the region is active in `transient-mark-mode', demote all headings
7213 (org-back-to-heading t)
7214 (let* ((level (save-match-data (funcall outline-level)))
7215 (after-change-functions (remove 'flyspell-after-change-function
7216 after-change-functions))
7217 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7218 (diff (abs (- level (length down-head) -1))))
7219 (replace-match down-head nil t)
7220 ;; Fixup tag positioning
7221 (and org-auto-align-tags (org-set-tags nil t))
7222 (if org-adapt-indentation (org-fixup-indentation diff))
7223 (run-hooks 'org-after-demote-entry-hook)))
7225 (defun org-cycle-level ()
7226 "Cycle the level of an empty headline through possible states.
7227 This goes first to child, then to parent, level, then up the hierarchy.
7228 After top level, it switches back to sibling level."
7230 (let ((org-adapt-indentation nil))
7231 (when (org-point-at-end-of-empty-headline)
7232 (setq this-command 'org-cycle-level) ; Only needed for caching
7233 (let ((cur-level (org-current-level))
7234 (prev-level (org-get-previous-line-level)))
7236 ;; If first headline in file, promote to top-level.
7238 (loop repeat (/ (- cur-level 1) (org-level-increment))
7239 do (org-do-promote)))
7240 ;; If same level as prev, demote one.
7241 ((= prev-level cur-level)
7243 ;; If parent is top-level, promote to top level if not already.
7245 (loop repeat (/ (- cur-level 1) (org-level-increment))
7246 do (org-do-promote)))
7247 ;; If top-level, return to prev-level.
7249 (loop repeat (/ (- prev-level 1) (org-level-increment))
7250 do (org-do-demote)))
7251 ;; If less than prev-level, promote one.
7252 ((< cur-level prev-level)
7254 ;; If deeper than prev-level, promote until higher than
7256 ((> cur-level prev-level)
7257 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7258 do (org-do-promote))))
7261 (defun org-map-tree (fun)
7262 "Call FUN for every heading underneath the current one."
7263 (org-back-to-heading)
7264 (let ((level (funcall outline-level)))
7268 (outline-next-heading)
7269 (> (funcall outline-level) level))
7273 (defun org-map-region (fun beg end)
7274 "Call FUN for every heading between BEG and END."
7275 (let ((org-ignore-region t))
7277 (setq end (copy-marker end))
7279 (if (and (re-search-forward org-outline-regexp-bol nil t)
7283 (outline-next-heading)
7288 (defun org-fixup-indentation (diff)
7289 "Change the indentation in the current entry by DIFF.
7290 However, if any line in the current entry has no indentation, or if it
7291 would end up with no indentation after the change, nothing at all is done."
7293 (let ((end (save-excursion (outline-next-heading)
7295 (prohibit (if (> diff 0)
7297 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
7299 (unless (save-excursion (end-of-line 1)
7300 (re-search-forward prohibit end t))
7301 (while (and (< (point) end)
7302 (re-search-forward "^[ \t]+" end t))
7303 (goto-char (match-end 0))
7304 (setq col (current-column))
7305 (if (< diff 0) (replace-match ""))
7306 (org-indent-to-column (+ diff col))))
7307 (move-marker end nil))))
7309 (defun org-convert-to-odd-levels ()
7310 "Convert an org-mode file with all levels allowed to one with odd levels.
7311 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7314 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7315 (let ((outline-level 'org-outline-level)
7316 (org-odd-levels-only nil) n)
7318 (goto-char (point-min))
7319 (while (re-search-forward "^\\*\\*+ " nil t)
7320 (setq n (- (length (match-string 0)) 2))
7321 (while (>= (setq n (1- n)) 0)
7323 (end-of-line 1))))))
7325 (defun org-convert-to-oddeven-levels ()
7326 "Convert an org-mode file with only odd levels to one with odd/even levels.
7327 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7328 file contains a section with an even level, conversion would
7329 destroy the structure of the file. An error is signaled in this
7332 (goto-char (point-min))
7333 ;; First check if there are no even levels
7334 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
7335 (org-show-context t)
7336 (error "Not all levels are odd in this file. Conversion not possible"))
7337 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7338 (let ((outline-regexp org-outline-regexp)
7339 (outline-level 'org-outline-level)
7340 (org-odd-levels-only nil) n)
7342 (goto-char (point-min))
7343 (while (re-search-forward "^\\*\\*+ " nil t)
7344 (setq n (/ (1- (length (match-string 0))) 2))
7345 (while (>= (setq n (1- n)) 0)
7347 (end-of-line 1))))))
7349 (defun org-tr-level (n)
7350 "Make N odd if required."
7351 (if org-odd-levels-only (1+ (/ n 2)) n))
7353 ;;; Vertical tree motion, cutting and pasting of subtrees
7355 (defun org-move-subtree-up (&optional arg)
7356 "Move the current subtree up past ARG headlines of the same level."
7358 (org-move-subtree-down (- (prefix-numeric-value arg))))
7360 (defun org-move-subtree-down (&optional arg)
7361 "Move the current subtree down past ARG headlines of the same level."
7363 (setq arg (prefix-numeric-value arg))
7364 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7365 'org-get-last-sibling))
7366 (ins-point (make-marker))
7368 (col (current-column))
7369 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7371 (org-back-to-heading)
7374 (setq ne-beg (org-back-over-empty-lines))
7377 (save-excursion (outline-end-of-heading)
7378 (setq folded (outline-invisible-p)))
7379 (outline-end-of-subtree))
7380 (outline-next-heading)
7381 (setq ne-end (org-back-over-empty-lines))
7384 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7385 ;; include less whitespace
7388 (forward-line (- ne-beg ne-end))
7389 (setq beg (point))))
7390 ;; Find insertion point, with error handling
7392 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7393 (progn (goto-char beg0)
7394 (error "Cannot move past superior level or buffer limit")))
7395 (setq cnt (1- cnt)))
7397 ;; Moving forward - still need to move over subtree
7398 (progn (org-end-of-subtree t t)
7400 (org-back-over-empty-lines)
7401 (or (bolp) (newline)))))
7402 (setq ne-ins (org-back-over-empty-lines))
7403 (move-marker ins-point (point))
7404 (setq txt (buffer-substring beg end))
7405 (org-save-markers-in-region beg end)
7406 (delete-region beg end)
7407 (org-remove-empty-overlays-at beg)
7408 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7409 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7410 (and (not (bolp)) (looking-at "\n") (forward-char 1))
7411 (let ((bbb (point)))
7412 (insert-before-markers txt)
7413 (org-reinstall-markers-in-region bbb)
7414 (move-marker ins-point bbb))
7415 (or (bolp) (insert "\n"))
7416 (setq ins-end (point))
7417 (goto-char ins-point)
7418 (org-skip-whitespace)
7419 (when (and (< arg 0)
7420 (org-first-sibling-p)
7422 ;; Move whitespace back to beginning
7425 (let ((kill-whole-line t))
7426 (kill-line (- ne-ins ne-beg)) (point)))
7427 (insert (make-string (- ne-ins ne-beg) ?\n)))
7428 (move-marker ins-point nil)
7433 (org-cycle-hide-drawers 'children))
7434 (org-clean-visibility-after-subtree-move)
7435 ;; move back to the initial column we were at
7436 (move-to-column col)))
7438 (defvar org-subtree-clip ""
7439 "Clipboard for cut and paste of subtrees.
7440 This is actually only a copy of the kill, because we use the normal kill
7441 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7443 (defvar org-subtree-clip-folded nil
7444 "Was the last copied subtree folded?
7445 This is used to fold the tree back after pasting.")
7447 (defun org-cut-subtree (&optional n)
7448 "Cut the current subtree into the clipboard.
7449 With prefix arg N, cut this many sequential subtrees.
7450 This is a short-hand for marking the subtree and then cutting it."
7452 (org-copy-subtree n 'cut))
7454 (defun org-copy-subtree (&optional n cut force-store-markers)
7455 "Cut the current subtree into the clipboard.
7456 With prefix arg N, cut this many sequential subtrees.
7457 This is a short-hand for marking the subtree and then copying it.
7458 If CUT is non-nil, actually cut the subtree.
7459 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7460 of some markers in the region, even if CUT is non-nil. This is
7461 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7463 (let (beg end folded (beg0 (point)))
7464 (if (org-called-interactively-p 'any)
7465 (org-back-to-heading nil) ; take what looks like a subtree
7466 (org-back-to-heading t)) ; take what is really there
7467 (org-back-over-empty-lines)
7469 (skip-chars-forward " \t\r\n")
7471 (save-excursion (outline-end-of-heading)
7472 (setq folded (outline-invisible-p)))
7474 (org-forward-same-level (1- n) t)
7476 (org-end-of-subtree t t))
7477 (org-back-over-empty-lines)
7481 (setq org-subtree-clip-folded folded)
7482 (when (or cut force-store-markers)
7483 (org-save-markers-in-region beg end))
7484 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7485 (setq org-subtree-clip (current-kill 0))
7486 (message "%s: Subtree(s) with %d characters"
7487 (if cut "Cut" "Copied")
7488 (length org-subtree-clip)))))
7490 (defun org-paste-subtree (&optional level tree for-yank)
7491 "Paste the clipboard as a subtree, with modification of headline level.
7492 The entire subtree is promoted or demoted in order to match a new headline
7495 If the cursor is at the beginning of a headline, the same level as
7496 that headline is used to paste the tree
7498 If not, the new level is derived from the *visible* headings
7499 before and after the insertion point, and taken to be the inferior headline
7500 level of the two. So if the previous visible heading is level 3 and the
7501 next is level 4 (or vice versa), level 4 will be used for insertion.
7502 This makes sure that the subtree remains an independent subtree and does
7503 not swallow low level entries.
7505 You can also force a different level, either by using a numeric prefix
7506 argument, or by inserting the heading marker by hand. For example, if the
7507 cursor is after \"*****\", then the tree will be shifted to level 5.
7509 If optional TREE is given, use this text instead of the kill ring.
7511 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7512 move back over whitespace before inserting, and move point to the end of
7513 the inserted text when done."
7515 (setq tree (or tree (and kill-ring (current-kill 0))))
7516 (unless (org-kill-is-subtree-p tree)
7518 (substitute-command-keys
7519 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
7520 (org-with-limited-levels
7521 (let* ((visp (not (outline-invisible-p)))
7523 (^re_ (concat "\\(\\*+\\)[ \t]*"))
7524 (old-level (if (string-match org-outline-regexp-bol txt)
7525 (- (match-end 0) (match-beginning 0) 1)
7527 (force-level (cond (level (prefix-numeric-value level))
7528 ((and (looking-at "[ \t]*$")
7530 ^re_ (buffer-substring
7531 (point-at-bol) (point))))
7532 (- (match-end 1) (match-beginning 1)))
7534 (looking-at org-outline-regexp))
7535 (- (match-end 0) (point) 1))
7537 (previous-level (save-excursion
7540 (outline-previous-visible-heading 1)
7542 (- (match-end 0) (match-beginning 0) 1)
7545 (next-level (save-excursion
7548 (or (looking-at org-outline-regexp)
7549 (outline-next-visible-heading 1))
7551 (- (match-end 0) (match-beginning 0) 1)
7554 (new-level (or force-level (max previous-level next-level)))
7555 (shift (if (or (= old-level -1)
7557 (= old-level new-level))
7559 (- new-level old-level)))
7560 (delta (if (> shift 0) -1 1))
7561 (func (if (> shift 0) 'org-demote 'org-promote))
7562 (org-odd-levels-only nil)
7564 ;; Remove the forced level indicator
7566 (delete-region (point-at-bol) (point)))
7568 (beginning-of-line 1)
7569 (unless for-yank (org-back-over-empty-lines))
7571 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7572 (insert-before-markers txt)
7573 (unless (string-match "\n\\'" txt) (insert "\n"))
7574 (setq newend (point))
7575 (org-reinstall-markers-in-region beg)
7578 (skip-chars-forward " \t\n\r")
7580 (if (and (outline-invisible-p) visp)
7581 (save-excursion (outline-show-heading)))
7582 ;; Shift if necessary
7585 (narrow-to-region beg end)
7586 (while (not (= shift 0))
7587 (org-map-region func (point-min) (point-max))
7588 (setq shift (+ delta shift)))
7589 (goto-char (point-min))
7590 (setq newend (point-max))))
7591 (when (or (org-called-interactively-p 'interactive) for-yank)
7592 (message "Clipboard pasted as level %d subtree" new-level))
7593 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7595 (eq org-subtree-clip (current-kill 0))
7596 org-subtree-clip-folded)
7597 ;; The tree was folded before it was killed/copied
7599 (and for-yank (goto-char newend)))))
7601 (defun org-kill-is-subtree-p (&optional txt)
7602 "Check if the current kill is an outline subtree, or a set of trees.
7603 Returns nil if kill does not start with a headline, or if the first
7604 headline level is not the largest headline level in the tree.
7605 So this will actually accept several entries of equal levels as well,
7606 which is OK for `org-paste-subtree'.
7607 If optional TXT is given, check this string instead of the current kill."
7608 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7609 (re (org-get-limited-outline-regexp))
7610 (^re (concat "^" re))
7611 (start-level (and kill
7613 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
7615 (- (match-end 2) (match-beginning 2) 1)))
7616 (start (1+ (or (match-beginning 2) -1))))
7617 (if (not start-level)
7619 nil) ;; does not even start with a heading
7621 (while (setq start (string-match ^re kill (1+ start)))
7622 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7626 (defvar org-markers-to-move nil
7627 "Markers that should be moved with a cut-and-paste operation.
7628 Those markers are stored together with their positions relative to
7629 the start of the region.")
7631 (defun org-save-markers-in-region (beg end)
7632 "Check markers in region.
7633 If these markers are between BEG and END, record their position relative
7634 to BEG, so that after moving the block of text, we can put the markers back
7636 This function gets called just before an entry or tree gets cut from the
7637 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7638 called immediately, to move the markers with the entries."
7639 (setq org-markers-to-move nil)
7640 (when (featurep 'org-clock)
7641 (org-clock-save-markers-for-cut-and-paste beg end))
7642 (when (featurep 'org-agenda)
7643 (org-agenda-save-markers-for-cut-and-paste beg end)))
7645 (defun org-check-and-save-marker (marker beg end)
7646 "Check if MARKER is between BEG and END.
7647 If yes, remember the marker and the distance to BEG."
7648 (when (and (marker-buffer marker)
7649 (equal (marker-buffer marker) (current-buffer)))
7650 (if (and (>= marker beg) (< marker end))
7651 (push (cons marker (- marker beg)) org-markers-to-move))))
7653 (defun org-reinstall-markers-in-region (beg)
7654 "Move all remembered markers to their position relative to BEG."
7656 (move-marker (car x) (+ beg (cdr x))))
7657 org-markers-to-move)
7658 (setq org-markers-to-move nil))
7660 (defun org-narrow-to-subtree ()
7661 "Narrow buffer to the current subtree."
7665 (org-with-limited-levels
7667 (progn (org-back-to-heading t) (point))
7668 (progn (org-end-of-subtree t t)
7669 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7672 (defun org-narrow-to-block ()
7673 "Narrow buffer to the current block."
7675 (let ((bstart "^[ \t]*#\\+begin")
7676 (bend "[ \t]*#\\+end")
7677 (case-fold-search t) ;; allow #+BEGIN
7679 (if (org-in-regexps-block-p bstart bend)
7681 (save-excursion (re-search-backward bstart nil t)
7682 (setq b_start (match-beginning 0)))
7683 (save-excursion (re-search-forward bend nil t)
7684 (setq b_end (match-end 0)))
7685 (narrow-to-region b_start b_end))
7686 (error "Not in a block"))))
7689 (defvar org-property-drawer-re))
7691 (defvar org-property-start-re) ;; defined below
7692 (defun org-clone-subtree-with-time-shift (n &optional shift)
7693 "Clone the task (subtree) at point N times.
7694 The clones will be inserted as siblings.
7696 In interactive use, the user will be prompted for the number of
7697 clones to be produced, and for a time SHIFT, which may be a
7698 repeater as used in time stamps, for example `+3d'.
7700 When a valid repeater is given and the entry contains any time
7701 stamps, the clones will become a sequence in time, with time
7702 stamps in the subtree shifted for each clone produced. If SHIFT
7703 is nil or the empty string, time stamps will be left alone. The
7704 ID property of the original subtree is removed.
7706 If the original subtree did contain time stamps with a repeater,
7707 the following will happen:
7708 - the repeater will be removed in each clone
7709 - an additional clone will be produced, with the current, unshifted
7710 date(s) in the entry.
7711 - the original entry will be placed *after* all the clones, with
7713 - the start days in the repeater in the original entry will be shifted
7714 to past the last clone.
7715 I this way you can spell out a number of instances of a repeating task,
7716 and still retain the repeater to cover future instances of the task."
7717 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7718 (let (beg end template task idprop
7719 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7720 (if (not (and (integerp n) (> n 0)))
7721 (error "Invalid number of replications %s" n))
7722 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
7723 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
7725 (error "Invalid shift specification %s" shift))
7727 (setq shift-n (string-to-number (match-string 1 shift))
7728 shift-what (cdr (assoc (match-string 2 shift)
7729 '(("d" . day) ("w" . week)
7730 ("m" . month) ("y" . year))))))
7731 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7732 (setq nmin 1 nmax n)
7733 (org-back-to-heading t)
7735 (setq idprop (org-entry-get nil "ID"))
7736 (org-end-of-subtree t t)
7737 (or (bolp) (insert "\n"))
7739 (setq template (buffer-substring beg end))
7740 ;; Remove clocks and empty drawers
7743 (goto-char (point-min))
7744 (while (re-search-forward
7745 "^[ \t]*CLOCK:.*$" (save-excursion (org-end-of-subtree t t)) t)
7748 (goto-char (point-min))
7749 (while (re-search-forward
7750 (concat "^[ \t]*:" (regexp-opt org-drawers) ":[ \t]*$") nil t)
7751 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7752 (setq template (buffer-substring (point-min) (point-max))))
7754 (string-match "<[^<>\n]+ \\+[0-9]+[dwmy][^<>\n]*>" template))
7755 (delete-region beg end)
7757 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7759 (loop for n from nmin to nmax do
7764 (goto-char (point-min))
7765 (and idprop (if org-clone-delete-id
7766 (org-entry-delete nil "ID")
7767 (org-id-get-create t)))
7768 (while (re-search-forward org-property-start-re nil t)
7769 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7770 (goto-char (point-min))
7772 (while (re-search-forward org-ts-regexp-both nil t)
7773 (org-timestamp-change (* n shift-n) shift-what))
7774 (unless (= n n-no-remove)
7775 (goto-char (point-min))
7776 (while (re-search-forward org-ts-regexp nil t)
7778 (goto-char (match-beginning 0))
7779 (if (looking-at "<[^<>\n]+\\( +\\+[0-9]+[dwmy]\\)")
7780 (delete-region (match-beginning 1) (match-end 1)))))))
7781 (setq task (buffer-string)))
7787 (defun org-sort (with-case)
7788 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7789 Optional argument WITH-CASE means sort case-sensitively.
7790 With a double prefix argument, also remove duplicate entries."
7793 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7794 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7796 (org-call-with-arg 'org-sort-entries with-case))))
7798 (defun org-sort-remove-invisible (s)
7799 (remove-text-properties 0 (length s) org-rm-props s)
7800 (while (string-match org-bracket-link-regexp s)
7801 (setq s (replace-match (if (match-end 2)
7803 (match-string 1 s)) t t s)))
7806 (defvar org-priority-regexp) ; defined later in the file
7808 (defvar org-after-sorting-entries-or-items-hook nil
7809 "Hook that is run after a bunch of entries or items have been sorted.
7810 When children are sorted, the cursor is in the parent line when this
7811 hook gets called. When a region or a plain list is sorted, the cursor
7812 will be in the first entry of the sorted region/list.")
7814 (defun org-sort-entries
7815 (&optional with-case sorting-type getkey-func compare-func property)
7816 "Sort entries on a certain level of an outline tree.
7817 If there is an active region, the entries in the region are sorted.
7818 Else, if the cursor is before the first entry, sort the top-level items.
7819 Else, the children of the entry at point are sorted.
7821 Sorting can be alphabetically, numerically, by date/time as given by
7822 a time stamp, by a property or by priority.
7824 The command prompts for the sorting type unless it has been given to the
7825 function through the SORTING-TYPE argument, which needs to be a character,
7826 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7827 precise meaning of each character:
7829 n Numerically, by converting the beginning of the entry/item to a number.
7830 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7831 t By date/time, either the first active time stamp in the entry, or, if
7832 none exist, by the first inactive one.
7833 s By the scheduled date/time.
7834 d By deadline date/time.
7835 c By creation time, which is assumed to be the first inactive time stamp
7836 at the beginning of a line.
7837 p By priority according to the cookie.
7838 r By the value of a property.
7840 Capital letters will reverse the sort order.
7842 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7843 called with point at the beginning of the record. It must return either
7844 a string or a number that should serve as the sorting key for that record.
7846 Comparing entries ignores case by default. However, with an optional argument
7847 WITH-CASE, the sorting considers case as well."
7849 (let ((case-func (if with-case 'identity 'downcase))
7850 start beg end stars re re2
7852 ;; Find beginning and end of region to sort
7854 ((org-region-active-p)
7855 ;; we will sort the region
7856 (setq end (region-end)
7858 (goto-char (region-beginning))
7859 (if (not (org-on-heading-p)) (outline-next-heading))
7860 (setq start (point)))
7861 ((or (org-on-heading-p)
7862 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7863 ;; we will sort the children of the current headline
7864 (org-back-to-heading)
7866 end (progn (org-end-of-subtree t t)
7867 (or (bolp) (insert "\n"))
7868 (org-back-over-empty-lines)
7873 (outline-next-heading))
7875 ;; we will sort the top-level entries in this file
7876 (goto-char (point-min))
7877 (or (org-on-heading-p) (outline-next-heading))
7878 (setq start (point))
7879 (goto-char (point-max))
7880 (beginning-of-line 1)
7881 (when (looking-at ".*?\\S-")
7882 ;; File ends in a non-white line
7885 (setq end (point-max))
7886 (setq what "top-level")
7891 (if (>= beg end) (error "Nothing to sort"))
7893 (looking-at "\\(\\*+\\)")
7894 (setq stars (match-string 1)
7895 re (concat "^" (regexp-quote stars) " +")
7896 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
7897 txt (buffer-substring beg end))
7898 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
7899 (if (and (not (equal stars "*")) (string-match re2 txt))
7900 (error "Region to sort contains a level above the first entry"))
7902 (unless sorting-type
7904 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7905 [t]ime
[s]cheduled [d]eadline [c]reated
7906 A/N/T/S/D/C/P/O/F means reversed:"
7908 (setq sorting-type (read-char-exclusive))
7910 (and (= (downcase sorting-type) ?f)
7912 (org-icompleting-read "Sort using function: "
7913 obarray 'fboundp t nil nil))
7914 (setq getkey-func (intern getkey-func)))
7916 (and (= (downcase sorting-type) ?r)
7918 (org-icompleting-read "Property: "
7919 (mapcar 'list (org-buffer-property-keys t))
7922 (message "Sorting entries...")
7925 (narrow-to-region start end)
7926 (let ((dcst (downcase sorting-type))
7927 (case-fold-search nil)
7928 (now (current-time)))
7930 (/= dcst sorting-type)
7931 ;; This function moves to the beginning character of the "record" to
7934 (if (re-search-forward re nil t)
7935 (goto-char (match-beginning 0))
7936 (goto-char (point-max))))
7937 ;; This function moves to the last character of the "record" being
7942 (outline-forward-same-level 1)
7944 (goto-char (point-max))))))
7945 ;; This function returns the value that gets sorted against.
7949 (if (looking-at org-complex-heading-regexp)
7950 (string-to-number (match-string 4))
7953 (if (looking-at org-complex-heading-regexp)
7954 (funcall case-func (match-string 4))
7957 (let ((end (save-excursion (outline-next-heading) (point))))
7958 (if (or (re-search-forward org-ts-regexp end t)
7959 (re-search-forward org-ts-regexp-both end t))
7960 (org-time-string-to-seconds (match-string 0))
7961 (org-float-time now))))
7963 (let ((end (save-excursion (outline-next-heading) (point))))
7964 (if (re-search-forward
7965 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
7967 (org-time-string-to-seconds (match-string 0))
7968 (org-float-time now))))
7970 (let ((end (save-excursion (outline-next-heading) (point))))
7971 (if (re-search-forward org-scheduled-time-regexp end t)
7972 (org-time-string-to-seconds (match-string 1))
7973 (org-float-time now))))
7975 (let ((end (save-excursion (outline-next-heading) (point))))
7976 (if (re-search-forward org-deadline-time-regexp end t)
7977 (org-time-string-to-seconds (match-string 1))
7978 (org-float-time now))))
7980 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7981 (string-to-char (match-string 2))
7982 org-default-priority))
7984 (or (org-entry-get nil property) ""))
7986 (if (looking-at org-complex-heading-regexp)
7987 (- 9999 (length (member (match-string 2)
7988 org-todo-keywords-1)))))
7992 (setq tmp (funcall getkey-func))
7993 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7995 (error "Invalid key function `%s'" getkey-func)))
7996 (t (error "Invalid sorting type `%c'" sorting-type))))
7999 ((= dcst ?a) 'string<)
8000 ((= dcst ?f) compare-func)
8001 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8003 (run-hooks 'org-after-sorting-entries-or-items-hook)
8004 (message "Sorting entries...done")))
8006 (defun org-do-sort (table what &optional with-case sorting-type)
8007 "Sort TABLE of WHAT according to SORTING-TYPE.
8008 The user will be prompted for the SORTING-TYPE if the call to this
8009 function does not specify it. WHAT is only for the prompt, to indicate
8010 what is being sorted. The sorting key will be extracted from
8011 the car of the elements of the table.
8012 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8013 (unless sorting-type
8015 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8017 (setq sorting-type (read-char-exclusive)))
8018 (let ((dcst (downcase sorting-type))
8019 extractfun comparefun)
8020 ;; Define the appropriate functions
8023 (setq extractfun 'string-to-number
8024 comparefun (if (= dcst sorting-type) '< '>)))
8026 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8027 (lambda(x) (downcase (org-sort-remove-invisible x))))
8028 comparefun (if (= dcst sorting-type)
8030 (lambda (a b) (and (not (string< a b))
8031 (not (string= a b)))))))
8035 (if (or (string-match org-ts-regexp x)
8036 (string-match org-ts-regexp-both x))
8038 (org-time-string-to-time (match-string 0 x)))
8040 comparefun (if (= dcst sorting-type) '< '>)))
8041 (t (error "Invalid sorting type `%c'" sorting-type)))
8043 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8045 (lambda (a b) (funcall comparefun (car a) (car b))))))
8048 ;;; The orgstruct minor mode
8050 ;; Define a minor mode which can be used in other modes in order to
8051 ;; integrate the org-mode structure editing commands.
8053 ;; This is really a hack, because the org-mode structure commands use
8054 ;; keys which normally belong to the major mode. Here is how it
8055 ;; works: The minor mode defines all the keys necessary to operate the
8056 ;; structure commands, but wraps the commands into a function which
8057 ;; tests if the cursor is currently at a headline or a plain list
8058 ;; item. If that is the case, the structure command is used,
8059 ;; temporarily setting many Org-mode variables like regular
8060 ;; expressions for filling etc. However, when any of those keys is
8061 ;; used at a different location, function uses `key-binding' to look
8062 ;; up if the key has an associated command in another currently active
8063 ;; keymap (minor modes, major mode, global), and executes that
8064 ;; command. There might be problems if any of the keys is otherwise
8065 ;; used as a prefix key.
8067 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8068 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8069 ;; addresses this by checking explicitly for both bindings.
8071 (defvar orgstruct-mode-map (make-sparse-keymap)
8072 "Keymap for the minor `orgstruct-mode'.")
8074 (defvar org-local-vars nil
8075 "List of local variables, for use by `orgstruct-mode'.")
8078 (define-minor-mode orgstruct-mode
8079 "Toggle the minor mode `orgstruct-mode'.
8080 This mode is for using Org-mode structure commands in other
8081 modes. The following keys behave as if Org-mode were active, if
8082 the cursor is on a headline, or on a plain list item (both as
8083 defined by Org-mode).
8085 M-up Move entry/item up
8086 M-down Move entry/item down
8089 M-S-up Move entry/item up
8090 M-S-down Move entry/item down
8091 M-S-left Promote subtree
8092 M-S-right Demote subtree
8093 M-q Fill paragraph and items like in Org-mode
8095 C-c - Cycle list bullet
8096 TAB Cycle item visibility
8097 M-RET Insert new heading/item
8098 S-M-RET Insert new TODO heading / Checkbox item
8099 C-c C-c Set tags / toggle checkbox"
8100 nil " OrgStruct" nil
8101 (org-load-modules-maybe)
8102 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8105 (defun turn-on-orgstruct ()
8106 "Unconditionally turn on `orgstruct-mode'."
8109 (defun orgstruct++-mode (&optional arg)
8110 "Toggle `orgstruct-mode', the enhanced version of it.
8111 In addition to setting orgstruct-mode, this also exports all indentation
8112 and autofilling variables from org-mode into the buffer. It will also
8113 recognize item context in multiline items.
8114 Note that turning off orgstruct-mode will *not* remove the
8115 indentation/paragraph settings. This can only be done by refreshing the
8116 major mode, for example with \\[normal-mode]."
8118 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8126 "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8127 (symbol-name (car x)))
8128 (setq var (car x) val (nth 1 x))
8129 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8131 (org-set-local 'orgstruct-is-++ t))))
8133 (defvar orgstruct-is-++ nil
8134 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8135 (make-variable-buffer-local 'orgstruct-is-++)
8138 (defun turn-on-orgstruct++ ()
8139 "Unconditionally turn on `orgstruct++-mode'."
8140 (orgstruct++-mode 1))
8142 (defun orgstruct-error ()
8143 "Error when there is no default binding for a structure key."
8145 (error "This key has no function outside structure elements"))
8147 (defun orgstruct-setup ()
8148 "Setup orgstruct keymaps."
8152 '([(meta up)] org-metaup)
8153 '([(meta down)] org-metadown)
8154 '([(meta left)] org-metaleft)
8155 '([(meta right)] org-metaright)
8156 '([(meta shift up)] org-shiftmetaup)
8157 '([(meta shift down)] org-shiftmetadown)
8158 '([(meta shift left)] org-shiftmetaleft)
8159 '([(meta shift right)] org-shiftmetaright)
8160 '([?\e (up)] org-metaup)
8161 '([?\e (down)] org-metadown)
8162 '([?\e (left)] org-metaleft)
8163 '([?\e (right)] org-metaright)
8164 '([?\e (shift up)] org-shiftmetaup)
8165 '([?\e (shift down)] org-shiftmetadown)
8166 '([?\e (shift left)] org-shiftmetaleft)
8167 '([?\e (shift right)] org-shiftmetaright)
8168 '([(shift up)] org-shiftup)
8169 '([(shift down)] org-shiftdown)
8170 '([(shift left)] org-shiftleft)
8171 '([(shift right)] org-shiftright)
8172 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8173 '("\M-q" fill-paragraph)
8175 '("\C-c-" org-cycle-list-bullet)))
8177 (while (setq elt (pop bindings))
8178 (setq nfunc (1+ nfunc))
8179 (setq key (org-key (car elt))
8181 cmd (orgstruct-make-binding fun nfunc key))
8182 (org-defkey orgstruct-mode-map key cmd))
8184 ;; Special treatment needed for TAB and RET
8185 (org-defkey orgstruct-mode-map [(tab)]
8186 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8187 (org-defkey orgstruct-mode-map "\C-i"
8188 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8190 (org-defkey orgstruct-mode-map "\M-\C-m"
8191 (orgstruct-make-binding 'org-insert-heading 105
8192 "\M-\C-m" [(meta return)]))
8193 (org-defkey orgstruct-mode-map [(meta return)]
8194 (orgstruct-make-binding 'org-insert-heading 106
8195 [(meta return)] "\M-\C-m"))
8197 (org-defkey orgstruct-mode-map [(shift meta return)]
8198 (orgstruct-make-binding 'org-insert-todo-heading 107
8199 [(meta return)] "\M-\C-m"))
8201 (org-defkey orgstruct-mode-map "\e\C-m"
8202 (orgstruct-make-binding 'org-insert-heading 108
8203 "\e\C-m" [?\e (return)]))
8204 (org-defkey orgstruct-mode-map [?\e (return)]
8205 (orgstruct-make-binding 'org-insert-heading 109
8206 [?\e (return)] "\e\C-m"))
8207 (org-defkey orgstruct-mode-map [?\e (shift return)]
8208 (orgstruct-make-binding 'org-insert-todo-heading 110
8209 [?\e (return)] "\e\C-m"))
8211 (unless org-local-vars
8212 (setq org-local-vars (org-get-local-variables)))
8216 (defun orgstruct-make-binding (fun n &rest keys)
8217 "Create a function for binding in the structure minor mode.
8218 FUN is the command to call inside a table. N is used to create a unique
8219 command name. KEYS are keys that should be checked in for a command
8220 to execute outside of tables."
8223 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8225 (concat "In Structure, run `" (symbol-name fun) "'.\n"
8226 "Outside of structure, run the binding of `"
8227 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8231 `(org-context-p 'headline 'item
8232 (and orgstruct-is-++
8233 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8235 (list 'org-run-like-in-org-mode (list 'quote fun))
8236 (list 'let '(orgstruct-mode)
8237 (list 'call-interactively
8240 (list 'key-binding k))
8242 '('orgstruct-error))))))))
8244 (defun org-context-p (&rest contexts)
8245 "Check if local context is any of CONTEXTS.
8246 Possible values in the list of contexts are `table', `headline', and `item'."
8247 (let ((pos (point)))
8248 (goto-char (point-at-bol))
8249 (prog1 (or (and (memq 'table contexts)
8250 (looking-at "[ \t]*|"))
8251 (and (memq 'headline contexts)
8252 (looking-at org-outline-regexp))
8253 (and (memq 'item contexts)
8254 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
8255 (and (memq 'item-body contexts)
8259 (defun org-get-local-variables ()
8260 "Return a list of all local variables in an org-mode buffer."
8262 (with-current-buffer (get-buffer-create "*Org tmp*")
8265 (setq varlist (buffer-local-variables)))
8266 (kill-buffer "*Org tmp*")
8273 (list (car x) (list 'quote (cdr x)))))
8275 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8276 (symbol-name (car x)))
8280 (defun org-clone-local-variables (from-buffer &optional regexp)
8281 "Clone local variables from FROM-BUFFER.
8282 Optional argument REGEXP selects variables to clone."
8285 (and (symbolp (car pair))
8287 (string-match regexp (symbol-name (car pair))))
8288 (set (make-local-variable (car pair))
8290 (buffer-local-variables from-buffer)))
8293 (defun org-run-like-in-org-mode (cmd)
8294 "Run a command, pretending that the current buffer is in Org-mode.
8295 This will temporarily bind local variables that are typically bound in
8296 Org-mode to the values they have in Org-mode, and then interactively
8298 (org-load-modules-maybe)
8299 (unless org-local-vars
8300 (setq org-local-vars (org-get-local-variables)))
8301 (eval (list 'let org-local-vars
8302 (list 'call-interactively (list 'quote cmd)))))
8306 (defun org-get-category (&optional pos force-refresh)
8307 "Get the category applying to position POS."
8308 (if force-refresh (org-refresh-category-properties))
8309 (let ((pos (or pos (point))))
8310 (or (get-text-property pos 'org-category)
8311 (progn (org-refresh-category-properties)
8312 (get-text-property pos 'org-category)))))
8314 (defun org-refresh-category-properties ()
8315 "Refresh category text properties in the buffer."
8316 (let ((def-cat (cond
8317 ((null org-category)
8318 (if buffer-file-name
8319 (file-name-sans-extension
8320 (file-name-nondirectory buffer-file-name))
8322 ((symbolp org-category) (symbol-name org-category))
8324 beg end cat pos optionp)
8329 (goto-char (point-min))
8330 (put-text-property (point) (point-max) 'org-category def-cat)
8331 (while (re-search-forward
8332 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
8333 (setq pos (match-end 0)
8334 optionp (equal (char-after (match-beginning 0)) ?#)
8335 cat (org-trim (match-string 2)))
8337 (setq beg (point-at-bol) end (point-max))
8338 (org-back-to-heading t)
8339 (setq beg (point) end (org-end-of-subtree t t)))
8340 (put-text-property beg end 'org-category cat)
8341 (goto-char pos)))))))
8346 ;;; Link abbreviations
8348 (defun org-link-expand-abbrev (link)
8349 "Apply replacements as defined in `org-link-abbrev-alist."
8350 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
8351 (let* ((key (match-string 1 link))
8352 (as (or (assoc key org-link-abbrev-alist-local)
8353 (assoc key org-link-abbrev-alist)))
8354 (tag (and (match-end 2) (match-string 3 link)))
8360 ((symbolp rpl) (funcall rpl tag))
8361 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8362 ((string-match "%h" rpl)
8363 (replace-match (url-hexify-string (or tag "")) t t rpl))
8364 (t (concat rpl tag)))))
8367 ;;; Storing and inserting links
8369 (defvar org-insert-link-history nil
8370 "Minibuffer history for links inserted with `org-insert-link'.")
8372 (defvar org-stored-links nil
8373 "Contains the links stored with `org-store-link'.")
8375 (defvar org-store-link-plist nil
8376 "Plist with info about the most recently link created with `org-store-link'.")
8378 (defvar org-link-protocols nil
8379 "Link protocols added to Org-mode using `org-add-link-type'.")
8381 (defvar org-store-link-functions nil
8382 "List of functions that are called to create and store a link.
8383 Each function will be called in turn until one returns a non-nil
8384 value. Each function should check if it is responsible for creating
8385 this link (for example by looking at the major mode).
8386 If not, it must exit and return nil.
8387 If yes, it should return a non-nil value after a calling
8388 `org-store-link-props' with a list of properties and values.
8389 Special properties are:
8391 :type The link prefix, like \"http\". This must be given.
8392 :link The link, like \"http://www.astro.uva.nl/~dominik\".
8393 This is obligatory as well.
8394 :description Optional default description for the second pair
8395 of brackets in an Org-mode link. The user can still change
8396 this when inserting this link into an Org-mode buffer.
8398 In addition to these, any additional properties can be specified
8399 and then used in remember templates.")
8401 (defun org-add-link-type (type &optional follow export)
8402 "Add TYPE to the list of `org-link-types'.
8403 Re-compute all regular expressions depending on `org-link-types'
8405 FOLLOW and EXPORT are two functions.
8407 FOLLOW should take the link path as the single argument and do whatever
8408 is necessary to follow the link, for example find a file or display
8411 EXPORT should format the link path for export to one of the export formats.
8412 It should be a function accepting three arguments:
8414 path the path of the link, the text after the prefix (like \"http:\")
8415 desc the description of the link, if any, or a description added by
8416 org-export-normalize-links if there is none
8417 format the export format, a symbol like `html' or `latex' or `ascii'..
8419 The function may use the FORMAT information to return different values
8420 depending on the format. The return value will be put literally into
8421 the exported file. If the return value is nil, this means Org should
8422 do what it normally does with links which do not have EXPORT defined.
8424 Org-mode has a built-in default for exporting links. If you are happy with
8425 this default, there is no need to define an export function for the link
8426 type. For a simple example of an export function, see `org-bbdb.el'."
8427 (add-to-list 'org-link-types type t)
8428 (org-make-link-regexps)
8429 (if (assoc type org-link-protocols)
8430 (setcdr (assoc type org-link-protocols) (list follow export))
8431 (push (list type follow export) org-link-protocols)))
8433 (defvar org-agenda-buffer-name)
8436 (defun org-store-link (arg)
8437 "\\<org-mode-map>Store an org-link to the current location.
8438 This link is added to `org-stored-links' and can later be inserted
8439 into an org-buffer with \\[org-insert-link].
8441 For some link types, a prefix arg is interpreted:
8442 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8443 For file links, arg negates `org-context-in-file-links'."
8445 (org-load-modules-maybe)
8446 (setq org-store-link-plist nil) ; reset
8447 (org-with-limited-levels
8448 (let (link cpltxt desc description search txt custom-id agenda-link)
8451 ((run-hook-with-args-until-success 'org-store-link-functions)
8452 (setq link (plist-get org-store-link-plist :link)
8453 desc (or (plist-get org-store-link-plist :description) link)))
8455 ((equal (buffer-name) "*Org Edit Src Example*")
8457 (while (or (not label)
8461 (goto-char (point-min))
8463 (regexp-quote (format org-coderef-label-format label))
8465 (when label (message "Label exists already") (sit-for 2))
8466 (setq label (read-string "Code line label: " label)))
8468 (setq link (format org-coderef-label-format label))
8469 (setq gc (- 79 (length link)))
8470 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8472 (setq link (concat "(" label ")") desc nil)))
8474 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8475 ;; We are in the agenda, link to referenced location
8476 (let ((m (or (get-text-property (point) 'org-hd-marker)
8477 (get-text-property (point) 'org-marker))))
8479 (org-with-point-at m
8481 (if (org-called-interactively-p 'any)
8482 (call-interactively 'org-store-link)
8483 (org-store-link nil)))))))
8485 ((eq major-mode 'calendar-mode)
8486 (let ((cd (calendar-cursor-to-date)))
8489 (car org-time-stamp-formats)
8491 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8493 (org-store-link-props :type "calendar" :date cd)))
8495 ((eq major-mode 'w3-mode)
8496 (setq cpltxt (if (and (buffer-name)
8497 (not (string-match "Untitled" (buffer-name))))
8500 link (org-make-link (url-view-url t)))
8501 (org-store-link-props :type "w3" :url (url-view-url t)))
8503 ((eq major-mode 'w3m-mode)
8504 (setq cpltxt (or w3m-current-title w3m-current-url)
8505 link (org-make-link w3m-current-url))
8506 (org-store-link-props :type "w3m" :url (url-view-url t)))
8508 ((setq search (run-hook-with-args-until-success
8509 'org-create-file-search-functions))
8510 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8512 (setq cpltxt (or description link)))
8514 ((eq major-mode 'image-mode)
8515 (setq cpltxt (concat "file:"
8516 (abbreviate-file-name buffer-file-name))
8517 link (org-make-link cpltxt))
8518 (org-store-link-props :type "image" :file buffer-file-name))
8520 ((eq major-mode 'dired-mode)
8521 ;; link to the file in the current line
8522 (let ((file (dired-get-filename nil t)))
8524 (abbreviate-file-name
8525 (expand-file-name (dired-get-filename nil t)))
8526 ;; otherwise, no file so use current directory.
8528 (setq cpltxt (concat "file:" file)
8529 link (org-make-link cpltxt))))
8531 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8532 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8534 ((org-in-regexp "<<\\(.*?\\)>>")
8537 (abbreviate-file-name
8538 (buffer-file-name (buffer-base-buffer)))
8539 "::" (match-string 1))
8540 link (org-make-link cpltxt)))
8541 ((and (featurep 'org-id)
8542 (or (eq org-link-to-org-use-id t)
8543 (and (eq org-link-to-org-use-id 'create-if-interactive)
8544 (org-called-interactively-p 'any))
8545 (and (eq org-link-to-org-use-id
8546 'create-if-interactive-and-no-custom-id)
8547 (org-called-interactively-p 'any)
8549 (and org-link-to-org-use-id
8550 (org-entry-get nil "ID"))))
8551 ;; We can make a link using the ID.
8552 (setq link (condition-case nil
8553 (prog1 (org-id-store-link)
8554 (setq desc (plist-get org-store-link-plist
8557 ;; probably before first headline, link to file only
8559 (abbreviate-file-name
8560 (buffer-file-name (buffer-base-buffer))))))))
8562 ;; Just link to current headline
8563 (setq cpltxt (concat "file:"
8564 (abbreviate-file-name
8565 (buffer-file-name (buffer-base-buffer)))))
8566 ;; Add a context search string
8567 (when (org-xor org-context-in-file-links arg)
8569 ((org-on-heading-p) nil)
8570 ((org-region-active-p)
8571 (buffer-substring (region-beginning) (region-end)))
8573 (when (or (null txt) (string-match "\\S-" txt))
8577 (org-make-org-heading-search-string txt)
8579 desc (or (nth 4 (ignore-errors
8580 (org-heading-components))) "NONE"))))
8581 (if (string-match "::\\'" cpltxt)
8582 (setq cpltxt (substring cpltxt 0 -2)))
8583 (setq link (org-make-link cpltxt)))))
8585 ((buffer-file-name (buffer-base-buffer))
8586 ;; Just link to this file here.
8587 (setq cpltxt (concat "file:"
8588 (abbreviate-file-name
8589 (buffer-file-name (buffer-base-buffer)))))
8590 ;; Add a context string
8591 (when (org-xor org-context-in-file-links arg)
8592 (setq txt (if (org-region-active-p)
8593 (buffer-substring (region-beginning) (region-end))
8594 (buffer-substring (point-at-bol) (point-at-eol))))
8595 ;; Only use search option if there is some text.
8596 (when (string-match "\\S-" txt)
8598 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8600 (setq link (org-make-link cpltxt)))
8602 ((org-called-interactively-p 'interactive)
8603 (error "Cannot link to a buffer which is not visiting a file"))
8605 (t (setq link nil)))
8607 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8608 (setq link (or link cpltxt)
8609 desc (or desc cpltxt))
8610 (if (equal desc "NONE") (setq desc nil))
8612 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8614 (setq org-stored-links
8615 (cons (list link desc) org-stored-links))
8616 (message "Stored: %s" (or desc link))
8618 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8620 (setq org-stored-links
8621 (cons (list link desc) org-stored-links))))
8622 (or agenda-link (and link (org-make-link-string link desc)))))))
8624 (defun org-store-link-props (&rest plist)
8625 "Store link properties, extract names and addresses."
8627 (when (setq x (plist-get plist :from))
8628 (setq adr (mail-extract-address-components x))
8629 (setq plist (plist-put plist :fromname (car adr)))
8630 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8631 (when (setq x (plist-get plist :to))
8632 (setq adr (mail-extract-address-components x))
8633 (setq plist (plist-put plist :toname (car adr)))
8634 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8635 (let ((from (plist-get plist :from))
8636 (to (plist-get plist :to)))
8637 (when (and from to org-from-is-user-regexp)
8639 (plist-put plist :fromto
8640 (if (string-match org-from-is-user-regexp from)
8642 (concat "from %f"))))))
8643 (setq org-store-link-plist plist))
8645 (defun org-add-link-props (&rest plist)
8646 "Add these properties to the link property list."
8649 (setq key (pop plist) value (pop plist))
8650 (setq org-store-link-plist
8651 (plist-put org-store-link-plist key value)))))
8653 (defun org-email-link-description (&optional fmt)
8654 "Return the description part of an email link.
8655 This takes information from `org-store-link-plist' and formats it
8656 according to FMT (default from `org-email-link-description-format')."
8657 (setq fmt (or fmt org-email-link-description-format))
8658 (let* ((p org-store-link-plist)
8659 (to (plist-get p :toaddress))
8660 (from (plist-get p :fromaddress))
8663 (cons "%c" (plist-get p :fromto))
8664 (cons "%F" (plist-get p :from))
8665 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8666 (cons "%T" (plist-get p :to))
8667 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8668 (cons "%s" (plist-get p :subject))
8669 (cons "%d" (plist-get p :date))
8670 (cons "%m" (plist-get p :message-id)))))
8671 (when (string-match "%c" fmt)
8672 ;; Check if the user wrote this message
8673 (if (and org-from-is-user-regexp from to
8674 (save-match-data (string-match org-from-is-user-regexp from)))
8675 (setq fmt (replace-match "to %t" t t fmt))
8676 (setq fmt (replace-match "from %f" t t fmt))))
8677 (org-replace-escapes fmt table)))
8679 (defun org-make-org-heading-search-string (&optional string heading)
8680 "Make search string for STRING or current headline."
8682 (let ((s (or string (org-get-heading)))
8683 (lines org-context-in-file-links))
8684 (unless (and string (not heading))
8685 ;; We are using a headline, clean up garbage in there.
8686 (if (string-match org-todo-regexp s)
8687 (setq s (replace-match "" t t s)))
8688 (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
8689 (setq s (replace-match "" t t s)))
8690 (setq s (org-trim s))
8691 (if (string-match (concat "^\\(" org-quote-string "\\|"
8692 org-comment-string "\\)") s)
8693 (setq s (replace-match "" t t s)))
8694 (while (string-match org-ts-regexp s)
8695 (setq s (replace-match "" t t s))))
8696 (or string (setq s (concat "*" s))) ; Add * for headlines
8697 (when (and string (integerp lines) (> lines 0))
8698 (let ((slines (org-split-string s "\n")))
8699 (when (< lines (length slines))
8702 (reverse (nthcdr (- (length slines) lines)
8703 (reverse slines))) "\n")))))
8704 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
8706 (defun org-make-link (&rest strings)
8707 "Concatenate STRINGS."
8708 (apply 'concat strings))
8710 (defun org-make-link-string (link &optional description)
8711 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8712 (unless (string-match "\\S-" link)
8713 (error "Empty link"))
8714 (when (and description
8715 (stringp description)
8716 (not (string-match "\\S-" description)))
8717 (setq description nil))
8718 (when (stringp description)
8719 ;; Remove brackets from the description, they are fatal.
8720 (while (string-match "\\[" description)
8721 (setq description (replace-match "{" t t description)))
8722 (while (string-match "\\]" description)
8723 (setq description (replace-match "}" t t description))))
8724 (when (equal link description)
8725 ;; No description needed, it is identical
8726 (setq description nil))
8727 (when (and (not description)
8728 (not (string-match (org-image-file-name-regexp) link))
8729 (not (equal link (org-link-escape link))))
8730 (setq description (org-extract-attributes link)))
8732 (cond ((string-match (org-image-file-name-regexp) link) link)
8733 ((string-match org-link-types-re link)
8734 (concat (match-string 1 link)
8735 (org-link-escape (substring link (match-end 1)))))
8736 (t (org-link-escape link))))
8737 (concat "[[" link "]"
8738 (if description (concat "[" description "]") "")
8741 (defconst org-link-escape-chars
8742 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8743 "List of characters that should be escaped in link.
8744 This is the list that is used for internal purposes.")
8746 (defvar org-url-encoding-use-url-hexify nil)
8748 (defconst org-link-escape-chars-browser
8750 "List of escapes for characters that are problematic in links.
8751 This is the list that is used before handing over to the browser.")
8753 (defun org-link-escape (text &optional table merge)
8754 "Return percent escaped representation of TEXT.
8755 TEXT is a string with the text to escape.
8756 Optional argument TABLE is a list with characters that should be
8757 escaped. When nil, `org-link-escape-chars' is used.
8758 If optional argument MERGE is set, merge TABLE into
8759 `org-link-escape-chars'."
8760 (if (and org-url-encoding-use-url-hexify (not table))
8761 (url-hexify-string text)
8764 (mapc (lambda (defchr)
8765 (unless (member defchr table)
8766 (setq table (cons defchr table)))) org-link-escape-chars))
8768 (setq table org-link-escape-chars)))
8771 (if (or (member char table)
8772 (< char 32) (= char 37) (> char 126))
8773 (mapconcat (lambda (sequence-element)
8774 (format "%%%.2X" sequence-element))
8775 (or (encode-coding-char char 'utf-8)
8776 (error "Unable to percent escape character: %s"
8777 (char-to-string char))) "")
8778 (char-to-string char))) text "")))
8780 (defun org-link-unescape (str)
8781 "Unhex hexified unicode strings as returned from the JavaScript function
8782 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8783 (unless (and (null str) (string= "" str))
8784 (let ((pos 0) (case-fold-search t) unhexed)
8785 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
8786 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8787 (setq str (replace-match unhexed t t str))
8788 (setq pos (+ pos (length unhexed))))))
8791 (defun org-link-unescape-compound (hex)
8792 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8793 Note: this function also decodes single byte encodings like
8794 `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
8796 (let* ((bytes (cdr (split-string hex "%")))
8801 (let* ((val (string-to-number (pop bytes) 16))
8805 ((>= val 252) (cons 6 252))
8806 ((>= val 248) (cons 5 248))
8807 ((>= val 240) (cons 4 240))
8808 ((>= val 224) (cons 3 224))
8809 ((>= val 192) (cons 2 192))
8812 (if (>= val 192) (setq eat (car shift-xor)))
8813 (setq val (logxor val (cdr shift-xor)))
8814 (setq sum (+ (lsh sum (car shift-xor)) val))
8815 (if (> eat 0) (setq eat (- eat 1)))
8817 ((= 0 eat) ;multi byte
8818 (setq ret (concat ret (org-char-to-string sum)))
8820 ((not bytes) ; single byte(s)
8821 (setq ret (org-link-unescape-single-byte-sequence hex))))
8822 )) ;; end (while bytes
8825 (defun org-link-unescape-single-byte-sequence (hex)
8826 "Unhexify hex-encoded single byte character sequences."
8827 (mapconcat (lambda (byte)
8828 (char-to-string (string-to-number byte 16)))
8829 (cdr (split-string hex "%")) ""))
8831 (defun org-xor (a b)
8835 (defun org-fixup-message-id-for-http (s)
8836 "Replace special characters in a message id, so it can be used in an http query."
8837 (when (string-match "%" s)
8838 (setq s (mapconcat (lambda (c)
8841 (char-to-string c)))
8843 (while (string-match "<" s)
8844 (setq s (replace-match "%3C" t t s)))
8845 (while (string-match ">" s)
8846 (setq s (replace-match "%3E" t t s)))
8847 (while (string-match "@" s)
8848 (setq s (replace-match "%40" t t s)))
8852 (defun org-insert-link-global ()
8853 "Insert a link like Org-mode does.
8854 This command can be called in any mode to insert a link in Org-mode syntax."
8856 (org-load-modules-maybe)
8857 (org-run-like-in-org-mode 'org-insert-link))
8859 (defun org-insert-link (&optional complete-file link-location)
8860 "Insert a link. At the prompt, enter the link.
8862 Completion can be used to insert any of the link protocol prefixes like
8865 The history can be used to select a link previously stored with
8866 `org-store-link'. When the empty string is entered (i.e. if you just
8867 press RET at the prompt), the link defaults to the most recently
8868 stored link. As SPC triggers completion in the minibuffer, you need to
8869 use M-SPC or C-q SPC to force the insertion of a space character.
8871 You will also be prompted for a description, and if one is given, it will
8872 be displayed in the buffer instead of the link.
8874 If there is already a link at point, this command will allow you to edit link
8875 and description parts.
8877 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
8878 be selected using completion. The path to the file will be relative to the
8879 current directory if the file is in the current directory or a subdirectory.
8880 Otherwise, the link will be the absolute path as completed in the minibuffer
8881 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8882 option `org-link-file-path-type'.
8884 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
8885 the current directory or below.
8887 With three \\[universal-argument] prefixes, negate the meaning of
8888 `org-keep-stored-link-after-insertion'.
8890 If `org-make-link-description-function' is non-nil, this function will be
8891 called with the link target, and the result will be the default
8894 If the LINK-LOCATION parameter is non-nil, this value will be
8895 used as the link location instead of reading one interactively."
8897 (let* ((wcf (current-window-configuration))
8898 (region (if (org-region-active-p)
8899 (buffer-substring (region-beginning) (region-end))))
8900 (remove (and region (list (region-beginning) (region-end))))
8902 tmphist ; byte-compile incorrectly complains about this
8903 (link link-location)
8904 entry file all-prefixes)
8906 (link-location) ; specified by arg, just use it.
8907 ((org-in-regexp org-bracket-link-regexp 1)
8908 ;; We do have a link at point, and we are going to edit it.
8909 (setq remove (list (match-beginning 0) (match-end 0)))
8910 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8911 (setq link (read-string "Link: "
8913 (org-match-string-no-properties 1)))))
8914 ((or (org-in-regexp org-angle-link-re)
8915 (org-in-regexp org-plain-link-re))
8916 ;; Convert to bracket link
8917 (setq remove (list (match-beginning 0) (match-end 0))
8918 link (read-string "Link: "
8919 (org-remove-angle-brackets (match-string 0)))))
8920 ((member complete-file '((4) (16)))
8921 ;; Completing read for file names.
8922 (setq link (org-file-complete-link complete-file)))
8924 ;; Read link, with completion for stored links.
8925 (with-output-to-temp-buffer "*Org Links*"
8926 (princ "Insert a link.
8927 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
8928 (when org-stored-links
8929 (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
8932 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8933 (reverse org-stored-links) "\n"))))
8934 (let ((cw (selected-window)))
8935 (select-window (get-buffer-window "*Org Links*" 'visible))
8936 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8937 (unless (pos-visible-in-window-p (point-max))
8938 (org-fit-window-to-buffer))
8939 (and (window-live-p cw) (select-window cw)))
8940 ;; Fake a link history, containing the stored links.
8941 (setq tmphist (append (mapcar 'car org-stored-links)
8942 org-insert-link-history))
8943 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8944 (mapcar 'car org-link-abbrev-alist)
8949 (let ((org-completion-use-ido nil)
8950 (org-completion-use-iswitchb nil))
8951 (org-completing-read
8954 (mapcar (lambda (x) (list (concat x ":")))
8956 (mapcar 'car org-stored-links))
8959 (car (car org-stored-links)))))
8960 (if (not (string-match "\\S-" link))
8961 (error "No link selected"))
8962 (if (or (member link all-prefixes)
8963 (and (equal ":" (substring link -1))
8964 (member (substring link 0 -1) all-prefixes)
8965 (setq link (substring link 0 -1))))
8966 (setq link (org-link-try-special-completion link))))
8967 (set-window-configuration wcf)
8968 (kill-buffer "*Org Links*"))
8969 (setq entry (assoc link org-stored-links))
8970 (or entry (push link org-insert-link-history))
8971 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8972 (not org-keep-stored-link-after-insertion))
8973 (setq org-stored-links (delq (assoc link org-stored-links)
8975 (setq desc (or desc (nth 1 entry)))))
8977 (if (string-match org-plain-link-re link)
8978 ;; URL-like link, normalize the use of angular brackets.
8979 (setq link (org-make-link (org-remove-angle-brackets link))))
8981 ;; Check if we are linking to the current file with a search option
8982 ;; If yes, simplify the link by using only the search option.
8983 (when (and buffer-file-name
8984 (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
8985 (let* ((path (match-string 1 link))
8986 (case-fold-search nil)
8987 (search (match-string 2 link)))
8989 (if (equal (file-truename buffer-file-name) (file-truename path))
8990 ;; We are linking to this same file, with a search option
8991 (setq link search)))))
8993 ;; Check if we can/should use a relative path. If yes, simplify the link
8994 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
8995 (let* ((type (match-string 1 link))
8996 (path (match-string 2 link))
8998 (case-fold-search nil))
9000 ((or (eq org-link-file-path-type 'absolute)
9001 (equal complete-file '(16)))
9002 (setq path (abbreviate-file-name (expand-file-name path))))
9003 ((eq org-link-file-path-type 'noabbrev)
9004 (setq path (expand-file-name path)))
9005 ((eq org-link-file-path-type 'relative)
9006 (setq path (file-relative-name path)))
9009 (if (string-match (concat "^" (regexp-quote
9011 (file-name-as-directory
9012 default-directory))))
9013 (expand-file-name path))
9014 ;; We are linking a file with relative path name.
9015 (setq path (substring (expand-file-name path)
9017 (setq path (abbreviate-file-name (expand-file-name path)))))))
9018 (setq link (concat type path))
9019 (if (equal desc origpath)
9022 (if org-make-link-description-function
9023 (setq desc (funcall org-make-link-description-function link desc)))
9025 (setq desc (read-string "Description: " desc))
9026 (unless (string-match "\\S-" desc) (setq desc nil))
9027 (if remove (apply 'delete-region remove))
9028 (insert (org-make-link-string link desc))))
9030 (defun org-link-try-special-completion (type)
9031 "If there is completion support for link type TYPE, offer it."
9032 (let ((fun (intern (concat "org-" type "-complete-link"))))
9035 (read-string "Link (no completion support): " (concat type ":")))))
9037 (defun org-file-complete-link (&optional arg)
9038 "Create a file link using completion."
9040 (setq file (read-file-name "File: "))
9041 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9042 (pwd1 (file-name-as-directory (abbreviate-file-name
9043 (expand-file-name ".")))))
9046 (setq link (org-make-link
9048 (abbreviate-file-name (expand-file-name file)))))
9049 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
9050 (setq link (org-make-link "file:" (match-string 1 file))))
9051 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
9052 (expand-file-name file))
9053 (setq link (org-make-link
9054 "file:" (match-string 1 (expand-file-name file)))))
9055 (t (setq link (org-make-link "file:" file)))))
9058 (defun org-completing-read (&rest args)
9059 "Completing-read with SPACE being a normal character."
9060 (let ((minibuffer-local-completion-map
9061 (copy-keymap minibuffer-local-completion-map)))
9062 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9063 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9064 (apply 'org-icompleting-read args)))
9066 (defun org-completing-read-no-i (&rest args)
9067 (let (org-completion-use-ido org-completion-use-iswitchb)
9068 (apply 'org-completing-read args)))
9070 (defun org-iswitchb-completing-read (prompt choices &rest args)
9071 "Use iswitch as a completing-read replacement to choose from choices.
9072 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9074 (let* ((iswitchb-use-virtual-buffers nil)
9075 (iswitchb-make-buflist-hook
9077 (setq iswitchb-temp-buflist choices))))
9078 (iswitchb-read-buffer prompt)))
9080 (defun org-icompleting-read (&rest args)
9081 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9082 (org-without-partial-completion
9083 (if (and org-completion-use-ido
9084 (fboundp 'ido-completing-read)
9085 (boundp 'ido-mode) ido-mode
9086 (listp (second args)))
9087 (let ((ido-enter-matching-directory nil))
9088 (apply 'ido-completing-read (concat (car args))
9089 (if (consp (car (nth 1 args)))
9090 (mapcar 'car (nth 1 args))
9093 (if (and org-completion-use-iswitchb
9094 (boundp 'iswitchb-mode) iswitchb-mode
9095 (listp (second args)))
9096 (apply 'org-iswitchb-completing-read (concat (car args))
9097 (if (consp (car (nth 1 args)))
9098 (mapcar 'car (nth 1 args))
9101 (apply 'completing-read args)))))
9103 (defun org-extract-attributes (s)
9104 "Extract the attributes cookie from a string and set as text property."
9105 (let (a attr (start 0) key value)
9107 (when (string-match "{{\\([^}]+\\)}}$" s)
9108 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9109 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
9110 (setq key (match-string 1 a) value (match-string 2 a)
9112 attr (plist-put attr (intern key) value))))
9113 (org-add-props s nil 'org-attr attr))
9116 (defun org-extract-attributes-from-string (tag)
9117 (let (key value attr)
9118 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
9119 (setq key (match-string 1 tag) value (match-string 2 tag)
9120 tag (replace-match "" t t tag)
9121 attr (plist-put attr (intern key) value)))
9124 (defun org-attributes-to-string (plist)
9125 "Format a property list into an HTML attribute list."
9126 (let ((s "") key value)
9128 (setq key (pop plist) value (pop plist))
9130 (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
9133 ;;; Opening/following a link
9135 (defvar org-link-search-failed nil)
9137 (defvar org-open-link-functions nil
9138 "Hook for functions finding a plain text link.
9139 These functions must take a single argument, the link content.
9140 They will be called for links that look like [[link text][description]]
9141 when LINK TEXT does not have a protocol like \"http:\" and does not look
9142 like a filename (e.g. \"./blue.png\").
9144 These functions will be called *before* Org attempts to resolve the
9145 link by doing text searches in the current buffer - so if you want a
9146 link \"[[target]]\" to still find \"<<target>>\", your function should
9147 handle this as a special case.
9149 When the function does handle the link, it must return a non-nil value.
9150 If it decides that it is not responsible for this link, it must return
9151 nil to indicate that that Org-mode can continue with other options
9152 like exact and fuzzy text search.")
9154 (defun org-next-link ()
9155 "Move forward to the next link.
9156 If the link is in hidden text, expose it."
9158 (when (and org-link-search-failed (eq this-command last-command))
9159 (goto-char (point-min))
9160 (message "Link search wrapped back to beginning of buffer"))
9161 (setq org-link-search-failed nil)
9162 (let* ((pos (point))
9164 (a (assoc :link ct)))
9165 (if a (goto-char (nth 2 a)))
9166 (if (re-search-forward org-any-link-re nil t)
9168 (goto-char (match-beginning 0))
9169 (if (outline-invisible-p) (org-show-context)))
9171 (setq org-link-search-failed t)
9172 (error "No further link found"))))
9174 (defun org-previous-link ()
9175 "Move backward to the previous link.
9176 If the link is in hidden text, expose it."
9178 (when (and org-link-search-failed (eq this-command last-command))
9179 (goto-char (point-max))
9180 (message "Link search wrapped back to end of buffer"))
9181 (setq org-link-search-failed nil)
9182 (let* ((pos (point))
9184 (a (assoc :link ct)))
9185 (if a (goto-char (nth 1 a)))
9186 (if (re-search-backward org-any-link-re nil t)
9188 (goto-char (match-beginning 0))
9189 (if (outline-invisible-p) (org-show-context)))
9191 (setq org-link-search-failed t)
9192 (error "No further link found"))))
9194 (defun org-translate-link (s)
9195 "Translate a link string if a translation function has been defined."
9196 (if (and org-link-translation-function
9197 (fboundp org-link-translation-function)
9198 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
9200 (setq s (funcall org-link-translation-function
9201 (match-string 1) (match-string 2)))
9202 (concat (car s) ":" (cdr s)))
9205 (defun org-translate-link-from-planner (type path)
9206 "Translate a link from Emacs Planner syntax so that Org can follow it.
9207 This is still an experimental function, your mileage may vary."
9209 ((member type '("http" "https" "news" "ftp"))
9210 ;; standard Internet links are the same.
9212 ((and (equal type "irc") (string-match "^//" path))
9213 ;; Planner has two / at the beginning of an irc link, we have 1.
9214 ;; We should have zero, actually....
9215 (setq path (substring path 1)))
9216 ((and (equal type "lisp") (string-match "^/" path))
9217 ;; Planner has a slash, we do not.
9218 (setq type "elisp" path (substring path 1)))
9219 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
9220 ;; A typical message link. Planner has the id after the final slash,
9221 ;; we separate it with a hash mark
9222 (setq path (concat (match-string 1 path) "#"
9223 (org-remove-angle-brackets (match-string 2 path)))))
9227 (defun org-find-file-at-mouse (ev)
9228 "Open file link or URL at mouse."
9230 (mouse-set-point ev)
9231 (org-open-at-point 'in-emacs))
9233 (defun org-open-at-mouse (ev)
9234 "Open file link or URL at mouse."
9236 (mouse-set-point ev)
9237 (if (eq major-mode 'org-agenda-mode)
9238 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9239 (org-open-at-point))
9241 (defvar org-window-config-before-follow-link nil
9242 "The window configuration before following a link.
9243 This is saved in case the need arises to restore it.")
9245 (defvar org-open-link-marker (make-marker)
9246 "Marker pointing to the location where `org-open-at-point; was called.")
9249 (defun org-open-at-point-global ()
9250 "Follow a link like Org-mode does.
9251 This command can be called in any mode to follow a link that has
9254 (org-run-like-in-org-mode 'org-open-at-point))
9257 (defun org-open-link-from-string (s &optional arg reference-buffer)
9258 "Open a link in the string S, as if it was in Org-mode."
9259 (interactive "sLink: \nP")
9260 (let ((reference-buffer (or reference-buffer (current-buffer))))
9262 (let ((org-inhibit-startup t))
9265 (goto-char (point-min))
9266 (when reference-buffer
9267 (setq org-link-abbrev-alist-local
9268 (with-current-buffer reference-buffer
9269 org-link-abbrev-alist-local)))
9270 (org-open-at-point arg reference-buffer)))))
9272 (defvar org-open-at-point-functions nil
9273 "Hook that is run when following a link at point.
9275 Functions in this hook must return t if they identify and follow
9276 a link at point. If they don't find anything interesting at point,
9277 they must return nil.")
9279 (defun org-open-at-point (&optional arg reference-buffer)
9280 "Open link at or after point.
9281 If there is no link at point, this function will search forward up to
9282 the end of the current line.
9283 Normally, files will be opened by an appropriate application. If the
9284 optional prefix argument ARG is non-nil, Emacs will visit the file.
9285 With a double prefix argument, try to open outside of Emacs, in the
9286 application the system uses for this file type."
9288 ;; if in a code block, then open the block's results
9289 (unless (call-interactively #'org-babel-open-src-block-result)
9290 (org-load-modules-maybe)
9291 (move-marker org-open-link-marker (point))
9292 (setq org-window-config-before-follow-link (current-window-configuration))
9293 (org-remove-occur-highlights nil nil t)
9295 ((and (org-on-heading-p)
9297 (concat org-plain-link-re "\\|"
9298 org-bracket-link-regexp "\\|"
9299 org-angle-link-re "\\|"
9300 "[ \t]:[^ \t\n]+:[ \t]*$")))
9301 (not (get-text-property (point) 'org-linked-text)))
9302 (or (org-offer-links-in-entry arg)
9303 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9304 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9305 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9306 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9307 (not (org-in-regexp org-bracket-link-regexp)))
9308 (org-footnote-action))
9310 (let (type path link line search (pos (point)))
9313 (skip-chars-forward "^]\n\r")
9314 (when (org-in-regexp org-bracket-link-regexp 1)
9315 (setq link (org-extract-attributes
9316 (org-link-unescape (org-match-string-no-properties 1))))
9317 (while (string-match " *\n *" link)
9318 (setq link (replace-match " " t t link)))
9319 (setq link (org-link-expand-abbrev link))
9321 ((or (file-name-absolute-p link)
9322 (string-match "^\\.\\.?/" link))
9323 (setq type "file" path link))
9324 ((string-match org-link-re-with-space3 link)
9325 (setq type (match-string 1 link) path (match-string 2 link)))
9326 (t (setq type "thisfile" path link)))
9329 (when (get-text-property (point) 'org-linked-text)
9330 (setq type "thisfile"
9331 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9332 (1+ (point)) (point))
9333 path (buffer-substring
9334 (or (previous-single-property-change pos 'org-linked-text)
9336 (or (next-single-property-change pos 'org-linked-text)
9341 (when (or (org-in-regexp org-angle-link-re)
9342 (org-in-regexp org-plain-link-re))
9343 (setq type (match-string 1) path (match-string 2))
9346 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
9348 path (match-string 1))
9349 (while (string-match ":" path)
9350 (setq path (replace-match "+" t t path)))
9352 (when (org-in-regexp "<\\([^><\n]+\\)>")
9353 (setq type "tree-match"
9354 path (match-string 1))
9357 (error "No link found"))
9359 ;; switch back to reference buffer
9360 ;; needed when if called in a temporary buffer through
9361 ;; org-open-link-from-string
9362 (with-current-buffer (or reference-buffer (current-buffer))
9364 ;; Remove any trailing spaces in path
9365 (if (string-match " +\\'" path)
9366 (setq path (replace-match "" t t path)))
9367 (if (and org-link-translation-function
9368 (fboundp org-link-translation-function))
9369 ;; Check if we need to translate the link
9370 (let ((tmp (funcall org-link-translation-function type path)))
9371 (setq type (car tmp) path (cdr tmp))))
9375 ((assoc type org-link-protocols)
9376 (funcall (nth 1 (assoc type org-link-protocols)) path))
9378 ((equal type "mailto")
9379 (let ((cmd (car org-link-mailto-program))
9380 (args (cdr org-link-mailto-program)) args1
9381 (address path) (subject "") a)
9382 (if (string-match "\\(.*\\)::\\(.*\\)" path)
9383 (setq address (match-string 1 path)
9384 subject (org-link-escape (match-string 2 path))))
9387 ((not (stringp (car args))) (push (pop args) args1))
9388 (t (setq a (pop args))
9389 (if (string-match "%a" a)
9390 (setq a (replace-match address t t a)))
9391 (if (string-match "%s" a)
9392 (setq a (replace-match subject t t a)))
9394 (apply cmd (nreverse args1))))
9396 ((member type '("http" "https" "ftp" "news"))
9397 (browse-url (concat type ":" (org-link-escape
9398 path org-link-escape-chars-browser))))
9400 ((string= type "doi")
9401 (browse-url (concat "http://dx.doi.org/"
9403 path org-link-escape-chars-browser))))
9405 ((member type '("message"))
9406 (browse-url (concat type ":" path)))
9408 ((string= type "tags")
9409 (org-tags-view arg path))
9411 ((string= type "tree-match")
9412 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
9414 ((string= type "file")
9415 (if (string-match "::\\([0-9]+\\)\\'" path)
9416 (setq line (string-to-number (match-string 1 path))
9417 path (substring path 0 (match-beginning 0)))
9418 (if (string-match "::\\(.+\\)\\'" path)
9419 (setq search (match-string 1 path)
9420 path (substring path 0 (match-beginning 0)))))
9421 (if (string-match "[*?{]" (file-name-nondirectory path))
9423 (org-open-file path arg line search)))
9425 ((string= type "shell")
9427 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9428 (string-match org-confirm-shell-link-not-regexp cmd))
9429 (not org-confirm-shell-link-function)
9430 (funcall org-confirm-shell-link-function
9431 (format "Execute \"%s\" in shell? "
9432 (org-add-props cmd nil
9433 'face 'org-warning))))
9435 (message "Executing %s" cmd)
9436 (shell-command cmd))
9439 ((string= type "elisp")
9441 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9442 (string-match org-confirm-elisp-link-not-regexp cmd))
9443 (not org-confirm-elisp-link-function)
9444 (funcall org-confirm-elisp-link-function
9445 (format "Execute \"%s\" as elisp? "
9446 (org-add-props cmd nil
9447 'face 'org-warning))))
9448 (message "%s => %s" cmd
9449 (if (equal (string-to-char cmd) ?\()
9451 (call-interactively (read cmd))))
9454 ((and (string= type "thisfile")
9455 (run-hook-with-args-until-success
9456 'org-open-link-functions path)))
9458 ((string= type "thisfile")
9460 (switch-to-buffer-other-window
9461 (org-get-buffer-for-internal-link (current-buffer)))
9462 (org-mark-ring-push))
9463 (let ((cmd `(org-link-search
9465 ,(cond ((equal arg '(4)) ''occur)
9466 ((equal arg '(16)) ''org-occur)
9469 (condition-case nil (eval cmd)
9470 (error (progn (widen) (eval cmd))))))
9473 (browse-url-at-point)))))))
9474 (move-marker org-open-link-marker nil)
9475 (run-hook-with-args 'org-follow-link-hook)))
9477 (defun org-offer-links-in-entry (&optional nth zero)
9478 "Offer links in the current entry and follow the selected link.
9479 If there is only one link, follow it immediately as well.
9480 If NTH is an integer, immediately pick the NTH link found.
9481 If ZERO is a string, check also this string for a link, and if
9482 there is one, offer it as link number zero."
9483 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
9484 "\\(" org-angle-link-re "\\)\\|"
9485 "\\(" org-plain-link-re "\\)"))
9487 (in-emacs (if (integerp nth) nil nth))
9488 have-zero end links link c)
9489 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9490 (push (match-string 0 zero) links)
9491 (setq cnt (1- cnt) have-zero t))
9493 (org-back-to-heading t)
9494 (setq end (save-excursion (outline-next-heading) (point)))
9495 (while (re-search-forward re end t)
9496 (push (match-string 0) links))
9497 (setq links (org-uniquify (reverse links))))
9501 (message "No links"))
9502 ((equal (length links) 1)
9503 (setq link (list (car links))))
9504 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9505 (setq link (nth (if have-zero nth (1- nth)) links)))
9506 (t ; we have to select a link
9508 (save-window-excursion
9509 (delete-other-windows)
9510 (with-output-to-temp-buffer "*Select Link*"
9512 (if (not (string-match org-bracket-link-regexp l))
9513 (princ (format "[%c] %s\n" (incf cnt)
9514 (org-remove-angle-brackets l)))
9516 (princ (format "[%c] %s (%s)\n" (incf cnt)
9517 (match-string 3 l) (match-string 1 l)))
9518 (princ (format "[%c] %s\n" (incf cnt)
9519 (match-string 1 l))))))
9521 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9522 (message "Select link to open, RET to open all:")
9523 (setq c (read-char-exclusive))
9524 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9525 (when (equal c ?q) (error "Abort"))
9529 (if have-zero (setq nth (1+ nth)))
9530 (unless (and (integerp nth) (>= (length links) nth))
9531 (error "Invalid link selection"))
9532 (setq link (list (nth (1- nth) links))))))
9534 (let ((buf (current-buffer)))
9536 (org-open-link-from-string l in-emacs buf))
9540 ;; Add special file links that specify the way of opening
9542 (org-add-link-type "file+sys" 'org-open-file-with-system)
9543 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9544 (defun org-open-file-with-system (path)
9545 "Open file at PATH using the system way of opening it."
9546 (org-open-file path 'system))
9547 (defun org-open-file-with-emacs (path)
9548 "Open file at PATH in Emacs."
9549 (org-open-file path 'emacs))
9550 (defun org-remove-file-link-modifiers ()
9551 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9552 (goto-char (point-min))
9553 (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
9555 (replace-match "file:" t t))))
9556 (eval-after-load "org-exp"
9557 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9558 'org-remove-file-link-modifiers))
9562 (defun org-get-effort (&optional pom)
9563 "Get the effort estimate for the current entry."
9564 (org-entry-get pom org-effort-property))
9568 (defvar org-create-file-search-functions nil
9569 "List of functions to construct the right search string for a file link.
9570 These functions are called in turn with point at the location to
9571 which the link should point.
9573 A function in the hook should first test if it would like to
9574 handle this file type, for example by checking the `major-mode'
9575 or the file extension. If it decides not to handle this file, it
9576 should just return nil to give other functions a chance. If it
9577 does handle the file, it must return the search string to be used
9578 when following the link. The search string will be part of the
9579 file link, given after a double colon, and `org-open-at-point'
9580 will automatically search for it. If special measures must be
9581 taken to make the search successful, another function should be
9582 added to the companion hook `org-execute-file-search-functions',
9585 A function in this hook may also use `setq' to set the variable
9586 `description' to provide a suggestion for the descriptive text to
9587 be used for this link when it gets inserted into an Org-mode
9588 buffer with \\[org-insert-link].")
9590 (defvar org-execute-file-search-functions nil
9591 "List of functions to execute a file search triggered by a link.
9593 Functions added to this hook must accept a single argument, the
9594 search string that was part of the file link, the part after the
9595 double colon. The function must first check if it would like to
9596 handle this search, for example by checking the `major-mode' or
9597 the file extension. If it decides not to handle this search, it
9598 should just return nil to give other functions a chance. If it
9599 does handle the search, it must return a non-nil value to keep
9600 other functions from trying.
9602 Each function can access the current prefix argument through the
9603 variable `current-prefix-argument'. Note that a single prefix is
9604 used to force opening a link in Emacs, so it may be good to only
9605 use a numeric or double prefix to guide the search function.
9607 In case this is needed, a function in this hook can also restore
9608 the window configuration before `org-open-at-point' was called using:
9610 (set-window-configuration org-window-config-before-follow-link)")
9612 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9613 (defun org-link-search (s &optional type avoid-pos)
9614 "Search for a link search option.
9615 If S is surrounded by forward slashes, it is interpreted as a
9616 regular expression. In org-mode files, this will create an `org-occur'
9617 sparse tree. In ordinary files, `occur' will be used to list matches.
9618 If the current buffer is in `dired-mode', grep will be used to search
9619 in all files. If AVOID-POS is given, ignore matches near that position."
9620 (let ((case-fold-search t)
9621 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
9622 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
9623 (append '(("") (" ") ("\t") ("\n"))
9627 (pre nil) (post nil)
9628 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9630 ;; First check if there are any special search functions
9631 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9632 ;; Now try the builtin stuff
9633 ((and (equal (string-to-char s0) ?#)
9636 (goto-char (point-min))
9639 (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
9640 (setq type 'dedicated
9641 pos (match-beginning 0))))
9642 ;; There is an exact target for this
9644 (org-back-to-heading t)))
9646 (goto-char (point-min))
9649 (concat "<<" (regexp-quote s0) ">>") nil t)
9650 (setq type 'dedicated
9651 pos (match-beginning 0))))
9652 ;; There is an exact target for this
9654 ((and (string-match "^(\\(.*\\))$" s0)
9656 (goto-char (point-min))
9659 (concat "[^[]" (regexp-quote
9660 (format org-coderef-label-format
9661 (match-string 1 s0))))
9663 (setq type 'dedicated
9664 pos (1+ (match-beginning 0))))))
9665 ;; There is a coderef target for this
9667 ((string-match "^/\\(.*\\)/$" s)
9668 ;; A regular expression
9671 (org-occur (match-string 1 s)))
9672 ;;((eq major-mode 'dired-mode)
9673 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9674 (t (org-do-occur (match-string 1 s)))))
9675 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9676 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9677 (goto-char (point-min))
9679 ((let (case-fold-search)
9680 (re-search-forward (format org-complex-heading-regexp-format
9683 ;; OK, found a match
9684 (setq type 'dedicated)
9685 (goto-char (match-beginning 0)))
9686 ((and (not org-link-search-inhibit-query)
9687 (eq org-link-search-must-match-exact-headline 'query-to-create)
9688 (y-or-n-p "No match - create this as a new heading? "))
9689 (goto-char (point-max))
9690 (or (bolp) (newline))
9691 (insert "* " s "\n")
9692 (beginning-of-line 0))
9695 (error "No match"))))
9697 ;; A normal search string
9698 (when (equal (string-to-char s) ?*)
9699 ;; Anchor on headlines, post may include tags.
9700 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
9701 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
9703 (remove-text-properties
9705 '(face nil mouse-face nil keymap nil fontified nil) s)
9706 ;; Make a series of regular expressions to find a match
9707 (setq words (org-split-string s "[ \n\r\t]+")
9709 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
9710 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
9712 re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
9713 re2a (concat "[ \t\r\n]" re2a_)
9714 re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
9715 re4 (concat "[^a-zA-Z_]" re4_)
9717 re1 (concat pre re2 post)
9718 re3 (concat pre (if pre re4_ re4) post)
9719 re5 (concat pre ".*" re4)
9720 re2 (concat pre re2)
9721 re2a (concat pre (if pre re2a_ re2a))
9722 re4 (concat pre (if pre re4_ re4))
9723 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
9724 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
9728 ((eq type 'org-occur) (org-occur reall))
9729 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9730 (t (goto-char (point-min))
9732 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9733 (org-search-not-self 1 re1 nil t)
9734 (org-search-not-self 1 re2 nil t)
9735 (org-search-not-self 1 re2a nil t)
9736 (org-search-not-self 1 re3 nil t)
9737 (org-search-not-self 1 re4 nil t)
9738 (org-search-not-self 1 re5 nil t)
9740 (goto-char (match-beginning 1))
9742 (error "No match"))))))
9743 (and (org-mode-p) (org-show-context 'link-search))
9746 (defun org-search-not-self (group &rest args)
9747 "Execute `re-search-forward', but only accept matches that do not
9748 enclose the position of `org-open-link-marker'."
9749 (let ((m org-open-link-marker))
9751 (while (apply 're-search-forward args)
9752 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9753 (goto-char (match-end group))
9754 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9755 (> (match-beginning 0) (marker-position m))
9756 (< (match-end 0) (marker-position m)))
9758 (or (not (org-in-regexp
9759 org-bracket-link-analytic-regexp 1))
9760 (not (match-end 4)) ; no description
9761 (and (<= (match-beginning 4) (point))
9762 (>= (match-end 4) (point))))))
9763 (throw 'exit (point))))))))
9765 (defun org-get-buffer-for-internal-link (buffer)
9766 "Return a buffer to be used for displaying the link target of internal links."
9768 ((not org-display-internal-link-with-indirect-buffer)
9770 ((string-match "(Clone)$" (buffer-name buffer))
9771 (message "Buffer is already a clone, not making another one")
9772 ;; we also do not modify visibility in this case
9774 (t ; make a new indirect buffer for displaying the link
9775 (let* ((bn (buffer-name buffer))
9776 (ibn (concat bn "(Clone)"))
9777 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9778 (with-current-buffer ib (org-overview))
9781 (defun org-do-occur (regexp &optional cleanup)
9782 "Call the Emacs command `occur'.
9783 If CLEANUP is non-nil, remove the printout of the regular expression
9784 in the *Occur* buffer. This is useful if the regex is long and not useful
9788 (let ((cwin (selected-window)) win beg end)
9789 (when (setq win (get-buffer-window "*Occur*"))
9790 (select-window win))
9791 (goto-char (point-min))
9792 (when (re-search-forward "match[a-z]+" nil t)
9793 (setq beg (match-end 0))
9794 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
9795 (setq end (1- (match-beginning 0)))))
9796 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9797 (goto-char (point-min))
9798 (select-window cwin))))
9800 ;;; The mark ring for links jumps
9802 (defvar org-mark-ring nil
9803 "Mark ring for positions before jumps in Org-mode.")
9804 (defvar org-mark-ring-last-goto nil
9805 "Last position in the mark ring used to go back.")
9806 ;; Fill and close the ring
9807 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9808 (loop for i from 1 to org-mark-ring-length do
9809 (push (make-marker) org-mark-ring))
9810 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9813 (defun org-mark-ring-push (&optional pos buffer)
9814 "Put the current position or POS into the mark ring and rotate it."
9816 (setq pos (or pos (point)))
9817 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9818 (move-marker (car org-mark-ring)
9820 (or buffer (current-buffer)))
9822 (substitute-command-keys
9823 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
9825 (defun org-mark-ring-goto (&optional n)
9826 "Jump to the previous position in the mark ring.
9827 With prefix arg N, jump back that many stored positions. When
9828 called several times in succession, walk through the entire ring.
9829 Org-mode commands jumping to a different position in the current file,
9830 or to another Org-mode file, automatically push the old position
9834 (if (eq last-command this-command)
9835 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9836 (setq p org-mark-ring))
9837 (setq org-mark-ring-last-goto p)
9839 (org-pop-to-buffer-same-window (marker-buffer m))
9841 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9843 (defun org-remove-angle-brackets (s)
9844 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9845 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9847 (defun org-add-angle-brackets (s)
9848 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9849 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9851 (defun org-remove-double-quotes (s)
9852 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
9853 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
9856 ;;; Following specific links
9858 (defun org-follow-timestamp-link ()
9860 ((org-at-date-range-p t)
9861 (let ((org-agenda-start-on-weekday)
9862 (t1 (match-string 1))
9863 (t2 (match-string 2)))
9864 (setq t1 (time-to-days (org-time-string-to-time t1))
9865 t2 (time-to-days (org-time-string-to-time t2)))
9866 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9867 ((org-at-timestamp-p t)
9868 (org-agenda-list nil (time-to-days (org-time-string-to-time
9869 (substring (match-string 1) 0 10)))
9871 (t (error "This should not happen"))))
9874 ;;; Following file links
9875 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9876 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9877 (declare-function mailcap-mime-info
9878 "mailcap" (string &optional request no-decode))
9879 (defvar org-wait nil)
9880 (defun org-open-file (path &optional in-emacs line search)
9881 "Open the file at PATH.
9882 First, this expands any special file name abbreviations. Then the
9883 configuration variable `org-file-apps' is checked if it contains an
9884 entry for this file type, and if yes, the corresponding command is launched.
9886 If no application is found, Emacs simply visits the file.
9888 With optional prefix argument IN-EMACS, Emacs will visit the file.
9889 With a double \\[universal-argument] \\[universal-argument] \
9890 prefix arg, Org tries to avoid opening in Emacs
9891 and to use an external application to visit the file.
9893 Optional LINE specifies a line to go to, optional SEARCH a string
9894 to search for. If LINE or SEARCH is given, the file will be
9895 opened in Emacs, unless an entry from org-file-apps that makes
9896 use of groups in a regexp matches.
9897 If the file does not exist, an error is thrown."
9898 (let* ((file (if (equal path "")
9900 (substitute-in-file-name (expand-file-name path))))
9901 (file-apps (append org-file-apps (org-default-apps)))
9902 (apps (org-remove-if
9903 'org-file-apps-entry-match-against-dlink-p file-apps))
9904 (apps-dlink (org-remove-if-not
9905 'org-file-apps-entry-match-against-dlink-p file-apps))
9906 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9907 (dirp (if remp nil (file-directory-p file)))
9908 (file (if (and dirp org-open-directory-means-index-dot-org)
9909 (concat (file-name-as-directory file) "index.org")
9911 (a-m-a-p (assq 'auto-mode apps))
9912 (dfile (downcase file))
9913 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9914 (link (cond ((and (eq line nil)
9918 (concat file "::" (number-to-string line)))
9920 (concat file "::" search))))
9921 (dlink (downcase link))
9922 (old-buffer (current-buffer))
9924 (old-mode major-mode)
9925 ext cmd link-match-data)
9926 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
9927 (setq ext (match-string 1 dfile))
9928 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
9929 (setq ext (match-string 1 dfile))))
9931 ((member in-emacs '((16) system))
9932 (setq cmd (cdr (assoc 'system apps))))
9933 (in-emacs (setq cmd 'emacs))
9935 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9936 (and dirp (cdr (assoc 'directory apps)))
9937 ; first, try matching against apps-dlink
9938 ; if we get a match here, store the match data for later
9939 (let ((match (assoc-default dlink apps-dlink
9942 (progn (setq link-match-data (match-data))
9944 (progn (setq in-emacs (or in-emacs line search))
9945 nil))) ; if we have no match in apps-dlink,
9946 ; always open the file in emacs if line or search
9947 ; is given (for backwards compatibility)
9948 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9950 (cdr (assoc ext apps))
9951 (cdr (assoc t apps))))))
9952 (when (eq cmd 'system)
9953 (setq cmd (cdr (assoc 'system apps))))
9954 (when (eq cmd 'default)
9955 (setq cmd (cdr (assoc t apps))))
9956 (when (eq cmd 'mailcap)
9958 (mailcap-parse-mailcaps)
9959 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9960 (command (mailcap-mime-info mime-type)))
9961 (if (stringp command)
9963 (setq cmd 'emacs))))
9964 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9965 (not (file-exists-p file))
9966 (not org-open-non-existing-files))
9967 (error "No such file: %s" file))
9969 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
9970 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9971 (while (string-match "['\"]%s['\"]" cmd)
9972 (setq cmd (replace-match "%s" t t cmd)))
9973 (while (string-match "%s" cmd)
9974 (setq cmd (replace-match
9976 (shell-quote-argument
9977 (convert-standard-filename file)))
9980 ;; Replace "%1", "%2" etc. in command with group matches from regex
9982 (let ((match-index 1)
9983 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9984 (set-match-data link-match-data)
9985 (while (<= match-index number-of-groups)
9986 (let ((regex (concat "%" (number-to-string match-index)))
9987 (replace-with (match-string match-index dlink)))
9988 (while (string-match regex cmd)
9989 (setq cmd (replace-match replace-with t t cmd))))
9990 (setq match-index (+ match-index 1)))))
9992 (save-window-excursion
9993 (start-process-shell-command cmd nil cmd)
9994 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9998 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10000 (if line (org-goto-line line)
10001 (if search (org-link-search search))))
10003 (let ((file (convert-standard-filename file)))
10005 (set-match-data link-match-data)
10007 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10008 (and (org-mode-p) (eq old-mode 'org-mode)
10009 (or (not (equal old-buffer (current-buffer)))
10010 (not (equal old-pos (point))))
10011 (org-mark-ring-push old-pos old-buffer))))
10013 (defun org-file-apps-entry-match-against-dlink-p (entry)
10014 "This function returns non-nil if `entry' uses a regular
10015 expression which should be matched against the whole link by
10018 It assumes that is the case when the entry uses a regular
10019 expression which has at least one grouping construct and the
10020 action is either a lisp form or a command string containing
10021 '%1', i.e. using at least one subexpression match as a
10023 (let ((selector (car entry))
10024 (action (cdr entry)))
10025 (if (stringp selector)
10026 (and (> (regexp-opt-depth selector) 0)
10027 (or (and (stringp action)
10028 (string-match "%[0-9]" action))
10032 (defun org-default-apps ()
10033 "Return the default applications for this operating system."
10035 ((eq system-type 'darwin)
10036 org-file-apps-defaults-macosx)
10037 ((eq system-type 'windows-nt)
10038 org-file-apps-defaults-windowsnt)
10039 (t org-file-apps-defaults-gnu)))
10041 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10042 "Convert extensions to regular expressions in the cars of LIST.
10043 Also, weed out any non-string entries, because the return value is used
10044 only for regexp matching.
10045 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10046 point to the symbol `emacs', indicating that the file should
10047 be opened in Emacs."
10050 (mapcar (lambda (x)
10051 (if (not (stringp (car x)))
10053 (if (string-match "\\W" (car x))
10055 (cons (concat "\\." (car x) "\\'") (cdr x)))))
10058 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10060 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10061 (defun org-file-remote-p (file)
10062 "Test whether FILE specifies a location on a remote system.
10063 Return non-nil if the location is indeed remote.
10065 For example, the filename \"/user@host:/foo\" specifies a location
10066 on the system \"/user@host:\"."
10067 (cond ((fboundp 'file-remote-p)
10068 (file-remote-p file))
10069 ((fboundp 'tramp-handle-file-remote-p)
10070 (tramp-handle-file-remote-p file))
10071 ((and (boundp 'ange-ftp-name-format)
10072 (string-match (car ange-ftp-name-format) file))
10079 (defun org-get-org-file ()
10080 "Read a filename, with default directory `org-directory'."
10081 (let ((default (or org-default-notes-file remember-data-file)))
10082 (read-file-name (format "File name [%s]: " default)
10083 (file-name-as-directory org-directory)
10086 (defun org-notes-order-reversed-p ()
10087 "Check if the current file should receive notes in reversed order."
10089 ((not org-reverse-note-order) nil)
10090 ((eq t org-reverse-note-order) t)
10091 ((not (listp org-reverse-note-order)) nil)
10093 (let ((all org-reverse-note-order)
10095 (while (setq entry (pop all))
10096 (if (string-match (car entry) buffer-file-name)
10097 (throw 'exit (cdr entry))))
10100 (defvar org-refile-target-table nil
10101 "The list of refile targets, created by `org-refile'.")
10103 (defvar org-agenda-new-buffers nil
10104 "Buffers created to visit agenda files.")
10106 (defvar org-refile-cache nil
10107 "Cache for refile targets.")
10109 (defvar org-refile-markers nil
10110 "All the markers used for caching refile locations.")
10112 (defun org-refile-marker (pos)
10113 "Get a new refile marker, but only if caching is in use."
10114 (if (not org-refile-use-cache)
10116 (let ((m (make-marker)))
10117 (move-marker m pos)
10118 (push m org-refile-markers)
10121 (defun org-refile-cache-clear ()
10122 "Clear the refile cache and disable all the markers."
10123 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10124 (setq org-refile-markers nil)
10125 (setq org-refile-cache nil)
10126 (message "Refile cache has been cleared"))
10128 (defun org-refile-cache-check-set (set)
10129 "Check if all the markers in the cache still have live buffers."
10132 (while (and set (setq marker (nth 3 (pop set))))
10133 ;; if org-refile-use-outline-path is 'file, marker may be nil
10134 (when (and marker (null (marker-buffer marker)))
10135 (message "not found") (sit-for 3)
10136 (throw 'exit nil)))
10139 (defun org-refile-cache-put (set &rest identifiers)
10140 "Push the refile targets SET into the cache, under IDENTIFIERS."
10141 (let* ((key (sha1 (prin1-to-string identifiers)))
10142 (entry (assoc key org-refile-cache)))
10145 (push (cons key set) org-refile-cache))))
10147 (defun org-refile-cache-get (&rest identifiers)
10148 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10150 ((not org-refile-cache) nil)
10151 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10153 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10154 org-refile-cache))))
10155 (and set (org-refile-cache-check-set set) set)))))
10157 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10158 "Produce a table with refile targets."
10159 (let ((case-fold-search nil)
10160 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10161 (entries (or org-refile-targets '((nil . (:level . 1)))))
10162 targets tgs txt re files f desc descre fast-path-p level pos0)
10163 (message "Getting targets...")
10164 (with-current-buffer (or default-buffer (current-buffer))
10165 (while (setq entry (pop entries))
10166 (setq files (car entry) desc (cdr entry))
10167 (setq fast-path-p nil)
10169 ((null files) (setq files (list (current-buffer))))
10170 ((eq files 'org-agenda-files)
10171 (setq files (org-agenda-files 'unrestricted)))
10172 ((and (symbolp files) (fboundp files))
10173 (setq files (funcall files)))
10174 ((and (symbolp files) (boundp files))
10175 (setq files (symbol-value files))))
10176 (if (stringp files) (setq files (list files)))
10178 ((eq (car desc) :tag)
10179 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
10180 ((eq (car desc) :todo)
10181 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
10182 ((eq (car desc) :regexp)
10183 (setq descre (cdr desc)))
10184 ((eq (car desc) :level)
10185 (setq descre (concat "^\\*\\{" (number-to-string
10186 (if org-odd-levels-only
10187 (1- (* 2 (cdr desc)))
10190 ((eq (car desc) :maxlevel)
10191 (setq fast-path-p t)
10192 (setq descre (concat "^\\*\\{1," (number-to-string
10193 (if org-odd-levels-only
10194 (1- (* 2 (cdr desc)))
10197 (t (error "Bad refiling target description %s" desc)))
10198 (while (setq f (pop files))
10199 (with-current-buffer
10200 (if (bufferp f) f (org-get-agenda-file-buffer f))
10202 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10204 (if (bufferp f) (setq f (buffer-file-name
10205 (buffer-base-buffer f))))
10206 (setq f (and f (expand-file-name f)))
10207 (if (eq org-refile-use-outline-path 'file)
10208 (push (list (file-name-nondirectory f) f nil nil) tgs))
10212 (goto-char (point-min))
10213 (while (re-search-forward descre nil t)
10214 (goto-char (setq pos0 (point-at-bol)))
10216 (when org-refile-target-verify-function
10218 (or (funcall org-refile-target-verify-function)
10220 (when (and (looking-at org-complex-heading-regexp)
10221 (not (member (match-string 4) excluded-entries)))
10222 (setq level (org-reduced-level
10223 (- (match-end 1) (match-beginning 1)))
10224 txt (org-link-display-format (match-string 4))
10225 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
10226 re (format org-complex-heading-regexp-format
10227 (regexp-quote (match-string 4))))
10228 (when org-refile-use-outline-path
10229 (setq txt (mapconcat
10232 (if (eq org-refile-use-outline-path
10234 (list (file-name-nondirectory
10236 (buffer-base-buffer))))
10237 (if (eq org-refile-use-outline-path
10239 (list (buffer-file-name
10240 (buffer-base-buffer)))))
10241 (org-get-outline-path fast-path-p
10245 (push (list txt f re (org-refile-marker (point)))
10247 (when (= (point) pos0)
10248 ;; verification function has not moved point
10249 (goto-char (point-at-eol))))))))
10250 (when org-refile-use-cache
10251 (org-refile-cache-put tgs (buffer-file-name) descre))
10252 (setq targets (append tgs targets))
10254 (message "Getting targets...done")
10255 (nreverse targets)))
10257 (defun org-protect-slash (s)
10258 (while (string-match "/" s)
10259 (setq s (replace-match "\\" t t s)))
10262 (defvar org-olpa (make-vector 20 nil))
10264 (defun org-get-outline-path (&optional fastp level heading)
10265 "Return the outline path to the current entry, as a list.
10267 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10268 routine which makes outline path derivations for an entire file,
10269 avoiding backtracing. Refile target collection makes use of that."
10273 (error "Outline path failure, more than 19 levels"))
10274 (loop for i from level upto 19 do
10275 (aset org-olpa i nil))
10277 (delq nil (append org-olpa nil))
10278 (aset org-olpa level heading)))
10279 (let (rtn case-fold-search)
10283 (while (org-up-heading-safe)
10284 (when (looking-at org-complex-heading-regexp)
10285 (push (org-match-string-no-properties 4) rtn)))
10288 (defun org-format-outline-path (path &optional width prefix)
10289 "Format the outline path PATH for display.
10290 Width is the maximum number of characters that is available.
10291 Prefix is a prefix to be included in the returned string,
10292 such as the file name."
10293 (setq width (or width 79))
10294 (if prefix (setq width (- width (length prefix))))
10297 (let* ((nsteps (length path))
10298 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10299 (maxwidth (if (<= total-width width)
10300 10000 ;; everything fits
10301 ;; we need to shorten the level headings
10302 (/ (- width nsteps) nsteps)))
10303 (org-odd-levels-only nil)
10305 (total (1+ (length prefix))))
10306 (setq maxwidth (max maxwidth 10))
10311 (if (and (= n nsteps) (< maxwidth 10000))
10312 (setq maxwidth (- total-width total)))
10313 (if (< (length h) maxwidth)
10314 (progn (setq total (+ total (length h) 1)) h)
10315 (setq h (substring h 0 (- maxwidth 2))
10316 total (+ total maxwidth 1))
10317 (if (string-match "[ \t]+\\'" h)
10318 (setq h (substring h 0 (match-beginning 0))))
10319 (setq h (concat h "..")))
10320 (org-add-props h nil 'face
10321 (nth (% (1- n) org-n-level-faces)
10326 (defun org-display-outline-path (&optional file current)
10327 "Display the current outline path in the echo area."
10329 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10330 (case-fold-search nil)
10331 (path (and (org-mode-p) (org-get-outline-path))))
10332 (if current (setq path (append path
10334 (org-back-to-heading t)
10335 (if (looking-at org-complex-heading-regexp)
10336 (list (match-string 4)))))))
10338 (org-format-outline-path
10341 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10343 (defvar org-refile-history nil
10344 "History for refiling operations.")
10346 (defvar org-after-refile-insert-hook nil
10347 "Hook run after `org-refile' has inserted its stuff at the new location.
10348 Note that this is still *before* the stuff will be removed from
10349 the *old* location.")
10351 (defvar org-capture-last-stored-marker)
10352 (defun org-refile (&optional goto default-buffer rfloc)
10353 "Move the entry or entries at point to another heading.
10354 The list of target headings is compiled using the information in
10355 `org-refile-targets', which see.
10357 At the target location, the entry is filed as a subitem of the target
10358 heading. Depending on `org-reverse-note-order', the new subitem will
10359 either be the first or the last subitem.
10361 If there is an active region, all entries in that region will be moved.
10362 However, the region must fulfill the requirement that the first heading
10363 is the first one sets the top-level of the moved text - at most siblings
10364 below it are allowed.
10366 With prefix arg GOTO, the command will only visit the target location
10367 and not actually move anything.
10369 With a double prefix arg \\[universal-argument] \\[universal-argument], \
10370 go to the location where the last refiling operation has put the subtree.
10371 With a prefix argument of `2', refile to the running clock.
10373 RFLOC can be a refile location obtained in a different way.
10375 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10377 If you are using target caching (see `org-refile-use-cache'),
10378 You have to clear the target cache in order to find new targets.
10379 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10380 prefix argument (`C-u C-u C-u C-c C-w')."
10383 (if (member goto '(0 (64)))
10384 (org-refile-cache-clear)
10385 (let* ((cbuf (current-buffer))
10386 (regionp (org-region-active-p))
10387 (region-start (and regionp (region-beginning)))
10388 (region-end (and regionp (region-end)))
10389 (region-length (and regionp (- region-end region-start)))
10390 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10391 pos it nbuf file re level reversed)
10392 (setq last-command nil)
10394 (goto-char region-start)
10395 (or (bolp) (goto-char (point-at-bol)))
10396 (setq region-start (point))
10397 (unless (org-kill-is-subtree-p
10398 (buffer-substring region-start region-end))
10399 (error "The region is not a (sequence of) subtree(s)")))
10400 (if (equal goto '(16))
10401 (org-refile-goto-last-stored)
10403 (and (equal goto 2)
10404 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10406 (setq it (list (or org-clock-heading "running clock")
10408 (marker-buffer org-clock-hd-marker))
10410 (marker-position org-clock-hd-marker)))
10414 (org-refile-get-location
10415 (if goto "Goto" "Refile to") default-buffer
10416 org-refile-allow-creating-parent-nodes)))))
10417 (setq file (nth 1 it)
10420 (if (and (not goto)
10422 (equal (buffer-file-name) file)
10424 (and (>= pos region-start)
10425 (<= pos region-end))
10426 (and (>= pos (point))
10427 (< pos (save-excursion
10428 (org-end-of-subtree t t))))))
10429 (error "Cannot refile to position inside the tree or region"))
10431 (setq nbuf (or (find-buffer-visiting file)
10432 (find-file-noselect file)))
10435 (org-pop-to-buffer-same-window nbuf)
10437 (org-show-context 'org-goto))
10440 (org-kill-new (buffer-substring region-start region-end))
10441 (org-save-markers-in-region region-start region-end))
10442 (org-copy-subtree 1 nil t))
10443 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10444 (find-file-noselect file)))
10445 (setq reversed (org-notes-order-reversed-p))
10452 (looking-at org-outline-regexp)
10453 (setq level (org-get-valid-level (funcall outline-level) 1))
10456 (or (outline-next-heading) (point-max))
10457 (or (save-excursion (org-get-next-sibling))
10458 (org-end-of-subtree t t)
10462 (goto-char (point-max))
10463 (goto-char (point-min))
10464 (or (outline-next-heading) (goto-char (point-max)))))
10465 (if (not (bolp)) (newline))
10466 (org-paste-subtree level)
10467 (when org-log-refile
10468 (org-add-log-setup 'refile nil nil 'findpos
10470 (unless (eq org-log-refile 'note)
10471 (save-excursion (org-add-log-note))))
10472 (and org-auto-align-tags (org-set-tags nil t))
10473 (bookmark-set "org-refile-last-stored")
10474 ;; If we are refiling for capture, make sure that the
10475 ;; last-capture pointers point here
10476 (when (org-bound-and-true-p org-refile-for-capture)
10477 (bookmark-set "org-capture-last-stored-marker")
10478 (move-marker org-capture-last-stored-marker (point)))
10479 (if (fboundp 'deactivate-mark) (deactivate-mark))
10480 (run-hooks 'org-after-refile-insert-hook))))
10482 (delete-region (point) (+ (point) region-length))
10484 (when (featurep 'org-inlinetask)
10485 (org-inlinetask-remove-END-maybe))
10486 (setq org-markers-to-move nil)
10487 (message "Refiled to \"%s\" in file %s" (car it) file)))))))
10489 (defun org-refile-goto-last-stored ()
10490 "Go to the location where the last refile was stored."
10492 (bookmark-jump "org-refile-last-stored")
10493 (message "This is the location of the last refile"))
10495 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10496 "Prompt the user for a refile location, using PROMPT.
10497 PROMPT should not be suffixed with a colon and a space, because
10498 this function appends the default value from
10499 `org-refile-history' automatically, if that is not empty."
10500 (let ((org-refile-targets org-refile-targets)
10501 (org-refile-use-outline-path org-refile-use-outline-path)
10503 (when (and (eq major-mode 'org-mode)
10504 (not org-refile-use-cache))
10507 (setq excluded-entries
10508 (append excluded-entries (list (org-get-heading t)))))))
10509 (setq org-refile-target-table
10510 (org-refile-get-targets default-buffer excluded-entries)))
10511 (unless org-refile-target-table
10512 (error "No refile targets"))
10513 (let* ((prompt (concat prompt
10514 (and (car org-refile-history)
10515 (concat " (default " (car org-refile-history) ")"))
10517 (cbuf (current-buffer))
10518 (partial-completion-mode nil)
10519 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10520 (cfunc (if (and org-refile-use-outline-path
10521 org-outline-path-complete-in-steps)
10522 'org-olpath-completing-read
10523 'org-icompleting-read))
10524 (extra (if org-refile-use-outline-path "/" ""))
10525 (filename (and cfn (expand-file-name cfn)))
10528 (if (and (not (member org-refile-use-outline-path
10529 '(file full-file-path)))
10530 (not (equal filename (nth 1 x))))
10531 (cons (concat (car x) extra " ("
10532 (file-name-nondirectory (nth 1 x)) ")")
10534 (cons (concat (car x) extra) (cdr x))))
10535 org-refile-target-table))
10536 (completion-ignore-case t)
10537 pa answ parent-target child parent old-hist)
10538 (setq old-hist org-refile-history)
10539 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10540 nil 'org-refile-history (car org-refile-history)))
10541 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10542 (org-refile-check-position pa)
10545 (when (or (not org-refile-history)
10546 (not (eq old-hist org-refile-history))
10547 (not (equal (car pa) (car org-refile-history))))
10548 (setq org-refile-history
10549 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10551 (cdr org-refile-history))))
10552 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10553 (pop org-refile-history)))
10555 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
10557 (setq parent (match-string 1 answ)
10558 child (match-string 2 answ))
10559 (setq parent-target (or (assoc parent tbl)
10560 (assoc (concat parent "/") tbl)))
10561 (when (and parent-target
10562 (or (eq new-nodes t)
10563 (and (eq new-nodes 'confirm)
10564 (y-or-n-p (format "Create new node \"%s\"? "
10566 (org-refile-new-child parent-target child)))
10567 (error "Invalid target location")))))
10569 (defun org-refile-check-position (refile-pointer)
10570 "Check if the refile pointer matches the readline to which it points."
10571 (let* ((file (nth 1 refile-pointer))
10572 (re (nth 2 refile-pointer))
10573 (pos (nth 3 refile-pointer))
10575 (when (org-string-nw-p re)
10576 (setq buffer (if (markerp pos)
10577 (marker-buffer pos)
10578 (or (find-buffer-visiting file)
10579 (find-file-noselect file))))
10580 (with-current-buffer buffer
10585 (beginning-of-line 1)
10586 (unless (org-looking-at-p re)
10587 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10589 (defun org-refile-new-child (parent-target child)
10590 "Use refile target PARENT-TARGET to add new CHILD below it."
10591 (unless parent-target
10592 (error "Cannot find parent for new node"))
10593 (let ((file (nth 1 parent-target))
10594 (pos (nth 3 parent-target))
10596 (with-current-buffer (or (find-buffer-visiting file)
10597 (find-file-noselect file))
10603 (goto-char (point-max))
10604 (if (not (bolp)) (newline)))
10605 (when (looking-at org-outline-regexp)
10606 (setq level (funcall outline-level))
10607 (org-end-of-subtree t t))
10608 (org-back-over-empty-lines)
10609 (insert "\n" (make-string
10610 (if pos (org-get-valid-level level 1) 1) ?*)
10612 (beginning-of-line 0)
10613 (list (concat (car parent-target) "/" child) file "" (point)))))))
10615 (defun org-olpath-completing-read (prompt collection &rest args)
10616 "Read an outline path like a file name."
10617 (let ((thetable collection)
10618 (org-completion-use-ido nil) ; does not work with ido.
10619 (org-completion-use-iswitchb nil)) ; or iswitchb
10621 'org-icompleting-read prompt
10622 (lambda (string predicate &optional flag)
10623 (let (rtn r f (l (length string)))
10627 (try-completion string thetable))
10630 (setq rtn (all-completions string thetable predicate))
10633 (setq r (substring x l))
10634 (if (string-match " ([^)]*)$" x)
10635 (setq f (match-string 0 x))
10637 (if (string-match "/" r)
10638 (concat string (substring r 0 (match-end 0)) f)
10643 (assoc string thetable)))
10647 ;;;; Dynamic blocks
10649 (defun org-find-dblock (name)
10650 "Find the first dynamic block with name NAME in the buffer.
10651 If not found, stay at current position and return nil."
10654 (goto-char (point-min))
10655 (setq pos (and (re-search-forward (concat "^[ \t]*#\\+BEGIN:[ \t]+" name "\\>")
10657 (match-beginning 0))))
10658 (if pos (goto-char pos))
10661 (defconst org-dblock-start-re
10662 "^[ \t]*#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
10663 "Matches the start line of a dynamic block, with parameters.")
10665 (defconst org-dblock-end-re "^[ \t]*#\\+END\\([: \t\r\n]\\|$\\)"
10666 "Matches the end of a dynamic block.")
10668 (defun org-create-dblock (plist)
10669 "Create a dynamic block section, with parameters taken from PLIST.
10670 PLIST must contain a :name entry which is used as name of the block."
10671 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
10674 (let ((col (current-column))
10675 (name (plist-get plist :name)))
10676 (insert "#+BEGIN: " name)
10678 (if (eq (car plist) :name)
10679 (setq plist (cddr plist))
10680 (insert " " (prin1-to-string (pop plist)))))
10681 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
10682 (beginning-of-line -2)))
10684 (defun org-prepare-dblock ()
10685 "Prepare dynamic block for refresh.
10686 This empties the block, puts the cursor at the insert position and returns
10687 the property list including an extra property :name with the block name."
10688 (unless (looking-at org-dblock-start-re)
10689 (error "Not at a dynamic block"))
10690 (let* ((begdel (1+ (match-end 0)))
10691 (name (org-no-properties (match-string 1)))
10692 (params (append (list :name name)
10693 (read (concat "(" (match-string 3) ")")))))
10695 (beginning-of-line 1)
10696 (skip-chars-forward " \t")
10697 (setq params (plist-put params :indentation-column (current-column))))
10698 (unless (re-search-forward org-dblock-end-re nil t)
10699 (error "Dynamic block not terminated"))
10702 (list :content (buffer-substring
10703 begdel (match-beginning 0)))))
10704 (delete-region begdel (match-beginning 0))
10709 (defun org-map-dblocks (&optional command)
10710 "Apply COMMAND to all dynamic blocks in the current buffer.
10711 If COMMAND is not given, use `org-update-dblock'."
10712 (let ((cmd (or command 'org-update-dblock)))
10714 (goto-char (point-min))
10715 (while (re-search-forward org-dblock-start-re nil t)
10716 (goto-char (match-beginning 0))
10718 (condition-case nil
10720 (error (message "Error during update of dynamic block"))))
10721 (unless (re-search-forward org-dblock-end-re nil t)
10722 (error "Dynamic block not terminated"))))))
10724 (defun org-dblock-update (&optional arg)
10725 "User command for updating dynamic blocks.
10726 Update the dynamic block at point. With prefix ARG, update all dynamic
10727 blocks in the buffer."
10730 (org-update-all-dblocks)
10731 (or (looking-at org-dblock-start-re)
10732 (org-beginning-of-dblock))
10733 (org-update-dblock)))
10735 (defun org-update-dblock ()
10736 "Update the dynamic block at point.
10737 This means to empty the block, parse for parameters and then call
10738 the correct writing function."
10740 (save-window-excursion
10741 (let* ((pos (point))
10742 (line (org-current-line))
10743 (params (org-prepare-dblock))
10744 (name (plist-get params :name))
10745 (indent (plist-get params :indentation-column))
10746 (cmd (intern (concat "org-dblock-write:" name))))
10747 (message "Updating dynamic block `%s' at line %d..." name line)
10748 (funcall cmd params)
10749 (message "Updating dynamic block `%s' at line %d...done" name line)
10751 (when (and indent (> indent 0))
10752 (setq indent (make-string indent ?\ ))
10754 (org-beginning-of-dblock)
10756 (while (not (looking-at org-dblock-end-re))
10758 (beginning-of-line 2))
10759 (when (looking-at org-dblock-end-re)
10760 (and (looking-at "[ \t]+")
10761 (replace-match ""))
10762 (insert indent)))))))
10764 (defun org-beginning-of-dblock ()
10765 "Find the beginning of the dynamic block at point.
10766 Error if there is no such block at point."
10767 (let ((pos (point))
10770 (if (and (re-search-backward org-dblock-start-re nil t)
10771 (setq beg (match-beginning 0))
10772 (re-search-forward org-dblock-end-re nil t)
10773 (> (match-end 0) pos))
10776 (error "Not in a dynamic block"))))
10778 (defun org-update-all-dblocks ()
10779 "Update all dynamic blocks in the buffer.
10780 This function can be used in a hook."
10783 (org-map-dblocks 'org-update-dblock)))
10788 (defconst org-additional-option-like-keywords
10789 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10790 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10791 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10792 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10794 "ORGTBL" "TBLFM:" "TBLNAME:"
10795 "BEGIN_EXAMPLE" "END_EXAMPLE"
10796 "BEGIN_QUOTE" "END_QUOTE"
10797 "BEGIN_VERSE" "END_VERSE"
10798 "BEGIN_CENTER" "END_CENTER"
10799 "BEGIN_SRC" "END_SRC"
10800 "BEGIN_RESULT" "END_RESULT"
10801 "SOURCE:" "SRCNAME:" "FUNCTION:"
10803 "HEADER:" "HEADERS:"
10805 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10806 "CAPTION:" "LABEL:"
10812 (defcustom org-structure-template-alist
10814 ("s" "#+begin_src ?\n\n#+end_src"
10815 "<src lang=\"?\">\n\n</src>")
10816 ("e" "#+begin_example\n?\n#+end_example"
10817 "<example>\n?\n</example>")
10818 ("q" "#+begin_quote\n?\n#+end_quote"
10819 "<quote>\n?\n</quote>")
10820 ("v" "#+begin_verse\n?\n#+end_verse"
10821 "<verse>\n?\n/verse>")
10822 ("c" "#+begin_center\n?\n#+end_center"
10823 "<center>\n?\n/center>")
10824 ("l" "#+begin_latex\n?\n#+end_latex"
10825 "<literal style=\"latex\">\n?\n</literal>")
10827 "<literal style=\"latex\">?</literal>")
10828 ("h" "#+begin_html\n?\n#+end_html"
10829 "<literal style=\"html\">\n?\n</literal>")
10831 "<literal style=\"html\">?</literal>")
10832 ("a" "#+begin_ascii\n?\n#+end_ascii")
10836 ("I" "#+include %file ?"
10837 "<include file=%file markup=\"?\">")
10839 "Structure completion elements.
10840 This is a list of abbreviation keys and values. The value gets inserted
10841 if you type `<' followed by the key and then press the completion key,
10842 usually `M-TAB'. %file will be replaced by a file name after prompting
10843 for the file using completion. The cursor will be placed at the position
10844 of the `?` in the template.
10845 There are two templates for each key, the first uses the original Org syntax,
10846 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10847 the default when the /org-mtags.el/ module has been loaded. See also the
10848 variable `org-mtags-prefer-muse-templates'.
10849 This is an experimental feature, it is undecided if it is going to stay in."
10850 :group 'org-completion
10852 (string :tag "Key")
10853 (string :tag "Template")
10854 (string :tag "Muse Template")))
10856 (defun org-try-structure-completion ()
10857 "Try to complete a structure template before point.
10858 This looks for strings like \"<e\" on an otherwise empty line and
10860 (let ((l (buffer-substring (point-at-bol) (point)))
10862 (when (and (looking-at "[ \t]*$")
10863 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
10864 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10865 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10866 (match-beginning 1)) a)
10869 (defun org-complete-expand-structure-template (start cell)
10870 "Expand a structure template."
10871 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10872 (rpl (nth (if musep 2 1) cell))
10874 (delete-region start (point))
10875 (when (string-match "\\`#\\+" rpl)
10878 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
10879 (setq ind (buffer-substring (point-at-bol) (point))))
10881 (setq start (point))
10882 (if (string-match "%file" rpl)
10883 (setq rpl (replace-match
10887 (abbreviate-file-name (read-file-name "Include file: ")))
10890 (setq rpl (mapconcat 'identity (split-string rpl "\n")
10891 (concat "\n" ind)))
10893 (if (re-search-backward "\\?" start t) (delete-char 1))))
10895 ;;;; TODO, DEADLINE, Comments
10897 (defun org-toggle-comment ()
10898 "Change the COMMENT state of an entry."
10901 (org-back-to-heading)
10902 (let (case-fold-search)
10903 (if (looking-at (concat org-outline-regexp
10904 "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
10905 (replace-match "" t t nil 1)
10906 (if (looking-at org-outline-regexp)
10908 (goto-char (match-end 0))
10909 (insert org-comment-string " ")))))))
10911 (defvar org-last-todo-state-is-todo nil
10912 "This is non-nil when the last TODO state change led to a TODO state.
10913 If the last change removed the TODO tag or switched to DONE, then
10916 (defvar org-setting-tags nil) ; dynamically skipped
10918 (defvar org-todo-setup-filter-hook nil
10919 "Hook for functions that pre-filter todo specs.
10920 Each function takes a todo spec and returns either nil or the spec
10921 transformed into canonical form." )
10923 (defvar org-todo-get-default-hook nil
10924 "Hook for functions that get a default item for todo.
10925 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10926 nil or a string to be used for the todo mark." )
10928 (defvar org-agenda-headline-snapshot-before-repeat)
10930 (defun org-todo (&optional arg)
10931 "Change the TODO state of an item.
10932 The state of an item is given by a keyword at the start of the heading,
10934 *** TODO Write paper
10937 The different keywords are specified in the variable `org-todo-keywords'.
10938 By default the available states are \"TODO\" and \"DONE\".
10939 So for this example: when the item starts with TODO, it is changed to DONE.
10940 When it starts with DONE, the DONE is removed. And when neither TODO nor
10941 DONE are present, add TODO at the beginning of the heading.
10943 With \\[universal-argument] prefix arg, use completion to determine the new \
10945 With numeric prefix arg, switch to that state.
10946 With a double \\[universal-argument] prefix, switch to the next set of TODO \
10947 keywords (nextset).
10948 With a triple \\[universal-argument] prefix, circumvent any state blocking.
10950 For calling through lisp, arg is also interpreted in the following way:
10951 'none -> empty state
10952 \"\"(empty string) -> switch to empty state
10953 'done -> switch to DONE
10954 'nextset -> switch to the next set of keywords
10955 'previousset -> switch to the previous set of keywords
10956 \"WAITING\" -> switch to the specified keyword, but only if it
10957 really is a member of `org-todo-keywords'."
10959 (if (equal arg '(16)) (setq arg 'nextset))
10960 (let ((org-blocker-hook org-blocker-hook)
10961 (case-fold-search nil))
10962 (when (equal arg '(64))
10963 (setq arg nil org-blocker-hook nil))
10964 (when (and org-blocker-hook
10965 (or org-inhibit-blocking
10966 (org-entry-get nil "NOBLOCKING")))
10967 (setq org-blocker-hook nil))
10970 (org-back-to-heading t)
10971 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
10972 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|$\\)"))
10974 (let* ((match-data (match-data))
10975 (startpos (point-at-bol))
10976 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10977 (org-log-done org-log-done)
10978 (org-log-repeat org-log-repeat)
10979 (org-todo-log-states org-todo-log-states)
10980 (this (match-string 1))
10981 (hl-pos (match-beginning 0))
10982 (head (org-get-todo-sequence-head this))
10983 (ass (assoc head org-todo-kwd-alist))
10984 (interpret (nth 1 ass))
10985 (done-word (nth 3 ass))
10986 (final-done-word (nth 4 ass))
10987 (last-state (or this ""))
10988 (completion-ignore-case t)
10989 (member (member this org-todo-keywords-1))
10990 (tail (cdr member))
10992 ((and org-todo-key-trigger
10993 (or (and (equal arg '(4))
10994 (eq org-use-fast-todo-selection 'prefix))
10995 (and (not arg) org-use-fast-todo-selection
10996 (not (eq org-use-fast-todo-selection
10998 ;; Use fast selection
10999 (org-fast-todo-selection))
11000 ((and (equal arg '(4))
11001 (or (not org-use-fast-todo-selection)
11002 (not org-todo-key-trigger)))
11003 ;; Read a state with completion
11004 (org-icompleting-read
11005 "State: " (mapcar (lambda(x) (list x))
11006 org-todo-keywords-1)
11010 (if tail (car tail) nil)
11011 (car org-todo-keywords-1)))
11013 (if (equal member org-todo-keywords-1)
11016 (nth (- (length org-todo-keywords-1)
11018 org-todo-keywords-1)
11019 (org-last org-todo-keywords-1))))
11020 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11021 (setq arg nil))) ; hack to fall back to cycling
11023 ;; user or caller requests a specific state
11025 ((equal arg "") nil)
11026 ((eq arg 'none) nil)
11027 ((eq arg 'done) (or done-word (car org-done-keywords)))
11029 (or (car (cdr (member head org-todo-heads)))
11030 (car org-todo-heads)))
11031 ((eq arg 'previousset)
11032 (let ((org-todo-heads (reverse org-todo-heads)))
11033 (or (car (cdr (member head org-todo-heads)))
11034 (car org-todo-heads))))
11035 ((car (member arg org-todo-keywords-1)))
11037 (error "State `%s' not valid in this file" arg))
11038 ((nth (1- (prefix-numeric-value arg))
11039 org-todo-keywords-1))))
11040 ((null member) (or head (car org-todo-keywords-1)))
11041 ((equal this final-done-word) nil) ;; -> make empty
11042 ((null tail) nil) ;; -> first entry
11043 ((memq interpret '(type priority))
11044 (if (eq this-command last-command)
11046 (if (> (length tail) 0)
11047 (or done-word (car org-done-keywords))
11052 (run-hook-with-args-until-success
11053 'org-todo-get-default-hook state last-state)
11055 (next (if state (concat " " state " ") " "))
11056 (change-plist (list :type 'todo-state-change :from this :to state
11057 :position startpos))
11059 (when org-blocker-hook
11060 (setq org-last-todo-state-is-todo
11061 (not (member this org-done-keywords)))
11062 (unless (save-excursion
11064 (org-with-wide-buffer
11065 (run-hook-with-args-until-failure
11066 'org-blocker-hook change-plist))))
11067 (if (org-called-interactively-p 'interactive)
11068 (error "TODO state change from %s to %s blocked" this state)
11070 (message "TODO state change from %s to %s blocked" this state)
11071 (throw 'exit nil))))
11072 (store-match-data match-data)
11073 (replace-match next t t)
11074 (unless (pos-visible-in-window-p hl-pos)
11075 (message "TODO state changed to %s" (org-trim next)))
11077 (setq head (org-get-todo-sequence-head state)
11078 ass (assoc head org-todo-kwd-alist)
11079 interpret (nth 1 ass)
11080 done-word (nth 3 ass)
11081 final-done-word (nth 4 ass)))
11082 (when (memq arg '(nextset previousset))
11083 (message "Keyword-Set %d/%d: %s"
11084 (- (length org-todo-sets) -1
11085 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11086 (length org-todo-sets)
11087 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11088 (setq org-last-todo-state-is-todo
11089 (not (member state org-done-keywords)))
11090 (setq now-done-p (and (member state org-done-keywords)
11091 (not (member this org-done-keywords))))
11092 (and logging (org-local-logging logging))
11093 (when (and (or org-todo-log-states org-log-done)
11094 (not (eq org-inhibit-logging t))
11095 (not (memq arg '(nextset previousset))))
11096 ;; we need to look at recording a time and note
11097 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11098 (nth 2 (assoc this org-todo-log-states))))
11099 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11100 (setq dolog 'time))
11102 (member state org-not-done-keywords)
11103 (not (member this org-not-done-keywords)))
11104 ;; This is now a todo state and was not one before
11105 ;; If there was a CLOSED time stamp, get rid of it.
11106 (org-add-planning-info nil nil 'closed))
11107 (when (and now-done-p org-log-done)
11108 ;; It is now done, and it was not done before
11109 (org-add-planning-info 'closed (org-current-time))
11110 (if (and (not dolog) (eq 'note org-log-done))
11111 (org-add-log-setup 'done state this 'findpos 'note)))
11112 (when (and state dolog)
11113 ;; This is a non-nil state, and we need to log it
11114 (org-add-log-setup 'state state this 'findpos dolog)))
11115 ;; Fixup tag positioning
11116 (org-todo-trigger-tag-changes state)
11117 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11118 (when org-provide-todo-statistics
11119 (org-update-parent-todo-statistics))
11120 (run-hooks 'org-after-todo-state-change-hook)
11121 (if (and arg (not (member state org-done-keywords)))
11122 (setq head (org-get-todo-sequence-head state)))
11123 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11124 ;; Do we need to trigger a repeat?
11126 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11127 ;; This is for the agenda, take a snapshot of the headline.
11129 (setq org-agenda-headline-snapshot-before-repeat
11130 (org-get-heading))))
11131 (org-auto-repeat-maybe state))
11132 ;; Fixup cursor location if close to the keyword
11133 (if (and (outline-on-heading-p)
11135 (save-excursion (beginning-of-line 1)
11136 (looking-at org-todo-line-regexp))
11137 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11139 (goto-char (or (match-end 2) (match-end 1)))
11140 (and (looking-at " ") (just-one-space))))
11141 (when org-trigger-hook
11143 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11145 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11146 "Block turning an entry into a TODO, using the hierarchy.
11147 This checks whether the current task should be blocked from state
11148 changes. Such blocking occurs when:
11150 1. The task has children which are not all in a completed state.
11152 2. A task has a parent with the property :ORDERED:, and there
11153 are siblings prior to the current task with incomplete
11156 3. The parent of the task is blocked because it has siblings that should
11157 be done first, or is child of a block grandparent TODO entry."
11159 (if (not org-enforce-todo-dependencies)
11160 t ; if locally turned off don't block
11162 ;; If this is not a todo state change, or if this entry is already DONE,
11164 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11165 (member (plist-get change-plist :from)
11166 (cons 'done org-done-keywords))
11167 (member (plist-get change-plist :to)
11168 (cons 'todo org-not-done-keywords))
11169 (not (plist-get change-plist :to)))
11170 (throw 'dont-block t))
11171 ;; If this task has children, and any are undone, it's blocked
11173 (org-back-to-heading t)
11174 (let ((this-level (funcall outline-level)))
11175 (outline-next-heading)
11176 (let ((child-level (funcall outline-level)))
11177 (while (and (not (eobp))
11178 (> child-level this-level))
11179 ;; this todo has children, check whether they are all
11181 (if (and (not (org-entry-is-done-p))
11182 (org-entry-is-todo-p))
11183 (throw 'dont-block nil))
11184 (outline-next-heading)
11185 (setq child-level (funcall outline-level))))))
11186 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11187 ;; any previous siblings are undone, it's blocked
11189 (org-back-to-heading t)
11190 (let* ((pos (point))
11191 (parent-pos (and (org-up-heading-safe) (point))))
11192 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11193 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11195 (re-search-forward org-not-done-heading-regexp pos t))
11196 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11197 ;; Search further up the hierarchy, to see if an anchestor is blocked
11199 (goto-char parent-pos)
11200 (if (not (looking-at org-not-done-heading-regexp))
11201 (throw 'dont-block t)) ; do not block, parent is not a TODO
11203 (setq parent-pos (and (org-up-heading-safe) (point)))
11204 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11205 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11207 (re-search-forward org-not-done-heading-regexp pos t))
11208 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11210 (defcustom org-track-ordered-property-with-tag nil
11211 "Should the ORDERED property also be shown as a tag?
11212 The ORDERED property decides if an entry should require subtasks to be
11213 completed in sequence. Since a property is not very visible, setting
11214 this option means that toggling the ORDERED property with the command
11215 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11216 not relevant for the behavior, but it makes things more visible.
11218 Note that toggling the tag with tags commands will not change the property
11219 and therefore not influence behavior!
11221 This can be t, meaning the tag ORDERED should be used, It can also be a
11222 string to select a different tag for this task."
11225 (const :tag "No tracking" nil)
11226 (const :tag "Track with ORDERED tag" t)
11227 (string :tag "Use other tag")))
11229 (defun org-toggle-ordered-property ()
11230 "Toggle the ORDERED property of the current entry.
11231 For better visibility, you can track the value of this property with a tag.
11232 See variable `org-track-ordered-property-with-tag'."
11234 (let* ((t1 org-track-ordered-property-with-tag)
11235 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11237 (org-back-to-heading)
11238 (if (org-entry-get nil "ORDERED")
11240 (org-delete-property "ORDERED")
11241 (and tag (org-toggle-tag tag 'off))
11242 (message "Subtasks can be completed in arbitrary order"))
11243 (org-entry-put nil "ORDERED" "t")
11244 (and tag (org-toggle-tag tag 'on))
11245 (message "Subtasks must be completed in sequence")))))
11247 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11248 (defun org-block-todo-from-checkboxes (change-plist)
11249 "Block turning an entry into a TODO, using checkboxes.
11250 This checks whether the current task should be blocked from state
11251 changes because there are unchecked boxes in this entry."
11252 (if (not org-enforce-todo-checkbox-dependencies)
11253 t ; if locally turned off don't block
11255 ;; If this is not a todo state change, or if this entry is already DONE,
11257 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11258 (member (plist-get change-plist :from)
11259 (cons 'done org-done-keywords))
11260 (member (plist-get change-plist :to)
11261 (cons 'todo org-not-done-keywords))
11262 (not (plist-get change-plist :to)))
11263 (throw 'dont-block t))
11264 ;; If this task has checkboxes that are not checked, it's blocked
11266 (org-back-to-heading t)
11267 (let ((beg (point)) end)
11268 (outline-next-heading)
11271 (if (re-search-forward "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\[[- ]\\]"
11274 (if (boundp 'org-blocked-by-checkboxes)
11275 (setq org-blocked-by-checkboxes t))
11276 (throw 'dont-block nil)))))
11277 t))) ; do not block
11279 (defun org-entry-blocked-p ()
11280 "Is the current entry blocked?"
11281 (if (org-entry-get nil "NOBLOCKING")
11282 nil ;; Never block this entry
11284 (run-hook-with-args-until-failure
11286 (list :type 'todo-state-change
11291 (defun org-update-statistics-cookies (all)
11292 "Update the statistics cookie, either from TODO or from checkboxes.
11293 This should be called with the cursor in a line with a statistics cookie."
11297 (org-update-checkbox-count 'all)
11298 (org-map-entries 'org-update-parent-todo-statistics))
11299 (if (not (org-on-heading-p))
11300 (org-update-checkbox-count)
11301 (let ((pos (move-marker (make-marker) (point)))
11303 (ignore-errors (org-back-to-heading t))
11304 (if (not (org-on-heading-p))
11305 (org-update-checkbox-count)
11306 (setq l1 (org-outline-level))
11307 (setq end (save-excursion
11308 (outline-next-heading)
11309 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11311 (if (and (save-excursion
11313 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
11314 (not (save-excursion (re-search-forward
11315 ":COOKIE_DATA:.*\\<todo\\>" end t))))
11316 (org-update-checkbox-count)
11317 (if (and l2 (> l2 l1))
11320 (org-update-parent-todo-statistics))
11322 (beginning-of-line 1)
11323 (while (re-search-forward
11324 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
11326 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11328 (move-marker pos nil)))))
11330 (defvar org-entry-property-inherited-from) ;; defined below
11331 (defun org-update-parent-todo-statistics ()
11332 "Update any statistics cookie in the parent of the current headline.
11333 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11334 the entire subtree and this will travel up the hierarchy and update
11335 statistics everywhere."
11336 (let* ((prop (save-excursion (org-up-heading-safe)
11337 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11338 (recursive (or (not org-hierarchical-todo-statistics)
11339 (and prop (string-match "\\<recursive\\>" prop))))
11340 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11343 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
11344 level ltoggle l1 new ndel
11345 (cnt-all 0) (cnt-done 0) is-percent kwd
11346 checkbox-beg ov ovs ove cookie-present)
11349 (beginning-of-line 1)
11350 (setq ltoggle (funcall outline-level))
11351 ;; Three situations are to consider:
11353 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11354 ;; to the top-level ancestor on the headline;
11356 ;; 2. If parent has "recursive" property, repeat up to the
11357 ;; headline setting that property, taking inheritance into
11360 ;; 3. Else, move up to direct parent and proceed only once.
11361 (while (and (setq level (org-up-heading-safe))
11362 (or recursive first)
11364 (setq first nil cookie-present nil)
11368 (downcase (or (org-entry-get nil "COOKIE_DATA")
11371 (while (re-search-forward box-re (point-at-eol) t)
11372 (setq cnt-all 0 cnt-done 0 cookie-present t)
11373 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11375 (unless (outline-next-heading) (throw 'exit nil))
11376 (while (and (looking-at org-complex-heading-regexp)
11377 (> (setq l1 (length (match-string 1))) level))
11378 (setq kwd (and (or recursive (= l1 ltoggle))
11380 (if (or (eq org-provide-todo-statistics 'all-headlines)
11381 (and (listp org-provide-todo-statistics)
11382 (or (member kwd org-provide-todo-statistics)
11383 (member kwd org-done-keywords))))
11384 (setq cnt-all (1+ cnt-all))
11385 (if (eq org-provide-todo-statistics t)
11386 (and kwd (setq cnt-all (1+ cnt-all)))))
11387 (and (member kwd org-done-keywords)
11388 (setq cnt-done (1+ cnt-done)))
11389 (outline-next-heading)))
11392 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11393 (format "[%d/%d]" cnt-done cnt-all))
11394 ndel (- (match-end 0) checkbox-beg))
11395 ;; handle overlays when updating cookie from column view
11396 (when (setq ov (car (overlays-at checkbox-beg)))
11397 (setq ovs (overlay-start ov) ove (overlay-end ov))
11398 (delete-overlay ov))
11399 (goto-char checkbox-beg)
11401 (delete-region (point) (+ (point) ndel))
11402 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11403 (when ov (move-overlay ov ovs ove)))
11404 (when cookie-present
11405 (run-hook-with-args 'org-after-todo-statistics-hook
11406 cnt-done (- cnt-all cnt-done))))))
11407 (run-hooks 'org-todo-statistics-hook)))
11409 (defvar org-after-todo-statistics-hook nil
11410 "Hook that is called after a TODO statistics cookie has been updated.
11411 Each function is called with two arguments: the number of not-done entries
11412 and the number of done entries.
11414 For example, the following function, when added to this hook, will switch
11415 an entry to DONE when all children are done, and back to TODO when new
11416 entries are set to a TODO status. Note that this hook is only called
11417 when there is a statistics cookie in the headline!
11419 (defun org-summary-todo (n-done n-not-done)
11420 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
11421 (let (org-log-done org-log-states) ; turn off logging
11422 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
11425 (defvar org-todo-statistics-hook nil
11426 "Hook that is run whenever Org thinks TODO statistics should be updated.
11427 This hook runs even if there is no statistics cookie present, in which case
11428 `org-after-todo-statistics-hook' would not run.")
11430 (defun org-todo-trigger-tag-changes (state)
11431 "Apply the changes defined in `org-todo-state-tags-triggers'."
11432 (let ((l org-todo-state-tags-triggers)
11434 (when (or (not state) (equal state ""))
11435 (setq changes (append changes (cdr (assoc "" l)))))
11436 (when (and (stringp state) (> (length state) 0))
11437 (setq changes (append changes (cdr (assoc state l)))))
11438 (when (member state org-not-done-keywords)
11439 (setq changes (append changes (cdr (assoc 'todo l)))))
11440 (when (member state org-done-keywords)
11441 (setq changes (append changes (cdr (assoc 'done l)))))
11442 (dolist (c changes)
11443 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11445 (defun org-local-logging (value)
11446 "Get logging settings from a property VALUE."
11448 ;; directly set the variables, they are already local.
11449 (setq org-log-done nil
11451 org-todo-log-states nil)
11452 (setq words (org-split-string value))
11453 (while (setq w (pop words))
11455 ((setq a (assoc w org-startup-options))
11456 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11457 (set (nth 1 a) (nth 2 a))))
11458 ((setq a (org-extract-log-state-settings w))
11459 (and (member (car a) org-todo-keywords-1)
11460 (push a org-todo-log-states)))))))
11462 (defun org-get-todo-sequence-head (kwd)
11463 "Return the head of the TODO sequence to which KWD belongs.
11464 If KWD is not set, check if there is a text property remembering the
11469 (or (get-text-property (point-at-bol) 'org-todo-head)
11471 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11472 nil (point-at-eol)))
11473 (get-text-property p 'org-todo-head))))
11474 ((not (member kwd org-todo-keywords-1))
11475 (car org-todo-keywords-1))
11476 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11478 (defun org-fast-todo-selection ()
11479 "Fast TODO keyword selection with single keys.
11480 Returns the new TODO keyword, or nil if no state change should occur."
11481 (let* ((fulltable org-todo-key-alist)
11482 (done-keywords org-done-keywords) ;; needed for the faces.
11483 (maxlen (apply 'max (mapcar
11485 (if (stringp (car x)) (string-width (car x)) 0))
11488 (fwidth (+ maxlen 3 1 3))
11489 (ncol (/ (- (window-width) 4) fwidth))
11493 (save-window-excursion
11495 (set-buffer (get-buffer-create " *Org todo*"))
11496 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11498 (org-set-local 'org-done-keywords done-keywords)
11499 (setq tbl fulltable cnt 0)
11500 (while (setq e (pop tbl))
11502 ((equal e '(:startgroup))
11503 (push '() groups) (setq ingroup t)
11504 (when (not (= cnt 0))
11508 ((equal e '(:endgroup))
11509 (setq ingroup nil cnt 0)
11511 ((equal e '(:newline))
11512 (when (not (= cnt 0))
11516 (while (equal (car tbl) '(:newline))
11518 (setq tbl (cdr tbl)))))
11520 (setq tg (car e) c (cdr e))
11521 (if ingroup (push tg (car groups)))
11522 (setq tg (org-add-props tg nil 'face
11523 (org-get-todo-face tg)))
11524 (if (and (= cnt 0) (not ingroup)) (insert " "))
11525 (insert "[" c "] " tg (make-string
11526 (- fwidth 4 (length tg)) ?\ ))
11527 (when (= (setq cnt (1+ cnt)) ncol)
11529 (if ingroup (insert " "))
11532 (goto-char (point-min))
11533 (if (not expert) (org-fit-window-to-buffer))
11534 (message "[a-z..]:Set [SPC]:clear")
11535 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11538 (and (= c ?q) (not (rassoc c fulltable))))
11539 (setq quit-flag t))
11541 ((setq e (rassoc c fulltable) tg (car e))
11543 (t (setq quit-flag t)))))))
11545 (defun org-entry-is-todo-p ()
11546 (member (org-get-todo-state) org-not-done-keywords))
11548 (defun org-entry-is-done-p ()
11549 (member (org-get-todo-state) org-done-keywords))
11551 (defun org-get-todo-state ()
11553 (org-back-to-heading t)
11554 (and (looking-at org-todo-line-regexp)
11556 (match-string 2))))
11558 (defun org-at-date-range-p (&optional inactive-ok)
11559 "Is the cursor inside a date range?"
11563 (let ((pos (point)))
11564 (skip-chars-backward "^[<\r\n")
11565 (skip-chars-backward "<[")
11566 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11567 (>= (match-end 0) pos)
11569 (skip-chars-backward "^<[\r\n")
11570 (skip-chars-backward "<[")
11571 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11572 (>= (match-end 0) pos)
11576 (defun org-get-repeat (&optional tagline)
11577 "Check if there is a deadline/schedule with repeater in this entry."
11580 (org-back-to-heading t)
11581 (and (re-search-forward (if tagline
11582 (concat tagline "\\s-*" org-repeat-re)
11584 (org-entry-end-position) t)
11585 (match-string-no-properties 1)))))
11587 (defvar org-last-changed-timestamp)
11588 (defvar org-last-inserted-timestamp)
11589 (defvar org-log-post-message)
11590 (defvar org-log-note-purpose)
11591 (defvar org-log-note-how)
11592 (defvar org-log-note-extra)
11593 (defun org-auto-repeat-maybe (done-word)
11594 "Check if the current headline contains a repeated deadline/schedule.
11595 If yes, set TODO state back to what it was and change the base date
11596 of repeating deadline/scheduled time stamps to new date.
11597 This function is run automatically after each state change to a DONE state."
11598 ;; last-state is dynamically scoped into this function
11599 (let* ((repeat (org-get-repeat))
11600 (aa (assoc last-state org-todo-kwd-alist))
11601 (interpret (nth 1 aa))
11603 (whata '(("d" . day) ("m" . month) ("y" . year)))
11604 (msg "Entry repeats: ")
11606 (org-todo-log-states nil)
11607 re type n what ts time to-state)
11609 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11610 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11611 org-todo-repeat-to-state))
11612 (unless (and to-state (member to-state org-todo-keywords-1))
11613 (setq to-state (if (eq interpret 'type) last-state head)))
11614 (org-todo to-state)
11615 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11616 (org-entry-put nil "LAST_REPEAT" (format-time-string
11617 (org-time-stamp-format t t))))
11618 (when org-log-repeat
11619 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11620 (memq 'org-add-log-note post-command-hook))
11621 ;; OK, we are already setup for some record
11622 (if (eq org-log-repeat 'note)
11623 ;; make sure we take a note, not only a time stamp
11624 (setq org-log-note-how 'note))
11625 ;; Set up for taking a record
11626 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11628 'findpos org-log-repeat)))
11629 (org-back-to-heading t)
11630 (org-add-planning-info nil nil 'closed)
11631 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
11632 org-deadline-time-regexp "\\)\\|\\("
11633 org-ts-regexp "\\)"))
11634 (while (re-search-forward
11635 re (save-excursion (outline-next-heading) (point)) t)
11636 (setq type (if (match-end 1) org-scheduled-string
11637 (if (match-end 3) org-deadline-string "Plain:"))
11638 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11639 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
11640 (setq n (string-to-number (match-string 2 ts))
11641 what (match-string 3 ts))
11642 (if (equal what "w") (setq n (* n 7) what "d"))
11643 ;; Preparation, see if we need to modify the start date for the change
11644 (when (match-end 1)
11645 (setq time (save-match-data (org-time-string-to-time ts)))
11647 ((equal (match-string 1 ts) ".")
11648 ;; Shift starting date to today
11649 (org-timestamp-change
11650 (- (time-to-days (current-time)) (time-to-days time))
11652 ((equal (match-string 1 ts) "+")
11653 (let ((nshiftmax 10) (nshift 0))
11654 (while (or (= nshift 0)
11655 (<= (time-to-days time)
11656 (time-to-days (current-time))))
11657 (when (= (incf nshift) nshiftmax)
11658 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11660 (org-timestamp-change n (cdr (assoc what whata)))
11661 (org-at-timestamp-p t)
11662 (setq ts (match-string 1))
11663 (setq time (save-match-data (org-time-string-to-time ts)))))
11664 (org-timestamp-change (- n) (cdr (assoc what whata)))
11665 ;; rematch, so that we have everything in place for the real shift
11666 (org-at-timestamp-p t)
11667 (setq ts (match-string 1))
11668 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
11669 (org-timestamp-change n (cdr (assoc what whata)))
11670 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11671 (setq org-log-post-message msg)
11672 (message "%s" msg))))
11674 (defun org-show-todo-tree (arg)
11675 "Make a compact tree which shows all headlines marked with TODO.
11676 The tree will show the lines where the regexp matches, and all higher
11677 headlines above the match.
11678 With a \\[universal-argument] prefix, prompt for a regexp to match.
11679 With a numeric prefix N, construct a sparse tree for the Nth element
11680 of `org-todo-keywords-1'."
11682 (let ((case-fold-search nil)
11684 (cond ((null arg) org-not-done-regexp)
11686 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11687 (mapcar 'list org-todo-keywords-1))))
11689 (mapconcat 'identity (org-split-string kwd "|") "\\|")
11691 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11692 (regexp-quote (nth (1- (prefix-numeric-value arg))
11693 org-todo-keywords-1)))
11694 (t (error "Invalid prefix argument: %s" arg)))))
11695 (message "%d TODO entries found"
11696 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11698 (defun org-deadline (&optional remove time)
11699 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
11700 With argument REMOVE, remove any deadline from the item.
11701 When TIME is set, it should be an internal time specification, and the
11702 scheduling will use the corresponding date."
11704 (org-loop-over-siblings-in-active-region
11705 (let* ((old-date (org-entry-get nil "DEADLINE"))
11706 (repeater (and old-date
11708 "\\([.+-]+[0-9]+[dwmy]\\(?:[/ ][-+]?[0-9]+[dwmy]\\)?\\) ?"
11710 (match-string 1 old-date))))
11713 (when (and old-date org-log-redeadline)
11714 (org-add-log-setup 'deldeadline nil old-date 'findpos
11715 org-log-redeadline))
11716 (org-remove-timestamp-with-keyword org-deadline-string)
11717 (message "Item no longer has a deadline."))
11718 (org-add-planning-info 'deadline time 'closed)
11719 (when (and old-date org-log-redeadline
11720 (not (equal old-date
11721 (substring org-last-inserted-timestamp 1 -1))))
11722 (org-add-log-setup 'redeadline nil old-date 'findpos
11723 org-log-redeadline))
11726 (org-back-to-heading t)
11727 (when (re-search-forward (concat org-deadline-string " "
11728 org-last-inserted-timestamp)
11730 (outline-next-heading) (point)) t)
11731 (goto-char (1- (match-end 0)))
11732 (insert " " repeater)
11733 (setq org-last-inserted-timestamp
11734 (concat (substring org-last-inserted-timestamp 0 -1)
11736 (substring org-last-inserted-timestamp -1))))))
11737 (message "Deadline on %s" org-last-inserted-timestamp)))))
11739 (defun org-schedule (&optional remove time)
11740 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11741 With argument REMOVE, remove any scheduling date from the item.
11742 When TIME is set, it should be an internal time specification, and the
11743 scheduling will use the corresponding date."
11745 (org-loop-over-siblings-in-active-region
11746 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11747 (repeater (and old-date
11749 "\\([.+-]+[0-9]+[dwmy]\\(?:[/ ][-+]?[0-9]+[dwmy]\\)?\\) ?"
11751 (match-string 1 old-date))))
11754 (when (and old-date org-log-reschedule)
11755 (org-add-log-setup 'delschedule nil old-date 'findpos
11756 org-log-reschedule))
11757 (org-remove-timestamp-with-keyword org-scheduled-string)
11758 (message "Item is no longer scheduled."))
11759 (org-add-planning-info 'scheduled time 'closed)
11760 (when (and old-date org-log-reschedule
11761 (not (equal old-date
11762 (substring org-last-inserted-timestamp 1 -1))))
11763 (org-add-log-setup 'reschedule nil old-date 'findpos
11764 org-log-reschedule))
11767 (org-back-to-heading t)
11768 (when (re-search-forward (concat org-scheduled-string " "
11769 org-last-inserted-timestamp)
11771 (outline-next-heading) (point)) t)
11772 (goto-char (1- (match-end 0)))
11773 (insert " " repeater)
11774 (setq org-last-inserted-timestamp
11775 (concat (substring org-last-inserted-timestamp 0 -1)
11777 (substring org-last-inserted-timestamp -1))))))
11778 (message "Scheduled to %s" org-last-inserted-timestamp)))))
11780 (defun org-get-scheduled-time (pom &optional inherit)
11781 "Get the scheduled time as a time tuple, of a format suitable
11782 for calling org-schedule with, or if there is no scheduling,
11784 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11786 (apply 'encode-time (org-parse-time-string time)))))
11788 (defun org-get-deadline-time (pom &optional inherit)
11789 "Get the deadline as a time tuple, of a format suitable for
11790 calling org-deadline with, or if there is no scheduling, returns
11792 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11794 (apply 'encode-time (org-parse-time-string time)))))
11796 (defun org-remove-timestamp-with-keyword (keyword)
11797 "Remove all time stamps with KEYWORD in the current entry."
11798 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
11801 (org-back-to-heading t)
11803 (outline-next-heading)
11804 (while (re-search-backward re beg t)
11806 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
11807 (equal (char-before) ?\ ))
11808 (backward-delete-char 1)
11809 (if (string-match "^[ \t]*$" (buffer-substring
11810 (point-at-bol) (point-at-eol)))
11811 (delete-region (point-at-bol)
11812 (min (point-max) (1+ (point-at-eol))))))))))
11814 (defun org-add-planning-info (what &optional time &rest remove)
11815 "Insert new timestamp with keyword in the line directly after the headline.
11816 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11817 If non is given, the user is prompted for a date.
11818 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11821 (let (org-time-was-given org-end-time-was-given ts
11822 end default-time default-input)
11825 (when (and (not time) (memq what '(scheduled deadline)))
11826 ;; Try to get a default date/time from existing timestamp
11828 (org-back-to-heading t)
11829 (setq end (save-excursion (outline-next-heading) (point)))
11830 (when (re-search-forward (if (eq what 'scheduled)
11831 org-scheduled-time-regexp
11832 org-deadline-time-regexp)
11834 (setq ts (match-string 1)
11836 (apply 'encode-time (org-parse-time-string ts))
11837 default-input (and ts (org-get-compact-tod ts))))))
11839 ;; If necessary, get the time from the user
11840 (setq time (or time (org-read-date nil 'to-time nil nil
11841 default-time default-input))))
11843 (when (and org-insert-labeled-timestamps-at-point
11844 (member what '(scheduled deadline)))
11846 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11847 (org-insert-time-stamp time org-time-was-given
11848 nil nil nil (list org-end-time-was-given))
11852 (let (col list elt ts buffer-invisibility-spec)
11853 (org-back-to-heading t)
11854 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
11855 (goto-char (match-end 1))
11856 (setq col (current-column))
11857 (goto-char (match-end 0))
11858 (if (eobp) (insert "\n") (forward-char 1))
11859 (when (and (not what)
11862 org-keyword-time-not-clock-regexp))))
11863 ;; Nothing to add, nothing to remove...... :-)
11865 (if (and (not (looking-at org-outline-regexp))
11866 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
11868 (not (equal (match-string 1) org-clock-string)))
11869 (narrow-to-region (match-beginning 0) (match-end 0))
11870 (insert-before-markers "\n")
11872 (narrow-to-region (point) (point))
11873 (and org-adapt-indentation (org-indent-to-column col)))
11874 ;; Check if we have to remove something.
11875 (setq list (cons what remove))
11877 (setq elt (pop list))
11878 (when (or (and (eq elt 'scheduled)
11879 (re-search-forward org-scheduled-time-regexp nil t))
11880 (and (eq elt 'deadline)
11881 (re-search-forward org-deadline-time-regexp nil t))
11882 (and (eq elt 'closed)
11883 (re-search-forward org-closed-time-regexp nil t)))
11885 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11886 (and (looking-at "^[ \t]+") (replace-match ""))
11887 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11890 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11891 (cond ((eq what 'scheduled) org-scheduled-string)
11892 ((eq what 'deadline) org-deadline-string)
11893 ((eq what 'closed) org-closed-string))
11895 (setq ts (org-insert-time-stamp
11897 (or org-time-was-given
11898 (and (eq what 'closed) org-log-done-with-time))
11900 nil nil (list org-end-time-was-given)))
11902 (if (not (or (bolp) (eq (char-before) ?\ )
11903 (memq (char-after) '(32 10))
11906 (goto-char (point-min))
11908 (if (and (looking-at "[ \t]*\n")
11909 (equal (char-before) ?\n))
11910 (delete-region (1- (point)) (point-at-eol)))
11913 (defvar org-log-note-marker (make-marker))
11914 (defvar org-log-note-purpose nil)
11915 (defvar org-log-note-state nil)
11916 (defvar org-log-note-previous-state nil)
11917 (defvar org-log-note-how nil)
11918 (defvar org-log-note-extra nil)
11919 (defvar org-log-note-window-configuration nil)
11920 (defvar org-log-note-return-to (make-marker))
11921 (defvar org-log-post-message nil
11922 "Message to be displayed after a log note has been stored.
11923 The auto-repeater uses this.")
11925 (defun org-add-note ()
11926 "Add a note to the current entry.
11927 This is done in the same way as adding a state change note."
11929 (org-add-log-setup 'note nil nil 'findpos nil))
11931 (defvar org-property-end-re)
11932 (defun org-add-log-setup (&optional purpose state prev-state
11934 "Set up the post command hook to take a note.
11935 If this is about to TODO state change, the new state is expected in STATE.
11936 When FINDPOS is non-nil, find the correct position for the note in
11937 the current entry. If not, assume that it can be inserted at point.
11938 HOW is an indicator what kind of note should be created.
11939 EXTRA is additional text that will be inserted into the notes buffer."
11940 (let* ((org-log-into-drawer (org-log-into-drawer))
11941 (drawer (cond ((stringp org-log-into-drawer)
11942 org-log-into-drawer)
11943 (org-log-into-drawer "LOGBOOK")
11948 (org-back-to-heading t)
11949 (narrow-to-region (point) (save-excursion
11950 (outline-next-heading) (point)))
11951 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
11952 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
11954 (goto-char (match-end 0))
11957 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
11960 (goto-char (match-end 0))
11961 (or org-log-states-order-reversed
11962 (and (re-search-forward org-property-end-re nil t)
11963 (goto-char (1- (match-beginning 0))))))
11964 (insert "\n:" drawer ":\n:END:")
11965 (beginning-of-line 0)
11966 (org-indent-line-function)
11967 (beginning-of-line 2)
11968 (org-indent-line-function)
11970 ((and org-log-state-notes-insert-after-drawers
11972 (forward-line) (looking-at org-drawer-regexp)))
11974 (while (looking-at org-drawer-regexp)
11975 (goto-char (match-end 0))
11976 (re-search-forward org-property-end-re (point-max) t)
11978 (forward-line -1)))
11979 (unless org-log-states-order-reversed
11980 (and (= (char-after) ?\n) (forward-char 1))
11981 (org-skip-over-state-notes)
11982 (skip-chars-backward " \t\n\r")))
11983 (move-marker org-log-note-marker (point))
11984 (setq org-log-note-purpose purpose
11985 org-log-note-state state
11986 org-log-note-previous-state prev-state
11987 org-log-note-how how
11988 org-log-note-extra extra)
11989 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11991 (defun org-skip-over-state-notes ()
11992 "Skip past the list of State notes in an entry."
11993 (if (looking-at "\n[ \t]*- State") (forward-char 1))
11994 (when (ignore-errors (goto-char (org-in-item-p)))
11995 (let* ((struct (org-list-struct))
11996 (prevs (org-list-prevs-alist struct)))
11997 (while (looking-at "[ \t]*- State")
11998 (goto-char (or (org-list-get-next-item (point) struct prevs)
11999 (org-list-get-item-end (point) struct)))))))
12001 (defun org-add-log-note (&optional purpose)
12002 "Pop up a window for taking a note, and add this note later at point."
12003 (remove-hook 'post-command-hook 'org-add-log-note)
12004 (setq org-log-note-window-configuration (current-window-configuration))
12005 (delete-other-windows)
12006 (move-marker org-log-note-return-to (point))
12007 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12008 (goto-char org-log-note-marker)
12009 (org-switch-to-buffer-other-window "*Org Note*")
12011 (if (memq org-log-note-how '(time state))
12012 (let (current-prefix-arg) (org-store-log-note))
12013 (let ((org-inhibit-startup t)) (org-mode))
12014 (insert (format "# Insert note for %s.
12015 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
12017 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12018 ((eq org-log-note-purpose 'done) "closed todo item")
12019 ((eq org-log-note-purpose 'state)
12020 (format "state change from \"%s\" to \"%s\""
12021 (or org-log-note-previous-state "")
12022 (or org-log-note-state "")))
12023 ((eq org-log-note-purpose 'reschedule)
12025 ((eq org-log-note-purpose 'delschedule)
12026 "no longer scheduled")
12027 ((eq org-log-note-purpose 'redeadline)
12028 "changing deadline")
12029 ((eq org-log-note-purpose 'deldeadline)
12030 "removing deadline")
12031 ((eq org-log-note-purpose 'refile)
12033 ((eq org-log-note-purpose 'note)
12035 (t (error "This should not happen")))))
12036 (if org-log-note-extra (insert org-log-note-extra))
12037 (org-set-local 'org-finish-function 'org-store-log-note)))
12039 (defvar org-note-abort nil) ; dynamically scoped
12040 (defun org-store-log-note ()
12041 "Finish taking a log note, and insert it to where it belongs."
12042 (let ((txt (buffer-string))
12043 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12045 (kill-buffer (current-buffer))
12046 (while (string-match "\\`#.*\n[ \t\n]*" txt)
12047 (setq txt (replace-match "" t t txt)))
12048 (if (string-match "\\s-+\\'" txt)
12049 (setq txt (replace-match "" t t txt)))
12050 (setq lines (org-split-string txt "\n"))
12051 (when (and note (string-match "\\S-" note))
12053 (org-replace-escapes
12055 (list (cons "%u" (user-login-name))
12056 (cons "%U" user-full-name)
12057 (cons "%t" (format-time-string
12058 (org-time-stamp-format 'long 'inactive)
12060 (cons "%T" (format-time-string
12061 (org-time-stamp-format 'long nil)
12063 (cons "%s" (if org-log-note-state
12064 (concat "\"" org-log-note-state "\"")
12066 (cons "%S" (if org-log-note-previous-state
12067 (concat "\"" org-log-note-previous-state "\"")
12069 (if lines (setq note (concat note " \\\\")))
12071 (when (or current-prefix-arg org-note-abort)
12072 (when org-log-into-drawer
12073 (org-remove-empty-drawer-at
12074 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12075 org-log-note-marker))
12078 (with-current-buffer (marker-buffer org-log-note-marker)
12080 (goto-char org-log-note-marker)
12081 (move-marker org-log-note-marker nil)
12083 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
12084 (setq ind (save-excursion
12085 (if (ignore-errors (goto-char (org-in-item-p)))
12086 (let ((struct (org-list-struct)))
12088 (org-list-get-top-point struct) struct))
12089 (skip-chars-backward " \r\t\n")
12091 ((and (org-at-heading-p)
12092 org-adapt-indentation)
12093 (1+ (org-current-level)))
12094 ((org-at-heading-p) 0)
12095 (t (org-get-indentation))))))
12096 (setq bul (org-list-bullet-string "-"))
12097 (org-indent-line-to ind)
12098 (insert bul (pop lines))
12099 (let ((ind-body (+ (length bul) ind)))
12102 (org-indent-line-to ind-body)
12103 (insert (pop lines))))
12104 (message "Note stored")
12105 (org-back-to-heading t)
12106 (org-cycle-hide-drawers 'children)))))
12107 (set-window-configuration org-log-note-window-configuration)
12108 (with-current-buffer (marker-buffer org-log-note-return-to)
12109 (goto-char org-log-note-return-to))
12110 (move-marker org-log-note-return-to nil)
12111 (and org-log-post-message (message "%s" org-log-post-message)))
12113 (defun org-remove-empty-drawer-at (drawer pos)
12114 "Remove an empty drawer DRAWER at position POS.
12115 POS may also be a marker."
12116 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12122 (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
12123 (replace-match ""))))))
12125 (defun org-sparse-tree (&optional arg)
12126 "Create a sparse tree, prompt for the details.
12127 This command can create sparse trees. You first need to select the type
12128 of match used to create the tree:
12130 t Show all TODO entries.
12131 T Show entries with a specific TODO keyword.
12132 m Show entries selected by a tags/property match.
12133 p Enter a property name and its value (both with completion on existing
12134 names/values) and show entries with that property.
12135 r Show entries matching a regular expression (`/' can be used as well)
12136 d Show deadlines due within `org-deadline-warning-days'.
12137 b Show deadlines and scheduled items before a date.
12138 a Show deadlines and scheduled items after a date."
12140 (let (ans kwd value)
12141 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12142 (setq ans (read-char-exclusive))
12145 (call-interactively 'org-check-deadlines))
12147 (call-interactively 'org-check-before-date))
12149 (call-interactively 'org-check-after-date))
12151 (org-show-todo-tree nil))
12153 (org-show-todo-tree '(4)))
12154 ((member ans '(?T ?m))
12155 (call-interactively 'org-match-sparse-tree))
12156 ((member ans '(?p ?P))
12157 (setq kwd (org-icompleting-read "Property: "
12158 (mapcar 'list (org-buffer-property-keys))))
12159 (setq value (org-icompleting-read "Value: "
12160 (mapcar 'list (org-property-values kwd))))
12161 (unless (string-match "\\`{.*}\\'" value)
12162 (setq value (concat "\"" value "\"")))
12163 (org-match-sparse-tree arg (concat kwd "=" value)))
12164 ((member ans '(?r ?R ?/))
12165 (call-interactively 'org-occur))
12166 (t (error "No such sparse tree command \"%c\"" ans)))))
12168 (defvar org-occur-highlights nil
12169 "List of overlays used for occur matches.")
12170 (make-variable-buffer-local 'org-occur-highlights)
12171 (defvar org-occur-parameters nil
12172 "Parameters of the active org-occur calls.
12173 This is a list, each call to org-occur pushes as cons cell,
12174 containing the regular expression and the callback, onto the list.
12175 The list can contain several entries if `org-occur' has been called
12176 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12177 will only contain one set of parameters. When the highlights are
12178 removed (for example with `C-c C-c', or with the next edit (depending
12179 on `org-remove-highlights-with-change'), this variable is emptied
12181 (make-variable-buffer-local 'org-occur-parameters)
12183 (defun org-occur (regexp &optional keep-previous callback)
12184 "Make a compact tree which shows all matches of REGEXP.
12185 The tree will show the lines where the regexp matches, and all higher
12186 headlines above the match. It will also show the heading after the match,
12187 to make sure editing the matching entry is easy.
12188 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12189 call to `org-occur' will be kept, to allow stacking of calls to this
12191 If CALLBACK is non-nil, it is a function which is called to confirm
12192 that the match should indeed be shown."
12193 (interactive "sRegexp: \nP")
12194 (when (equal regexp "")
12195 (error "Regexp cannot be empty"))
12196 (unless keep-previous
12197 (org-remove-occur-highlights nil nil t))
12198 (push (cons regexp callback) org-occur-parameters)
12201 (goto-char (point-min))
12202 (if (or (not keep-previous) ; do not want to keep
12203 (not org-occur-highlights)) ; no previous matches
12206 (while (re-search-forward regexp nil t)
12207 (when (or (not callback)
12208 (save-match-data (funcall callback)))
12209 (setq cnt (1+ cnt))
12210 (when org-highlight-sparse-tree-matches
12211 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12212 (org-show-context 'occur-tree))))
12213 (when org-remove-highlights-with-change
12214 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12216 (unless org-sparse-tree-open-archived-trees
12217 (org-hide-archived-subtrees (point-min) (point-max)))
12218 (run-hooks 'org-occur-hook)
12219 (if (org-called-interactively-p 'interactive)
12220 (message "%d match(es) for regexp %s" cnt regexp))
12223 (defun org-occur-next-match (&optional n reset)
12224 "Function for `next-error-function' to find sparse tree matches.
12225 N is the number of matches to move, when negative move backwards.
12226 RESET is entirely ignored - this function always goes back to the
12227 starting point when no match is found."
12228 (let* ((limit (if (< n 0) (point-min) (point-max)))
12229 (search-func (if (< n 0)
12230 'previous-single-char-property-change
12231 'next-single-char-property-change))
12236 (while (setq p1 (funcall search-func (point) 'org-type))
12237 (when (equal p1 limit)
12239 (error "No more matches"))
12240 (when (equal (get-char-property p1 'org-type) 'org-occur)
12244 (throw 'exit (point))))
12247 (error "No more matches"))))
12249 (defun org-show-context (&optional key)
12250 "Make sure point and context are visible.
12251 How much context is shown depends upon the variables
12252 `org-show-hierarchy-above', `org-show-following-heading'. and
12253 `org-show-siblings'."
12254 (let ((heading-p (org-on-heading-p t))
12255 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12256 (following-p (org-get-alist-option org-show-following-heading key))
12257 (entry-p (org-get-alist-option org-show-entry-below key))
12258 (siblings-p (org-get-alist-option org-show-siblings key)))
12260 ;; Show heading or entry text
12261 (if (and heading-p (not entry-p))
12262 (org-flag-heading nil) ; only show the heading
12263 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12264 (org-show-hidden-entry))) ; show entire entry
12266 ;; Show next sibling, or heading below text
12268 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12269 (org-flag-heading nil))))
12270 (when siblings-p (org-show-siblings))
12272 ;; show all higher headings, possibly with siblings
12274 (while (and (condition-case nil
12275 (progn (org-up-heading-all 1) t)
12278 (org-flag-heading nil)
12279 (when siblings-p (org-show-siblings))))))))
12281 (defvar org-reveal-start-hook nil
12282 "Hook run before revealing a location.")
12284 (defun org-reveal (&optional siblings)
12285 "Show current entry, hierarchy above it, and the following headline.
12286 This can be used to show a consistent set of context around locations
12287 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12288 not t for the search context.
12290 With optional argument SIBLINGS, on each level of the hierarchy all
12291 siblings are shown. This repairs the tree structure to what it would
12292 look like when opened with hierarchical calls to `org-cycle'.
12293 With double optional argument \\[universal-argument] \\[universal-argument], \
12294 go to the parent and show the
12297 (run-hooks 'org-reveal-start-hook)
12298 (let ((org-show-hierarchy-above t)
12299 (org-show-following-heading t)
12300 (org-show-siblings (if siblings t org-show-siblings)))
12301 (org-show-context nil))
12302 (when (equal siblings '(16))
12304 (when (org-up-heading-safe)
12306 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12308 (defun org-highlight-new-match (beg end)
12309 "Highlight from BEG to END and mark the highlight is an occur headline."
12310 (let ((ov (make-overlay beg end)))
12311 (overlay-put ov 'face 'secondary-selection)
12312 (overlay-put ov 'org-type 'org-occur)
12313 (push ov org-occur-highlights)))
12315 (defun org-remove-occur-highlights (&optional beg end noremove)
12316 "Remove the occur highlights from the buffer.
12317 BEG and END are ignored. If NOREMOVE is nil, remove this function
12318 from the `before-change-functions' in the current buffer."
12320 (unless org-inhibit-highlight-removal
12321 (mapc 'delete-overlay org-occur-highlights)
12322 (setq org-occur-highlights nil)
12323 (setq org-occur-parameters nil)
12325 (remove-hook 'before-change-functions
12326 'org-remove-occur-highlights 'local))))
12330 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
12331 "Regular expression matching the priority indicator.")
12333 (defvar org-remove-priority-next-time nil)
12335 (defun org-priority-up ()
12336 "Increase the priority of the current item."
12338 (org-priority 'up))
12340 (defun org-priority-down ()
12341 "Decrease the priority of the current item."
12343 (org-priority 'down))
12345 (defun org-priority (&optional action)
12346 "Change the priority of an item by ARG.
12347 ACTION can be `set', `up', `down', or a character."
12349 (unless org-enable-priority-commands
12350 (error "Priority commands are disabled"))
12351 (setq action (or action 'set))
12352 (let (current new news have remove)
12354 (org-back-to-heading t)
12355 (if (looking-at org-priority-regexp)
12356 (setq current (string-to-char (match-string 2))
12359 ((eq action 'remove)
12360 (setq remove t new ?\ ))
12361 ((or (eq action 'set)
12362 (if (featurep 'xemacs) (characterp action) (integerp action)))
12363 (if (not (eq action 'set))
12365 (message "Priority %c-%c, SPC to remove: "
12366 org-highest-priority org-lowest-priority)
12368 (setq new (read-char-exclusive))))
12369 (if (and (= (upcase org-highest-priority) org-highest-priority)
12370 (= (upcase org-lowest-priority) org-lowest-priority))
12371 (setq new (upcase new)))
12372 (cond ((equal new ?\ ) (setq remove t))
12373 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12374 (error "Priority must be between `%c' and `%c'"
12375 org-highest-priority org-lowest-priority))))
12378 (1- current) ; normal cycling
12379 ;; last priority was empty
12380 (if (eq last-command this-command)
12381 org-lowest-priority ; wrap around empty to lowest
12383 (if org-priority-start-cycle-with-default
12384 org-default-priority
12385 (1- org-default-priority))))))
12388 (1+ current) ; normal cycling
12389 ;; last priority was empty
12390 (if (eq last-command this-command)
12391 org-highest-priority ; wrap around empty to highest
12393 (if org-priority-start-cycle-with-default
12394 org-default-priority
12395 (1+ org-default-priority))))))
12396 (t (error "Invalid action")))
12397 (if (or (< (upcase new) org-highest-priority)
12398 (> (upcase new) org-lowest-priority))
12399 (if (and (memq action '(up down))
12400 (not have) (not (eq last-command this-command)))
12401 ;; `new' is from default priority
12403 "The default can not be set, see `org-default-priority' why")
12404 ;; normal cycling: `new' is beyond highest/lowest priority
12405 ;; and is wrapped around to the empty priority
12407 (setq news (format "%c" new))
12410 (replace-match "" t t nil 1)
12411 (replace-match news t t nil 2))
12413 (error "No priority cookie found in line")
12414 (let ((case-fold-search nil))
12415 (looking-at org-todo-line-regexp))
12418 (goto-char (match-end 2))
12419 (insert " [#" news "]"))
12420 (goto-char (match-beginning 3))
12421 (insert "[#" news "] "))))
12422 (org-preserve-lc (org-set-tags nil 'align)))
12424 (message "Priority removed")
12425 (message "Priority of current item set to %s" news))))
12427 (defun org-get-priority (s)
12428 "Find priority cookie and return priority."
12429 (if (functionp org-get-priority-function)
12430 (funcall org-get-priority-function)
12432 (if (not (string-match org-priority-regexp s))
12433 (* 1000 (- org-lowest-priority org-default-priority))
12434 (* 1000 (- org-lowest-priority
12435 (string-to-char (match-string 2 s))))))))
12439 (defvar org-agenda-archives-mode)
12440 (defvar org-map-continue-from nil
12441 "Position from where mapping should continue.
12442 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12444 (defvar org-scanner-tags nil
12445 "The current tag list while the tags scanner is running.")
12446 (defvar org-trust-scanner-tags nil
12447 "Should `org-get-tags-at' use the tags for the scanner.
12448 This is for internal dynamical scoping only.
12449 When this is non-nil, the function `org-get-tags-at' will return the value
12450 of `org-scanner-tags' instead of building the list by itself. This
12451 can lead to large speed-ups when the tags scanner is used in a file with
12452 many entries, and when the list of tags is retrieved, for example to
12453 obtain a list of properties. Building the tags list for each entry in such
12454 a file becomes an N^2 operation - but with this variable set, it scales
12457 (defun org-scan-tags (action matcher &optional todo-only)
12458 "Scan headline tags with inheritance and produce output ACTION.
12460 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12461 or `agenda' to produce an entry list for an agenda view. It can also be
12462 a Lisp form or a function that should be called at each matched headline, in
12463 this case the return value is a list of all return values from these calls.
12465 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12466 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12467 only lines with a TODO keyword are included in the output."
12468 (require 'org-agenda)
12469 (let* ((re (concat "^" org-outline-regexp " *\\(\\<\\("
12470 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
12472 "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
12473 (props (list 'face 'default
12474 'done-face 'org-agenda-done
12475 'undone-face 'default
12476 'mouse-face 'highlight
12477 'org-not-done-regexp org-not-done-regexp
12478 'org-todo-regexp org-todo-regexp
12480 (format "mouse-2 or RET jump to org file %s"
12481 (abbreviate-file-name
12482 (or (buffer-file-name (buffer-base-buffer))
12483 (buffer-name (buffer-base-buffer)))))))
12484 (case-fold-search nil)
12485 (org-map-continue-from nil)
12486 lspos tags tags-list
12487 (tags-alist (list (cons 0 org-file-tags)))
12488 (llast 0) rtn rtn1 level category i txt
12489 todo marker entry priority)
12490 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12491 (setq action (list 'lambda nil action)))
12493 (goto-char (point-min))
12494 (when (eq action 'sparse-tree)
12496 (org-remove-occur-highlights))
12497 (while (re-search-forward re nil t)
12499 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12500 tags (if (match-end 4) (org-match-string-no-properties 4)))
12501 (goto-char (setq lspos (match-beginning 0)))
12502 (setq level (org-reduced-level (funcall outline-level))
12503 category (org-get-category))
12504 (setq i llast llast level)
12505 ;; remove tag lists from same and sublevels
12506 (while (>= i level)
12507 (when (setq entry (assoc i tags-alist))
12508 (setq tags-alist (delete entry tags-alist)))
12510 ;; add the next tags
12512 (setq tags (org-split-string tags ":")
12514 (cons (cons level tags) tags-alist)))
12515 ;; compile tags for current headline
12517 (if org-use-tag-inheritance
12518 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12520 org-scanner-tags tags-list)
12521 (when org-use-tag-inheritance
12522 (setcdr (car tags-alist)
12523 (mapcar (lambda (x)
12524 (setq x (copy-sequence x))
12525 (org-add-prop-inherited x))
12526 (cdar tags-alist))))
12527 (when (and tags org-use-tag-inheritance
12528 (or (not (eq t org-use-tag-inheritance))
12529 org-tags-exclude-from-inheritance))
12530 ;; selective inheritance, remove uninherited ones
12531 (setcdr (car tags-alist)
12532 (org-remove-uninherited-tags (cdar tags-alist))))
12535 ;; eval matcher only when the todo condition is OK
12536 (and (or (not todo-only) (member todo org-not-done-keywords))
12537 (let ((case-fold-search t)) (eval matcher)))
12539 ;; Call the skipper, but return t if it does not skip,
12540 ;; so that the `and' form continues evaluating
12542 (unless (eq action 'sparse-tree) (org-agenda-skip))
12545 ;; Check if timestamps are deselecting this entry
12546 (or (not todo-only)
12547 (and (member todo org-not-done-keywords)
12548 (or (not org-agenda-tags-todo-honor-ignore-options)
12549 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12551 ;; Extra check for the archive tag
12552 ;; FIXME: Does the skipper already do this????
12554 (not (member org-archive-tag tags-list))
12555 ;; we have an archive tag, should we use this anyway?
12556 (or (not org-agenda-skip-archived-trees)
12557 (and (eq action 'agenda) org-agenda-archives-mode))))
12559 ;; select this headline
12562 ((eq action 'sparse-tree)
12563 (and org-highlight-sparse-tree-matches
12564 (org-get-heading) (match-end 0)
12565 (org-highlight-new-match
12566 (match-beginning 0) (match-beginning 1)))
12567 (org-show-context 'tags-tree))
12568 ((eq action 'agenda)
12569 (setq txt (org-format-agenda-item
12572 (if (eq org-tags-match-list-sublevels 'indented)
12573 (make-string (1- level) ?.) "")
12578 priority (org-get-priority txt))
12580 (setq marker (org-agenda-new-marker))
12581 (org-add-props txt props
12582 'org-marker marker 'org-hd-marker marker 'org-category category
12584 'priority priority 'type "tagsmatch")
12586 ((functionp action)
12587 (setq org-map-continue-from nil)
12589 (setq rtn1 (funcall action))
12591 (t (error "Invalid action")))
12593 ;; if we are to skip sublevels, jump to end of subtree
12594 (unless org-tags-match-list-sublevels
12595 (org-end-of-subtree t)
12596 (backward-char 1))))
12597 ;; Get the correct position from where to continue
12598 (if org-map-continue-from
12599 (goto-char org-map-continue-from)
12600 (and (= (point) lspos) (end-of-line 1)))))
12601 (when (and (eq action 'sparse-tree)
12602 (not org-sparse-tree-open-archived-trees))
12603 (org-hide-archived-subtrees (point-min) (point-max)))
12606 (defun org-remove-uninherited-tags (tags)
12607 "Remove all tags that are not inherited from the list TAGS."
12609 ((eq org-use-tag-inheritance t)
12610 (if org-tags-exclude-from-inheritance
12611 (org-delete-all org-tags-exclude-from-inheritance tags)
12613 ((not org-use-tag-inheritance) nil)
12614 ((stringp org-use-tag-inheritance)
12617 (if (and (string-match org-use-tag-inheritance x)
12618 (not (member x org-tags-exclude-from-inheritance)))
12621 ((listp org-use-tag-inheritance)
12624 (if (member x org-use-tag-inheritance) x nil))
12627 (defvar todo-only) ;; dynamically scoped
12629 (defun org-match-sparse-tree (&optional todo-only match)
12630 "Create a sparse tree according to tags string MATCH.
12631 MATCH can contain positive and negative selection of tags, like
12632 \"+WORK+URGENT-WITHBOSS\".
12633 If optional argument TODO-ONLY is non-nil, only select lines that are
12636 (org-prepare-agenda-buffers (list (current-buffer)))
12637 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12639 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12641 (defvar org-cached-props nil)
12642 (defun org-cached-entry-get (pom property)
12643 (if (or (eq t org-use-property-inheritance)
12644 (and (stringp org-use-property-inheritance)
12645 (string-match org-use-property-inheritance property))
12646 (and (listp org-use-property-inheritance)
12647 (member property org-use-property-inheritance)))
12648 ;; Caching is not possible, check it directly
12649 (org-entry-get pom property 'inherit)
12650 ;; Get all properties, so that we can do complicated checks easily
12651 (cdr (assoc property (or org-cached-props
12652 (setq org-cached-props
12653 (org-entry-properties pom)))))))
12655 (defun org-global-tags-completion-table (&optional files)
12656 "Return the list of all tags in all agenda buffer/files.
12657 Optional FILES argument is a list of files to which can be used
12658 instead of the agenda files."
12665 (set-buffer (find-file-noselect file))
12666 (append (org-get-buffer-tags)
12667 (mapcar (lambda (x) (if (stringp (car-safe x))
12668 (list (car-safe x)) nil))
12670 (if (and files (car files))
12672 (org-agenda-files))))))))
12674 (defun org-make-tags-matcher (match)
12675 "Create the TAGS/TODO matcher form for the selection string MATCH."
12676 ;; todo-only is scoped dynamically into this function, and the function
12677 ;; may change it if the matcher asks for it.
12679 ;; Get a new match request, with completion
12680 (let ((org-last-tags-completion-table
12681 (org-global-tags-completion-table)))
12682 (setq match (org-completing-read-no-i
12683 "Match: " 'org-tags-completion-function nil nil nil
12684 'org-tags-history))))
12686 ;; Parse the string and create a lisp form
12687 (let ((match0 match)
12688 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12690 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12691 orterms term orlist re-p str-p level-p level-op time-p
12692 prop-p pn pv po gv rest)
12693 (if (string-match "/+" match)
12694 ;; match contains also a todo-matching request
12696 (setq tagsmatch (substring match 0 (match-beginning 0))
12697 todomatch (substring match (match-end 0)))
12698 (if (string-match "^!" todomatch)
12699 (setq todo-only t todomatch (substring todomatch 1)))
12700 (if (string-match "^\\s-*$" todomatch)
12701 (setq todomatch nil)))
12702 ;; only matching tags
12703 (setq tagsmatch match todomatch nil))
12705 ;; Make the tags matcher
12706 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
12707 (setq tagsmatcher t)
12708 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12709 (while (setq term (pop orterms))
12710 (while (and (equal (substring term -1) "\\") orterms)
12711 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12712 (while (string-match re term)
12713 (setq rest (substring term (match-end 0))
12714 minus (and (match-end 1)
12715 (equal (match-string 1 term) "-"))
12716 tag (save-match-data (replace-regexp-in-string
12718 (match-string 2 term)))
12719 re-p (equal (string-to-char tag) ?{)
12720 level-p (match-end 4)
12721 prop-p (match-end 5)
12723 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12725 (setq level-op (org-op-to-function (match-string 3 term)))
12726 `(,level-op level ,(string-to-number
12727 (match-string 4 term))))
12729 (setq pn (match-string 5 term)
12730 po (match-string 6 term)
12731 pv (match-string 7 term)
12732 re-p (equal (string-to-char pv) ?{)
12733 str-p (equal (string-to-char pv) ?\")
12734 time-p (save-match-data
12735 (string-match "^\"[[<].*[]>]\"$" pv))
12736 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12737 (if time-p (setq pv (org-matcher-time pv)))
12738 (setq po (org-op-to-function po (if time-p 'time str-p)))
12740 ((equal pn "CATEGORY")
12741 (setq gv '(get-text-property (point) 'org-category)))
12745 (setq gv `(org-cached-entry-get nil ,pn))))
12748 `(not (string-match ,pv (or ,gv "")))
12749 `(string-match ,pv (or ,gv "")))
12751 `(,po (or ,gv "") ,pv)
12752 `(,po (string-to-number (or ,gv ""))
12753 ,(string-to-number pv) ))))
12754 (t `(member ,tag tags-list)))
12755 mm (if minus (list 'not mm) mm)
12757 (push mm tagsmatcher))
12758 (push (if (> (length tagsmatcher) 1)
12759 (cons 'and tagsmatcher)
12762 (setq tagsmatcher nil))
12763 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12765 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12766 ;; Make the todo matcher
12767 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
12768 (setq todomatcher t)
12769 (setq orterms (org-split-string todomatch "|") orlist nil)
12770 (while (setq term (pop orterms))
12771 (while (string-match re term)
12772 (setq minus (and (match-end 1)
12773 (equal (match-string 1 term) "-"))
12774 kwd (match-string 2 term)
12775 re-p (equal (string-to-char kwd) ?{)
12776 term (substring term (match-end 0))
12778 `(string-match ,(substring kwd 1 -1) todo)
12779 (list 'equal 'todo kwd))
12780 mm (if minus (list 'not mm) mm))
12781 (push mm todomatcher))
12782 (push (if (> (length todomatcher) 1)
12783 (cons 'and todomatcher)
12786 (setq todomatcher nil))
12787 (setq todomatcher (if (> (length orlist) 1)
12788 (cons 'or orlist) (car orlist))))
12790 ;; Return the string and lisp forms of the matcher
12791 (setq matcher (if todomatcher
12792 (list 'and tagsmatcher todomatcher)
12794 (cons match0 matcher)))
12796 (defun org-op-to-function (op &optional stringp)
12797 "Turn an operator into the appropriate function."
12800 ((equal op "<" ) '(< string< org-time<))
12801 ((equal op ">" ) '(> org-string> org-time>))
12802 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12803 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12804 ((member op '("=" "==")) '(= string= org-time=))
12805 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12806 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12808 (defun org<> (a b) (not (= a b)))
12809 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12810 (defun org-string>= (a b) (not (string< a b)))
12811 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12812 (defun org-string<> (a b) (not (string= a b)))
12813 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12814 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12815 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12816 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12817 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12818 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12820 "Convert S to a floating point time.
12821 If S is already a number, just return it. If it is a string, parse
12822 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12826 (condition-case nil
12827 (float-time (apply 'encode-time (org-parse-time-string s)))
12831 (defun org-time-today ()
12832 "Time in seconds today at 0:00.
12833 Returns the float number of seconds since the beginning of the
12834 epoch to the beginning of today (00:00)."
12835 (float-time (apply 'encode-time
12836 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12838 (defun org-matcher-time (s)
12839 "Interpret a time comparison value."
12842 ((string= s "<now>") (float-time))
12843 ((string= s "<today>") (org-time-today))
12844 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12845 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12846 ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
12847 (+ (org-time-today)
12848 (* (string-to-number (match-string 1 s))
12849 (cdr (assoc (match-string 2 s)
12850 '(("d" . 86400.0) ("w" . 604800.0)
12851 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12854 (defun org-match-any-p (re list)
12855 "Does re match any element of list?"
12856 (setq list (mapcar (lambda (x) (string-match re x)) list))
12859 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12860 (defvar org-tags-overlay (make-overlay 1 1))
12861 (org-detach-overlay org-tags-overlay)
12863 (defun org-get-local-tags-at (&optional pos)
12864 "Get a list of tags defined in the current headline."
12865 (org-get-tags-at pos 'local))
12867 (defun org-get-local-tags ()
12868 "Get a list of tags defined in the current headline."
12869 (org-get-tags-at nil 'local))
12871 (defun org-get-tags-at (&optional pos local)
12872 "Get a list of all headline tags applicable at POS.
12873 POS defaults to point. If tags are inherited, the list contains
12874 the targets in the same sequence as the headlines appear, i.e.
12875 the tags of the current headline come last.
12876 When LOCAL is non-nil, only return tags from the current headline,
12877 ignore inherited ones."
12879 (if (and org-trust-scanner-tags
12880 (or (not pos) (equal pos (point)))
12883 (let (tags ltags lastpos parent)
12887 (goto-char (or pos (point)))
12890 (condition-case nil
12892 (org-back-to-heading t)
12893 (while (not (equal lastpos (point)))
12894 (setq lastpos (point))
12896 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
12897 (setq ltags (org-split-string
12898 (org-match-string-no-properties 1) ":"))
12900 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12903 (org-remove-uninherited-tags ltags)
12906 (or org-use-tag-inheritance (throw 'done t))
12907 (if local (throw 'done t))
12908 (or (org-up-heading-safe) (error nil))
12913 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12915 (defun org-add-prop-inherited (s)
12916 (add-text-properties 0 (length s) '(inherited t) s)
12919 (defun org-toggle-tag (tag &optional onoff)
12920 "Toggle the tag TAG for the current line.
12921 If ONOFF is `on' or `off', don't toggle but set to this state."
12924 (org-back-to-heading t)
12925 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
12928 (setq current (match-string 1))
12929 (replace-match ""))
12931 (setq current (nreverse (org-split-string current ":")))
12935 (or (member tag current) (push tag current)))
12937 (or (not (member tag current)) (setq current (delete tag current))))
12938 (t (if (member tag current)
12939 (setq current (delete tag current))
12941 (push tag current))))
12945 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12946 (org-set-tags nil t))
12947 (delete-horizontal-space))
12948 (run-hooks 'org-after-tags-change-hook))
12951 (defun org-align-tags-here (to-col)
12952 ;; Assumes that this is a headline
12953 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12954 (beginning-of-line 1)
12955 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
12956 (< pos (match-beginning 2)))
12958 (setq tags-l (- (match-end 2) (match-beginning 2)))
12959 (goto-char (match-beginning 1))
12961 (delete-region (point) (1+ (match-beginning 2)))
12962 (setq ncol (max (1+ (current-column))
12966 (- (abs to-col) tags-l))))
12968 (insert (make-string (- ncol (current-column)) ?\ ))
12969 (setq ncol (current-column))
12970 (when indent-tabs-mode (tabify p (point-at-eol)))
12971 (org-move-to-column (min ncol col) t))
12974 (defun org-set-tags-command (&optional arg just-align)
12975 "Call the set-tags command for the current entry."
12977 (if (org-on-heading-p)
12978 (org-set-tags arg just-align)
12980 (org-back-to-heading t)
12981 (org-set-tags arg just-align))))
12983 (defun org-set-tags-to (data)
12984 "Set the tags of the current entry to DATA, replacing the current tags.
12985 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12986 If DATA is nil or the empty string, any tags will be removed."
12987 (interactive "sTags: ")
12991 ((equal data "") "")
12993 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12996 (concat ":" (mapconcat 'identity data ":") ":"))
13000 (org-back-to-heading t)
13001 (when (looking-at org-complex-heading-regexp)
13004 (goto-char (match-beginning 5))
13006 (delete-region (point) (point-at-eol))
13007 (org-set-tags nil 'align))
13008 (goto-char (point-at-eol))
13010 (org-set-tags nil 'align)))
13011 (beginning-of-line 1)
13012 (if (looking-at ".*?\\([ \t]+\\)$")
13013 (delete-region (match-beginning 1) (match-end 1))))))
13015 (defun org-align-all-tags ()
13016 "Align the tags i all headings."
13019 (or (ignore-errors (org-back-to-heading t))
13020 (outline-next-heading))
13021 (if (org-on-heading-p)
13023 (message "No headings"))))
13025 (defvar org-indent-indentation-per-level)
13026 (defun org-set-tags (&optional arg just-align)
13027 "Set the tags for the current headline.
13028 With prefix ARG, realign all tags in headings in the current buffer."
13030 (let* ((re org-outline-regexp-bol)
13031 (current (org-get-tags-string))
13032 (col (current-column))
13033 (org-setting-tags t)
13034 table current-tags inherited-tags ; computed below when needed
13035 tags p0 c0 c1 rpl di tc level)
13038 (goto-char (point-min))
13039 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13040 (while (re-search-forward re nil t)
13041 (org-set-tags nil t)
13043 (message "All tags realigned to column %d" org-tags-column))
13045 (setq tags current)
13046 ;; Get a new set of tags from the user
13048 (setq table (append org-tag-persistent-alist
13049 (or org-tag-alist (org-get-buffer-tags))
13051 org-complete-tags-always-offer-all-agenda-tags
13052 (org-global-tags-completion-table
13053 (org-agenda-files))))
13054 org-last-tags-completion-table table
13055 current-tags (org-split-string current ":")
13056 inherited-tags (nreverse
13057 (nthcdr (length current-tags)
13058 (nreverse (org-get-tags-at))))
13060 (if (or (eq t org-use-fast-tag-selection)
13061 (and org-use-fast-tag-selection
13062 (delq nil (mapcar 'cdr table))))
13063 (org-fast-tag-selection
13064 current-tags inherited-tags table
13065 (if org-fast-tag-selection-include-todo
13066 org-todo-key-alist))
13067 (let ((org-add-colon-after-tag-completion t))
13069 (org-icompleting-read "Tags: "
13070 'org-tags-completion-function
13071 nil nil current 'org-tags-history))))))
13072 (while (string-match "[-+&]+" tags)
13073 ;; No boolean logic, just a list
13074 (setq tags (replace-match ":" t t tags))))
13076 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13078 (if org-tags-sort-function
13079 (setq tags (mapconcat 'identity
13080 (sort (org-split-string
13081 tags (org-re "[^[:alnum:]_@#%]+"))
13082 org-tags-sort-function) ":")))
13084 (if (string-match "\\`[\t ]*\\'" tags)
13086 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13087 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13089 ;; Insert new tags at the correct column
13090 (beginning-of-line 1)
13091 (setq level (or (and (looking-at org-outline-regexp)
13092 (- (match-end 0) (point) 1))
13095 ((and (equal current "") (equal tags "")))
13096 ((re-search-forward
13097 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
13099 (if (equal tags "")
13101 (goto-char (match-beginning 0))
13102 (setq c0 (current-column)
13103 ;; compute offset for the case of org-indent-mode active
13104 di (if org-indent-mode
13105 (* (1- org-indent-indentation-per-level) (1- level))
13107 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13108 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13109 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13110 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13111 (replace-match rpl t t)
13112 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13114 (t (error "Tags alignment failed")))
13115 (org-move-to-column col)
13117 (run-hooks 'org-after-tags-change-hook)))))
13119 (defun org-change-tag-in-region (beg end tag off)
13120 "Add or remove TAG for each entry in the region.
13121 This works in the agenda, and also in an org-mode buffer."
13123 (list (region-beginning) (region-end)
13124 (let ((org-last-tags-completion-table
13126 (org-get-buffer-tags)
13127 (org-global-tags-completion-table))))
13128 (org-icompleting-read
13129 "Tag: " 'org-tags-completion-function nil nil nil
13130 'org-tags-history))
13132 (message "[s]et or
[r]emove? ")
13133 (equal (read-char-exclusive) ?r))))
13134 (if (fboundp 'deactivate-mark) (deactivate-mark))
13135 (let ((agendap (equal major-mode 'org-agenda-mode))
13136 l1 l2 m buf pos newhead (cnt 0))
13138 (setq l2 (1- (org-current-line)))
13140 (setq l1 (org-current-line))
13141 (loop for l from l1 to l2 do
13143 (setq m (get-text-property (point) 'org-hd-marker))
13144 (when (or (and (org-mode-p) (org-on-heading-p))
13146 (setq buf (if agendap (marker-buffer m) (current-buffer))
13147 pos (if agendap m (point)))
13148 (with-current-buffer buf
13152 (setq cnt (1+ cnt))
13153 (org-toggle-tag tag (if off 'off 'on))
13154 (setq newhead (org-get-heading)))))
13155 (and agendap (org-agenda-change-all-lines newhead m))))
13156 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13158 (defun org-tags-completion-function (string predicate &optional flag)
13159 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13160 (confirm (lambda (x) (stringp (car x)))))
13161 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
13162 (setq s1 (match-string 1 string)
13163 s2 (match-string 2 string))
13164 (setq s1 "" s2 string))
13168 (setq rtn (try-completion s2 ctable confirm))
13171 (concat s1 s2 (substring rtn (length s2))
13172 (if (and org-add-colon-after-tag-completion
13173 (assoc rtn ctable))
13178 (all-completions s2 ctable confirm)
13182 (assoc s2 ctable)))
13185 (defun org-fast-tag-insert (kwd tags face &optional end)
13186 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13187 (insert (format "%-12s" (concat kwd ":"))
13188 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13191 (defun org-fast-tag-show-exit (flag)
13194 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
13195 (replace-match ""))
13198 (org-move-to-column (- (window-width) 19) t)
13199 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13201 (defun org-set-current-tags-overlay (current prefix)
13202 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13203 (if (featurep 'xemacs)
13204 (org-overlay-display org-tags-overlay (concat prefix s)
13205 'secondary-selection)
13206 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13207 (org-overlay-display org-tags-overlay (concat prefix s)))))
13209 (defvar org-last-tag-selection-key nil)
13210 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13211 "Fast tag selection with single keys.
13212 CURRENT is the current list of tags in the headline, INHERITED is the
13213 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13214 possibly with grouping information. TODO-TABLE is a similar table with
13215 TODO keywords, should these have keys assigned to them.
13216 If the keys are nil, a-z are automatically assigned.
13217 Returns the new tags string, or nil to not change the current settings."
13218 (let* ((fulltable (append table todo-table))
13219 (maxlen (apply 'max (mapcar
13221 (if (stringp (car x)) (string-width (car x)) 0))
13223 (buf (current-buffer))
13224 (expert (eq org-fast-tag-selection-single-key 'expert))
13226 (fwidth (+ maxlen 3 1 3))
13227 (ncol (/ (- (window-width) 4) fwidth))
13230 tg cnt e c char c1 c2 ntable tbl rtn
13231 ov-start ov-end ov-prefix
13232 (exit-after-next org-fast-tag-selection-single-key)
13233 (done-keywords org-done-keywords)
13236 (beginning-of-line 1)
13238 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
13239 (setq ov-start (match-beginning 1)
13240 ov-end (match-end 1)
13242 (setq ov-start (1- (point-at-eol))
13243 ov-end (1+ ov-start))
13244 (skip-chars-forward "^\n\r")
13247 (buffer-substring (1- (point)) (point))
13248 (if (> (current-column) org-tags-column)
13250 (make-string (- org-tags-column (current-column)) ?\ ))))))
13251 (move-overlay org-tags-overlay ov-start ov-end)
13252 (save-window-excursion
13254 (set-buffer (get-buffer-create " *Org tags*"))
13255 (delete-other-windows)
13256 (split-window-vertically)
13257 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13259 (org-set-local 'org-done-keywords done-keywords)
13260 (org-fast-tag-insert "Inherited" inherited i-face "\n")
13261 (org-fast-tag-insert "Current" current c-face "\n\n")
13262 (org-fast-tag-show-exit exit-after-next)
13263 (org-set-current-tags-overlay current ov-prefix)
13264 (setq tbl fulltable char ?a cnt 0)
13265 (while (setq e (pop tbl))
13267 ((equal (car e) :startgroup)
13268 (push '() groups) (setq ingroup t)
13269 (when (not (= cnt 0))
13272 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13273 ((equal (car e) :endgroup)
13274 (setq ingroup nil cnt 0)
13275 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
13276 ((equal e '(:newline))
13277 (when (not (= cnt 0))
13281 (while (equal (car tbl) '(:newline))
13283 (setq tbl (cdr tbl)))))
13285 (setq tg (copy-sequence (car e)) c2 nil)
13288 ;; automatically assign a character.
13289 (setq c1 (string-to-char
13290 (downcase (substring
13291 tg (if (= (string-to-char tg) ?@) 1 0)))))
13292 (if (or (rassoc c1 ntable) (rassoc c1 table))
13293 (while (or (rassoc char ntable) (rassoc char table))
13294 (setq char (1+ char)))
13296 (setq c (or c2 char)))
13297 (if ingroup (push tg (car groups)))
13298 (setq tg (org-add-props tg nil 'face
13300 ((not (assoc tg table))
13301 (org-get-todo-face tg))
13302 ((member tg current) c-face)
13303 ((member tg inherited) i-face)
13305 (if (and (= cnt 0) (not ingroup)) (insert " "))
13306 (insert "[" c "] " tg (make-string
13307 (- fwidth 4 (length tg)) ?\ ))
13308 (push (cons tg c) ntable)
13309 (when (= (setq cnt (1+ cnt)) ncol)
13311 (if ingroup (insert " "))
13313 (setq ntable (nreverse ntable))
13315 (goto-char (point-min))
13316 (if (not expert) (org-fit-window-to-buffer))
13320 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13321 (if (not groups) "no " "")
13322 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13323 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13324 (setq org-last-tag-selection-key c)
13326 ((= c ?\r) (throw 'exit t))
13328 (setq groups (not groups))
13329 (goto-char (point-min))
13330 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13333 (org-fast-tag-show-exit
13334 (setq exit-after-next (not exit-after-next)))
13336 (delete-other-windows)
13337 (set-window-buffer (split-window-vertically) " *Org tags*")
13338 (org-switch-to-buffer-other-window " *Org tags*")
13339 (org-fit-window-to-buffer)))
13341 (and (= c ?q) (not (rassoc c ntable))))
13342 (org-detach-overlay org-tags-overlay)
13343 (setq quit-flag t))
13346 (if exit-after-next (setq exit-after-next 'now)))
13348 (condition-case nil
13349 (setq tg (org-icompleting-read
13352 (with-current-buffer buf
13353 (org-get-buffer-tags)))))
13354 (quit (setq tg "")))
13355 (when (string-match "\\S-" tg)
13356 (add-to-list 'buffer-tags (list tg))
13357 (if (member tg current)
13358 (setq current (delete tg current))
13359 (push tg current)))
13360 (if exit-after-next (setq exit-after-next 'now)))
13361 ((setq e (rassoc c todo-table) tg (car e))
13362 (with-current-buffer buf
13363 (save-excursion (org-todo tg)))
13364 (if exit-after-next (setq exit-after-next 'now)))
13365 ((setq e (rassoc c ntable) tg (car e))
13366 (if (member tg current)
13367 (setq current (delete tg current))
13368 (loop for g in groups do
13371 (setq current (delete x current)))
13374 (if exit-after-next (setq exit-after-next 'now))))
13376 ;; Create a sorted list
13380 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13381 (if (eq exit-after-next 'now) (throw 'exit t))
13382 (goto-char (point-min))
13383 (beginning-of-line 2)
13384 (delete-region (point) (point-at-eol))
13385 (org-fast-tag-insert "Current" current c-face)
13386 (org-set-current-tags-overlay current ov-prefix)
13387 (while (re-search-forward
13388 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
13389 (setq tg (match-string 1))
13390 (add-text-properties
13391 (match-beginning 1) (match-end 1)
13394 ((member tg current) c-face)
13395 ((member tg inherited) i-face)
13396 (t (get-text-property (match-beginning 1) 'face))))))
13397 (goto-char (point-min)))))
13398 (org-detach-overlay org-tags-overlay)
13400 (mapconcat 'identity current ":")
13403 (defun org-get-tags-string ()
13404 "Get the TAGS string in the current headline."
13405 (unless (org-on-heading-p t)
13406 (error "Not on a heading"))
13408 (beginning-of-line 1)
13409 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
13410 (org-match-string-no-properties 1)
13413 (defun org-get-tags ()
13414 "Get the list of tags specified in the current headline."
13415 (org-split-string (org-get-tags-string) ":"))
13417 (defun org-get-buffer-tags ()
13418 "Get a table of all tags used in the buffer, for completion."
13421 (goto-char (point-min))
13422 (while (re-search-forward
13423 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
13424 (when (equal (char-after (point-at-bol 0)) ?*)
13425 (mapc (lambda (x) (add-to-list 'tags x))
13426 (org-split-string (org-match-string-no-properties 1) ":")))))
13427 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13428 (mapcar 'list tags)))
13430 ;;;; The mapping API
13433 (defun org-map-entries (func &optional match scope &rest skip)
13434 "Call FUNC at each headline selected by MATCH in SCOPE.
13436 FUNC is a function or a lisp form. The function will be called without
13437 arguments, with the cursor positioned at the beginning of the headline.
13438 The return values of all calls to the function will be collected and
13439 returned as a list.
13441 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13442 does not need to preserve point. After evaluation, the cursor will be
13443 moved to the end of the line (presumably of the headline of the
13444 processed entry) and search continues from there. Under some
13445 circumstances, this may not produce the wanted results. For example,
13446 if you have removed (e.g. archived) the current (sub)tree it could
13447 mean that the next entry will be skipped entirely. In such cases, you
13448 can specify the position from where search should continue by making
13449 FUNC set the variable `org-map-continue-from' to the desired buffer
13452 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13453 Only headlines that are matched by this query will be considered during
13454 the iteration. When MATCH is nil or t, all headlines will be
13455 visited by the iteration.
13457 SCOPE determines the scope of this command. It can be any of:
13459 nil The current buffer, respecting the restriction if any
13460 tree The subtree started with the entry at point
13461 file The current buffer, without restriction
13463 The current buffer, and any archives associated with it
13464 agenda All agenda files
13465 agenda-with-archives
13466 All agenda files with any archive files associated with them
13468 If this is a list, all files in the list will be scanned
13470 The remaining args are treated as settings for the skipping facilities of
13471 the scanner. The following items can be given here:
13473 archive skip trees with the archive tag.
13474 comment skip trees with the COMMENT keyword
13475 function or Emacs Lisp form:
13476 will be used as value for `org-agenda-skip-function', so whenever
13477 the function returns t, FUNC will not be called for that
13478 entry and search will continue from the point where the
13479 function leaves it.
13481 If your function needs to retrieve the tags including inherited tags
13482 at the *current* entry, you can use the value of the variable
13483 `org-scanner-tags' which will be much faster than getting the value
13484 with `org-get-tags-at'. If your function gets properties with
13485 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13486 to t around the call to `org-entry-properties' to get the same speedup.
13487 Note that if your function moves around to retrieve tags and properties at
13488 a *different* entry, you cannot use these techniques."
13489 (let* ((org-agenda-archives-mode nil) ; just to make sure
13490 (org-agenda-skip-archived-trees (memq 'archive skip))
13491 (org-agenda-skip-comment-trees (memq 'comment skip))
13492 (org-agenda-skip-function
13493 (car (org-delete-all '(comment archive) skip)))
13494 (org-tags-match-list-sublevels t)
13496 org-todo-keywords-for-agenda
13497 org-done-keywords-for-agenda
13498 org-todo-keyword-alist-for-agenda
13499 org-drawers-for-agenda
13500 org-tag-alist-for-agenda)
13503 ((eq match t) (setq matcher t))
13504 ((eq match nil) (setq matcher t))
13505 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13509 (when (eq scope 'tree)
13510 (org-back-to-heading t)
13511 (org-narrow-to-subtree)
13516 (org-prepare-agenda-buffers
13517 (list (buffer-file-name (current-buffer))))
13518 (setq res (org-scan-tags func matcher)))
13519 ;; Get the right scope
13521 ((and scope (listp scope) (symbolp (car scope)))
13522 (setq scope (eval scope)))
13523 ((eq scope 'agenda)
13524 (setq scope (org-agenda-files t)))
13525 ((eq scope 'agenda-with-archives)
13526 (setq scope (org-agenda-files t))
13527 (setq scope (org-add-archive-files scope)))
13529 (setq scope (list (buffer-file-name))))
13530 ((eq scope 'file-with-archives)
13531 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13532 (org-prepare-agenda-buffers scope)
13533 (while (setq file (pop scope))
13534 (with-current-buffer (org-find-base-buffer-visiting file)
13538 (goto-char (point-min))
13539 (setq res (append res (org-scan-tags func matcher))))))))))
13544 ;;; Setting and retrieving properties
13546 (defconst org-special-properties
13547 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13548 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13549 "The special properties valid in Org-mode.
13551 These are properties that are not defined in the property drawer,
13552 but in some other way.")
13554 (defconst org-default-properties
13555 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13556 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13557 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13558 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13559 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13560 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13561 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13562 "Some properties that are used by Org-mode for various purposes.
13563 Being in this list makes sure that they are offered for completion.")
13565 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
13566 "Regular expression matching the first line of a property drawer.")
13568 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
13569 "Regular expression matching the last line of a property drawer.")
13571 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
13572 "Regular expression matching the first line of a property drawer.")
13574 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
13575 "Regular expression matching the first line of a property drawer.")
13577 (defconst org-property-drawer-re
13578 (concat "\\(" org-property-start-re "\\)[^\000]*\\("
13579 org-property-end-re "\\)\n?")
13580 "Matches an entire property drawer.")
13582 (defconst org-clock-drawer-re
13583 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
13584 org-property-end-re "\\)\n?")
13585 "Matches an entire clock drawer.")
13587 (defsubst org-re-property (property)
13588 "Return a regexp matching PROPERTY.
13589 Match group 1 will be set to the value "
13590 (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
13592 (defun org-property-action ()
13593 "Do an action on properties."
13596 (org-at-property-p)
13597 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13598 (setq c (read-char-exclusive))
13601 (call-interactively 'org-set-property))
13603 (call-interactively 'org-delete-property))
13605 (call-interactively 'org-delete-property-globally))
13607 (call-interactively 'org-compute-property-at-point))
13608 (t (error "No such property action %c" c)))))
13610 (defun org-set-effort (&optional value)
13611 "Set the effort property of the current entry.
13612 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13615 (if (equal value 0) (setq value 10))
13616 (let* ((completion-ignore-case t)
13617 (prop org-effort-property)
13618 (cur (org-entry-get nil prop))
13619 (allowed (org-property-get-allowed-values nil prop 'table))
13620 (existing (mapcar 'list (org-property-values prop)))
13623 ((stringp value) value)
13624 ((and allowed (integerp value))
13625 (or (car (nth (1- value) allowed))
13626 (car (org-last allowed))))
13628 (message "Select 1-9,0, [RET%s]: %s"
13629 (if cur (concat "=" cur) "")
13630 (mapconcat 'car allowed " "))
13631 (setq rpl (read-char-exclusive))
13632 (if (equal rpl ?\r)
13634 (setq rpl (- rpl ?0))
13635 (if (equal rpl 0) (setq rpl 10))
13636 (if (and (> rpl 0) (<= rpl (length allowed)))
13637 (car (nth (1- rpl) allowed))
13638 (org-completing-read "Effort: " allowed nil))))
13640 (let (org-completion-use-ido org-completion-use-iswitchb)
13641 (org-completing-read
13642 (concat "Effort " (if (and cur (string-match "\\S-" cur))
13643 (concat "[" cur "]") "")
13645 existing nil nil "" nil cur))))))
13646 (unless (equal (org-entry-get nil prop) val)
13647 (org-entry-put nil prop val))
13648 (message "%s is now %s" prop val)))
13650 (defun org-at-property-p ()
13651 "Is cursor inside a property drawer?"
13653 (beginning-of-line 1)
13654 (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
13655 (save-match-data ;; Used by calling procedures
13657 (range (unless (org-before-first-heading-p)
13658 (org-get-property-block))))
13659 (and range (<= (car range) p) (< p (cdr range))))))))
13661 (defun org-get-property-block (&optional beg end force)
13662 "Return the (beg . end) range of the body of the property drawer.
13663 BEG and END can be beginning and end of subtree, if not given
13664 they will be found.
13665 If the drawer does not exist and FORCE is non-nil, create the drawer."
13668 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13669 (end (or end (progn (outline-next-heading) (point)))))
13671 (if (re-search-forward org-property-start-re end t)
13672 (setq beg (1+ (match-end 0)))
13675 (org-insert-property-drawer)
13676 (setq end (progn (outline-next-heading) (point))))
13679 (if (re-search-forward org-property-start-re end t)
13680 (setq beg (1+ (match-end 0)))))
13681 (if (re-search-forward org-property-end-re end t)
13682 (setq end (match-beginning 0))
13683 (or force (throw 'exit nil))
13686 (org-indent-line-function)
13687 (insert ":END:\n"))
13690 (defun org-entry-properties (&optional pom which specific)
13691 "Get all properties of the entry at point-or-marker POM.
13692 This includes the TODO keyword, the tags, time strings for deadline,
13693 scheduled, and clocking, and any additional properties defined in the
13694 entry. The return value is an alist, keys may occur multiple times
13695 if the property key was used several times.
13696 POM may also be nil, in which case the current entry is used.
13697 If WHICH is nil or `all', get all properties. If WHICH is
13698 `special' or `standard', only get that subclass. If WHICH
13699 is a string only get exactly this property. SPECIFIC can be a string, the
13700 specific property we are interested in. Specifying it can speed
13701 things up because then unnecessary parsing is avoided."
13702 (setq which (or which 'all))
13703 (org-with-point-at pom
13704 (let ((clockstr (substring org-clock-string 0 -1))
13705 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13706 (case-fold-search nil)
13707 beg end range props sum-props key key1 value string clocksum)
13709 (when (condition-case nil
13710 (and (org-mode-p) (org-back-to-heading t))
13713 (setq sum-props (get-text-property (point) 'org-summaries))
13714 (setq clocksum (get-text-property (point) :org-clock-minutes))
13715 (outline-next-heading)
13717 (when (memq which '(all special))
13718 ;; Get the special properties, like TODO and tags
13720 (when (and (or (not specific) (string= specific "TODO"))
13721 (looking-at org-todo-line-regexp) (match-end 2))
13722 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13723 (when (and (or (not specific) (string= specific "PRIORITY"))
13724 (looking-at org-priority-regexp))
13725 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13726 (when (or (not specific) (string= specific "FILE"))
13727 (push (cons "FILE" buffer-file-name) props))
13728 (when (and (or (not specific) (string= specific "TAGS"))
13729 (setq value (org-get-tags-string))
13730 (string-match "\\S-" value))
13731 (push (cons "TAGS" value) props))
13732 (when (and (or (not specific) (string= specific "ALLTAGS"))
13733 (setq value (org-get-tags-at)))
13734 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13737 (when (or (not specific) (string= specific "BLOCKED"))
13738 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13739 (when (or (not specific)
13741 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13742 "TIMESTAMP" "TIMESTAMP_IA")))
13744 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13745 (setq key (if (match-end 1)
13746 (substring (org-match-string-no-properties 1)
13748 string (if (equal key clockstr)
13752 (match-beginning 3) (goto-char
13754 (substring (org-match-string-no-properties 3)
13756 ;; Get the correct property name from the key. This is
13757 ;; necessary if the user has configured time keywords.
13758 (setq key1 (concat key ":"))
13762 (if (= (char-after (match-beginning 3)) ?\[)
13763 "TIMESTAMP_IA" "TIMESTAMP")))
13764 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13765 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13766 ((equal key1 org-closed-string) (setq key "CLOSED"))
13767 ((equal key1 org-clock-string) (setq key "CLOCK")))
13768 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13770 (push (cons key string) props)
13771 ;; no need to search further if match is found
13773 (when (or (equal key "CLOCK") (not (assoc key props)))
13774 (push (cons key string) props))))))
13777 (when (memq which '(all standard))
13778 ;; Get the standard properties, like :PROP: ...
13779 (setq range (org-get-property-block beg end))
13781 (goto-char (car range))
13782 (while (re-search-forward
13783 (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
13785 (setq key (org-match-string-no-properties 1)
13786 value (org-trim (or (org-match-string-no-properties 2) "")))
13787 (unless (member key excluded)
13788 (push (cons key (or value "")) props)))))
13790 (push (cons "CLOCKSUM"
13791 (org-columns-number-to-string (/ (float clocksum) 60.)
13794 (unless (assoc "CATEGORY" props)
13795 (push (cons "CATEGORY" (org-get-category)) props))
13796 (append sum-props (nreverse props)))))))
13798 (defun org-entry-get (pom property &optional inherit literal-nil)
13799 "Get value of PROPERTY for entry at point-or-marker POM.
13800 If INHERIT is non-nil and the entry does not have the property,
13801 then also check higher levels of the hierarchy.
13802 If INHERIT is the symbol `selective', use inheritance only if the setting
13803 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13804 If the property is present but empty, the return value is the empty string.
13805 If the property is not present at all, nil is returned.
13807 If LITERAL-NIL is set, return the string value \"nil\" as a string,
13808 do not interpret it as the list atom nil. This is used for inheritance
13809 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
13810 (org-with-point-at pom
13811 (if (and inherit (if (eq inherit 'selective)
13812 (org-property-inherit-p property)
13814 (org-entry-get-with-inheritance property literal-nil)
13815 (if (member property org-special-properties)
13816 ;; We need a special property. Use `org-entry-properties' to
13817 ;; retrieve it, but specify the wanted property
13818 (cdr (assoc property (org-entry-properties nil 'special property)))
13819 (let ((range (unless (org-before-first-heading-p)
13820 (org-get-property-block))))
13822 (goto-char (car range))
13824 (org-re-property property)
13826 ;; Found the property, return it.
13829 (org-match-string-no-properties 1)
13830 (org-not-nil (org-match-string-no-properties 1)))
13833 (defun org-property-or-variable-value (var &optional inherit)
13834 "Check if there is a property fixing the value of VAR.
13835 If yes, return this value. If not, return the current value of the variable."
13836 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13837 (if (and prop (stringp prop) (string-match "\\S-" prop))
13839 (symbol-value var))))
13841 (defun org-entry-delete (pom property)
13842 "Delete the property PROPERTY from entry at point-or-marker POM."
13843 (org-with-point-at pom
13844 (if (member property org-special-properties)
13845 nil ; cannot delete these properties.
13846 (let ((range (org-get-property-block)))
13848 (goto-char (car range))
13850 (org-re-property property)
13853 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13857 ;; Multi-values properties are properties that contain multiple values
13858 ;; These values are assumed to be single words, separated by whitespace.
13859 (defun org-entry-add-to-multivalued-property (pom property value)
13860 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13861 (let* ((old (org-entry-get pom property))
13862 (values (and old (org-split-string old "[ \t]"))))
13863 (setq value (org-entry-protect-space value))
13864 (unless (member value values)
13865 (setq values (cons value values))
13866 (org-entry-put pom property
13867 (mapconcat 'identity values " ")))))
13869 (defun org-entry-remove-from-multivalued-property (pom property value)
13870 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13871 (let* ((old (org-entry-get pom property))
13872 (values (and old (org-split-string old "[ \t]"))))
13873 (setq value (org-entry-protect-space value))
13874 (when (member value values)
13875 (setq values (delete value values))
13876 (org-entry-put pom property
13877 (mapconcat 'identity values " ")))))
13879 (defun org-entry-member-in-multivalued-property (pom property value)
13880 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13881 (let* ((old (org-entry-get pom property))
13882 (values (and old (org-split-string old "[ \t]"))))
13883 (setq value (org-entry-protect-space value))
13884 (member value values)))
13886 (defun org-entry-get-multivalued-property (pom property)
13887 "Return a list of values in a multivalued property."
13888 (let* ((value (org-entry-get pom property))
13889 (values (and value (org-split-string value "[ \t]"))))
13890 (mapcar 'org-entry-restore-space values)))
13892 (defun org-entry-put-multivalued-property (pom property &rest values)
13893 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13894 VALUES should be a list of strings. Spaces will be protected."
13895 (org-entry-put pom property
13896 (mapconcat 'org-entry-protect-space values " "))
13897 (let* ((value (org-entry-get pom property))
13898 (values (and value (org-split-string value "[ \t]"))))
13899 (mapcar 'org-entry-restore-space values)))
13901 (defun org-entry-protect-space (s)
13902 "Protect spaces and newline in string S."
13903 (while (string-match " " s)
13904 (setq s (replace-match "%20" t t s)))
13905 (while (string-match "\n" s)
13906 (setq s (replace-match "%0A" t t s)))
13909 (defun org-entry-restore-space (s)
13910 "Restore spaces and newline in string S."
13911 (while (string-match "%20" s)
13912 (setq s (replace-match " " t t s)))
13913 (while (string-match "%0A" s)
13914 (setq s (replace-match "\n" t t s)))
13917 (defvar org-entry-property-inherited-from (make-marker)
13918 "Marker pointing to the entry from where a property was inherited.
13919 Each call to `org-entry-get-with-inheritance' will set this marker to the
13920 location of the entry where the inheritance search matched. If there was
13921 no match, the marker will point nowhere.
13922 Note that also `org-entry-get' calls this function, if the INHERIT flag
13925 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13926 "Get entry property, and search higher levels if not present.
13927 The search will stop at the first ancestor which has the property defined.
13928 If the value found is \"nil\", return nil to show that the property
13929 should be considered as undefined (this is the meaning of nil here).
13930 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
13931 (move-marker org-entry-property-inherited-from nil)
13933 (unless (org-before-first-heading-p)
13939 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13940 (org-back-to-heading t)
13941 (move-marker org-entry-property-inherited-from (point))
13943 (or (org-up-heading-safe) (throw 'ex nil)))))))
13945 (cdr (assoc property org-file-properties))
13946 (cdr (assoc property org-global-properties))
13947 (cdr (assoc property org-global-properties-fixed))))
13948 (if literal-nil tmp (org-not-nil tmp))))
13950 (defvar org-property-changed-functions nil
13951 "Hook called when the value of a property has changed.
13952 Each hook function should accept two arguments, the name of the property
13953 and the new value.")
13955 (defun org-entry-put (pom property value)
13956 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13957 (org-with-point-at pom
13958 (org-back-to-heading t)
13959 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13962 ((equal property "TODO")
13963 (when (and (stringp value) (string-match "\\S-" value)
13964 (not (member value org-todo-keywords-1)))
13965 (error "\"%s\" is not a valid TODO state" value))
13966 (if (or (not value)
13967 (not (string-match "\\S-" value)))
13968 (setq value 'none))
13970 (org-set-tags nil 'align))
13971 ((equal property "PRIORITY")
13972 (org-priority (if (and value (stringp value) (string-match "\\S-" value))
13973 (string-to-char value) ?\ ))
13974 (org-set-tags nil 'align))
13975 ((equal property "SCHEDULED")
13976 (if (re-search-forward org-scheduled-time-regexp end t)
13978 ((eq value 'earlier) (org-timestamp-change -1 'day))
13979 ((eq value 'later) (org-timestamp-change 1 'day))
13980 (t (call-interactively 'org-schedule)))
13981 (call-interactively 'org-schedule)))
13982 ((equal property "DEADLINE")
13983 (if (re-search-forward org-deadline-time-regexp end t)
13985 ((eq value 'earlier) (org-timestamp-change -1 'day))
13986 ((eq value 'later) (org-timestamp-change 1 'day))
13987 (t (call-interactively 'org-deadline)))
13988 (call-interactively 'org-deadline)))
13989 ((member property org-special-properties)
13990 (error "The %s property can not yet be set with `org-entry-put'"
13992 (t ; a non-special property
13993 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13994 (setq range (org-get-property-block beg end 'force))
13995 (goto-char (car range))
13996 (if (re-search-forward
13997 (org-re-property property) (cdr range) t)
13999 (delete-region (match-beginning 0) (match-end 0))
14000 (goto-char (match-beginning 0)))
14001 (goto-char (cdr range))
14004 (org-indent-line-function))
14005 (insert ":" property ":")
14006 (and value (insert " " value))
14007 (org-indent-line-function)))))
14008 (run-hook-with-args 'org-property-changed-functions property value)))
14010 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14011 "Get all property keys in the current buffer.
14012 With INCLUDE-SPECIALS, also list the special properties that reflect things
14013 like tags and TODO state.
14014 With INCLUDE-DEFAULTS, also include properties that has special meaning
14015 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14017 With INCLUDE-COLUMNS, also include property names given in COLUMN
14018 formats in the current buffer."
14019 (let (rtn range cfmt s p)
14023 (goto-char (point-min))
14024 (while (re-search-forward org-property-start-re nil t)
14025 (setq range (org-get-property-block))
14026 (goto-char (car range))
14027 (while (re-search-forward
14028 (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
14030 (add-to-list 'rtn (org-match-string-no-properties 1)))
14031 (outline-next-heading))))
14033 (when include-specials
14034 (setq rtn (append org-special-properties rtn)))
14036 (when include-defaults
14037 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14038 (add-to-list 'rtn org-effort-property))
14040 (when include-columns
14044 (goto-char (point-min))
14045 (while (re-search-forward
14046 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
14048 (setq cfmt (match-string 2) s 0)
14049 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
14051 (setq s (match-end 0)
14052 p (match-string 1 cfmt))
14053 (unless (or (equal p "ITEM")
14054 (member p org-special-properties))
14055 (add-to-list 'rtn (match-string 1 cfmt))))))))
14057 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14059 (defun org-property-values (key)
14060 "Return a list of all values of property KEY in the current buffer."
14064 (goto-char (point-min))
14065 (let ((re (org-re-property key))
14067 (while (re-search-forward re nil t)
14068 (add-to-list 'values (org-trim (match-string 1))))
14069 (delete "" values)))))
14071 (defun org-insert-property-drawer ()
14072 "Insert a property drawer into the current entry."
14074 (org-back-to-heading t)
14075 (looking-at org-outline-regexp)
14076 (let ((indent (if org-adapt-indentation
14077 (- (match-end 0)(match-beginning 0))
14080 (re (concat "^[ \t]*" org-keyword-time-regexp))
14082 (outline-next-heading)
14085 (while (re-search-forward re end t))
14086 (setq hiddenp (outline-invisible-p))
14088 (and (equal (char-after) ?\n) (forward-char 1))
14089 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
14090 (if (member (match-string 1) '("CLOCK:" ":END:"))
14091 ;; just skip this line
14092 (beginning-of-line 2)
14093 ;; Drawer start, find the end
14094 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
14095 (beginning-of-line 1)))
14096 (org-skip-over-state-notes)
14097 (skip-chars-backward " \t\n\r")
14098 (if (eq (char-before) ?*) (forward-char 1))
14099 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
14100 (beginning-of-line 0)
14101 (org-indent-to-column indent)
14102 (beginning-of-line 2)
14103 (org-indent-to-column indent)
14104 (beginning-of-line 0)
14107 (org-back-to-heading t)
14109 (org-flag-drawer t))))
14111 (defvar org-property-set-functions-alist nil
14112 "Property set function alist.
14113 Each entry should have the following format:
14115 (PROPERTY . READ-FUNCTION)
14117 The read function will be called with the same argument as
14118 `org-completing-read'.")
14120 (defun org-set-property-function (property)
14121 "Get the function that should be used to set PROPERTY.
14122 This is computed according to `org-property-set-functions-alist'."
14123 (or (cdr (assoc property org-property-set-functions-alist))
14124 'org-completing-read))
14126 (defun org-read-property-value (property)
14127 "Read PROPERTY value from user."
14128 (let* ((completion-ignore-case t)
14129 (allowed (org-property-get-allowed-values nil property 'table))
14130 (cur (org-entry-get nil property))
14131 (prompt (concat property " value"
14132 (if (and cur (string-match "\\S-" cur))
14133 (concat " [" cur "]") "") ": "))
14134 (set-function (org-set-property-function property))
14136 (funcall set-function prompt allowed nil
14137 (not (get-text-property 0 'org-unrestricted
14139 (let (org-completion-use-ido org-completion-use-iswitchb)
14140 (funcall set-function prompt
14141 (mapcar 'list (org-property-values property))
14142 nil nil "" nil cur)))))
14147 (defvar org-last-set-property nil)
14148 (defun org-read-property-name ()
14149 "Read a property name."
14150 (let* ((completion-ignore-case t)
14151 (keys (org-buffer-property-keys nil t t))
14152 (default-prop (or (save-excursion
14154 (beginning-of-line)
14155 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
14156 (null (string= (match-string 1) "END"))
14157 (match-string 1))))
14158 org-last-set-property))
14159 (property (org-icompleting-read
14161 (if default-prop (concat " [" default-prop "]") "")
14163 (mapcar 'list keys)
14167 (if (member property keys)
14169 (or (cdr (assoc (downcase property)
14170 (mapcar (lambda (x) (cons (downcase x) x))
14174 (defun org-set-property (property value)
14175 "In the current entry, set PROPERTY to VALUE.
14176 When called interactively, this will prompt for a property name, offering
14177 completion on existing and default properties. And then it will prompt
14178 for a value, offering completion either on allowed values (via an inherited
14179 xxx_ALL property) or on existing values in other instances of this property
14180 in the current file."
14181 (interactive (list nil nil))
14182 (let* ((property (or property (org-read-property-name)))
14183 (value (or value (org-read-property-value property))))
14184 (setq org-last-set-property property)
14185 (unless (equal (org-entry-get nil property) value)
14186 (org-entry-put nil property value))))
14188 (defun org-delete-property (property)
14189 "In the current entry, delete PROPERTY."
14191 (let* ((completion-ignore-case t)
14192 (prop (org-icompleting-read "Property: "
14193 (org-entry-properties nil 'standard))))
14195 (message "Property %s %s" property
14196 (if (org-entry-delete nil property)
14198 "was not present in the entry")))
14200 (defun org-delete-property-globally (property)
14201 "Remove PROPERTY globally, from all entries."
14203 (let* ((completion-ignore-case t)
14204 (prop (org-icompleting-read
14205 "Globally remove property: "
14206 (mapcar 'list (org-buffer-property-keys)))))
14211 (goto-char (point-min))
14213 (while (re-search-forward
14214 (org-re-property property)
14216 (setq cnt (1+ cnt))
14217 (replace-match ""))
14218 (message "Property \"%s\" removed from %d entries" property cnt)))))
14220 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14222 (defun org-compute-property-at-point ()
14223 "Compute the property at point.
14224 This looks for an enclosing column format, extracts the operator and
14225 then applies it to the property in the column format's scope."
14227 (unless (org-at-property-p)
14228 (error "Not at a property"))
14229 (let ((prop (org-match-string-no-properties 2)))
14230 (org-columns-get-format-and-top-level)
14231 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14232 (error "No operator defined for property %s" prop))
14233 (org-columns-compute prop)))
14235 (defvar org-property-allowed-value-functions nil
14236 "Hook for functions supplying allowed values for a specific property.
14237 The functions must take a single argument, the name of the property, and
14238 return a flat list of allowed values. If \":ETC\" is one of
14239 the values, this means that these values are intended as defaults for
14240 completion, but that other values should be allowed too.
14241 The functions must return nil if they are not responsible for this
14244 (defun org-property-get-allowed-values (pom property &optional table)
14245 "Get allowed values for the property PROPERTY.
14246 When TABLE is non-nil, return an alist that can directly be used for
14250 ((equal property "TODO")
14251 (setq vals (org-with-point-at pom
14252 (append org-todo-keywords-1 '("")))))
14253 ((equal property "PRIORITY")
14254 (let ((n org-lowest-priority))
14255 (while (>= n org-highest-priority)
14256 (push (char-to-string n) vals)
14258 ((member property org-special-properties))
14259 ((setq vals (run-hook-with-args-until-success
14260 'org-property-allowed-value-functions property)))
14262 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14263 (when (and vals (string-match "\\S-" vals))
14264 (setq vals (car (read-from-string (concat "(" vals ")"))))
14265 (setq vals (mapcar (lambda (x)
14266 (cond ((stringp x) x)
14267 ((numberp x) (number-to-string x))
14268 ((symbolp x) (symbol-name x))
14271 (when (member ":ETC" vals)
14272 (setq vals (remove ":ETC" vals))
14273 (org-add-props (car vals) '(org-unrestricted t)))
14274 (if table (mapcar 'list vals) vals)))
14276 (defun org-property-previous-allowed-value (&optional previous)
14277 "Switch to the next allowed value for this property."
14279 (org-property-next-allowed-value t))
14281 (defun org-property-next-allowed-value (&optional previous)
14282 "Switch to the next allowed value for this property."
14284 (unless (org-at-property-p)
14285 (error "Not at a property"))
14286 (let* ((key (match-string 2))
14287 (value (match-string 3))
14288 (allowed (or (org-property-get-allowed-values (point) key)
14289 (and (member value '("[ ]" "[-]" "[X]"))
14293 (error "Allowed values for this property have not been defined"))
14294 (if previous (setq allowed (reverse allowed)))
14295 (if (member value allowed)
14296 (setq nval (car (cdr (member value allowed)))))
14297 (setq nval (or nval (car allowed)))
14298 (if (equal nval value)
14299 (error "Only one allowed value for this property"))
14300 (org-at-property-p)
14301 (replace-match (concat " :" key ": " nval) t t)
14302 (org-indent-line-function)
14303 (beginning-of-line 1)
14304 (skip-chars-forward " \t")
14305 (run-hook-with-args 'org-property-changed-functions key nval)))
14307 (defun org-find-olp (path &optional this-buffer)
14308 "Return a marker pointing to the entry at outline path OLP.
14309 If anything goes wrong, throw an error.
14310 You can wrap this call to catch the error like this:
14312 (condition-case msg
14313 (org-mobile-locate-entry (match-string 4))
14314 (error (nth 1 msg)))
14316 The return value will then be either a string with the error message,
14317 or a marker if everything is OK.
14319 If THIS-BUFFER is set, the outline path does not contain a file,
14321 (let* ((file (if this-buffer buffer-file-name (pop path)))
14322 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14326 limit re end found pos heading cnt flevel)
14327 (unless buffer (error "File not found :%s" file))
14328 (with-current-buffer buffer
14332 (setq limit (point-max))
14333 (goto-char (point-min))
14334 (while (setq heading (pop path))
14335 (setq re (format org-complex-heading-regexp-format
14336 (regexp-quote heading)))
14337 (setq cnt 0 pos (point))
14338 (while (re-search-forward re end t)
14339 (setq level (- (match-end 1) (match-beginning 1)))
14340 (if (and (>= level lmin) (<= level lmax))
14341 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14342 (when (= cnt 0) (error "Heading not found on level %d: %s"
14344 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14347 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14348 (setq end (save-excursion (org-end-of-subtree t t))))
14349 (when (org-on-heading-p)
14350 (move-marker (make-marker) (point))))))))
14352 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14353 "Find node HEADING in BUFFER.
14354 Return a marker to the heading if it was found, or nil if not.
14355 If POS-ONLY is set, return just the position instead of a marker.
14357 The heading text must match exact, but it may have a TODO keyword,
14358 a priority cookie and tags in the standard locations."
14359 (with-current-buffer (or buffer (current-buffer))
14363 (goto-char (point-min))
14364 (let (case-fold-search)
14365 (if (re-search-forward
14366 (format org-complex-heading-regexp-format
14367 (regexp-quote heading)) nil t)
14369 (match-beginning 0)
14370 (move-marker (make-marker) (match-beginning 0)))))))))
14372 (defun org-find-exact-heading-in-directory (heading &optional dir)
14373 "Find Org node headline HEADING in all .org files in directory DIR.
14374 When the target headline is found, return a marker to this location."
14375 (let ((files (directory-files (or dir default-directory)
14376 nil "\\`[^.#].*\\.org\\'"))
14377 file visiting m buffer)
14379 (while (setq file (pop files))
14380 (message "trying %s" file)
14381 (setq visiting (org-find-base-buffer-visiting file))
14382 (setq buffer (or visiting (find-file-noselect file)))
14383 (setq m (org-find-exact-headline-in-buffer
14385 (when (and (not m) (not visiting)) (kill-buffer buffer))
14386 (and m (throw 'found m))))))
14388 (defun org-find-entry-with-id (ident)
14389 "Locate the entry that contains the ID property with exact value IDENT.
14390 IDENT can be a string, a symbol or a number, this function will search for
14391 the string representation of it.
14392 Return the position where this entry starts, or nil if there is no such entry."
14393 (interactive "sID: ")
14395 ((stringp ident) ident)
14396 ((symbol-name ident) (symbol-name ident))
14397 ((numberp ident) (number-to-string ident))
14398 (t (error "IDENT %s must be a string, symbol or number" ident))))
14399 (case-fold-search nil))
14403 (goto-char (point-min))
14404 (when (re-search-forward
14405 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
14407 (org-back-to-heading t)
14412 (defvar org-last-changed-timestamp nil)
14413 (defvar org-last-inserted-timestamp nil
14414 "The last time stamp inserted with `org-insert-time-stamp'.")
14415 (defvar org-time-was-given) ; dynamically scoped parameter
14416 (defvar org-end-time-was-given) ; dynamically scoped parameter
14417 (defvar org-ts-what) ; dynamically scoped parameter
14419 (defun org-time-stamp (arg &optional inactive)
14420 "Prompt for a date/time and insert a time stamp.
14421 If the user specifies a time like HH:MM, or if this command is called
14422 with a prefix argument, the time stamp will contain date and time.
14423 Otherwise, only the date will be included. All parts of a date not
14424 specified by the user will be filled in from the current date/time.
14425 So if you press just return without typing anything, the time stamp
14426 will represent the current date/time. If there is already a timestamp
14427 at the cursor, it will be modified."
14431 ;; Default time is either today, or, when entering a range,
14432 ;; the range start.
14433 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14435 (re-search-backward
14436 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
14437 (- (point) 20) t)))
14438 (apply 'encode-time (org-parse-time-string (match-string 1)))
14440 (default-input (and ts (org-get-compact-tod ts)))
14441 (repeater (save-excursion
14443 (beginning-of-line)
14444 (when (re-search-forward
14445 "\\([.+-]+[0-9]+[dwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[dwmy]\\)?\\) ?"
14446 (save-excursion (progn (end-of-line) (point))) t)
14447 (match-string 0)))))
14448 org-time-was-given org-end-time-was-given time)
14450 ((and (org-at-timestamp-p t)
14451 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14452 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14454 (setq time (let ((this-command this-command))
14455 (org-read-date arg 'totime nil nil
14456 default-time default-input)))
14457 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14458 ((org-at-timestamp-p t)
14459 (setq time (let ((this-command this-command))
14460 (org-read-date arg 'totime nil nil default-time default-input)))
14461 (when (org-at-timestamp-p t) ; just to get the match data
14462 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14464 (setq org-last-changed-timestamp
14465 (org-insert-time-stamp
14466 time (or org-time-was-given arg)
14467 inactive nil nil (list org-end-time-was-given)))
14468 (when repeater (goto-char (1- (point))) (insert " " repeater)
14469 (setq org-last-changed-timestamp
14470 (concat (substring org-last-inserted-timestamp 0 -1)
14471 " " repeater ">"))))
14472 (message "Timestamp updated"))
14474 (setq time (let ((this-command this-command))
14475 (org-read-date arg 'totime nil nil default-time default-input)))
14476 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14477 nil nil (list org-end-time-was-given))))))
14479 ;; FIXME: can we use this for something else, like computing time differences?
14480 (defun org-get-compact-tod (s)
14481 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14482 (let* ((t1 (match-string 1 s))
14483 (h1 (string-to-number (match-string 2 s)))
14484 (m1 (string-to-number (match-string 3 s)))
14485 (t2 (and (match-end 4) (match-string 5 s)))
14486 (h2 (and t2 (string-to-number (match-string 6 s))))
14487 (m2 (and t2 (string-to-number (match-string 7 s))))
14491 (setq dh (- h2 h1) dm (- m2 m1))
14492 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14493 (concat t1 "+" (number-to-string dh)
14494 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14496 (defun org-time-stamp-inactive (&optional arg)
14497 "Insert an inactive time stamp.
14498 An inactive time stamp is enclosed in square brackets instead of angle
14499 brackets. It is inactive in the sense that it does not trigger agenda entries,
14500 does not link to the calendar and cannot be changed with the S-cursor keys.
14501 So these are more for recording a certain time/date."
14503 (org-time-stamp arg 'inactive))
14505 (defvar org-date-ovl (make-overlay 1 1))
14506 (overlay-put org-date-ovl 'face 'org-warning)
14507 (org-detach-overlay org-date-ovl)
14509 (defvar org-ans1) ; dynamically scoped parameter
14510 (defvar org-ans2) ; dynamically scoped parameter
14512 (defvar org-plain-time-of-day-regexp) ; defined below
14514 (defvar org-overriding-default-time nil) ; dynamically scoped
14515 (defvar org-read-date-overlay nil)
14516 (defvar org-dcst nil) ; dynamically scoped
14517 (defvar org-read-date-history nil)
14518 (defvar org-read-date-final-answer nil)
14519 (defvar org-read-date-analyze-futurep nil)
14520 (defvar org-read-date-analyze-forced-year nil)
14522 (defun org-read-date (&optional with-time to-time from-string prompt
14523 default-time default-input)
14524 "Read a date, possibly a time, and make things smooth for the user.
14525 The prompt will suggest to enter an ISO date, but you can also enter anything
14526 which will at least partially be understood by `parse-time-string'.
14527 Unrecognized parts of the date will default to the current day, month, year,
14528 hour and minute. If this command is called to replace a timestamp at point,
14529 of to enter the second timestamp of a range, the default time is taken
14530 from the existing stamp. Furthermore, the command prefers the future,
14531 so if you are giving a date where the year is not given, and the day-month
14532 combination is already past in the current year, it will assume you
14533 mean next year. For details, see the manual. A few examples:
14535 3-2-5 --> 2003-02-05
14536 feb 15 --> currentyear-02-15
14537 2/15 --> currentyear-02-15
14538 sep 12 9 --> 2009-09-12
14539 12:45 --> today 12:45
14540 22 sept 0:34 --> currentyear-09-22 0:34
14541 12 --> currentyear-currentmonth-12
14542 Fri --> nearest Friday (today or later)
14545 Furthermore you can specify a relative date by giving, as the *first* thing
14546 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14547 change in days weeks, months, years.
14548 With a single plus or minus, the date is relative to today. With a double
14549 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14550 +4d --> four days from today
14551 +4 --> same as above
14552 +2w --> two weeks from today
14553 ++5 --> five days from default date
14555 The function understands only English month and weekday abbreviations,
14556 but this can be configured with the variables `parse-time-months' and
14557 `parse-time-weekdays'.
14559 While prompting, a calendar is popped up - you can also select the
14560 date with the mouse (button 1). The calendar shows a period of three
14561 months. To scroll it to other months, use the keys `>' and `<'.
14562 If you don't like the calendar, turn it off with
14563 \(setq org-read-date-popup-calendar nil)
14565 With optional argument TO-TIME, the date will immediately be converted
14566 to an internal time.
14567 With an optional argument WITH-TIME, the prompt will suggest to also
14568 insert a time. Note that when WITH-TIME is not set, you can still
14569 enter a time, and this function will inform the calling routine about
14570 this change. The calling routine may then choose to change the format
14571 used to insert the time stamp into the buffer to include the time.
14572 With optional argument FROM-STRING, read from this string instead from
14573 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14574 the time/date that is used for everything that is not specified by the
14576 (require 'parse-time)
14577 (let* ((org-time-stamp-rounding-minutes
14578 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14579 (org-dcst org-display-custom-times)
14580 (ct (org-current-time))
14581 (def (or org-overriding-default-time default-time ct))
14582 (defdecode (decode-time def))
14584 (when (< (nth 2 defdecode) org-extend-today-until)
14585 (setcar (nthcdr 2 defdecode) -1)
14586 (setcar (nthcdr 1 defdecode) 59)
14587 (setq def (apply 'encode-time defdecode)
14588 defdecode (decode-time def)))))
14589 (calendar-frame-setup nil)
14590 (calendar-setup nil)
14591 (calendar-move-hook nil)
14592 (calendar-view-diary-initially-flag nil)
14593 (calendar-view-holidays-initially-flag nil)
14594 (timestr (format-time-string
14595 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14596 (prompt (concat (if prompt (concat prompt " ") "")
14597 (format "Date+time [%s]: " timestr)))
14598 ans (org-ans0 "") org-ans1 org-ans2 final)
14601 (from-string (setq ans from-string))
14602 (org-read-date-popup-calendar
14604 (save-window-excursion
14608 (calendar-forward-day (- (time-to-days def)
14609 (calendar-absolute-from-gregorian
14610 (calendar-current-date))))
14611 (org-eval-in-calendar nil t)
14612 (let* ((old-map (current-local-map))
14613 (map (copy-keymap calendar-mode-map))
14614 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14615 (org-defkey map (kbd "RET") 'org-calendar-select)
14616 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14617 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14618 (org-defkey minibuffer-local-map [(meta shift left)]
14619 (lambda () (interactive)
14620 (org-eval-in-calendar '(calendar-backward-month 1))))
14621 (org-defkey minibuffer-local-map [(meta shift right)]
14622 (lambda () (interactive)
14623 (org-eval-in-calendar '(calendar-forward-month 1))))
14624 (org-defkey minibuffer-local-map [(meta shift up)]
14625 (lambda () (interactive)
14626 (org-eval-in-calendar '(calendar-backward-year 1))))
14627 (org-defkey minibuffer-local-map [(meta shift down)]
14628 (lambda () (interactive)
14629 (org-eval-in-calendar '(calendar-forward-year 1))))
14630 (org-defkey minibuffer-local-map [?\e (shift left)]
14631 (lambda () (interactive)
14632 (org-eval-in-calendar '(calendar-backward-month 1))))
14633 (org-defkey minibuffer-local-map [?\e (shift right)]
14634 (lambda () (interactive)
14635 (org-eval-in-calendar '(calendar-forward-month 1))))
14636 (org-defkey minibuffer-local-map [?\e (shift up)]
14637 (lambda () (interactive)
14638 (org-eval-in-calendar '(calendar-backward-year 1))))
14639 (org-defkey minibuffer-local-map [?\e (shift down)]
14640 (lambda () (interactive)
14641 (org-eval-in-calendar '(calendar-forward-year 1))))
14642 (org-defkey minibuffer-local-map [(shift up)]
14643 (lambda () (interactive)
14644 (org-eval-in-calendar '(calendar-backward-week 1))))
14645 (org-defkey minibuffer-local-map [(shift down)]
14646 (lambda () (interactive)
14647 (org-eval-in-calendar '(calendar-forward-week 1))))
14648 (org-defkey minibuffer-local-map [(shift left)]
14649 (lambda () (interactive)
14650 (org-eval-in-calendar '(calendar-backward-day 1))))
14651 (org-defkey minibuffer-local-map [(shift right)]
14652 (lambda () (interactive)
14653 (org-eval-in-calendar '(calendar-forward-day 1))))
14654 (org-defkey minibuffer-local-map ">"
14655 (lambda () (interactive)
14656 (org-eval-in-calendar '(scroll-calendar-left 1))))
14657 (org-defkey minibuffer-local-map "<"
14658 (lambda () (interactive)
14659 (org-eval-in-calendar '(scroll-calendar-right 1))))
14660 (org-defkey minibuffer-local-map "\C-v"
14661 (lambda () (interactive)
14662 (org-eval-in-calendar
14663 '(calendar-scroll-left-three-months 1))))
14664 (org-defkey minibuffer-local-map "\M-v"
14665 (lambda () (interactive)
14666 (org-eval-in-calendar
14667 '(calendar-scroll-right-three-months 1))))
14668 (run-hooks 'org-read-date-minibuffer-setup-hook)
14671 (use-local-map map)
14672 (add-hook 'post-command-hook 'org-read-date-display)
14673 (setq org-ans0 (read-string prompt default-input
14674 'org-read-date-history nil))
14675 ;; org-ans0: from prompt
14676 ;; org-ans1: from mouse click
14677 ;; org-ans2: from calendar motion
14678 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14679 (remove-hook 'post-command-hook 'org-read-date-display)
14680 (use-local-map old-map)
14681 (when org-read-date-overlay
14682 (delete-overlay org-read-date-overlay)
14683 (setq org-read-date-overlay nil)))))
14684 (bury-buffer "*Calendar*")))))
14686 (t ; Naked prompt only
14688 (setq ans (read-string prompt default-input
14689 'org-read-date-history timestr))
14690 (when org-read-date-overlay
14691 (delete-overlay org-read-date-overlay)
14692 (setq org-read-date-overlay nil)))))
14694 (setq final (org-read-date-analyze ans def defdecode))
14696 (when org-read-date-analyze-forced-year
14697 (message "Year was forced into %s"
14698 (if org-read-date-force-compatible-dates
14699 "compatible range (1970-2037)"
14700 "range representable on this machine"))
14703 ;; One round trip to get rid of 34th of August and stuff like that....
14704 (setq final (decode-time (apply 'encode-time final)))
14706 (setq org-read-date-final-answer ans)
14709 (apply 'encode-time final)
14710 (if (and (boundp 'org-time-was-given) org-time-was-given)
14711 (format "%04d-%02d-%02d %02d:%02d"
14712 (nth 5 final) (nth 4 final) (nth 3 final)
14713 (nth 2 final) (nth 1 final))
14714 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14719 (defun org-read-date-display ()
14720 "Display the current date prompt interpretation in the minibuffer."
14721 (when org-read-date-display-live
14722 (when org-read-date-overlay
14723 (delete-overlay org-read-date-overlay))
14726 (while (not (equal (buffer-substring
14727 (max (point-min) (- (point) 4)) (point))
14731 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14732 " " (or org-ans1 org-ans2)))
14733 (org-end-time-was-given nil)
14734 (f (org-read-date-analyze ans def defdecode))
14736 org-time-stamp-custom-formats
14737 org-time-stamp-formats))
14738 (fmt (if (or with-time
14739 (and (boundp 'org-time-was-given) org-time-was-given))
14742 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14743 (when (and org-end-time-was-given
14744 (string-match org-plain-time-of-day-regexp txt))
14745 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14746 org-end-time-was-given
14747 (substring txt (match-end 0)))))
14748 (when org-read-date-analyze-futurep
14749 (setq txt (concat txt " (=>F)")))
14750 (setq org-read-date-overlay
14751 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14752 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14754 (defun org-read-date-analyze (ans def defdecode)
14755 "Analyze the combined answer of the date prompt."
14756 ;; FIXME: cleanup and comment
14757 (let ((nowdecode (decode-time (current-time)))
14758 delta deltan deltaw deltadef year month day
14759 hour minute second wday pm h2 m2 tl wday1
14760 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14761 (setq org-read-date-analyze-futurep nil
14762 org-read-date-analyze-forced-year nil)
14763 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
14766 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14767 (setq ans (replace-match "" t t ans)
14769 deltaw (nth 1 delta)
14770 deltadef (nth 2 delta)))
14772 ;; Check if there is an iso week date in there
14773 ;; If yes, store the info and postpone interpreting it until the rest
14774 ;; of the parsing is done
14775 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14776 (setq iso-year (if (match-end 1)
14777 (org-small-year-to-year
14778 (string-to-number (match-string 1 ans))))
14779 iso-weekday (if (match-end 3)
14780 (string-to-number (match-string 3 ans)))
14781 iso-week (string-to-number (match-string 2 ans)))
14782 (setq ans (replace-match "" t t ans)))
14784 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14785 (when (string-match
14786 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
14787 (setq year (if (match-end 2)
14788 (string-to-number (match-string 2 ans))
14789 (progn (setq kill-year t)
14790 (string-to-number (format-time-string "%Y"))))
14791 month (string-to-number (match-string 3 ans))
14792 day (string-to-number (match-string 4 ans)))
14793 (if (< year 100) (setq year (+ 2000 year)))
14794 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
14797 ;; Help matching dottet european dates
14798 (when (string-match
14799 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14800 (setq year (if (match-end 3)
14801 (string-to-number (match-string 3 ans))
14802 (progn (setq kill-year t)
14803 (string-to-number (format-time-string "%Y"))))
14804 day (string-to-number (match-string 1 ans))
14805 month (string-to-number (match-string 2 ans))
14806 ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
14809 ;; Help matching american dates, like 5/30 or 5/30/7
14810 (when (string-match
14811 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14812 (setq year (if (match-end 4)
14813 (string-to-number (match-string 4 ans))
14814 (progn (setq kill-year t)
14815 (string-to-number (format-time-string "%Y"))))
14816 month (string-to-number (match-string 1 ans))
14817 day (string-to-number (match-string 2 ans)))
14818 (if (< year 100) (setq year (+ 2000 year)))
14819 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
14821 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14822 ;; If there is a time with am/pm, and *no* time without it, we convert
14823 ;; so that matching will be successful.
14824 (loop for i from 1 to 2 do ; twice, for end time as well
14825 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
14826 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
14827 (setq hour (string-to-number (match-string 1 ans))
14828 minute (if (match-end 3)
14829 (string-to-number (match-string 3 ans))
14832 (string-to-char (downcase (match-string 4 ans)))))
14833 (if (and (= hour 12) (not pm))
14835 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14836 (setq ans (replace-match (format "%02d:%02d" hour minute)
14839 ;; Check if a time range is given as a duration
14840 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14841 (setq hour (string-to-number (match-string 1 ans))
14842 h2 (+ hour (string-to-number (match-string 3 ans)))
14843 minute (string-to-number (match-string 2 ans))
14844 m2 (+ minute (if (match-end 5) (string-to-number
14845 (match-string 5 ans))0)))
14846 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14847 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14850 ;; Check if there is a time range
14851 (when (boundp 'org-end-time-was-given)
14852 (setq org-time-was-given nil)
14853 (when (and (string-match org-plain-time-of-day-regexp ans)
14855 (setq org-end-time-was-given (match-string 8 ans))
14856 (setq ans (concat (substring ans 0 (match-beginning 7))
14857 (substring ans (match-end 7))))))
14859 (setq tl (parse-time-string ans)
14860 day (or (nth 3 tl) (nth 3 defdecode))
14861 month (or (nth 4 tl)
14862 (if (and org-read-date-prefer-future
14863 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14864 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14865 (nth 4 defdecode)))
14866 year (or (and (not kill-year) (nth 5 tl))
14867 (if (and org-read-date-prefer-future
14868 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14869 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14870 (nth 5 defdecode)))
14871 hour (or (nth 2 tl) (nth 2 defdecode))
14872 minute (or (nth 1 tl) (nth 1 defdecode))
14873 second (or (nth 0 tl) 0)
14876 (when (and (eq org-read-date-prefer-future 'time)
14877 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14878 (equal day (nth 3 nowdecode))
14879 (equal month (nth 4 nowdecode))
14880 (equal year (nth 5 nowdecode))
14882 (or (< (nth 2 tl) (nth 2 nowdecode))
14883 (and (= (nth 2 tl) (nth 2 nowdecode))
14885 (< (nth 1 tl) (nth 1 nowdecode)))))
14889 ;; Special date definitions below
14892 ;; There was an iso week
14895 (setq year (or iso-year year)
14896 day (or iso-weekday wday 1)
14897 wday nil ; to make sure that the trigger below does not match
14898 iso-date (calendar-gregorian-from-absolute
14899 (calendar-absolute-from-iso
14900 (list iso-week day year))))
14901 ; FIXME: Should we also push ISO weeks into the future?
14902 ; (when (and org-read-date-prefer-future
14904 ; (< (calendar-absolute-from-gregorian iso-date)
14905 ; (time-to-days (current-time))))
14906 ; (setq year (1+ year)
14907 ; iso-date (calendar-gregorian-from-absolute
14908 ; (calendar-absolute-from-iso
14909 ; (list iso-week day year)))))
14910 (setq month (car iso-date)
14911 year (nth 2 iso-date)
14912 day (nth 1 iso-date)))
14916 (let ((now (decode-time (current-time))))
14917 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14918 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14919 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14920 ((equal deltaw "m") (setq month (+ month deltan)))
14921 ((equal deltaw "y") (setq year (+ year deltan)))))
14922 ((and wday (not (nth 3 tl)))
14924 ;; Weekday was given, but no day, so pick that day in the week
14925 ;; on or after the derived date.
14926 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14927 (unless (equal wday wday1)
14928 (setq day (+ day (% (- wday wday1 -7) 7))))))
14929 (if (and (boundp 'org-time-was-given)
14931 (setq org-time-was-given t))
14932 (if (< year 100) (setq year (+ 2000 year)))
14933 ;; Check of the date is representable
14934 (if org-read-date-force-compatible-dates
14937 (setq year 1970 org-read-date-analyze-forced-year t))
14939 (setq year 2037 org-read-date-analyze-forced-year t)))
14940 (condition-case nil
14941 (ignore (encode-time second minute hour day month year))
14943 (setq year (nth 5 defdecode))
14944 (setq org-read-date-analyze-forced-year t))))
14945 (setq org-read-date-analyze-futurep futurep)
14946 (list second minute hour day month year)))
14948 (defvar parse-time-weekdays)
14950 (defun org-read-date-get-relative (s today default)
14951 "Check string S for special relative date string.
14952 TODAY and DEFAULT are internal times, for today and for a default.
14953 Return shift list (N what def-flag)
14954 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
14955 N is the number of WHATs to shift.
14956 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14957 the DEFAULT date rather than TODAY."
14961 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
14963 "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
14964 "\\([ \t]\\|$\\)") s)
14965 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14966 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14967 (string-to-char (substring (match-string 1 s) -1))
14969 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14970 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14971 (what (if (match-end 3) (match-string 3 s) "d"))
14972 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14973 (date (if rel default today))
14974 (wday (nth 6 (decode-time date)))
14978 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14979 (if (= dir ?-) (setq delta (- delta 7)))
14980 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14981 (list delta "d" rel))
14982 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14984 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14985 "Turn a user-specified date into the internal representation.
14986 The internal representation needed by the calendar is (month day year).
14987 This is a wrapper to handle the brain-dead convention in calendar that
14988 user function argument order change dependent on argument order."
14989 (if (boundp 'calendar-date-style)
14991 ((eq calendar-date-style 'american)
14992 (list arg1 arg2 arg3))
14993 ((eq calendar-date-style 'european)
14994 (list arg2 arg1 arg3))
14995 ((eq calendar-date-style 'iso)
14996 (list arg2 arg3 arg1)))
14997 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14998 (if (org-bound-and-true-p european-calendar-style)
14999 (list arg2 arg1 arg3)
15000 (list arg1 arg2 arg3)))))
15002 (defun org-eval-in-calendar (form &optional keepdate)
15003 "Eval FORM in the calendar window and return to current window.
15004 Also, store the cursor date in variable org-ans2."
15005 (let ((sf (selected-frame))
15006 (sw (selected-window)))
15007 (select-window (get-buffer-window "*Calendar*" t))
15009 (when (and (not keepdate) (calendar-cursor-to-date))
15010 (let* ((date (calendar-cursor-to-date))
15011 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15012 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15013 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15015 (org-select-frame-set-input-focus sf)))
15017 (defun org-calendar-select ()
15018 "Return to `org-read-date' with the date currently selected.
15019 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15021 (when (calendar-cursor-to-date)
15022 (let* ((date (calendar-cursor-to-date))
15023 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15024 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15025 (if (active-minibuffer-window) (exit-minibuffer))))
15027 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15028 "Insert a date stamp for the date given by the internal TIME.
15029 WITH-HM means use the stamp format that includes the time of the day.
15030 INACTIVE means use square brackets instead of angular ones, so that the
15031 stamp will not contribute to the agenda.
15032 PRE and POST are optional strings to be inserted before and after the
15034 The command returns the inserted time stamp."
15035 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15037 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15038 (insert-before-markers (or pre ""))
15039 (when (listp extra)
15040 (setq extra (car extra))
15041 (if (and (stringp extra)
15042 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
15043 (setq extra (format "-%02d:%02d"
15044 (string-to-number (match-string 1 extra))
15045 (string-to-number (match-string 2 extra))))
15048 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15049 (insert-before-markers (setq stamp (format-time-string fmt time)))
15050 (insert-before-markers (or post ""))
15051 (setq org-last-inserted-timestamp stamp)))
15053 (defun org-toggle-time-stamp-overlays ()
15054 "Toggle the use of custom time stamp formats."
15056 (setq org-display-custom-times (not org-display-custom-times))
15057 (unless org-display-custom-times
15058 (let ((p (point-min)) (bmp (buffer-modified-p)))
15059 (while (setq p (next-single-property-change p 'display))
15060 (if (and (get-text-property p 'display)
15061 (eq (get-text-property p 'face) 'org-date))
15062 (remove-text-properties
15063 p (setq p (next-single-property-change p 'display))
15065 (set-buffer-modified-p bmp)))
15066 (if (featurep 'xemacs)
15067 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15068 (org-restart-font-lock)
15069 (setq org-table-may-need-update t)
15070 (if org-display-custom-times
15071 (message "Time stamps are overlayed with custom format")
15072 (message "Time stamp overlays removed")))
15074 (defun org-display-custom-time (beg end)
15075 "Overlay modified time stamp format over timestamp between BEG and END."
15076 (let* ((ts (buffer-substring beg end))
15077 t1 w1 with-hm tf time str w2 (off 0))
15079 (setq t1 (org-parse-time-string ts t))
15080 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15081 (setq off (- (match-end 0) (match-beginning 0)))))
15082 (setq end (- end off))
15083 (setq w1 (- end beg)
15084 with-hm (and (nth 1 t1) (nth 2 t1))
15085 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15086 time (org-fix-decoded-time t1)
15088 (format-time-string
15089 (substring tf 1 -1) (apply 'encode-time time))
15090 nil 'mouse-face 'highlight)
15092 (if (not (= w2 w1))
15093 (add-text-properties (1+ beg) (+ 2 beg)
15094 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15095 (if (featurep 'xemacs)
15097 (put-text-property beg end 'invisible t)
15098 (put-text-property beg end 'end-glyph (make-glyph str)))
15099 (put-text-property beg end 'display str))))
15101 (defun org-translate-time (string)
15102 "Translate all timestamps in STRING to custom format.
15103 But do this only if the variable `org-display-custom-times' is set."
15104 (when org-display-custom-times
15107 (re org-ts-regexp-both)
15108 t1 with-hm inactive tf time str beg end)
15109 (while (setq start (string-match re string start))
15110 (setq beg (match-beginning 0)
15112 t1 (save-match-data
15113 (org-parse-time-string (substring string beg end) t))
15114 with-hm (and (nth 1 t1) (nth 2 t1))
15115 inactive (equal (substring string beg (1+ beg)) "[")
15116 tf (funcall (if with-hm 'cdr 'car)
15117 org-time-stamp-custom-formats)
15118 time (org-fix-decoded-time t1)
15119 str (format-time-string
15121 (if inactive "[" "<") (substring tf 1 -1)
15122 (if inactive "]" ">"))
15123 (apply 'encode-time time))
15124 string (replace-match str t t string)
15125 start (+ start (length str)))))))
15128 (defun org-fix-decoded-time (time)
15129 "Set 0 instead of nil for the first 6 elements of time.
15130 Don't touch the rest."
15132 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15134 (defun org-days-to-time (timestamp-string)
15135 "Difference between TIMESTAMP-STRING and now in days."
15136 (- (time-to-days (org-time-string-to-time timestamp-string))
15137 (time-to-days (current-time))))
15139 (defun org-deadline-close (timestamp-string &optional ndays)
15140 "Is the time in TIMESTAMP-STRING close to the current date?"
15141 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15142 (and (< (org-days-to-time timestamp-string) ndays)
15143 (not (org-entry-is-done-p))))
15145 (defun org-get-wdays (ts)
15146 "Get the deadline lead time appropriate for timestring TS."
15148 ((<= org-deadline-warning-days 0)
15149 ;; 0 or negative, enforce this value no matter what
15150 (- org-deadline-warning-days))
15151 ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\| \\)" ts)
15152 ;; lead time is specified.
15153 (floor (* (string-to-number (match-string 1 ts))
15154 (cdr (assoc (match-string 2 ts)
15155 '(("d" . 1) ("w" . 7)
15156 ("m" . 30.4) ("y" . 365.25)))))))
15157 ;; go for the default.
15158 (t org-deadline-warning-days)))
15160 (defun org-calendar-select-mouse (ev)
15161 "Return to `org-read-date' with the date currently selected.
15162 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15164 (mouse-set-point ev)
15165 (when (calendar-cursor-to-date)
15166 (let* ((date (calendar-cursor-to-date))
15167 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15168 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15169 (if (active-minibuffer-window) (exit-minibuffer))))
15171 (defun org-check-deadlines (ndays)
15172 "Check if there are any deadlines due or past due.
15173 A deadline is considered due if it happens within `org-deadline-warning-days'
15174 days from today's date. If the deadline appears in an entry marked DONE,
15175 it is not shown. The prefix arg NDAYS can be used to test that many
15176 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
15178 (let* ((org-warn-days
15180 ((equal ndays '(4)) 100000)
15181 (ndays (prefix-numeric-value ndays))
15182 (t (abs org-deadline-warning-days))))
15183 (case-fold-search nil)
15184 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
15186 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15188 (message "%d deadlines past-due or due within %d days"
15189 (org-occur regexp nil callback)
15192 (defun org-check-before-date (date)
15193 "Check if there are deadlines or scheduled entries before DATE."
15194 (interactive (list (org-read-date)))
15195 (let ((case-fold-search nil)
15196 (regexp (concat "\\<\\(" org-deadline-string
15197 "\\|" org-scheduled-string
15198 "\\) *<\\([^>]+\\)>"))
15200 (lambda () (time-less-p
15201 (org-time-string-to-time (match-string 2))
15202 (org-time-string-to-time date)))))
15203 (message "%d entries before %s"
15204 (org-occur regexp nil callback) date)))
15206 (defun org-check-after-date (date)
15207 "Check if there are deadlines or scheduled entries after DATE."
15208 (interactive (list (org-read-date)))
15209 (let ((case-fold-search nil)
15210 (regexp (concat "\\<\\(" org-deadline-string
15211 "\\|" org-scheduled-string
15212 "\\) *<\\([^>]+\\)>"))
15216 (org-time-string-to-time (match-string 2))
15217 (org-time-string-to-time date))))))
15218 (message "%d entries after %s"
15219 (org-occur regexp nil callback) date)))
15221 (defun org-evaluate-time-range (&optional to-buffer)
15222 "Evaluate a time range by computing the difference between start and end.
15223 Normally the result is just printed in the echo area, but with prefix arg
15224 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15225 If the time range is actually in a table, the result is inserted into the
15227 For time difference computation, a year is assumed to be exactly 365
15228 days in order to avoid rounding problems."
15231 (org-clock-update-time-maybe)
15233 (unless (org-at-date-range-p t)
15234 (goto-char (point-at-bol))
15235 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15236 (if (not (org-at-date-range-p t))
15237 (error "Not at a time-stamp range, and none found in current line")))
15238 (let* ((ts1 (match-string 1))
15239 (ts2 (match-string 2))
15240 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15241 (match-end (match-end 0))
15242 (time1 (org-time-string-to-time ts1))
15243 (time2 (org-time-string-to-time ts2))
15244 (t1 (org-float-time time1))
15245 (t2 (org-float-time time2))
15246 (diff (abs (- t2 t1)))
15247 (negative (< (- t2 t1) 0))
15248 ;; (ys (floor (* 365 24 60 60)))
15251 (fy "%dy %dd %02d:%02d")
15253 (fd "%dd %02d:%02d")
15258 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15260 d (floor (/ diff ds)) diff (mod diff ds)
15261 h (floor (/ diff hs)) diff (mod diff hs)
15262 m (floor (/ diff 60)))
15263 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15265 d (floor (+ (/ diff ds) 0.5))
15267 (if (not to-buffer)
15268 (message "%s" (org-make-tdiff-string y d h m))
15269 (if (org-at-table-p)
15271 (goto-char match-end)
15273 (and (looking-at " *|") (goto-char (match-end 0))))
15274 (goto-char match-end))
15276 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
15277 (replace-match ""))
15278 (if negative (insert " -"))
15279 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15280 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15281 (insert " " (format fh h m))))
15282 (if align (org-table-align))
15283 (message "Time difference inserted")))))
15285 (defun org-make-tdiff-string (y d h m)
15288 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15290 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15292 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15294 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15296 (apply 'format fmt (nreverse l))))
15298 (defun org-time-string-to-time (s)
15299 (apply 'encode-time (org-parse-time-string s)))
15300 (defun org-time-string-to-seconds (s)
15301 (org-float-time (org-time-string-to-time s)))
15303 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15304 "Convert a time stamp to an absolute day number.
15305 If there is a specifier for a cyclic time stamp, get the closest date to
15307 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15308 The variable date is bound by the calendar when this is called."
15310 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
15311 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15314 ((and daynr (string-match "\\+[0-9]+[dwmy]" s))
15315 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15316 (time-to-days (current-time))) (match-string 0 s)
15318 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15320 (defun org-days-to-iso-week (days)
15321 "Return the iso week number."
15323 (car (calendar-iso-from-absolute days)))
15325 (defun org-small-year-to-year (year)
15326 "Convert 2-digit years into 4-digit years.
15327 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15328 The year 2000 cannot be abbreviated. Any year larger than 99
15329 is returned unchanged."
15331 (setq year (+ 2000 year))
15333 (setq year (+ 1900 year))))
15336 (defun org-time-from-absolute (d)
15337 "Return the time corresponding to date D.
15338 D may be an absolute day number, or a calendar-type list (month day year)."
15339 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15340 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15342 (defun org-calendar-holiday ()
15343 "List of holidays, for Diary display in Org-mode."
15344 (require 'holidays)
15346 (if (fboundp 'calendar-check-holidays)
15347 'calendar-check-holidays 'check-calendar-holidays) date)))
15348 (if hl (mapconcat 'identity hl "; "))))
15350 (defun org-diary-sexp-entry (sexp entry date)
15351 "Process a SEXP diary ENTRY for DATE."
15352 (require 'diary-lib)
15353 (let ((result (if calendar-debug-sexp
15354 (let ((stack-trace-on-error t))
15355 (eval (car (read-from-string sexp))))
15356 (condition-case nil
15357 (eval (car (read-from-string sexp)))
15360 (message "Bad sexp at line %d in %s: %s"
15362 (buffer-file-name) sexp)
15364 (cond ((stringp result) (split-string result "; "))
15365 ((and (consp result)
15366 (not (consp (cdr result)))
15367 (stringp (cdr result))) (cdr result))
15368 ((and (consp result)
15369 (stringp (car result))) result)
15373 (defun org-diary-to-ical-string (frombuf)
15374 "Get iCalendar entries from diary entries in buffer FROMBUF.
15375 This uses the icalendar.el library."
15376 (let* ((tmpdir (if (featurep 'xemacs)
15378 temporary-file-directory))
15379 (tmpfile (make-temp-name
15380 (expand-file-name "orgics" tmpdir)))
15382 (with-current-buffer frombuf
15383 (icalendar-export-region (point-min) (point-max) tmpfile)
15384 (setq buf (find-buffer-visiting tmpfile))
15386 (goto-char (point-min))
15387 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15388 (setq b (match-beginning 0)))
15389 (goto-char (point-max))
15390 (if (re-search-backward "^END:VEVENT" nil t)
15391 (setq e (match-end 0)))
15392 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
15394 (delete-file tmpfile)
15397 (defun org-closest-date (start current change prefer show-all)
15398 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15399 When PREFER is `past', return a date that is either CURRENT or past.
15400 When PREFER is `future', return a date that is either CURRENT or future.
15401 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15402 ;; Make the proper lists from the dates
15404 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15405 dn dw sday cday n1 n2 n0
15406 d m y y1 y2 date1 date2 nmonths nm ny m2)
15408 (setq start (org-date-to-gregorian start)
15409 current (org-date-to-gregorian
15412 (time-to-days (current-time))))
15413 sday (calendar-absolute-from-gregorian start)
15414 cday (calendar-absolute-from-gregorian current))
15416 (if (<= cday sday) (throw 'exit sday))
15418 (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
15419 (setq dn (string-to-number (match-string 1 change))
15420 dw (cdr (assoc (match-string 2 change) a1)))
15421 (error "Invalid change specifier: %s" change))
15422 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15425 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15428 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15429 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15430 (setq date1 (list m d y1)
15431 n1 (calendar-absolute-from-gregorian date1)
15432 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15433 n2 (calendar-absolute-from-gregorian date2)))
15435 ;; approx number of month between the two dates
15436 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15437 ;; How often does dn fit in there?
15438 (setq d (nth 1 start) m (car start) y (nth 2 start)
15439 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15441 ny (floor (/ m 12))
15444 (while (> m 12) (setq m (- m 12) y (1+ y)))
15445 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15446 (setq m2 (+ m dn) y2 y)
15447 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15448 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15449 (while (<= n2 cday)
15450 (setq n1 n2 m m2 y y2)
15451 (setq m2 (+ m dn) y2 y)
15452 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15453 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15454 ;; Make sure n1 is the earlier date
15455 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15458 ((eq prefer 'past) (if (= cday n2) n2 n1))
15459 ((eq prefer 'future) (if (= cday n1) n1 n2))
15460 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15462 ((eq prefer 'past) (if (= cday n2) n2 n1))
15463 ((eq prefer 'future) (if (= cday n1) n1 n2))
15464 (t (if (= cday n1) n1 n2)))))))
15466 (defun org-date-to-gregorian (date)
15467 "Turn any specification of DATE into a Gregorian date for the calendar."
15468 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15469 ((and (listp date) (= (length date) 3)) date)
15471 (setq date (org-parse-time-string date))
15472 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15474 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15476 (defun org-parse-time-string (s &optional nodefault)
15477 "Parse the standard Org-mode time string.
15478 This should be a lot faster than the normal `parse-time-string'.
15479 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15480 hour and minute fields will be nil if not given."
15481 (if (string-match org-ts-regexp0 s)
15483 (if (or (match-beginning 8) (not nodefault))
15484 (string-to-number (or (match-string 8 s) "0")))
15485 (if (or (match-beginning 7) (not nodefault))
15486 (string-to-number (or (match-string 7 s) "0")))
15487 (string-to-number (match-string 4 s))
15488 (string-to-number (match-string 3 s))
15489 (string-to-number (match-string 2 s))
15491 (error "Not a standard Org-mode time string: %s" s)))
15493 (defun org-timestamp-up (&optional arg)
15494 "Increase the date item at the cursor by one.
15495 If the cursor is on the year, change the year. If it is on the month,
15496 the day or the time, change that.
15497 With prefix ARG, change by that many units."
15499 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15501 (defun org-timestamp-down (&optional arg)
15502 "Decrease the date item at the cursor by one.
15503 If the cursor is on the year, change the year. If it is on the month,
15504 the day or the time, change that.
15505 With prefix ARG, change by that many units."
15507 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15509 (defun org-timestamp-up-day (&optional arg)
15510 "Increase the date in the time stamp by one day.
15511 With prefix ARG, change that many days."
15513 (if (and (not (org-at-timestamp-p t))
15514 (org-on-heading-p))
15516 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15518 (defun org-timestamp-down-day (&optional arg)
15519 "Decrease the date in the time stamp by one day.
15520 With prefix ARG, change that many days."
15522 (if (and (not (org-at-timestamp-p t))
15523 (org-on-heading-p))
15525 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15527 (defun org-at-timestamp-p (&optional inactive-ok)
15528 "Determine if the cursor is in or at a timestamp."
15530 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15532 (ans (or (looking-at tsr)
15534 (skip-chars-backward "^[<\n\r\t")
15535 (if (> (point) (point-min)) (backward-char 1))
15536 (and (looking-at tsr)
15537 (> (- (match-end 0) pos) -1))))))
15539 (boundp 'org-ts-what)
15542 ((= pos (match-beginning 0)) 'bracket)
15543 ((= pos (1- (match-end 0))) 'bracket)
15544 ((org-pos-in-match-range pos 2) 'year)
15545 ((org-pos-in-match-range pos 3) 'month)
15546 ((org-pos-in-match-range pos 7) 'hour)
15547 ((org-pos-in-match-range pos 8) 'minute)
15548 ((or (org-pos-in-match-range pos 4)
15549 (org-pos-in-match-range pos 5)) 'day)
15550 ((and (> pos (or (match-end 8) (match-end 5)))
15551 (< pos (match-end 0)))
15552 (- pos (or (match-end 8) (match-end 5))))
15556 (defun org-toggle-timestamp-type ()
15557 "Toggle the type (<active> or [inactive]) of a time stamp."
15559 (when (org-at-timestamp-p t)
15560 (let ((beg (match-beginning 0)) (end (match-end 0))
15561 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15564 (while (re-search-forward "[][<>]" end t)
15565 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15567 (message "Timestamp is now %sactive"
15568 (if (equal (char-after beg) ?<) "" "in")))))
15570 (defun org-timestamp-change (n &optional what updown)
15571 "Change the date in the time stamp at point.
15572 The date will be changed by N times WHAT. WHAT can be `day', `month',
15573 `year', `minute', `second'. If WHAT is not given, the cursor position
15574 in the timestamp determines what will be changed."
15575 (let ((pos (point))
15577 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15581 (if (not (org-at-timestamp-p t))
15582 (error "Not at a timestamp"))
15583 (if (and (not what) (eq org-ts-what 'bracket))
15584 (org-toggle-timestamp-type)
15585 (if (and (not what) (not (eq org-ts-what 'day))
15586 org-display-custom-times
15587 (get-text-property (point) 'display)
15588 (not (get-text-property (1- (point)) 'display)))
15589 (setq org-ts-what 'day))
15590 (setq org-ts-what (or what org-ts-what)
15591 inactive (= (char-after (match-beginning 0)) ?\[)
15592 ts (match-string 0))
15595 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)*\\)[]>]"
15597 (setq extra (match-string 1 ts)))
15598 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
15600 (setq time0 (org-parse-time-string ts))
15602 (eq org-ts-what 'minute)
15603 (not current-prefix-arg))
15604 ;; This looks like s-up and s-down. Change by one rounding step.
15605 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15606 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15607 (setcar (cdr time0) (+ (nth 1 time0)
15608 (if (> n 0) (- rem) (- dm rem))))))
15610 (encode-time (or (car time0) 0)
15611 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15612 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15613 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15614 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15615 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15617 (when (and (member org-ts-what '(hour minute))
15619 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
15620 (setq extra (org-modify-ts-extra
15622 (if (eq org-ts-what 'hour) 2 5)
15624 (when (integerp org-ts-what)
15625 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15626 (if (eq what 'calendar)
15627 (let ((cal-date (org-get-date-from-calendar)))
15628 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15629 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15630 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15631 (setcar time0 (or (car time0) 0))
15632 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15633 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15634 (setq time (apply 'encode-time time0))))
15635 (setq org-last-changed-timestamp
15636 (org-insert-time-stamp time with-hm inactive nil nil extra))
15637 (org-clock-update-time-maybe)
15639 ;; Try to recenter the calendar window, if any
15640 (if (and org-calendar-follow-timestamp-change
15641 (get-buffer-window "*Calendar*" t)
15642 (memq org-ts-what '(day month year)))
15643 (org-recenter-calendar (time-to-days time))))))
15645 (defun org-modify-ts-extra (s pos n dm)
15646 "Change the different parts of the lead-time and repeat fields in timestamp."
15647 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15649 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15651 ((or (org-pos-in-match-range pos 2)
15652 (org-pos-in-match-range pos 3))
15653 (setq m (string-to-number (match-string 3 s))
15654 h (string-to-number (match-string 2 s)))
15655 (if (org-pos-in-match-range pos 2)
15657 (setq n (* dm (org-no-warnings (signum n))))
15658 (when (not (= 0 (setq rem (% m dm))))
15659 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15661 (if (< m 0) (setq m (+ m 60) h (1- h)))
15662 (if (> m 59) (setq m (- m 60) h (1+ h)))
15663 (setq h (min 24 (max 0 h)))
15664 (setq ng 1 new (format "-%02d:%02d" h m)))
15665 ((org-pos-in-match-range pos 6)
15666 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15667 ((org-pos-in-match-range pos 5)
15668 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15670 ((org-pos-in-match-range pos 9)
15671 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15672 ((org-pos-in-match-range pos 8)
15673 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15677 (substring s 0 (match-beginning ng))
15679 (substring s (match-end ng))))))
15682 (defun org-recenter-calendar (date)
15683 "If the calendar is visible, recenter it to DATE."
15684 (let* ((win (selected-window))
15685 (cwin (get-buffer-window "*Calendar*" t))
15686 (calendar-move-hook nil))
15688 (select-window cwin)
15689 (calendar-goto-date (if (listp date) date
15690 (calendar-gregorian-from-absolute date)))
15691 (select-window win))))
15693 (defun org-goto-calendar (&optional arg)
15694 "Go to the Emacs calendar at the current date.
15695 If there is a time stamp in the current line, go to that date.
15696 A prefix ARG can be used to force the current date."
15698 (let ((tsr org-ts-regexp) diff
15699 (calendar-move-hook nil)
15700 (calendar-view-holidays-initially-flag nil)
15701 (calendar-view-diary-initially-flag nil))
15702 (if (or (org-at-timestamp-p)
15704 (beginning-of-line 1)
15705 (looking-at (concat ".*" tsr))))
15706 (let ((d1 (time-to-days (current-time)))
15708 (org-time-string-to-time (match-string 1)))))
15709 (setq diff (- d2 d1))))
15711 (calendar-goto-today)
15712 (if (and diff (not arg)) (calendar-forward-day diff))))
15714 (defun org-get-date-from-calendar ()
15715 "Return a list (month day year) of date at point in calendar."
15716 (with-current-buffer "*Calendar*"
15718 (calendar-cursor-to-date))))
15720 (defun org-date-from-calendar ()
15721 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15722 If there is already a time stamp at the cursor position, update it."
15724 (if (org-at-timestamp-p t)
15725 (org-timestamp-change 0 'calendar)
15726 (let ((cal-date (org-get-date-from-calendar)))
15727 (org-insert-time-stamp
15728 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15730 (defun org-minutes-to-hh:mm-string (m)
15731 "Compute H:MM from a number of minutes."
15732 (let ((h (/ m 60)))
15733 (setq m (- m (* 60 h)))
15734 (format org-time-clocksum-format h m)))
15736 (defun org-hh:mm-string-to-minutes (s)
15737 "Convert a string H:MM to a number of minutes.
15738 If the string is just a number, interpret it as minutes.
15739 In fact, the first hh:mm or number in the string will be taken,
15740 there can be extra stuff in the string.
15741 If no number is found, the return value is 0."
15744 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
15745 (+ (* (string-to-number (match-string 1 s)) 60)
15746 (string-to-number (match-string 2 s))))
15747 ((string-match "\\([0-9]+\\)" s)
15748 (string-to-number (match-string 1 s)))
15751 (defcustom org-effort-durations
15754 ("w" . ,(* 60 8 5))
15755 ("m" . ,(* 60 8 5 4))
15756 ("y" . ,(* 60 8 5 40)))
15757 "Conversion factor to minutes for an effort modifier.
15759 Each entry has the form (MODIFIER . MINUTES).
15761 In an effort string, a number followed by MODIFIER is multiplied
15762 by the specified number of MINUTES to obtain an effort in
15765 For example, if the value of this variable is ((\"hours\" . 60)), then an
15766 effort string \"2hours\" is equivalent to 120 minutes."
15768 :type '(alist :key-type (string :tag "Modifier")
15769 :value-type (number :tag "Minutes")))
15771 (defun org-duration-string-to-minutes (s)
15772 "Convert a duration string S to minutes.
15774 A bare number is interpreted as minutes, modifiers can be set by
15775 customizing `org-effort-durations' (which see).
15777 Entries containing a colon are interpreted as H:MM by
15778 `org-hh:mm-string-to-minutes'."
15780 (re (concat "\\([0-9]+\\) *\\("
15781 (regexp-opt (mapcar 'car org-effort-durations))
15783 (while (string-match re s)
15784 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15785 (string-to-number (match-string 1 s))))
15786 (setq s (replace-match "" nil t s)))
15787 (incf result (org-hh:mm-string-to-minutes s))
15792 (defun org-save-all-org-buffers ()
15793 "Save all Org-mode buffers without user confirmation."
15795 (message "Saving all Org-mode buffers...")
15796 (save-some-buffers t 'org-mode-p)
15797 (when (featurep 'org-id) (org-id-locations-save))
15798 (message "Saving all Org-mode buffers... done"))
15800 (defun org-revert-all-org-buffers ()
15801 "Revert all Org-mode buffers.
15802 Prompt for confirmation when there are unsaved changes.
15803 Be sure you know what you are doing before letting this function
15804 overwrite your changes.
15806 This function is useful in a setup where one tracks org files
15807 with a version control system, to revert on one machine after pulling
15808 changes from another. I believe the procedure must be like this:
15810 1. M-x org-save-all-org-buffers
15811 2. Pull changes from the other machine, resolve conflicts
15812 3. M-x org-revert-all-org-buffers"
15814 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15817 (save-window-excursion
15820 (when (and (with-current-buffer b (org-mode-p))
15821 (with-current-buffer b buffer-file-name))
15822 (org-pop-to-buffer-same-window b)
15823 (revert-buffer t 'no-confirm)))
15825 (when (and (featurep 'org-id) org-id-track-globally)
15826 (org-id-locations-load)))))
15831 (defun org-switchb (&optional arg)
15832 "Switch between Org buffers.
15833 With a prefix argument, restrict available to files.
15834 With two prefix arguments, restrict available buffers to agenda files.
15836 Defaults to `iswitchb' for buffer name completion.
15837 Set `org-completion-use-ido' to make it use ido instead."
15839 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15840 ((equal arg '(16)) (org-buffer-list 'agenda))
15841 (t (org-buffer-list))))
15842 (org-completion-use-iswitchb org-completion-use-iswitchb)
15843 (org-completion-use-ido org-completion-use-ido))
15844 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15845 (setq org-completion-use-iswitchb t))
15846 (org-pop-to-buffer-same-window
15847 (org-icompleting-read "Org buffer: "
15848 (mapcar 'list (mapcar 'buffer-name blist))
15851 ;;; Define some older names previously used for this functionality
15853 (defalias 'org-ido-switchb 'org-switchb)
15855 (defalias 'org-iswitchb 'org-switchb)
15857 (defun org-buffer-list (&optional predicate exclude-tmp)
15858 "Return a list of Org buffers.
15859 PREDICATE can be `export', `files' or `agenda'.
15861 export restrict the list to Export buffers.
15862 files restrict the list to buffers visiting Org files.
15863 agenda restrict the list to buffers visiting agenda files.
15865 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15867 (agenda-files (and (eq predicate 'agenda)
15868 (mapcar 'file-truename (org-agenda-files t))))
15871 ((eq predicate 'files)
15872 (lambda (b) (with-current-buffer b (org-mode-p))))
15873 ((eq predicate 'export)
15874 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15875 ((eq predicate 'agenda)
15877 (with-current-buffer b
15879 (setq bfn (buffer-file-name b))
15880 (member (file-truename bfn) agenda-files)))))
15881 (t (lambda (b) (with-current-buffer b
15883 (string-match "\*Org .*Export"
15884 (buffer-name b)))))))))
15888 (if (and (funcall filter b)
15889 (or (not exclude-tmp)
15890 (not (string-match "tmp" (buffer-name b)))))
15895 (defun org-agenda-files (&optional unrestricted archives)
15896 "Get the list of agenda files.
15897 Optional UNRESTRICTED means return the full list even if a restriction
15898 is currently in place.
15899 When ARCHIVES is t, include all archive files that are really being
15900 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15901 `org-agenda-archives-mode' is t."
15904 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15905 ((stringp org-agenda-files) (org-read-agenda-file-list))
15906 ((listp org-agenda-files) org-agenda-files)
15907 (t (error "Invalid value of `org-agenda-files'")))))
15908 (setq files (apply 'append
15909 (mapcar (lambda (f)
15910 (if (file-directory-p f)
15912 f t org-agenda-file-regexp)
15915 (when org-agenda-skip-unavailable-files
15916 (setq files (delq nil
15919 (and (file-readable-p file) file)))
15921 (when (or (eq archives t)
15922 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15923 (setq files (org-add-archive-files files)))
15926 (defun org-agenda-file-p (&optional file)
15927 "Return non-nil, if FILE is an agenda file.
15928 If FILE is omitted, use the file associated with the current
15930 (member (or file (buffer-file-name))
15931 (org-agenda-files t)))
15933 (defun org-edit-agenda-file-list ()
15934 "Edit the list of agenda files.
15935 Depending on setup, this either uses customize to edit the variable
15936 `org-agenda-files', or it visits the file that is holding the list. In the
15937 latter case, the buffer is set up in a way that saving it automatically kills
15938 the buffer and restores the previous window configuration."
15940 (if (stringp org-agenda-files)
15941 (let ((cw (current-window-configuration)))
15942 (find-file org-agenda-files)
15943 (org-set-local 'org-window-configuration cw)
15944 (org-add-hook 'after-save-hook
15946 (set-window-configuration
15947 (prog1 org-window-configuration
15948 (kill-buffer (current-buffer))))
15949 (org-install-agenda-files-menu)
15950 (message "New agenda file list installed"))
15952 (message "%s" (substitute-command-keys
15953 "Edit list and finish with \\[save-buffer]")))
15954 (customize-variable 'org-agenda-files)))
15956 (defun org-store-new-agenda-file-list (list)
15957 "Set new value for the agenda file list and save it correctly."
15958 (if (stringp org-agenda-files)
15959 (let ((fe (org-read-agenda-file-list t)) b u)
15960 (while (setq b (find-buffer-visiting org-agenda-files))
15962 (with-temp-file org-agenda-files
15965 (lambda (f) ;; Keep un-expanded entries.
15966 (if (setq u (assoc f fe))
15971 (let ((org-mode-hook nil) (org-inhibit-startup t)
15972 (org-insert-mode-line-in-empty-file nil))
15973 (setq org-agenda-files list)
15974 (customize-save-variable 'org-agenda-files org-agenda-files))))
15976 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15977 "Read the list of agenda files from a file.
15978 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15979 filenames, used by `org-store-new-agenda-file-list' to write back
15980 un-expanded file names."
15981 (when (file-directory-p org-agenda-files)
15982 (error "`org-agenda-files' cannot be a single directory"))
15983 (when (stringp org-agenda-files)
15985 (insert-file-contents org-agenda-files)
15988 (let ((e (expand-file-name (substitute-in-file-name f)
15990 (if pair-with-expansion
15993 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
15996 (defun org-cycle-agenda-files ()
15997 "Cycle through the files in `org-agenda-files'.
15998 If the current buffer visits an agenda file, find the next one in the list.
15999 If the current buffer does not, find the first agenda file."
16001 (let* ((fs (org-agenda-files t))
16002 (files (append fs (list (car fs))))
16003 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16005 (unless files (error "No agenda files"))
16007 (while (setq file (pop files))
16008 (if (equal (file-truename file) tcf)
16010 (find-file (car files))
16012 (find-file (car fs)))
16013 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16015 (defun org-agenda-file-to-front (&optional to-end)
16016 "Move/add the current file to the top of the agenda file list.
16017 If the file is not present in the list, it is added to the front. If it is
16018 present, it is moved there. With optional argument TO-END, add/move to the
16021 (let ((org-agenda-skip-unavailable-files nil)
16022 (file-alist (mapcar (lambda (x)
16023 (cons (file-truename x) x))
16024 (org-agenda-files t)))
16025 (ctf (file-truename buffer-file-name))
16027 (setq x (assoc ctf file-alist) had x)
16029 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16031 (setq file-alist (append (delq x file-alist) (list x)))
16032 (setq file-alist (cons x (delq x file-alist))))
16033 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16034 (org-install-agenda-files-menu)
16035 (message "File %s to %s of agenda file list"
16036 (if had "moved" "added") (if to-end "end" "front"))))
16038 (defun org-remove-file (&optional file)
16039 "Remove current file from the list of files in variable `org-agenda-files'.
16040 These are the files which are being checked for agenda entries.
16041 Optional argument FILE means use this file instead of the current."
16043 (let* ((org-agenda-skip-unavailable-files nil)
16044 (file (or file buffer-file-name))
16045 (true-file (file-truename file))
16046 (afile (abbreviate-file-name file))
16047 (files (delq nil (mapcar
16049 (if (equal true-file
16052 (org-agenda-files t)))))
16053 (if (not (= (length files) (length (org-agenda-files t))))
16055 (org-store-new-agenda-file-list files)
16056 (org-install-agenda-files-menu)
16057 (message "Removed file: %s" afile))
16058 (message "File was not in list: %s (not removed)" afile))))
16060 (defun org-file-menu-entry (file)
16061 (vector file (list 'find-file file) t))
16063 (defun org-check-agenda-file (file)
16064 "Make sure FILE exists. If not, ask user what to do."
16065 (when (not (file-exists-p file))
16066 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16067 (abbreviate-file-name file))
16068 (let ((r (downcase (read-char-exclusive))))
16071 (org-remove-file file)
16072 (throw 'nextfile t))
16073 (t (error "Abort"))))))
16075 (defun org-get-agenda-file-buffer (file)
16076 "Get a buffer visiting FILE. If the buffer needs to be created, add
16077 it to the list of buffers which might be released later."
16078 (let ((buf (org-find-base-buffer-visiting file)))
16080 buf ; just return it
16081 ;; Make a new buffer and remember it
16082 (setq buf (find-file-noselect file))
16083 (if buf (push buf org-agenda-new-buffers))
16086 (defun org-release-buffers (blist)
16087 "Release all buffers in list, asking the user for confirmation when needed.
16088 When a buffer is unmodified, it is just killed. When modified, it is saved
16089 \(if the user agrees) and then killed."
16091 (while (setq buf (pop blist))
16092 (setq file (buffer-file-name buf))
16093 (when (and (buffer-modified-p buf)
16095 (y-or-n-p (format "Save file %s? " file)))
16096 (with-current-buffer buf (save-buffer)))
16097 (kill-buffer buf))))
16099 (defun org-prepare-agenda-buffers (files)
16100 "Create buffers for all agenda files, protect archived trees and comments."
16102 (let ((pa '(:org-archived t))
16103 (pc '(:org-comment t))
16104 (pall '(:org-archived t :org-comment t))
16105 (inhibit-read-only t)
16106 (rea (concat ":" org-archive-tag ":"))
16110 (while (setq file (pop files))
16114 (org-check-agenda-file file)
16115 (set-buffer (org-get-agenda-file-buffer file)))
16117 (setq bmp (buffer-modified-p))
16118 (org-refresh-category-properties)
16119 (setq org-todo-keywords-for-agenda
16120 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16121 (setq org-done-keywords-for-agenda
16122 (append org-done-keywords-for-agenda org-done-keywords))
16123 (setq org-todo-keyword-alist-for-agenda
16124 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16125 (setq org-drawers-for-agenda
16126 (append org-drawers-for-agenda org-drawers))
16127 (setq org-tag-alist-for-agenda
16128 (append org-tag-alist-for-agenda org-tag-alist))
16131 (remove-text-properties (point-min) (point-max) pall)
16132 (when org-agenda-skip-archived-trees
16133 (goto-char (point-min))
16134 (while (re-search-forward rea nil t)
16135 (if (org-on-heading-p t)
16136 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16137 (goto-char (point-min))
16138 (setq re (concat org-outline-regexp-bol "+" org-comment-string "\\>"))
16139 (while (re-search-forward re nil t)
16140 (add-text-properties
16141 (match-beginning 0) (org-end-of-subtree t) pc)))
16142 (set-buffer-modified-p bmp)))))
16143 (setq org-todo-keywords-for-agenda
16144 (org-uniquify org-todo-keywords-for-agenda))
16145 (setq org-todo-keyword-alist-for-agenda
16146 (org-uniquify org-todo-keyword-alist-for-agenda)
16147 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16149 ;;;; Embedded LaTeX
16151 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16152 "Keymap for the minor `org-cdlatex-mode'.")
16154 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16155 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16156 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16157 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16158 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16160 (defvar org-cdlatex-texmathp-advice-is-done nil
16161 "Flag remembering if we have applied the advice to texmathp already.")
16163 (define-minor-mode org-cdlatex-mode
16164 "Toggle the minor `org-cdlatex-mode'.
16165 This mode supports entering LaTeX environment and math in LaTeX fragments
16167 \\{org-cdlatex-mode-map}"
16169 (when org-cdlatex-mode (require 'cdlatex))
16170 (unless org-cdlatex-texmathp-advice-is-done
16171 (setq org-cdlatex-texmathp-advice-is-done t)
16172 (defadvice texmathp (around org-math-always-on activate)
16173 "Always return t in org-mode buffers.
16174 This is because we want to insert math symbols without dollars even outside
16175 the LaTeX math segments. If Orgmode thinks that point is actually inside
16176 an embedded LaTeX fragment, let texmathp do its job.
16177 \\[org-cdlatex-mode-map]"
16181 ((not (org-mode-p)) ad-do-it)
16182 ((eq this-command 'cdlatex-math-symbol)
16183 (setq ad-return-value t
16184 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16186 (let ((p (org-inside-LaTeX-fragment-p)))
16187 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16188 (setq ad-return-value t
16189 texmathp-why '("Org-mode embedded math" . 0))
16190 (if p ad-do-it)))))))))
16192 (defun turn-on-org-cdlatex ()
16193 "Unconditionally turn on `org-cdlatex-mode'."
16194 (org-cdlatex-mode 1))
16196 (defun org-inside-LaTeX-fragment-p ()
16197 "Test if point is inside a LaTeX fragment.
16198 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
16199 sequence appearing also before point.
16200 Even though the matchers for math are configurable, this function assumes
16201 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
16202 delimiters are skipped when they have been removed by customization.
16203 The return value is nil, or a cons cell with the delimiter and the
16204 position of this delimiter.
16206 This function does a reasonably good job, but can locally be fooled by
16207 for example currency specifications. For example it will assume being in
16208 inline math after \"$22.34\". The LaTeX fragment formatter will only format
16209 fragments that are properly closed, but during editing, we have to live
16210 with the uncertainty caused by missing closing delimiters. This function
16211 looks only before point, not after."
16213 (let ((pos (point))
16214 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16216 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
16218 dd-on str (start 0) m re)
16221 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
16222 re (nth 1 (assoc "$" org-latex-regexps)))
16223 (while (string-match re str start)
16225 ((= (match-end 0) (length str))
16226 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16227 ((= (match-end 0) (- (length str) 5))
16229 (t (setq start (match-end 0))))))
16230 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16232 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16233 (and (match-beginning 2) (throw 'exit nil))
16235 (while (re-search-backward "\\$\\$" lim t)
16236 (setq dd-on (not dd-on)))
16238 (if dd-on (cons "$$" m))))))
16240 (defun org-inside-latex-macro-p ()
16241 "Is point inside a LaTeX macro or its arguments?"
16244 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
16246 (defun org-try-cdlatex-tab ()
16247 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16248 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16249 - inside a LaTeX fragment, or
16250 - after the first word in a line, where an abbreviation expansion could
16251 insert a LaTeX environment."
16252 (when org-cdlatex-mode
16255 (skip-chars-backward "a-zA-Z0-9*")
16256 (skip-chars-backward " \t")
16259 ((org-inside-LaTeX-fragment-p)
16263 (defun org-cdlatex-underscore-caret (&optional arg)
16264 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16265 Revert to the normal definition outside of these fragments."
16267 (if (org-inside-LaTeX-fragment-p)
16268 (call-interactively 'cdlatex-sub-superscript)
16269 (let (org-cdlatex-mode)
16270 (call-interactively (key-binding (vector last-input-event))))))
16272 (defun org-cdlatex-math-modify (&optional arg)
16273 "Execute `cdlatex-math-modify' in LaTeX fragments.
16274 Revert to the normal definition outside of these fragments."
16276 (if (org-inside-LaTeX-fragment-p)
16277 (call-interactively 'cdlatex-math-modify)
16278 (let (org-cdlatex-mode)
16279 (call-interactively (key-binding (vector last-input-event))))))
16281 (defvar org-latex-fragment-image-overlays nil
16282 "List of overlays carrying the images of latex fragments.")
16283 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16285 (defun org-remove-latex-fragment-image-overlays ()
16286 "Remove all overlays with LaTeX fragment images in current buffer."
16287 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16288 (setq org-latex-fragment-image-overlays nil))
16290 (defun org-preview-latex-fragment (&optional subtree)
16291 "Preview the LaTeX fragment at point, or all locally or globally.
16292 If the cursor is in a LaTeX fragment, create the image and overlay
16293 it over the source code. If there is no fragment at point, display
16294 all fragments in the current text, from one headline to the next. With
16295 prefix SUBTREE, display all fragments in the current subtree. With a
16296 double prefix arg \\[universal-argument] \\[universal-argument], or when \
16297 the cursor is before the first headline,
16298 display all fragments in the buffer.
16299 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
16301 (org-remove-latex-fragment-image-overlays)
16304 (let (beg end at msg)
16306 ((or (equal subtree '(16))
16307 (not (save-excursion
16308 (re-search-backward org-outline-regexp-bol nil t))))
16309 (setq beg (point-min) end (point-max)
16310 msg "Creating images for buffer...%s"))
16311 ((equal subtree '(4))
16312 (org-back-to-heading)
16313 (setq beg (point) end (org-end-of-subtree t)
16314 msg "Creating images for subtree...%s"))
16316 (if (setq at (org-inside-LaTeX-fragment-p))
16317 (goto-char (max (point-min) (- (cdr at) 2)))
16318 (org-back-to-heading))
16319 (setq beg (point) end (progn (outline-next-heading) (point))
16320 msg (if at "Creating image...%s"
16321 "Creating images for entry...%s"))))
16323 (narrow-to-region beg end)
16326 (concat "ltxpng/" (file-name-sans-extension
16327 (file-name-nondirectory
16328 buffer-file-name)))
16329 default-directory 'overlays msg at 'forbuffer 'dvipng)
16330 (message msg "done. Use `C-c C-c' to remove images.")))))
16332 (defvar org-latex-regexps
16333 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
16334 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16335 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
16336 ("$1" "\\([^$]\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16337 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16338 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
16339 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
16340 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
16341 "Regular expressions for matching embedded LaTeX.")
16343 (defvar org-export-have-math nil) ;; dynamic scoping
16344 (defun org-format-latex (prefix &optional dir overlays msg at
16345 forbuffer processing-type)
16346 "Replace LaTeX fragments with links to an image, and produce images.
16347 Some of the options can be changed using the variable
16348 `org-format-latex-options'."
16349 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16350 (let* ((prefixnodir (file-name-nondirectory prefix))
16351 (absprefix (expand-file-name prefix dir))
16352 (todir (file-name-directory absprefix))
16353 (opt org-format-latex-options)
16354 (matchers (plist-get opt :matchers))
16355 (re-list org-latex-regexps)
16356 (org-format-latex-header-extra
16357 (plist-get (org-infile-export-plist) :latex-header-extra))
16358 (cnt 0) txt hash link beg end re e checkdir
16359 executables-checked string
16360 m n block linkfile movefile ov)
16361 ;; Check the different regular expressions
16362 (while (setq e (pop re-list))
16363 (setq m (car e) re (nth 1 e) n (nth 2 e)
16364 block (if (nth 3 e) "\n\n" ""))
16365 (when (member m matchers)
16366 (goto-char (point-min))
16367 (while (re-search-forward re nil t)
16368 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16369 (not (get-text-property (match-beginning n)
16372 (not (eq (get-char-property (match-beginning n)
16374 'org-latex-overlay))))
16375 (setq org-export-have-math t)
16377 ((eq processing-type 'verbatim)
16378 ;; Leave the text verbatim, just protect it
16379 (add-text-properties (match-beginning n) (match-end n)
16380 '(org-protected t)))
16381 ((eq processing-type 'mathjax)
16382 ;; Prepare for MathJax processing
16383 (setq string (match-string n))
16384 (if (member m '("$" "$1"))
16386 (delete-region (match-beginning n) (match-end n))
16387 (goto-char (match-beginning n))
16388 (insert (org-add-props (concat "\\(" (substring string 1 -1)
16390 '(org-protected t))))
16391 (add-text-properties (match-beginning n) (match-end n)
16392 '(org-protected t))))
16393 ((or (eq processing-type 'dvipng) t)
16394 ;; Process to an image
16395 (setq txt (match-string n)
16396 beg (match-beginning n) end (match-end n)
16398 (let (print-length print-level) ; make sure full list is printed
16399 (setq hash (sha1 (prin1-to-string
16400 (list org-format-latex-header
16401 org-format-latex-header-extra
16402 org-export-latex-default-packages-alist
16403 org-export-latex-packages-alist
16404 org-format-latex-options
16406 linkfile (format "%s_%s.png" prefix hash)
16407 movefile (format "%s_%s.png" absprefix hash)))
16408 (setq link (concat block "[[file:" linkfile "]]" block))
16409 (if msg (message msg cnt))
16411 (unless checkdir ; make sure the directory exists
16413 (or (file-directory-p todir) (make-directory todir t)))
16415 (unless executables-checked
16416 (org-check-external-command
16417 "latex" "needed to convert LaTeX fragments to images")
16418 (org-check-external-command
16419 "dvipng" "needed to convert LaTeX fragments to images")
16420 (setq executables-checked t))
16422 (unless (file-exists-p movefile)
16423 (org-create-formula-image
16424 txt movefile opt forbuffer))
16428 (if (eq (overlay-get o 'org-overlay-type)
16429 'org-latex-overlay)
16430 (delete-overlay o)))
16431 (overlays-in beg end))
16432 (setq ov (make-overlay beg end))
16433 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16434 (if (featurep 'xemacs)
16436 (overlay-put ov 'invisible t)
16439 (make-glyph (vector 'png :file movefile))))
16442 (list 'image :type 'png :file movefile :ascent 'center)))
16443 (push ov org-latex-fragment-image-overlays)
16445 (delete-region beg end)
16446 (insert (org-add-props link
16447 (list 'org-latex-src
16448 (replace-regexp-in-string
16449 "\"" "" txt)))))))))))))
16451 ;; This function borrows from Ganesh Swami's latex2png.el
16452 (defun org-create-formula-image (string tofile options buffer)
16453 "This calls dvipng."
16454 (require 'org-latex)
16455 (let* ((tmpdir (if (featurep 'xemacs)
16457 temporary-file-directory))
16458 (texfilebase (make-temp-name
16459 (expand-file-name "orgtex" tmpdir)))
16460 (texfile (concat texfilebase ".tex"))
16461 (dvifile (concat texfilebase ".dvi"))
16462 (pngfile (concat texfilebase ".png"))
16463 (fnh (if (featurep 'xemacs)
16464 (font-height (get-face-font 'default))
16465 (face-attribute 'default :height nil)))
16466 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16467 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16468 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16470 (bg (or (plist-get options (if buffer :background :html-background))
16472 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16473 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16474 (with-temp-file texfile
16475 (insert (org-splice-latex-header
16476 org-format-latex-header
16477 org-export-latex-default-packages-alist
16478 org-export-latex-packages-alist t
16479 org-format-latex-header-extra))
16480 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
16481 (require 'org-latex)
16482 (org-export-latex-fix-inputenc))
16483 (let ((dir default-directory))
16484 (condition-case nil
16487 (call-process "latex" nil nil nil texfile))
16490 (if (not (file-exists-p dvifile))
16491 (progn (message "Failed to create dvi file from %s" texfile) nil)
16492 (condition-case nil
16493 (call-process "dvipng" nil nil nil
16496 ;;"-x" scale "-y" scale
16501 (if (not (file-exists-p pngfile))
16502 (if org-format-latex-signal-error
16503 (error "Failed to create png file from %s" texfile)
16504 (message "Failed to create png file from %s" texfile)
16506 ;; Use the requested file name and clean up
16507 (copy-file pngfile tofile 'replace)
16508 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16509 (delete-file (concat texfilebase e)))
16512 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16513 "Fill a LaTeX header template TPL.
16514 In the template, the following place holders will be recognized:
16516 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
16517 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16518 [PACKAGES] \\usepackage statements for PKG
16519 [NO-PACKAGES] do not include PKG
16520 [EXTRA] the string EXTRA
16521 [NO-EXTRA] do not include EXTRA
16523 For backward compatibility, if both the positive and the negative place
16524 holder is missing, the positive one (without the \"NO-\") will be
16525 assumed to be present at the end of the template.
16526 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16528 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16529 (let (rpl (end ""))
16530 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
16531 (setq rpl (if (or (match-end 1) (not def-pkg))
16532 "" (org-latex-packages-to-string def-pkg snippets-p t))
16533 tpl (replace-match rpl t t tpl))
16534 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16536 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
16537 (setq rpl (if (or (match-end 1) (not pkg))
16538 "" (org-latex-packages-to-string pkg snippets-p t))
16539 tpl (replace-match rpl t t tpl))
16542 (org-latex-packages-to-string pkg snippets-p)))))
16544 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
16545 (setq rpl (if (or (match-end 1) (not extra))
16546 "" (concat extra "\n"))
16547 tpl (replace-match rpl t t tpl))
16548 (if (and extra (string-match "\\S-" extra))
16549 (setq end (concat end "\n" extra))))
16551 (if (string-match "\\S-" end)
16552 (concat tpl "\n" end)
16555 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16556 "Turn an alist of packages into a string with the \\usepackage macros."
16557 (setq pkg (mapconcat (lambda(p)
16560 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16561 (format "%% Package %s omitted" (cadr p)))
16562 ((equal "" (car p))
16563 (format "\\usepackage{%s}" (cadr p)))
16565 (format "\\usepackage[%s]{%s}"
16566 (car p) (cadr p)))))
16569 (if newline (concat pkg "\n") pkg))
16571 (defun org-dvipng-color (attr)
16572 "Return an rgb color specification for dvipng."
16573 (apply 'format "rgb %s %s %s"
16574 (mapcar 'org-normalize-color
16575 (color-values (face-attribute 'default attr nil)))))
16577 (defun org-normalize-color (value)
16578 "Return string to be used as color value for an RGB component."
16579 (format "%g" (/ value 65535.0)))
16584 (defvar org-inline-image-overlays nil)
16585 (make-variable-buffer-local 'org-inline-image-overlays)
16587 (defun org-toggle-inline-images (&optional include-linked)
16588 "Toggle the display of inline images.
16589 INCLUDE-LINKED is passed to `org-display-inline-images'."
16591 (if org-inline-image-overlays
16593 (org-remove-inline-images)
16594 (message "Inline image display turned off"))
16595 (org-display-inline-images include-linked)
16596 (if org-inline-image-overlays
16597 (message "%d images displayed inline"
16598 (length org-inline-image-overlays))
16599 (message "No images to display inline"))))
16601 (defun org-display-inline-images (&optional include-linked refresh beg end)
16602 "Display inline images.
16603 Normally only links without a description part are inlined, because this
16604 is how it will work for export. When INCLUDE-LINKED is set, also links
16605 with a description part will be inlined. This can be nice for a quick
16606 look at those images, but it does not reflect what exported files will look
16608 When REFRESH is set, refresh existing images between BEG and END.
16609 This will create new image displays only if necessary.
16610 BEG and END default to the buffer boundaries."
16613 (org-remove-inline-images)
16614 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16618 (setq beg (or beg (point-min)) end (or end (point-max)))
16619 (goto-char (point-min))
16620 (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
16621 (substring (org-image-file-name-regexp) 0 -2)
16622 "\\)\\]" (if include-linked "" "\\]")))
16624 (while (re-search-forward re end t)
16625 (setq old (get-char-property-and-overlay (match-beginning 1)
16626 'org-image-overlay))
16627 (setq file (expand-file-name
16628 (concat (or (match-string 3) "") (match-string 4))))
16629 (when (file-exists-p file)
16630 (if (and (car-safe old) refresh)
16631 (image-refresh (overlay-get (cdr old) 'display))
16632 (setq img (save-match-data (create-image file)))
16634 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16635 (overlay-put ov 'display img)
16636 (overlay-put ov 'face 'default)
16637 (overlay-put ov 'org-image-overlay t)
16638 (overlay-put ov 'modification-hooks
16639 (list 'org-display-inline-modification-hook))
16640 (push ov org-inline-image-overlays)))))))))
16642 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16643 "Remove inline-display overlay if a corresponding region is modified."
16644 (let ((inhibit-modification-hooks t))
16645 (when (and ov after)
16646 (delete ov org-inline-image-overlays)
16647 (delete-overlay ov))))
16649 (defun org-remove-inline-images ()
16650 "Remove inline display of images."
16652 (mapc 'delete-overlay org-inline-image-overlays)
16653 (setq org-inline-image-overlays nil))
16657 ;; Make `C-c C-x' a prefix key
16658 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16660 ;; TAB key with modifiers
16661 (org-defkey org-mode-map "\C-i" 'org-cycle)
16662 (org-defkey org-mode-map [(tab)] 'org-cycle)
16663 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16664 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16665 (org-defkey org-mode-map "\M-\t" 'pcomplete)
16666 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16667 ;; The following line is necessary under Suse GNU/Linux
16668 (unless (featurep 'xemacs)
16669 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16670 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16671 (define-key org-mode-map [backtab] 'org-shifttab)
16673 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16674 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16675 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16677 ;; Cursor keys with modifiers
16678 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16679 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16680 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16681 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16683 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16684 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16685 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16686 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16688 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16689 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16690 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16691 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16693 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16694 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16695 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16696 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16699 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16700 (mapc (lambda (pair)
16701 (define-key org-babel-map (car pair) (cdr pair)))
16702 org-babel-key-bindings)
16704 ;;; Extra keys for tty access.
16705 ;; We only set them when really needed because otherwise the
16706 ;; menus don't show the simple keys
16708 (when (or org-use-extra-keys
16709 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16710 (not window-system))
16711 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16712 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16713 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16714 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16715 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16716 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16717 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16718 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16719 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16720 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16721 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16722 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16723 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16724 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16725 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16726 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16727 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16728 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16729 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16730 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16731 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16732 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16733 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16734 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16735 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16736 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16737 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16738 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16740 ;; All the other keys
16742 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16743 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16744 (if (boundp 'narrow-map)
16745 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16746 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16747 (if (boundp 'narrow-map)
16748 (org-defkey narrow-map "b" 'org-narrow-to-block)
16749 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16750 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16751 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16752 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16753 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16754 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16755 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16756 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16757 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16758 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16759 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16760 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16761 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16762 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16763 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16764 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16765 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16766 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
16767 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16768 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16769 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16770 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16771 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16772 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16773 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16774 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16775 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16776 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16777 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16778 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16779 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16780 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16781 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16782 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16783 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16784 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16785 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16786 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
16787 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16788 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16789 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16790 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16791 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16792 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16793 (org-defkey org-mode-map "\C-c^" 'org-sort)
16794 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16795 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16796 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16797 (org-defkey org-mode-map "\C-m" 'org-return)
16798 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16799 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16800 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16801 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16802 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16803 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16804 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16805 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16806 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16807 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16808 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16809 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16810 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16811 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16812 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16813 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16814 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16815 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16816 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16817 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16818 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16819 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16821 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16822 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16823 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16824 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16826 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16827 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16828 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16829 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16830 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16831 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16832 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16833 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16834 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16835 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16836 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
16837 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16838 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16839 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16840 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16841 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16842 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16843 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16845 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16846 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16847 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16848 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16849 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16851 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16853 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16855 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16856 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16858 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16861 (when (featurep 'xemacs)
16862 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16865 (defconst org-speed-commands-default
16867 ("Outline Navigation")
16868 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16869 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16870 ("f" . (org-speed-move-safe 'org-forward-same-level))
16871 ("b" . (org-speed-move-safe 'org-backward-same-level))
16872 ("u" . (org-speed-move-safe 'outline-up-heading))
16874 ("g" . (org-refile t))
16875 ("Outline Visibility")
16877 ("C" . org-shifttab)
16878 (" " . org-display-outline-path)
16879 ("Outline Structure Editing")
16880 ("U" . org-shiftmetaup)
16881 ("D" . org-shiftmetadown)
16882 ("r" . org-metaright)
16883 ("l" . org-metaleft)
16884 ("R" . org-shiftmetaright)
16885 ("L" . org-shiftmetaleft)
16886 ("i" . (progn (forward-char 1) (call-interactively
16887 'org-insert-heading-respect-content)))
16890 ("a" . org-archive-subtree-default-with-confirmation)
16891 ("." . org-mark-subtree)
16893 ("I" . org-clock-in)
16894 ("O" . org-clock-out)
16895 ("Meta Data Editing")
16897 ("0" . (org-priority ?\ ))
16898 ("1" . (org-priority ?A))
16899 ("2" . (org-priority ?B))
16900 ("3" . (org-priority ?C))
16901 (";" . org-set-tags-command)
16902 ("e" . org-set-effort)
16903 ("Agenda Views etc")
16905 ("/" . org-sparse-tree)
16907 ("o" . org-open-at-point)
16908 ("?" . org-speed-command-help)
16909 ("<" . (org-agenda-set-restriction-lock 'subtree))
16910 (">" . (org-agenda-remove-restriction-lock))
16912 "The default speed commands.")
16914 (defun org-print-speed-command (e)
16915 (if (> (length (car e)) 1)
16920 (princ (make-string (length (car e)) ?-))
16924 (if (symbolp (cdr e))
16925 (princ (symbol-name (cdr e)))
16929 (defun org-speed-command-help ()
16930 "Show the available speed commands."
16932 (if (not org-use-speed-commands)
16933 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16934 (with-output-to-temp-buffer "*Help*"
16935 (princ "User-defined Speed commands\n===========================\n")
16936 (mapc 'org-print-speed-command org-speed-commands-user)
16938 (princ "Built-in Speed commands\n=======================\n")
16939 (mapc 'org-print-speed-command org-speed-commands-default))
16940 (with-current-buffer "*Help*"
16941 (setq truncate-lines t))))
16943 (defun org-speed-move-safe (cmd)
16944 "Execute CMD, but make sure that the cursor always ends up in a headline.
16945 If not, return to the original position and throw an error."
16947 (let ((pos (point)))
16948 (call-interactively cmd)
16949 (unless (and (bolp) (org-on-heading-p))
16951 (error "Boundary reached while executing %s" cmd))))
16953 (defvar org-self-insert-command-undo-counter 0)
16955 (defvar org-table-auto-blank-field) ; defined in org-table.el
16956 (defvar org-speed-command nil)
16958 (defun org-speed-command-default-hook (keys)
16959 "Hook for activating single-letter speed commands.
16960 `org-speed-commands-default' specifies a minimal command set. Use
16961 `org-speed-commands-user' for further customization."
16962 (when (or (and (bolp) (looking-at org-outline-regexp))
16963 (and (functionp org-use-speed-commands)
16964 (funcall org-use-speed-commands)))
16965 (cdr (assoc keys (append org-speed-commands-user
16966 org-speed-commands-default)))))
16968 (defun org-babel-speed-command-hook (keys)
16969 "Hook for activating single-letter code block commands."
16970 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16971 (cdr (assoc keys org-babel-key-bindings))))
16973 (defcustom org-speed-command-hook
16974 '(org-speed-command-default-hook org-babel-speed-command-hook)
16975 "Hook for activating speed commands at strategic locations.
16976 Hook functions are called in sequence until a valid handler is
16979 Each hook takes a single argument, a user-pressed command key
16980 which is also a `self-insert-command' from the global map.
16982 Within the hook, examine the cursor position and the command key
16983 and return nil or a valid handler as appropriate. Handler could
16984 be one of an interactive command, a function, or a form.
16986 Set `org-use-speed-commands' to non-nil value to enable this
16987 hook. The default setting is `org-speed-command-default-hook'."
16988 :group 'org-structure
16991 (defun org-self-insert-command (N)
16992 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16993 If the cursor is in a table looking at whitespace, the whitespace is
16994 overwritten, and the table is not marked as requiring realignment."
16997 ((and org-use-speed-commands
16998 (setq org-speed-command
16999 (run-hook-with-args-until-success
17000 'org-speed-command-hook (this-command-keys))))
17002 ((commandp org-speed-command)
17003 (setq this-command org-speed-command)
17004 (call-interactively org-speed-command))
17005 ((functionp org-speed-command)
17006 (funcall org-speed-command))
17007 ((and org-speed-command (listp org-speed-command))
17008 (eval org-speed-command))
17009 (t (let (org-use-speed-commands)
17010 (call-interactively 'org-self-insert-command)))))
17014 ;; check if we blank the field, and if that triggers align
17015 (and (featurep 'org-table) org-table-auto-blank-field
17016 (member last-command
17017 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17018 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
17019 ;; got extra space, this field does not determine column width
17020 (let (org-table-may-need-update) (org-table-blank-field))
17021 ;; no extra space, this field may determine column width
17022 (org-table-blank-field)))
17025 (looking-at "[^|\n]* |"))
17026 (let (org-table-may-need-update)
17027 (goto-char (1- (match-end 0)))
17029 (goto-char (match-beginning 0))
17030 (self-insert-command N)))
17032 (setq org-table-may-need-update t)
17033 (self-insert-command N)
17034 (org-fix-tags-on-the-fly)
17035 (if org-self-insert-cluster-for-undo
17036 (if (not (eq last-command 'org-self-insert-command))
17037 (setq org-self-insert-command-undo-counter 1)
17038 (if (>= org-self-insert-command-undo-counter 20)
17039 (setq org-self-insert-command-undo-counter 1)
17040 (and (> org-self-insert-command-undo-counter 0)
17041 buffer-undo-list (listp buffer-undo-list)
17042 (not (cadr buffer-undo-list)) ; remove nil entry
17043 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17044 (setq org-self-insert-command-undo-counter
17045 (1+ org-self-insert-command-undo-counter))))))))
17047 (defun org-fix-tags-on-the-fly ()
17048 (when (and (equal (char-after (point-at-bol)) ?*)
17049 (org-on-heading-p))
17050 (org-align-tags-here org-tags-column)))
17052 (defun org-delete-backward-char (N)
17053 "Like `delete-backward-char', insert whitespace at field end in tables.
17054 When deleting backwards, in tables this function will insert whitespace in
17055 front of the next \"|\" separator, to keep the table aligned. The table will
17056 still be marked for re-alignment if the field did fill the entire column,
17057 because, in this case the deletion might narrow the column."
17059 (if (and (org-table-p)
17061 (string-match "|" (buffer-substring (point-at-bol) (point)))
17062 (looking-at ".*?|"))
17063 (let ((pos (point))
17064 (noalign (looking-at "[^|\n\r]* |"))
17065 (c org-table-may-need-update))
17066 (backward-delete-char N)
17067 (if (not overwrite-mode)
17069 (skip-chars-forward "^|")
17071 (goto-char (1- pos))))
17072 ;; noalign: if there were two spaces at the end, this field
17073 ;; does not determine the width of the column.
17074 (if noalign (setq org-table-may-need-update c)))
17075 (backward-delete-char N)
17076 (org-fix-tags-on-the-fly)))
17078 (defun org-delete-char (N)
17079 "Like `delete-char', but insert whitespace at field end in tables.
17080 When deleting characters, in tables this function will insert whitespace in
17081 front of the next \"|\" separator, to keep the table aligned. The table will
17082 still be marked for re-alignment if the field did fill the entire column,
17083 because, in this case the deletion might narrow the column."
17085 (if (and (org-table-p)
17087 (not (= (char-after) ?|))
17089 (if (looking-at ".*?|")
17090 (let ((pos (point))
17091 (noalign (looking-at "[^|\n\r]* |"))
17092 (c org-table-may-need-update))
17093 (replace-match (concat
17094 (substring (match-string 0) 1 -1)
17097 ;; noalign: if there were two spaces at the end, this field
17098 ;; does not determine the width of the column.
17099 (if noalign (setq org-table-may-need-update c)))
17102 (org-fix-tags-on-the-fly)))
17104 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17105 (put 'org-self-insert-command 'delete-selection t)
17106 (put 'orgtbl-self-insert-command 'delete-selection t)
17107 (put 'org-delete-char 'delete-selection 'supersede)
17108 (put 'org-delete-backward-char 'delete-selection 'supersede)
17109 (put 'org-yank 'delete-selection 'yank)
17111 ;; Make `flyspell-mode' delay after some commands
17112 (put 'org-self-insert-command 'flyspell-delayed t)
17113 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17114 (put 'org-delete-char 'flyspell-delayed t)
17115 (put 'org-delete-backward-char 'flyspell-delayed t)
17117 ;; Make pabbrev-mode expand after org-mode commands
17118 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17119 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17121 ;; How to do this: Measure non-white length of current string
17122 ;; If equal to column width, we should realign.
17124 (defun org-remap (map &rest commands)
17125 "In MAP, remap the functions given in COMMANDS.
17126 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17129 (setq old (pop commands) new (pop commands))
17130 (if (fboundp 'command-remapping)
17131 (org-defkey map (vector 'remap old) new)
17132 (substitute-key-definition old new map global-map)))))
17134 (when (eq org-enable-table-editor 'optimized)
17135 ;; If the user wants maximum table support, we need to hijack
17136 ;; some standard editing functions
17137 (org-remap org-mode-map
17138 'self-insert-command 'org-self-insert-command
17139 'delete-char 'org-delete-char
17140 'delete-backward-char 'org-delete-backward-char)
17141 (org-defkey org-mode-map "|" 'org-force-self-insert))
17143 (defvar org-ctrl-c-ctrl-c-hook nil
17144 "Hook for functions attaching themselves to `C-c C-c'.
17145 This can be used to add additional functionality to the C-c C-c key which
17146 executes context-dependent commands.
17147 Each function will be called with no arguments. The function must check
17148 if the context is appropriate for it to act. If yes, it should do its
17149 thing and then return a non-nil value. If the context is wrong,
17150 just do nothing and return nil.")
17152 (defvar org-tab-first-hook nil
17153 "Hook for functions to attach themselves to TAB.
17154 See `org-ctrl-c-ctrl-c-hook' for more information.
17155 This hook runs as the first action when TAB is pressed, even before
17156 `org-cycle' messes around with the `outline-regexp' to cater for
17157 inline tasks and plain list item folding.
17158 If any function in this hook returns t, any other actions that
17159 would have been caused by TAB (such as table field motion or visibility
17160 cycling) will not occur.")
17162 (defvar org-tab-after-check-for-table-hook nil
17163 "Hook for functions to attach themselves to TAB.
17164 See `org-ctrl-c-ctrl-c-hook' for more information.
17165 This hook runs after it has been established that the cursor is not in a
17166 table, but before checking if the cursor is in a headline or if global cycling
17168 If any function in this hook returns t, not other actions like visibility
17169 cycling will be done.")
17171 (defvar org-tab-after-check-for-cycling-hook nil
17172 "Hook for functions to attach themselves to TAB.
17173 See `org-ctrl-c-ctrl-c-hook' for more information.
17174 This hook runs after it has been established that not table field motion and
17175 not visibility should be done because of current context. This is probably
17176 the place where a package like yasnippets can hook in.")
17178 (defvar org-tab-before-tab-emulation-hook nil
17179 "Hook for functions to attach themselves to TAB.
17180 See `org-ctrl-c-ctrl-c-hook' for more information.
17181 This hook runs after every other options for TAB have been exhausted, but
17182 before indentation and \t insertion takes place.")
17184 (defvar org-metaleft-hook nil
17185 "Hook for functions attaching themselves to `M-left'.
17186 See `org-ctrl-c-ctrl-c-hook' for more information.")
17187 (defvar org-metaright-hook nil
17188 "Hook for functions attaching themselves to `M-right'.
17189 See `org-ctrl-c-ctrl-c-hook' for more information.")
17190 (defvar org-metaup-hook nil
17191 "Hook for functions attaching themselves to `M-up'.
17192 See `org-ctrl-c-ctrl-c-hook' for more information.")
17193 (defvar org-metadown-hook nil
17194 "Hook for functions attaching themselves to `M-down'.
17195 See `org-ctrl-c-ctrl-c-hook' for more information.")
17196 (defvar org-shiftmetaleft-hook nil
17197 "Hook for functions attaching themselves to `M-S-left'.
17198 See `org-ctrl-c-ctrl-c-hook' for more information.")
17199 (defvar org-shiftmetaright-hook nil
17200 "Hook for functions attaching themselves to `M-S-right'.
17201 See `org-ctrl-c-ctrl-c-hook' for more information.")
17202 (defvar org-shiftmetaup-hook nil
17203 "Hook for functions attaching themselves to `M-S-up'.
17204 See `org-ctrl-c-ctrl-c-hook' for more information.")
17205 (defvar org-shiftmetadown-hook nil
17206 "Hook for functions attaching themselves to `M-S-down'.
17207 See `org-ctrl-c-ctrl-c-hook' for more information.")
17208 (defvar org-metareturn-hook nil
17209 "Hook for functions attaching themselves to `M-RET'.
17210 See `org-ctrl-c-ctrl-c-hook' for more information.")
17211 (defvar org-shiftup-hook nil
17212 "Hook for functions attaching themselves to `S-up'.
17213 See `org-ctrl-c-ctrl-c-hook' for more information.")
17214 (defvar org-shiftup-final-hook nil
17215 "Hook for functions attaching themselves to `S-up'.
17216 This one runs after all other options except shift-select have been excluded.
17217 See `org-ctrl-c-ctrl-c-hook' for more information.")
17218 (defvar org-shiftdown-hook nil
17219 "Hook for functions attaching themselves to `S-down'.
17220 See `org-ctrl-c-ctrl-c-hook' for more information.")
17221 (defvar org-shiftdown-final-hook nil
17222 "Hook for functions attaching themselves to `S-down'.
17223 This one runs after all other options except shift-select have been excluded.
17224 See `org-ctrl-c-ctrl-c-hook' for more information.")
17225 (defvar org-shiftleft-hook nil
17226 "Hook for functions attaching themselves to `S-left'.
17227 See `org-ctrl-c-ctrl-c-hook' for more information.")
17228 (defvar org-shiftleft-final-hook nil
17229 "Hook for functions attaching themselves to `S-left'.
17230 This one runs after all other options except shift-select have been excluded.
17231 See `org-ctrl-c-ctrl-c-hook' for more information.")
17232 (defvar org-shiftright-hook nil
17233 "Hook for functions attaching themselves to `S-right'.
17234 See `org-ctrl-c-ctrl-c-hook' for more information.")
17235 (defvar org-shiftright-final-hook nil
17236 "Hook for functions attaching themselves to `S-right'.
17237 This one runs after all other options except shift-select have been excluded.
17238 See `org-ctrl-c-ctrl-c-hook' for more information.")
17240 (defun org-modifier-cursor-error ()
17241 "Throw an error, a modified cursor command was applied in wrong context."
17242 (error "This command is active in special context like tables, headlines or items"))
17244 (defun org-shiftselect-error ()
17245 "Throw an error because Shift-Cursor command was applied in wrong context."
17246 (if (and (boundp 'shift-select-mode) shift-select-mode)
17247 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17248 (error "This command works only in special context like headlines or timestamps")))
17250 (defun org-call-for-shift-select (cmd)
17251 (let ((this-command-keys-shift-translated t))
17252 (call-interactively cmd)))
17254 (defun org-shifttab (&optional arg)
17255 "Global visibility cycling or move to previous table field.
17256 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17258 See the individual commands for more information."
17261 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17263 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17264 (message "Content view to level: %d" arg)
17265 (org-content (prefix-numeric-value arg2))
17266 (setq org-cycle-global-status 'overview)))
17267 (t (call-interactively 'org-global-cycle))))
17269 (defun org-shiftmetaleft ()
17270 "Promote subtree or delete table column.
17271 Calls `org-promote-subtree', `org-outdent-item',
17272 or `org-table-delete-column', depending on context.
17273 See the individual commands for more information."
17276 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17277 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17278 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17279 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17280 (t (org-modifier-cursor-error))))
17282 (defun org-shiftmetaright ()
17283 "Demote subtree or insert table column.
17284 Calls `org-demote-subtree', `org-indent-item',
17285 or `org-table-insert-column', depending on context.
17286 See the individual commands for more information."
17289 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17290 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17291 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17292 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17293 (t (org-modifier-cursor-error))))
17295 (defun org-shiftmetaup (&optional arg)
17296 "Move subtree up or kill table row.
17297 Calls `org-move-subtree-up' or `org-table-kill-row' or
17298 `org-move-item-up' depending on context. See the individual commands
17299 for more information."
17302 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17303 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17304 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17305 ((org-at-item-p) (call-interactively 'org-move-item-up))
17306 (t (org-modifier-cursor-error))))
17308 (defun org-shiftmetadown (&optional arg)
17309 "Move subtree down or insert table row.
17310 Calls `org-move-subtree-down' or `org-table-insert-row' or
17311 `org-move-item-down', depending on context. See the individual
17312 commands for more information."
17315 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17316 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17317 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17318 ((org-at-item-p) (call-interactively 'org-move-item-down))
17319 (t (org-modifier-cursor-error))))
17321 (defsubst org-hidden-tree-error ()
17323 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17325 (defun org-metaleft (&optional arg)
17326 "Promote heading or move table column to left.
17327 Calls `org-do-promote' or `org-table-move-column', depending on context.
17328 With no specific context, calls the Emacs default `backward-word'.
17329 See the individual commands for more information."
17332 ((run-hook-with-args-until-success 'org-metaleft-hook))
17333 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17334 ((org-with-limited-levels
17335 (or (org-on-heading-p)
17336 (and (org-region-active-p)
17338 (goto-char (region-beginning))
17339 (org-on-heading-p)))))
17340 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17341 (call-interactively 'org-do-promote))
17342 ;; At an inline task.
17343 ((org-on-heading-p)
17344 (call-interactively 'org-inlinetask-promote))
17345 ((or (org-at-item-p)
17346 (and (org-region-active-p)
17348 (goto-char (region-beginning))
17350 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17351 (call-interactively 'org-outdent-item))
17352 (t (call-interactively 'backward-word))))
17354 (defun org-metaright (&optional arg)
17355 "Demote subtree or move table column to right.
17356 Calls `org-do-demote' or `org-table-move-column', depending on context.
17357 With no specific context, calls the Emacs default `forward-word'.
17358 See the individual commands for more information."
17361 ((run-hook-with-args-until-success 'org-metaright-hook))
17362 ((org-at-table-p) (call-interactively 'org-table-move-column))
17363 ((org-with-limited-levels
17364 (or (org-on-heading-p)
17365 (and (org-region-active-p)
17367 (goto-char (region-beginning))
17368 (org-on-heading-p)))))
17369 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17370 (call-interactively 'org-do-demote))
17371 ;; At an inline task.
17372 ((org-on-heading-p)
17373 (call-interactively 'org-inlinetask-demote))
17374 ((or (org-at-item-p)
17375 (and (org-region-active-p)
17377 (goto-char (region-beginning))
17379 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17380 (call-interactively 'org-indent-item))
17381 (t (call-interactively 'forward-word))))
17383 (defun org-check-for-hidden (what)
17384 "Check if there are hidden headlines/items in the current visual line.
17385 WHAT can be either `headlines' or `items'. If the current line is
17386 an outline or item heading and it has a folded subtree below it,
17387 this function returns t, nil otherwise."
17389 ((eq what 'headlines) org-outline-regexp-bol)
17390 ((eq what 'items) (org-item-beginning-re))
17391 (t (error "This should not happen"))))
17395 (unless (org-region-active-p)
17396 (setq beg (point-at-bol))
17397 (beginning-of-line 2)
17398 (while (and (not (eobp)) ;; this is like `next-line'
17399 (get-char-property (1- (point)) 'invisible))
17400 (beginning-of-line 2))
17403 (goto-char (point-at-eol))
17404 (setq end (max end (point)))
17405 (while (re-search-forward re end t)
17406 (if (get-char-property (match-beginning 0) 'invisible)
17410 (defun org-metaup (&optional arg)
17411 "Move subtree up or move table row up.
17412 Calls `org-move-subtree-up' or `org-table-move-row' or
17413 `org-move-item-up', depending on context. See the individual commands
17414 for more information."
17417 ((run-hook-with-args-until-success 'org-metaup-hook))
17418 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17419 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17420 ((org-at-item-p) (call-interactively 'org-move-item-up))
17421 (t (transpose-lines 1) (beginning-of-line -1))))
17423 (defun org-metadown (&optional arg)
17424 "Move subtree down or move table row down.
17425 Calls `org-move-subtree-down' or `org-table-move-row' or
17426 `org-move-item-down', depending on context. See the individual
17427 commands for more information."
17430 ((run-hook-with-args-until-success 'org-metadown-hook))
17431 ((org-at-table-p) (call-interactively 'org-table-move-row))
17432 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17433 ((org-at-item-p) (call-interactively 'org-move-item-down))
17434 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17436 (defun org-shiftup (&optional arg)
17437 "Increase item in timestamp or increase priority of current headline.
17438 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17439 depending on context. See the individual commands for more information."
17442 ((run-hook-with-args-until-success 'org-shiftup-hook))
17443 ((and org-support-shift-select (org-region-active-p))
17444 (org-call-for-shift-select 'previous-line))
17445 ((org-at-timestamp-p t)
17446 (call-interactively (if org-edit-timestamp-down-means-later
17447 'org-timestamp-down 'org-timestamp-up)))
17448 ((and (not (eq org-support-shift-select 'always))
17449 org-enable-priority-commands
17450 (org-on-heading-p))
17451 (call-interactively 'org-priority-up))
17452 ((and (not org-support-shift-select) (org-at-item-p))
17453 (call-interactively 'org-previous-item))
17454 ((org-clocktable-try-shift 'up arg))
17455 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17456 (org-support-shift-select
17457 (org-call-for-shift-select 'previous-line))
17458 (t (org-shiftselect-error))))
17460 (defun org-shiftdown (&optional arg)
17461 "Decrease item in timestamp or decrease priority of current headline.
17462 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17463 depending on context. See the individual commands for more information."
17466 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17467 ((and org-support-shift-select (org-region-active-p))
17468 (org-call-for-shift-select 'next-line))
17469 ((org-at-timestamp-p t)
17470 (call-interactively (if org-edit-timestamp-down-means-later
17471 'org-timestamp-up 'org-timestamp-down)))
17472 ((and (not (eq org-support-shift-select 'always))
17473 org-enable-priority-commands
17474 (org-on-heading-p))
17475 (call-interactively 'org-priority-down))
17476 ((and (not org-support-shift-select) (org-at-item-p))
17477 (call-interactively 'org-next-item))
17478 ((org-clocktable-try-shift 'down arg))
17479 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17480 (org-support-shift-select
17481 (org-call-for-shift-select 'next-line))
17482 (t (org-shiftselect-error))))
17484 (defun org-shiftright (&optional arg)
17485 "Cycle the thing at point or in the current line, depending on context.
17486 Depending on context, this does one of the following:
17488 - switch a timestamp at point one day into the future
17489 - on a headline, switch to the next TODO keyword.
17490 - on an item, switch entire list to the next bullet type
17491 - on a property line, switch to the next allowed value
17492 - on a clocktable definition line, move time block into the future"
17495 ((run-hook-with-args-until-success 'org-shiftright-hook))
17496 ((and org-support-shift-select (org-region-active-p))
17497 (org-call-for-shift-select 'forward-char))
17498 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17499 ((and (not (eq org-support-shift-select 'always))
17500 (org-on-heading-p))
17501 (let ((org-inhibit-logging
17502 (not org-treat-S-cursor-todo-selection-as-state-change))
17503 (org-inhibit-blocking
17504 (not org-treat-S-cursor-todo-selection-as-state-change)))
17505 (org-call-with-arg 'org-todo 'right)))
17506 ((or (and org-support-shift-select
17507 (not (eq org-support-shift-select 'always))
17508 (org-at-item-bullet-p))
17509 (and (not org-support-shift-select) (org-at-item-p)))
17510 (org-call-with-arg 'org-cycle-list-bullet nil))
17511 ((and (not (eq org-support-shift-select 'always))
17512 (org-at-property-p))
17513 (call-interactively 'org-property-next-allowed-value))
17514 ((org-clocktable-try-shift 'right arg))
17515 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17516 (org-support-shift-select
17517 (org-call-for-shift-select 'forward-char))
17518 (t (org-shiftselect-error))))
17520 (defun org-shiftleft (&optional arg)
17521 "Cycle the thing at point or in the current line, depending on context.
17522 Depending on context, this does one of the following:
17524 - switch a timestamp at point one day into the past
17525 - on a headline, switch to the previous TODO keyword.
17526 - on an item, switch entire list to the previous bullet type
17527 - on a property line, switch to the previous allowed value
17528 - on a clocktable definition line, move time block into the past"
17531 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17532 ((and org-support-shift-select (org-region-active-p))
17533 (org-call-for-shift-select 'backward-char))
17534 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17535 ((and (not (eq org-support-shift-select 'always))
17536 (org-on-heading-p))
17537 (let ((org-inhibit-logging
17538 (not org-treat-S-cursor-todo-selection-as-state-change))
17539 (org-inhibit-blocking
17540 (not org-treat-S-cursor-todo-selection-as-state-change)))
17541 (org-call-with-arg 'org-todo 'left)))
17542 ((or (and org-support-shift-select
17543 (not (eq org-support-shift-select 'always))
17544 (org-at-item-bullet-p))
17545 (and (not org-support-shift-select) (org-at-item-p)))
17546 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17547 ((and (not (eq org-support-shift-select 'always))
17548 (org-at-property-p))
17549 (call-interactively 'org-property-previous-allowed-value))
17550 ((org-clocktable-try-shift 'left arg))
17551 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17552 (org-support-shift-select
17553 (org-call-for-shift-select 'backward-char))
17554 (t (org-shiftselect-error))))
17556 (defun org-shiftcontrolright ()
17557 "Switch to next TODO set."
17560 ((and org-support-shift-select (org-region-active-p))
17561 (org-call-for-shift-select 'forward-word))
17562 ((and (not (eq org-support-shift-select 'always))
17563 (org-on-heading-p))
17564 (org-call-with-arg 'org-todo 'nextset))
17565 (org-support-shift-select
17566 (org-call-for-shift-select 'forward-word))
17567 (t (org-shiftselect-error))))
17569 (defun org-shiftcontrolleft ()
17570 "Switch to previous TODO set."
17573 ((and org-support-shift-select (org-region-active-p))
17574 (org-call-for-shift-select 'backward-word))
17575 ((and (not (eq org-support-shift-select 'always))
17576 (org-on-heading-p))
17577 (org-call-with-arg 'org-todo 'previousset))
17578 (org-support-shift-select
17579 (org-call-for-shift-select 'backward-word))
17580 (t (org-shiftselect-error))))
17582 (defun org-shiftcontrolup ()
17583 "Change timestamps synchronously up in CLOCK log lines."
17585 (cond ((and (not org-support-shift-select)
17586 (org-at-clock-log-p)
17587 (org-at-timestamp-p t))
17588 (org-clock-timestamps-up))
17589 (t (org-shiftselect-error))))
17591 (defun org-shiftcontroldown ()
17592 "Change timestamps synchronously down in CLOCK log lines."
17594 (cond ((and (not org-support-shift-select)
17595 (org-at-clock-log-p)
17596 (org-at-timestamp-p t))
17597 (org-clock-timestamps-down))
17598 (t (org-shiftselect-error))))
17600 (defun org-ctrl-c-ret ()
17601 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17604 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17605 (t (call-interactively 'org-insert-heading))))
17607 (defun org-copy-special ()
17608 "Copy region in table or copy current subtree.
17609 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17610 See the individual commands for more information."
17612 (call-interactively
17613 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17615 (defun org-cut-special ()
17616 "Cut region in table or cut current subtree.
17617 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17618 See the individual commands for more information."
17620 (call-interactively
17621 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17623 (defun org-paste-special (arg)
17624 "Paste rectangular region into table, or past subtree relative to level.
17625 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17626 See the individual commands for more information."
17628 (if (org-at-table-p)
17629 (org-table-paste-rectangle)
17630 (org-paste-subtree arg)))
17632 (defun org-edit-special (&optional arg)
17633 "Call a special editor for the stuff at point.
17634 When at a table, call the formula editor with `org-table-edit-formulas'.
17635 When at the first line of an src example, call `org-edit-src-code'.
17636 When in an #+include line, visit the include file. Otherwise call
17637 `ffap' to visit the file at point."
17639 ;; possibly prep session before editing source
17641 (let* ((info (org-babel-get-src-block-info))
17642 (lang (nth 0 info))
17643 (params (nth 2 info))
17644 (session (cdr (assoc :session params))))
17645 (when (and info session) ;; we are in a source-code block with a session
17647 (intern (concat "org-babel-prep-session:" lang)) session params))))
17648 (cond ;; proceed with `org-edit-special'
17650 (beginning-of-line 1)
17651 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17652 (find-file (org-trim (match-string 1))))
17653 ((org-edit-src-code))
17654 ((org-edit-fixed-width-region))
17655 ((org-at-table.el-p)
17656 (org-edit-src-code))
17657 ((or (org-at-table-p)
17659 (beginning-of-line 1)
17660 (looking-at "[ \t]*#\\+TBLFM:")))
17661 (call-interactively 'org-table-edit-formulas))
17662 (t (call-interactively 'ffap))))
17664 (defun org-ctrl-c-ctrl-c (&optional arg)
17665 "Set tags in headline, or update according to changed information at point.
17667 This command does many different things, depending on context:
17669 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17670 this is what we do.
17672 - If the cursor is on a statistics cookie, update it.
17674 - If the cursor is in a headline, prompt for tags and insert them
17675 into the current line, aligned to `org-tags-column'. When called
17676 with prefix arg, realign all tags in the current buffer.
17678 - If the cursor is in one of the special #+KEYWORD lines, this
17679 triggers scanning the buffer for these lines and updating the
17682 - If the cursor is inside a table, realign the table. This command
17683 works even if the automatic table editor has been turned off.
17685 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17688 - If the cursor is at a footnote reference or definition, jump to
17689 the corresponding definition or references, respectively.
17691 - If the cursor is a the beginning of a dynamic block, update it.
17693 - If the current buffer is a capture buffer, close note and file it.
17695 - If the cursor is on a <<<target>>>, update radio targets and
17696 corresponding links in this buffer.
17698 - If the cursor is on a numbered item in a plain list, renumber the
17701 - If the cursor is on a checkbox, toggle it.
17703 - If the cursor is on a code block, evaluate it. The variable
17704 `org-confirm-babel-evaluate' can be used to control prompting
17705 before code block evaluation, by default every code block
17706 evaluation requires confirmation. Code block evaluation can be
17707 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17709 (let ((org-enable-table-editor t))
17711 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17712 org-occur-highlights
17713 org-latex-fragment-image-overlays)
17714 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17715 (org-remove-occur-highlights)
17716 (org-remove-latex-fragment-image-overlays)
17717 (message "Temporary highlights/overlays removed from current buffer"))
17718 ((and (local-variable-p 'org-finish-function (current-buffer))
17719 (fboundp org-finish-function))
17720 (funcall org-finish-function))
17721 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17722 ((or (looking-at org-property-start-re)
17723 (org-at-property-p))
17724 (call-interactively 'org-property-action))
17725 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17726 ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
17727 (or (org-on-heading-p) (org-at-item-p)))
17728 (call-interactively 'org-update-statistics-cookies))
17729 ((org-on-heading-p) (call-interactively 'org-set-tags))
17730 ((org-at-table.el-p)
17731 (message "Use C-c ' to edit table.el tables"))
17733 (org-table-maybe-eval-formula)
17735 (call-interactively 'org-table-recalculate)
17736 (org-table-maybe-recalculate-line))
17737 (call-interactively 'org-table-align)
17738 (orgtbl-send-table 'maybe))
17739 ((or (org-footnote-at-reference-p)
17740 (org-footnote-at-definition-p))
17741 (call-interactively 'org-footnote-action))
17742 ((org-at-item-checkbox-p)
17743 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17744 ;; list only if at top item.
17745 (let* ((cbox (match-string 1))
17746 (struct (org-list-struct))
17747 (old-struct (copy-tree struct))
17748 (parents (org-list-parents-alist struct))
17749 (prevs (org-list-prevs-alist struct))
17750 (orderedp (org-entry-get nil "ORDERED"))
17751 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17753 ;; Use a light version of `org-toggle-checkbox' to avoid
17754 ;; computing list structure twice.
17755 (org-list-set-checkbox (point-at-bol) struct
17757 ((equal arg '(16)) "[-]")
17758 ((equal arg '(4)) nil)
17759 ((equal "[X]" cbox) "[ ]")
17761 (org-list-struct-fix-ind struct parents)
17762 (org-list-struct-fix-bul struct prevs)
17764 (org-list-struct-fix-box struct parents prevs orderedp))
17767 "Checkboxes were removed due to unchecked box at line %d"
17768 (org-current-line block-item)))
17769 (org-list-struct-apply-struct struct old-struct)
17770 (org-update-checkbox-count-maybe)
17771 (when firstp (org-list-send-list 'maybe))))
17773 ;; Cursor at an item: repair list. Do checkbox related actions
17774 ;; only if function was called with an argument. Send list only
17776 (let* ((struct (org-list-struct))
17777 (old-struct (copy-tree struct))
17778 (parents (org-list-parents-alist struct))
17779 (prevs (org-list-prevs-alist struct))
17780 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17781 (org-list-struct-fix-ind struct parents)
17782 (org-list-struct-fix-bul struct prevs)
17784 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17785 (org-list-struct-fix-box struct parents prevs))
17786 (org-list-struct-apply-struct struct old-struct)
17787 (when arg (org-update-checkbox-count-maybe))
17788 (when firstp (org-list-send-list 'maybe))))
17789 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17791 (beginning-of-line 1)
17792 (save-excursion (org-update-dblock)))
17794 (beginning-of-line 1)
17795 (looking-at "[ \t]*#\\+\\([A-Z]+\\)"))
17797 ((equal (match-string 1) "TBLFM")
17798 ;; Recalculate the table before this line
17800 (beginning-of-line 1)
17801 (skip-chars-backward " \r\n\t")
17802 (if (org-at-table-p)
17803 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17805 (let ((org-inhibit-startup-visibility-stuff t)
17806 (org-startup-align-all-tables nil))
17807 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17808 (message "Local setup has been refreshed"))))
17809 ((org-clock-update-time-maybe))
17810 (t (error "C-c C-c can do nothing useful at this location")))))
17812 (defun org-mode-restart ()
17813 "Restart Org-mode, to scan again for special lines.
17814 Also updates the keyword regular expressions."
17817 (message "Org-mode restarted"))
17819 (defun org-kill-note-or-show-branches ()
17820 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17822 (if (not org-finish-function)
17825 (call-interactively 'show-branches))
17826 (let ((org-note-abort t))
17827 (funcall org-finish-function))))
17829 (defun org-return (&optional indent)
17830 "Goto next table row or insert a newline.
17831 Calls `org-table-next-row' or `newline', depending on context.
17832 See the individual commands for more information."
17835 ((bobp) (if indent (newline-and-indent) (newline)))
17837 (org-table-justify-field-maybe)
17838 (call-interactively 'org-table-next-row))
17839 ;; when `newline-and-indent' is called within a list, make sure
17840 ;; text moved stays inside the item.
17841 ((and (org-in-item-p) indent)
17842 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17845 (org-indent-line-to (length (match-string 0))))
17846 (let ((ind (org-get-indentation)))
17848 (if (org-looking-back org-list-end-re)
17849 (org-indent-line-function)
17850 (org-indent-line-to ind)))))
17851 ((and org-return-follows-link
17852 (eq (get-text-property (point) 'face) 'org-link))
17853 (call-interactively 'org-open-at-point))
17854 ((and (org-at-heading-p)
17856 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
17860 (t (if indent (newline-and-indent) (newline)))))
17862 (defun org-return-indent ()
17863 "Goto next table row or insert a newline and indent.
17864 Calls `org-table-next-row' or `newline-and-indent', depending on
17865 context. See the individual commands for more information."
17869 (defun org-ctrl-c-star ()
17870 "Compute table, or change heading status of lines.
17871 Calls `org-table-recalculate' or `org-toggle-heading',
17872 depending on context."
17876 (call-interactively 'org-table-recalculate))
17878 ;; Convert all lines in region to list items
17879 (call-interactively 'org-toggle-heading))))
17881 (defun org-ctrl-c-minus ()
17882 "Insert separator line in table or modify bullet status of line.
17883 Also turns a plain line or a region of lines into list items.
17884 Calls `org-table-insert-hline', `org-toggle-item', or
17885 `org-cycle-list-bullet', depending on context."
17889 (call-interactively 'org-table-insert-hline))
17890 ((org-region-active-p)
17891 (call-interactively 'org-toggle-item))
17893 (call-interactively 'org-cycle-list-bullet))
17895 (call-interactively 'org-toggle-item))))
17897 (defun org-toggle-item (arg)
17898 "Convert headings or normal lines to items, items to normal lines.
17899 If there is no active region, only the current line is considered.
17901 If the first non blank line in the region is an headline, convert
17902 all headlines to items, shifting text accordingly.
17904 If it is an item, convert all items to normal lines.
17906 If it is normal text, change region into an item. With a prefix
17907 argument ARG, change each line in region into an item."
17911 ;; Shift text in current section to IND, from point to END.
17912 ;; The function leaves point to END line.
17914 (let ((min-i 1000) (end (copy-marker end)))
17915 ;; First determine the minimum indentation (MIN-I) of
17919 (while (< (point) end)
17920 (let ((i (org-get-indentation)))
17922 ;; Skip blank lines and inline tasks.
17923 ((looking-at "^[ \t]*$"))
17924 ((looking-at org-outline-regexp-bol))
17925 ;; We can't find less than 0 indentation.
17926 ((zerop i) (throw 'exit (setq min-i 0)))
17927 ((< i min-i) (setq min-i i))))
17929 ;; Then indent each line so that a line indented to
17930 ;; MIN-I becomes indented to IND. Ignore blank lines
17931 ;; and inline tasks in the process.
17932 (let ((delta (- ind min-i)))
17933 (while (< (point) end)
17934 (unless (or (looking-at "^[ \t]*$")
17935 (looking-at org-outline-regexp-bol))
17936 (org-indent-line-to (+ (org-get-indentation) delta)))
17937 (forward-line)))))))
17940 ;; Return beginning of first non-blank line, starting from
17945 (skip-chars-forward " \r\t\n")
17948 ;; Determine boundaries of changes.
17949 (if (org-region-active-p)
17950 (setq beg (funcall skip-blanks (region-beginning))
17951 end (copy-marker (region-end)))
17952 (setq beg (funcall skip-blanks (point-at-bol))
17953 end (copy-marker (point-at-eol))))
17954 ;; Depending on the starting line, choose an action on the text
17955 ;; between BEG and END.
17956 (org-with-limited-levels
17960 ;; Case 1. Start at an item: de-itemize. Note that it only
17961 ;; happens when a region is active: `org-ctrl-c-minus'
17962 ;; would call `org-cycle-list-bullet' otherwise.
17964 (while (< (point) end)
17965 (when (org-at-item-p)
17966 (skip-chars-forward " \t")
17967 (delete-region (point) (match-end 0)))
17969 ;; Case 2. Start at an heading: convert to items.
17970 ((org-on-heading-p)
17971 (let* ((bul (org-list-bullet-string "-"))
17972 (bul-len (length bul))
17973 ;; Indentation of the first heading. It should be
17974 ;; relative to the indentation of its parent, if any.
17975 (start-ind (save-excursion
17977 ((not org-adapt-indentation) 0)
17978 ((not (outline-previous-heading)) 0)
17979 (t (length (match-string 0))))))
17980 ;; Level of first heading. Further headings will be
17981 ;; compared to it to determine hierarchy in the list.
17982 (ref-level (org-reduced-level (org-outline-level))))
17983 (while (< (point) end)
17984 (let* ((level (org-reduced-level (org-outline-level)))
17985 (delta (max 0 (- level ref-level))))
17986 ;; If current headline is less indented than the first
17987 ;; one, set it as reference, in order to preserve
17989 (when (< level ref-level) (setq ref-level level))
17990 (replace-match bul t t)
17991 (org-indent-line-to (+ start-ind (* delta bul-len)))
17992 ;; Ensure all text down to END (or SECTION-END) belongs
17993 ;; to the newly created item.
17994 (let ((section-end (save-excursion
17995 (or (outline-next-heading) (point)))))
17997 (funcall shift-text
17998 (+ start-ind (* (1+ delta) bul-len))
17999 (min end section-end)))))))
18000 ;; Case 3. Normal line with ARG: turn each non-item line into
18003 (while (< (point) end)
18004 (unless (or (org-on-heading-p) (org-at-item-p))
18005 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
18007 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
18009 ;; Case 4. Normal line without ARG: make the first line of
18010 ;; region an item, and shift indentation of others
18011 ;; lines to set them as item's body.
18012 (t (let* ((bul (org-list-bullet-string "-"))
18013 (bul-len (length bul))
18014 (ref-ind (org-get-indentation)))
18015 (skip-chars-forward " \t")
18018 (while (< (point) end)
18019 ;; Ensure that lines less indented than first one
18020 ;; still get included in item body.
18021 (funcall shift-text
18022 (+ ref-ind bul-len)
18023 (min end (save-excursion (or (outline-next-heading)
18025 (forward-line)))))))))
18027 (defun org-toggle-heading (&optional nstars)
18028 "Convert headings to normal text, or items or text to headings.
18029 If there is no active region, only the current line is considered.
18031 If the first non blank line is an headline, remove the stars from
18032 all headlines in the region.
18034 If it is a plain list item, turn all plain list items into headings.
18036 If it is a normal line, turn each and every normal line (i.e. not
18037 an heading or an item) in the region into a heading.
18039 When converting a line into a heading, the number of stars is chosen
18040 such that the lines become children of the current entry. However,
18041 when a prefix argument is given, its value determines the number of
18046 ;; Return beginning of first non-blank line, starting from
18051 (skip-chars-forward " \r\t\n")
18054 ;; Determine boundaries of changes. If region ends at a bol, do
18055 ;; not consider the last line to be in the region.
18056 (if (org-region-active-p)
18057 (setq beg (funcall skip-blanks (region-beginning))
18058 end (copy-marker (save-excursion
18059 (goto-char (region-end))
18060 (if (bolp) (point) (point-at-eol)))))
18061 (setq beg (funcall skip-blanks (point-at-bol))
18062 end (copy-marker (point-at-eol))))
18063 ;; Ensure inline tasks don't count as headings.
18064 (org-with-limited-levels
18068 ;; Case 1. Started at an heading: de-star headings.
18069 ((org-on-heading-p)
18070 (while (< (point) end)
18071 (when (org-on-heading-p t)
18072 (looking-at org-outline-regexp) (replace-match ""))
18074 ;; Case 2. Started at an item: change items into headlines.
18075 ;; One star will be added by `org-list-to-subtree'.
18077 (let* ((stars (make-string
18079 ;; subtract the star that will be added again by
18080 ;; `org-list-to-subtree'
18081 (1- (prefix-numeric-value current-prefix-arg))
18082 (or (org-current-level) 0))
18085 (cond (nstars "") ; stars from prefix only
18086 ((equal stars "") "") ; before first heading
18087 (org-odd-levels-only "*") ; inside heading, odd
18088 (t "")))) ; inside heading, oddeven
18089 (while (< (point) end)
18090 (when (org-at-item-p)
18091 ;; Pay attention to cases when region ends before list.
18092 (let* ((struct (org-list-struct))
18093 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18095 (narrow-to-region (point) list-end)
18097 (org-list-to-subtree
18098 (org-list-parse-list t)
18099 '(:istart (concat stars add-stars (funcall get-stars depth))
18100 :icount (concat stars add-stars (funcall get-stars depth))))))))
18102 ;; Case 3. Started at normal text: make every line an heading,
18103 ;; skipping headlines and items.
18104 (t (let* ((stars (make-string
18106 (prefix-numeric-value current-prefix-arg)
18107 (or (org-current-level) 0))
18110 (cond (nstars "") ; stars from prefix only
18111 ((equal stars "") "*") ; before first heading
18112 (org-odd-levels-only "**") ; inside heading, odd
18113 (t "*"))) ; inside heading, oddeven
18114 (rpl (concat stars add-stars " ")))
18115 (while (< (point) end)
18116 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18117 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
18118 (replace-match (concat rpl (match-string 2))))
18119 (forward-line)))))))))
18121 (defun org-meta-return (&optional arg)
18122 "Insert a new heading or wrap a region in a table.
18123 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18124 See the individual commands for more information."
18127 ((run-hook-with-args-until-success 'org-metareturn-hook))
18129 (call-interactively 'org-table-wrap-region))
18130 (t (call-interactively 'org-insert-heading))))
18134 ;; Define the Org-mode menus
18135 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18137 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18138 ["Next Field" org-cycle (org-at-table-p)]
18139 ["Previous Field" org-shifttab (org-at-table-p)]
18140 ["Next Row" org-return (org-at-table-p)]
18142 ["Blank Field" org-table-blank-field (org-at-table-p)]
18143 ["Edit Field" org-table-edit-field (org-at-table-p)]
18144 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18147 ["Move Column Left" org-metaleft (org-at-table-p)]
18148 ["Move Column Right" org-metaright (org-at-table-p)]
18149 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18150 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18152 ["Move Row Up" org-metaup (org-at-table-p)]
18153 ["Move Row Down" org-metadown (org-at-table-p)]
18154 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18155 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18156 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18158 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18160 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18161 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18162 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18163 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18166 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18167 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18168 ["Edit Formulas" org-edit-special (org-at-table-p)]
18170 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18171 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18172 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18174 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18176 ["Sum Column/Rectangle" org-table-sum
18177 (or (org-at-table-p) (org-region-active-p))]
18178 ["Which Column?" org-table-current-column (org-at-table-p)])
18180 org-table-toggle-formula-debugger
18181 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18182 ["Show Col/Row Numbers"
18183 org-table-toggle-coordinate-overlays
18185 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18187 ["Create" org-table-create (and (not (org-at-table-p))
18188 org-enable-table-editor)]
18189 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18190 ["Import from File" org-table-import (not (org-at-table-p))]
18191 ["Export to File" org-table-export (org-at-table-p)]
18193 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18195 (easy-menu-define org-org-menu org-mode-map "Org menu"
18198 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18199 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18200 ["Sparse Tree..." org-sparse-tree t]
18201 ["Reveal Context" org-reveal t]
18202 ["Show All" show-all t]
18204 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18206 ["New Heading" org-insert-heading t]
18207 ("Navigate Headings"
18208 ["Up" outline-up-heading t]
18209 ["Next" outline-next-visible-heading t]
18210 ["Previous" outline-previous-visible-heading t]
18211 ["Next Same Level" outline-forward-same-level t]
18212 ["Previous Same Level" outline-backward-same-level t]
18214 ["Jump" org-goto t])
18216 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18217 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18219 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18220 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18221 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18223 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18225 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18226 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18227 ["Demote Heading" org-metaright (not (org-at-table-p))]
18228 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18230 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18232 ["Convert to odd levels" org-convert-to-odd-levels t]
18233 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18235 ["Emphasis..." org-emphasize t]
18236 ["Edit Source Example" org-edit-special t]
18238 ["Footnote new/jump" org-footnote-action t]
18239 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18241 ["Archive (default method)" org-archive-subtree-default t]
18243 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18244 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18245 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18249 ["Store Link (Global)" org-store-link t]
18250 ["Find existing link to here" org-occur-link-in-agenda-files t]
18251 ["Insert Link" org-insert-link t]
18252 ["Follow Link" org-open-at-point t]
18254 ["Next link" org-next-link t]
18255 ["Previous link" org-previous-link t]
18257 ["Descriptive Links"
18258 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18260 :selected (member '(org-link) buffer-invisibility-spec)]
18263 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18265 :selected (not (member '(org-link) buffer-invisibility-spec))])
18268 ["TODO/DONE/-" org-todo t]
18270 ["Next keyword" org-shiftright (org-on-heading-p)]
18271 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18272 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18273 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18274 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18275 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18276 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18278 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18279 :selected org-enforce-todo-dependencies :style toggle :active t]
18280 "Settings for tree at point"
18281 ["Do Children sequentially" org-toggle-ordered-property :style radio
18282 :selected (org-entry-get nil "ORDERED")
18283 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18284 ["Do Children parallel" org-toggle-ordered-property :style radio
18285 :selected (not (org-entry-get nil "ORDERED"))
18286 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18288 ["Set Priority" org-priority t]
18289 ["Priority Up" org-shiftup t]
18290 ["Priority Down" org-shiftdown t]
18292 ["Get news from all feeds" org-feed-update-all t]
18293 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18294 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18295 ("TAGS and Properties"
18296 ["Set Tags" org-set-tags-command t]
18297 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18299 ["Set property" org-set-property t]
18300 ["Column view of properties" org-columns t]
18301 ["Insert Column View DBlock" org-insert-columns-dblock t])
18302 ("Dates and Scheduling"
18303 ["Timestamp" org-time-stamp t]
18304 ["Timestamp (inactive)" org-time-stamp-inactive t]
18306 ["1 Day Later" org-shiftright t]
18307 ["1 Day Earlier" org-shiftleft t]
18308 ["1 ... Later" org-shiftup t]
18309 ["1 ... Earlier" org-shiftdown t])
18310 ["Compute Time Range" org-evaluate-time-range t]
18311 ["Schedule Item" org-schedule t]
18312 ["Deadline" org-deadline t]
18314 ["Custom time format" org-toggle-time-stamp-overlays
18315 :style radio :selected org-display-custom-times]
18317 ["Goto Calendar" org-goto-calendar t]
18318 ["Date from Calendar" org-date-from-calendar t]
18320 ["Start/Restart Timer" org-timer-start t]
18321 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18322 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18323 ["Insert Timer String" org-timer t]
18324 ["Insert Timer Item" org-timer-item t])
18326 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18327 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18328 ["Clock out" org-clock-out t]
18329 ["Clock cancel" org-clock-cancel t]
18331 ["Mark as default task" org-clock-mark-default-task t]
18332 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18333 ["Goto running clock" org-clock-goto t]
18335 ["Display times" org-clock-display t]
18336 ["Create clock table" org-clock-report t]
18338 ["Record DONE time"
18339 (progn (setq org-log-done (not org-log-done))
18340 (message "Switching to %s will %s record a timestamp"
18341 (car org-done-keywords)
18342 (if org-log-done "automatically" "not")))
18343 :style toggle :selected org-log-done])
18345 ["Agenda Command..." org-agenda t]
18346 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18347 ("File List for Agenda")
18348 ("Special views current file"
18349 ["TODO Tree" org-show-todo-tree t]
18350 ["Check Deadlines" org-check-deadlines t]
18351 ["Timeline" org-timeline t]
18352 ["Tags/Property tree" org-match-sparse-tree t])
18354 ["Export/Publish..." org-export t]
18356 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18357 :selected org-cdlatex-mode]
18358 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18359 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18360 ["Modify math symbol" org-cdlatex-math-modify
18361 (org-inside-LaTeX-fragment-p)]
18362 ["Insert citation" org-reftex-citation t]
18364 ["Template for BEAMER" org-insert-beamer-options-template t])
18367 ["Push Files and Views" org-mobile-push t]
18368 ["Get Captured and Flagged" org-mobile-pull t]
18369 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18371 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18374 ["Show Version" org-version t]
18375 ["Info Documentation" org-info t])
18377 ["Browse Org Group" org-customize t]
18379 ["Expand This Menu" org-create-customize-menu
18380 (fboundp 'customize-menu-create)])
18381 ["Send bug report" org-submit-bug-report t]
18384 ["Refresh setup current buffer" org-mode-restart t]
18385 ["Reload Org (after update)" org-reload t]
18386 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18389 (defun org-info (&optional node)
18390 "Read documentation for Org-mode in the info system.
18391 With optional NODE, go directly to that node."
18393 (info (format "(org)%s" (or node ""))))
18396 (defun org-submit-bug-report ()
18397 "Submit a bug report on Org-mode via mail.
18399 Don't hesitate to report any problems or inaccurate documentation.
18401 If you don't have setup sending mail from (X)Emacs, please copy the
18402 output buffer into your mail program, as it gives us important
18403 information about your Org-mode version and configuration."
18405 (require 'reporter)
18406 (org-load-modules-maybe)
18407 (org-require-autoloaded-modules)
18408 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18409 (reporter-submit-bug-report
18410 "emacs-orgmode@gnu.org"
18413 (save-window-excursion
18414 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18415 (delete-other-windows)
18417 (insert "You are about to submit a bug report to the Org-mode mailing list.
18419 We would like to add your full Org-mode and Outline configuration to the
18420 bug report. This greatly simplifies the work of the maintainer and
18421 other experts on the mailing list.
18423 HOWEVER, some variables you have customized may contain private
18424 information. The names of customers, colleagues, or friends, might
18425 appear in the form of file names, tags, todo states, or search strings.
18426 If you answer yes to the prompt, you might want to check and remove
18427 such private information before sending the email.")
18428 (add-text-properties (point-min) (point-max) '(face org-warning))
18429 (when (yes-or-no-p "Include your Org-mode configuration ")
18433 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
18434 (or (and (symbol-value v)
18435 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
18437 (get v 'custom-type) (get v 'standard-value)
18438 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18440 (kill-buffer (get-buffer "*Warn about privacy*"))
18443 "Remember to cover the basics, that is, what you expected to happen and
18444 what in fact did happen. You don't know how to make a good report? See
18446 http://orgmode.org/manual/Feedback.html#Feedback
18448 Your bug report will be posted to the Org-mode mailing list.
18449 ------------------------------------------------------------------------")
18451 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
18452 (replace-match "\\1Bug: \\3 [\\2]")))))
18455 (defun org-install-agenda-files-menu ()
18456 (let ((bl (buffer-list)))
18459 (set-buffer (pop bl))
18460 (if (org-mode-p) (setq bl nil)))
18463 '("Org") "File List for Agenda"
18466 ["Edit File List" (org-edit-agenda-file-list) t]
18467 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18468 ["Remove Current File from List" org-remove-file t]
18469 ["Cycle through agenda files" org-cycle-agenda-files t]
18470 ["Occur in all agenda files" org-occur-in-agenda-files t]
18472 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18477 (defun org-require-autoloaded-modules ()
18480 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18481 org-docbook org-exp org-html org-icalendar
18483 org-publish org-remember org-table
18484 org-timer org-xoxo)))
18487 (defun org-reload (&optional uncompiled)
18488 "Reload all org lisp files.
18489 With prefix arg UNCOMPILED, load the uncompiled versions."
18491 (require 'find-func)
18492 (let* ((file-re "^\\(org\\|orgtbl\\)\\(\\.el\\|-.*\\.el\\)")
18493 (dir-org (file-name-directory (org-find-library-name "org")))
18494 (dir-org-contrib (ignore-errors
18495 (file-name-directory
18496 (org-find-library-name "org-contribdir"))))
18498 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18499 (append (list nil "comint" "eval" "exp" "keys"
18500 "lob" "ref" "table" "tangle")
18504 (when (cdr lang) (symbol-name (car lang))))
18505 org-babel-load-languages)))))
18507 (append (directory-files dir-org t file-re)
18509 (and dir-org-contrib
18510 (directory-files dir-org-contrib t file-re))))
18511 (remove-re (concat (if (featurep 'xemacs)
18512 "org-colview" "org-colview-xemacs")
18514 (setq files (mapcar 'file-name-sans-extension files))
18515 (setq files (mapcar
18516 (lambda (x) (if (string-match remove-re x) nil x))
18518 (setq files (delq nil files))
18521 (when (featurep (intern (file-name-nondirectory f)))
18522 (if (and (not uncompiled)
18523 (file-exists-p (concat f ".elc")))
18524 (load (concat f ".elc") nil nil t)
18525 (load (concat f ".el") nil nil t))))
18530 (defun org-customize ()
18531 "Call the customize function with org as argument."
18533 (org-load-modules-maybe)
18534 (org-require-autoloaded-modules)
18535 (customize-browse 'org))
18537 (defun org-create-customize-menu ()
18538 "Create a full customization menu for Org-mode, insert it into the menu."
18540 (org-load-modules-maybe)
18541 (org-require-autoloaded-modules)
18542 (if (fboundp 'customize-menu-create)
18545 '("Org") "Customize"
18546 `(["Browse Org group" org-customize t]
18548 ,(customize-menu-create 'org)
18549 ["Set" Custom-set t]
18550 ["Save" Custom-save t]
18551 ["Reset to Current" Custom-reset-current t]
18552 ["Reset to Saved" Custom-reset-saved t]
18553 ["Reset to Standard Settings" Custom-reset-standard t]))
18554 (message "\"Org\"-menu now contains full customization menu"))
18555 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18557 ;;;; Miscellaneous stuff
18559 ;;; Generally useful functions
18561 (defun org-get-at-bol (property)
18562 "Get text property PROPERTY at beginning of line."
18563 (get-text-property (point-at-bol) property))
18565 (defun org-find-text-property-in-string (prop s)
18566 "Return the first non-nil value of property PROP in string S."
18567 (or (get-text-property 0 prop s)
18568 (get-text-property (or (next-single-property-change 0 prop s) 0)
18571 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18572 "Display the given MESSAGE as a warning."
18573 (if (fboundp 'display-warning)
18574 (display-warning 'org message
18575 (if (featurep 'xemacs) 'warning :warning))
18576 (let ((buf (get-buffer-create "*Org warnings*")))
18577 (with-current-buffer buf
18578 (goto-char (point-max))
18579 (insert "Warning (Org): " message)
18582 (display-buffer buf)
18585 (defun org-eval (form)
18586 "Eval FORM and return result."
18587 (condition-case error
18589 (error (format "%%![Error: %s]" error))))
18591 (defun org-in-commented-line ()
18592 "Is point in a line starting with `#'?"
18593 (equal (char-after (point-at-bol)) ?#))
18595 (defun org-in-indented-comment-line ()
18596 "Is point in a line starting with `#' after some white space?"
18599 (goto-char (point-at-bol))
18600 (looking-at "[ \t]*#"))))
18602 (defun org-in-verbatim-emphasis ()
18604 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18606 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18607 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18608 (if (and marker (marker-buffer marker)
18609 (buffer-live-p (marker-buffer marker)))
18611 (org-pop-to-buffer-same-window (marker-buffer marker))
18612 (if (or (> marker (point-max)) (< marker (point-min)))
18615 (org-show-context 'org-goto))
18617 (bookmark-jump bookmark)
18618 (error "Cannot find location"))))
18620 (defun org-quote-csv-field (s)
18621 "Quote field for inclusion in CSV material."
18622 (if (string-match "[\",]" s)
18623 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
18626 (defun org-force-self-insert (N)
18627 "Needed to enforce self-insert under remapping."
18629 (self-insert-command N))
18631 (defun org-string-width (s)
18632 "Compute width of string, ignoring invisible characters.
18633 This ignores character with invisibility property `org-link', and also
18634 characters with property `org-cwidth', because these will become invisible
18635 upon the next fontification round."
18637 (when (or (eq t buffer-invisibility-spec)
18638 (assq 'org-link buffer-invisibility-spec))
18639 (while (setq b (text-property-any 0 (length s)
18640 'invisible 'org-link s))
18641 (setq s (concat (substring s 0 b)
18642 (substring s (or (next-single-property-change
18643 b 'invisible s) (length s)))))))
18644 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18645 (setq s (concat (substring s 0 b)
18646 (substring s (or (next-single-property-change
18647 b 'org-cwidth s) (length s))))))
18648 (setq l (string-width s) b -1)
18649 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18650 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18653 (defun org-shorten-string (s maxlength)
18654 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18655 If the string is shorter or has length MAXLENGTH, just return the
18656 original string. If it is longer, the functions finds a space in the
18657 string, breaks this string off at that locations and adds three dots
18658 as ellipsis. Including the ellipsis, the string will not be longer
18659 than MAXLENGTH. If finding a good breaking point in the string does
18660 not work, the string is just chopped off in the middle of a word
18662 (if (<= (length s) maxlength)
18664 (let* ((n (max (- maxlength 4) 1))
18665 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
18666 (if (string-match re s)
18667 (concat (match-string 1 s) "...")
18668 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18670 (defun org-get-indentation (&optional line)
18671 "Get the indentation of the current line, interpreting tabs.
18672 When LINE is given, assume it represents a line and compute its indentation."
18674 (if (string-match "^ *" (org-remove-tabs line))
18677 (beginning-of-line 1)
18678 (skip-chars-forward " \t")
18679 (current-column))))
18681 (defun org-get-string-indentation (s)
18682 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18683 (let ((n -1) (i 0) (w tab-width) c)
18685 (while (< (setq n (1+ n)) (length s))
18686 (setq c (aref s n))
18687 (cond ((= c ?\ ) (setq i (1+ i)))
18688 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
18689 (t (throw 'exit t)))))
18692 (defun org-remove-tabs (s &optional width)
18693 "Replace tabulators in S with spaces.
18694 Assumes that s is a single line, starting in column 0."
18695 (setq width (or width tab-width))
18696 (while (string-match "\t" s)
18697 (setq s (replace-match
18699 (- (* width (/ (+ (match-beginning 0) width) width))
18700 (match-beginning 0)) ?\ )
18704 (defun org-fix-indentation (line ind)
18705 "Fix indentation in LINE.
18706 IND is a cons cell with target and minimum indentation.
18707 If the current indentation in LINE is smaller than the minimum,
18708 leave it alone. If it is larger than ind, set it to the target."
18709 (let* ((l (org-remove-tabs line))
18710 (i (org-get-indentation l))
18711 (i1 (car ind)) (i2 (cdr ind)))
18712 (if (>= i i2) (setq l (substring line i2)))
18714 (concat (make-string i1 ?\ ) l)
18717 (defun org-remove-indentation (code &optional n)
18718 "Remove the maximum common indentation from the lines in CODE.
18719 N may optionally be the number of spaces to remove."
18722 (org-do-remove-indentation n)
18725 (defun org-do-remove-indentation (&optional n)
18726 "Remove the maximum common indentation from the buffer."
18727 (untabify (point-min) (point-max))
18728 (let ((min 10000) re)
18731 (goto-char (point-min))
18732 (while (re-search-forward "^ *[^ \n]" nil t)
18733 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18734 (unless (or (= min 0) (= min 10000))
18735 (setq re (format "^ \\{%d\\}" min))
18736 (goto-char (point-min))
18737 (while (re-search-forward re nil t)
18742 (defun org-fill-template (template alist)
18743 "Find each %key of ALIST in TEMPLATE and replace it."
18744 (let ((case-fold-search nil)
18746 (setq alist (sort (copy-sequence alist)
18747 (lambda (a b) (< (length (car a)) (length (car b))))))
18748 (while (setq entry (pop alist))
18750 (replace-regexp-in-string
18751 (concat "%" (regexp-quote (car entry)))
18752 (cdr entry) template t t)))
18755 (defun org-base-buffer (buffer)
18756 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18759 (or (buffer-base-buffer buffer)
18762 (defun org-trim (s)
18763 "Remove whitespace at beginning and end of string."
18764 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
18765 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
18768 (defun org-wrap (string &optional width lines)
18769 "Wrap string to either a number of lines, or a width in characters.
18770 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18771 that costs. If there is a word longer than WIDTH, the text is actually
18772 wrapped to the length of that word.
18773 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18774 many lines, whatever width that takes.
18775 The return value is a list of lines, without newlines at the end."
18776 (let* ((words (org-split-string string "[ \t\n]+"))
18777 (maxword (apply 'max (mapcar 'org-string-width words)))
18780 (org-do-wrap words (max maxword width)))
18783 (setq ll (org-do-wrap words maxword))
18784 (if (<= (length ll) lines)
18787 (while (> (length ll) lines)
18789 (setq ll (org-do-wrap words w)))
18791 (t (error "Cannot wrap this")))))
18793 (defun org-do-wrap (words width)
18794 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18797 (setq line (pop words))
18798 (while (and words (< (+ (length line) (length (car words))) width))
18799 (setq line (concat line " " (pop words))))
18800 (setq lines (push line lines)))
18803 (defun org-split-string (string &optional separators)
18804 "Splits STRING into substrings at SEPARATORS.
18805 No empty strings are returned if there are matches at the beginning
18806 and end of string."
18807 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
18811 (while (and (string-match rexp string
18813 (= start (match-beginning 0))
18814 (< start (length string)))
18816 (< (match-beginning 0) (length string)))
18818 (or (eq (match-beginning 0) 0)
18819 (and (eq (match-beginning 0) (match-end 0))
18820 (eq (match-beginning 0) start))
18822 (cons (substring string start (match-beginning 0))
18824 (setq start (match-end 0)))
18825 (or (eq start (length string))
18827 (cons (substring string start)
18831 (defun org-quote-vert (s)
18832 "Replace \"|\" with \"\\vert\"."
18833 (while (string-match "|" s)
18834 (setq s (replace-match "\\vert" t t s)))
18837 (defun org-uuidgen-p (s)
18838 "Is S an ID created by UUIDGEN?"
18839 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18841 (defun org-context ()
18842 "Return a list of contexts of the current cursor position.
18843 If several contexts apply, all are returned.
18844 Each context entry is a list with a symbol naming the context, and
18845 two positions indicating start and end of the context. Possible
18848 :headline anywhere in a headline
18849 :headline-stars on the leading stars in a headline
18850 :todo-keyword on a TODO keyword (including DONE) in a headline
18851 :tags on the TAGS in a headline
18852 :priority on the priority cookie in a headline
18853 :item on the first line of a plain list item
18854 :item-bullet on the bullet/number of a plain list item
18855 :checkbox on the checkbox in a plain list item
18856 :table in an org-mode table
18857 :table-special on a special filed in a table
18858 :table-table in a table.el table
18859 :link on a hyperlink
18860 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18861 :target on a <<target>>
18862 :radio-target on a <<<radio-target>>>
18863 :latex-fragment on a LaTeX fragment
18864 :latex-preview on a LaTeX fragment with overlayed preview image
18866 This function expects the position to be visible because it uses font-lock
18867 faces as a help to recognize the following contexts: :table-special, :link,
18869 (let* ((f (get-text-property (point) 'face))
18870 (faces (if (listp f) f (list f)))
18871 (p (point)) clist o)
18872 ;; First the large context
18874 ((org-on-heading-p t)
18875 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18877 (beginning-of-line 1)
18878 (looking-at org-todo-line-tags-regexp))
18879 (push (org-point-in-group p 1 :headline-stars) clist)
18880 (push (org-point-in-group p 2 :todo-keyword) clist)
18881 (push (org-point-in-group p 4 :tags) clist))
18883 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
18884 (if (looking-at "\\[#[A-Z0-9]\\]")
18885 (push (org-point-in-group p 0 :priority) clist)))
18888 (push (org-point-in-group p 2 :item-bullet) clist)
18889 (push (list :item (point-at-bol)
18890 (save-excursion (org-end-of-item) (point)))
18892 (and (org-at-item-checkbox-p)
18893 (push (org-point-in-group p 0 :checkbox) clist)))
18896 (push (list :table (org-table-begin) (org-table-end)) clist)
18897 (if (memq 'org-formula faces)
18898 (push (list :table-special
18899 (previous-single-property-change p 'face)
18900 (next-single-property-change p 'face)) clist)))
18901 ((org-at-table-p 'any)
18902 (push (list :table-table) clist)))
18905 ;; Now the small context
18907 ((org-at-timestamp-p)
18908 (push (org-point-in-group p 0 :timestamp) clist))
18909 ((memq 'org-link faces)
18911 (previous-single-property-change p 'face)
18912 (next-single-property-change p 'face)) clist))
18913 ((memq 'org-special-keyword faces)
18914 (push (list :keyword
18915 (previous-single-property-change p 'face)
18916 (next-single-property-change p 'face)) clist))
18918 (push (org-point-in-group p 0 :target) clist)
18919 (goto-char (1- (match-beginning 0)))
18920 (if (looking-at org-radio-target-regexp)
18921 (push (org-point-in-group p 0 :radio-target) clist))
18923 ((setq o (car (delq nil
18926 (if (memq x org-latex-fragment-image-overlays) x))
18927 (overlays-at (point))))))
18928 (push (list :latex-fragment
18929 (overlay-start o) (overlay-end o)) clist)
18930 (push (list :latex-preview
18931 (overlay-start o) (overlay-end o)) clist))
18932 ((org-inside-LaTeX-fragment-p)
18933 ;; FIXME: positions wrong.
18934 (push (list :latex-fragment (point) (point)) clist)))
18936 (setq clist (nreverse (delq nil clist)))
18939 ;; FIXME: Compare with at-regexp-p Do we need both?
18940 (defun org-in-regexp (re &optional nlines visually)
18941 "Check if point is inside a match of regexp.
18942 Normally only the current line is checked, but you can include NLINES extra
18943 lines both before and after point into the search.
18944 If VISUALLY is set, require that the cursor is not after the match but
18945 really on, so that the block visually is on the match."
18947 (let ((pos (point))
18948 (eol (point-at-eol (+ 1 (or nlines 0))))
18949 (inc (if visually 1 0)))
18951 (beginning-of-line (- 1 (or nlines 0)))
18952 (while (re-search-forward re eol t)
18953 (if (and (<= (match-beginning 0) pos)
18954 (>= (+ inc (match-end 0)) pos))
18955 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18957 (defun org-at-regexp-p (regexp)
18958 "Is point inside a match of REGEXP in the current line?"
18961 (let ((pos (point)) (end (point-at-eol)))
18962 (beginning-of-line 1)
18963 (while (re-search-forward regexp end t)
18964 (if (and (<= (match-beginning 0) pos)
18965 (>= (match-end 0) pos))
18969 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18970 "Return t if the current point is between matches of START-RE and END-RE.
18971 This will also return t if point is on one of the two matches or
18972 in an unfinished block. END-RE can be a string or a form
18973 returning a string.
18975 An optional third argument bounds the search for START-RE. It
18976 defaults to previous heading or `point-min'."
18977 (let ((pos (point))
18978 (limit (or bound (save-excursion (outline-previous-heading)))))
18980 ;; we're on a block when point is on start-re...
18981 (or (org-at-regexp-p start-re)
18982 ;; ... or start-re can be found above...
18983 (and (re-search-backward start-re limit t)
18984 ;; ... but no end-re between start-re and point.
18985 (not (re-search-forward (eval end-re) pos t)))))))
18987 (defun org-in-block-p (names)
18988 "Is point inside any block whose name belongs to NAMES?
18990 NAMES is a list of strings containing names of blocks."
18993 (let ((case-fold-search t))
18994 (mapc (lambda (name)
18995 (let ((n (regexp-quote name)))
18996 (when (org-in-regexps-block-p
18997 (concat "^[ \t]*#\\+begin_" n)
18998 (concat "^[ \t]*#\\+end_" n))
19003 (defun org-occur-in-agenda-files (regexp &optional nlines)
19004 "Call `multi-occur' with buffers for all agenda files."
19005 (interactive "sOrg-files matching: \np")
19006 (let* ((files (org-agenda-files))
19007 (tnames (mapcar 'file-truename files))
19008 (extra org-agenda-text-search-extra-files)
19010 (when (eq (car extra) 'agenda-archives)
19011 (setq extra (cdr extra))
19012 (setq files (org-add-archive-files files)))
19013 (while (setq f (pop extra))
19014 (unless (member (file-truename f) tnames)
19015 (add-to-list 'files f 'append)
19016 (add-to-list 'tnames (file-truename f) 'append)))
19018 (mapcar (lambda (x)
19019 (with-current-buffer
19020 (or (get-file-buffer x) (find-file-noselect x))
19026 (if (boundp 'occur-mode-find-occurrence-hook)
19028 (add-hook 'occur-mode-find-occurrence-hook
19033 (defadvice occur-mode-goto-occurrence
19034 (after org-occur-reveal activate)
19035 (and (org-mode-p) (org-reveal)))
19036 (defadvice occur-mode-goto-occurrence-other-window
19037 (after org-occur-reveal activate)
19038 (and (org-mode-p) (org-reveal)))
19039 (defadvice occur-mode-display-occurrence
19040 (after org-occur-reveal activate)
19042 (let ((pos (occur-mode-find-occurrence)))
19043 (with-current-buffer (marker-buffer pos)
19048 (defun org-occur-link-in-agenda-files ()
19049 "Create a link and search for it in the agendas.
19050 The link is not stored in `org-stored-links', it is just created
19051 for the search purpose."
19053 (let ((link (condition-case nil
19054 (org-store-link nil)
19055 (error "Unable to create a link to here"))))
19056 (org-occur-in-agenda-files (regexp-quote link))))
19058 (defun org-uniquify (list)
19059 "Remove duplicate elements from LIST."
19061 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19064 (defun org-delete-all (elts list)
19065 "Remove all elements in ELTS from LIST."
19067 (setq list (delete (pop elts) list)))
19070 (defun org-count (cl-item cl-seq)
19071 "Count the number of occurrences of ITEM in SEQ.
19072 Taken from `count' in cl-seq.el with all keyword arguments removed."
19073 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19074 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19075 (while (< cl-start cl-end)
19076 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19077 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19078 (setq cl-start (1+ cl-start)))
19081 (defun org-remove-if (predicate seq)
19082 "Remove everything from SEQ that fulfills PREDICATE."
19086 (if (not (funcall predicate e)) (push e res)))
19089 (defun org-remove-if-not (predicate seq)
19090 "Remove everything from SEQ that does not fulfill PREDICATE."
19094 (if (funcall predicate e) (push e res)))
19097 (defun org-back-over-empty-lines ()
19098 "Move backwards over whitespace, to the beginning of the first empty line.
19099 Returns the number of empty lines passed."
19100 (let ((pos (point)))
19101 (if (cdr (assoc 'heading org-blank-before-new-entry))
19102 (skip-chars-backward " \t\n\r")
19104 (beginning-of-line 2)
19105 (goto-char (min (point) pos))
19106 (count-lines (point) pos)))
19108 (defun org-skip-whitespace ()
19109 (skip-chars-forward " \t\n\r"))
19111 (defun org-point-in-group (point group &optional context)
19112 "Check if POINT is in match-group GROUP.
19113 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19114 match. If the match group does not exist or point is not inside it,
19116 (and (match-beginning group)
19117 (>= point (match-beginning group))
19118 (<= point (match-end group))
19120 (list context (match-beginning group) (match-end group))
19123 (defun org-switch-to-buffer-other-window (&rest args)
19124 "Switch to buffer in a second window on the current frame.
19125 In particular, do not allow pop-up frames.
19126 Returns the newly created buffer."
19127 (let (pop-up-frames special-display-buffer-names special-display-regexps
19128 special-display-function)
19129 (apply 'switch-to-buffer-other-window args)))
19131 (defun org-combine-plists (&rest plists)
19132 "Create a single property list from all plists in PLISTS.
19133 The process starts by copying the first list, and then setting properties
19134 from the other lists. Settings in the last list are the most significant
19135 ones and overrule settings in the other lists."
19136 (let ((rtn (copy-sequence (pop plists)))
19139 (setq ls (pop plists))
19141 (setq p (pop ls) v (pop ls))
19142 (setq rtn (plist-put rtn p v))))
19145 (defun org-move-line-down (arg)
19146 "Move the current line down. With prefix argument, move it past ARG lines."
19148 (let ((col (current-column))
19150 (beginning-of-line 1) (setq beg (point))
19151 (beginning-of-line 2) (setq end (point))
19152 (beginning-of-line (+ 1 arg))
19153 (setq pos (move-marker (make-marker) (point)))
19154 (insert (delete-and-extract-region beg end))
19156 (org-move-to-column col)))
19158 (defun org-move-line-up (arg)
19159 "Move the current line up. With prefix argument, move it past ARG lines."
19161 (let ((col (current-column))
19163 (beginning-of-line 1) (setq beg (point))
19164 (beginning-of-line 2) (setq end (point))
19165 (beginning-of-line (- arg))
19166 (setq pos (move-marker (make-marker) (point)))
19167 (insert (delete-and-extract-region beg end))
19169 (org-move-to-column col)))
19171 (defun org-replace-escapes (string table)
19172 "Replace %-escapes in STRING with values in TABLE.
19173 TABLE is an association list with keys like \"%a\" and string values.
19174 The sequences in STRING may contain normal field width and padding information,
19175 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
19176 so values can contain further %-escapes if they are define later in TABLE."
19177 (let ((tbl (copy-alist table))
19178 (case-fold-search nil)
19181 (while (setq e (pop tbl))
19182 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19183 (when (and (cdr e) (string-match re (cdr e)))
19184 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19186 (add-text-properties 0 3 (list 'sref sref) safe)
19187 (setcdr e (replace-match safe t t (cdr e)))))
19188 (while (string-match re string)
19189 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19191 (setq string (replace-match rpl t t string))))
19192 (while (setq pchg (next-property-change pchg string))
19193 (let ((sref (get-text-property pchg 'sref string)))
19194 (when (and sref (string-match "SREF" string pchg))
19195 (setq string (replace-match sref t t string)))))
19198 (defun org-sublist (list start end)
19199 "Return a section of LIST, from START to END.
19200 Counting starts at 1."
19201 (let (rtn (c start))
19202 (setq list (nthcdr (1- start) list))
19203 (while (and list (<= c end))
19204 (push (pop list) rtn)
19208 (defun org-find-base-buffer-visiting (file)
19209 "Like `find-buffer-visiting' but always return the base buffer and
19210 not an indirect buffer."
19211 (let ((buf (or (get-file-buffer file)
19212 (find-buffer-visiting file))))
19214 (or (buffer-base-buffer buf) buf)
19217 (defun org-image-file-name-regexp (&optional extensions)
19218 "Return regexp matching the file names of images.
19219 If EXTENSIONS is given, only match these."
19220 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19221 (image-file-name-regexp)
19222 (let ((image-file-name-extensions
19224 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19225 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19227 (regexp-opt (nconc (mapcar 'upcase
19228 image-file-name-extensions)
19229 image-file-name-extensions)
19233 (defun org-file-image-p (file &optional extensions)
19234 "Return non-nil if FILE is an image."
19236 (string-match (org-image-file-name-regexp extensions) file)))
19238 (defun org-get-cursor-date ()
19239 "Return the date at cursor in as a time.
19240 This works in the calendar and in the agenda, anywhere else it just
19241 returns the current time."
19242 (let (date day defd)
19244 ((eq major-mode 'calendar-mode)
19245 (setq date (calendar-cursor-to-date)
19246 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19247 ((eq major-mode 'org-agenda-mode)
19248 (setq day (get-text-property (point) 'day))
19250 (setq date (calendar-gregorian-from-absolute day)
19251 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19253 (or defd (current-time))))
19255 (defvar org-agenda-action-marker (make-marker)
19256 "Marker pointing to the entry for the next agenda action.")
19258 (defun org-mark-entry-for-agenda-action ()
19259 "Mark the current entry as target of an agenda action.
19260 Agenda actions are actions executed from the agenda with the key `k',
19261 which make use of the date at the cursor."
19263 (move-marker org-agenda-action-marker
19264 (save-excursion (org-back-to-heading t) (point))
19267 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19269 (defun org-mark-subtree ()
19270 "Mark the current subtree.
19271 This puts point at the start of the current subtree, and mark at the end.
19273 If point is in an inline task, mark that task instead."
19275 (let ((inline-task-p
19276 (and (featurep 'org-inlinetask)
19277 (org-inlinetask-in-task-p)))
19279 ;; Get beginning of subtree
19281 (inline-task-p (org-inlinetask-goto-beginning))
19282 ((org-at-heading-p) (beginning-of-line))
19283 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19287 (org-inlinetask-goto-end)
19288 (org-end-of-subtree))
19290 (push-mark (point) nil t)
19293 ;;; Paragraph filling stuff.
19294 ;; We want this to be just right, so use the full arsenal.
19296 (defun org-indent-line-function ()
19297 "Indent line depending on context."
19299 (let* ((pos (point))
19300 (itemp (org-at-item-p))
19301 (case-fold-search t)
19302 (org-drawer-regexp (or org-drawer-regexp "\000"))
19303 (inline-task-p (and (featurep 'org-inlinetask)
19304 (org-inlinetask-in-task-p)))
19305 (inline-re (and inline-task-p
19306 (org-inlinetask-outline-regexp)))
19308 (beginning-of-line 1)
19311 ((looking-at "# ") (setq column 0))
19313 ((looking-at org-outline-regexp) (setq column 0))
19315 ((looking-at "#\\+include:") (setq column 0))
19316 ;; Footnote definition
19317 ((looking-at org-footnote-definition-re) (setq column 0))
19318 ;; Literal examples
19319 ((looking-at "[ \t]*:[ \t]")
19320 (setq column (org-get-indentation))) ; do nothing
19322 ((ignore-errors (goto-char (org-in-item-p)))
19323 (setq column (if itemp
19324 (org-get-indentation)
19325 (org-list-item-body-column (point))))
19328 ((and (looking-at "[ \t]*:END:")
19329 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19331 (goto-char (1- (match-beginning 1)))
19332 (setq column (current-column))))
19334 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
19336 (re-search-backward
19337 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
19338 (setq column (org-get-indentation (match-string 0))))
19339 ((and (not (looking-at "[ \t]*#\\+begin_"))
19340 (org-in-regexps-block-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
19342 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
19344 (if (equal (downcase (match-string 1)) "src")
19345 ;; src blocks: let `org-edit-src-exit' handle them
19346 (org-get-indentation)
19347 (org-get-indentation (match-string 0)))))
19348 ;; This line has nothing special, look at the previous relevant
19349 ;; line to compute indentation
19351 (beginning-of-line 0)
19352 (while (and (not (bobp))
19353 (not (looking-at org-drawer-regexp))
19354 ;; When point started in an inline task, do not move
19355 ;; above task starting line.
19356 (not (and inline-task-p (looking-at inline-re)))
19357 ;; Skip drawers, blocks, empty lines, verbatim,
19358 ;; comments, tables, footnotes definitions, lists,
19360 (or (and (looking-at "[ \t]*:END:")
19361 (re-search-backward org-drawer-regexp nil t))
19362 (and (looking-at "[ \t]*#\\+end_")
19363 (re-search-backward "[ \t]*#\\+begin_"nil t))
19364 (looking-at "[ \t]*[\n:#|]")
19365 (looking-at org-footnote-definition-re)
19366 (and (ignore-errors (goto-char (org-in-item-p)))
19368 (org-list-get-top-point (org-list-struct))))
19369 (and (not inline-task-p)
19370 (featurep 'org-inlinetask)
19371 (org-inlinetask-in-task-p)
19372 (or (org-inlinetask-goto-beginning) t))))
19373 (beginning-of-line 0))
19375 ;; There was an heading above.
19376 ((looking-at "\\*+[ \t]+")
19377 (if (not org-adapt-indentation)
19379 (goto-char (match-end 0))
19380 (setq column (current-column))))
19381 ;; A drawer had started and is unfinished
19382 ((looking-at org-drawer-regexp)
19383 (goto-char (1- (match-beginning 1)))
19384 (setq column (current-column)))
19385 ;; Else, nothing noticeable found: get indentation and go on.
19386 (t (setq column (org-get-indentation))))))
19387 ;; Now apply indentation and move cursor accordingly
19389 (if (<= (current-column) (current-indentation))
19390 (org-indent-line-to column)
19391 (save-excursion (org-indent-line-to column)))
19392 ;; Special polishing for properties, see `org-property-format'
19393 (setq column (current-column))
19394 (beginning-of-line 1)
19396 "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
19397 (replace-match (concat (match-string 1)
19398 (format org-property-format
19399 (match-string 2) (match-string 3)))
19401 (org-move-to-column column)))
19403 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19404 "Variable to store copy of `adaptive-fill-regexp'.
19405 Since `adaptive-fill-regexp' is set to never match, we need to
19406 store a backup of its value before entering `org-mode' so that
19407 the functionality can be provided as a fall-back.")
19409 (defun org-set-autofill-regexps ()
19411 ;; In the paragraph separator we include headlines, because filling
19412 ;; text in a line directly attached to a headline would otherwise
19413 ;; fill the headline as well.
19414 (org-set-local 'comment-start-skip "^#+[ \t]*")
19415 (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|#]")
19416 ;; The paragraph starter includes hand-formatted lists.
19422 org-outline-regexp "\\|"
19424 (org-item-re) "\\|"
19427 "\\\\\\(begin\\|end\\|[][]\\)"))
19428 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19429 ;; But only if the user has not turned off tables or fixed-width regions
19431 'auto-fill-inhibit-regexp
19432 (concat org-outline-regexp
19434 "\\|[ \t]*" org-keyword-time-regexp
19435 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19438 (if org-enable-table-editor "|" "")
19439 (if org-enable-fixed-width-editor ":" "")
19441 ;; We use our own fill-paragraph function, to make sure that tables
19442 ;; and fixed-width regions are not wrapped. That function will pass
19443 ;; through to `fill-paragraph' when appropriate.
19444 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19445 ;; Prevent auto-fill from inserting unwanted new items.
19446 (org-set-local 'fill-nobreak-predicate
19447 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19448 fill-nobreak-predicate
19449 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19450 ;; Adaptive filling: To get full control, first make sure that
19451 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19452 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19453 (org-set-local 'org-adaptive-fill-regexp-backup
19454 adaptive-fill-regexp))
19455 (org-set-local 'adaptive-fill-regexp "\000")
19456 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19457 (org-set-local 'adaptive-fill-function
19458 'org-adaptive-fill-function)
19460 'align-mode-rules-list
19461 '((org-in-buffer-settings
19462 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
19463 (modes . '(org-mode))))))
19465 (defun org-fill-item-nobreak-p ()
19466 "Non-nil when a line break at point would insert a new item."
19467 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19469 (defun org-fill-paragraph (&optional justify)
19470 "Re-align a table, pass through to fill-paragraph if no table."
19471 (let ((table-p (org-at-table-p))
19472 (table.el-p (org-at-table.el-p))
19473 (itemp (org-in-item-p)))
19474 (cond ((and (equal (char-after (point-at-bol)) ?*)
19475 (save-excursion (goto-char (point-at-bol))
19476 (looking-at org-outline-regexp)))
19477 t) ; skip headlines
19478 (table.el-p t) ; skip table.el tables
19479 (table-p (org-table-align) t) ; align Org tables
19480 (itemp ; align text in items
19481 (let* ((struct (save-excursion (goto-char itemp)
19482 (org-list-struct)))
19483 (parents (org-list-parents-alist struct))
19484 (children (org-list-get-children itemp struct parents))
19485 beg end prev next prefix)
19486 ;; Determine in which part of item point is: before
19487 ;; first child, after last child, between two
19488 ;; sub-lists, or simply in item if there's no child.
19491 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19493 end (org-list-get-item-end itemp struct)))
19494 ((< (point) (setq next (car children)))
19495 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19498 ((> (point) (setq prev (car (last children))))
19499 (setq beg (org-list-get-item-end prev struct)
19500 end (org-list-get-item-end itemp struct)
19501 prefix (save-excursion
19503 (skip-chars-forward " \t")
19504 (make-string (current-column) ?\ ))))
19506 (while (setq next (pop children))
19507 (if (> (point) next)
19509 (setq beg (org-list-get-item-end prev struct)
19511 prefix (save-excursion
19513 (skip-chars-forward " \t")
19514 (make-string (current-column) ?\ )))
19515 (throw 'exit nil))))))
19516 ;; Use `fill-paragraph' with buffer narrowed to item
19517 ;; without any child, and with our computed PREFIX.
19518 (flet ((fill-context-prefix (from to &optional flr) prefix))
19520 (narrow-to-region beg end)
19521 (save-excursion (fill-paragraph justify)))) t))
19522 ;; Special case where point is not in a list but is on
19523 ;; a paragraph adjacent to a list: make sure this paragraph
19524 ;; doesn't get merged with the end of the list by narrowing
19526 ((save-excursion (forward-paragraph -1)
19527 (setq itemp (org-in-item-p)))
19528 (let ((struct (save-excursion (goto-char itemp)
19529 (org-list-struct))))
19531 (narrow-to-region (org-list-get-bottom-point struct)
19532 (save-excursion (forward-paragraph 1)
19534 (fill-paragraph justify) t)))
19535 ;; Else simply call `fill-paragraph'.
19538 ;; For reference, this is the default value of adaptive-fill-regexp
19539 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
19541 (defun org-adaptive-fill-function ()
19542 "Return a fill prefix for org-mode files."
19547 ((looking-at "#[ \t]+")
19548 (match-string-no-properties 0))
19551 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19552 ;; Point is in a list after `backward-paragraph': original
19553 ;; point wasn't in the list, or filling would have been taken
19554 ;; care of by `org-auto-fill-function', but the list and the
19555 ;; real paragraph are not separated by a blank line. Thus, move
19556 ;; point after the list to go back to real paragraph and
19557 ;; determine fill-prefix.
19558 ((setq itemp (org-in-item-p))
19560 (let* ((struct (org-list-struct))
19561 (bottom (org-list-get-bottom-point struct)))
19563 (make-string (org-get-indentation) ?\ )))
19565 ((looking-at org-adaptive-fill-regexp-backup)
19566 (match-string-no-properties 0))))))
19568 (defun org-auto-fill-function ()
19569 "Auto-fill function."
19570 (let (itemp prefix)
19571 ;; When in a list, compute an appropriate fill-prefix and make
19572 ;; sure it will be used by `do-auto-fill'.
19573 (if (setq itemp (org-in-item-p))
19575 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19576 (flet ((fill-context-prefix (from to &optional flr) prefix))
19578 ;; Else just use `do-auto-fill'.
19583 (defun org-toggle-fixed-width-section (arg)
19584 "Toggle the fixed-width export.
19585 If there is no active region, the QUOTE keyword at the current headline is
19586 inserted or removed. When present, it causes the text between this headline
19587 and the next to be exported as fixed-width text, and unmodified.
19588 If there is an active region, this command adds or removes a colon as the
19589 first character of this line. If the first character of a line is a colon,
19590 this line is also exported in fixed-width font."
19593 (regionp (org-region-active-p))
19594 (beg (if regionp (region-beginning) (point)))
19595 (end (if regionp (region-end)))
19596 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19597 (case-fold-search nil)
19598 (re "[ \t]*\\(: \\)")
19603 (setq cc (current-column))
19604 (beginning-of-line 1)
19605 (setq off (looking-at re))
19606 (while (> nlines 0)
19607 (setq nlines (1- nlines))
19608 (beginning-of-line 1)
19611 (org-move-to-column cc t)
19614 ((and off (looking-at re))
19615 (replace-match "" t t nil 1))
19616 ((not off) (org-move-to-column cc t) (insert ": ")))
19619 (org-back-to-heading)
19620 (if (looking-at (concat org-outline-regexp
19621 "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
19622 (replace-match "" t t nil 1)
19623 (if (looking-at org-outline-regexp)
19625 (goto-char (match-end 0))
19626 (insert org-quote-string " "))))))))
19628 (defun org-reftex-citation ()
19629 "Use reftex-citation to insert a citation into the buffer.
19630 This looks for a line like
19632 #+BIBLIOGRAPHY: foo plain option:-d
19634 and derives from it that foo.bib is the bibliography file relevant
19635 for this document. It then installs the necessary environment for RefTeX
19636 to work in this buffer and calls `reftex-citation' to insert a citation
19639 Export of such citations to both LaTeX and HTML is handled by the contributed
19640 package org-exp-bibtex by Taru Karttunen."
19642 (let ((reftex-docstruct-symbol 'rds)
19643 (reftex-cite-format "\\cite{%l}")
19648 (let ((case-fold-search t)
19649 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
19650 (if (not (save-excursion
19651 (or (re-search-forward re nil t)
19652 (re-search-backward re nil t))))
19653 (error "No bibliography defined in file")
19654 (setq bib (concat (match-string 1) ".bib")
19655 rds (list (list 'bib bib)))))))
19656 (call-interactively 'reftex-citation)))
19658 ;;;; Functions extending outline functionality
19660 (defun org-beginning-of-line (&optional arg)
19661 "Go to the beginning of the current line. If that is invisible, continue
19662 to a visible line beginning. This makes the function of C-a more intuitive.
19663 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19664 first attempt, and only move to after the tags when the cursor is already
19665 beyond the end of the headline."
19667 (let ((pos (point))
19668 (special (if (consp org-special-ctrl-a/e)
19669 (car org-special-ctrl-a/e)
19670 org-special-ctrl-a/e))
19672 (if (org-bound-and-true-p line-move-visual)
19673 (beginning-of-visual-line 1)
19674 (beginning-of-line 1))
19675 (if (and arg (fboundp 'move-beginning-of-line))
19676 (call-interactively 'move-beginning-of-line)
19680 (if (org-truely-invisible-p)
19681 (while (and (not (bobp)) (org-truely-invisible-p))
19683 (beginning-of-line 1))
19684 (forward-char 1))))
19687 ((and (looking-at org-complex-heading-regexp)
19688 (= (char-after (match-end 1)) ?\ ))
19689 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19693 (cond ((> pos refpos) refpos)
19694 ((= pos (point)) refpos)
19696 (cond ((> pos (point)) (point))
19697 ((not (eq last-command this-command)) (point))
19702 (cond ((> pos (match-end 0)) (match-end 0))
19703 ((= pos (point)) (match-end 0))
19705 (cond ((> pos (point)) (point))
19706 ((not (eq last-command this-command)) (point))
19707 (t (match-end 0))))))))
19709 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19711 (defun org-end-of-line (&optional arg)
19712 "Go to the end of the line.
19713 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19714 first attempt, and only move to after the tags when the cursor is already
19715 beyond the end of the headline."
19717 (let ((special (if (consp org-special-ctrl-a/e)
19718 (cdr org-special-ctrl-a/e)
19719 org-special-ctrl-a/e)))
19720 (if (or (not special)
19721 (not (org-on-heading-p))
19723 (call-interactively
19724 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19725 ((fboundp 'move-end-of-line) 'move-end-of-line)
19727 (let ((pos (point)))
19728 (beginning-of-line 1)
19729 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
19731 (if (or (< pos (match-beginning 1))
19732 (= pos (match-end 0)))
19733 (goto-char (match-beginning 1))
19734 (goto-char (match-end 0)))
19735 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19736 (goto-char (match-end 0))
19737 (goto-char (match-beginning 1))))
19738 (call-interactively (if (fboundp 'move-end-of-line)
19742 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19744 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19745 (define-key org-mode-map "\C-e" 'org-end-of-line)
19747 (defun org-backward-sentence (&optional arg)
19748 "Go to beginning of sentence, or beginning of table field.
19749 This will call `backward-sentence' or `org-table-beginning-of-field',
19750 depending on context."
19753 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19754 (t (call-interactively 'backward-sentence))))
19756 (defun org-forward-sentence (&optional arg)
19757 "Go to end of sentence, or end of table field.
19758 This will call `forward-sentence' or `org-table-end-of-field',
19759 depending on context."
19762 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19763 (t (call-interactively 'forward-sentence))))
19765 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19766 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19768 (defun org-kill-line (&optional arg)
19769 "Kill line, to tags or end of line."
19772 ((or (not org-special-ctrl-k)
19774 (not (org-on-heading-p)))
19775 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19776 org-ctrl-k-protect-subtree)
19777 (if (or (eq org-ctrl-k-protect-subtree 'error)
19778 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19779 (error "C-k aborted - would kill hidden subtree")))
19780 (call-interactively 'kill-line))
19781 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
19782 (kill-region (point) (match-beginning 1))
19783 (org-set-tags nil t))
19784 (t (kill-region (point) (point-at-eol)))))
19786 (define-key org-mode-map "\C-k" 'org-kill-line)
19788 (defun org-yank (&optional arg)
19789 "Yank. If the kill is a subtree, treat it specially.
19790 This command will look at the current kill and check if is a single
19791 subtree, or a series of subtrees[1]. If it passes the test, and if the
19792 cursor is at the beginning of a line or after the stars of a currently
19793 empty headline, then the yank is handled specially. How exactly depends
19794 on the value of the following variables, both set by default.
19796 org-yank-folded-subtrees
19797 When set, the subtree(s) will be folded after insertion, but only
19798 if doing so would now swallow text after the yanked text.
19800 org-yank-adjusted-subtrees
19801 When set, the subtree will be promoted or demoted in order to
19802 fit into the local outline tree structure, which means that the level
19803 will be adjusted so that it becomes the smaller one of the two
19804 *visible* surrounding headings.
19806 Any prefix to this command will cause `yank' to be called directly with
19807 no special treatment. In particular, a simple \\[universal-argument] prefix \
19809 plainly yank the text as it is.
19811 \[1] The test checks if the first non-white line is a heading
19812 and if there are no other headings with fewer stars."
19814 (org-yank-generic 'yank arg))
19816 (defun org-yank-generic (command arg)
19817 "Perform some yank-like command.
19819 This function implements the behavior described in the `org-yank'
19820 documentation. However, it has been generalized to work for any
19821 interactive command with similar behavior."
19823 ;; pretend to be command COMMAND
19824 (setq this-command command)
19827 (call-interactively command)
19829 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19830 (and (org-kill-is-subtree-p)
19832 (and (looking-at "[ \t]*$")
19835 (buffer-substring (point-at-bol) (point)))))))
19838 ((and subtreep org-yank-folded-subtrees)
19839 (let ((beg (point))
19841 (if (and subtreep org-yank-adjusted-subtrees)
19842 (org-paste-subtree nil nil 'for-yank)
19843 (call-interactively command))
19847 (when (and (bolp) subtreep
19848 (not (setq swallowp
19849 (org-yank-folding-would-swallow-text beg end))))
19850 (org-with-limited-levels
19851 (or (looking-at org-outline-regexp)
19852 (re-search-forward org-outline-regexp-bol end t))
19853 (while (and (< (point) end) (looking-at org-outline-regexp))
19855 (org-cycle-show-empty-lines 'folded)
19856 (condition-case nil
19857 (outline-forward-same-level 1)
19858 (error (goto-char end))))))
19861 "Inserted text not folded because that would swallow text"))
19864 (skip-chars-forward " \t\n\r")
19865 (beginning-of-line 1)
19866 (push-mark beg 'nomsg)))
19867 ((and subtreep org-yank-adjusted-subtrees)
19868 (let ((beg (point-at-bol)))
19869 (org-paste-subtree nil nil 'for-yank)
19870 (push-mark beg 'nomsg)))
19872 (call-interactively command))))))
19874 (defun org-yank-folding-would-swallow-text (beg end)
19875 "Would hide-subtree at BEG swallow any text after END?"
19877 (org-with-limited-levels
19880 (when (or (looking-at org-outline-regexp)
19881 (re-search-forward org-outline-regexp-bol end t))
19882 (setq level (org-outline-level)))
19884 (skip-chars-forward " \t\r\n\v\f")
19886 (and (bolp) (looking-at org-outline-regexp)
19887 (<= (org-outline-level) level)))
19888 nil ; Nothing would be swallowed
19889 t))))) ; something would swallow
19891 (define-key org-mode-map "\C-y" 'org-yank)
19893 (defun org-truely-invisible-p ()
19894 "Check if point is at a character currently not visible.
19895 This version does not only check the character property, but also
19897 ;; Early versions of noutline don't have `outline-invisible-p'.
19898 (if (org-bound-and-true-p visible-mode)
19900 (outline-invisible-p)))
19902 (defun org-invisible-p2 ()
19903 "Check if point is at a character currently not visible."
19905 (if (and (eolp) (not (bobp))) (backward-char 1))
19906 ;; Early versions of noutline don't have `outline-invisible-p'.
19907 (outline-invisible-p)))
19909 (defun org-back-to-heading (&optional invisible-ok)
19910 "Call `outline-back-to-heading', but provide a better error message."
19911 (condition-case nil
19912 (outline-back-to-heading invisible-ok)
19913 (error (error "Before first headline at position %d in buffer %s"
19914 (point) (current-buffer)))))
19916 (defun org-beginning-of-defun ()
19917 "Go to the beginning of the subtree, i.e. back to the heading."
19918 (org-back-to-heading))
19919 (defun org-end-of-defun ()
19920 "Go to the end of the subtree."
19921 (org-end-of-subtree nil t))
19923 (defun org-before-first-heading-p ()
19924 "Before first heading?"
19927 (null (re-search-backward org-outline-regexp-bol nil t))))
19929 (defun org-on-heading-p (&optional ignored)
19930 (outline-on-heading-p t))
19931 (defun org-at-heading-p (&optional ignored)
19932 (outline-on-heading-p t))
19934 (defun org-point-at-end-of-empty-headline ()
19935 "If point is at the end of an empty headline, return t, else nil.
19936 If the heading only contains a TODO keyword, it is still still considered
19938 (and (looking-at "[ \t]*$")
19940 (beginning-of-line 1)
19941 (let ((case-fold-search nil))
19942 (looking-at (concat "^\\(\\*+\\)[ \t]+\\(" org-todo-regexp
19943 "\\)?[ \t]*$"))))))
19944 (defun org-at-heading-or-item-p ()
19945 (or (org-on-heading-p) (org-at-item-p)))
19947 (defun org-on-target-p ()
19948 (or (org-in-regexp org-radio-target-regexp)
19949 (org-in-regexp org-target-regexp)))
19951 (defun org-up-heading-all (arg)
19952 "Move to the heading line of which the present line is a subheading.
19953 This function considers both visible and invisible heading lines.
19954 With argument, move up ARG levels."
19955 (if (fboundp 'outline-up-heading-all)
19956 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19957 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19959 (defun org-up-heading-safe ()
19960 "Move to the heading line of which the present line is a subheading.
19961 This version will not throw an error. It will return the level of the
19962 headline found, or nil if no higher level is found.
19964 Also, this function will be a lot faster than `outline-up-heading',
19965 because it relies on stars being the outline starters. This can really
19966 make a significant difference in outlines with very many siblings."
19967 (let (start-level re)
19968 (org-back-to-heading t)
19969 (setq start-level (funcall outline-level))
19970 (if (equal start-level 1)
19972 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
19973 (if (re-search-backward re nil t)
19974 (funcall outline-level)))))
19976 (defun org-first-sibling-p ()
19977 "Is this heading the first child of its parents?"
19979 (let ((re org-outline-regexp-bol)
19981 (unless (org-at-heading-p t)
19982 (error "Not at a heading"))
19983 (setq level (funcall outline-level))
19985 (if (not (re-search-backward re nil t))
19987 (setq l (funcall outline-level))
19990 (defun org-goto-sibling (&optional previous)
19991 "Goto the next sibling, even if it is invisible.
19992 When PREVIOUS is set, go to the previous sibling instead. Returns t
19993 when a sibling was found. When none is found, return nil and don't
19995 (let ((fun (if previous 're-search-backward 're-search-forward))
19997 (re org-outline-regexp-bol)
19999 (when (condition-case nil (org-back-to-heading t) (error nil))
20000 (setq level (funcall outline-level))
20002 (or previous (forward-char 1))
20003 (while (funcall fun re nil t)
20004 (setq l (funcall outline-level))
20005 (when (< l level) (goto-char pos) (throw 'exit nil))
20006 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20010 (defun org-show-siblings ()
20011 "Show all siblings of the current headline."
20013 (while (org-goto-sibling) (org-flag-heading nil)))
20015 (while (org-goto-sibling 'previous)
20016 (org-flag-heading nil))))
20018 (defun org-goto-first-child ()
20019 "Goto the first child, even if it is invisible.
20020 Return t when a child was found. Otherwise don't move point and
20022 (let (level (pos (point)) (re org-outline-regexp-bol))
20023 (when (condition-case nil (org-back-to-heading t) (error nil))
20024 (setq level (outline-level))
20026 (if (and (re-search-forward re nil t) (> (outline-level) level))
20027 (progn (goto-char (match-beginning 0)) t)
20028 (goto-char pos) nil))))
20030 (defun org-show-hidden-entry ()
20031 "Show an entry where even the heading is hidden."
20035 (defun org-flag-heading (flag &optional entry)
20036 "Flag the current heading. FLAG non-nil means make invisible.
20037 When ENTRY is non-nil, show the entire entry."
20039 (org-back-to-heading t)
20040 ;; Check if we should show the entire entry
20045 (and (outline-next-heading)
20046 (org-flag-heading nil))))
20047 (outline-flag-region (max (point-min) (1- (point)))
20048 (save-excursion (outline-end-of-heading) (point))
20051 (defun org-get-next-sibling ()
20052 "Move to next heading of the same level, and return point.
20053 If there is no such heading, return nil.
20054 This is like outline-next-sibling, but invisible headings are ok."
20055 (let ((level (funcall outline-level)))
20056 (outline-next-heading)
20057 (while (and (not (eobp)) (> (funcall outline-level) level))
20058 (outline-next-heading))
20059 (if (or (eobp) (< (funcall outline-level) level))
20063 (defun org-get-last-sibling ()
20064 "Move to previous heading of the same level, and return point.
20065 If there is no such heading, return nil."
20066 (let ((opoint (point))
20067 (level (funcall outline-level)))
20068 (outline-previous-heading)
20069 (when (and (/= (point) opoint) (outline-on-heading-p t))
20070 (while (and (> (funcall outline-level) level)
20072 (outline-previous-heading))
20073 (if (< (funcall outline-level) level)
20077 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20078 ;; This contains an exact copy of the original function, but it uses
20079 ;; `org-back-to-heading', to make it work also in invisible
20080 ;; trees. And is uses an invisible-OK argument.
20081 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20082 ;; Furthermore, when used inside Org, finding the end of a large subtree
20083 ;; with many children and grandchildren etc, this can be much faster
20084 ;; than the outline version.
20085 (org-back-to-heading invisible-OK)
20087 (level (funcall outline-level)))
20088 (if (and (org-mode-p) (< level 1000))
20089 ;; A true heading (not a plain list item), in Org-mode
20090 ;; This means we can easily find the end by looking
20091 ;; only for the right number of stars. Using a regexp to do
20092 ;; this is so much faster than using a Lisp loop.
20093 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
20095 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20096 ;; something else, do it the slow way
20097 (while (and (not (eobp))
20098 (or first (> (funcall outline-level) level)))
20100 (outline-next-heading)))
20102 (if (memq (preceding-char) '(?\n ?\^M))
20104 ;; Go to end of line before heading
20106 (if (memq (preceding-char) '(?\n ?\^M))
20107 ;; leave blank line before heading
20108 (forward-char -1))))))
20111 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20112 "Use Org version in org-mode, for dramatic speed-up."
20115 (org-end-of-subtree nil t)
20116 (unless (eobp) (backward-char 1)))
20119 (defun org-end-of-meta-data-and-drawers ()
20120 "Jump to the first text after meta data and drawers in the current entry.
20121 This will move over empty lines, lines with planning time stamps,
20122 clocking lines, and drawers."
20123 (org-back-to-heading t)
20124 (let ((end (save-excursion (outline-next-heading) (point)))
20125 (re (concat "\\(" org-drawer-regexp "\\)"
20126 "\\|" "[ \t]*" org-keyword-time-regexp)))
20128 (while (re-search-forward re end t)
20129 (if (not (match-end 1))
20130 ;; empty or planning line
20132 ;; a drawer, find the end
20133 (re-search-forward "^[ \t]*:END:" end 'move)
20135 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
20138 (defun org-forward-same-level (arg &optional invisible-ok)
20139 "Move forward to the arg'th subheading at same level as this one.
20140 Stop at the first and last subheadings of a superior heading.
20141 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20142 it wil also look at invisible ones."
20144 (org-back-to-heading invisible-ok)
20146 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20147 (re (format "^\\*\\{1,%d\\} " level))
20151 (while (and (re-search-forward re nil 'move)
20152 (setq l (- (match-end 0) (match-beginning 0) 1))
20155 (progn (backward-char 1) (outline-invisible-p)))
20156 (if (< l level) (setq arg 1)))
20157 (setq arg (1- arg)))
20158 (beginning-of-line 1)))
20160 (defun org-backward-same-level (arg &optional invisible-ok)
20161 "Move backward to the arg'th subheading at same level as this one.
20162 Stop at the first and last subheadings of a superior heading."
20164 (org-back-to-heading)
20166 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20167 (re (format "^\\*\\{1,%d\\} " level))
20170 (while (and (re-search-backward re nil 'move)
20171 (setq l (- (match-end 0) (match-beginning 0) 1))
20174 (outline-invisible-p))
20175 (if (< l level) (setq arg 1)))
20176 (setq arg (1- arg)))))
20178 (defun org-show-subtree ()
20179 "Show everything after this heading at deeper levels."
20180 (outline-flag-region
20183 (org-end-of-subtree t t))
20186 (defun org-show-entry ()
20187 "Show the body directly following this heading.
20188 Show the heading too, if it is currently invisible."
20191 (condition-case nil
20193 (org-back-to-heading t)
20194 (outline-flag-region
20195 (max (point-min) (1- (point)))
20197 (if (re-search-forward
20198 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
20199 (match-beginning 1)
20202 (org-cycle-hide-drawers 'children))
20205 (defun org-make-options-regexp (kwds &optional extra)
20206 "Make a regular expression for keyword lines."
20210 (mapconcat 'regexp-quote kwds "\\|")
20211 (if extra (concat "\\|" extra))
20215 ;; Make isearch reveal the necessary context
20216 (defun org-isearch-end ()
20217 "Reveal context after isearch exits."
20218 (when isearch-success ; only if search was successful
20219 (if (featurep 'xemacs)
20220 ;; Under XEmacs, the hook is run in the correct place,
20221 ;; we directly show the context.
20222 (org-show-context 'isearch)
20223 ;; In Emacs the hook runs *before* restoring the overlays.
20224 ;; So we have to use a one-time post-command-hook to do this.
20225 ;; (Emacs 22 has a special variable, see function `org-mode')
20226 (unless (and (boundp 'isearch-mode-end-hook-quit)
20227 isearch-mode-end-hook-quit)
20228 ;; Only when the isearch was not quitted.
20229 (org-add-hook 'post-command-hook 'org-isearch-post-command
20230 'append 'local)))))
20232 (defun org-isearch-post-command ()
20233 "Remove self from hook, and show context."
20234 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20235 (org-show-context 'isearch))
20238 ;;;; Integration with and fixes for other packages
20242 (defvar org-imenu-markers nil
20243 "All markers currently used by Imenu.")
20244 (make-variable-buffer-local 'org-imenu-markers)
20246 (defun org-imenu-new-marker (&optional pos)
20247 "Return a new marker for use by Imenu, and remember the marker."
20248 (let ((m (make-marker)))
20249 (move-marker m (or pos (point)))
20250 (push m org-imenu-markers)
20253 (defun org-imenu-get-tree ()
20254 "Produce the index for Imenu."
20255 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20256 (setq org-imenu-markers nil)
20257 (let* ((n org-imenu-depth)
20258 (re (concat "^" (org-get-limited-outline-regexp)))
20259 (subs (make-vector (1+ n) nil))
20265 (goto-char (point-max))
20266 (while (re-search-backward re nil t)
20267 (setq level (org-reduced-level (funcall outline-level)))
20269 (looking-at org-complex-heading-regexp)
20270 (setq head (org-link-display-format
20271 (org-match-string-no-properties 4))
20272 m (org-imenu-new-marker))
20273 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20274 (if (>= level last-level)
20275 (push (cons head m) (aref subs level))
20276 (push (cons head (aref subs (1+ level))) (aref subs level))
20277 (loop for i from (1+ level) to n do (aset subs i nil)))
20278 (setq last-level level)))))
20281 (eval-after-load "imenu"
20283 (add-hook 'imenu-after-jump-hook
20286 (org-show-context 'org-goto))))))
20288 (defun org-link-display-format (link)
20289 "Replace a link with either the description, or the link target
20290 if no description is present"
20292 (if (string-match org-bracket-link-analytic-regexp link)
20293 (replace-match (if (match-end 5)
20294 (match-string 5 link)
20295 (concat (match-string 1 link)
20296 (match-string 3 link)))
20300 ;; Speedbar support
20302 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20303 "Overlay marking the agenda restriction line in speedbar.")
20304 (overlay-put org-speedbar-restriction-lock-overlay
20305 'face 'org-agenda-restriction-lock)
20306 (overlay-put org-speedbar-restriction-lock-overlay
20307 'help-echo "Agendas are currently limited to this item.")
20308 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20310 (defun org-speedbar-set-agenda-restriction ()
20311 "Restrict future agenda commands to the location at point in speedbar.
20312 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
20314 (require 'org-agenda)
20315 (let (p m tp np dir txt)
20317 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20319 (setq m (get-text-property p 'org-imenu-marker))
20320 (with-current-buffer (marker-buffer m)
20322 (org-agenda-set-restriction-lock 'subtree)))
20323 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20324 'speedbar-function 'speedbar-find-file))
20325 (setq tp (previous-single-property-change
20326 (1+ p) 'speedbar-function)
20327 np (next-single-property-change
20328 tp 'speedbar-function)
20329 dir (speedbar-line-directory)
20330 txt (buffer-substring-no-properties (or tp (point-min))
20331 (or np (point-max))))
20332 (with-current-buffer (find-file-noselect
20333 (let ((default-directory dir))
20334 (expand-file-name txt)))
20335 (unless (org-mode-p)
20336 (error "Cannot restrict to non-Org-mode file"))
20337 (org-agenda-set-restriction-lock 'file)))
20338 (t (error "Don't know how to restrict Org-mode's agenda")))
20339 (move-overlay org-speedbar-restriction-lock-overlay
20340 (point-at-bol) (point-at-eol))
20341 (setq current-prefix-arg nil)
20342 (org-agenda-maybe-redo)))
20344 (eval-after-load "speedbar"
20346 (speedbar-add-supported-extension ".org")
20347 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20348 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20349 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20350 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20351 (add-hook 'speedbar-visiting-tag-hook
20352 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20354 ;;; Fixes and Hacks for problems with other packages
20356 ;; Make flyspell not check words in links, to not mess up our keymap
20357 (defun org-mode-flyspell-verify ()
20358 "Don't let flyspell put overlays at active buttons, or on
20359 {todo,all-time,additional-option-like}-keywords."
20360 (let ((pos (max (1- (point)) (point-min)))
20361 (word (thing-at-point 'word)))
20362 (and (not (get-text-property pos 'keymap))
20363 (not (get-text-property pos 'org-no-flyspell))
20364 (not (member word org-todo-keywords-1))
20365 (not (member word org-all-time-keywords))
20366 (not (member word org-additional-option-like-keywords)))))
20368 (defun org-remove-flyspell-overlays-in (beg end)
20369 "Remove flyspell overlays in region."
20370 (and (org-bound-and-true-p flyspell-mode)
20371 (fboundp 'flyspell-delete-region-overlays)
20372 (flyspell-delete-region-overlays beg end))
20373 (add-text-properties beg end '(org-no-flyspell t)))
20375 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20376 (eval-after-load "bookmark"
20377 '(if (boundp 'bookmark-after-jump-hook)
20378 ;; We can use the hook
20379 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20380 ;; Hook not available, use advice
20381 (defadvice bookmark-jump (after org-make-visible activate)
20382 "Make the position visible."
20383 (org-bookmark-jump-unhide))))
20385 ;; Make sure saveplace shows the location if it was hidden
20386 (eval-after-load "saveplace"
20387 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20388 "Make the position visible."
20389 (org-bookmark-jump-unhide)))
20391 ;; Make sure ecb shows the location if it was hidden
20392 (eval-after-load "ecb"
20393 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20394 "Make hierarchy visible when jumping into location from ECB tree buffer."
20396 (org-show-context))))
20398 (defun org-bookmark-jump-unhide ()
20399 "Unhide the current position, to show the bookmark location."
20401 (or (outline-invisible-p)
20402 (save-excursion (goto-char (max (point-min) (1- (point))))
20403 (outline-invisible-p)))
20404 (org-show-context 'bookmark-jump)))
20406 ;; Make session.el ignore our circular variable
20407 (eval-after-load "session"
20408 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20410 ;;;; Experimental code
20412 (defun org-closed-in-range ()
20413 "Sparse tree of items closed in a certain time range.
20414 Still experimental, may disappear in the future."
20416 ;; Get the time interval from the user.
20417 (let* ((time1 (org-float-time
20418 (org-read-date nil 'to-time nil "Starting date: ")))
20419 (time2 (org-float-time
20420 (org-read-date nil 'to-time nil "End date:")))
20421 ;; callback function
20422 (callback (lambda ()
20425 (apply 'encode-time
20426 (org-parse-time-string
20427 (match-string 1))))))
20428 ;; check if time in interval
20429 (and (>= time time1) (<= time time2))))))
20430 ;; make tree, check each match with the callback
20431 (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
20437 (run-hooks 'org-load-hook)
20439 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20441 ;;; org.el ends here