Fix exporting radio link with missing radio target
[org-mode.git] / lisp / org.el
blob60658f4390a01b58c7a14c94813519530435d35e
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; 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/>.
26 ;;; Commentary:
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
63 ;;; Code:
65 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local)
70 ;;;; Require other packages
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (load "org-loaddefs.el" t t t)
82 (require 'org-macs)
83 (require 'org-compat)
85 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
86 ;; some places -- e.g. see the macro `org-with-limited-levels'.
88 ;; In Org buffers, the value of `outline-regexp' is that of
89 ;; `org-outline-regexp'. The only function still directly relying on
90 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
91 ;; job when `orgstruct-mode' is active.
92 (defvar org-outline-regexp "\\*+ "
93 "Regexp to match Org headlines.")
95 (defvar org-outline-regexp-bol "^\\*+ "
96 "Regexp to match Org headlines.
97 This is similar to `org-outline-regexp' but additionally makes
98 sure that we are at the beginning of the line.")
100 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
101 "Matches a headline, putting stars and text into groups.
102 Stars are put in group 1 and the trimmed body in group 2.")
104 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
105 (unless (boundp 'calendar-view-holidays-initially-flag)
106 (org-defvaralias 'calendar-view-holidays-initially-flag
107 'view-calendar-holidays-initially))
108 (unless (boundp 'calendar-view-diary-initially-flag)
109 (org-defvaralias 'calendar-view-diary-initially-flag
110 'view-diary-entries-initially))
111 (unless (boundp 'diary-fancy-buffer)
112 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
114 (declare-function org-add-archive-files "org-archive" (files))
116 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
117 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
118 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
119 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
120 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
121 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
122 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
123 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
124 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
125 (declare-function org-clock-update-time-maybe "org-clock" ())
126 (declare-function org-clocktable-shift "org-clock" (dir n))
128 (declare-function orgtbl-mode "org-table" (&optional arg))
129 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-table-edit-field "org-table" (arg))
132 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
133 (declare-function org-table-set-constants "org-table" ())
134 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
135 (declare-function org-id-get-create "org-id" (&optional force))
136 (declare-function org-id-find-id-file "org-id" (id))
137 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
138 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
139 (declare-function org-agenda-redo "org-agenda" (&optional all))
140 (declare-function org-table-align "org-table" ())
141 (declare-function org-table-begin "org-table" (&optional table-type))
142 (declare-function org-table-blank-field "org-table" ())
143 (declare-function org-table-end "org-table" (&optional table-type))
144 (declare-function org-table-insert-row "org-table" (&optional arg))
145 (declare-function org-table-paste-rectangle "org-table" ())
146 (declare-function org-table-maybe-eval-formula "org-table" ())
147 (declare-function org-table-maybe-recalculate-line "org-table" ())
149 (declare-function org-element--parse-objects "org-element"
150 (beg end acc restriction))
151 (declare-function org-element-at-point "org-element" (&optional keep-trail))
152 (declare-function org-element-contents "org-element" (element))
153 (declare-function org-element-context "org-element" (&optional element))
154 (declare-function org-element-interpret-data "org-element"
155 (data &optional parent))
156 (declare-function org-element-map "org-element"
157 (data types fun &optional info first-match no-recursion))
158 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
159 (declare-function org-element-parse-buffer "org-element"
160 (&optional granularity visible-only))
161 (declare-function org-element-property "org-element" (property element))
162 (declare-function org-element-put-property "org-element"
163 (element property value))
164 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
165 (declare-function org-element--parse-objects "org-element"
166 (beg end acc restriction))
167 (declare-function org-element-parse-buffer "org-element"
168 (&optional granularity visible-only))
169 (declare-function org-element-restriction "org-element" (element))
170 (declare-function org-element-type "org-element" (element))
172 ;; load languages based on value of `org-babel-load-languages'
173 (defvar org-babel-load-languages)
175 ;;;###autoload
176 (defun org-babel-do-load-languages (sym value)
177 "Load the languages defined in `org-babel-load-languages'."
178 (set-default sym value)
179 (mapc (lambda (pair)
180 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
181 (if active
182 (progn
183 (require (intern (concat "ob-" lang))))
184 (progn
185 (funcall 'fmakunbound
186 (intern (concat "org-babel-execute:" lang)))
187 (funcall 'fmakunbound
188 (intern (concat "org-babel-expand-body:" lang)))))))
189 org-babel-load-languages))
191 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
192 ;;;###autoload
193 (defun org-babel-load-file (file &optional compile)
194 "Load Emacs Lisp source code blocks in the Org-mode FILE.
195 This function exports the source code using `org-babel-tangle'
196 and then loads the resulting file using `load-file'. With prefix
197 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
198 file to byte-code before it is loaded."
199 (interactive "fFile to load: \nP")
200 (require 'ob-core)
201 (let* ((age (lambda (file)
202 (float-time
203 (time-subtract (current-time)
204 (nth 5 (or (file-attributes (file-truename file))
205 (file-attributes file)))))))
206 (base-name (file-name-sans-extension file))
207 (exported-file (concat base-name ".el")))
208 ;; tangle if the org-mode file is newer than the elisp file
209 (unless (and (file-exists-p exported-file)
210 (> (funcall age file) (funcall age exported-file)))
211 (setq exported-file
212 (car (org-babel-tangle-file file exported-file "emacs-lisp"))))
213 (message "%s %s"
214 (if compile
215 (progn (byte-compile-file exported-file 'load)
216 "Compiled and loaded")
217 (progn (load-file exported-file) "Loaded"))
218 exported-file)))
220 (defcustom org-babel-load-languages '((emacs-lisp . t))
221 "Languages which can be evaluated in Org-mode buffers.
222 This list can be used to load support for any of the languages
223 below, note that each language will depend on a different set of
224 system executables and/or Emacs modes. When a language is
225 \"loaded\", then code blocks in that language can be evaluated
226 with `org-babel-execute-src-block' bound by default to C-c
227 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
228 be set to remove code block evaluation from the C-c C-c
229 keybinding. By default only Emacs Lisp (which has no
230 requirements) is loaded."
231 :group 'org-babel
232 :set 'org-babel-do-load-languages
233 :version "24.1"
234 :type '(alist :tag "Babel Languages"
235 :key-type
236 (choice
237 (const :tag "Awk" awk)
238 (const :tag "C" C)
239 (const :tag "R" R)
240 (const :tag "Asymptote" asymptote)
241 (const :tag "Calc" calc)
242 (const :tag "Clojure" clojure)
243 (const :tag "CSS" css)
244 (const :tag "Ditaa" ditaa)
245 (const :tag "Dot" dot)
246 (const :tag "Emacs Lisp" emacs-lisp)
247 (const :tag "Fortran" fortran)
248 (const :tag "Gnuplot" gnuplot)
249 (const :tag "Haskell" haskell)
250 (const :tag "IO" io)
251 (const :tag "Java" java)
252 (const :tag "Javascript" js)
253 (const :tag "LaTeX" latex)
254 (const :tag "Ledger" ledger)
255 (const :tag "Lilypond" lilypond)
256 (const :tag "Lisp" lisp)
257 (const :tag "Makefile" makefile)
258 (const :tag "Maxima" maxima)
259 (const :tag "Matlab" matlab)
260 (const :tag "Mscgen" mscgen)
261 (const :tag "Ocaml" ocaml)
262 (const :tag "Octave" octave)
263 (const :tag "Org" org)
264 (const :tag "Perl" perl)
265 (const :tag "Pico Lisp" picolisp)
266 (const :tag "PlantUML" plantuml)
267 (const :tag "Python" python)
268 (const :tag "Ruby" ruby)
269 (const :tag "Sass" sass)
270 (const :tag "Scala" scala)
271 (const :tag "Scheme" scheme)
272 (const :tag "Screen" screen)
273 (const :tag "Shell Script" sh)
274 (const :tag "Shen" shen)
275 (const :tag "Sql" sql)
276 (const :tag "Sqlite" sqlite))
277 :value-type (boolean :tag "Activate" :value t)))
279 ;;;; Customization variables
280 (defcustom org-clone-delete-id nil
281 "Remove ID property of clones of a subtree.
282 When non-nil, clones of a subtree don't inherit the ID property.
283 Otherwise they inherit the ID property with a new unique
284 identifier."
285 :type 'boolean
286 :version "24.1"
287 :group 'org-id)
289 ;;; Version
290 (org-check-version)
292 ;;;###autoload
293 (defun org-version (&optional here full message)
294 "Show the org-mode version in the echo area.
295 With prefix argument HERE, insert it at point.
296 When FULL is non-nil, use a verbose version string.
297 When MESSAGE is non-nil, display a message with the version."
298 (interactive "P")
299 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
300 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
301 (load-suffixes (list ".el"))
302 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
303 (org-trash (or
304 (and (fboundp 'org-release) (fboundp 'org-git-version))
305 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
306 (load-suffixes save-load-suffixes)
307 (org-version (org-release))
308 (git-version (org-git-version))
309 (version (format "Org-mode version %s (%s @ %s)"
310 org-version
311 git-version
312 (if org-install-dir
313 (if (string= org-dir org-install-dir)
314 org-install-dir
315 (concat "mixed installation! " org-install-dir " and " org-dir))
316 "org-loaddefs.el can not be found!")))
317 (version1 (if full version org-version)))
318 (if (org-called-interactively-p 'interactive)
319 (if here
320 (insert version)
321 (message version))
322 (if message (message version1))
323 version1)))
325 (defconst org-version (org-version))
327 ;;; Compatibility constants
329 ;;; The custom variables
331 (defgroup org nil
332 "Outline-based notes management and organizer."
333 :tag "Org"
334 :group 'outlines
335 :group 'calendar)
337 (defcustom org-mode-hook nil
338 "Mode hook for Org-mode, run after the mode was turned on."
339 :group 'org
340 :type 'hook)
342 (defcustom org-load-hook nil
343 "Hook that is run after org.el has been loaded."
344 :group 'org
345 :type 'hook)
347 (defcustom org-log-buffer-setup-hook nil
348 "Hook that is run after an Org log buffer is created."
349 :group 'org
350 :version "24.1"
351 :type 'hook)
353 (defvar org-modules) ; defined below
354 (defvar org-modules-loaded nil
355 "Have the modules been loaded already?")
357 (defun org-load-modules-maybe (&optional force)
358 "Load all extensions listed in `org-modules'."
359 (when (or force (not org-modules-loaded))
360 (mapc (lambda (ext)
361 (condition-case nil (require ext)
362 (error (message "Problems while trying to load feature `%s'" ext))))
363 org-modules)
364 (setq org-modules-loaded t)))
366 (defun org-set-modules (var value)
367 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
368 (set var value)
369 (when (featurep 'org)
370 (org-load-modules-maybe 'force)))
372 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
373 "Modules that should always be loaded together with org.el.
375 If a description starts with <C>, the file is not part of Emacs
376 and loading it will require that you have downloaded and properly
377 installed the Org mode distribution.
379 You can also use this system to load external packages (i.e. neither Org
380 core modules, nor modules from the CONTRIB directory). Just add symbols
381 to the end of the list. If the package is called org-xyz.el, then you need
382 to add the symbol `xyz', and the package must have a call to:
384 \(provide 'org-xyz)
386 For export specific modules, see also `org-export-backends'."
387 :group 'org
388 :set 'org-set-modules
389 :version "24.4"
390 :package-version '(Org . "8.0")
391 :type
392 '(set :greedy t
393 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
394 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
395 (const :tag " crypt: Encryption of subtrees" org-crypt)
396 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
397 (const :tag " docview: Links to doc-view buffers" org-docview)
398 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
399 (const :tag " habit: Track your consistency with habits" org-habit)
400 (const :tag " id: Global IDs for identifying entries" org-id)
401 (const :tag " info: Links to Info nodes" org-info)
402 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
403 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
404 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
405 (const :tag " mouse: Additional mouse support" org-mouse)
406 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
407 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
408 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
410 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
411 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
412 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
413 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
414 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
415 (const :tag "C collector: Collect properties into tables" org-collector)
416 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
417 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
418 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
419 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
420 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
421 (const :tag "C eval: Include command output as text" org-eval)
422 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
423 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
424 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
425 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
426 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
427 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
428 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
429 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
430 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
431 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
432 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
433 (const :tag "C mew: Links to Mew folders/messages" org-mew)
434 (const :tag "C mtags: Support for muse-like tags" org-mtags)
435 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
436 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
437 (const :tag "C registry: A registry for Org-mode links" org-registry)
438 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
439 (const :tag "C secretary: Team management with org-mode" org-secretary)
440 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
441 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
442 (const :tag "C track: Keep up with Org-mode development" org-track)
443 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
444 (const :tag "C vm: Links to VM folders/messages" org-vm)
445 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
446 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
447 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
449 (defvar org-export--registered-backends) ; From ox.el.
450 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
451 (declare-function org-export-backend-name "ox" (backend))
452 (defcustom org-export-backends '(ascii html icalendar latex)
453 "List of export back-ends that should be always available.
455 If a description starts with <C>, the file is not part of Emacs
456 and loading it will require that you have downloaded and properly
457 installed the Org mode distribution.
459 Unlike to `org-modules', libraries in this list will not be
460 loaded along with Org, but only once the export framework is
461 needed.
463 This variable needs to be set before org.el is loaded. If you
464 need to make a change while Emacs is running, use the customize
465 interface or run the following code, where VAL stands for the new
466 value of the variable, after updating it:
468 \(progn
469 \(setq org-export--registered-backends
470 \(org-remove-if-not
471 \(lambda (backend)
472 \(let ((name (org-export-backend-name backend)))
473 \(or (memq name val)
474 \(catch 'parentp
475 \(dolist (b val)
476 \(and (org-export-derived-backend-p b name)
477 \(throw 'parentp t)))))))
478 org-export--registered-backends))
479 \(let ((new-list (mapcar 'org-export-backend-name
480 org-export--registered-backends)))
481 \(dolist (backend val)
482 \(cond
483 \((not (load (format \"ox-%s\" backend) t t))
484 \(message \"Problems while trying to load export back-end `%s'\"
485 backend))
486 \((not (memq backend new-list)) (push backend new-list))))
487 \(set-default 'org-export-backends new-list)))
489 Adding a back-end to this list will also pull the back-end it
490 depends on, if any."
491 :group 'org
492 :group 'org-export
493 :version "24.4"
494 :package-version '(Org . "8.0")
495 :initialize 'custom-initialize-set
496 :set (lambda (var val)
497 (if (not (featurep 'ox)) (set-default var val)
498 ;; Any back-end not required anymore (not present in VAL and not
499 ;; a parent of any back-end in the new value) is removed from the
500 ;; list of registered back-ends.
501 (setq org-export--registered-backends
502 (org-remove-if-not
503 (lambda (backend)
504 (let ((name (org-export-backend-name backend)))
505 (or (memq name val)
506 (catch 'parentp
507 (dolist (b val)
508 (and (org-export-derived-backend-p b name)
509 (throw 'parentp t)))))))
510 org-export--registered-backends))
511 ;; Now build NEW-LIST of both new back-ends and required
512 ;; parents.
513 (let ((new-list (mapcar 'org-export-backend-name
514 org-export--registered-backends)))
515 (dolist (backend val)
516 (cond
517 ((not (load (format "ox-%s" backend) t t))
518 (message "Problems while trying to load export back-end `%s'"
519 backend))
520 ((not (memq backend new-list)) (push backend new-list))))
521 ;; Set VAR to that list with fixed dependencies.
522 (set-default var new-list))))
523 :type '(set :greedy t
524 (const :tag " ascii Export buffer to ASCII format" ascii)
525 (const :tag " beamer Export buffer to Beamer presentation" beamer)
526 (const :tag " html Export buffer to HTML format" html)
527 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
528 (const :tag " latex Export buffer to LaTeX format" latex)
529 (const :tag " man Export buffer to MAN format" man)
530 (const :tag " md Export buffer to Markdown format" md)
531 (const :tag " odt Export buffer to ODT format" odt)
532 (const :tag " org Export buffer to Org format" org)
533 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
534 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
535 (const :tag "C deck Export buffer to deck.js presentations" deck)
536 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
537 (const :tag "C groff Export buffer to Groff format" groff)
538 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
539 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
540 (const :tag "C s5 Export buffer to s5 presentations" s5)
541 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
543 (eval-after-load 'ox
544 '(mapc
545 (lambda (backend)
546 (condition-case nil (require (intern (format "ox-%s" backend)))
547 (error (message "Problems while trying to load export back-end `%s'"
548 backend))))
549 org-export-backends))
551 (defcustom org-support-shift-select nil
552 "Non-nil means make shift-cursor commands select text when possible.
554 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
555 start selecting a region, or enlarge regions started in this way.
556 In Org-mode, in special contexts, these same keys are used for
557 other purposes, important enough to compete with shift selection.
558 Org tries to balance these needs by supporting `shift-select-mode'
559 outside these special contexts, under control of this variable.
561 The default of this variable is nil, to avoid confusing behavior. Shifted
562 cursor keys will then execute Org commands in the following contexts:
563 - on a headline, changing TODO state (left/right) and priority (up/down)
564 - on a time stamp, changing the time
565 - in a plain list item, changing the bullet type
566 - in a property definition line, switching between allowed values
567 - in the BEGIN line of a clock table (changing the time block).
568 Outside these contexts, the commands will throw an error.
570 When this variable is t and the cursor is not in a special
571 context, Org-mode will support shift-selection for making and
572 enlarging regions. To make this more effective, the bullet
573 cycling will no longer happen anywhere in an item line, but only
574 if the cursor is exactly on the bullet.
576 If you set this variable to the symbol `always', then the keys
577 will not be special in headlines, property lines, and item lines,
578 to make shift selection work there as well. If this is what you
579 want, you can use the following alternative commands: `C-c C-t'
580 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
581 can be used to switch TODO sets, `C-c -' to cycle item bullet
582 types, and properties can be edited by hand or in column view.
584 However, when the cursor is on a timestamp, shift-cursor commands
585 will still edit the time stamp - this is just too good to give up.
587 XEmacs user should have this variable set to nil, because
588 `shift-select-mode' is in Emacs 23 or later only."
589 :group 'org
590 :type '(choice
591 (const :tag "Never" nil)
592 (const :tag "When outside special context" t)
593 (const :tag "Everywhere except timestamps" always)))
595 (defcustom org-loop-over-headlines-in-active-region nil
596 "Shall some commands act upon headlines in the active region?
598 When set to `t', some commands will be performed in all headlines
599 within the active region.
601 When set to `start-level', some commands will be performed in all
602 headlines within the active region, provided that these headlines
603 are of the same level than the first one.
605 When set to a string, those commands will be performed on the
606 matching headlines within the active region. Such string must be
607 a tags/property/todo match as it is used in the agenda tags view.
609 The list of commands is: `org-schedule', `org-deadline',
610 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
611 `org-archive-to-archive-sibling'. The archiving commands skip
612 already archived entries."
613 :type '(choice (const :tag "Don't loop" nil)
614 (const :tag "All headlines in active region" t)
615 (const :tag "In active region, headlines at the same level than the first one" start-level)
616 (string :tag "Tags/Property/Todo matcher"))
617 :version "24.1"
618 :group 'org-todo
619 :group 'org-archive)
621 (defgroup org-startup nil
622 "Options concerning startup of Org-mode."
623 :tag "Org Startup"
624 :group 'org)
626 (defcustom org-startup-folded t
627 "Non-nil means entering Org-mode will switch to OVERVIEW.
628 This can also be configured on a per-file basis by adding one of
629 the following lines anywhere in the buffer:
631 #+STARTUP: fold (or `overview', this is equivalent)
632 #+STARTUP: nofold (or `showall', this is equivalent)
633 #+STARTUP: content
634 #+STARTUP: showeverything
636 By default, this option is ignored when Org opens agenda files
637 for the first time. If you want the agenda to honor the startup
638 option, set `org-agenda-inhibit-startup' to nil."
639 :group 'org-startup
640 :type '(choice
641 (const :tag "nofold: show all" nil)
642 (const :tag "fold: overview" t)
643 (const :tag "content: all headlines" content)
644 (const :tag "show everything, even drawers" showeverything)))
646 (defcustom org-startup-truncated t
647 "Non-nil means entering Org-mode will set `truncate-lines'.
648 This is useful since some lines containing links can be very long and
649 uninteresting. Also tables look terrible when wrapped."
650 :group 'org-startup
651 :type 'boolean)
653 (defcustom org-startup-indented nil
654 "Non-nil means turn on `org-indent-mode' on startup.
655 This can also be configured on a per-file basis by adding one of
656 the following lines anywhere in the buffer:
658 #+STARTUP: indent
659 #+STARTUP: noindent"
660 :group 'org-structure
661 :type '(choice
662 (const :tag "Not" nil)
663 (const :tag "Globally (slow on startup in large files)" t)))
665 (defcustom org-use-sub-superscripts t
666 "Non-nil means interpret \"_\" and \"^\" for display.
668 If you want to control how Org exports those characters, see
669 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
670 used to be an alias for `org-export-with-sub-superscripts' in
671 Org <8.0, it is not anymore.
673 When this option is turned on, you can use TeX-like syntax for
674 sub- and superscripts within the buffer. Several characters after
675 \"_\" or \"^\" will be considered as a single item - so grouping
676 with {} is normally not needed. For example, the following things
677 will be parsed as single sub- or superscripts:
679 10^24 or 10^tau several digits will be considered 1 item.
680 10^-12 or 10^-tau a leading sign with digits or a word
681 x^2-y^3 will be read as x^2 - y^3, because items are
682 terminated by almost any nonword/nondigit char.
683 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
685 Still, ambiguity is possible. So when in doubt, use {} to enclose
686 the sub/superscript. If you set this variable to the symbol `{}',
687 the braces are *required* in order to trigger interpretations as
688 sub/superscript. This can be helpful in documents that need \"_\"
689 frequently in plain text."
690 :group 'org-startup
691 :version "24.4"
692 :package-version '(Org . "8.0")
693 :type '(choice
694 (const :tag "Always interpret" t)
695 (const :tag "Only with braces" {})
696 (const :tag "Never interpret" nil)))
698 (defcustom org-startup-with-beamer-mode nil
699 "Non-nil means turn on `org-beamer-mode' on startup.
700 This can also be configured on a per-file basis by adding one of
701 the following lines anywhere in the buffer:
703 #+STARTUP: beamer"
704 :group 'org-startup
705 :version "24.1"
706 :type 'boolean)
708 (defcustom org-startup-align-all-tables nil
709 "Non-nil means align all tables when visiting a file.
710 This is useful when the column width in tables is forced with <N> cookies
711 in table fields. Such tables will look correct only after the first re-align.
712 This can also be configured on a per-file basis by adding one of
713 the following lines anywhere in the buffer:
714 #+STARTUP: align
715 #+STARTUP: noalign"
716 :group 'org-startup
717 :type 'boolean)
719 (defcustom org-startup-with-inline-images nil
720 "Non-nil means show inline images when loading a new Org file.
721 This can also be configured on a per-file basis by adding one of
722 the following lines anywhere in the buffer:
723 #+STARTUP: inlineimages
724 #+STARTUP: noinlineimages"
725 :group 'org-startup
726 :version "24.1"
727 :type 'boolean)
729 (defcustom org-startup-with-latex-preview nil
730 "Non-nil means preview LaTeX fragments when loading a new Org file.
732 This can also be configured on a per-file basis by adding one of
733 the following lines anywhere in the buffer:
734 #+STARTUP: latexpreview
735 #+STARTUP: nolatexpreview"
736 :group 'org-startup
737 :version "24.4"
738 :package-version '(Org . "8.0")
739 :type 'boolean)
741 (defcustom org-insert-mode-line-in-empty-file nil
742 "Non-nil means insert the first line setting Org-mode in empty files.
743 When the function `org-mode' is called interactively in an empty file, this
744 normally means that the file name does not automatically trigger Org-mode.
745 To ensure that the file will always be in Org-mode in the future, a
746 line enforcing Org-mode will be inserted into the buffer, if this option
747 has been set."
748 :group 'org-startup
749 :type 'boolean)
751 (defcustom org-replace-disputed-keys nil
752 "Non-nil means use alternative key bindings for some keys.
753 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
754 These keys are also used by other packages like shift-selection-mode'
755 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
756 If you want to use Org-mode together with one of these other modes,
757 or more generally if you would like to move some Org-mode commands to
758 other keys, set this variable and configure the keys with the variable
759 `org-disputed-keys'.
761 This option is only relevant at load-time of Org-mode, and must be set
762 *before* org.el is loaded. Changing it requires a restart of Emacs to
763 become effective."
764 :group 'org-startup
765 :type 'boolean)
767 (defcustom org-use-extra-keys nil
768 "Non-nil means use extra key sequence definitions for certain commands.
769 This happens automatically if you run XEmacs or if `window-system'
770 is nil. This variable lets you do the same manually. You must
771 set it before loading org.
773 Example: on Carbon Emacs 22 running graphically, with an external
774 keyboard on a Powerbook, the default way of setting M-left might
775 not work for either Alt or ESC. Setting this variable will make
776 it work for ESC."
777 :group 'org-startup
778 :type 'boolean)
780 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
782 (defcustom org-disputed-keys
783 '(([(shift up)] . [(meta p)])
784 ([(shift down)] . [(meta n)])
785 ([(shift left)] . [(meta -)])
786 ([(shift right)] . [(meta +)])
787 ([(control shift right)] . [(meta shift +)])
788 ([(control shift left)] . [(meta shift -)]))
789 "Keys for which Org-mode and other modes compete.
790 This is an alist, cars are the default keys, second element specifies
791 the alternative to use when `org-replace-disputed-keys' is t.
793 Keys can be specified in any syntax supported by `define-key'.
794 The value of this option takes effect only at Org-mode's startup,
795 therefore you'll have to restart Emacs to apply it after changing."
796 :group 'org-startup
797 :type 'alist)
799 (defun org-key (key)
800 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
801 Or return the original if not disputed.
802 Also apply the translations defined in `org-xemacs-key-equivalents'."
803 (when org-replace-disputed-keys
804 (let* ((nkey (key-description key))
805 (x (org-find-if (lambda (x)
806 (equal (key-description (car x)) nkey))
807 org-disputed-keys)))
808 (setq key (if x (cdr x) key))))
809 (when (featurep 'xemacs)
810 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
811 key)
813 (defun org-find-if (predicate seq)
814 (catch 'exit
815 (while seq
816 (if (funcall predicate (car seq))
817 (throw 'exit (car seq))
818 (pop seq)))))
820 (defun org-defkey (keymap key def)
821 "Define a key, possibly translated, as returned by `org-key'."
822 (define-key keymap (org-key key) def))
824 (defcustom org-ellipsis nil
825 "The ellipsis to use in the Org-mode outline.
826 When nil, just use the standard three dots.
827 When a string, use that string instead.
828 When a face, use the standard 3 dots, but with the specified face.
829 The change affects only Org-mode (which will then use its own display table).
830 Changing this requires executing `M-x org-mode RET' in a buffer to become
831 effective."
832 :group 'org-startup
833 :type '(choice (const :tag "Default" nil)
834 (face :tag "Face" :value org-warning)
835 (string :tag "String" :value "...#")))
837 (defvar org-display-table nil
838 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
840 (defgroup org-keywords nil
841 "Keywords in Org-mode."
842 :tag "Org Keywords"
843 :group 'org)
845 (defcustom org-deadline-string "DEADLINE:"
846 "String to mark deadline entries.
847 A deadline is this string, followed by a time stamp. Should be a word,
848 terminated by a colon. You can insert a schedule keyword and
849 a timestamp with \\[org-deadline].
850 Changes become only effective after restarting Emacs."
851 :group 'org-keywords
852 :type 'string)
854 (defcustom org-scheduled-string "SCHEDULED:"
855 "String to mark scheduled TODO entries.
856 A schedule is this string, followed by a time stamp. Should be a word,
857 terminated by a colon. You can insert a schedule keyword and
858 a timestamp with \\[org-schedule].
859 Changes become only effective after restarting Emacs."
860 :group 'org-keywords
861 :type 'string)
863 (defcustom org-closed-string "CLOSED:"
864 "String used as the prefix for timestamps logging closing a TODO entry."
865 :group 'org-keywords
866 :type 'string)
868 (defcustom org-clock-string "CLOCK:"
869 "String used as prefix for timestamps clocking work hours on an item."
870 :group 'org-keywords
871 :type 'string)
873 (defcustom org-closed-keep-when-no-todo nil
874 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
875 :group 'org-todo
876 :group 'org-keywords
877 :version "24.4"
878 :package-version '(Org . "8.0")
879 :type 'boolean)
881 (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
882 org-scheduled-string "\\|"
883 org-deadline-string "\\|"
884 org-closed-string "\\|"
885 org-clock-string "\\)")
886 "Matches a line with planning or clock info.")
888 (defcustom org-comment-string "COMMENT"
889 "Entries starting with this keyword will never be exported.
890 An entry can be toggled between COMMENT and normal with
891 \\[org-toggle-comment].
892 Changes become only effective after restarting Emacs."
893 :group 'org-keywords
894 :type 'string)
896 (defcustom org-quote-string "QUOTE"
897 "Entries starting with this keyword will be exported in fixed-width font.
898 Quoting applies only to the text in the entry following the headline, and does
899 not extend beyond the next headline, even if that is lower level.
900 An entry can be toggled between QUOTE and normal with
901 \\[org-toggle-fixed-width-section]."
902 :group 'org-keywords
903 :type 'string)
905 (defconst org-repeat-re
906 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
907 "Regular expression for specifying repeated events.
908 After a match, group 1 contains the repeat expression.")
910 (defgroup org-structure nil
911 "Options concerning the general structure of Org-mode files."
912 :tag "Org Structure"
913 :group 'org)
915 (defgroup org-reveal-location nil
916 "Options about how to make context of a location visible."
917 :tag "Org Reveal Location"
918 :group 'org-structure)
920 (defconst org-context-choice
921 '(choice
922 (const :tag "Always" t)
923 (const :tag "Never" nil)
924 (repeat :greedy t :tag "Individual contexts"
925 (cons
926 (choice :tag "Context"
927 (const agenda)
928 (const org-goto)
929 (const occur-tree)
930 (const tags-tree)
931 (const link-search)
932 (const mark-goto)
933 (const bookmark-jump)
934 (const isearch)
935 (const default))
936 (boolean))))
937 "Contexts for the reveal options.")
939 (defcustom org-show-hierarchy-above '((default . t))
940 "Non-nil means show full hierarchy when revealing a location.
941 Org-mode often shows locations in an org-mode file which might have
942 been invisible before. When this is set, the hierarchy of headings
943 above the exposed location is shown.
944 Turning this off for example for sparse trees makes them very compact.
945 Instead of t, this can also be an alist specifying this option for different
946 contexts. Valid contexts are
947 agenda when exposing an entry from the agenda
948 org-goto when using the command `org-goto' on key C-c C-j
949 occur-tree when using the command `org-occur' on key C-c /
950 tags-tree when constructing a sparse tree based on tags matches
951 link-search when exposing search matches associated with a link
952 mark-goto when exposing the jump goal of a mark
953 bookmark-jump when exposing a bookmark location
954 isearch when exiting from an incremental search
955 default default for all contexts not set explicitly"
956 :group 'org-reveal-location
957 :type org-context-choice)
959 (defcustom org-show-following-heading '((default . nil))
960 "Non-nil means show following heading when revealing a location.
961 Org-mode often shows locations in an org-mode file which might have
962 been invisible before. When this is set, the heading following the
963 match is shown.
964 Turning this off for example for sparse trees makes them very compact,
965 but makes it harder to edit the location of the match. In such a case,
966 use the command \\[org-reveal] to show more context.
967 Instead of t, this can also be an alist specifying this option for different
968 contexts. See `org-show-hierarchy-above' for valid contexts."
969 :group 'org-reveal-location
970 :type org-context-choice)
972 (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
973 "Non-nil means show all sibling heading when revealing a location.
974 Org-mode often shows locations in an org-mode file which might have
975 been invisible before. When this is set, the sibling of the current entry
976 heading are all made visible. If `org-show-hierarchy-above' is t,
977 the same happens on each level of the hierarchy above the current entry.
979 By default this is on for the isearch context, off for all other contexts.
980 Turning this off for example for sparse trees makes them very compact,
981 but makes it harder to edit the location of the match. In such a case,
982 use the command \\[org-reveal] to show more context.
983 Instead of t, this can also be an alist specifying this option for different
984 contexts. See `org-show-hierarchy-above' for valid contexts."
985 :group 'org-reveal-location
986 :type org-context-choice
987 :version "24.4"
988 :package-version '(Org . "8.0"))
990 (defcustom org-show-entry-below '((default . nil))
991 "Non-nil means show the entry below a headline when revealing a location.
992 Org-mode often shows locations in an org-mode file which might have
993 been invisible before. When this is set, the text below the headline that is
994 exposed is also shown.
996 By default this is off for all contexts.
997 Instead of t, this can also be an alist specifying this option for different
998 contexts. See `org-show-hierarchy-above' for valid contexts."
999 :group 'org-reveal-location
1000 :type org-context-choice)
1002 (defcustom org-indirect-buffer-display 'other-window
1003 "How should indirect tree buffers be displayed?
1004 This applies to indirect buffers created with the commands
1005 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1006 Valid values are:
1007 current-window Display in the current window
1008 other-window Just display in another window.
1009 dedicated-frame Create one new frame, and re-use it each time.
1010 new-frame Make a new frame each time. Note that in this case
1011 previously-made indirect buffers are kept, and you need to
1012 kill these buffers yourself."
1013 :group 'org-structure
1014 :group 'org-agenda-windows
1015 :type '(choice
1016 (const :tag "In current window" current-window)
1017 (const :tag "In current frame, other window" other-window)
1018 (const :tag "Each time a new frame" new-frame)
1019 (const :tag "One dedicated frame" dedicated-frame)))
1021 (defcustom org-use-speed-commands nil
1022 "Non-nil means activate single letter commands at beginning of a headline.
1023 This may also be a function to test for appropriate locations where speed
1024 commands should be active."
1025 :group 'org-structure
1026 :type '(choice
1027 (const :tag "Never" nil)
1028 (const :tag "At beginning of headline stars" t)
1029 (function)))
1031 (defcustom org-speed-commands-user nil
1032 "Alist of additional speed commands.
1033 This list will be checked before `org-speed-commands-default'
1034 when the variable `org-use-speed-commands' is non-nil
1035 and when the cursor is at the beginning of a headline.
1036 The car if each entry is a string with a single letter, which must
1037 be assigned to `self-insert-command' in the global map.
1038 The cdr is either a command to be called interactively, a function
1039 to be called, or a form to be evaluated.
1040 An entry that is just a list with a single string will be interpreted
1041 as a descriptive headline that will be added when listing the speed
1042 commands in the Help buffer using the `?' speed command."
1043 :group 'org-structure
1044 :type '(repeat :value ("k" . ignore)
1045 (choice :value ("k" . ignore)
1046 (list :tag "Descriptive Headline" (string :tag "Headline"))
1047 (cons :tag "Letter and Command"
1048 (string :tag "Command letter")
1049 (choice
1050 (function)
1051 (sexp))))))
1053 (defcustom org-bookmark-names-plist
1054 '(:last-capture "org-capture-last-stored"
1055 :last-refile "org-refile-last-stored"
1056 :last-capture-marker "org-capture-last-stored-marker")
1057 "Names for bookmarks automatically set by some Org commands.
1058 This can provide strings as names for a number of bookmarks Org sets
1059 automatically. The following keys are currently implemented:
1060 :last-capture
1061 :last-capture-marker
1062 :last-refile
1063 When a key does not show up in the property list, the corresponding bookmark
1064 is not set."
1065 :group 'org-structure
1066 :type 'plist)
1068 (defgroup org-cycle nil
1069 "Options concerning visibility cycling in Org-mode."
1070 :tag "Org Cycle"
1071 :group 'org-structure)
1073 (defcustom org-cycle-skip-children-state-if-no-children t
1074 "Non-nil means skip CHILDREN state in entries that don't have any."
1075 :group 'org-cycle
1076 :type 'boolean)
1078 (defcustom org-cycle-max-level nil
1079 "Maximum level which should still be subject to visibility cycling.
1080 Levels higher than this will, for cycling, be treated as text, not a headline.
1081 When `org-odd-levels-only' is set, a value of N in this variable actually
1082 means 2N-1 stars as the limiting headline.
1083 When nil, cycle all levels.
1084 Note that the limiting level of cycling is also influenced by
1085 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1086 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1087 than its value."
1088 :group 'org-cycle
1089 :type '(choice
1090 (const :tag "No limit" nil)
1091 (integer :tag "Maximum level")))
1093 (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
1094 "Names of drawers. Drawers are not opened by cycling on the headline above.
1095 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1096 this:
1097 :DRAWERNAME:
1098 .....
1099 :END:
1100 The drawer \"PROPERTIES\" is special for capturing properties through
1101 the property API.
1103 Drawers can be defined on the per-file basis with a line like:
1105 #+DRAWERS: HIDDEN STATE PROPERTIES"
1106 :group 'org-structure
1107 :group 'org-cycle
1108 :type '(repeat (string :tag "Drawer Name")))
1110 (defcustom org-hide-block-startup nil
1111 "Non-nil means entering Org-mode will fold all blocks.
1112 This can also be set in on a per-file basis with
1114 #+STARTUP: hideblocks
1115 #+STARTUP: showblocks"
1116 :group 'org-startup
1117 :group 'org-cycle
1118 :type 'boolean)
1120 (defcustom org-cycle-global-at-bob nil
1121 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1122 This makes it possible to do global cycling without having to use S-TAB or
1123 \\[universal-argument] TAB. For this special case to work, the first line
1124 of the buffer must not be a headline -- it may be empty or some other text.
1125 When used in this way, `org-cycle-hook' is disabled temporarily to make
1126 sure the cursor stays at the beginning of the buffer. When this option is
1127 nil, don't do anything special at the beginning of the buffer."
1128 :group 'org-cycle
1129 :type 'boolean)
1131 (defcustom org-cycle-level-after-item/entry-creation t
1132 "Non-nil means cycle entry level or item indentation in new empty entries.
1134 When the cursor is at the end of an empty headline, i.e., with only stars
1135 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1136 and then all possible ancestor states, before returning to the original state.
1137 This makes data entry extremely fast: M-RET to create a new headline,
1138 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1140 When the cursor is at the end of an empty plain list item, one TAB will
1141 make it a subitem, two or more tabs will back up to make this an item
1142 higher up in the item hierarchy."
1143 :group 'org-cycle
1144 :type 'boolean)
1146 (defcustom org-cycle-emulate-tab t
1147 "Where should `org-cycle' emulate TAB.
1148 nil Never
1149 white Only in completely white lines
1150 whitestart Only at the beginning of lines, before the first non-white char
1151 t Everywhere except in headlines
1152 exc-hl-bol Everywhere except at the start of a headline
1153 If TAB is used in a place where it does not emulate TAB, the current subtree
1154 visibility is cycled."
1155 :group 'org-cycle
1156 :type '(choice (const :tag "Never" nil)
1157 (const :tag "Only in completely white lines" white)
1158 (const :tag "Before first char in a line" whitestart)
1159 (const :tag "Everywhere except in headlines" t)
1160 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1162 (defcustom org-cycle-separator-lines 2
1163 "Number of empty lines needed to keep an empty line between collapsed trees.
1164 If you leave an empty line between the end of a subtree and the following
1165 headline, this empty line is hidden when the subtree is folded.
1166 Org-mode will leave (exactly) one empty line visible if the number of
1167 empty lines is equal or larger to the number given in this variable.
1168 So the default 2 means at least 2 empty lines after the end of a subtree
1169 are needed to produce free space between a collapsed subtree and the
1170 following headline.
1172 If the number is negative, and the number of empty lines is at least -N,
1173 all empty lines are shown.
1175 Special case: when 0, never leave empty lines in collapsed view."
1176 :group 'org-cycle
1177 :type 'integer)
1178 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1180 (defcustom org-pre-cycle-hook nil
1181 "Hook that is run before visibility cycling is happening.
1182 The function(s) in this hook must accept a single argument which indicates
1183 the new state that will be set right after running this hook. The
1184 argument is a symbol. Before a global state change, it can have the values
1185 `overview', `content', or `all'. Before a local state change, it can have
1186 the values `folded', `children', or `subtree'."
1187 :group 'org-cycle
1188 :type 'hook)
1190 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1191 org-cycle-hide-drawers
1192 org-cycle-hide-inline-tasks
1193 org-cycle-show-empty-lines
1194 org-optimize-window-after-visibility-change)
1195 "Hook that is run after `org-cycle' has changed the buffer visibility.
1196 The function(s) in this hook must accept a single argument which indicates
1197 the new state that was set by the most recent `org-cycle' command. The
1198 argument is a symbol. After a global state change, it can have the values
1199 `overview', `contents', or `all'. After a local state change, it can have
1200 the values `folded', `children', or `subtree'."
1201 :group 'org-cycle
1202 :type 'hook)
1204 (defgroup org-edit-structure nil
1205 "Options concerning structure editing in Org-mode."
1206 :tag "Org Edit Structure"
1207 :group 'org-structure)
1209 (defcustom org-odd-levels-only nil
1210 "Non-nil means skip even levels and only use odd levels for the outline.
1211 This has the effect that two stars are being added/taken away in
1212 promotion/demotion commands. It also influences how levels are
1213 handled by the exporters.
1214 Changing it requires restart of `font-lock-mode' to become effective
1215 for fontification also in regions already fontified.
1216 You may also set this on a per-file basis by adding one of the following
1217 lines to the buffer:
1219 #+STARTUP: odd
1220 #+STARTUP: oddeven"
1221 :group 'org-edit-structure
1222 :group 'org-appearance
1223 :type 'boolean)
1225 (defcustom org-adapt-indentation t
1226 "Non-nil means adapt indentation to outline node level.
1228 When this variable is set, Org assumes that you write outlines by
1229 indenting text in each node to align with the headline (after the stars).
1230 The following issues are influenced by this variable:
1232 - When this is set and the *entire* text in an entry is indented, the
1233 indentation is increased by one space in a demotion command, and
1234 decreased by one in a promotion command. If any line in the entry
1235 body starts with text at column 0, indentation is not changed at all.
1237 - Property drawers and planning information is inserted indented when
1238 this variable s set. When nil, they will not be indented.
1240 - TAB indents a line relative to context. The lines below a headline
1241 will be indented when this variable is set.
1243 Note that this is all about true indentation, by adding and removing
1244 space characters. See also `org-indent.el' which does level-dependent
1245 indentation in a virtual way, i.e. at display time in Emacs."
1246 :group 'org-edit-structure
1247 :type 'boolean)
1249 (defcustom org-special-ctrl-a/e nil
1250 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1252 When t, `C-a' will bring back the cursor to the beginning of the
1253 headline text, i.e. after the stars and after a possible TODO
1254 keyword. In an item, this will be the position after bullet and
1255 check-box, if any. When the cursor is already at that position,
1256 another `C-a' will bring it to the beginning of the line.
1258 `C-e' will jump to the end of the headline, ignoring the presence
1259 of tags in the headline. A second `C-e' will then jump to the
1260 true end of the line, after any tags. This also means that, when
1261 this variable is non-nil, `C-e' also will never jump beyond the
1262 end of the heading of a folded section, i.e. not after the
1263 ellipses.
1265 When set to the symbol `reversed', the first `C-a' or `C-e' works
1266 normally, going to the true line boundary first. Only a directly
1267 following, identical keypress will bring the cursor to the
1268 special positions.
1270 This may also be a cons cell where the behavior for `C-a' and
1271 `C-e' is set separately."
1272 :group 'org-edit-structure
1273 :type '(choice
1274 (const :tag "off" nil)
1275 (const :tag "on: after stars/bullet and before tags first" t)
1276 (const :tag "reversed: true line boundary first" reversed)
1277 (cons :tag "Set C-a and C-e separately"
1278 (choice :tag "Special C-a"
1279 (const :tag "off" nil)
1280 (const :tag "on: after stars/bullet first" t)
1281 (const :tag "reversed: before stars/bullet first" reversed))
1282 (choice :tag "Special C-e"
1283 (const :tag "off" nil)
1284 (const :tag "on: before tags first" t)
1285 (const :tag "reversed: after tags first" reversed)))))
1286 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1288 (defcustom org-special-ctrl-k nil
1289 "Non-nil means `C-k' will behave specially in headlines.
1290 When nil, `C-k' will call the default `kill-line' command.
1291 When t, the following will happen while the cursor is in the headline:
1293 - When the cursor is at the beginning of a headline, kill the entire
1294 line and possible the folded subtree below the line.
1295 - When in the middle of the headline text, kill the headline up to the tags.
1296 - When after the headline text, kill the tags."
1297 :group 'org-edit-structure
1298 :type 'boolean)
1300 (defcustom org-ctrl-k-protect-subtree nil
1301 "Non-nil means, do not delete a hidden subtree with C-k.
1302 When set to the symbol `error', simply throw an error when C-k is
1303 used to kill (part-of) a headline that has hidden text behind it.
1304 Any other non-nil value will result in a query to the user, if it is
1305 OK to kill that hidden subtree. When nil, kill without remorse."
1306 :group 'org-edit-structure
1307 :version "24.1"
1308 :type '(choice
1309 (const :tag "Do not protect hidden subtrees" nil)
1310 (const :tag "Protect hidden subtrees with a security query" t)
1311 (const :tag "Never kill a hidden subtree with C-k" error)))
1313 (defcustom org-special-ctrl-o t
1314 "Non-nil means, make `C-o' insert a row in tables."
1315 :group 'org-edit-structure
1316 :type 'boolean)
1318 (defcustom org-catch-invisible-edits nil
1319 "Check if in invisible region before inserting or deleting a character.
1320 Valid values are:
1322 nil Do not check, so just do invisible edits.
1323 error Throw an error and do nothing.
1324 show Make point visible, and do the requested edit.
1325 show-and-error Make point visible, then throw an error and abort the edit.
1326 smart Make point visible, and do insertion/deletion if it is
1327 adjacent to visible text and the change feels predictable.
1328 Never delete a previously invisible character or add in the
1329 middle or right after an invisible region. Basically, this
1330 allows insertion and backward-delete right before ellipses.
1331 FIXME: maybe in this case we should not even show?"
1332 :group 'org-edit-structure
1333 :version "24.1"
1334 :type '(choice
1335 (const :tag "Do not check" nil)
1336 (const :tag "Throw error when trying to edit" error)
1337 (const :tag "Unhide, but do not do the edit" show-and-error)
1338 (const :tag "Show invisible part and do the edit" show)
1339 (const :tag "Be smart and do the right thing" smart)))
1341 (defcustom org-yank-folded-subtrees t
1342 "Non-nil means when yanking subtrees, fold them.
1343 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1344 it starts with a heading and all other headings in it are either children
1345 or siblings, then fold all the subtrees. However, do this only if no
1346 text after the yank would be swallowed into a folded tree by this action."
1347 :group 'org-edit-structure
1348 :type 'boolean)
1350 (defcustom org-yank-adjusted-subtrees nil
1351 "Non-nil means when yanking subtrees, adjust the level.
1352 With this setting, `org-paste-subtree' is used to insert the subtree, see
1353 this function for details."
1354 :group 'org-edit-structure
1355 :type 'boolean)
1357 (defcustom org-M-RET-may-split-line '((default . t))
1358 "Non-nil means M-RET will split the line at the cursor position.
1359 When nil, it will go to the end of the line before making a
1360 new line.
1361 You may also set this option in a different way for different
1362 contexts. Valid contexts are:
1364 headline when creating a new headline
1365 item when creating a new item
1366 table in a table field
1367 default the value to be used for all contexts not explicitly
1368 customized"
1369 :group 'org-structure
1370 :group 'org-table
1371 :type '(choice
1372 (const :tag "Always" t)
1373 (const :tag "Never" nil)
1374 (repeat :greedy t :tag "Individual contexts"
1375 (cons
1376 (choice :tag "Context"
1377 (const headline)
1378 (const item)
1379 (const table)
1380 (const default))
1381 (boolean)))))
1384 (defcustom org-insert-heading-respect-content nil
1385 "Non-nil means insert new headings after the current subtree.
1386 When nil, the new heading is created directly after the current line.
1387 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1388 this variable on for the duration of the command."
1389 :group 'org-structure
1390 :type 'boolean)
1392 (defcustom org-blank-before-new-entry '((heading . auto)
1393 (plain-list-item . auto))
1394 "Should `org-insert-heading' leave a blank line before new heading/item?
1395 The value is an alist, with `heading' and `plain-list-item' as CAR,
1396 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1397 which case Org will look at the surrounding headings/items and try to
1398 make an intelligent decision whether to insert a blank line or not.
1400 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1401 the setting here is ignored and no empty line is inserted to avoid breaking
1402 the list structure."
1403 :group 'org-edit-structure
1404 :type '(list
1405 (cons (const heading)
1406 (choice (const :tag "Never" nil)
1407 (const :tag "Always" t)
1408 (const :tag "Auto" auto)))
1409 (cons (const plain-list-item)
1410 (choice (const :tag "Never" nil)
1411 (const :tag "Always" t)
1412 (const :tag "Auto" auto)))))
1414 (defcustom org-insert-heading-hook nil
1415 "Hook being run after inserting a new heading."
1416 :group 'org-edit-structure
1417 :type 'hook)
1419 (defcustom org-enable-fixed-width-editor t
1420 "Non-nil means lines starting with \":\" are treated as fixed-width.
1421 This currently only means they are never auto-wrapped.
1422 When nil, such lines will be treated like ordinary lines.
1423 See also the QUOTE keyword."
1424 :group 'org-edit-structure
1425 :type 'boolean)
1427 (defcustom org-goto-auto-isearch t
1428 "Non-nil means typing characters in `org-goto' starts incremental search.
1429 When nil, you can use these keybindings to navigate the buffer:
1431 q Quit the org-goto interface
1432 n Go to the next visible heading
1433 p Go to the previous visible heading
1434 f Go one heading forward on same level
1435 b Go one heading backward on same level
1436 u Go one heading up"
1437 :group 'org-edit-structure
1438 :type 'boolean)
1440 (defgroup org-sparse-trees nil
1441 "Options concerning sparse trees in Org-mode."
1442 :tag "Org Sparse Trees"
1443 :group 'org-structure)
1445 (defcustom org-highlight-sparse-tree-matches t
1446 "Non-nil means highlight all matches that define a sparse tree.
1447 The highlights will automatically disappear the next time the buffer is
1448 changed by an edit command."
1449 :group 'org-sparse-trees
1450 :type 'boolean)
1452 (defcustom org-remove-highlights-with-change t
1453 "Non-nil means any change to the buffer will remove temporary highlights.
1454 Such highlights are created by `org-occur' and `org-clock-display'.
1455 When nil, `C-c C-c needs to be used to get rid of the highlights.
1456 The highlights created by `org-preview-latex-fragment' always need
1457 `C-c C-c' to be removed."
1458 :group 'org-sparse-trees
1459 :group 'org-time
1460 :type 'boolean)
1463 (defcustom org-occur-hook '(org-first-headline-recenter)
1464 "Hook that is run after `org-occur' has constructed a sparse tree.
1465 This can be used to recenter the window to show as much of the structure
1466 as possible."
1467 :group 'org-sparse-trees
1468 :type 'hook)
1470 (defgroup org-imenu-and-speedbar nil
1471 "Options concerning imenu and speedbar in Org-mode."
1472 :tag "Org Imenu and Speedbar"
1473 :group 'org-structure)
1475 (defcustom org-imenu-depth 2
1476 "The maximum level for Imenu access to Org-mode headlines.
1477 This also applied for speedbar access."
1478 :group 'org-imenu-and-speedbar
1479 :type 'integer)
1481 (defgroup org-table nil
1482 "Options concerning tables in Org-mode."
1483 :tag "Org Table"
1484 :group 'org)
1486 (defcustom org-enable-table-editor 'optimized
1487 "Non-nil means lines starting with \"|\" are handled by the table editor.
1488 When nil, such lines will be treated like ordinary lines.
1490 When equal to the symbol `optimized', the table editor will be optimized to
1491 do the following:
1492 - Automatic overwrite mode in front of whitespace in table fields.
1493 This makes the structure of the table stay in tact as long as the edited
1494 field does not exceed the column width.
1495 - Minimize the number of realigns. Normally, the table is aligned each time
1496 TAB or RET are pressed to move to another field. With optimization this
1497 happens only if changes to a field might have changed the column width.
1498 Optimization requires replacing the functions `self-insert-command',
1499 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1500 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1501 very good at guessing when a re-align will be necessary, but you can always
1502 force one with \\[org-ctrl-c-ctrl-c].
1504 If you would like to use the optimized version in Org-mode, but the
1505 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1507 This variable can be used to turn on and off the table editor during a session,
1508 but in order to toggle optimization, a restart is required.
1510 See also the variable `org-table-auto-blank-field'."
1511 :group 'org-table
1512 :type '(choice
1513 (const :tag "off" nil)
1514 (const :tag "on" t)
1515 (const :tag "on, optimized" optimized)))
1517 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1518 (version<= emacs-version "24.1"))
1519 "Non-nil means cluster self-insert commands for undo when possible.
1520 If this is set, then, like in the Emacs command loop, 20 consecutive
1521 characters will be undone together.
1522 This is configurable, because there is some impact on typing performance."
1523 :group 'org-table
1524 :type 'boolean)
1526 (defcustom org-table-tab-recognizes-table.el t
1527 "Non-nil means TAB will automatically notice a table.el table.
1528 When it sees such a table, it moves point into it and - if necessary -
1529 calls `table-recognize-table'."
1530 :group 'org-table-editing
1531 :type 'boolean)
1533 (defgroup org-link nil
1534 "Options concerning links in Org-mode."
1535 :tag "Org Link"
1536 :group 'org)
1538 (defvar org-link-abbrev-alist-local nil
1539 "Buffer-local version of `org-link-abbrev-alist', which see.
1540 The value of this is taken from the #+LINK lines.")
1541 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1543 (defcustom org-link-abbrev-alist nil
1544 "Alist of link abbreviations.
1545 The car of each element is a string, to be replaced at the start of a link.
1546 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1547 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1549 [[linkkey:tag][description]]
1551 The 'linkkey' must be a word word, starting with a letter, followed
1552 by letters, numbers, '-' or '_'.
1554 If REPLACE is a string, the tag will simply be appended to create the link.
1555 If the string contains \"%s\", the tag will be inserted there. If the string
1556 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1557 at that point (see the function `url-hexify-string'). If the string contains
1558 the specifier \"%(my-function)\", then the custom function `my-function' will
1559 be invoked: this function takes the tag as its only argument and must return
1560 a string.
1562 REPLACE may also be a function that will be called with the tag as the
1563 only argument to create the link, which should be returned as a string.
1565 See the manual for examples."
1566 :group 'org-link
1567 :type '(repeat
1568 (cons
1569 (string :tag "Protocol")
1570 (choice
1571 (string :tag "Format")
1572 (function)))))
1574 (defcustom org-descriptive-links t
1575 "Non-nil means Org will display descriptive links.
1576 E.g. [[http://orgmode.org][Org website]] will be displayed as
1577 \"Org Website\", hiding the link itself and just displaying its
1578 description. When set to `nil', Org will display the full links
1579 literally.
1581 You can interactively set the value of this variable by calling
1582 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1583 :group 'org-link
1584 :type 'boolean)
1586 (defcustom org-link-file-path-type 'adaptive
1587 "How the path name in file links should be stored.
1588 Valid values are:
1590 relative Relative to the current directory, i.e. the directory of the file
1591 into which the link is being inserted.
1592 absolute Absolute path, if possible with ~ for home directory.
1593 noabbrev Absolute path, no abbreviation of home directory.
1594 adaptive Use relative path for files in the current directory and sub-
1595 directories of it. For other files, use an absolute path."
1596 :group 'org-link
1597 :type '(choice
1598 (const relative)
1599 (const absolute)
1600 (const noabbrev)
1601 (const adaptive)))
1603 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1604 "Types of links that should be activated in Org-mode files.
1605 This is a list of symbols, each leading to the activation of a certain link
1606 type. In principle, it does not hurt to turn on most link types - there may
1607 be a small gain when turning off unused link types. The types are:
1609 bracket The recommended [[link][description]] or [[link]] links with hiding.
1610 angle Links in angular brackets that may contain whitespace like
1611 <bbdb:Carsten Dominik>.
1612 plain Plain links in normal text, no whitespace, like http://google.com.
1613 radio Text that is matched by a radio target, see manual for details.
1614 tag Tag settings in a headline (link to tag search).
1615 date Time stamps (link to calendar).
1616 footnote Footnote labels.
1618 Changing this variable requires a restart of Emacs to become effective."
1619 :group 'org-link
1620 :type '(set :greedy t
1621 (const :tag "Double bracket links" bracket)
1622 (const :tag "Angular bracket links" angle)
1623 (const :tag "Plain text links" plain)
1624 (const :tag "Radio target matches" radio)
1625 (const :tag "Tags" tag)
1626 (const :tag "Timestamps" date)
1627 (const :tag "Footnotes" footnote)))
1629 (defcustom org-make-link-description-function nil
1630 "Function to use for generating link descriptions from links.
1631 When nil, the link location will be used. This function must take
1632 two parameters: the first one is the link, the second one is the
1633 description generated by `org-insert-link'. The function should
1634 return the description to use."
1635 :group 'org-link
1636 :type '(choice (const nil) (function)))
1638 (defgroup org-link-store nil
1639 "Options concerning storing links in Org-mode."
1640 :tag "Org Store Link"
1641 :group 'org-link)
1643 (defcustom org-url-hexify-p t
1644 "When non-nil, hexify URL when creating a link."
1645 :type 'boolean
1646 :version "24.3"
1647 :group 'org-link-store)
1649 (defcustom org-email-link-description-format "Email %c: %.30s"
1650 "Format of the description part of a link to an email or usenet message.
1651 The following %-escapes will be replaced by corresponding information:
1653 %F full \"From\" field
1654 %f name, taken from \"From\" field, address if no name
1655 %T full \"To\" field
1656 %t first name in \"To\" field, address if no name
1657 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1658 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1659 %s subject
1660 %d date
1661 %m message-id.
1663 You may use normal field width specification between the % and the letter.
1664 This is for example useful to limit the length of the subject.
1666 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1667 :group 'org-link-store
1668 :type 'string)
1670 (defcustom org-from-is-user-regexp
1671 (let (r1 r2)
1672 (when (and user-mail-address (not (string= user-mail-address "")))
1673 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1674 (when (and user-full-name (not (string= user-full-name "")))
1675 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1676 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1677 "Regexp matched against the \"From:\" header of an email or usenet message.
1678 It should match if the message is from the user him/herself."
1679 :group 'org-link-store
1680 :type 'regexp)
1682 (defcustom org-context-in-file-links t
1683 "Non-nil means file links from `org-store-link' contain context.
1684 A search string will be added to the file name with :: as separator and
1685 used to find the context when the link is activated by the command
1686 `org-open-at-point'. When this option is t, the entire active region
1687 will be placed in the search string of the file link. If set to a
1688 positive integer, only the first n lines of context will be stored.
1690 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1691 negates this setting for the duration of the command."
1692 :group 'org-link-store
1693 :type '(choice boolean integer))
1695 (defcustom org-keep-stored-link-after-insertion nil
1696 "Non-nil means keep link in list for entire session.
1698 The command `org-store-link' adds a link pointing to the current
1699 location to an internal list. These links accumulate during a session.
1700 The command `org-insert-link' can be used to insert links into any
1701 Org-mode file (offering completion for all stored links). When this
1702 option is nil, every link which has been inserted once using \\[org-insert-link]
1703 will be removed from the list, to make completing the unused links
1704 more efficient."
1705 :group 'org-link-store
1706 :type 'boolean)
1708 (defgroup org-link-follow nil
1709 "Options concerning following links in Org-mode."
1710 :tag "Org Follow Link"
1711 :group 'org-link)
1713 (defcustom org-link-translation-function nil
1714 "Function to translate links with different syntax to Org syntax.
1715 This can be used to translate links created for example by the Planner
1716 or emacs-wiki packages to Org syntax.
1717 The function must accept two parameters, a TYPE containing the link
1718 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1719 which is everything after the link protocol. It should return a cons
1720 with possibly modified values of type and path.
1721 Org contains a function for this, so if you set this variable to
1722 `org-translate-link-from-planner', you should be able follow many
1723 links created by planner."
1724 :group 'org-link-follow
1725 :type '(choice (const nil) (function)))
1727 (defcustom org-follow-link-hook nil
1728 "Hook that is run after a link has been followed."
1729 :group 'org-link-follow
1730 :type 'hook)
1732 (defcustom org-tab-follows-link nil
1733 "Non-nil means on links TAB will follow the link.
1734 Needs to be set before org.el is loaded.
1735 This really should not be used, it does not make sense, and the
1736 implementation is bad."
1737 :group 'org-link-follow
1738 :type 'boolean)
1740 (defcustom org-return-follows-link nil
1741 "Non-nil means on links RET will follow the link.
1742 In tables, the special behavior of RET has precedence."
1743 :group 'org-link-follow
1744 :type 'boolean)
1746 (defcustom org-mouse-1-follows-link
1747 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1748 "Non-nil means mouse-1 on a link will follow the link.
1749 A longer mouse click will still set point. Does not work on XEmacs.
1750 Needs to be set before org.el is loaded."
1751 :group 'org-link-follow
1752 :version "24.4"
1753 :package-version '(Org . "8.3")
1754 :type '(choice
1755 (const :tag "A double click follows the link" double)
1756 (const :tag "Unconditionally follow the link with mouse-1" t)
1757 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1759 (defcustom org-mark-ring-length 4
1760 "Number of different positions to be recorded in the ring.
1761 Changing this requires a restart of Emacs to work correctly."
1762 :group 'org-link-follow
1763 :type 'integer)
1765 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1766 "Non-nil means internal links in Org files must exactly match a headline.
1767 When nil, the link search tries to match a phrase with all words
1768 in the search text."
1769 :group 'org-link-follow
1770 :version "24.1"
1771 :type '(choice
1772 (const :tag "Use fuzzy text search" nil)
1773 (const :tag "Match only exact headline" t)
1774 (const :tag "Match exact headline or query to create it"
1775 query-to-create)))
1777 (defcustom org-link-frame-setup
1778 '((vm . vm-visit-folder-other-frame)
1779 (vm-imap . vm-visit-imap-folder-other-frame)
1780 (gnus . org-gnus-no-new-news)
1781 (file . find-file-other-window)
1782 (wl . wl-other-frame))
1783 "Setup the frame configuration for following links.
1784 When following a link with Emacs, it may often be useful to display
1785 this link in another window or frame. This variable can be used to
1786 set this up for the different types of links.
1787 For VM, use any of
1788 `vm-visit-folder'
1789 `vm-visit-folder-other-window'
1790 `vm-visit-folder-other-frame'
1791 For Gnus, use any of
1792 `gnus'
1793 `gnus-other-frame'
1794 `org-gnus-no-new-news'
1795 For FILE, use any of
1796 `find-file'
1797 `find-file-other-window'
1798 `find-file-other-frame'
1799 For Wanderlust use any of
1800 `wl'
1801 `wl-other-frame'
1802 For the calendar, use the variable `calendar-setup'.
1803 For BBDB, it is currently only possible to display the matches in
1804 another window."
1805 :group 'org-link-follow
1806 :type '(list
1807 (cons (const vm)
1808 (choice
1809 (const vm-visit-folder)
1810 (const vm-visit-folder-other-window)
1811 (const vm-visit-folder-other-frame)))
1812 (cons (const vm-imap)
1813 (choice
1814 (const vm-visit-imap-folder)
1815 (const vm-visit-imap-folder-other-window)
1816 (const vm-visit-imap-folder-other-frame)))
1817 (cons (const gnus)
1818 (choice
1819 (const gnus)
1820 (const gnus-other-frame)
1821 (const org-gnus-no-new-news)))
1822 (cons (const file)
1823 (choice
1824 (const find-file)
1825 (const find-file-other-window)
1826 (const find-file-other-frame)))
1827 (cons (const wl)
1828 (choice
1829 (const wl)
1830 (const wl-other-frame)))))
1832 (defcustom org-display-internal-link-with-indirect-buffer nil
1833 "Non-nil means use indirect buffer to display infile links.
1834 Activating internal links (from one location in a file to another location
1835 in the same file) normally just jumps to the location. When the link is
1836 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1837 is displayed in
1838 another window. When this option is set, the other window actually displays
1839 an indirect buffer clone of the current buffer, to avoid any visibility
1840 changes to the current buffer."
1841 :group 'org-link-follow
1842 :type 'boolean)
1844 (defcustom org-open-non-existing-files nil
1845 "Non-nil means `org-open-file' will open non-existing files.
1846 When nil, an error will be generated.
1847 This variable applies only to external applications because they
1848 might choke on non-existing files. If the link is to a file that
1849 will be opened in Emacs, the variable is ignored."
1850 :group 'org-link-follow
1851 :type 'boolean)
1853 (defcustom org-open-directory-means-index-dot-org nil
1854 "Non-nil means a link to a directory really means to index.org.
1855 When nil, following a directory link will run dired or open a finder/explorer
1856 window on that directory."
1857 :group 'org-link-follow
1858 :type 'boolean)
1860 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1861 "Function and arguments to call for following mailto links.
1862 This is a list with the first element being a Lisp function, and the
1863 remaining elements being arguments to the function. In string arguments,
1864 %a will be replaced by the address, and %s will be replaced by the subject
1865 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1866 :group 'org-link-follow
1867 :type '(choice
1868 (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1869 (const :tag "compose-mail" (compose-mail "%a" "%s"))
1870 (const :tag "message-mail" (message-mail "%a" "%s"))
1871 (cons :tag "other" (function) (repeat :tag "argument" sexp))))
1873 (defcustom org-confirm-shell-link-function 'yes-or-no-p
1874 "Non-nil means ask for confirmation before executing shell links.
1875 Shell links can be dangerous: just think about a link
1877 [[shell:rm -rf ~/*][Google Search]]
1879 This link would show up in your Org-mode document as \"Google Search\",
1880 but really it would remove your entire home directory.
1881 Therefore we advise against setting this variable to nil.
1882 Just change it to `y-or-n-p' if you want to confirm with a
1883 single keystroke rather than having to type \"yes\"."
1884 :group 'org-link-follow
1885 :type '(choice
1886 (const :tag "with yes-or-no (safer)" yes-or-no-p)
1887 (const :tag "with y-or-n (faster)" y-or-n-p)
1888 (const :tag "no confirmation (dangerous)" nil)))
1889 (put 'org-confirm-shell-link-function
1890 'safe-local-variable
1891 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1893 (defcustom org-confirm-shell-link-not-regexp ""
1894 "A regexp to skip confirmation for shell links."
1895 :group 'org-link-follow
1896 :version "24.1"
1897 :type 'regexp)
1899 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
1900 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1901 Elisp links can be dangerous: just think about a link
1903 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1905 This link would show up in your Org-mode document as \"Google Search\",
1906 but really it would remove your entire home directory.
1907 Therefore we advise against setting this variable to nil.
1908 Just change it to `y-or-n-p' if you want to confirm with a
1909 single keystroke rather than having to type \"yes\"."
1910 :group 'org-link-follow
1911 :type '(choice
1912 (const :tag "with yes-or-no (safer)" yes-or-no-p)
1913 (const :tag "with y-or-n (faster)" y-or-n-p)
1914 (const :tag "no confirmation (dangerous)" nil)))
1915 (put 'org-confirm-shell-link-function
1916 'safe-local-variable
1917 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1919 (defcustom org-confirm-elisp-link-not-regexp ""
1920 "A regexp to skip confirmation for Elisp links."
1921 :group 'org-link-follow
1922 :version "24.1"
1923 :type 'regexp)
1925 (defconst org-file-apps-defaults-gnu
1926 '((remote . emacs)
1927 (system . mailcap)
1928 (t . mailcap))
1929 "Default file applications on a UNIX or GNU/Linux system.
1930 See `org-file-apps'.")
1932 (defconst org-file-apps-defaults-macosx
1933 '((remote . emacs)
1934 (t . "open %s")
1935 (system . "open %s")
1936 ("ps.gz" . "gv %s")
1937 ("eps.gz" . "gv %s")
1938 ("dvi" . "xdvi %s")
1939 ("fig" . "xfig %s"))
1940 "Default file applications on a MacOS X system.
1941 The system \"open\" is known as a default, but we use X11 applications
1942 for some files for which the OS does not have a good default.
1943 See `org-file-apps'.")
1945 (defconst org-file-apps-defaults-windowsnt
1946 (list
1947 '(remote . emacs)
1948 (cons t
1949 (list (if (featurep 'xemacs)
1950 'mswindows-shell-execute
1951 'w32-shell-execute)
1952 "open" 'file))
1953 (cons 'system
1954 (list (if (featurep 'xemacs)
1955 'mswindows-shell-execute
1956 'w32-shell-execute)
1957 "open" 'file)))
1958 "Default file applications on a Windows NT system.
1959 The system \"open\" is used for most files.
1960 See `org-file-apps'.")
1962 (defcustom org-file-apps
1963 '((auto-mode . emacs)
1964 ("\\.mm\\'" . default)
1965 ("\\.x?html?\\'" . default)
1966 ("\\.pdf\\'" . default))
1967 "External applications for opening `file:path' items in a document.
1968 Org-mode uses system defaults for different file types, but
1969 you can use this variable to set the application for a given file
1970 extension. The entries in this list are cons cells where the car identifies
1971 files and the cdr the corresponding command. Possible values for the
1972 file identifier are
1973 \"string\" A string as a file identifier can be interpreted in different
1974 ways, depending on its contents:
1976 - Alphanumeric characters only:
1977 Match links with this file extension.
1978 Example: (\"pdf\" . \"evince %s\")
1979 to open PDFs with evince.
1981 - Regular expression: Match links where the
1982 filename matches the regexp. If you want to
1983 use groups here, use shy groups.
1985 Example: (\"\\.x?html\\'\" . \"firefox %s\")
1986 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
1987 to open *.html and *.xhtml with firefox.
1989 - Regular expression which contains (non-shy) groups:
1990 Match links where the whole link, including \"::\", and
1991 anything after that, matches the regexp.
1992 In a custom command string, %1, %2, etc. are replaced with
1993 the parts of the link that were matched by the groups.
1994 For backwards compatibility, if a command string is given
1995 that does not use any of the group matches, this case is
1996 handled identically to the second one (i.e. match against
1997 file name only).
1998 In a custom lisp form, you can access the group matches with
1999 (match-string n link).
2001 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2002 to open [[file:document.pdf::5]] with evince at page 5.
2004 `directory' Matches a directory
2005 `remote' Matches a remote file, accessible through tramp or efs.
2006 Remote files most likely should be visited through Emacs
2007 because external applications cannot handle such paths.
2008 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2009 so all files Emacs knows how to handle. Using this with
2010 command `emacs' will open most files in Emacs. Beware that this
2011 will also open html files inside Emacs, unless you add
2012 (\"html\" . default) to the list as well.
2013 t Default for files not matched by any of the other options.
2014 `system' The system command to open files, like `open' on Windows
2015 and Mac OS X, and mailcap under GNU/Linux. This is the command
2016 that will be selected if you call `C-c C-o' with a double
2017 \\[universal-argument] \\[universal-argument] prefix.
2019 Possible values for the command are:
2020 `emacs' The file will be visited by the current Emacs process.
2021 `default' Use the default application for this file type, which is the
2022 association for t in the list, most likely in the system-specific
2023 part.
2024 This can be used to overrule an unwanted setting in the
2025 system-specific variable.
2026 `system' Use the system command for opening files, like \"open\".
2027 This command is specified by the entry whose car is `system'.
2028 Most likely, the system-specific version of this variable
2029 does define this command, but you can overrule/replace it
2030 here.
2031 string A command to be executed by a shell; %s will be replaced
2032 by the path to the file.
2033 sexp A Lisp form which will be evaluated. The file path will
2034 be available in the Lisp variable `file'.
2035 For more examples, see the system specific constants
2036 `org-file-apps-defaults-macosx'
2037 `org-file-apps-defaults-windowsnt'
2038 `org-file-apps-defaults-gnu'."
2039 :group 'org-link-follow
2040 :type '(repeat
2041 (cons (choice :value ""
2042 (string :tag "Extension")
2043 (const :tag "System command to open files" system)
2044 (const :tag "Default for unrecognized files" t)
2045 (const :tag "Remote file" remote)
2046 (const :tag "Links to a directory" directory)
2047 (const :tag "Any files that have Emacs modes"
2048 auto-mode))
2049 (choice :value ""
2050 (const :tag "Visit with Emacs" emacs)
2051 (const :tag "Use default" default)
2052 (const :tag "Use the system command" system)
2053 (string :tag "Command")
2054 (sexp :tag "Lisp form")))))
2056 (defcustom org-doi-server-url "http://dx.doi.org/"
2057 "The URL of the DOI server."
2058 :type 'string
2059 :version "24.3"
2060 :group 'org-link-follow)
2062 (defgroup org-refile nil
2063 "Options concerning refiling entries in Org-mode."
2064 :tag "Org Refile"
2065 :group 'org)
2067 (defcustom org-directory "~/org"
2068 "Directory with org files.
2069 This is just a default location to look for Org files. There is no need
2070 at all to put your files into this directory. It is only used in the
2071 following situations:
2073 1. When a capture template specifies a target file that is not an
2074 absolute path. The path will then be interpreted relative to
2075 `org-directory'
2076 2. When a capture note is filed away in an interactive way (when exiting the
2077 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2078 with `org-directory' as the default path."
2079 :group 'org-refile
2080 :group 'org-capture
2081 :type 'directory)
2083 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2084 "Default target for storing notes.
2085 Used as a fall back file for org-capture.el, for templates that
2086 do not specify a target file."
2087 :group 'org-refile
2088 :group 'org-capture
2089 :type '(choice
2090 (const :tag "Default from remember-data-file" nil)
2091 file))
2093 (defcustom org-goto-interface 'outline
2094 "The default interface to be used for `org-goto'.
2095 Allowed values are:
2096 outline The interface shows an outline of the relevant file
2097 and the correct heading is found by moving through
2098 the outline or by searching with incremental search.
2099 outline-path-completion Headlines in the current buffer are offered via
2100 completion. This is the interface also used by
2101 the refile command."
2102 :group 'org-refile
2103 :type '(choice
2104 (const :tag "Outline" outline)
2105 (const :tag "Outline-path-completion" outline-path-completion)))
2107 (defcustom org-goto-max-level 5
2108 "Maximum target level when running `org-goto' with refile interface."
2109 :group 'org-refile
2110 :type 'integer)
2112 (defcustom org-reverse-note-order nil
2113 "Non-nil means store new notes at the beginning of a file or entry.
2114 When nil, new notes will be filed to the end of a file or entry.
2115 This can also be a list with cons cells of regular expressions that
2116 are matched against file names, and values."
2117 :group 'org-capture
2118 :group 'org-refile
2119 :type '(choice
2120 (const :tag "Reverse always" t)
2121 (const :tag "Reverse never" nil)
2122 (repeat :tag "By file name regexp"
2123 (cons regexp boolean))))
2125 (defcustom org-log-refile nil
2126 "Information to record when a task is refiled.
2128 Possible values are:
2130 nil Don't add anything
2131 time Add a time stamp to the task
2132 note Prompt for a note and add it with template `org-log-note-headings'
2134 This option can also be set with on a per-file-basis with
2136 #+STARTUP: nologrefile
2137 #+STARTUP: logrefile
2138 #+STARTUP: lognoterefile
2140 You can have local logging settings for a subtree by setting the LOGGING
2141 property to one or more of these keywords.
2143 When bulk-refiling from the agenda, the value `note' is forbidden and
2144 will temporarily be changed to `time'."
2145 :group 'org-refile
2146 :group 'org-progress
2147 :version "24.1"
2148 :type '(choice
2149 (const :tag "No logging" nil)
2150 (const :tag "Record timestamp" time)
2151 (const :tag "Record timestamp with note." note)))
2153 (defcustom org-refile-targets nil
2154 "Targets for refiling entries with \\[org-refile].
2155 This is a list of cons cells. Each cell contains:
2156 - a specification of the files to be considered, either a list of files,
2157 or a symbol whose function or variable value will be used to retrieve
2158 a file name or a list of file names. If you use `org-agenda-files' for
2159 that, all agenda files will be scanned for targets. Nil means consider
2160 headings in the current buffer.
2161 - A specification of how to find candidate refile targets. This may be
2162 any of:
2163 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2164 This tag has to be present in all target headlines, inheritance will
2165 not be considered.
2166 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2167 todo keyword.
2168 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2169 headlines that are refiling targets.
2170 - a cons cell (:level . N). Any headline of level N is considered a target.
2171 Note that, when `org-odd-levels-only' is set, level corresponds to
2172 order in hierarchy, not to the number of stars.
2173 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2174 Note that, when `org-odd-levels-only' is set, level corresponds to
2175 order in hierarchy, not to the number of stars.
2177 Each element of this list generates a set of possible targets.
2178 The union of these sets is presented (with completion) to
2179 the user by `org-refile'.
2181 You can set the variable `org-refile-target-verify-function' to a function
2182 to verify each headline found by the simple criteria above.
2184 When this variable is nil, all top-level headlines in the current buffer
2185 are used, equivalent to the value `((nil . (:level . 1))'."
2186 :group 'org-refile
2187 :type '(repeat
2188 (cons
2189 (choice :value org-agenda-files
2190 (const :tag "All agenda files" org-agenda-files)
2191 (const :tag "Current buffer" nil)
2192 (function) (variable) (file))
2193 (choice :tag "Identify target headline by"
2194 (cons :tag "Specific tag" (const :value :tag) (string))
2195 (cons :tag "TODO keyword" (const :value :todo) (string))
2196 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2197 (cons :tag "Level number" (const :value :level) (integer))
2198 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2200 (defcustom org-refile-target-verify-function nil
2201 "Function to verify if the headline at point should be a refile target.
2202 The function will be called without arguments, with point at the
2203 beginning of the headline. It should return t and leave point
2204 where it is if the headline is a valid target for refiling.
2206 If the target should not be selected, the function must return nil.
2207 In addition to this, it may move point to a place from where the search
2208 should be continued. For example, the function may decide that the entire
2209 subtree of the current entry should be excluded and move point to the end
2210 of the subtree."
2211 :group 'org-refile
2212 :type '(choice
2213 (const nil)
2214 (function)))
2216 (defcustom org-refile-use-cache nil
2217 "Non-nil means cache refile targets to speed up the process.
2218 The cache for a particular file will be updated automatically when
2219 the buffer has been killed, or when any of the marker used for flagging
2220 refile targets no longer points at a live buffer.
2221 If you have added new entries to a buffer that might themselves be targets,
2222 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2223 find that easier, `C-u C-u C-u C-c C-w'."
2224 :group 'org-refile
2225 :version "24.1"
2226 :type 'boolean)
2228 (defcustom org-refile-use-outline-path nil
2229 "Non-nil means provide refile targets as paths.
2230 So a level 3 headline will be available as level1/level2/level3.
2232 When the value is `file', also include the file name (without directory)
2233 into the path. In this case, you can also stop the completion after
2234 the file name, to get entries inserted as top level in the file.
2236 When `full-file-path', include the full file path."
2237 :group 'org-refile
2238 :type '(choice
2239 (const :tag "Not" nil)
2240 (const :tag "Yes" t)
2241 (const :tag "Start with file name" file)
2242 (const :tag "Start with full file path" full-file-path)))
2244 (defcustom org-outline-path-complete-in-steps t
2245 "Non-nil means complete the outline path in hierarchical steps.
2246 When Org-mode uses the refile interface to select an outline path
2247 \(see variable `org-refile-use-outline-path'), the completion of
2248 the path can be done is a single go, or if can be done in steps down
2249 the headline hierarchy. Going in steps is probably the best if you
2250 do not use a special completion package like `ido' or `icicles'.
2251 However, when using these packages, going in one step can be very
2252 fast, while still showing the whole path to the entry."
2253 :group 'org-refile
2254 :type 'boolean)
2256 (defcustom org-refile-allow-creating-parent-nodes nil
2257 "Non-nil means allow to create new nodes as refile targets.
2258 New nodes are then created by adding \"/new node name\" to the completion
2259 of an existing node. When the value of this variable is `confirm',
2260 new node creation must be confirmed by the user (recommended).
2261 When nil, the completion must match an existing entry.
2263 Note that, if the new heading is not seen by the criteria
2264 listed in `org-refile-targets', multiple instances of the same
2265 heading would be created by trying again to file under the new
2266 heading."
2267 :group 'org-refile
2268 :type '(choice
2269 (const :tag "Never" nil)
2270 (const :tag "Always" t)
2271 (const :tag "Prompt for confirmation" confirm)))
2273 (defcustom org-refile-active-region-within-subtree nil
2274 "Non-nil means also refile active region within a subtree.
2276 By default `org-refile' doesn't allow refiling regions if they
2277 don't contain a set of subtrees, but it might be convenient to
2278 do so sometimes: in that case, the first line of the region is
2279 converted to a headline before refiling."
2280 :group 'org-refile
2281 :version "24.1"
2282 :type 'boolean)
2284 (defgroup org-todo nil
2285 "Options concerning TODO items in Org-mode."
2286 :tag "Org TODO"
2287 :group 'org)
2289 (defgroup org-progress nil
2290 "Options concerning Progress logging in Org-mode."
2291 :tag "Org Progress"
2292 :group 'org-time)
2294 (defvar org-todo-interpretation-widgets
2295 '((:tag "Sequence (cycling hits every state)" sequence)
2296 (:tag "Type (cycling directly to DONE)" type))
2297 "The available interpretation symbols for customizing `org-todo-keywords'.
2298 Interested libraries should add to this list.")
2300 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2301 "List of TODO entry keyword sequences and their interpretation.
2302 \\<org-mode-map>This is a list of sequences.
2304 Each sequence starts with a symbol, either `sequence' or `type',
2305 indicating if the keywords should be interpreted as a sequence of
2306 action steps, or as different types of TODO items. The first
2307 keywords are states requiring action - these states will select a headline
2308 for inclusion into the global TODO list Org-mode produces. If one of
2309 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2310 signify that no further action is necessary. If \"|\" is not found,
2311 the last keyword is treated as the only DONE state of the sequence.
2313 The command \\[org-todo] cycles an entry through these states, and one
2314 additional state where no keyword is present. For details about this
2315 cycling, see the manual.
2317 TODO keywords and interpretation can also be set on a per-file basis with
2318 the special #+SEQ_TODO and #+TYP_TODO lines.
2320 Each keyword can optionally specify a character for fast state selection
2321 \(in combination with the variable `org-use-fast-todo-selection')
2322 and specifiers for state change logging, using the same syntax that
2323 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2324 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2325 indicates to record a time stamp each time this state is selected.
2327 Each keyword may also specify if a timestamp or a note should be
2328 recorded when entering or leaving the state, by adding additional
2329 characters in the parenthesis after the keyword. This looks like this:
2330 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2331 record only the time of the state change. With X and Y being either
2332 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2333 Y when leaving the state if and only if the *target* state does not
2334 define X. You may omit any of the fast-selection key or X or /Y,
2335 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2337 For backward compatibility, this variable may also be just a list
2338 of keywords. In this case the interpretation (sequence or type) will be
2339 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2340 :group 'org-todo
2341 :group 'org-keywords
2342 :type '(choice
2343 (repeat :tag "Old syntax, just keywords"
2344 (string :tag "Keyword"))
2345 (repeat :tag "New syntax"
2346 (cons
2347 (choice
2348 :tag "Interpretation"
2349 ;;Quick and dirty way to see
2350 ;;`org-todo-interpretations'. This takes the
2351 ;;place of item arguments
2352 :convert-widget
2353 (lambda (widget)
2354 (widget-put widget
2355 :args (mapcar
2356 #'(lambda (x)
2357 (widget-convert
2358 (cons 'const x)))
2359 org-todo-interpretation-widgets))
2360 widget))
2361 (repeat
2362 (string :tag "Keyword"))))))
2364 (defvar org-todo-keywords-1 nil
2365 "All TODO and DONE keywords active in a buffer.")
2366 (make-variable-buffer-local 'org-todo-keywords-1)
2367 (defvar org-todo-keywords-for-agenda nil)
2368 (defvar org-done-keywords-for-agenda nil)
2369 (defvar org-drawers-for-agenda nil)
2370 (defvar org-todo-keyword-alist-for-agenda nil)
2371 (defvar org-tag-alist-for-agenda nil
2372 "Alist of all tags from all agenda files.")
2373 (defvar org-tag-groups-alist-for-agenda nil
2374 "Alist of all groups tags from all current agenda files.")
2375 (defvar org-tag-groups-alist nil)
2376 (make-variable-buffer-local 'org-tag-groups-alist)
2377 (defvar org-agenda-contributing-files nil)
2378 (defvar org-not-done-keywords nil)
2379 (make-variable-buffer-local 'org-not-done-keywords)
2380 (defvar org-done-keywords nil)
2381 (make-variable-buffer-local 'org-done-keywords)
2382 (defvar org-todo-heads nil)
2383 (make-variable-buffer-local 'org-todo-heads)
2384 (defvar org-todo-sets nil)
2385 (make-variable-buffer-local 'org-todo-sets)
2386 (defvar org-todo-log-states nil)
2387 (make-variable-buffer-local 'org-todo-log-states)
2388 (defvar org-todo-kwd-alist nil)
2389 (make-variable-buffer-local 'org-todo-kwd-alist)
2390 (defvar org-todo-key-alist nil)
2391 (make-variable-buffer-local 'org-todo-key-alist)
2392 (defvar org-todo-key-trigger nil)
2393 (make-variable-buffer-local 'org-todo-key-trigger)
2395 (defcustom org-todo-interpretation 'sequence
2396 "Controls how TODO keywords are interpreted.
2397 This variable is in principle obsolete and is only used for
2398 backward compatibility, if the interpretation of todo keywords is
2399 not given already in `org-todo-keywords'. See that variable for
2400 more information."
2401 :group 'org-todo
2402 :group 'org-keywords
2403 :type '(choice (const sequence)
2404 (const type)))
2406 (defcustom org-use-fast-todo-selection t
2407 "Non-nil means use the fast todo selection scheme with C-c C-t.
2408 This variable describes if and under what circumstances the cycling
2409 mechanism for TODO keywords will be replaced by a single-key, direct
2410 selection scheme.
2412 When nil, fast selection is never used.
2414 When the symbol `prefix', it will be used when `org-todo' is called
2415 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2416 `C-u t' in an agenda buffer.
2418 When t, fast selection is used by default. In this case, the prefix
2419 argument forces cycling instead.
2421 In all cases, the special interface is only used if access keys have
2422 actually been assigned by the user, i.e. if keywords in the configuration
2423 are followed by a letter in parenthesis, like TODO(t)."
2424 :group 'org-todo
2425 :type '(choice
2426 (const :tag "Never" nil)
2427 (const :tag "By default" t)
2428 (const :tag "Only with C-u C-c C-t" prefix)))
2430 (defcustom org-provide-todo-statistics t
2431 "Non-nil means update todo statistics after insert and toggle.
2432 ALL-HEADLINES means update todo statistics by including headlines
2433 with no TODO keyword as well, counting them as not done.
2434 A list of TODO keywords means the same, but skip keywords that are
2435 not in this list.
2437 When this is set, todo statistics is updated in the parent of the
2438 current entry each time a todo state is changed."
2439 :group 'org-todo
2440 :type '(choice
2441 (const :tag "Yes, only for TODO entries" t)
2442 (const :tag "Yes, including all entries" all-headlines)
2443 (repeat :tag "Yes, for TODOs in this list"
2444 (string :tag "TODO keyword"))
2445 (other :tag "No TODO statistics" nil)))
2447 (defcustom org-hierarchical-todo-statistics t
2448 "Non-nil means TODO statistics covers just direct children.
2449 When nil, all entries in the subtree are considered.
2450 This has only an effect if `org-provide-todo-statistics' is set.
2451 To set this to nil for only a single subtree, use a COOKIE_DATA
2452 property and include the word \"recursive\" into the value."
2453 :group 'org-todo
2454 :type 'boolean)
2456 (defcustom org-after-todo-state-change-hook nil
2457 "Hook which is run after the state of a TODO item was changed.
2458 The new state (a string with a TODO keyword, or nil) is available in the
2459 Lisp variable `org-state'."
2460 :group 'org-todo
2461 :type 'hook)
2463 (defvar org-blocker-hook nil
2464 "Hook for functions that are allowed to block a state change.
2466 Functions in this hook should not modify the buffer.
2467 Each function gets as its single argument a property list,
2468 see `org-trigger-hook' for more information about this list.
2470 If any of the functions in this hook returns nil, the state change
2471 is blocked.")
2473 (defvar org-trigger-hook nil
2474 "Hook for functions that are triggered by a state change.
2476 Each function gets as its single argument a property list with at
2477 least the following elements:
2479 (:type type-of-change :position pos-at-entry-start
2480 :from old-state :to new-state)
2482 Depending on the type, more properties may be present.
2484 This mechanism is currently implemented for:
2486 TODO state changes
2487 ------------------
2488 :type todo-state-change
2489 :from previous state (keyword as a string), or nil, or a symbol
2490 'todo' or 'done', to indicate the general type of state.
2491 :to new state, like in :from")
2493 (defcustom org-enforce-todo-dependencies nil
2494 "Non-nil means undone TODO entries will block switching the parent to DONE.
2495 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2496 be blocked if any prior sibling is not yet done.
2497 Finally, if the parent is blocked because of ordered siblings of its own,
2498 the child will also be blocked."
2499 :set (lambda (var val)
2500 (set var val)
2501 (if val
2502 (add-hook 'org-blocker-hook
2503 'org-block-todo-from-children-or-siblings-or-parent)
2504 (remove-hook 'org-blocker-hook
2505 'org-block-todo-from-children-or-siblings-or-parent)))
2506 :group 'org-todo
2507 :type 'boolean)
2509 (defcustom org-enforce-todo-checkbox-dependencies nil
2510 "Non-nil means unchecked boxes will block switching the parent to DONE.
2511 When this is nil, checkboxes have no influence on switching TODO states.
2512 When non-nil, you first need to check off all check boxes before the TODO
2513 entry can be switched to DONE.
2514 This variable needs to be set before org.el is loaded, and you need to
2515 restart Emacs after a change to make the change effective. The only way
2516 to change is while Emacs is running is through the customize interface."
2517 :set (lambda (var val)
2518 (set var val)
2519 (if val
2520 (add-hook 'org-blocker-hook
2521 'org-block-todo-from-checkboxes)
2522 (remove-hook 'org-blocker-hook
2523 'org-block-todo-from-checkboxes)))
2524 :group 'org-todo
2525 :type 'boolean)
2527 (defcustom org-treat-insert-todo-heading-as-state-change nil
2528 "Non-nil means inserting a TODO heading is treated as state change.
2529 So when the command \\[org-insert-todo-heading] is used, state change
2530 logging will apply if appropriate. When nil, the new TODO item will
2531 be inserted directly, and no logging will take place."
2532 :group 'org-todo
2533 :type 'boolean)
2535 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2536 "Non-nil means switching TODO states with S-cursor counts as state change.
2537 This is the default behavior. However, setting this to nil allows a
2538 convenient way to select a TODO state and bypass any logging associated
2539 with that."
2540 :group 'org-todo
2541 :type 'boolean)
2543 (defcustom org-todo-state-tags-triggers nil
2544 "Tag changes that should be triggered by TODO state changes.
2545 This is a list. Each entry is
2547 (state-change (tag . flag) .......)
2549 State-change can be a string with a state, and empty string to indicate the
2550 state that has no TODO keyword, or it can be one of the symbols `todo'
2551 or `done', meaning any not-done or done state, respectively."
2552 :group 'org-todo
2553 :group 'org-tags
2554 :type '(repeat
2555 (cons (choice :tag "When changing to"
2556 (const :tag "Not-done state" todo)
2557 (const :tag "Done state" done)
2558 (string :tag "State"))
2559 (repeat
2560 (cons :tag "Tag action"
2561 (string :tag "Tag")
2562 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2564 (defcustom org-log-done nil
2565 "Information to record when a task moves to the DONE state.
2567 Possible values are:
2569 nil Don't add anything, just change the keyword
2570 time Add a time stamp to the task
2571 note Prompt for a note and add it with template `org-log-note-headings'
2573 This option can also be set with on a per-file-basis with
2575 #+STARTUP: nologdone
2576 #+STARTUP: logdone
2577 #+STARTUP: lognotedone
2579 You can have local logging settings for a subtree by setting the LOGGING
2580 property to one or more of these keywords."
2581 :group 'org-todo
2582 :group 'org-progress
2583 :type '(choice
2584 (const :tag "No logging" nil)
2585 (const :tag "Record CLOSED timestamp" time)
2586 (const :tag "Record CLOSED timestamp with note." note)))
2588 ;; Normalize old uses of org-log-done.
2589 (cond
2590 ((eq org-log-done t) (setq org-log-done 'time))
2591 ((and (listp org-log-done) (memq 'done org-log-done))
2592 (setq org-log-done 'note)))
2594 (defcustom org-log-reschedule nil
2595 "Information to record when the scheduling date of a tasks is modified.
2597 Possible values are:
2599 nil Don't add anything, just change the date
2600 time Add a time stamp to the task
2601 note Prompt for a note and add it with template `org-log-note-headings'
2603 This option can also be set with on a per-file-basis with
2605 #+STARTUP: nologreschedule
2606 #+STARTUP: logreschedule
2607 #+STARTUP: lognotereschedule"
2608 :group 'org-todo
2609 :group 'org-progress
2610 :type '(choice
2611 (const :tag "No logging" nil)
2612 (const :tag "Record timestamp" time)
2613 (const :tag "Record timestamp with note." note)))
2615 (defcustom org-log-redeadline nil
2616 "Information to record when the deadline date of a tasks is modified.
2618 Possible values are:
2620 nil Don't add anything, just change the date
2621 time Add a time stamp to the task
2622 note Prompt for a note and add it with template `org-log-note-headings'
2624 This option can also be set with on a per-file-basis with
2626 #+STARTUP: nologredeadline
2627 #+STARTUP: logredeadline
2628 #+STARTUP: lognoteredeadline
2630 You can have local logging settings for a subtree by setting the LOGGING
2631 property to one or more of these keywords."
2632 :group 'org-todo
2633 :group 'org-progress
2634 :type '(choice
2635 (const :tag "No logging" nil)
2636 (const :tag "Record timestamp" time)
2637 (const :tag "Record timestamp with note." note)))
2639 (defcustom org-log-note-clock-out nil
2640 "Non-nil means record a note when clocking out of an item.
2641 This can also be configured on a per-file basis by adding one of
2642 the following lines anywhere in the buffer:
2644 #+STARTUP: lognoteclock-out
2645 #+STARTUP: nolognoteclock-out"
2646 :group 'org-todo
2647 :group 'org-progress
2648 :type 'boolean)
2650 (defcustom org-log-done-with-time t
2651 "Non-nil means the CLOSED time stamp will contain date and time.
2652 When nil, only the date will be recorded."
2653 :group 'org-progress
2654 :type 'boolean)
2656 (defcustom org-log-note-headings
2657 '((done . "CLOSING NOTE %t")
2658 (state . "State %-12s from %-12S %t")
2659 (note . "Note taken on %t")
2660 (reschedule . "Rescheduled from %S on %t")
2661 (delschedule . "Not scheduled, was %S on %t")
2662 (redeadline . "New deadline from %S on %t")
2663 (deldeadline . "Removed deadline, was %S on %t")
2664 (refile . "Refiled on %t")
2665 (clock-out . ""))
2666 "Headings for notes added to entries.
2667 The value is an alist, with the car being a symbol indicating the note
2668 context, and the cdr is the heading to be used. The heading may also be the
2669 empty string.
2670 %t in the heading will be replaced by a time stamp.
2671 %T will be an active time stamp instead the default inactive one
2672 %d will be replaced by a short-format time stamp.
2673 %D will be replaced by an active short-format time stamp.
2674 %s will be replaced by the new TODO state, in double quotes.
2675 %S will be replaced by the old TODO state, in double quotes.
2676 %u will be replaced by the user name.
2677 %U will be replaced by the full user name.
2679 In fact, it is not a good idea to change the `state' entry, because
2680 agenda log mode depends on the format of these entries."
2681 :group 'org-todo
2682 :group 'org-progress
2683 :type '(list :greedy t
2684 (cons (const :tag "Heading when closing an item" done) string)
2685 (cons (const :tag
2686 "Heading when changing todo state (todo sequence only)"
2687 state) string)
2688 (cons (const :tag "Heading when just taking a note" note) string)
2689 (cons (const :tag "Heading when rescheduling" reschedule) string)
2690 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2691 (cons (const :tag "Heading when changing deadline" redeadline) string)
2692 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2693 (cons (const :tag "Heading when refiling" refile) string)
2694 (cons (const :tag "Heading when clocking out" clock-out) string)))
2696 (unless (assq 'note org-log-note-headings)
2697 (push '(note . "%t") org-log-note-headings))
2699 (defcustom org-log-into-drawer nil
2700 "Non-nil means insert state change notes and time stamps into a drawer.
2701 When nil, state changes notes will be inserted after the headline and
2702 any scheduling and clock lines, but not inside a drawer.
2704 The value of this variable should be the name of the drawer to use.
2705 LOGBOOK is proposed as the default drawer for this purpose, you can
2706 also set this to a string to define the drawer of your choice.
2708 A value of t is also allowed, representing \"LOGBOOK\".
2710 A value of t or nil can also be set with on a per-file-basis with
2712 #+STARTUP: logdrawer
2713 #+STARTUP: nologdrawer
2715 If this variable is set, `org-log-state-notes-insert-after-drawers'
2716 will be ignored.
2718 You can set the property LOG_INTO_DRAWER to overrule this setting for
2719 a subtree."
2720 :group 'org-todo
2721 :group 'org-progress
2722 :type '(choice
2723 (const :tag "Not into a drawer" nil)
2724 (const :tag "LOGBOOK" t)
2725 (string :tag "Other")))
2727 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2729 (defun org-log-into-drawer ()
2730 "Return the value of `org-log-into-drawer', but let properties overrule.
2731 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2732 used instead of the default value."
2733 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2734 (cond
2735 ((not p) org-log-into-drawer)
2736 ((equal p "nil") nil)
2737 ((equal p "t") "LOGBOOK")
2738 (t p))))
2740 (defcustom org-log-state-notes-insert-after-drawers nil
2741 "Non-nil means insert state change notes after any drawers in entry.
2742 Only the drawers that *immediately* follow the headline and the
2743 deadline/scheduled line are skipped.
2744 When nil, insert notes right after the heading and perhaps the line
2745 with deadline/scheduling if present.
2747 This variable will have no effect if `org-log-into-drawer' is
2748 set."
2749 :group 'org-todo
2750 :group 'org-progress
2751 :type 'boolean)
2753 (defcustom org-log-states-order-reversed t
2754 "Non-nil means the latest state note will be directly after heading.
2755 When nil, the state change notes will be ordered according to time.
2757 This option can also be set with on a per-file-basis with
2759 #+STARTUP: logstatesreversed
2760 #+STARTUP: nologstatesreversed"
2761 :group 'org-todo
2762 :group 'org-progress
2763 :type 'boolean)
2765 (defcustom org-todo-repeat-to-state nil
2766 "The TODO state to which a repeater should return the repeating task.
2767 By default this is the first task in a TODO sequence, or the previous state
2768 in a TODO_TYP set. But you can specify another task here.
2769 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2770 :group 'org-todo
2771 :version "24.1"
2772 :type '(choice (const :tag "Head of sequence" nil)
2773 (string :tag "Specific state")))
2775 (defcustom org-log-repeat 'time
2776 "Non-nil means record moving through the DONE state when triggering repeat.
2777 An auto-repeating task is immediately switched back to TODO when
2778 marked DONE. If you are not logging state changes (by adding \"@\"
2779 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2780 record a closing note, there will be no record of the task moving
2781 through DONE. This variable forces taking a note anyway.
2783 nil Don't force a record
2784 time Record a time stamp
2785 note Prompt for a note and add it with template `org-log-note-headings'
2787 This option can also be set with on a per-file-basis with
2789 #+STARTUP: nologrepeat
2790 #+STARTUP: logrepeat
2791 #+STARTUP: lognoterepeat
2793 You can have local logging settings for a subtree by setting the LOGGING
2794 property to one or more of these keywords."
2795 :group 'org-todo
2796 :group 'org-progress
2797 :type '(choice
2798 (const :tag "Don't force a record" nil)
2799 (const :tag "Force recording the DONE state" time)
2800 (const :tag "Force recording a note with the DONE state" note)))
2803 (defgroup org-priorities nil
2804 "Priorities in Org-mode."
2805 :tag "Org Priorities"
2806 :group 'org-todo)
2808 (defcustom org-enable-priority-commands t
2809 "Non-nil means priority commands are active.
2810 When nil, these commands will be disabled, so that you never accidentally
2811 set a priority."
2812 :group 'org-priorities
2813 :type 'boolean)
2815 (defcustom org-highest-priority ?A
2816 "The highest priority of TODO items. A character like ?A, ?B etc.
2817 Must have a smaller ASCII number than `org-lowest-priority'."
2818 :group 'org-priorities
2819 :type 'character)
2821 (defcustom org-lowest-priority ?C
2822 "The lowest priority of TODO items. A character like ?A, ?B etc.
2823 Must have a larger ASCII number than `org-highest-priority'."
2824 :group 'org-priorities
2825 :type 'character)
2827 (defcustom org-default-priority ?B
2828 "The default priority of TODO items.
2829 This is the priority an item gets if no explicit priority is given.
2830 When starting to cycle on an empty priority the first step in the cycle
2831 depends on `org-priority-start-cycle-with-default'. The resulting first
2832 step priority must not exceed the range from `org-highest-priority' to
2833 `org-lowest-priority' which means that `org-default-priority' has to be
2834 in this range exclusive or inclusive the range boundaries. Else the
2835 first step refuses to set the default and the second will fall back
2836 to (depending on the command used) the highest or lowest priority."
2837 :group 'org-priorities
2838 :type 'character)
2840 (defcustom org-priority-start-cycle-with-default t
2841 "Non-nil means start with default priority when starting to cycle.
2842 When this is nil, the first step in the cycle will be (depending on the
2843 command used) one higher or lower than the default priority.
2844 See also `org-default-priority'."
2845 :group 'org-priorities
2846 :type 'boolean)
2848 (defcustom org-get-priority-function nil
2849 "Function to extract the priority from a string.
2850 The string is normally the headline. If this is nil Org computes the
2851 priority from the priority cookie like [#A] in the headline. It returns
2852 an integer, increasing by 1000 for each priority level.
2853 The user can set a different function here, which should take a string
2854 as an argument and return the numeric priority."
2855 :group 'org-priorities
2856 :version "24.1"
2857 :type '(choice
2858 (const nil)
2859 (function)))
2861 (defgroup org-time nil
2862 "Options concerning time stamps and deadlines in Org-mode."
2863 :tag "Org Time"
2864 :group 'org)
2866 (defcustom org-insert-labeled-timestamps-at-point nil
2867 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2868 When nil, these labeled time stamps are forces into the second line of an
2869 entry, just after the headline. When scheduling from the global TODO list,
2870 the time stamp will always be forced into the second line."
2871 :group 'org-time
2872 :type 'boolean)
2874 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
2875 "Formats for `format-time-string' which are used for time stamps.
2876 It is not recommended to change this constant.")
2878 (defcustom org-time-stamp-rounding-minutes '(0 5)
2879 "Number of minutes to round time stamps to.
2880 These are two values, the first applies when first creating a time stamp.
2881 The second applies when changing it with the commands `S-up' and `S-down'.
2882 When changing the time stamp, this means that it will change in steps
2883 of N minutes, as given by the second value.
2885 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2886 numbers should be factors of 60, so for example 5, 10, 15.
2888 When this is larger than 1, you can still force an exact time stamp by using
2889 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2890 and by using a prefix arg to `S-up/down' to specify the exact number
2891 of minutes to shift."
2892 :group 'org-time
2893 :get #'(lambda (var) ; Make sure both elements are there
2894 (if (integerp (default-value var))
2895 (list (default-value var) 5)
2896 (default-value var)))
2897 :type '(list
2898 (integer :tag "when inserting times")
2899 (integer :tag "when modifying times")))
2901 ;; Normalize old customizations of this variable.
2902 (when (integerp org-time-stamp-rounding-minutes)
2903 (setq org-time-stamp-rounding-minutes
2904 (list org-time-stamp-rounding-minutes
2905 org-time-stamp-rounding-minutes)))
2907 (defcustom org-display-custom-times nil
2908 "Non-nil means overlay custom formats over all time stamps.
2909 The formats are defined through the variable `org-time-stamp-custom-formats'.
2910 To turn this on on a per-file basis, insert anywhere in the file:
2911 #+STARTUP: customtime"
2912 :group 'org-time
2913 :set 'set-default
2914 :type 'sexp)
2915 (make-variable-buffer-local 'org-display-custom-times)
2917 (defcustom org-time-stamp-custom-formats
2918 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
2919 "Custom formats for time stamps. See `format-time-string' for the syntax.
2920 These are overlaid over the default ISO format if the variable
2921 `org-display-custom-times' is set. Time like %H:%M should be at the
2922 end of the second format. The custom formats are also honored by export
2923 commands, if custom time display is turned on at the time of export."
2924 :group 'org-time
2925 :type 'sexp)
2927 (defun org-time-stamp-format (&optional long inactive)
2928 "Get the right format for a time string."
2929 (let ((f (if long (cdr org-time-stamp-formats)
2930 (car org-time-stamp-formats))))
2931 (if inactive
2932 (concat "[" (substring f 1 -1) "]")
2933 f)))
2935 (defcustom org-time-clocksum-format
2936 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
2937 "The format string used when creating CLOCKSUM lines.
2938 This is also used when Org mode generates a time duration.
2940 The value can be a single format string containing two
2941 %-sequences, which will be filled with the number of hours and
2942 minutes in that order.
2944 Alternatively, the value can be a plist associating any of the
2945 keys :years, :months, :weeks, :days, :hours or :minutes with
2946 format strings. The time duration is formatted using only the
2947 time components that are needed and concatenating the results.
2948 If a time unit in absent, it falls back to the next smallest
2949 unit.
2951 The keys :require-years, :require-months, :require-days,
2952 :require-weeks, :require-hours, :require-minutes are also
2953 meaningful. A non-nil value for these keys indicates that the
2954 corresponding time component should always be included, even if
2955 its value is 0.
2958 For example,
2960 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
2961 :require-minutes t)
2963 means durations longer than a day will be expressed in days,
2964 hours and minutes, and durations less than a day will always be
2965 expressed in hours and minutes (even for durations less than an
2966 hour).
2968 The value
2970 \(:days \"%dd\" :minutes \"%dm\")
2972 means durations longer than a day will be expressed in days and
2973 minutes, and durations less than a day will be expressed entirely
2974 in minutes (even for durations longer than an hour)."
2975 :group 'org-time
2976 :group 'org-clock
2977 :version "24.4"
2978 :package-version '(Org . "8.0")
2979 :type '(choice (string :tag "Format string")
2980 (set :tag "Plist"
2981 (group :inline t (const :tag "Years" :years)
2982 (string :tag "Format string"))
2983 (group :inline t
2984 (const :tag "Always show years" :require-years)
2985 (const t))
2986 (group :inline t (const :tag "Months" :months)
2987 (string :tag "Format string"))
2988 (group :inline t
2989 (const :tag "Always show months" :require-months)
2990 (const t))
2991 (group :inline t (const :tag "Weeks" :weeks)
2992 (string :tag "Format string"))
2993 (group :inline t
2994 (const :tag "Always show weeks" :require-weeks)
2995 (const t))
2996 (group :inline t (const :tag "Days" :days)
2997 (string :tag "Format string"))
2998 (group :inline t
2999 (const :tag "Always show days" :require-days)
3000 (const t))
3001 (group :inline t (const :tag "Hours" :hours)
3002 (string :tag "Format string"))
3003 (group :inline t
3004 (const :tag "Always show hours" :require-hours)
3005 (const t))
3006 (group :inline t (const :tag "Minutes" :minutes)
3007 (string :tag "Format string"))
3008 (group :inline t
3009 (const :tag "Always show minutes" :require-minutes)
3010 (const t)))))
3012 (defcustom org-time-clocksum-use-fractional nil
3013 "When non-nil, \\[org-clock-display] uses fractional times.
3014 See `org-time-clocksum-format' for more on time clock formats."
3015 :group 'org-time
3016 :group 'org-clock
3017 :version "24.3"
3018 :type 'boolean)
3020 (defcustom org-time-clocksum-use-effort-durations nil
3021 "When non-nil, \\[org-clock-display] uses effort durations.
3022 E.g. by default, one day is considered to be a 8 hours effort,
3023 so a task that has been clocked for 16 hours will be displayed
3024 as during 2 days in the clock display or in the clocktable.
3026 See `org-effort-durations' on how to set effort durations
3027 and `org-time-clocksum-format' for more on time clock formats."
3028 :group 'org-time
3029 :group 'org-clock
3030 :version "24.4"
3031 :package-version '(Org . "8.0")
3032 :type 'boolean)
3034 (defcustom org-time-clocksum-fractional-format "%.2f"
3035 "The format string used when creating CLOCKSUM lines,
3036 or when Org mode generates a time duration, if
3037 `org-time-clocksum-use-fractional' is enabled.
3039 The value can be a single format string containing one
3040 %-sequence, which will be filled with the number of hours as
3041 a float.
3043 Alternatively, the value can be a plist associating any of the
3044 keys :years, :months, :weeks, :days, :hours or :minutes with
3045 a format string. The time duration is formatted using the
3046 largest time unit which gives a non-zero integer part. If all
3047 specified formats have zero integer part, the smallest time unit
3048 is used."
3049 :group 'org-time
3050 :type '(choice (string :tag "Format string")
3051 (set (group :inline t (const :tag "Years" :years)
3052 (string :tag "Format string"))
3053 (group :inline t (const :tag "Months" :months)
3054 (string :tag "Format string"))
3055 (group :inline t (const :tag "Weeks" :weeks)
3056 (string :tag "Format string"))
3057 (group :inline t (const :tag "Days" :days)
3058 (string :tag "Format string"))
3059 (group :inline t (const :tag "Hours" :hours)
3060 (string :tag "Format string"))
3061 (group :inline t (const :tag "Minutes" :minutes)
3062 (string :tag "Format string")))))
3064 (defcustom org-deadline-warning-days 14
3065 "Number of days before expiration during which a deadline becomes active.
3066 This variable governs the display in sparse trees and in the agenda.
3067 When 0 or negative, it means use this number (the absolute value of it)
3068 even if a deadline has a different individual lead time specified.
3070 Custom commands can set this variable in the options section."
3071 :group 'org-time
3072 :group 'org-agenda-daily/weekly
3073 :type 'integer)
3075 (defcustom org-scheduled-delay-days 0
3076 "Number of days before a scheduled item becomes active.
3077 This variable governs the display in sparse trees and in the agenda.
3078 The default value (i.e. 0) means: don't delay scheduled item.
3079 When negative, it means use this number (the absolute value of it)
3080 even if a scheduled item has a different individual delay time
3081 specified.
3083 Custom commands can set this variable in the options section."
3084 :group 'org-time
3085 :group 'org-agenda-daily/weekly
3086 :version "24.4"
3087 :package-version '(Org . "8.0")
3088 :type 'integer)
3090 (defcustom org-read-date-prefer-future t
3091 "Non-nil means assume future for incomplete date input from user.
3092 This affects the following situations:
3093 1. The user gives a month but not a year.
3094 For example, if it is April and you enter \"feb 2\", this will be read
3095 as Feb 2, *next* year. \"May 5\", however, will be this year.
3096 2. The user gives a day, but no month.
3097 For example, if today is the 15th, and you enter \"3\", Org-mode will
3098 read this as the third of *next* month. However, if you enter \"17\",
3099 it will be considered as *this* month.
3101 If you set this variable to the symbol `time', then also the following
3102 will work:
3104 3. If the user gives a time.
3105 If the time is before now, it will be interpreted as tomorrow.
3107 Currently none of this works for ISO week specifications.
3109 When this option is nil, the current day, month and year will always be
3110 used as defaults.
3112 See also `org-agenda-jump-prefer-future'."
3113 :group 'org-time
3114 :type '(choice
3115 (const :tag "Never" nil)
3116 (const :tag "Check month and day" t)
3117 (const :tag "Check month, day, and time" time)))
3119 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3120 "Should the agenda jump command prefer the future for incomplete dates?
3121 The default is to do the same as configured in `org-read-date-prefer-future'.
3122 But you can also set a deviating value here.
3123 This may t or nil, or the symbol `org-read-date-prefer-future'."
3124 :group 'org-agenda
3125 :group 'org-time
3126 :version "24.1"
3127 :type '(choice
3128 (const :tag "Use org-read-date-prefer-future"
3129 org-read-date-prefer-future)
3130 (const :tag "Never" nil)
3131 (const :tag "Always" t)))
3133 (defcustom org-read-date-force-compatible-dates t
3134 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3136 Depending on the system Emacs is running on, certain dates cannot
3137 be represented with the type used internally to represent time.
3138 Dates between 1970-1-1 and 2038-1-1 can always be represented
3139 correctly. Some systems allow for earlier dates, some for later,
3140 some for both. One way to find out it to insert any date into an
3141 Org buffer, putting the cursor on the year and hitting S-up and
3142 S-down to test the range.
3144 When this variable is set to t, the date/time prompt will not let
3145 you specify dates outside the 1970-2037 range, so it is certain that
3146 these dates will work in whatever version of Emacs you are
3147 running, and also that you can move a file from one Emacs implementation
3148 to another. WHenever Org is forcing the year for you, it will display
3149 a message and beep.
3151 When this variable is nil, Org will check if the date is
3152 representable in the specific Emacs implementation you are using.
3153 If not, it will force a year, usually the current year, and beep
3154 to remind you. Currently this setting is not recommended because
3155 the likelihood that you will open your Org files in an Emacs that
3156 has limited date range is not negligible.
3158 A workaround for this problem is to use diary sexp dates for time
3159 stamps outside of this range."
3160 :group 'org-time
3161 :version "24.1"
3162 :type 'boolean)
3164 (defcustom org-read-date-display-live t
3165 "Non-nil means display current interpretation of date prompt live.
3166 This display will be in an overlay, in the minibuffer."
3167 :group 'org-time
3168 :type 'boolean)
3170 (defcustom org-read-date-popup-calendar t
3171 "Non-nil means pop up a calendar when prompting for a date.
3172 In the calendar, the date can be selected with mouse-1. However, the
3173 minibuffer will also be active, and you can simply enter the date as well.
3174 When nil, only the minibuffer will be available."
3175 :group 'org-time
3176 :type 'boolean)
3177 (org-defvaralias 'org-popup-calendar-for-date-prompt
3178 'org-read-date-popup-calendar)
3180 (make-obsolete-variable
3181 'org-read-date-minibuffer-setup-hook
3182 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3183 (defcustom org-read-date-minibuffer-setup-hook nil
3184 "Hook to be used to set up keys for the date/time interface.
3185 Add key definitions to `minibuffer-local-map', which will be a
3186 temporary copy.
3188 WARNING: This option is obsolete, you should use
3189 `org-read-date-minibuffer-local-map' to set up keys."
3190 :group 'org-time
3191 :type 'hook)
3193 (defcustom org-extend-today-until 0
3194 "The hour when your day really ends. Must be an integer.
3195 This has influence for the following applications:
3196 - When switching the agenda to \"today\". It it is still earlier than
3197 the time given here, the day recognized as TODAY is actually yesterday.
3198 - When a date is read from the user and it is still before the time given
3199 here, the current date and time will be assumed to be yesterday, 23:59.
3200 Also, timestamps inserted in capture templates follow this rule.
3202 IMPORTANT: This is a feature whose implementation is and likely will
3203 remain incomplete. Really, it is only here because past midnight seems to
3204 be the favorite working time of John Wiegley :-)"
3205 :group 'org-time
3206 :type 'integer)
3208 (defcustom org-use-effective-time nil
3209 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3210 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3211 \"effective time\" of any timestamps between midnight and 8am will be
3212 23:59 of the previous day."
3213 :group 'org-time
3214 :version "24.1"
3215 :type 'boolean)
3217 (defcustom org-use-last-clock-out-time-as-effective-time nil
3218 "When non-nil, use the last clock out time for `org-todo'.
3219 Note that this option has precedence over the combined use of
3220 `org-use-effective-time' and `org-extend-today-until'."
3221 :group 'org-time
3222 :version "24.4"
3223 :package-version '(Org . "8.0")
3224 :type 'boolean)
3226 (defcustom org-edit-timestamp-down-means-later nil
3227 "Non-nil means S-down will increase the time in a time stamp.
3228 When nil, S-up will increase."
3229 :group 'org-time
3230 :type 'boolean)
3232 (defcustom org-calendar-follow-timestamp-change t
3233 "Non-nil means make the calendar window follow timestamp changes.
3234 When a timestamp is modified and the calendar window is visible, it will be
3235 moved to the new date."
3236 :group 'org-time
3237 :type 'boolean)
3239 (defgroup org-tags nil
3240 "Options concerning tags in Org-mode."
3241 :tag "Org Tags"
3242 :group 'org)
3244 (defcustom org-tag-alist nil
3245 "List of tags allowed in Org-mode files.
3246 When this list is nil, Org-mode will base TAG input on what is already in the
3247 buffer.
3248 The value of this variable is an alist, the car of each entry must be a
3249 keyword as a string, the cdr may be a character that is used to select
3250 that tag through the fast-tag-selection interface.
3251 See the manual for details."
3252 :group 'org-tags
3253 :type '(repeat
3254 (choice
3255 (cons (string :tag "Tag name")
3256 (character :tag "Access char"))
3257 (list :tag "Start radio group"
3258 (const :startgroup)
3259 (option (string :tag "Group description")))
3260 (list :tag "Group tags delimiter"
3261 (const :grouptags))
3262 (list :tag "End radio group"
3263 (const :endgroup)
3264 (option (string :tag "Group description")))
3265 (const :tag "New line" (:newline)))))
3267 (defcustom org-tag-persistent-alist nil
3268 "List of tags that will always appear in all Org-mode files.
3269 This is in addition to any in buffer settings or customizations
3270 of `org-tag-alist'.
3271 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3272 The value of this variable is an alist, the car of each entry must be a
3273 keyword as a string, the cdr may be a character that is used to select
3274 that tag through the fast-tag-selection interface.
3275 See the manual for details.
3276 To disable these tags on a per-file basis, insert anywhere in the file:
3277 #+STARTUP: noptag"
3278 :group 'org-tags
3279 :type '(repeat
3280 (choice
3281 (cons (string :tag "Tag name")
3282 (character :tag "Access char"))
3283 (const :tag "Start radio group" (:startgroup))
3284 (const :tag "Group tags delimiter" (:grouptags))
3285 (const :tag "End radio group" (:endgroup))
3286 (const :tag "New line" (:newline)))))
3288 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3289 "If non-nil, always offer completion for all tags of all agenda files.
3290 Instead of customizing this variable directly, you might want to
3291 set it locally for capture buffers, because there no list of
3292 tags in that file can be created dynamically (there are none).
3294 (add-hook 'org-capture-mode-hook
3295 (lambda ()
3296 (set (make-local-variable
3297 'org-complete-tags-always-offer-all-agenda-tags)
3298 t)))"
3299 :group 'org-tags
3300 :version "24.1"
3301 :type 'boolean)
3303 (defvar org-file-tags nil
3304 "List of tags that can be inherited by all entries in the file.
3305 The tags will be inherited if the variable `org-use-tag-inheritance'
3306 says they should be.
3307 This variable is populated from #+FILETAGS lines.")
3309 (defcustom org-use-fast-tag-selection 'auto
3310 "Non-nil means use fast tag selection scheme.
3311 This is a special interface to select and deselect tags with single keys.
3312 When nil, fast selection is never used.
3313 When the symbol `auto', fast selection is used if and only if selection
3314 characters for tags have been configured, either through the variable
3315 `org-tag-alist' or through a #+TAGS line in the buffer.
3316 When t, fast selection is always used and selection keys are assigned
3317 automatically if necessary."
3318 :group 'org-tags
3319 :type '(choice
3320 (const :tag "Always" t)
3321 (const :tag "Never" nil)
3322 (const :tag "When selection characters are configured" auto)))
3324 (defcustom org-fast-tag-selection-single-key nil
3325 "Non-nil means fast tag selection exits after first change.
3326 When nil, you have to press RET to exit it.
3327 During fast tag selection, you can toggle this flag with `C-c'.
3328 This variable can also have the value `expert'. In this case, the window
3329 displaying the tags menu is not even shown, until you press C-c again."
3330 :group 'org-tags
3331 :type '(choice
3332 (const :tag "No" nil)
3333 (const :tag "Yes" t)
3334 (const :tag "Expert" expert)))
3336 (defvar org-fast-tag-selection-include-todo nil
3337 "Non-nil means fast tags selection interface will also offer TODO states.
3338 This is an undocumented feature, you should not rely on it.")
3340 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3341 "The column to which tags should be indented in a headline.
3342 If this number is positive, it specifies the column. If it is negative,
3343 it means that the tags should be flushright to that column. For example,
3344 -80 works well for a normal 80 character screen.
3345 When 0, place tags directly after headline text, with only one space in
3346 between."
3347 :group 'org-tags
3348 :type 'integer)
3350 (defcustom org-auto-align-tags t
3351 "Non-nil keeps tags aligned when modifying headlines.
3352 Some operations (i.e. demoting) change the length of a headline and
3353 therefore shift the tags around. With this option turned on, after
3354 each such operation the tags are again aligned to `org-tags-column'."
3355 :group 'org-tags
3356 :type 'boolean)
3358 (defcustom org-use-tag-inheritance t
3359 "Non-nil means tags in levels apply also for sublevels.
3360 When nil, only the tags directly given in a specific line apply there.
3361 This may also be a list of tags that should be inherited, or a regexp that
3362 matches tags that should be inherited. Additional control is possible
3363 with the variable `org-tags-exclude-from-inheritance' which gives an
3364 explicit list of tags to be excluded from inheritance, even if the value of
3365 `org-use-tag-inheritance' would select it for inheritance.
3367 If this option is t, a match early-on in a tree can lead to a large
3368 number of matches in the subtree when constructing the agenda or creating
3369 a sparse tree. If you only want to see the first match in a tree during
3370 a search, check out the variable `org-tags-match-list-sublevels'."
3371 :group 'org-tags
3372 :type '(choice
3373 (const :tag "Not" nil)
3374 (const :tag "Always" t)
3375 (repeat :tag "Specific tags" (string :tag "Tag"))
3376 (regexp :tag "Tags matched by regexp")))
3378 (defcustom org-tags-exclude-from-inheritance nil
3379 "List of tags that should never be inherited.
3380 This is a way to exclude a few tags from inheritance. For way to do
3381 the opposite, to actively allow inheritance for selected tags,
3382 see the variable `org-use-tag-inheritance'."
3383 :group 'org-tags
3384 :type '(repeat (string :tag "Tag")))
3386 (defun org-tag-inherit-p (tag)
3387 "Check if TAG is one that should be inherited."
3388 (cond
3389 ((member tag org-tags-exclude-from-inheritance) nil)
3390 ((eq org-use-tag-inheritance t) t)
3391 ((not org-use-tag-inheritance) nil)
3392 ((stringp org-use-tag-inheritance)
3393 (string-match org-use-tag-inheritance tag))
3394 ((listp org-use-tag-inheritance)
3395 (member tag org-use-tag-inheritance))
3396 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3398 (defcustom org-tags-match-list-sublevels t
3399 "Non-nil means list also sublevels of headlines matching a search.
3400 This variable applies to tags/property searches, and also to stuck
3401 projects because this search is based on a tags match as well.
3403 When set to the symbol `indented', sublevels are indented with
3404 leading dots.
3406 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3407 the sublevels of a headline matching a tag search often also match
3408 the same search. Listing all of them can create very long lists.
3409 Setting this variable to nil causes subtrees of a match to be skipped.
3411 This variable is semi-obsolete and probably should always be true. It
3412 is better to limit inheritance to certain tags using the variables
3413 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3414 :group 'org-tags
3415 :type '(choice
3416 (const :tag "No, don't list them" nil)
3417 (const :tag "Yes, do list them" t)
3418 (const :tag "List them, indented with leading dots" indented)))
3420 (defcustom org-tags-sort-function nil
3421 "When set, tags are sorted using this function as a comparator."
3422 :group 'org-tags
3423 :type '(choice
3424 (const :tag "No sorting" nil)
3425 (const :tag "Alphabetical" string<)
3426 (const :tag "Reverse alphabetical" string>)
3427 (function :tag "Custom function" nil)))
3429 (defvar org-tags-history nil
3430 "History of minibuffer reads for tags.")
3431 (defvar org-last-tags-completion-table nil
3432 "The last used completion table for tags.")
3433 (defvar org-after-tags-change-hook nil
3434 "Hook that is run after the tags in a line have changed.")
3436 (defgroup org-properties nil
3437 "Options concerning properties in Org-mode."
3438 :tag "Org Properties"
3439 :group 'org)
3441 (defcustom org-property-format "%-10s %s"
3442 "How property key/value pairs should be formatted by `indent-line'.
3443 When `indent-line' hits a property definition, it will format the line
3444 according to this format, mainly to make sure that the values are
3445 lined-up with respect to each other."
3446 :group 'org-properties
3447 :type 'string)
3449 (defcustom org-properties-postprocess-alist nil
3450 "Alist of properties and functions to adjust inserted values.
3451 Elements of this alist must be of the form
3453 ([string] [function])
3455 where [string] must be a property name and [function] must be a
3456 lambda expression: this lambda expression must take one argument,
3457 the value to adjust, and return the new value as a string.
3459 For example, this element will allow the property \"Remaining\"
3460 to be updated wrt the relation between the \"Effort\" property
3461 and the clock summary:
3463 ((\"Remaining\" (lambda(value)
3464 (let ((clocksum (org-clock-sum-current-item))
3465 (effort (org-duration-string-to-minutes
3466 (org-entry-get (point) \"Effort\"))))
3467 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3468 :group 'org-properties
3469 :version "24.1"
3470 :type '(alist :key-type (string :tag "Property")
3471 :value-type (function :tag "Function")))
3473 (defcustom org-use-property-inheritance nil
3474 "Non-nil means properties apply also for sublevels.
3476 This setting is chiefly used during property searches. Turning it on can
3477 cause significant overhead when doing a search, which is why it is not
3478 on by default.
3480 When nil, only the properties directly given in the current entry count.
3481 When t, every property is inherited. The value may also be a list of
3482 properties that should have inheritance, or a regular expression matching
3483 properties that should be inherited.
3485 However, note that some special properties use inheritance under special
3486 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3487 and the properties ending in \"_ALL\" when they are used as descriptor
3488 for valid values of a property.
3490 Note for programmers:
3491 When querying an entry with `org-entry-get', you can control if inheritance
3492 should be used. By default, `org-entry-get' looks only at the local
3493 properties. You can request inheritance by setting the inherit argument
3494 to t (to force inheritance) or to `selective' (to respect the setting
3495 in this variable)."
3496 :group 'org-properties
3497 :type '(choice
3498 (const :tag "Not" nil)
3499 (const :tag "Always" t)
3500 (repeat :tag "Specific properties" (string :tag "Property"))
3501 (regexp :tag "Properties matched by regexp")))
3503 (defun org-property-inherit-p (property)
3504 "Check if PROPERTY is one that should be inherited."
3505 (cond
3506 ((eq org-use-property-inheritance t) t)
3507 ((not org-use-property-inheritance) nil)
3508 ((stringp org-use-property-inheritance)
3509 (string-match org-use-property-inheritance property))
3510 ((listp org-use-property-inheritance)
3511 (member property org-use-property-inheritance))
3512 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3514 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3515 "The default column format, if no other format has been defined.
3516 This variable can be set on the per-file basis by inserting a line
3518 #+COLUMNS: %25ITEM ....."
3519 :group 'org-properties
3520 :type 'string)
3522 (defcustom org-columns-ellipses ".."
3523 "The ellipses to be used when a field in column view is truncated.
3524 When this is the empty string, as many characters as possible are shown,
3525 but then there will be no visual indication that the field has been truncated.
3526 When this is a string of length N, the last N characters of a truncated
3527 field are replaced by this string. If the column is narrower than the
3528 ellipses string, only part of the ellipses string will be shown."
3529 :group 'org-properties
3530 :type 'string)
3532 (defcustom org-columns-modify-value-for-display-function nil
3533 "Function that modifies values for display in column view.
3534 For example, it can be used to cut out a certain part from a time stamp.
3535 The function must take 2 arguments:
3537 column-title The title of the column (*not* the property name)
3538 value The value that should be modified.
3540 The function should return the value that should be displayed,
3541 or nil if the normal value should be used."
3542 :group 'org-properties
3543 :type '(choice (const nil) (function)))
3545 (defcustom org-effort-property "Effort"
3546 "The property that is being used to keep track of effort estimates.
3547 Effort estimates given in this property need to have the format H:MM."
3548 :group 'org-properties
3549 :group 'org-progress
3550 :type '(string :tag "Property"))
3552 (defconst org-global-properties-fixed
3553 '(("VISIBILITY_ALL" . "folded children content all")
3554 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3555 "List of property/value pairs that can be inherited by any entry.
3557 These are fixed values, for the preset properties. The user variable
3558 that can be used to add to this list is `org-global-properties'.
3560 The entries in this list are cons cells where the car is a property
3561 name and cdr is a string with the value. If the value represents
3562 multiple items like an \"_ALL\" property, separate the items by
3563 spaces.")
3565 (defcustom org-global-properties nil
3566 "List of property/value pairs that can be inherited by any entry.
3568 This list will be combined with the constant `org-global-properties-fixed'.
3570 The entries in this list are cons cells where the car is a property
3571 name and cdr is a string with the value.
3573 You can set buffer-local values for the same purpose in the variable
3574 `org-file-properties' this by adding lines like
3576 #+PROPERTY: NAME VALUE"
3577 :group 'org-properties
3578 :type '(repeat
3579 (cons (string :tag "Property")
3580 (string :tag "Value"))))
3582 (defvar org-file-properties nil
3583 "List of property/value pairs that can be inherited by any entry.
3584 Valid for the current buffer.
3585 This variable is populated from #+PROPERTY lines.")
3586 (make-variable-buffer-local 'org-file-properties)
3588 (defgroup org-agenda nil
3589 "Options concerning agenda views in Org-mode."
3590 :tag "Org Agenda"
3591 :group 'org)
3593 (defvar org-category nil
3594 "Variable used by org files to set a category for agenda display.
3595 Such files should use a file variable to set it, for example
3597 # -*- mode: org; org-category: \"ELisp\"
3599 or contain a special line
3601 #+CATEGORY: ELisp
3603 If the file does not specify a category, then file's base name
3604 is used instead.")
3605 (make-variable-buffer-local 'org-category)
3606 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3608 (defcustom org-agenda-files nil
3609 "The files to be used for agenda display.
3610 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3611 \\[org-remove-file]. You can also use customize to edit the list.
3613 If an entry is a directory, all files in that directory that are matched by
3614 `org-agenda-file-regexp' will be part of the file list.
3616 If the value of the variable is not a list but a single file name, then
3617 the list of agenda files is actually stored and maintained in that file, one
3618 agenda file per line. In this file paths can be given relative to
3619 `org-directory'. Tilde expansion and environment variable substitution
3620 are also made."
3621 :group 'org-agenda
3622 :type '(choice
3623 (repeat :tag "List of files and directories" file)
3624 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3626 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3627 "Regular expression to match files for `org-agenda-files'.
3628 If any element in the list in that variable contains a directory instead
3629 of a normal file, all files in that directory that are matched by this
3630 regular expression will be included."
3631 :group 'org-agenda
3632 :type 'regexp)
3634 (defcustom org-agenda-text-search-extra-files nil
3635 "List of extra files to be searched by text search commands.
3636 These files will be searched in addition to the agenda files by the
3637 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3638 Note that these files will only be searched for text search commands,
3639 not for the other agenda views like todo lists, tag searches or the weekly
3640 agenda. This variable is intended to list notes and possibly archive files
3641 that should also be searched by these two commands.
3642 In fact, if the first element in the list is the symbol `agenda-archives',
3643 then all archive files of all agenda files will be added to the search
3644 scope."
3645 :group 'org-agenda
3646 :type '(set :greedy t
3647 (const :tag "Agenda Archives" agenda-archives)
3648 (repeat :inline t (file))))
3650 (org-defvaralias 'org-agenda-multi-occur-extra-files
3651 'org-agenda-text-search-extra-files)
3653 (defcustom org-agenda-skip-unavailable-files nil
3654 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3655 A nil value means to remove them, after a query, from the list."
3656 :group 'org-agenda
3657 :type 'boolean)
3659 (defcustom org-calendar-to-agenda-key [?c]
3660 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3661 The command `org-calendar-goto-agenda' will be bound to this key. The
3662 default is the character `c' because then `c' can be used to switch back and
3663 forth between agenda and calendar."
3664 :group 'org-agenda
3665 :type 'sexp)
3667 (defcustom org-calendar-insert-diary-entry-key [?i]
3668 "The key to be installed in `calendar-mode-map' for adding diary entries.
3669 This option is irrelevant until `org-agenda-diary-file' has been configured
3670 to point to an Org-mode file. When that is the case, the command
3671 `org-agenda-diary-entry' will be bound to the key given here, by default
3672 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3673 if you want to continue doing this, you need to change this to a different
3674 key."
3675 :group 'org-agenda
3676 :type 'sexp)
3678 (defcustom org-agenda-diary-file 'diary-file
3679 "File to which to add new entries with the `i' key in agenda and calendar.
3680 When this is the symbol `diary-file', the functionality in the Emacs
3681 calendar will be used to add entries to the `diary-file'. But when this
3682 points to a file, `org-agenda-diary-entry' will be used instead."
3683 :group 'org-agenda
3684 :type '(choice
3685 (const :tag "The standard Emacs diary file" diary-file)
3686 (file :tag "Special Org file diary entries")))
3688 (eval-after-load "calendar"
3689 '(progn
3690 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3691 'org-calendar-goto-agenda)
3692 (add-hook 'calendar-mode-hook
3693 (lambda ()
3694 (unless (eq org-agenda-diary-file 'diary-file)
3695 (define-key calendar-mode-map
3696 org-calendar-insert-diary-entry-key
3697 'org-agenda-diary-entry))))))
3699 (defgroup org-latex nil
3700 "Options for embedding LaTeX code into Org-mode."
3701 :tag "Org LaTeX"
3702 :group 'org)
3704 (defcustom org-format-latex-options
3705 '(:foreground default :background default :scale 1.0
3706 :html-foreground "Black" :html-background "Transparent"
3707 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3708 "Options for creating images from LaTeX fragments.
3709 This is a property list with the following properties:
3710 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3711 `default' means use the foreground of the default face.
3712 `auto' means use the foreground from the text face.
3713 :background the background color, or \"Transparent\".
3714 `default' means use the background of the default face.
3715 `auto' means use the background from the text face.
3716 :scale a scaling factor for the size of the images, to get more pixels
3717 :html-foreground, :html-background, :html-scale
3718 the same numbers for HTML export.
3719 :matchers a list indicating which matchers should be used to
3720 find LaTeX fragments. Valid members of this list are:
3721 \"begin\" find environments
3722 \"$1\" find single characters surrounded by $.$
3723 \"$\" find math expressions surrounded by $...$
3724 \"$$\" find math expressions surrounded by $$....$$
3725 \"\\(\" find math expressions surrounded by \\(...\\)
3726 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3727 :group 'org-latex
3728 :type 'plist)
3730 (defcustom org-format-latex-signal-error t
3731 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3732 When nil, just push out a message."
3733 :group 'org-latex
3734 :version "24.1"
3735 :type 'boolean)
3737 (defcustom org-latex-to-mathml-jar-file nil
3738 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3739 Use this to specify additional executable file say a jar file.
3741 When using MathToWeb as the converter, specify the full-path to
3742 your mathtoweb.jar file."
3743 :group 'org-latex
3744 :version "24.1"
3745 :type '(choice
3746 (const :tag "None" nil)
3747 (file :tag "JAR file" :must-match t)))
3749 (defcustom org-latex-to-mathml-convert-command nil
3750 "Command to convert LaTeX fragments to MathML.
3751 Replace format-specifiers in the command as noted below and use
3752 `shell-command' to convert LaTeX to MathML.
3753 %j: Executable file in fully expanded form as specified by
3754 `org-latex-to-mathml-jar-file'.
3755 %I: Input LaTeX file in fully expanded form
3756 %o: Output MathML file
3757 This command is used by `org-create-math-formula'.
3759 When using MathToWeb as the converter, set this to
3760 \"java -jar %j -unicode -force -df %o %I\"."
3761 :group 'org-latex
3762 :version "24.1"
3763 :type '(choice
3764 (const :tag "None" nil)
3765 (string :tag "\nShell command")))
3767 (defcustom org-latex-create-formula-image-program 'dvipng
3768 "Program to convert LaTeX fragments with.
3770 dvipng Process the LaTeX fragments to dvi file, then convert
3771 dvi files to png files using dvipng.
3772 This will also include processing of non-math environments.
3773 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3774 to convert pdf files to png files"
3775 :group 'org-latex
3776 :version "24.1"
3777 :type '(choice
3778 (const :tag "dvipng" dvipng)
3779 (const :tag "imagemagick" imagemagick)))
3781 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
3782 "Path to store latex preview images.
3783 A relative path here creates many directories relative to the
3784 processed org files paths. An absolute path puts all preview
3785 images at the same place."
3786 :group 'org-latex
3787 :version "24.3"
3788 :type 'string)
3790 (defun org-format-latex-mathml-available-p ()
3791 "Return t if `org-latex-to-mathml-convert-command' is usable."
3792 (save-match-data
3793 (when (and (boundp 'org-latex-to-mathml-convert-command)
3794 org-latex-to-mathml-convert-command)
3795 (let ((executable (car (split-string
3796 org-latex-to-mathml-convert-command))))
3797 (when (executable-find executable)
3798 (if (string-match
3799 "%j" org-latex-to-mathml-convert-command)
3800 (file-readable-p org-latex-to-mathml-jar-file)
3801 t))))))
3803 (defcustom org-format-latex-header "\\documentclass{article}
3804 \\usepackage[usenames]{color}
3805 \[PACKAGES]
3806 \[DEFAULT-PACKAGES]
3807 \\pagestyle{empty} % do not remove
3808 % The settings below are copied from fullpage.sty
3809 \\setlength{\\textwidth}{\\paperwidth}
3810 \\addtolength{\\textwidth}{-3cm}
3811 \\setlength{\\oddsidemargin}{1.5cm}
3812 \\addtolength{\\oddsidemargin}{-2.54cm}
3813 \\setlength{\\evensidemargin}{\\oddsidemargin}
3814 \\setlength{\\textheight}{\\paperheight}
3815 \\addtolength{\\textheight}{-\\headheight}
3816 \\addtolength{\\textheight}{-\\headsep}
3817 \\addtolength{\\textheight}{-\\footskip}
3818 \\addtolength{\\textheight}{-3cm}
3819 \\setlength{\\topmargin}{1.5cm}
3820 \\addtolength{\\topmargin}{-2.54cm}"
3821 "The document header used for processing LaTeX fragments.
3822 It is imperative that this header make sure that no page number
3823 appears on the page. The package defined in the variables
3824 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3825 will either replace the placeholder \"[PACKAGES]\" in this
3826 header, or they will be appended."
3827 :group 'org-latex
3828 :type 'string)
3830 (defun org-set-packages-alist (var val)
3831 "Set the packages alist and make sure it has 3 elements per entry."
3832 (set var (mapcar (lambda (x)
3833 (if (and (consp x) (= (length x) 2))
3834 (list (car x) (nth 1 x) t)
3836 val)))
3838 (defun org-get-packages-alist (var)
3839 "Get the packages alist and make sure it has 3 elements per entry."
3840 (mapcar (lambda (x)
3841 (if (and (consp x) (= (length x) 2))
3842 (list (car x) (nth 1 x) t)
3844 (default-value var)))
3846 (defcustom org-latex-default-packages-alist
3847 '(("AUTO" "inputenc" t)
3848 ("T1" "fontenc" t)
3849 ("" "fixltx2e" nil)
3850 ("" "graphicx" t)
3851 ("" "longtable" nil)
3852 ("" "float" nil)
3853 ("" "wrapfig" nil)
3854 ("" "rotating" nil)
3855 ("normalem" "ulem" t)
3856 ("" "amsmath" t)
3857 ("" "textcomp" t)
3858 ("" "marvosym" t)
3859 ("" "wasysym" t)
3860 ("" "amssymb" t)
3861 ("" "hyperref" nil)
3862 "\\tolerance=1000")
3863 "Alist of default packages to be inserted in the header.
3865 Change this only if one of the packages here causes an
3866 incompatibility with another package you are using.
3868 The packages in this list are needed by one part or another of
3869 Org mode to function properly:
3871 - inputenc, fontenc: for basic font and character selection
3872 - fixltx2e: Important patches of LaTeX itself
3873 - graphicx: for including images
3874 - longtable: For multipage tables
3875 - float, wrapfig: for figure placement
3876 - rotating: for sideways figures and tables
3877 - ulem: for underline and strike-through
3878 - amsmath: for subscript and superscript and math environments
3879 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
3880 for interpreting the entities in `org-entities'. You can skip
3881 some of these packages if you don't use any of their symbols.
3882 - hyperref: for cross references
3884 Therefore you should not modify this variable unless you know
3885 what you are doing. The one reason to change it anyway is that
3886 you might be loading some other package that conflicts with one
3887 of the default packages. Each element is either a cell or
3888 a string.
3890 A cell is of the format:
3892 \( \"options\" \"package\" SNIPPET-FLAG).
3894 If SNIPPET-FLAG is non-nil, the package also needs to be included
3895 when compiling LaTeX snippets into images for inclusion into
3896 non-LaTeX output.
3898 A string will be inserted as-is in the header of the document."
3899 :group 'org-latex
3900 :group 'org-export-latex
3901 :set 'org-set-packages-alist
3902 :get 'org-get-packages-alist
3903 :version "24.1"
3904 :type '(repeat
3905 (choice
3906 (list :tag "options/package pair"
3907 (string :tag "options")
3908 (string :tag "package")
3909 (boolean :tag "Snippet"))
3910 (string :tag "A line of LaTeX"))))
3912 (defcustom org-latex-packages-alist nil
3913 "Alist of packages to be inserted in every LaTeX header.
3915 These will be inserted after `org-latex-default-packages-alist'.
3916 Each element is either a cell or a string.
3918 A cell is of the format:
3920 \(\"options\" \"package\" SNIPPET-FLAG)
3922 SNIPPET-FLAG, when non-nil, indicates that this package is also
3923 needed when turning LaTeX snippets into images for inclusion into
3924 non-LaTeX output.
3926 A string will be inserted as-is in the header of the document.
3928 Make sure that you only list packages here which:
3930 - you want in every file;
3931 - do not conflict with the setup in `org-format-latex-header';
3932 - do not conflict with the default packages in
3933 `org-latex-default-packages-alist'."
3934 :group 'org-latex
3935 :group 'org-export-latex
3936 :set 'org-set-packages-alist
3937 :get 'org-get-packages-alist
3938 :type '(repeat
3939 (choice
3940 (list :tag "options/package pair"
3941 (string :tag "options")
3942 (string :tag "package")
3943 (boolean :tag "Snippet"))
3944 (string :tag "A line of LaTeX"))))
3946 (defgroup org-appearance nil
3947 "Settings for Org-mode appearance."
3948 :tag "Org Appearance"
3949 :group 'org)
3951 (defcustom org-level-color-stars-only nil
3952 "Non-nil means fontify only the stars in each headline.
3953 When nil, the entire headline is fontified.
3954 Changing it requires restart of `font-lock-mode' to become effective
3955 also in regions already fontified."
3956 :group 'org-appearance
3957 :type 'boolean)
3959 (defcustom org-hide-leading-stars nil
3960 "Non-nil means hide the first N-1 stars in a headline.
3961 This works by using the face `org-hide' for these stars. This
3962 face is white for a light background, and black for a dark
3963 background. You may have to customize the face `org-hide' to
3964 make this work.
3965 Changing it requires restart of `font-lock-mode' to become effective
3966 also in regions already fontified.
3967 You may also set this on a per-file basis by adding one of the following
3968 lines to the buffer:
3970 #+STARTUP: hidestars
3971 #+STARTUP: showstars"
3972 :group 'org-appearance
3973 :type 'boolean)
3975 (defcustom org-hidden-keywords nil
3976 "List of symbols corresponding to keywords to be hidden the org buffer.
3977 For example, a value '(title) for this list will make the document's title
3978 appear in the buffer without the initial #+TITLE: keyword."
3979 :group 'org-appearance
3980 :version "24.1"
3981 :type '(set (const :tag "#+AUTHOR" author)
3982 (const :tag "#+DATE" date)
3983 (const :tag "#+EMAIL" email)
3984 (const :tag "#+TITLE" title)))
3986 (defcustom org-custom-properties nil
3987 "List of properties (as strings) with a special meaning.
3988 The default use of these custom properties is to let the user
3989 hide them with `org-toggle-custom-properties-visibility'."
3990 :group 'org-properties
3991 :group 'org-appearance
3992 :version "24.3"
3993 :type '(repeat (string :tag "Property Name")))
3995 (defcustom org-fontify-done-headline nil
3996 "Non-nil means change the face of a headline if it is marked DONE.
3997 Normally, only the TODO/DONE keyword indicates the state of a headline.
3998 When this is non-nil, the headline after the keyword is set to the
3999 `org-headline-done' as an additional indication."
4000 :group 'org-appearance
4001 :type 'boolean)
4003 (defcustom org-fontify-emphasized-text t
4004 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4005 Changing this variable requires a restart of Emacs to take effect."
4006 :group 'org-appearance
4007 :type 'boolean)
4009 (defcustom org-fontify-whole-heading-line nil
4010 "Non-nil means fontify the whole line for headings.
4011 This is useful when setting a background color for the
4012 org-level-* faces."
4013 :group 'org-appearance
4014 :type 'boolean)
4016 (defcustom org-highlight-latex-and-related nil
4017 "Non-nil means highlight LaTeX related syntax in the buffer.
4018 When non nil, the value should be a list containing any of the
4019 following symbols:
4020 `latex' Highlight LaTeX snippets and environments.
4021 `script' Highlight subscript and superscript.
4022 `entities' Highlight entities."
4023 :group 'org-appearance
4024 :version "24.4"
4025 :package-version '(Org . "8.0")
4026 :type '(choice
4027 (const :tag "No highlighting" nil)
4028 (set :greedy t :tag "Highlight"
4029 (const :tag "LaTeX snippets and environments" latex)
4030 (const :tag "Subscript and superscript" script)
4031 (const :tag "Entities" entities))))
4033 (defcustom org-hide-emphasis-markers nil
4034 "Non-nil mean font-lock should hide the emphasis marker characters."
4035 :group 'org-appearance
4036 :type 'boolean)
4038 (defcustom org-pretty-entities nil
4039 "Non-nil means show entities as UTF8 characters.
4040 When nil, the \\name form remains in the buffer."
4041 :group 'org-appearance
4042 :version "24.1"
4043 :type 'boolean)
4045 (defcustom org-pretty-entities-include-sub-superscripts t
4046 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4047 :group 'org-appearance
4048 :version "24.1"
4049 :type 'boolean)
4051 (defvar org-emph-re nil
4052 "Regular expression for matching emphasis.
4053 After a match, the match groups contain these elements:
4054 0 The match of the full regular expression, including the characters
4055 before and after the proper match
4056 1 The character before the proper match, or empty at beginning of line
4057 2 The proper match, including the leading and trailing markers
4058 3 The leading marker like * or /, indicating the type of highlighting
4059 4 The text between the emphasis markers, not including the markers
4060 5 The character after the match, empty at the end of a line")
4061 (defvar org-verbatim-re nil
4062 "Regular expression for matching verbatim text.")
4063 (defvar org-emphasis-regexp-components) ; defined just below
4064 (defvar org-emphasis-alist) ; defined just below
4065 (defun org-set-emph-re (var val)
4066 "Set variable and compute the emphasis regular expression."
4067 (set var val)
4068 (when (and (boundp 'org-emphasis-alist)
4069 (boundp 'org-emphasis-regexp-components)
4070 org-emphasis-alist org-emphasis-regexp-components)
4071 (let* ((e org-emphasis-regexp-components)
4072 (pre (car e))
4073 (post (nth 1 e))
4074 (border (nth 2 e))
4075 (body (nth 3 e))
4076 (nl (nth 4 e))
4077 (body1 (concat body "*?"))
4078 (markers (mapconcat 'car org-emphasis-alist ""))
4079 (vmarkers (mapconcat
4080 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4081 org-emphasis-alist "")))
4082 ;; make sure special characters appear at the right position in the class
4083 (if (string-match "\\^" markers)
4084 (setq markers (concat (replace-match "" t t markers) "^")))
4085 (if (string-match "-" markers)
4086 (setq markers (concat (replace-match "" t t markers) "-")))
4087 (if (string-match "\\^" vmarkers)
4088 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4089 (if (string-match "-" vmarkers)
4090 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4091 (if (> nl 0)
4092 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4093 (int-to-string nl) "\\}")))
4094 ;; Make the regexp
4095 (setq org-emph-re
4096 (concat "\\([" pre "]\\|^\\)"
4097 "\\("
4098 "\\([" markers "]\\)"
4099 "\\("
4100 "[^" border "]\\|"
4101 "[^" border "]"
4102 body1
4103 "[^" border "]"
4104 "\\)"
4105 "\\3\\)"
4106 "\\([" post "]\\|$\\)"))
4107 (setq org-verbatim-re
4108 (concat "\\([" pre "]\\|^\\)"
4109 "\\("
4110 "\\([" vmarkers "]\\)"
4111 "\\("
4112 "[^" border "]\\|"
4113 "[^" border "]"
4114 body1
4115 "[^" border "]"
4116 "\\)"
4117 "\\3\\)"
4118 "\\([" post "]\\|$\\)")))))
4120 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4121 ;; set this option proved cumbersome. See this message/thread:
4122 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4123 (defvar org-emphasis-regexp-components
4124 '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
4125 "Components used to build the regular expression for emphasis.
4126 This is a list with five entries. Terminology: In an emphasis string
4127 like \" *strong word* \", we call the initial space PREMATCH, the final
4128 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4129 and \"trong wor\" is the body. The different components in this variable
4130 specify what is allowed/forbidden in each part:
4132 pre Chars allowed as prematch. Beginning of line will be allowed too.
4133 post Chars allowed as postmatch. End of line will be allowed too.
4134 border The chars *forbidden* as border characters.
4135 body-regexp A regexp like \".\" to match a body character. Don't use
4136 non-shy groups here, and don't allow newline here.
4137 newline The maximum number of newlines allowed in an emphasis exp.
4139 You need to reload Org or to restart Emacs after customizing this.")
4141 (defcustom org-emphasis-alist
4142 `(("*" bold)
4143 ("/" italic)
4144 ("_" underline)
4145 ("=" org-verbatim verbatim)
4146 ("~" org-code verbatim)
4147 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4148 "Alist of characters and faces to emphasize text.
4149 Text starting and ending with a special character will be emphasized,
4150 for example *bold*, _underlined_ and /italic/. This variable sets the
4151 marker characters and the face to be used by font-lock for highlighting
4152 in Org-mode Emacs buffers.
4154 You need to reload Org or to restart Emacs after customizing this."
4155 :group 'org-appearance
4156 :set 'org-set-emph-re
4157 :version "24.4"
4158 :package-version '(Org . "8.0")
4159 :type '(repeat
4160 (list
4161 (string :tag "Marker character")
4162 (choice
4163 (face :tag "Font-lock-face")
4164 (plist :tag "Face property list"))
4165 (option (const verbatim)))))
4167 (defvar org-protecting-blocks
4168 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4169 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4170 This is needed for font-lock setup.")
4172 ;;; Miscellaneous options
4174 (defgroup org-completion nil
4175 "Completion in Org-mode."
4176 :tag "Org Completion"
4177 :group 'org)
4179 (defcustom org-completion-use-ido nil
4180 "Non-nil means use ido completion wherever possible.
4181 Note that `ido-mode' must be active for this variable to be relevant.
4182 If you decide to turn this variable on, you might well want to turn off
4183 `org-outline-path-complete-in-steps'.
4184 See also `org-completion-use-iswitchb'."
4185 :group 'org-completion
4186 :type 'boolean)
4188 (defcustom org-completion-use-iswitchb nil
4189 "Non-nil means use iswitchb completion wherever possible.
4190 Note that `iswitchb-mode' must be active for this variable to be relevant.
4191 If you decide to turn this variable on, you might well want to turn off
4192 `org-outline-path-complete-in-steps'.
4193 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4194 :group 'org-completion
4195 :type 'boolean)
4197 (defcustom org-completion-fallback-command 'hippie-expand
4198 "The expansion command called by \\[pcomplete] in normal context.
4199 Normal means, no org-mode-specific context."
4200 :group 'org-completion
4201 :type 'function)
4203 ;;; Functions and variables from their packages
4204 ;; Declared here to avoid compiler warnings
4206 ;; XEmacs only
4207 (defvar outline-mode-menu-heading)
4208 (defvar outline-mode-menu-show)
4209 (defvar outline-mode-menu-hide)
4210 (defvar zmacs-regions) ; XEmacs regions
4212 ;; Emacs only
4213 (defvar mark-active)
4215 ;; Various packages
4216 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4217 (declare-function calendar-forward-day "cal-move" (arg))
4218 (declare-function calendar-goto-date "cal-move" (date))
4219 (declare-function calendar-goto-today "cal-move" ())
4220 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4221 (defvar calc-embedded-close-formula)
4222 (defvar calc-embedded-open-formula)
4223 (declare-function cdlatex-tab "ext:cdlatex" ())
4224 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4225 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4226 (defvar font-lock-unfontify-region-function)
4227 (declare-function iswitchb-read-buffer "iswitchb"
4228 (prompt &optional default require-match start matches-set))
4229 (defvar iswitchb-temp-buflist)
4230 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4231 (defvar org-agenda-tags-todo-honor-ignore-options)
4232 (declare-function org-agenda-skip "org-agenda" ())
4233 (declare-function
4234 org-agenda-format-item "org-agenda"
4235 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4236 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4237 (declare-function org-agenda-change-all-lines "org-agenda"
4238 (newhead hdmarker &optional fixface just-this))
4239 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4240 (declare-function org-agenda-maybe-redo "org-agenda" ())
4241 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4242 (beg end))
4243 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4244 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4245 "org-agenda" (&optional end))
4246 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4247 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4248 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4249 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4250 (declare-function org-indent-mode "org-indent" (&optional arg))
4251 (declare-function parse-time-string "parse-time" (string))
4252 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4253 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4254 (defvar remember-data-file)
4255 (defvar texmathp-why)
4256 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4257 (declare-function table--at-cell-p "table" (position &optional object at-column))
4259 (defvar org-latex-regexps)
4261 ;;; Autoload and prepare some org modules
4263 ;; Some table stuff that needs to be defined here, because it is used
4264 ;; by the functions setting up org-mode or checking for table context.
4266 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
4267 "Detect an org-type or table-type table.")
4268 (defconst org-table-line-regexp "^[ \t]*|"
4269 "Detect an org-type table line.")
4270 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
4271 "Detect an org-type table line.")
4272 (defconst org-table-hline-regexp "^[ \t]*|-"
4273 "Detect an org-type table hline.")
4274 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
4275 "Detect a table-type table hline.")
4276 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
4277 "Detect the first line outside a table when searching from within it.
4278 This works for both table types.")
4280 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
4281 "Detect a #+TBLFM line.")
4283 ;;;###autoload
4284 (defun turn-on-orgtbl ()
4285 "Unconditionally turn on `orgtbl-mode'."
4286 (require 'org-table)
4287 (orgtbl-mode 1))
4289 (defun org-at-table-p (&optional table-type)
4290 "Return t if the cursor is inside an org-type table.
4291 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4292 (if org-enable-table-editor
4293 (save-excursion
4294 (beginning-of-line 1)
4295 (looking-at (if table-type org-table-any-line-regexp
4296 org-table-line-regexp)))
4297 nil))
4298 (defsubst org-table-p () (org-at-table-p))
4300 (defun org-at-table.el-p ()
4301 "Return t if and only if we are at a table.el table."
4302 (and (org-at-table-p 'any)
4303 (save-excursion
4304 (goto-char (org-table-begin 'any))
4305 (looking-at org-table1-hline-regexp))))
4307 (defun org-table-recognize-table.el ()
4308 "If there is a table.el table nearby, recognize it and move into it."
4309 (if org-table-tab-recognizes-table.el
4310 (if (org-at-table.el-p)
4311 (progn
4312 (beginning-of-line 1)
4313 (if (looking-at org-table-dataline-regexp)
4315 (if (looking-at org-table1-hline-regexp)
4316 (progn
4317 (beginning-of-line 2)
4318 (if (looking-at org-table-any-border-regexp)
4319 (beginning-of-line -1)))))
4320 (if (re-search-forward "|" (org-table-end t) t)
4321 (progn
4322 (require 'table)
4323 (if (table--at-cell-p (point))
4325 (message "recognizing table.el table...")
4326 (table-recognize-table)
4327 (message "recognizing table.el table...done")))
4328 (error "This should not happen"))
4330 nil)
4331 nil))
4333 (defun org-at-table-hline-p ()
4334 "Return t if the cursor is inside a hline in a table."
4335 (if org-enable-table-editor
4336 (save-excursion
4337 (beginning-of-line 1)
4338 (looking-at org-table-hline-regexp))
4339 nil))
4341 (defun org-table-map-tables (function &optional quietly)
4342 "Apply FUNCTION to the start of all tables in the buffer."
4343 (save-excursion
4344 (save-restriction
4345 (widen)
4346 (goto-char (point-min))
4347 (while (re-search-forward org-table-any-line-regexp nil t)
4348 (unless quietly
4349 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4350 (beginning-of-line 1)
4351 (when (and (looking-at org-table-line-regexp)
4352 ;; Exclude tables in src/example/verbatim/clocktable blocks
4353 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4354 (save-excursion (funcall function))
4355 (or (looking-at org-table-line-regexp)
4356 (forward-char 1)))
4357 (re-search-forward org-table-any-border-regexp nil 1))))
4358 (unless quietly (message "Mapping tables: done")))
4360 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4361 (declare-function org-clock-update-mode-line "org-clock" ())
4362 (declare-function org-resolve-clocks "org-clock"
4363 (&optional also-non-dangling-p prompt last-valid))
4365 (defun org-at-TBLFM-p (&optional pos)
4366 "Return t when point (or POS) is in #+TBLFM line."
4367 (save-excursion
4368 (let ((pos pos)))
4369 (goto-char (or pos (point)))
4370 (beginning-of-line 1)
4371 (looking-at org-TBLFM-regexp)))
4373 (defvar org-clock-start-time)
4374 (defvar org-clock-marker (make-marker)
4375 "Marker recording the last clock-in.")
4376 (defvar org-clock-hd-marker (make-marker)
4377 "Marker recording the last clock-in, but the headline position.")
4378 (defvar org-clock-heading ""
4379 "The heading of the current clock entry.")
4380 (defun org-clock-is-active ()
4381 "Return the buffer where the clock is currently running.
4382 Return nil if no clock is running."
4383 (marker-buffer org-clock-marker))
4385 (defun org-check-running-clock ()
4386 "Check if the current buffer contains the running clock.
4387 If yes, offer to stop it and to save the buffer with the changes."
4388 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4389 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4390 (buffer-name))))
4391 (org-clock-out)
4392 (when (y-or-n-p "Save changed buffer?")
4393 (save-buffer))))
4395 (defun org-clocktable-try-shift (dir n)
4396 "Check if this line starts a clock table, if yes, shift the time block."
4397 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4398 (org-clocktable-shift dir n)))
4400 ;;;###autoload
4401 (defun org-clock-persistence-insinuate ()
4402 "Set up hooks for clock persistence."
4403 (require 'org-clock)
4404 (add-hook 'org-mode-hook 'org-clock-load)
4405 (add-hook 'kill-emacs-hook 'org-clock-save))
4407 (defgroup org-archive nil
4408 "Options concerning archiving in Org-mode."
4409 :tag "Org Archive"
4410 :group 'org-structure)
4412 (defcustom org-archive-location "%s_archive::"
4413 "The location where subtrees should be archived.
4415 The value of this variable is a string, consisting of two parts,
4416 separated by a double-colon. The first part is a filename and
4417 the second part is a headline.
4419 When the filename is omitted, archiving happens in the same file.
4420 %s in the filename will be replaced by the current file
4421 name (without the directory part). Archiving to a different file
4422 is useful to keep archived entries from contributing to the
4423 Org-mode Agenda.
4425 The archived entries will be filed as subtrees of the specified
4426 headline. When the headline is omitted, the subtrees are simply
4427 filed away at the end of the file, as top-level entries. Also in
4428 the heading you can use %s to represent the file name, this can be
4429 useful when using the same archive for a number of different files.
4431 Here are a few examples:
4432 \"%s_archive::\"
4433 If the current file is Projects.org, archive in file
4434 Projects.org_archive, as top-level trees. This is the default.
4436 \"::* Archived Tasks\"
4437 Archive in the current file, under the top-level headline
4438 \"* Archived Tasks\".
4440 \"~/org/archive.org::\"
4441 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4443 \"~/org/archive.org::* From %s\"
4444 Archive in file ~/org/archive.org (absolute path), under headlines
4445 \"From FILENAME\" where file name is the current file name.
4447 \"~/org/datetree.org::datetree/* Finished Tasks\"
4448 The \"datetree/\" string is special, signifying to archive
4449 items to the datetree. Items are placed in either the CLOSED
4450 date of the item, or the current date if there is no CLOSED date.
4451 The heading will be a subentry to the current date. There doesn't
4452 need to be a heading, but there always needs to be a slash after
4453 datetree. For example, to store archived items directly in the
4454 datetree, use \"~/org/datetree.org::datetree/\".
4456 \"basement::** Finished Tasks\"
4457 Archive in file ./basement (relative path), as level 3 trees
4458 below the level 2 heading \"** Finished Tasks\".
4460 You may set this option on a per-file basis by adding to the buffer a
4461 line like
4463 #+ARCHIVE: basement::** Finished Tasks
4465 You may also define it locally for a subtree by setting an ARCHIVE property
4466 in the entry. If such a property is found in an entry, or anywhere up
4467 the hierarchy, it will be used."
4468 :group 'org-archive
4469 :type 'string)
4471 (defcustom org-archive-tag "ARCHIVE"
4472 "The tag that marks a subtree as archived.
4473 An archived subtree does not open during visibility cycling, and does
4474 not contribute to the agenda listings.
4475 After changing this, font-lock must be restarted in the relevant buffers to
4476 get the proper fontification."
4477 :group 'org-archive
4478 :group 'org-keywords
4479 :type 'string)
4481 (defcustom org-agenda-skip-archived-trees t
4482 "Non-nil means the agenda will skip any items located in archived trees.
4483 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4484 variable is no longer recommended, you should leave it at the value t.
4485 Instead, use the key `v' to cycle the archives-mode in the agenda."
4486 :group 'org-archive
4487 :group 'org-agenda-skip
4488 :type 'boolean)
4490 (defcustom org-columns-skip-archived-trees t
4491 "Non-nil means ignore archived trees when creating column view."
4492 :group 'org-archive
4493 :group 'org-properties
4494 :type 'boolean)
4496 (defcustom org-cycle-open-archived-trees nil
4497 "Non-nil means `org-cycle' will open archived trees.
4498 An archived tree is a tree marked with the tag ARCHIVE.
4499 When nil, archived trees will stay folded. You can still open them with
4500 normal outline commands like `show-all', but not with the cycling commands."
4501 :group 'org-archive
4502 :group 'org-cycle
4503 :type 'boolean)
4505 (defcustom org-sparse-tree-open-archived-trees nil
4506 "Non-nil means sparse tree construction shows matches in archived trees.
4507 When nil, matches in these trees are highlighted, but the trees are kept in
4508 collapsed state."
4509 :group 'org-archive
4510 :group 'org-sparse-trees
4511 :type 'boolean)
4513 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4514 "The default date type when building a sparse tree.
4515 When this is nil, a date is a scheduled or a deadline timestamp.
4516 Otherwise, these types are allowed:
4518 all: all timestamps
4519 active: only active timestamps (<...>)
4520 inactive: only inactive timestamps (<...)
4521 scheduled: only scheduled timestamps
4522 deadline: only deadline timestamps"
4523 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4524 (const :tag "All timestamps" all)
4525 (const :tag "Only active timestamps" active)
4526 (const :tag "Only inactive timestamps" inactive)
4527 (const :tag "Only scheduled timestamps" scheduled)
4528 (const :tag "Only deadline timestamps" deadline)
4529 (const :tag "Only closed timestamps" closed))
4530 :version "24.3"
4531 :group 'org-sparse-trees)
4533 (defun org-cycle-hide-archived-subtrees (state)
4534 "Re-hide all archived subtrees after a visibility state change."
4535 (when (and (not org-cycle-open-archived-trees)
4536 (not (memq state '(overview folded))))
4537 (save-excursion
4538 (let* ((globalp (memq state '(contents all)))
4539 (beg (if globalp (point-min) (point)))
4540 (end (if globalp (point-max) (org-end-of-subtree t))))
4541 (org-hide-archived-subtrees beg end)
4542 (goto-char beg)
4543 (if (looking-at (concat ".*:" org-archive-tag ":"))
4544 (message "%s" (substitute-command-keys
4545 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4547 (defun org-force-cycle-archived ()
4548 "Cycle subtree even if it is archived."
4549 (interactive)
4550 (setq this-command 'org-cycle)
4551 (let ((org-cycle-open-archived-trees t))
4552 (call-interactively 'org-cycle)))
4554 (defun org-hide-archived-subtrees (beg end)
4555 "Re-hide all archived subtrees after a visibility state change."
4556 (save-excursion
4557 (let* ((re (concat ":" org-archive-tag ":")))
4558 (goto-char beg)
4559 (while (re-search-forward re end t)
4560 (when (org-at-heading-p)
4561 (org-flag-subtree t)
4562 (org-end-of-subtree t))))))
4564 (declare-function outline-end-of-heading "outline" ())
4565 (declare-function outline-flag-region "outline" (from to flag))
4566 (defun org-flag-subtree (flag)
4567 (save-excursion
4568 (org-back-to-heading t)
4569 (outline-end-of-heading)
4570 (outline-flag-region (point)
4571 (progn (org-end-of-subtree t) (point))
4572 flag)))
4574 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4576 ;; Declare Column View Code
4578 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4579 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4580 (declare-function org-columns-compute "org-colview" (property))
4582 ;; Declare ID code
4584 (declare-function org-id-store-link "org-id")
4585 (declare-function org-id-locations-load "org-id")
4586 (declare-function org-id-locations-save "org-id")
4587 (defvar org-id-track-globally)
4589 ;;; Variables for pre-computed regular expressions, all buffer local
4591 (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
4592 "Matches first line of a hidden block.")
4593 (make-variable-buffer-local 'org-drawer-regexp)
4594 (defvar org-todo-regexp nil
4595 "Matches any of the TODO state keywords.")
4596 (make-variable-buffer-local 'org-todo-regexp)
4597 (defvar org-not-done-regexp nil
4598 "Matches any of the TODO state keywords except the last one.")
4599 (make-variable-buffer-local 'org-not-done-regexp)
4600 (defvar org-not-done-heading-regexp nil
4601 "Matches a TODO headline that is not done.")
4602 (make-variable-buffer-local 'org-not-done-regexp)
4603 (defvar org-todo-line-regexp nil
4604 "Matches a headline and puts TODO state into group 2 if present.")
4605 (make-variable-buffer-local 'org-todo-line-regexp)
4606 (defvar org-complex-heading-regexp nil
4607 "Matches a headline and puts everything into groups:
4608 group 1: the stars
4609 group 2: The todo keyword, maybe
4610 group 3: Priority cookie
4611 group 4: True headline
4612 group 5: Tags")
4613 (make-variable-buffer-local 'org-complex-heading-regexp)
4614 (defvar org-complex-heading-regexp-format nil
4615 "Printf format to make regexp to match an exact headline.
4616 This regexp will match the headline of any node which has the
4617 exact headline text that is put into the format, but may have any
4618 TODO state, priority and tags.")
4619 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4620 (defvar org-todo-line-tags-regexp nil
4621 "Matches a headline and puts TODO state into group 2 if present.
4622 Also put tags into group 4 if tags are present.")
4623 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4624 (defvar org-ds-keyword-length 12
4625 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4626 (make-variable-buffer-local 'org-ds-keyword-length)
4627 (defvar org-deadline-regexp nil
4628 "Matches the DEADLINE keyword.")
4629 (make-variable-buffer-local 'org-deadline-regexp)
4630 (defvar org-deadline-time-regexp nil
4631 "Matches the DEADLINE keyword together with a time stamp.")
4632 (make-variable-buffer-local 'org-deadline-time-regexp)
4633 (defvar org-deadline-time-hour-regexp nil
4634 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4635 (make-variable-buffer-local 'org-deadline-time-hour-regexp)
4636 (defvar org-deadline-line-regexp nil
4637 "Matches the DEADLINE keyword and the rest of the line.")
4638 (make-variable-buffer-local 'org-deadline-line-regexp)
4639 (defvar org-scheduled-regexp nil
4640 "Matches the SCHEDULED keyword.")
4641 (make-variable-buffer-local 'org-scheduled-regexp)
4642 (defvar org-scheduled-time-regexp nil
4643 "Matches the SCHEDULED keyword together with a time stamp.")
4644 (make-variable-buffer-local 'org-scheduled-time-regexp)
4645 (defvar org-scheduled-time-hour-regexp nil
4646 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4647 (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
4648 (defvar org-closed-time-regexp nil
4649 "Matches the CLOSED keyword together with a time stamp.")
4650 (make-variable-buffer-local 'org-closed-time-regexp)
4652 (defvar org-keyword-time-regexp nil
4653 "Matches any of the 4 keywords, together with the time stamp.")
4654 (make-variable-buffer-local 'org-keyword-time-regexp)
4655 (defvar org-keyword-time-not-clock-regexp nil
4656 "Matches any of the 3 keywords, together with the time stamp.")
4657 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
4658 (defvar org-maybe-keyword-time-regexp nil
4659 "Matches a timestamp, possibly preceded by a keyword.")
4660 (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
4661 (defvar org-all-time-keywords nil
4662 "List of time keywords.")
4663 (make-variable-buffer-local 'org-all-time-keywords)
4665 (defconst org-plain-time-of-day-regexp
4666 (concat
4667 "\\(\\<[012]?[0-9]"
4668 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4669 "\\(--?"
4670 "\\(\\<[012]?[0-9]"
4671 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4672 "\\)?")
4673 "Regular expression to match a plain time or time range.
4674 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4675 groups carry important information:
4676 0 the full match
4677 1 the first time, range or not
4678 8 the second time, if it is a range.")
4680 (defconst org-plain-time-extension-regexp
4681 (concat
4682 "\\(\\<[012]?[0-9]"
4683 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4684 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4685 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4686 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4687 groups carry important information:
4688 0 the full match
4689 7 hours of duration
4690 9 minutes of duration")
4692 (defconst org-stamp-time-of-day-regexp
4693 (concat
4694 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4695 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4696 "\\(--?"
4697 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4698 "Regular expression to match a timestamp time or time range.
4699 After a match, the following groups carry important information:
4700 0 the full match
4701 1 date plus weekday, for back referencing to make sure both times are on the same day
4702 2 the first time, range or not
4703 4 the second time, if it is a range.")
4705 (defconst org-startup-options
4706 '(("fold" org-startup-folded t)
4707 ("overview" org-startup-folded t)
4708 ("nofold" org-startup-folded nil)
4709 ("showall" org-startup-folded nil)
4710 ("showeverything" org-startup-folded showeverything)
4711 ("content" org-startup-folded content)
4712 ("indent" org-startup-indented t)
4713 ("noindent" org-startup-indented nil)
4714 ("hidestars" org-hide-leading-stars t)
4715 ("showstars" org-hide-leading-stars nil)
4716 ("odd" org-odd-levels-only t)
4717 ("oddeven" org-odd-levels-only nil)
4718 ("align" org-startup-align-all-tables t)
4719 ("noalign" org-startup-align-all-tables nil)
4720 ("inlineimages" org-startup-with-inline-images t)
4721 ("noinlineimages" org-startup-with-inline-images nil)
4722 ("latexpreview" org-startup-with-latex-preview t)
4723 ("nolatexpreview" org-startup-with-latex-preview nil)
4724 ("customtime" org-display-custom-times t)
4725 ("logdone" org-log-done time)
4726 ("lognotedone" org-log-done note)
4727 ("nologdone" org-log-done nil)
4728 ("lognoteclock-out" org-log-note-clock-out t)
4729 ("nolognoteclock-out" org-log-note-clock-out nil)
4730 ("logrepeat" org-log-repeat state)
4731 ("lognoterepeat" org-log-repeat note)
4732 ("logdrawer" org-log-into-drawer t)
4733 ("nologdrawer" org-log-into-drawer nil)
4734 ("logstatesreversed" org-log-states-order-reversed t)
4735 ("nologstatesreversed" org-log-states-order-reversed nil)
4736 ("nologrepeat" org-log-repeat nil)
4737 ("logreschedule" org-log-reschedule time)
4738 ("lognotereschedule" org-log-reschedule note)
4739 ("nologreschedule" org-log-reschedule nil)
4740 ("logredeadline" org-log-redeadline time)
4741 ("lognoteredeadline" org-log-redeadline note)
4742 ("nologredeadline" org-log-redeadline nil)
4743 ("logrefile" org-log-refile time)
4744 ("lognoterefile" org-log-refile note)
4745 ("nologrefile" org-log-refile nil)
4746 ("fninline" org-footnote-define-inline t)
4747 ("nofninline" org-footnote-define-inline nil)
4748 ("fnlocal" org-footnote-section nil)
4749 ("fnauto" org-footnote-auto-label t)
4750 ("fnprompt" org-footnote-auto-label nil)
4751 ("fnconfirm" org-footnote-auto-label confirm)
4752 ("fnplain" org-footnote-auto-label plain)
4753 ("fnadjust" org-footnote-auto-adjust t)
4754 ("nofnadjust" org-footnote-auto-adjust nil)
4755 ("constcgs" constants-unit-system cgs)
4756 ("constSI" constants-unit-system SI)
4757 ("noptag" org-tag-persistent-alist nil)
4758 ("hideblocks" org-hide-block-startup t)
4759 ("nohideblocks" org-hide-block-startup nil)
4760 ("beamer" org-startup-with-beamer-mode t)
4761 ("entitiespretty" org-pretty-entities t)
4762 ("entitiesplain" org-pretty-entities nil))
4763 "Variable associated with STARTUP options for org-mode.
4764 Each element is a list of three items: the startup options (as written
4765 in the #+STARTUP line), the corresponding variable, and the value to set
4766 this variable to if the option is found. An optional forth element PUSH
4767 means to push this value onto the list in the variable.")
4769 (defun org-update-property-plist (key val props)
4770 "Update PROPS with KEY and VAL."
4771 (let* ((appending (string= "+" (substring key (- (length key) 1))))
4772 (key (if appending (substring key 0 (- (length key) 1)) key))
4773 (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
4774 (previous (cdr (assoc key props))))
4775 (if appending
4776 (cons (cons key (if previous (concat previous " " val) val)) remainder)
4777 (cons (cons key val) remainder))))
4779 (defconst org-block-regexp
4780 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
4781 "Regular expression for hiding blocks.")
4782 (defconst org-heading-keyword-regexp-format
4783 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
4784 "Printf format for a regexp matching a headline with some keyword.
4785 This regexp will match the headline of any node which has the
4786 exact keyword that is put into the format. The keyword isn't in
4787 any group by default, but the stars and the body are.")
4788 (defconst org-heading-keyword-maybe-regexp-format
4789 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
4790 "Printf format for a regexp matching a headline, possibly with some keyword.
4791 This regexp can match any headline with the specified keyword, or
4792 without a keyword. The keyword isn't in any group by default,
4793 but the stars and the body are.")
4795 (defcustom org-group-tags t
4796 "When non-nil (the default), use group tags.
4797 This can be turned on/off through `org-toggle-tags-groups'."
4798 :group 'org-tags
4799 :group 'org-startup
4800 :type 'boolean)
4802 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4804 (defun org-toggle-tags-groups ()
4805 "Toggle support for group tags.
4806 Support for group tags is controlled by the option
4807 `org-group-tags', which is non-nil by default."
4808 (interactive)
4809 (setq org-group-tags (not org-group-tags))
4810 (cond ((and (derived-mode-p 'org-agenda-mode)
4811 org-group-tags)
4812 (org-agenda-redo))
4813 ((derived-mode-p 'org-mode)
4814 (let ((org-inhibit-startup t)) (org-mode))))
4815 (message "Groups tags support has been turned %s"
4816 (if org-group-tags "on" "off")))
4818 (defun org-set-regexps-and-options-for-tags ()
4819 "Precompute variables used for tags."
4820 (when (derived-mode-p 'org-mode)
4821 (org-set-local 'org-file-tags nil)
4822 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4823 (splitre "[ \t]+")
4824 (start 0)
4825 tags ftags key value)
4826 (save-excursion
4827 (save-restriction
4828 (widen)
4829 (goto-char (point-min))
4830 (while (re-search-forward re nil t)
4831 (setq key (upcase (org-match-string-no-properties 1))
4832 value (org-match-string-no-properties 2))
4833 (if (stringp value) (setq value (org-trim value)))
4834 (cond
4835 ((equal key "TAGS")
4836 (setq tags (append tags (if tags '("\\n") nil)
4837 (org-split-string value splitre))))
4838 ((equal key "FILETAGS")
4839 (when (string-match "\\S-" value)
4840 (setq ftags
4841 (append
4842 ftags
4843 (apply 'append
4844 (mapcar (lambda (x) (org-split-string x ":"))
4845 (org-split-string value)))))))))))
4846 ;; Process the file tags.
4847 (and ftags (org-set-local 'org-file-tags
4848 (mapcar 'org-add-prop-inherited ftags)))
4849 (org-set-local 'org-tag-groups-alist nil)
4850 ;; Process the tags.
4851 (when (and (not tags) org-tag-alist)
4852 (setq tags
4853 (mapcar
4854 (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
4855 ((eq (car tg) :endgroup) "}")
4856 ((eq (car tg) :grouptags) ":")
4857 ((eq (car tg) :newline) "\n")
4858 (t (concat (car tg)
4859 (if (characterp (cdr tg))
4860 (format "(%s)" (char-to-string (cdr tg))) "")))))
4861 org-tag-alist)))
4862 (let (e tgs g)
4863 (while (setq e (pop tags))
4864 (cond
4865 ((equal e "{")
4866 (progn (push '(:startgroup) tgs)
4867 (when (equal (nth 1 tags) ":")
4868 (push (list (replace-regexp-in-string
4869 "(.+)$" "" (nth 0 tags)))
4870 org-tag-groups-alist)
4871 (setq g 0))))
4872 ((equal e ":") (push '(:grouptags) tgs))
4873 ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
4874 ((equal e "\\n") (push '(:newline) tgs))
4875 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
4876 (push (cons (match-string 1 e)
4877 (string-to-char (match-string 2 e))) tgs)
4878 (if (and g (> g 0))
4879 (setcar org-tag-groups-alist
4880 (append (car org-tag-groups-alist)
4881 (list (match-string 1 e)))))
4882 (if g (setq g (1+ g))))
4883 (t (push (list e) tgs)
4884 (if (and g (> g 0))
4885 (setcar org-tag-groups-alist
4886 (append (car org-tag-groups-alist) (list e))))
4887 (if g (setq g (1+ g))))))
4888 (org-set-local 'org-tag-alist nil)
4889 (while (setq e (pop tgs))
4890 (or (and (stringp (car e))
4891 (assoc (car e) org-tag-alist))
4892 (push e org-tag-alist)))
4893 ;; Return a list with tag variables
4894 (list org-file-tags org-tag-alist org-tag-groups-alist)))))
4896 (defvar org-ota nil)
4897 (defun org-set-regexps-and-options ()
4898 "Precompute regular expressions used in the current buffer."
4899 (when (derived-mode-p 'org-mode)
4900 (org-set-local 'org-todo-kwd-alist nil)
4901 (org-set-local 'org-todo-key-alist nil)
4902 (org-set-local 'org-todo-key-trigger nil)
4903 (org-set-local 'org-todo-keywords-1 nil)
4904 (org-set-local 'org-done-keywords nil)
4905 (org-set-local 'org-todo-heads nil)
4906 (org-set-local 'org-todo-sets nil)
4907 (org-set-local 'org-todo-log-states nil)
4908 (org-set-local 'org-file-properties nil)
4909 (let ((re (org-make-options-regexp
4910 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
4911 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
4912 "SETUPFILE" "OPTIONS")
4913 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4914 (splitre "[ \t]+")
4915 (scripts org-use-sub-superscripts)
4916 kwds kws0 kwsa key log value cat arch const links hw dws
4917 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4918 (start 0))
4919 (save-excursion
4920 (save-restriction
4921 (widen)
4922 (goto-char (point-min))
4923 (while
4924 (or (and
4925 ext-setup-or-nil
4926 (not org-ota)
4927 (let (ret)
4928 (with-temp-buffer
4929 (insert ext-setup-or-nil)
4930 (let ((major-mode 'org-mode) org-ota)
4931 (setq ret (save-match-data
4932 (org-set-regexps-and-options-for-tags)))))
4933 ;; Append setupfile tags to existing tags
4934 (setq org-ota t)
4935 (setq org-file-tags
4936 (delq nil (append org-file-tags (nth 0 ret)))
4937 org-tag-alist
4938 (delq nil (append org-tag-alist (nth 1 ret)))
4939 org-tag-groups-alist
4940 (delq nil (append org-tag-groups-alist (nth 2 ret))))))
4941 (and ext-setup-or-nil
4942 (string-match re ext-setup-or-nil start)
4943 (setq start (match-end 0)))
4944 (and (setq ext-setup-or-nil nil start 0)
4945 (re-search-forward re nil t)))
4946 (setq key (upcase (match-string 1 ext-setup-or-nil))
4947 value (org-match-string-no-properties 2 ext-setup-or-nil))
4948 (if (stringp value) (setq value (org-trim value)))
4949 (cond
4950 ((equal key "CATEGORY")
4951 (setq cat value))
4952 ((member key '("SEQ_TODO" "TODO"))
4953 (push (cons 'sequence (org-split-string value splitre)) kwds))
4954 ((equal key "TYP_TODO")
4955 (push (cons 'type (org-split-string value splitre)) kwds))
4956 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
4957 ;; general TODO-like setup
4958 (push (cons (intern (downcase (match-string 1 key)))
4959 (org-split-string value splitre)) kwds))
4960 ((equal key "COLUMNS")
4961 (org-set-local 'org-columns-default-format value))
4962 ((equal key "LINK")
4963 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
4964 (push (cons (match-string 1 value)
4965 (org-trim (match-string 2 value)))
4966 links)))
4967 ((equal key "PRIORITIES")
4968 (setq prio (org-split-string value " +")))
4969 ((equal key "PROPERTY")
4970 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
4971 (setq props (org-update-property-plist (match-string 1 value)
4972 (match-string 2 value)
4973 props))))
4974 ((equal key "DRAWERS")
4975 (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
4976 ((equal key "CONSTANTS")
4977 (org-table-set-constants))
4978 ((equal key "STARTUP")
4979 (let ((opts (org-split-string value splitre))
4980 l var val)
4981 (while (setq l (pop opts))
4982 (when (setq l (assoc l org-startup-options))
4983 (setq var (nth 1 l) val (nth 2 l))
4984 (if (not (nth 3 l))
4985 (set (make-local-variable var) val)
4986 (if (not (listp (symbol-value var)))
4987 (set (make-local-variable var) nil))
4988 (set (make-local-variable var) (symbol-value var))
4989 (add-to-list var val))))))
4990 ((equal key "ARCHIVE")
4991 (setq arch value)
4992 (remove-text-properties 0 (length arch)
4993 '(face t fontified t) arch))
4994 ((equal key "OPTIONS")
4995 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
4996 (setq scripts (read (match-string 2 value)))))
4997 ((and (equal key "SETUPFILE")
4998 ;; Prevent checking in Gnus messages
4999 (not buffer-read-only))
5000 (setq setup-contents (org-file-contents
5001 (expand-file-name
5002 (org-remove-double-quotes value))
5003 'noerror))
5004 (if (not ext-setup-or-nil)
5005 (setq ext-setup-or-nil setup-contents start 0)
5006 (setq ext-setup-or-nil
5007 (concat (substring ext-setup-or-nil 0 start)
5008 "\n" setup-contents "\n"
5009 (substring ext-setup-or-nil start)))))))
5010 ;; search for property blocks
5011 (goto-char (point-min))
5012 (while (re-search-forward org-block-regexp nil t)
5013 (when (equal "PROPERTY" (upcase (match-string 1)))
5014 (setq value (replace-regexp-in-string
5015 "[\n\r]" " " (match-string 4)))
5016 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5017 (setq props (org-update-property-plist (match-string 1 value)
5018 (match-string 2 value)
5019 props)))))))
5020 (org-set-local 'org-use-sub-superscripts scripts)
5021 (when cat
5022 (org-set-local 'org-category (intern cat))
5023 (push (cons "CATEGORY" cat) props))
5024 (when prio
5025 (if (< (length prio) 3) (setq prio '("A" "C" "B")))
5026 (setq prio (mapcar 'string-to-char prio))
5027 (org-set-local 'org-highest-priority (nth 0 prio))
5028 (org-set-local 'org-lowest-priority (nth 1 prio))
5029 (org-set-local 'org-default-priority (nth 2 prio)))
5030 (and props (org-set-local 'org-file-properties (nreverse props)))
5031 (and drawers (org-set-local 'org-drawers drawers))
5032 (and arch (org-set-local 'org-archive-location arch))
5033 (and links (setq org-link-abbrev-alist-local (nreverse links)))
5034 ;; Process the TODO keywords
5035 (unless kwds
5036 ;; Use the global values as if they had been given locally.
5037 (setq kwds (default-value 'org-todo-keywords))
5038 (if (stringp (car kwds))
5039 (setq kwds (list (cons org-todo-interpretation
5040 (default-value 'org-todo-keywords)))))
5041 (setq kwds (reverse kwds)))
5042 (setq kwds (nreverse kwds))
5043 (let (inter kws kw)
5044 (while (setq kws (pop kwds))
5045 (let ((kws (or
5046 (run-hook-with-args-until-success
5047 'org-todo-setup-filter-hook kws)
5048 kws)))
5049 (setq inter (pop kws) sep (member "|" kws)
5050 kws0 (delete "|" (copy-sequence kws))
5051 kwsa nil
5052 kws1 (mapcar
5053 (lambda (x)
5054 ;; 1 2
5055 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
5056 (progn
5057 (setq kw (match-string 1 x)
5058 key (and (match-end 2) (match-string 2 x))
5059 log (org-extract-log-state-settings x))
5060 (push (cons kw (and key (string-to-char key))) kwsa)
5061 (and log (push log org-todo-log-states))
5063 (error "Invalid TODO keyword %s" x)))
5064 kws0)
5065 kwsa (if kwsa (append '((:startgroup))
5066 (nreverse kwsa)
5067 '((:endgroup))))
5068 hw (car kws1)
5069 dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
5070 tail (list inter hw (car dws) (org-last dws))))
5071 (add-to-list 'org-todo-heads hw 'append)
5072 (push kws1 org-todo-sets)
5073 (setq org-done-keywords (append org-done-keywords dws nil))
5074 (setq org-todo-key-alist (append org-todo-key-alist kwsa))
5075 (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
5076 (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
5077 (setq org-todo-sets (nreverse org-todo-sets)
5078 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5079 org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
5080 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
5081 ;; Compute the regular expressions and other local variables.
5082 ;; Using `org-outline-regexp-bol' would complicate them much,
5083 ;; because of the fixed white space at the end of that string.
5084 (if (not org-done-keywords)
5085 (setq org-done-keywords (and org-todo-keywords-1
5086 (list (org-last org-todo-keywords-1)))))
5087 (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
5088 (length org-scheduled-string)
5089 (length org-clock-string)
5090 (length org-closed-string)))
5091 org-drawer-regexp
5092 (concat "^[ \t]*:\\("
5093 (mapconcat 'regexp-quote org-drawers "\\|")
5094 "\\):[ \t]*$")
5095 org-not-done-keywords
5096 (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
5097 org-todo-regexp
5098 (concat "\\("
5099 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
5100 "\\)")
5101 org-not-done-regexp
5102 (concat "\\("
5103 (mapconcat 'regexp-quote org-not-done-keywords "\\|")
5104 "\\)")
5105 org-not-done-heading-regexp
5106 (format org-heading-keyword-regexp-format org-not-done-regexp)
5107 org-todo-line-regexp
5108 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5109 org-complex-heading-regexp
5110 (concat "^\\(\\*+\\)"
5111 "\\(?: +" org-todo-regexp "\\)?"
5112 "\\(?: +\\(\\[#.\\]\\)\\)?"
5113 "\\(?: +\\(.*?\\)\\)??"
5114 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5115 "[ \t]*$")
5116 org-complex-heading-regexp-format
5117 (concat "^\\(\\*+\\)"
5118 "\\(?: +" org-todo-regexp "\\)?"
5119 "\\(?: +\\(\\[#.\\]\\)\\)?"
5120 "\\(?: +"
5121 ;; Stats cookies can be stuck to body.
5122 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5123 "\\(%s\\)"
5124 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5125 "\\)"
5126 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5127 "[ \t]*$")
5128 org-todo-line-tags-regexp
5129 (concat "^\\(\\*+\\)"
5130 "\\(?: +" org-todo-regexp "\\)?"
5131 "\\(?: +\\(.*?\\)\\)??"
5132 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5133 "[ \t]*$")
5134 org-deadline-regexp (concat "\\<" org-deadline-string)
5135 org-deadline-time-regexp
5136 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
5137 org-deadline-time-hour-regexp
5138 (concat "\\<" org-deadline-string
5139 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5140 org-deadline-line-regexp
5141 (concat "\\<\\(" org-deadline-string "\\).*")
5142 org-scheduled-regexp
5143 (concat "\\<" org-scheduled-string)
5144 org-scheduled-time-regexp
5145 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
5146 org-scheduled-time-hour-regexp
5147 (concat "\\<" org-scheduled-string
5148 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5149 org-closed-time-regexp
5150 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
5151 org-keyword-time-regexp
5152 (concat "\\<\\(" org-scheduled-string
5153 "\\|" org-deadline-string
5154 "\\|" org-closed-string
5155 "\\|" org-clock-string "\\)"
5156 " *[[<]\\([^]>]+\\)[]>]")
5157 org-keyword-time-not-clock-regexp
5158 (concat "\\<\\(" org-scheduled-string
5159 "\\|" org-deadline-string
5160 "\\|" org-closed-string
5161 "\\)"
5162 " *[[<]\\([^]>]+\\)[]>]")
5163 org-maybe-keyword-time-regexp
5164 (concat "\\(\\<\\(" org-scheduled-string
5165 "\\|" org-deadline-string
5166 "\\|" org-closed-string
5167 "\\|" org-clock-string "\\)\\)?"
5168 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5169 org-all-time-keywords
5170 (mapcar (lambda (w) (substring w 0 -1))
5171 (list org-scheduled-string org-deadline-string
5172 org-clock-string org-closed-string)))
5173 (setq org-ota nil)
5174 (org-compute-latex-and-related-regexp))))
5176 (defun org-file-contents (file &optional noerror)
5177 "Return the contents of FILE, as a string."
5178 (if (or (not file) (not (file-readable-p file)))
5179 (if (not noerror)
5180 (error "Cannot read file \"%s\"" file)
5181 (message "Cannot read file \"%s\"" file)
5183 (with-temp-buffer
5184 (insert-file-contents file)
5185 (buffer-string))))
5187 (defun org-extract-log-state-settings (x)
5188 "Extract the log state setting from a TODO keyword string.
5189 This will extract info from a string like \"WAIT(w@/!)\"."
5190 (let (kw key log1 log2)
5191 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5192 (setq kw (match-string 1 x)
5193 key (and (match-end 2) (match-string 2 x))
5194 log1 (and (match-end 3) (match-string 3 x))
5195 log2 (and (match-end 4) (match-string 4 x)))
5196 (and (or log1 log2)
5197 (list kw
5198 (and log1 (if (equal log1 "!") 'time 'note))
5199 (and log2 (if (equal log2 "!") 'time 'note)))))))
5201 (defun org-remove-keyword-keys (list)
5202 "Remove a pair of parenthesis at the end of each string in LIST."
5203 (mapcar (lambda (x)
5204 (if (string-match "(.*)$" x)
5205 (substring x 0 (match-beginning 0))
5207 list))
5209 (defun org-assign-fast-keys (alist)
5210 "Assign fast keys to a keyword-key alist.
5211 Respect keys that are already there."
5212 (let (new e (alt ?0))
5213 (while (setq e (pop alist))
5214 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5215 (cdr e)) ;; Key already assigned.
5216 (push e new)
5217 (let ((clist (string-to-list (downcase (car e))))
5218 (used (append new alist)))
5219 (when (= (car clist) ?@)
5220 (pop clist))
5221 (while (and clist (rassoc (car clist) used))
5222 (pop clist))
5223 (unless clist
5224 (while (rassoc alt used)
5225 (incf alt)))
5226 (push (cons (car e) (or (car clist) alt)) new))))
5227 (nreverse new)))
5229 ;;; Some variables used in various places
5231 (defvar org-window-configuration nil
5232 "Used in various places to store a window configuration.")
5233 (defvar org-selected-window nil
5234 "Used in various places to store a window configuration.")
5235 (defvar org-finish-function nil
5236 "Function to be called when `C-c C-c' is used.
5237 This is for getting out of special buffers like capture.")
5240 ;; FIXME: Occasionally check by commenting these, to make sure
5241 ;; no other functions uses these, forgetting to let-bind them.
5242 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5243 (defvar org-last-state)
5244 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5246 ;; Defined somewhere in this file, but used before definition.
5247 (defvar org-entities) ;; defined in org-entities.el
5248 (defvar org-struct-menu)
5249 (defvar org-org-menu)
5250 (defvar org-tbl-menu)
5252 ;;;; Define the Org-mode
5254 ;; We use a before-change function to check if a table might need
5255 ;; an update.
5256 (defvar org-table-may-need-update t
5257 "Indicates that a table might need an update.
5258 This variable is set by `org-before-change-function'.
5259 `org-table-align' sets it back to nil.")
5260 (defun org-before-change-function (beg end)
5261 "Every change indicates that a table might need an update."
5262 (setq org-table-may-need-update t))
5263 (defvar org-mode-map)
5264 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5265 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5266 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5267 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5268 (defvar org-table-buffer-is-an nil)
5270 (defvar bidi-paragraph-direction)
5271 (defvar buffer-face-mode-face)
5273 (require 'outline)
5274 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5275 (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"))
5276 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5278 ;; Other stuff we need.
5279 (require 'time-date)
5280 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5281 (require 'easymenu)
5282 (require 'overlay)
5284 ;; (require 'org-macs) moved higher up in the file before it is first used
5285 (require 'org-entities)
5286 ;; (require 'org-compat) moved higher up in the file before it is first used
5287 (require 'org-faces)
5288 (require 'org-list)
5289 (require 'org-pcomplete)
5290 (require 'org-src)
5291 (require 'org-footnote)
5292 (require 'org-macro)
5294 ;; babel
5295 (require 'ob)
5297 ;;;###autoload
5298 (define-derived-mode org-mode outline-mode "Org"
5299 "Outline-based notes management and organizer, alias
5300 \"Carsten's outline-mode for keeping track of everything.\"
5302 Org-mode develops organizational tasks around a NOTES file which
5303 contains information about projects as plain text. Org-mode is
5304 implemented on top of outline-mode, which is ideal to keep the content
5305 of large files well structured. It supports ToDo items, deadlines and
5306 time stamps, which magically appear in the diary listing of the Emacs
5307 calendar. Tables are easily created with a built-in table editor.
5308 Plain text URL-like links connect to websites, emails (VM), Usenet
5309 messages (Gnus), BBDB entries, and any files related to the project.
5310 For printing and sharing of notes, an Org-mode file (or a part of it)
5311 can be exported as a structured ASCII or HTML file.
5313 The following commands are available:
5315 \\{org-mode-map}"
5317 ;; Get rid of Outline menus, they are not needed
5318 ;; Need to do this here because define-derived-mode sets up
5319 ;; the keymap so late. Still, it is a waste to call this each time
5320 ;; we switch another buffer into org-mode.
5321 (if (featurep 'xemacs)
5322 (when (boundp 'outline-mode-menu-heading)
5323 ;; Assume this is Greg's port, it uses easymenu
5324 (easy-menu-remove outline-mode-menu-heading)
5325 (easy-menu-remove outline-mode-menu-show)
5326 (easy-menu-remove outline-mode-menu-hide))
5327 (define-key org-mode-map [menu-bar headings] 'undefined)
5328 (define-key org-mode-map [menu-bar hide] 'undefined)
5329 (define-key org-mode-map [menu-bar show] 'undefined))
5331 (org-load-modules-maybe)
5332 (easy-menu-add org-org-menu)
5333 (easy-menu-add org-tbl-menu)
5334 (org-install-agenda-files-menu)
5335 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5336 (add-to-invisibility-spec '(org-cwidth))
5337 (add-to-invisibility-spec '(org-hide-block . t))
5338 (when (featurep 'xemacs)
5339 (org-set-local 'line-move-ignore-invisible t))
5340 (org-set-local 'outline-regexp org-outline-regexp)
5341 (org-set-local 'outline-level 'org-outline-level)
5342 (setq bidi-paragraph-direction 'left-to-right)
5343 (when (and org-ellipsis
5344 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5345 (fboundp 'make-glyph-code))
5346 (unless org-display-table
5347 (setq org-display-table (make-display-table)))
5348 (set-display-table-slot
5349 org-display-table 4
5350 (vconcat (mapcar
5351 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5352 org-ellipsis)))
5353 (if (stringp org-ellipsis) org-ellipsis "..."))))
5354 (setq buffer-display-table org-display-table))
5355 (org-set-regexps-and-options-for-tags)
5356 (org-set-regexps-and-options)
5357 (org-set-font-lock-defaults)
5358 (when (and org-tag-faces (not org-tags-special-faces-re))
5359 ;; tag faces set outside customize.... force initialization.
5360 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5361 ;; Calc embedded
5362 (org-set-local 'calc-embedded-open-mode "# ")
5363 ;; Modify a few syntax entries
5364 (modify-syntax-entry ?@ "w")
5365 (modify-syntax-entry ?\" "\"")
5366 (modify-syntax-entry ?\\ "_")
5367 (modify-syntax-entry ?~ "_")
5368 (if org-startup-truncated (setq truncate-lines t))
5369 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5370 (org-set-local 'font-lock-unfontify-region-function
5371 'org-unfontify-region)
5372 ;; Activate before-change-function
5373 (org-set-local 'org-table-may-need-update t)
5374 (org-add-hook 'before-change-functions 'org-before-change-function nil
5375 'local)
5376 ;; Check for running clock before killing a buffer
5377 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5378 ;; Initialize macros templates.
5379 (org-macro-initialize-templates)
5380 ;; Initialize radio targets.
5381 (org-update-radio-target-regexp)
5382 ;; Indentation.
5383 (org-set-local 'indent-line-function 'org-indent-line)
5384 (org-set-local 'indent-region-function 'org-indent-region)
5385 ;; Filling and auto-filling.
5386 (org-setup-filling)
5387 ;; Comments.
5388 (org-setup-comments-handling)
5389 ;; Beginning/end of defun
5390 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5391 (org-set-local 'end-of-defun-function
5392 (lambda ()
5393 (if (not (org-at-heading-p))
5394 (org-forward-element)
5395 (org-forward-element)
5396 (forward-char -1))))
5397 ;; Next error for sparse trees
5398 (org-set-local 'next-error-function 'org-occur-next-match)
5399 ;; Make sure dependence stuff works reliably, even for users who set it
5400 ;; too late :-(
5401 (if org-enforce-todo-dependencies
5402 (add-hook 'org-blocker-hook
5403 'org-block-todo-from-children-or-siblings-or-parent)
5404 (remove-hook 'org-blocker-hook
5405 'org-block-todo-from-children-or-siblings-or-parent))
5406 (if org-enforce-todo-checkbox-dependencies
5407 (add-hook 'org-blocker-hook
5408 'org-block-todo-from-checkboxes)
5409 (remove-hook 'org-blocker-hook
5410 'org-block-todo-from-checkboxes))
5412 ;; Align options lines
5413 (org-set-local
5414 'align-mode-rules-list
5415 '((org-in-buffer-settings
5416 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5417 (modes . '(org-mode)))))
5419 ;; Imenu
5420 (org-set-local 'imenu-create-index-function
5421 'org-imenu-get-tree)
5423 ;; Make isearch reveal context
5424 (if (or (featurep 'xemacs)
5425 (not (boundp 'outline-isearch-open-invisible-function)))
5426 ;; Emacs 21 and XEmacs make use of the hook
5427 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5428 ;; Emacs 22 deals with this through a special variable
5429 (org-set-local 'outline-isearch-open-invisible-function
5430 (lambda (&rest ignore) (org-show-context 'isearch))))
5432 ;; Setup the pcomplete hooks
5433 (set (make-local-variable 'pcomplete-command-completion-function)
5434 'org-pcomplete-initial)
5435 (set (make-local-variable 'pcomplete-command-name-function)
5436 'org-command-at-point)
5437 (set (make-local-variable 'pcomplete-default-completion-function)
5438 'ignore)
5439 (set (make-local-variable 'pcomplete-parse-arguments-function)
5440 'org-parse-arguments)
5441 (set (make-local-variable 'pcomplete-termination-string) "")
5442 (when (>= emacs-major-version 23)
5443 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5445 ;; If empty file that did not turn on org-mode automatically, make it to.
5446 (if (and org-insert-mode-line-in-empty-file
5447 (org-called-interactively-p 'any)
5448 (= (point-min) (point-max)))
5449 (insert "# -*- mode: org -*-\n\n"))
5450 (unless org-inhibit-startup
5451 (org-unmodified
5452 (and org-startup-with-beamer-mode (org-beamer-mode))
5453 (when org-startup-align-all-tables
5454 (org-table-map-tables 'org-table-align 'quietly))
5455 (when org-startup-with-inline-images
5456 (org-display-inline-images))
5457 (when org-startup-with-latex-preview
5458 (org-preview-latex-fragment))
5459 (unless org-inhibit-startup-visibility-stuff
5460 (org-set-startup-visibility))))
5461 ;; Try to set org-hide correctly
5462 (let ((foreground (org-find-invisible-foreground)))
5463 (if foreground
5464 (set-face-foreground 'org-hide foreground))))
5466 ;; Update `customize-package-emacs-version-alist'
5467 (add-to-list 'customize-package-emacs-version-alist
5468 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5469 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5470 ("8.2.6" . "24.4")))
5472 (defvar org-mode-transpose-word-syntax-table
5473 (let ((st (make-syntax-table)))
5474 (mapc (lambda(c) (modify-syntax-entry
5475 (string-to-char (car c)) "w p" st))
5476 org-emphasis-alist)
5477 st))
5479 (when (fboundp 'abbrev-table-put)
5480 (abbrev-table-put org-mode-abbrev-table
5481 :parents (list text-mode-abbrev-table)))
5483 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
5485 (defun org-find-invisible-foreground ()
5486 (let ((candidates (remove
5487 "unspecified-bg"
5488 (nconc
5489 (list (face-background 'default)
5490 (face-background 'org-default))
5491 (mapcar
5492 (lambda (alist)
5493 (when (boundp alist)
5494 (cdr (assoc 'background-color (symbol-value alist)))))
5495 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5496 (list (face-foreground 'org-hide))))))
5497 (car (remove nil candidates))))
5499 (defun org-current-time (&optional rounding-minutes past)
5500 "Current time, possibly rounded to ROUNDING-MINUTES.
5501 When ROUNDING-MINUTES is not an integer, fall back on the car of
5502 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5503 the rounding returns a past time."
5504 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5505 (car org-time-stamp-rounding-minutes)))
5506 (time (decode-time)) res)
5507 (if (< r 1)
5508 (current-time)
5509 (setq res
5510 (apply 'encode-time
5511 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5512 (nthcdr 2 time))))
5513 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5514 (seconds-to-time (- (org-float-time res) (* r 60)))
5515 res))))
5517 (defun org-today ()
5518 "Return today date, considering `org-extend-today-until'."
5519 (time-to-days
5520 (time-subtract (current-time)
5521 (list 0 (* 3600 org-extend-today-until) 0))))
5523 ;;;; Font-Lock stuff, including the activators
5525 (defvar org-mouse-map (make-sparse-keymap))
5526 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5527 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5528 (when org-mouse-1-follows-link
5529 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5530 (when org-tab-follows-link
5531 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5532 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5534 (require 'font-lock)
5536 (defconst org-non-link-chars "]\t\n\r<>")
5537 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5538 "shell" "elisp" "doi" "message"))
5539 (defvar org-link-types-re nil
5540 "Matches a link that has a url-like prefix like \"http:\"")
5541 (defvar org-link-re-with-space nil
5542 "Matches a link with spaces, optional angular brackets around it.")
5543 (defvar org-link-re-with-space2 nil
5544 "Matches a link with spaces, optional angular brackets around it.")
5545 (defvar org-link-re-with-space3 nil
5546 "Matches a link with spaces, only for internal part in bracket links.")
5547 (defvar org-angle-link-re nil
5548 "Matches link with angular brackets, spaces are allowed.")
5549 (defvar org-plain-link-re nil
5550 "Matches plain link, without spaces.")
5551 (defvar org-bracket-link-regexp nil
5552 "Matches a link in double brackets.")
5553 (defvar org-bracket-link-analytic-regexp nil
5554 "Regular expression used to analyze links.
5555 Here is what the match groups contain after a match:
5556 1: http:
5557 2: http
5558 3: path
5559 4: [desc]
5560 5: desc")
5561 (defvar org-bracket-link-analytic-regexp++ nil
5562 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5563 (defvar org-any-link-re nil
5564 "Regular expression matching any link.")
5566 (defconst org-match-sexp-depth 3
5567 "Number of stacked braces for sub/superscript matching.")
5569 (defun org-create-multibrace-regexp (left right n)
5570 "Create a regular expression which will match a balanced sexp.
5571 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5572 as single character strings.
5573 The regexp returned will match the entire expression including the
5574 delimiters. It will also define a single group which contains the
5575 match except for the outermost delimiters. The maximum depth of
5576 stacked delimiters is N. Escaping delimiters is not possible."
5577 (let* ((nothing (concat "[^" left right "]*?"))
5578 (or "\\|")
5579 (re nothing)
5580 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5581 (while (> n 1)
5582 (setq n (1- n)
5583 re (concat re or next)
5584 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5585 (concat left "\\(" re "\\)" right)))
5587 (defvar org-match-substring-regexp
5588 (concat
5589 "\\(\\S-\\)\\([_^]\\)\\("
5590 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5591 "\\|"
5592 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5593 "\\|"
5594 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
5595 "The regular expression matching a sub- or superscript.")
5597 (defvar org-match-substring-with-braces-regexp
5598 (concat
5599 "\\(\\S-\\)\\([_^]\\)\\("
5600 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5601 "\\)")
5602 "The regular expression matching a sub- or superscript, forcing braces.")
5604 (defun org-make-link-regexps ()
5605 "Update the link regular expressions.
5606 This should be called after the variable `org-link-types' has changed."
5607 (let ((types-re (regexp-opt org-link-types t)))
5608 (setq org-link-types-re
5609 (concat "\\`" types-re ":")
5610 org-link-re-with-space
5611 (concat "<?" types-re ":"
5612 "\\([^" org-non-link-chars " ]"
5613 "[^" org-non-link-chars "]*"
5614 "[^" org-non-link-chars " ]\\)>?")
5615 org-link-re-with-space2
5616 (concat "<?" types-re ":"
5617 "\\([^" org-non-link-chars " ]"
5618 "[^\t\n\r]*"
5619 "[^" org-non-link-chars " ]\\)>?")
5620 org-link-re-with-space3
5621 (concat "<?" types-re ":"
5622 "\\([^" org-non-link-chars " ]"
5623 "[^\t\n\r]*\\)")
5624 org-angle-link-re
5625 (concat "<" types-re ":"
5626 "\\([^" org-non-link-chars " ]"
5627 "[^" org-non-link-chars "]*"
5628 "\\)>")
5629 org-plain-link-re
5630 (concat
5631 "\\<" types-re ":"
5632 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5633 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5634 org-bracket-link-regexp
5635 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5636 org-bracket-link-analytic-regexp
5637 (concat
5638 "\\[\\["
5639 "\\(" types-re ":\\)?"
5640 "\\([^]]+\\)"
5641 "\\]"
5642 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5643 "\\]")
5644 org-bracket-link-analytic-regexp++
5645 (concat
5646 "\\[\\["
5647 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5648 "\\([^]]+\\)"
5649 "\\]"
5650 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5651 "\\]")
5652 org-any-link-re
5653 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5654 org-angle-link-re "\\)\\|\\("
5655 org-plain-link-re "\\)"))))
5657 (org-make-link-regexps)
5659 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
5660 "Regular expression for fast time stamp matching.")
5661 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5662 "Regular expression for fast time stamp matching.")
5663 (defconst org-ts-regexp0
5664 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5665 "Regular expression matching time strings for analysis.
5666 This one does not require the space after the date, so it can be used
5667 on a string that terminates immediately after the date.")
5668 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5669 "Regular expression matching time strings for analysis.")
5670 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
5671 "Regular expression matching time stamps, with groups.")
5672 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
5673 "Regular expression matching time stamps (also [..]), with groups.")
5674 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5675 "Regular expression matching a time stamp range.")
5676 (defconst org-tr-regexp-both
5677 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5678 "Regular expression matching a time stamp range.")
5679 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
5680 org-ts-regexp "\\)?")
5681 "Regular expression matching a time stamp or time stamp range.")
5682 (defconst org-tsr-regexp-both
5683 (concat org-ts-regexp-both "\\(--?-?"
5684 org-ts-regexp-both "\\)?")
5685 "Regular expression matching a time stamp or time stamp range.
5686 The time stamps may be either active or inactive.")
5688 (defvar org-emph-face nil)
5690 (defun org-do-emphasis-faces (limit)
5691 "Run through the buffer and add overlays to emphasized strings."
5692 (let (rtn a)
5693 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5694 (let* ((border (char-after (match-beginning 3)))
5695 (bre (regexp-quote (char-to-string border))))
5696 (if (and (not (= border (char-after (match-beginning 4))))
5697 (not (save-match-data
5698 (string-match (concat bre ".*" bre)
5699 (replace-regexp-in-string
5700 "\n" " "
5701 (substring (match-string 2) 1 -1))))))
5702 (progn
5703 (setq rtn t)
5704 (setq a (assoc (match-string 3) org-emphasis-alist))
5705 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5706 'face
5707 (nth 1 a))
5708 (and (nth 2 a)
5709 (org-remove-flyspell-overlays-in
5710 (match-beginning 0) (match-end 0)))
5711 (add-text-properties (match-beginning 2) (match-end 2)
5712 '(font-lock-multiline t org-emphasis t))
5713 (when org-hide-emphasis-markers
5714 (add-text-properties (match-end 4) (match-beginning 5)
5715 '(invisible org-link))
5716 (add-text-properties (match-beginning 3) (match-end 3)
5717 '(invisible org-link))))))
5718 (goto-char (1+ (match-beginning 0))))
5719 rtn))
5721 (defun org-emphasize (&optional char)
5722 "Insert or change an emphasis, i.e. a font like bold or italic.
5723 If there is an active region, change that region to a new emphasis.
5724 If there is no region, just insert the marker characters and position
5725 the cursor between them.
5726 CHAR should be the marker character. If it is a space, it means to
5727 remove the emphasis of the selected region.
5728 If CHAR is not given (for example in an interactive call) it will be
5729 prompted for."
5730 (interactive)
5731 (let ((erc org-emphasis-regexp-components)
5732 (prompt "")
5733 (string "") beg end move c s)
5734 (if (org-region-active-p)
5735 (setq beg (region-beginning) end (region-end)
5736 string (buffer-substring beg end))
5737 (setq move t))
5739 (unless char
5740 (message "Emphasis marker or tag: [%s]"
5741 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5742 (setq char (read-char-exclusive)))
5743 (if (equal char ?\ )
5744 (setq s "" move nil)
5745 (unless (assoc (char-to-string char) org-emphasis-alist)
5746 (user-error "No such emphasis marker: \"%c\"" char))
5747 (setq s (char-to-string char)))
5748 (while (and (> (length string) 1)
5749 (equal (substring string 0 1) (substring string -1))
5750 (assoc (substring string 0 1) org-emphasis-alist))
5751 (setq string (substring string 1 -1)))
5752 (setq string (concat s string s))
5753 (if beg (delete-region beg end))
5754 (unless (or (bolp)
5755 (string-match (concat "[" (nth 0 erc) "\n]")
5756 (char-to-string (char-before (point)))))
5757 (insert " "))
5758 (unless (or (eobp)
5759 (string-match (concat "[" (nth 1 erc) "\n]")
5760 (char-to-string (char-after (point)))))
5761 (insert " ") (backward-char 1))
5762 (insert string)
5763 (and move (backward-char 1))))
5765 (defconst org-nonsticky-props
5766 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5768 (defsubst org-rear-nonsticky-at (pos)
5769 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5771 (defun org-activate-plain-links (limit)
5772 "Run through the buffer and add overlays to links."
5773 (let (f hl)
5774 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5775 (not (org-in-src-block-p)))
5776 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5777 (setq f (get-text-property (match-beginning 0) 'face))
5778 (setq hl (org-match-string-no-properties 0))
5779 (if (or (eq f 'org-tag)
5780 (and (listp f) (memq 'org-tag f)))
5782 (add-text-properties (match-beginning 0) (match-end 0)
5783 (list 'mouse-face 'highlight
5784 'face 'org-link
5785 'htmlize-link `(:uri ,hl)
5786 'keymap org-mouse-map))
5787 (org-rear-nonsticky-at (match-end 0)))
5788 t)))
5790 (defun org-activate-code (limit)
5791 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5792 (progn
5793 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5794 (remove-text-properties (match-beginning 0) (match-end 0)
5795 '(display t invisible t intangible t))
5796 t)))
5798 (defcustom org-src-fontify-natively nil
5799 "When non-nil, fontify code in code blocks."
5800 :type 'boolean
5801 :version "24.1"
5802 :group 'org-appearance
5803 :group 'org-babel)
5805 (defcustom org-allow-promoting-top-level-subtree nil
5806 "When non-nil, allow promoting a top level subtree.
5807 The leading star of the top level headline will be replaced
5808 by a #."
5809 :type 'boolean
5810 :version "24.1"
5811 :group 'org-appearance)
5813 (defun org-fontify-meta-lines-and-blocks (limit)
5814 (condition-case nil
5815 (org-fontify-meta-lines-and-blocks-1 limit)
5816 (error (message "org-mode fontification error"))))
5818 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5819 "Fontify #+ lines and blocks."
5820 (let ((case-fold-search t))
5821 (if (re-search-forward
5822 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5823 limit t)
5824 (let ((beg (match-beginning 0))
5825 (block-start (match-end 0))
5826 (block-end nil)
5827 (lang (match-string 7))
5828 (beg1 (line-beginning-position 2))
5829 (dc1 (downcase (match-string 2)))
5830 (dc3 (downcase (match-string 3)))
5831 end end1 quoting block-type ovl)
5832 (cond
5833 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5834 ;; a single line of backend-specific content
5835 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5836 (remove-text-properties (match-beginning 0) (match-end 0)
5837 '(display t invisible t intangible t))
5838 (add-text-properties (match-beginning 1) (match-end 3)
5839 '(font-lock-fontified t face org-meta-line))
5840 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5841 '(font-lock-fontified t face org-block))
5842 ; for backend-specific code
5844 ((and (match-end 4) (equal dc3 "+begin"))
5845 ;; Truly a block
5846 (setq block-type (downcase (match-string 5))
5847 quoting (member block-type org-protecting-blocks))
5848 (when (re-search-forward
5849 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5850 nil t) ;; on purpose, we look further than LIMIT
5851 (setq end (min (point-max) (match-end 0))
5852 end1 (min (point-max) (1- (match-beginning 0))))
5853 (setq block-end (match-beginning 0))
5854 (when quoting
5855 (remove-text-properties beg end
5856 '(display t invisible t intangible t)))
5857 (add-text-properties
5858 beg end
5859 '(font-lock-fontified t font-lock-multiline t))
5860 (add-text-properties beg beg1 '(face org-meta-line))
5861 (add-text-properties end1 (min (point-max) (1+ end))
5862 '(face org-meta-line)) ; for end_src
5863 (cond
5864 ((and lang (not (string= lang "")) org-src-fontify-natively)
5865 (org-src-font-lock-fontify-block lang block-start block-end)
5866 ;; remove old background overlays
5867 (mapc (lambda (ov)
5868 (if (eq (overlay-get ov 'face) 'org-block-background)
5869 (delete-overlay ov)))
5870 (overlays-at (/ (+ beg1 block-end) 2)))
5871 ;; add a background overlay
5872 (setq ovl (make-overlay beg1 block-end))
5873 (overlay-put ovl 'face 'org-block-background)
5874 (overlay-put ovl 'evaporate t)) ;; make it go away when empty
5875 (quoting
5876 (add-text-properties beg1 (min (point-max) (1+ end1))
5877 '(face org-block))) ; end of source block
5878 ((not org-fontify-quote-and-verse-blocks))
5879 ((string= block-type "quote")
5880 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5881 ((string= block-type "verse")
5882 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5883 (add-text-properties beg beg1 '(face org-block-begin-line))
5884 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5885 '(face org-block-end-line))
5887 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5888 (add-text-properties
5889 beg (match-end 3)
5890 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5891 '(font-lock-fontified t invisible t)
5892 '(font-lock-fontified t face org-document-info-keyword)))
5893 (add-text-properties
5894 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5895 (if (string-equal dc1 "+title:")
5896 '(font-lock-fontified t face org-document-title)
5897 '(font-lock-fontified t face org-document-info))))
5898 ((or (equal dc1 "+results")
5899 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5900 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5901 "+call:" "+header:" "+headers:" "+name:"))
5902 (and (match-end 4) (equal dc3 "+attr")))
5903 (add-text-properties
5904 beg (match-end 0)
5905 '(font-lock-fontified t face org-meta-line))
5907 ((member dc3 '(" " ""))
5908 (add-text-properties
5909 beg (match-end 0)
5910 '(font-lock-fontified t face font-lock-comment-face)))
5911 ((not (member (char-after beg) '(?\ ?\t)))
5912 ;; just any other in-buffer setting, but not indented
5913 (add-text-properties
5914 beg (match-end 0)
5915 '(font-lock-fontified t face org-meta-line))
5917 (t nil))))))
5919 (defun org-activate-angle-links (limit)
5920 "Run through the buffer and add overlays to links."
5921 (if (and (re-search-forward org-angle-link-re limit t)
5922 (not (org-in-src-block-p)))
5923 (progn
5924 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5925 (add-text-properties (match-beginning 0) (match-end 0)
5926 (list 'mouse-face 'highlight
5927 'keymap org-mouse-map))
5928 (org-rear-nonsticky-at (match-end 0))
5929 t)))
5931 (defun org-activate-footnote-links (limit)
5932 "Run through the buffer and add overlays to footnotes."
5933 (let ((fn (org-footnote-next-reference-or-definition limit)))
5934 (when fn
5935 (let ((beg (nth 1 fn)) (end (nth 2 fn)))
5936 (org-remove-flyspell-overlays-in beg end)
5937 (add-text-properties beg end
5938 (list 'mouse-face 'highlight
5939 'keymap org-mouse-map
5940 'help-echo
5941 (if (= (point-at-bol) beg)
5942 "Footnote definition"
5943 "Footnote reference")
5944 'font-lock-fontified t
5945 'font-lock-multiline t
5946 'face 'org-footnote))))))
5948 (defun org-activate-bracket-links (limit)
5949 "Run through the buffer and add overlays to bracketed links."
5950 (if (and (re-search-forward org-bracket-link-regexp limit t)
5951 (not (org-in-src-block-p)))
5952 (let* ((hl (org-match-string-no-properties 1))
5953 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
5954 (ip (org-maybe-intangible
5955 (list 'invisible 'org-link
5956 'keymap org-mouse-map 'mouse-face 'highlight
5957 'font-lock-multiline t 'help-echo help
5958 'htmlize-link `(:uri ,hl))))
5959 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
5960 'font-lock-multiline t 'help-echo help
5961 'htmlize-link `(:uri ,hl))))
5962 ;; We need to remove the invisible property here. Table narrowing
5963 ;; may have made some of this invisible.
5964 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5965 (remove-text-properties (match-beginning 0) (match-end 0)
5966 '(invisible nil))
5967 (if (match-end 3)
5968 (progn
5969 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5970 (org-rear-nonsticky-at (match-beginning 3))
5971 (add-text-properties (match-beginning 3) (match-end 3) vp)
5972 (org-rear-nonsticky-at (match-end 3))
5973 (add-text-properties (match-end 3) (match-end 0) ip)
5974 (org-rear-nonsticky-at (match-end 0)))
5975 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5976 (org-rear-nonsticky-at (match-beginning 1))
5977 (add-text-properties (match-beginning 1) (match-end 1) vp)
5978 (org-rear-nonsticky-at (match-end 1))
5979 (add-text-properties (match-end 1) (match-end 0) ip)
5980 (org-rear-nonsticky-at (match-end 0)))
5981 t)))
5983 (defun org-activate-dates (limit)
5984 "Run through the buffer and add overlays to dates."
5985 (if (and (re-search-forward org-tsr-regexp-both limit t)
5986 (not (equal (char-before (match-beginning 0)) 91)))
5987 (progn
5988 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5989 (add-text-properties (match-beginning 0) (match-end 0)
5990 (list 'mouse-face 'highlight
5991 'keymap org-mouse-map))
5992 (org-rear-nonsticky-at (match-end 0))
5993 (when org-display-custom-times
5994 (if (match-end 3)
5995 (org-display-custom-time (match-beginning 3) (match-end 3)))
5996 (org-display-custom-time (match-beginning 1) (match-end 1)))
5997 t)))
5999 (defvar org-target-link-regexp nil
6000 "Regular expression matching radio targets in plain text.")
6001 (make-variable-buffer-local 'org-target-link-regexp)
6002 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
6003 "Regular expression matching a link target.")
6004 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
6005 "Regular expression matching a radio target.")
6006 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
6007 "Regular expression matching any target.")
6009 (defun org-activate-target-links (limit)
6010 "Run through the buffer and add overlays to target matches."
6011 (when org-target-link-regexp
6012 (let ((case-fold-search t))
6013 (if (re-search-forward org-target-link-regexp limit t)
6014 (progn
6015 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6016 (add-text-properties (match-beginning 0) (match-end 0)
6017 (list 'mouse-face 'highlight
6018 'keymap org-mouse-map
6019 'help-echo "Radio target link"
6020 'org-linked-text t))
6021 (org-rear-nonsticky-at (match-end 0))
6022 t)))))
6024 (defun org-update-radio-target-regexp ()
6025 "Find all radio targets in this file and update the regular expression."
6026 (interactive)
6027 (when (memq 'radio org-activate-links)
6028 (setq org-target-link-regexp
6029 (org-make-target-link-regexp (org-all-targets 'radio)))
6030 (org-restart-font-lock)))
6032 (defun org-hide-wide-columns (limit)
6033 (let (s e)
6034 (setq s (text-property-any (point) (or limit (point-max))
6035 'org-cwidth t))
6036 (when s
6037 (setq e (next-single-property-change s 'org-cwidth))
6038 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6039 (goto-char e)
6040 t)))
6042 (defvar org-latex-and-related-regexp nil
6043 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6044 (defvar org-match-substring-regexp)
6045 (defvar org-match-substring-with-braces-regexp)
6047 (defun org-compute-latex-and-related-regexp ()
6048 "Compute regular expression for LaTeX, entities and sub/superscript.
6049 Result depends on variable `org-highlight-latex-and-related'."
6050 (org-set-local
6051 'org-latex-and-related-regexp
6052 (let* ((re-sub
6053 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6054 ((eq org-use-sub-superscripts '{})
6055 (list org-match-substring-with-braces-regexp))
6056 (org-use-sub-superscripts (list org-match-substring-regexp))))
6057 (re-latex
6058 (when (memq 'latex org-highlight-latex-and-related)
6059 (let ((matchers (plist-get org-format-latex-options :matchers)))
6060 (delq nil
6061 (mapcar (lambda (x)
6062 (and (member (car x) matchers) (nth 1 x)))
6063 org-latex-regexps)))))
6064 (re-entities
6065 (when (memq 'entities org-highlight-latex-and-related)
6066 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6067 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6069 (defun org-do-latex-and-related (limit)
6070 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6071 LIMIT bounds the search for syntax to highlight. Stop at first
6072 highlighted object, if any. Return t if some highlighting was
6073 done, nil otherwise."
6074 (when (org-string-nw-p org-latex-and-related-regexp)
6075 (catch 'found
6076 (while (re-search-forward org-latex-and-related-regexp limit t)
6077 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6078 'face))
6079 '(org-code org-verbatim underline))
6080 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6081 '(?_ ?^))
6083 0)))
6084 (font-lock-prepend-text-property
6085 (+ offset (match-beginning 0)) (match-end 0)
6086 'face 'org-latex-and-related)
6087 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6088 '(font-lock-multiline t)))
6089 (throw 'found t)))
6090 nil)))
6092 (defun org-restart-font-lock ()
6093 "Restart `font-lock-mode', to force refontification."
6094 (when (and (boundp 'font-lock-mode) font-lock-mode)
6095 (font-lock-mode -1)
6096 (font-lock-mode 1)))
6098 (defun org-all-targets (&optional radio)
6099 "Return a list of all targets in this file.
6100 When optional argument RADIO is non-nil, only find radio
6101 targets."
6102 (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
6103 (save-excursion
6104 (goto-char (point-min))
6105 (while (re-search-forward re nil t)
6106 ;; Make sure point is really within the object.
6107 (backward-char)
6108 (let ((obj (org-element-context)))
6109 (when (memq (org-element-type obj) '(radio-target target))
6110 (add-to-list 'rtn (downcase (org-element-property :value obj))))))
6111 rtn)))
6113 (defun org-make-target-link-regexp (targets)
6114 "Make regular expression matching all strings in TARGETS.
6115 The regular expression finds the targets also if there is a line break
6116 between words."
6117 (and targets
6118 (concat
6119 "\\_<\\("
6120 (mapconcat
6121 (lambda (x)
6122 (setq x (regexp-quote x))
6123 (while (string-match " +" x)
6124 (setq x (replace-match "\\s-+" t t x)))
6126 targets
6127 "\\|")
6128 "\\)\\_>")))
6130 (defun org-activate-tags (limit)
6131 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6132 (progn
6133 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6134 (add-text-properties (match-beginning 1) (match-end 1)
6135 (list 'mouse-face 'highlight
6136 'keymap org-mouse-map))
6137 (org-rear-nonsticky-at (match-end 1))
6138 t)))
6140 (defun org-outline-level ()
6141 "Compute the outline level of the heading at point.
6142 If this is called at a normal headline, the level is the number of stars.
6143 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6144 (save-excursion
6145 (if (not (condition-case nil
6146 (org-back-to-heading t)
6147 (error nil)))
6149 (looking-at org-outline-regexp)
6150 (1- (- (match-end 0) (match-beginning 0))))))
6152 (defvar org-font-lock-keywords nil)
6154 (defsubst org-re-property (property &optional literal allow-null)
6155 "Return a regexp matching a PROPERTY line.
6156 Match group 3 will be set to the value if it exists."
6157 (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
6158 (if literal property (regexp-quote property))
6159 "\\):\\)[ \t]+\\(?3:[^ \t\r\n]"
6160 (if allow-null "*")
6161 ".*?\\)\\(?5:[ \t]*\\)$"))
6163 (defconst org-property-re
6164 (org-re-property ".*?" 'literal t)
6165 "Regular expression matching a property line.
6166 There are four matching groups:
6167 1: :PROPKEY: including the leading and trailing colon,
6168 2: PROPKEY without the leading and trailing colon,
6169 3: PROPVAL without leading or trailing spaces,
6170 4: the indentation of the current line,
6171 5: trailing whitespace.")
6173 (defvar org-font-lock-hook nil
6174 "Functions to be called for special font lock stuff.")
6176 (defvar org-font-lock-set-keywords-hook nil
6177 "Functions that can manipulate `org-font-lock-extra-keywords'.
6178 This is called after `org-font-lock-extra-keywords' is defined, but before
6179 it is installed to be used by font lock. This can be useful if something
6180 needs to be inserted at a specific position in the font-lock sequence.")
6182 (defun org-font-lock-hook (limit)
6183 "Run `org-font-lock-hook' within LIMIT."
6184 (run-hook-with-args 'org-font-lock-hook limit))
6186 (defun org-set-font-lock-defaults ()
6187 "Set font lock defaults for the current buffer."
6188 (let* ((em org-fontify-emphasized-text)
6189 (lk org-activate-links)
6190 (org-font-lock-extra-keywords
6191 (list
6192 ;; Call the hook
6193 '(org-font-lock-hook)
6194 ;; Headlines
6195 `(,(if org-fontify-whole-heading-line
6196 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6197 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6198 (1 (org-get-level-face 1))
6199 (2 (org-get-level-face 2))
6200 (3 (org-get-level-face 3)))
6201 ;; Table lines
6202 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6203 (1 'org-table t))
6204 ;; Table internals
6205 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6206 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6207 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6208 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6209 ;; Drawers
6210 (list org-drawer-regexp '(0 'org-special-keyword t))
6211 (list "^[ \t]*:END:" '(0 'org-special-keyword t))
6212 ;; Properties
6213 (list org-property-re
6214 '(1 'org-special-keyword t)
6215 '(3 'org-property-value t))
6216 ;; Links
6217 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6218 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6219 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6220 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6221 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6222 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6223 (if (memq 'footnote lk) '(org-activate-footnote-links))
6224 ;; Targets.
6225 (list org-any-target-regexp '(0 'org-target t))
6226 ;; Diary sexps.
6227 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6228 ;; Macro
6229 '("{{{.+}}}" (0 'org-macro t))
6230 '(org-hide-wide-columns (0 nil append))
6231 ;; TODO keyword
6232 (list (format org-heading-keyword-regexp-format
6233 org-todo-regexp)
6234 '(2 (org-get-todo-face 2) t))
6235 ;; DONE
6236 (if org-fontify-done-headline
6237 (list (format org-heading-keyword-regexp-format
6238 (concat
6239 "\\(?:"
6240 (mapconcat 'regexp-quote org-done-keywords "\\|")
6241 "\\)"))
6242 '(2 'org-headline-done t))
6243 nil)
6244 ;; Priorities
6245 '(org-font-lock-add-priority-faces)
6246 ;; Tags
6247 '(org-font-lock-add-tag-faces)
6248 ;; Tags groups
6249 (if (and org-group-tags org-tag-groups-alist)
6250 (list (concat org-outline-regexp-bol ".+\\(:"
6251 (regexp-opt (mapcar 'car org-tag-groups-alist))
6252 ":\\).*$")
6253 '(1 'org-tag-group prepend)))
6254 ;; Special keywords
6255 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6256 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6257 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6258 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6259 ;; Emphasis
6260 (if em
6261 (if (featurep 'xemacs)
6262 '(org-do-emphasis-faces (0 nil append))
6263 '(org-do-emphasis-faces)))
6264 ;; Checkboxes
6265 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6266 1 'org-checkbox prepend)
6267 (if (cdr (assq 'checkbox org-list-automatic-rules))
6268 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6269 (0 (org-get-checkbox-statistics-face) t)))
6270 ;; Description list items
6271 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6272 1 'org-list-dt prepend)
6273 ;; ARCHIVEd headings
6274 (list (concat
6275 org-outline-regexp-bol
6276 "\\(.*:" org-archive-tag ":.*\\)")
6277 '(1 'org-archived prepend))
6278 ;; Specials
6279 '(org-do-latex-and-related)
6280 '(org-fontify-entities)
6281 '(org-raise-scripts)
6282 ;; Code
6283 '(org-activate-code (1 'org-code t))
6284 ;; COMMENT
6285 (list (format org-heading-keyword-regexp-format
6286 (concat "\\("
6287 org-comment-string "\\|" org-quote-string
6288 "\\)"))
6289 '(2 'org-special-keyword t))
6290 ;; Blocks and meta lines
6291 '(org-fontify-meta-lines-and-blocks))))
6292 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6293 (run-hooks 'org-font-lock-set-keywords-hook)
6294 ;; Now set the full font-lock-keywords
6295 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6296 (org-set-local 'font-lock-defaults
6297 '(org-font-lock-keywords t nil nil backward-paragraph))
6298 (kill-local-variable 'font-lock-keywords) nil))
6300 (defun org-toggle-pretty-entities ()
6301 "Toggle the composition display of entities as UTF8 characters."
6302 (interactive)
6303 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6304 (org-restart-font-lock)
6305 (if org-pretty-entities
6306 (message "Entities are now displayed as UTF8 characters")
6307 (save-restriction
6308 (widen)
6309 (org-decompose-region (point-min) (point-max))
6310 (message "Entities are now displayed as plain text"))))
6312 (defvar org-custom-properties-overlays nil
6313 "List of overlays used for custom properties.")
6314 (make-variable-buffer-local 'org-custom-properties-overlays)
6316 (defun org-toggle-custom-properties-visibility ()
6317 "Display or hide properties in `org-custom-properties'."
6318 (interactive)
6319 (if org-custom-properties-overlays
6320 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6321 (setq org-custom-properties-overlays nil))
6322 (unless (not org-custom-properties)
6323 (save-excursion
6324 (save-restriction
6325 (widen)
6326 (goto-char (point-min))
6327 (while (re-search-forward org-property-re nil t)
6328 (mapc (lambda(p)
6329 (when (equal p (substring (match-string 1) 1 -1))
6330 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6331 (overlay-put o 'invisible t)
6332 (overlay-put o 'org-custom-property t)
6333 (push o org-custom-properties-overlays))))
6334 org-custom-properties)))))))
6336 (defun org-fontify-entities (limit)
6337 "Find an entity to fontify."
6338 (let (ee)
6339 (when org-pretty-entities
6340 (catch 'match
6341 (while (re-search-forward
6342 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6343 limit t)
6344 (if (and (not (org-in-indented-comment-line))
6345 (setq ee (org-entity-get (match-string 1)))
6346 (= (length (nth 6 ee)) 1))
6347 (let*
6348 ((end (if (equal (match-string 2) "{}")
6349 (match-end 2)
6350 (match-end 1))))
6351 (add-text-properties
6352 (match-beginning 0) end
6353 (list 'font-lock-fontified t))
6354 (compose-region (match-beginning 0) end
6355 (nth 6 ee) nil)
6356 (backward-char 1)
6357 (throw 'match t))))
6358 nil))))
6360 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6361 "Fontify string S like in Org-mode."
6362 (with-temp-buffer
6363 (insert s)
6364 (let ((org-odd-levels-only odd-levels))
6365 (org-mode)
6366 (font-lock-fontify-buffer)
6367 (buffer-string))))
6369 (defvar org-m nil)
6370 (defvar org-l nil)
6371 (defvar org-f nil)
6372 (defun org-get-level-face (n)
6373 "Get the right face for match N in font-lock matching of headlines."
6374 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6375 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6376 (if org-cycle-level-faces
6377 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6378 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6379 (cond
6380 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6381 ((eq n 2) org-f)
6382 (t (if org-level-color-stars-only nil org-f))))
6385 (defun org-get-todo-face (kwd)
6386 "Get the right face for a TODO keyword KWD.
6387 If KWD is a number, get the corresponding match group."
6388 (if (numberp kwd) (setq kwd (match-string kwd)))
6389 (or (org-face-from-face-or-color
6390 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6391 (and (member kwd org-done-keywords) 'org-done)
6392 'org-todo))
6394 (defun org-face-from-face-or-color (context inherit face-or-color)
6395 "Create a face list that inherits INHERIT, but sets the foreground color.
6396 When FACE-OR-COLOR is not a string, just return it."
6397 (if (stringp face-or-color)
6398 (list :inherit inherit
6399 (cdr (assoc context org-faces-easy-properties))
6400 face-or-color)
6401 face-or-color))
6403 (defun org-font-lock-add-tag-faces (limit)
6404 "Add the special tag faces."
6405 (when (and org-tag-faces org-tags-special-faces-re)
6406 (while (re-search-forward org-tags-special-faces-re limit t)
6407 (add-text-properties (match-beginning 1) (match-end 1)
6408 (list 'face (org-get-tag-face 1)
6409 'font-lock-fontified t))
6410 (backward-char 1))))
6412 (defun org-font-lock-add-priority-faces (limit)
6413 "Add the special priority faces."
6414 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6415 (when (save-match-data (org-at-heading-p))
6416 (add-text-properties
6417 (match-beginning 0) (match-end 0)
6418 (list 'face (or (org-face-from-face-or-color
6419 'priority 'org-priority
6420 (cdr (assoc (char-after (match-beginning 1))
6421 org-priority-faces)))
6422 'org-priority)
6423 'font-lock-fontified t)))))
6425 (defun org-get-tag-face (kwd)
6426 "Get the right face for a TODO keyword KWD.
6427 If KWD is a number, get the corresponding match group."
6428 (if (numberp kwd) (setq kwd (match-string kwd)))
6429 (or (org-face-from-face-or-color
6430 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6431 'org-tag))
6433 (defun org-unfontify-region (beg end &optional maybe_loudly)
6434 "Remove fontification and activation overlays from links."
6435 (font-lock-default-unfontify-region beg end)
6436 (let* ((buffer-undo-list t)
6437 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6438 (inhibit-modification-hooks t)
6439 deactivate-mark buffer-file-name buffer-file-truename)
6440 (org-decompose-region beg end)
6441 (remove-text-properties beg end
6442 '(mouse-face t keymap t org-linked-text t
6443 invisible t intangible t
6444 org-no-flyspell t org-emphasis t))
6445 (org-remove-font-lock-display-properties beg end)))
6447 (defconst org-script-display '(((raise -0.3) (height 0.7))
6448 ((raise 0.3) (height 0.7))
6449 ((raise -0.5))
6450 ((raise 0.5)))
6451 "Display properties for showing superscripts and subscripts.")
6453 (defun org-remove-font-lock-display-properties (beg end)
6454 "Remove specific display properties that have been added by font lock.
6455 The will remove the raise properties that are used to show superscripts
6456 and subscripts."
6457 (let (next prop)
6458 (while (< beg end)
6459 (setq next (next-single-property-change beg 'display nil end)
6460 prop (get-text-property beg 'display))
6461 (if (member prop org-script-display)
6462 (put-text-property beg next 'display nil))
6463 (setq beg next))))
6465 (defun org-raise-scripts (limit)
6466 "Add raise properties to sub/superscripts."
6467 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6468 (if (re-search-forward
6469 (if (eq org-use-sub-superscripts t)
6470 org-match-substring-regexp
6471 org-match-substring-with-braces-regexp)
6472 limit t)
6473 (let* ((pos (point)) table-p comment-p
6474 (mpos (match-beginning 3))
6475 (emph-p (get-text-property mpos 'org-emphasis))
6476 (link-p (get-text-property mpos 'mouse-face))
6477 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6478 (goto-char (point-at-bol))
6479 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6480 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6481 (goto-char pos)
6482 ;; Handle a_b^c
6483 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6484 (if (or comment-p emph-p link-p keyw-p)
6486 (put-text-property (match-beginning 3) (match-end 0)
6487 'display
6488 (if (equal (char-after (match-beginning 2)) ?^)
6489 (nth (if table-p 3 1) org-script-display)
6490 (nth (if table-p 2 0) org-script-display)))
6491 (add-text-properties (match-beginning 2) (match-end 2)
6492 (list 'invisible t
6493 'org-dwidth t 'org-dwidth-n 1))
6494 (if (and (eq (char-after (match-beginning 3)) ?{)
6495 (eq (char-before (match-end 3)) ?}))
6496 (progn
6497 (add-text-properties
6498 (match-beginning 3) (1+ (match-beginning 3))
6499 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6500 (add-text-properties
6501 (1- (match-end 3)) (match-end 3)
6502 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6503 t)))))
6505 ;;;; Visibility cycling, including org-goto and indirect buffer
6507 ;;; Cycling
6509 (defvar org-cycle-global-status nil)
6510 (make-variable-buffer-local 'org-cycle-global-status)
6511 (put 'org-cycle-global-status 'org-state t)
6512 (defvar org-cycle-subtree-status nil)
6513 (make-variable-buffer-local 'org-cycle-subtree-status)
6514 (put 'org-cycle-subtree-status 'org-state t)
6516 (defvar org-inlinetask-min-level)
6518 (defun org-unlogged-message (&rest args)
6519 "Display a message, but avoid logging it in the *Messages* buffer."
6520 (let ((message-log-max nil))
6521 (apply 'message args)))
6523 ;;;###autoload
6524 (defun org-cycle (&optional arg)
6525 "TAB-action and visibility cycling for Org-mode.
6527 This is the command invoked in Org-mode by the TAB key. Its main purpose
6528 is outline visibility cycling, but it also invokes other actions
6529 in special contexts.
6531 - When this function is called with a prefix argument, rotate the entire
6532 buffer through 3 states (global cycling)
6533 1. OVERVIEW: Show only top-level headlines.
6534 2. CONTENTS: Show all headlines of all levels, but no body text.
6535 3. SHOW ALL: Show everything.
6536 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6537 determined by the variable `org-startup-folded', and by any VISIBILITY
6538 properties in the buffer.
6539 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6540 including any drawers.
6542 - When inside a table, re-align the table and move to the next field.
6544 - When point is at the beginning of a headline, rotate the subtree started
6545 by this line through 3 different states (local cycling)
6546 1. FOLDED: Only the main headline is shown.
6547 2. CHILDREN: The main headline and the direct children are shown.
6548 From this state, you can move to one of the children
6549 and zoom in further.
6550 3. SUBTREE: Show the entire subtree, including body text.
6551 If there is no subtree, switch directly from CHILDREN to FOLDED.
6553 - When point is at the beginning of an empty headline and the variable
6554 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6555 of the headline by demoting and promoting it to likely levels. This
6556 speeds up creation document structure by pressing TAB once or several
6557 times right after creating a new headline.
6559 - When there is a numeric prefix, go up to a heading with level ARG, do
6560 a `show-subtree' and return to the previous cursor position. If ARG
6561 is negative, go up that many levels.
6563 - When point is not at the beginning of a headline, execute the global
6564 binding for TAB, which is re-indenting the line. See the option
6565 `org-cycle-emulate-tab' for details.
6567 - Special case: if point is at the beginning of the buffer and there is
6568 no headline in line 1, this function will act as if called with prefix arg
6569 (C-u TAB, same as S-TAB) also when called without prefix arg.
6570 But only if also the variable `org-cycle-global-at-bob' is t."
6571 (interactive "P")
6572 (org-load-modules-maybe)
6573 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6574 (and org-cycle-level-after-item/entry-creation
6575 (or (org-cycle-level)
6576 (org-cycle-item-indentation))))
6577 (let* ((limit-level
6578 (or org-cycle-max-level
6579 (and (boundp 'org-inlinetask-min-level)
6580 org-inlinetask-min-level
6581 (1- org-inlinetask-min-level))))
6582 (nstars (and limit-level
6583 (if org-odd-levels-only
6584 (and limit-level (1- (* limit-level 2)))
6585 limit-level)))
6586 (org-outline-regexp
6587 (if (not (derived-mode-p 'org-mode))
6588 outline-regexp
6589 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6590 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6591 (not (looking-at org-outline-regexp))))
6592 (org-cycle-hook
6593 (if bob-special
6594 (delq 'org-optimize-window-after-visibility-change
6595 (copy-sequence org-cycle-hook))
6596 org-cycle-hook))
6597 (pos (point)))
6599 (if (or bob-special (equal arg '(4)))
6600 ;; special case: use global cycling
6601 (setq arg t))
6603 (cond
6605 ((equal arg '(16))
6606 (setq last-command 'dummy)
6607 (org-set-startup-visibility)
6608 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6610 ((equal arg '(64))
6611 (show-all)
6612 (org-unlogged-message "Entire buffer visible, including drawers"))
6614 ;; Try cdlatex TAB completion
6615 ((org-try-cdlatex-tab))
6617 ;; Table: enter it or move to the next field.
6618 ((org-at-table-p 'any)
6619 (if (org-at-table.el-p)
6620 (message "Use C-c ' to edit table.el tables")
6621 (if arg (org-table-edit-field t)
6622 (org-table-justify-field-maybe)
6623 (call-interactively 'org-table-next-field))))
6625 ((run-hook-with-args-until-success
6626 'org-tab-after-check-for-table-hook))
6628 ;; Global cycling: delegate to `org-cycle-internal-global'.
6629 ((eq arg t) (org-cycle-internal-global))
6631 ;; Drawers: delegate to `org-flag-drawer'.
6632 ((and org-drawers org-drawer-regexp
6633 (save-excursion
6634 (beginning-of-line 1)
6635 (looking-at org-drawer-regexp)))
6636 (org-flag-drawer ; toggle block visibility
6637 (not (get-char-property (match-end 0) 'invisible))))
6639 ;; Show-subtree, ARG levels up from here.
6640 ((integerp arg)
6641 (save-excursion
6642 (org-back-to-heading)
6643 (outline-up-heading (if (< arg 0) (- arg)
6644 (- (funcall outline-level) arg)))
6645 (org-show-subtree)))
6647 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6648 ((and (featurep 'org-inlinetask)
6649 (org-inlinetask-at-task-p)
6650 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6651 (org-inlinetask-toggle-visibility))
6653 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6654 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6655 (save-excursion (beginning-of-line 1)
6656 (looking-at org-outline-regexp)))
6657 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6658 (org-cycle-internal-local))
6660 ;; From there: TAB emulation and template completion.
6661 (buffer-read-only (org-back-to-heading))
6663 ((run-hook-with-args-until-success
6664 'org-tab-after-check-for-cycling-hook))
6666 ((org-try-structure-completion))
6668 ((run-hook-with-args-until-success
6669 'org-tab-before-tab-emulation-hook))
6671 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6672 (or (not (bolp))
6673 (not (looking-at org-outline-regexp))))
6674 (call-interactively (global-key-binding "\t")))
6676 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6677 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6678 (or (and (eq org-cycle-emulate-tab 'white)
6679 (= (match-end 0) (point-at-eol)))
6680 (and (eq org-cycle-emulate-tab 'whitestart)
6681 (>= (match-end 0) pos))))
6683 (eq org-cycle-emulate-tab t))
6684 (call-interactively (global-key-binding "\t")))
6686 (t (save-excursion
6687 (org-back-to-heading)
6688 (org-cycle)))))))
6690 (defun org-cycle-internal-global ()
6691 "Do the global cycling action."
6692 ;; Hack to avoid display of messages for .org attachments in Gnus
6693 (let ((ga (string-match "\\*fontification" (buffer-name))))
6694 (cond
6695 ((and (eq last-command this-command)
6696 (eq org-cycle-global-status 'overview))
6697 ;; We just created the overview - now do table of contents
6698 ;; This can be slow in very large buffers, so indicate action
6699 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6700 (unless ga (org-unlogged-message "CONTENTS..."))
6701 (org-content)
6702 (unless ga (org-unlogged-message "CONTENTS...done"))
6703 (setq org-cycle-global-status 'contents)
6704 (run-hook-with-args 'org-cycle-hook 'contents))
6706 ((and (eq last-command this-command)
6707 (eq org-cycle-global-status 'contents))
6708 ;; We just showed the table of contents - now show everything
6709 (run-hook-with-args 'org-pre-cycle-hook 'all)
6710 (show-all)
6711 (unless ga (org-unlogged-message "SHOW ALL"))
6712 (setq org-cycle-global-status 'all)
6713 (run-hook-with-args 'org-cycle-hook 'all))
6716 ;; Default action: go to overview
6717 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6718 (org-overview)
6719 (unless ga (org-unlogged-message "OVERVIEW"))
6720 (setq org-cycle-global-status 'overview)
6721 (run-hook-with-args 'org-cycle-hook 'overview)))))
6723 (defvar org-called-with-limited-levels nil
6724 "Non-nil when `org-with-limited-levels' is currently active.")
6726 (defun org-cycle-internal-local ()
6727 "Do the local cycling action."
6728 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6729 ;; First, determine end of headline (EOH), end of subtree or item
6730 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6731 (save-excursion
6732 (if (org-at-item-p)
6733 (progn
6734 (beginning-of-line)
6735 (setq struct (org-list-struct))
6736 (setq eoh (point-at-eol))
6737 (setq eos (org-list-get-item-end-before-blank (point) struct))
6738 (setq has-children (org-list-has-child-p (point) struct)))
6739 (org-back-to-heading)
6740 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6741 (setq eos (save-excursion (org-end-of-subtree t t)
6742 (when (bolp) (backward-char)) (point)))
6743 (setq has-children
6744 (or (save-excursion
6745 (let ((level (funcall outline-level)))
6746 (outline-next-heading)
6747 (and (org-at-heading-p t)
6748 (> (funcall outline-level) level))))
6749 (save-excursion
6750 (org-list-search-forward (org-item-beginning-re) eos t)))))
6751 ;; Determine end invisible part of buffer (EOL)
6752 (beginning-of-line 2)
6753 ;; XEmacs doesn't have `next-single-char-property-change'
6754 (if (featurep 'xemacs)
6755 (while (and (not (eobp)) ;; this is like `next-line'
6756 (get-char-property (1- (point)) 'invisible))
6757 (beginning-of-line 2))
6758 (while (and (not (eobp)) ;; this is like `next-line'
6759 (get-char-property (1- (point)) 'invisible))
6760 (goto-char (next-single-char-property-change (point) 'invisible))
6761 (and (eolp) (beginning-of-line 2))))
6762 (setq eol (point)))
6763 ;; Find out what to do next and set `this-command'
6764 (cond
6765 ((= eos eoh)
6766 ;; Nothing is hidden behind this heading
6767 (unless (org-before-first-heading-p)
6768 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6769 (org-unlogged-message "EMPTY ENTRY")
6770 (setq org-cycle-subtree-status nil)
6771 (save-excursion
6772 (goto-char eos)
6773 (outline-next-heading)
6774 (if (outline-invisible-p) (org-flag-heading nil))))
6775 ((and (or (>= eol eos)
6776 (not (string-match "\\S-" (buffer-substring eol eos))))
6777 (or has-children
6778 (not (setq children-skipped
6779 org-cycle-skip-children-state-if-no-children))))
6780 ;; Entire subtree is hidden in one line: children view
6781 (unless (org-before-first-heading-p)
6782 (run-hook-with-args 'org-pre-cycle-hook 'children))
6783 (if (org-at-item-p)
6784 (org-list-set-item-visibility (point-at-bol) struct 'children)
6785 (org-show-entry)
6786 (org-with-limited-levels (show-children))
6787 ;; FIXME: This slows down the func way too much.
6788 ;; How keep drawers hidden in subtree anyway?
6789 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6790 ;; (org-cycle-hide-drawers 'subtree))
6792 ;; Fold every list in subtree to top-level items.
6793 (when (eq org-cycle-include-plain-lists 'integrate)
6794 (save-excursion
6795 (org-back-to-heading)
6796 (while (org-list-search-forward (org-item-beginning-re) eos t)
6797 (beginning-of-line 1)
6798 (let* ((struct (org-list-struct))
6799 (prevs (org-list-prevs-alist struct))
6800 (end (org-list-get-bottom-point struct)))
6801 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6802 (org-list-get-all-items (point) struct prevs))
6803 (goto-char (if (< end eos) end eos)))))))
6804 (org-unlogged-message "CHILDREN")
6805 (save-excursion
6806 (goto-char eos)
6807 (outline-next-heading)
6808 (if (outline-invisible-p) (org-flag-heading nil)))
6809 (setq org-cycle-subtree-status 'children)
6810 (unless (org-before-first-heading-p)
6811 (run-hook-with-args 'org-cycle-hook 'children)))
6812 ((or children-skipped
6813 (and (eq last-command this-command)
6814 (eq org-cycle-subtree-status 'children)))
6815 ;; We just showed the children, or no children are there,
6816 ;; now show everything.
6817 (unless (org-before-first-heading-p)
6818 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6819 (outline-flag-region eoh eos nil)
6820 (org-unlogged-message
6821 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6822 (setq org-cycle-subtree-status 'subtree)
6823 (unless (org-before-first-heading-p)
6824 (run-hook-with-args 'org-cycle-hook 'subtree)))
6826 ;; Default action: hide the subtree.
6827 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6828 (outline-flag-region eoh eos t)
6829 (org-unlogged-message "FOLDED")
6830 (setq org-cycle-subtree-status 'folded)
6831 (unless (org-before-first-heading-p)
6832 (run-hook-with-args 'org-cycle-hook 'folded))))))
6834 ;;;###autoload
6835 (defun org-global-cycle (&optional arg)
6836 "Cycle the global visibility. For details see `org-cycle'.
6837 With \\[universal-argument] prefix arg, switch to startup visibility.
6838 With a numeric prefix, show all headlines up to that level."
6839 (interactive "P")
6840 (let ((org-cycle-include-plain-lists
6841 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6842 (cond
6843 ((integerp arg)
6844 (show-all)
6845 (hide-sublevels arg)
6846 (setq org-cycle-global-status 'contents))
6847 ((equal arg '(4))
6848 (org-set-startup-visibility)
6849 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6851 (org-cycle '(4))))))
6853 (defun org-set-startup-visibility ()
6854 "Set the visibility required by startup options and properties."
6855 (cond
6856 ((eq org-startup-folded t)
6857 (org-overview))
6858 ((eq org-startup-folded 'content)
6859 (org-content))
6860 ((or (eq org-startup-folded 'showeverything)
6861 (eq org-startup-folded nil))
6862 (show-all)))
6863 (unless (eq org-startup-folded 'showeverything)
6864 (if org-hide-block-startup (org-hide-block-all))
6865 (org-set-visibility-according-to-property 'no-cleanup)
6866 (org-cycle-hide-archived-subtrees 'all)
6867 (org-cycle-hide-drawers 'all)
6868 (org-cycle-show-empty-lines t)))
6870 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6871 "Switch subtree visibilities according to :VISIBILITY: property."
6872 (interactive)
6873 (let (org-show-entry-below state)
6874 (save-excursion
6875 (goto-char (point-min))
6876 (while (re-search-forward
6877 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6878 nil t)
6879 (setq state (match-string 1))
6880 (save-excursion
6881 (org-back-to-heading t)
6882 (hide-subtree)
6883 (org-reveal)
6884 (cond
6885 ((equal state '("fold" "folded"))
6886 (hide-subtree))
6887 ((equal state "children")
6888 (org-show-hidden-entry)
6889 (show-children))
6890 ((equal state "content")
6891 (save-excursion
6892 (save-restriction
6893 (org-narrow-to-subtree)
6894 (org-content))))
6895 ((member state '("all" "showall"))
6896 (show-subtree)))))
6897 (unless no-cleanup
6898 (org-cycle-hide-archived-subtrees 'all)
6899 (org-cycle-hide-drawers 'all)
6900 (org-cycle-show-empty-lines 'all)))))
6902 ;; This function uses outline-regexp instead of the more fundamental
6903 ;; org-outline-regexp so that org-cycle-global works outside of Org
6904 ;; buffers, where outline-regexp is needed.
6905 (defun org-overview ()
6906 "Switch to overview mode, showing only top-level headlines.
6907 This shows all headlines with a level equal or greater than the level
6908 of the first headline in the buffer. This is important, because if the
6909 first headline is not level one, then (hide-sublevels 1) gives confusing
6910 results."
6911 (interactive)
6912 (save-excursion
6913 (let ((level
6914 (save-excursion
6915 (goto-char (point-min))
6916 (if (re-search-forward (concat "^" outline-regexp) nil t)
6917 (progn
6918 (goto-char (match-beginning 0))
6919 (funcall outline-level))))))
6920 (and level (hide-sublevels level)))))
6922 (defun org-content (&optional arg)
6923 "Show all headlines in the buffer, like a table of contents.
6924 With numerical argument N, show content up to level N."
6925 (interactive "P")
6926 (org-overview)
6927 (save-excursion
6928 ;; Visit all headings and show their offspring
6929 (and (integerp arg) (org-overview))
6930 (goto-char (point-max))
6931 (catch 'exit
6932 (while (and (progn (condition-case nil
6933 (outline-previous-visible-heading 1)
6934 (error (goto-char (point-min))))
6936 (looking-at org-outline-regexp))
6937 (if (integerp arg)
6938 (show-children (1- arg))
6939 (show-branches))
6940 (if (bobp) (throw 'exit nil))))))
6942 (defun org-optimize-window-after-visibility-change (state)
6943 "Adjust the window after a change in outline visibility.
6944 This function is the default value of the hook `org-cycle-hook'."
6945 (when (get-buffer-window (current-buffer))
6946 (cond
6947 ((eq state 'content) nil)
6948 ((eq state 'all) nil)
6949 ((eq state 'folded) nil)
6950 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6951 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6953 (defun org-remove-empty-overlays-at (pos)
6954 "Remove outline overlays that do not contain non-white stuff."
6955 (mapc
6956 (lambda (o)
6957 (and (eq 'outline (overlay-get o 'invisible))
6958 (not (string-match "\\S-" (buffer-substring (overlay-start o)
6959 (overlay-end o))))
6960 (delete-overlay o)))
6961 (overlays-at pos)))
6963 (defun org-clean-visibility-after-subtree-move ()
6964 "Fix visibility issues after moving a subtree."
6965 ;; First, find a reasonable region to look at:
6966 ;; Start two siblings above, end three below
6967 (let* ((beg (save-excursion
6968 (and (org-get-last-sibling)
6969 (org-get-last-sibling))
6970 (point)))
6971 (end (save-excursion
6972 (and (org-get-next-sibling)
6973 (org-get-next-sibling)
6974 (org-get-next-sibling))
6975 (if (org-at-heading-p)
6976 (point-at-eol)
6977 (point))))
6978 (level (looking-at "\\*+"))
6979 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
6980 (save-excursion
6981 (save-restriction
6982 (narrow-to-region beg end)
6983 (when re
6984 ;; Properly fold already folded siblings
6985 (goto-char (point-min))
6986 (while (re-search-forward re nil t)
6987 (if (and (not (outline-invisible-p))
6988 (save-excursion
6989 (goto-char (point-at-eol)) (outline-invisible-p)))
6990 (hide-entry))))
6991 (org-cycle-show-empty-lines 'overview)
6992 (org-cycle-hide-drawers 'overview)))))
6994 (defun org-cycle-show-empty-lines (state)
6995 "Show empty lines above all visible headlines.
6996 The region to be covered depends on STATE when called through
6997 `org-cycle-hook'. Lisp program can use t for STATE to get the
6998 entire buffer covered. Note that an empty line is only shown if there
6999 are at least `org-cycle-separator-lines' empty lines before the headline."
7000 (when (not (= org-cycle-separator-lines 0))
7001 (save-excursion
7002 (let* ((n (abs org-cycle-separator-lines))
7003 (re (cond
7004 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7005 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7006 (t (let ((ns (number-to-string (- n 2))))
7007 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7008 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7009 beg end b e)
7010 (cond
7011 ((memq state '(overview contents t))
7012 (setq beg (point-min) end (point-max)))
7013 ((memq state '(children folded))
7014 (setq beg (point) end (progn (org-end-of-subtree t t)
7015 (beginning-of-line 2)
7016 (point)))))
7017 (when beg
7018 (goto-char beg)
7019 (while (re-search-forward re end t)
7020 (unless (get-char-property (match-end 1) 'invisible)
7021 (setq e (match-end 1))
7022 (if (< org-cycle-separator-lines 0)
7023 (setq b (save-excursion
7024 (goto-char (match-beginning 0))
7025 (org-back-over-empty-lines)
7026 (if (save-excursion
7027 (goto-char (max (point-min) (1- (point))))
7028 (org-at-heading-p))
7029 (1- (point))
7030 (point))))
7031 (setq b (match-beginning 1)))
7032 (outline-flag-region b e nil)))))))
7033 ;; Never hide empty lines at the end of the file.
7034 (save-excursion
7035 (goto-char (point-max))
7036 (outline-previous-heading)
7037 (outline-end-of-heading)
7038 (if (and (looking-at "[ \t\n]+")
7039 (= (match-end 0) (point-max)))
7040 (outline-flag-region (point) (match-end 0) nil))))
7042 (defun org-show-empty-lines-in-parent ()
7043 "Move to the parent and re-show empty lines before visible headlines."
7044 (save-excursion
7045 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7046 (org-cycle-show-empty-lines context))))
7048 (defun org-files-list ()
7049 "Return `org-agenda-files' list, plus all open org-mode files.
7050 This is useful for operations that need to scan all of a user's
7051 open and agenda-wise Org files."
7052 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7053 (dolist (buf (buffer-list))
7054 (with-current-buffer buf
7055 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7056 (let ((file (expand-file-name (buffer-file-name))))
7057 (unless (member file files)
7058 (push file files))))))
7059 files))
7061 (defsubst org-entry-beginning-position ()
7062 "Return the beginning position of the current entry."
7063 (save-excursion (outline-back-to-heading t) (point)))
7065 (defsubst org-entry-end-position ()
7066 "Return the end position of the current entry."
7067 (save-excursion (outline-next-heading) (point)))
7069 (defun org-cycle-hide-drawers (state)
7070 "Re-hide all drawers after a visibility state change."
7071 (when (and (derived-mode-p 'org-mode)
7072 (not (memq state '(overview folded contents))))
7073 (save-excursion
7074 (let* ((globalp (memq state '(contents all)))
7075 (beg (if globalp (point-min) (point)))
7076 (end (if globalp (point-max)
7077 (if (eq state 'children)
7078 (save-excursion (outline-next-heading) (point))
7079 (org-end-of-subtree t)))))
7080 (goto-char beg)
7081 (while (re-search-forward org-drawer-regexp end t)
7082 (org-flag-drawer t))))))
7084 (defun org-cycle-hide-inline-tasks (state)
7085 "Re-hide inline tasks when switching to 'contents or 'children
7086 visibility state."
7087 (case state
7088 (contents
7089 (when (org-bound-and-true-p org-inlinetask-min-level)
7090 (hide-sublevels (1- org-inlinetask-min-level))))
7091 (children
7092 (when (featurep 'org-inlinetask)
7093 (save-excursion
7094 (while (and (outline-next-heading)
7095 (org-inlinetask-at-task-p))
7096 (org-inlinetask-toggle-visibility)
7097 (org-inlinetask-goto-end)))))))
7099 (defun org-flag-drawer (flag)
7100 "When FLAG is non-nil, hide the drawer we are within.
7101 Otherwise make it visible."
7102 (save-excursion
7103 (beginning-of-line 1)
7104 (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
7105 (let ((b (match-end 0)))
7106 (if (re-search-forward
7107 "^[ \t]*:END:"
7108 (save-excursion (outline-next-heading) (point)) t)
7109 (outline-flag-region b (point-at-eol) flag)
7110 (user-error ":END: line missing at position %s" b))))))
7112 (defun org-subtree-end-visible-p ()
7113 "Is the end of the current subtree visible?"
7114 (pos-visible-in-window-p
7115 (save-excursion (org-end-of-subtree t) (point))))
7117 (defun org-first-headline-recenter ()
7118 "Move cursor to the first headline and recenter the headline."
7119 (goto-char (point-min))
7120 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7121 (set-window-start (selected-window) (point-at-bol))))
7123 ;;; Saving and restoring visibility
7125 (defun org-outline-overlay-data (&optional use-markers)
7126 "Return a list of the locations of all outline overlays.
7127 These are overlays with the `invisible' property value `outline'.
7128 The return value is a list of cons cells, with start and stop
7129 positions for each overlay.
7130 If USE-MARKERS is set, return the positions as markers."
7131 (let (beg end)
7132 (save-excursion
7133 (save-restriction
7134 (widen)
7135 (delq nil
7136 (mapcar (lambda (o)
7137 (when (eq (overlay-get o 'invisible) 'outline)
7138 (setq beg (overlay-start o)
7139 end (overlay-end o))
7140 (and beg end (> end beg)
7141 (if use-markers
7142 (cons (move-marker (make-marker) beg)
7143 (move-marker (make-marker) end))
7144 (cons beg end)))))
7145 (overlays-in (point-min) (point-max))))))))
7147 (defun org-set-outline-overlay-data (data)
7148 "Create visibility overlays for all positions in DATA.
7149 DATA should have been made by `org-outline-overlay-data'."
7150 (let (o)
7151 (save-excursion
7152 (save-restriction
7153 (widen)
7154 (show-all)
7155 (mapc (lambda (c)
7156 (outline-flag-region (car c) (cdr c) t))
7157 data)))))
7159 ;;; Folding of blocks
7161 (defvar org-hide-block-overlays nil
7162 "Overlays hiding blocks.")
7163 (make-variable-buffer-local 'org-hide-block-overlays)
7165 (defun org-block-map (function &optional start end)
7166 "Call FUNCTION at the head of all source blocks in the current buffer.
7167 Optional arguments START and END can be used to limit the range."
7168 (let ((start (or start (point-min)))
7169 (end (or end (point-max))))
7170 (save-excursion
7171 (goto-char start)
7172 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7173 (save-excursion
7174 (save-match-data
7175 (goto-char (match-beginning 0))
7176 (funcall function)))))))
7178 (defun org-hide-block-toggle-all ()
7179 "Toggle the visibility of all blocks in the current buffer."
7180 (org-block-map #'org-hide-block-toggle))
7182 (defun org-hide-block-all ()
7183 "Fold all blocks in the current buffer."
7184 (interactive)
7185 (org-show-block-all)
7186 (org-block-map #'org-hide-block-toggle-maybe))
7188 (defun org-show-block-all ()
7189 "Unfold all blocks in the current buffer."
7190 (interactive)
7191 (mapc 'delete-overlay org-hide-block-overlays)
7192 (setq org-hide-block-overlays nil))
7194 (defun org-hide-block-toggle-maybe ()
7195 "Toggle visibility of block at point."
7196 (interactive)
7197 (let ((case-fold-search t))
7198 (if (save-excursion
7199 (beginning-of-line 1)
7200 (looking-at org-block-regexp))
7201 (progn (org-hide-block-toggle)
7202 t) ;; to signal that we took action
7203 nil))) ;; to signal that we did not
7205 (defun org-hide-block-toggle (&optional force)
7206 "Toggle the visibility of the current block."
7207 (interactive)
7208 (save-excursion
7209 (beginning-of-line)
7210 (if (re-search-forward org-block-regexp nil t)
7211 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7212 (end (match-end 0)) ;; end of entire body
7214 (if (memq t (mapcar (lambda (overlay)
7215 (eq (overlay-get overlay 'invisible)
7216 'org-hide-block))
7217 (overlays-at start)))
7218 (if (or (not force) (eq force 'off))
7219 (mapc (lambda (ov)
7220 (when (member ov org-hide-block-overlays)
7221 (setq org-hide-block-overlays
7222 (delq ov org-hide-block-overlays)))
7223 (when (eq (overlay-get ov 'invisible)
7224 'org-hide-block)
7225 (delete-overlay ov)))
7226 (overlays-at start)))
7227 (setq ov (make-overlay start end))
7228 (overlay-put ov 'invisible 'org-hide-block)
7229 ;; make the block accessible to isearch
7230 (overlay-put
7231 ov 'isearch-open-invisible
7232 (lambda (ov)
7233 (when (member ov org-hide-block-overlays)
7234 (setq org-hide-block-overlays
7235 (delq ov org-hide-block-overlays)))
7236 (when (eq (overlay-get ov 'invisible)
7237 'org-hide-block)
7238 (delete-overlay ov))))
7239 (push ov org-hide-block-overlays)))
7240 (user-error "Not looking at a source block"))))
7242 ;; org-tab-after-check-for-cycling-hook
7243 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7244 ;; Remove overlays when changing major mode
7245 (add-hook 'org-mode-hook
7246 (lambda () (org-add-hook 'change-major-mode-hook
7247 'org-show-block-all 'append 'local)))
7249 ;;; Org-goto
7251 (defvar org-goto-window-configuration nil)
7252 (defvar org-goto-marker nil)
7253 (defvar org-goto-map)
7254 (defun org-goto-map ()
7255 "Set the keymap `org-goto'."
7256 (setq org-goto-map
7257 (let ((map (make-sparse-keymap)))
7258 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7259 mouse-drag-region universal-argument org-occur))
7260 cmd)
7261 (while (setq cmd (pop cmds))
7262 (substitute-key-definition cmd cmd map global-map)))
7263 (suppress-keymap map)
7264 (org-defkey map "\C-m" 'org-goto-ret)
7265 (org-defkey map [(return)] 'org-goto-ret)
7266 (org-defkey map [(left)] 'org-goto-left)
7267 (org-defkey map [(right)] 'org-goto-right)
7268 (org-defkey map [(control ?g)] 'org-goto-quit)
7269 (org-defkey map "\C-i" 'org-cycle)
7270 (org-defkey map [(tab)] 'org-cycle)
7271 (org-defkey map [(down)] 'outline-next-visible-heading)
7272 (org-defkey map [(up)] 'outline-previous-visible-heading)
7273 (if org-goto-auto-isearch
7274 (if (fboundp 'define-key-after)
7275 (define-key-after map [t] 'org-goto-local-auto-isearch)
7276 nil)
7277 (org-defkey map "q" 'org-goto-quit)
7278 (org-defkey map "n" 'outline-next-visible-heading)
7279 (org-defkey map "p" 'outline-previous-visible-heading)
7280 (org-defkey map "f" 'outline-forward-same-level)
7281 (org-defkey map "b" 'outline-backward-same-level)
7282 (org-defkey map "u" 'outline-up-heading))
7283 (org-defkey map "/" 'org-occur)
7284 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7285 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7286 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7287 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7288 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7289 map)))
7291 (defconst org-goto-help
7292 "Browse buffer copy, to find location or copy text.%s
7293 RET=jump to location C-g=quit and return to previous location
7294 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7296 (defvar org-goto-start-pos) ; dynamically scoped parameter
7298 (defun org-goto (&optional alternative-interface)
7299 "Look up a different location in the current file, keeping current visibility.
7301 When you want look-up or go to a different location in a
7302 document, the fastest way is often to fold the entire buffer and
7303 then dive into the tree. This method has the disadvantage, that
7304 the previous location will be folded, which may not be what you
7305 want.
7307 This command works around this by showing a copy of the current
7308 buffer in an indirect buffer, in overview mode. You can dive
7309 into the tree in that copy, use org-occur and incremental search
7310 to find a location. When pressing RET or `Q', the command
7311 returns to the original buffer in which the visibility is still
7312 unchanged. After RET it will also jump to the location selected
7313 in the indirect buffer and expose the headline hierarchy above.
7315 With a prefix argument, use the alternative interface: e.g. if
7316 `org-goto-interface' is 'outline use 'outline-path-completion."
7317 (interactive "P")
7318 (org-goto-map)
7319 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7320 (org-refile-use-outline-path t)
7321 (org-refile-target-verify-function nil)
7322 (interface
7323 (if (not alternative-interface)
7324 org-goto-interface
7325 (if (eq org-goto-interface 'outline)
7326 'outline-path-completion
7327 'outline)))
7328 (org-goto-start-pos (point))
7329 (selected-point
7330 (if (eq interface 'outline)
7331 (car (org-get-location (current-buffer) org-goto-help))
7332 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7333 (org-refile-check-position pa)
7334 (nth 3 pa)))))
7335 (if selected-point
7336 (progn
7337 (org-mark-ring-push org-goto-start-pos)
7338 (goto-char selected-point)
7339 (if (or (outline-invisible-p) (org-invisible-p2))
7340 (org-show-context 'org-goto)))
7341 (message "Quit"))))
7343 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7344 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7345 (defvar org-goto-local-auto-isearch-map) ; defined below
7347 (defun org-get-location (buf help)
7348 "Let the user select a location in the Org-mode buffer BUF.
7349 This function uses a recursive edit. It returns the selected position
7350 or nil."
7351 (org-no-popups
7352 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7353 (isearch-hide-immediately nil)
7354 (isearch-search-fun-function
7355 (lambda () 'org-goto-local-search-headings))
7356 (org-goto-selected-point org-goto-exit-command))
7357 (save-excursion
7358 (save-window-excursion
7359 (delete-other-windows)
7360 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7361 (org-pop-to-buffer-same-window
7362 (condition-case nil
7363 (make-indirect-buffer (current-buffer) "*org-goto*")
7364 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7365 (with-output-to-temp-buffer "*Org Help*"
7366 (princ (format help (if org-goto-auto-isearch
7367 " Just type for auto-isearch."
7368 " n/p/f/b/u to navigate, q to quit."))))
7369 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7370 (setq buffer-read-only nil)
7371 (let ((org-startup-truncated t)
7372 (org-startup-folded nil)
7373 (org-startup-align-all-tables nil))
7374 (org-mode)
7375 (org-overview))
7376 (setq buffer-read-only t)
7377 (if (and (boundp 'org-goto-start-pos)
7378 (integer-or-marker-p org-goto-start-pos))
7379 (let ((org-show-hierarchy-above t)
7380 (org-show-siblings t)
7381 (org-show-following-heading t))
7382 (goto-char org-goto-start-pos)
7383 (and (outline-invisible-p) (org-show-context)))
7384 (goto-char (point-min)))
7385 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7386 (message "Select location and press RET")
7387 (use-local-map org-goto-map)
7388 (recursive-edit)))
7389 (kill-buffer "*org-goto*")
7390 (cons org-goto-selected-point org-goto-exit-command))))
7392 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7393 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7394 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7395 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7397 (defun org-goto-local-search-headings (string bound noerror)
7398 "Search and make sure that any matches are in headlines."
7399 (catch 'return
7400 (while (if isearch-forward
7401 (search-forward string bound noerror)
7402 (search-backward string bound noerror))
7403 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7404 (and (member :headline context)
7405 (not (member :tags context))))
7406 (throw 'return (point))))))
7408 (defun org-goto-local-auto-isearch ()
7409 "Start isearch."
7410 (interactive)
7411 (goto-char (point-min))
7412 (let ((keys (this-command-keys)))
7413 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7414 (isearch-mode t)
7415 (isearch-process-search-char (string-to-char keys)))))
7417 (defun org-goto-ret (&optional arg)
7418 "Finish `org-goto' by going to the new location."
7419 (interactive "P")
7420 (setq org-goto-selected-point (point)
7421 org-goto-exit-command 'return)
7422 (throw 'exit nil))
7424 (defun org-goto-left ()
7425 "Finish `org-goto' by going to the new location."
7426 (interactive)
7427 (if (org-at-heading-p)
7428 (progn
7429 (beginning-of-line 1)
7430 (setq org-goto-selected-point (point)
7431 org-goto-exit-command 'left)
7432 (throw 'exit nil))
7433 (user-error "Not on a heading")))
7435 (defun org-goto-right ()
7436 "Finish `org-goto' by going to the new location."
7437 (interactive)
7438 (if (org-at-heading-p)
7439 (progn
7440 (setq org-goto-selected-point (point)
7441 org-goto-exit-command 'right)
7442 (throw 'exit nil))
7443 (user-error "Not on a heading")))
7445 (defun org-goto-quit ()
7446 "Finish `org-goto' without cursor motion."
7447 (interactive)
7448 (setq org-goto-selected-point nil)
7449 (setq org-goto-exit-command 'quit)
7450 (throw 'exit nil))
7452 ;;; Indirect buffer display of subtrees
7454 (defvar org-indirect-dedicated-frame nil
7455 "This is the frame being used for indirect tree display.")
7456 (defvar org-last-indirect-buffer nil)
7458 (defun org-tree-to-indirect-buffer (&optional arg)
7459 "Create indirect buffer and narrow it to current subtree.
7460 With a numerical prefix ARG, go up to this level and then take that tree.
7461 If ARG is negative, go up that many levels.
7463 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7464 indirect buffer previously made with this command, to avoid proliferation of
7465 indirect buffers. However, when you call the command with a \
7466 \\[universal-argument] prefix, or
7467 when `org-indirect-buffer-display' is `new-frame', the last buffer
7468 is kept so that you can work with several indirect buffers at the same time.
7469 If `org-indirect-buffer-display' is `dedicated-frame', the \
7470 \\[universal-argument] prefix also
7471 requests that a new frame be made for the new buffer, so that the dedicated
7472 frame is not changed."
7473 (interactive "P")
7474 (let ((cbuf (current-buffer))
7475 (cwin (selected-window))
7476 (pos (point))
7477 beg end level heading ibuf)
7478 (save-excursion
7479 (org-back-to-heading t)
7480 (when (numberp arg)
7481 (setq level (org-outline-level))
7482 (if (< arg 0) (setq arg (+ level arg)))
7483 (while (> (setq level (org-outline-level)) arg)
7484 (org-up-heading-safe)))
7485 (setq beg (point)
7486 heading (org-get-heading))
7487 (org-end-of-subtree t t)
7488 (if (org-at-heading-p) (backward-char 1))
7489 (setq end (point)))
7490 (if (and (buffer-live-p org-last-indirect-buffer)
7491 (not (eq org-indirect-buffer-display 'new-frame))
7492 (not arg))
7493 (kill-buffer org-last-indirect-buffer))
7494 (setq ibuf (org-get-indirect-buffer cbuf)
7495 org-last-indirect-buffer ibuf)
7496 (cond
7497 ((or (eq org-indirect-buffer-display 'new-frame)
7498 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7499 (select-frame (make-frame))
7500 (delete-other-windows)
7501 (org-pop-to-buffer-same-window ibuf)
7502 (org-set-frame-title heading))
7503 ((eq org-indirect-buffer-display 'dedicated-frame)
7504 (raise-frame
7505 (select-frame (or (and org-indirect-dedicated-frame
7506 (frame-live-p org-indirect-dedicated-frame)
7507 org-indirect-dedicated-frame)
7508 (setq org-indirect-dedicated-frame (make-frame)))))
7509 (delete-other-windows)
7510 (org-pop-to-buffer-same-window ibuf)
7511 (org-set-frame-title (concat "Indirect: " heading)))
7512 ((eq org-indirect-buffer-display 'current-window)
7513 (org-pop-to-buffer-same-window ibuf))
7514 ((eq org-indirect-buffer-display 'other-window)
7515 (pop-to-buffer ibuf))
7516 (t (error "Invalid value")))
7517 (if (featurep 'xemacs)
7518 (save-excursion (org-mode) (turn-on-font-lock)))
7519 (narrow-to-region beg end)
7520 (show-all)
7521 (goto-char pos)
7522 (run-hook-with-args 'org-cycle-hook 'all)
7523 (and (window-live-p cwin) (select-window cwin))))
7525 (defun org-get-indirect-buffer (&optional buffer)
7526 (setq buffer (or buffer (current-buffer)))
7527 (let ((n 1) (base (buffer-name buffer)) bname)
7528 (while (buffer-live-p
7529 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7530 (setq n (1+ n)))
7531 (condition-case nil
7532 (make-indirect-buffer buffer bname 'clone)
7533 (error (make-indirect-buffer buffer bname)))))
7535 (defun org-set-frame-title (title)
7536 "Set the title of the current frame to the string TITLE."
7537 ;; FIXME: how to name a single frame in XEmacs???
7538 (unless (featurep 'xemacs)
7539 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7541 ;;;; Structure editing
7543 ;;; Inserting headlines
7545 (defun org-previous-line-empty-p (&optional next)
7546 "Is the previous line a blank line?
7547 When NEXT is non-nil, check the next line instead."
7548 (save-excursion
7549 (and (not (bobp))
7550 (or (beginning-of-line (if next 2 0)) t)
7551 (save-match-data
7552 (looking-at "[ \t]*$")))))
7554 (defun org-insert-heading (&optional arg invisible-ok)
7555 "Insert a new heading or an item with the same depth at point.
7557 If point is at the beginning of a heading or a list item, insert
7558 a new heading or a new item above the current one. If point is
7559 at the beginning of a normal line, turn the line into a heading.
7561 If point is in the middle of a headline or a list item, split the
7562 headline or the item and create a new headline/item with the text
7563 in the current line after point \(see `org-M-RET-may-split-line'
7564 on how to modify this behavior).
7566 With one universal prefirx argument, set the user option
7567 `org-insert-heading-respect-content' to t for the duration of
7568 the command. This modifies the behavior described above in this
7569 ways: on list items and at the beginning of normal lines, force
7570 the insertion of a heading after the current subtree.
7572 With two universal prefix arguments, insert the heading at the
7573 end of the grandparent subtree. For example, if point is within
7574 a 2nd-level heading, then it will insert a 2nd-level heading at
7575 the end of the 1st-level parent heading.
7577 When INVISIBLE-OK is set, stop at invisible headlines when going
7578 back. This is important for non-interactive uses of the
7579 command."
7580 (interactive "P")
7581 (if (org-called-interactively-p 'any) (org-reveal))
7582 (let ((itemp (org-in-item-p))
7583 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7584 (respect-content (or org-insert-heading-respect-content
7585 (equal arg '(4))))
7586 (initial-content "")
7587 (adjust-empty-lines t))
7589 (cond
7591 ((or (= (buffer-size) 0)
7592 (and (not (save-excursion
7593 (and (ignore-errors (org-back-to-heading invisible-ok))
7594 (org-at-heading-p))))
7595 (or arg (not itemp))))
7596 ;; At beginning of buffer or so high up that only a heading
7597 ;; makes sense.
7598 (cond ((and (bolp) (not respect-content)) (insert "* "))
7599 ((not respect-content)
7600 (unless may-split (end-of-line))
7601 (insert "\n* "))
7602 ((re-search-forward org-outline-regexp-bol nil t)
7603 (beginning-of-line)
7604 (insert "* \n")
7605 (backward-char))
7606 (t (goto-char (point-max))
7607 (insert "\n* ")))
7608 (run-hooks 'org-insert-heading-hook))
7610 ((and itemp (not (member arg '((4) (16)))))
7611 ;; Insert an item
7612 (org-insert-item))
7615 ;; Maybe move at the end of the subtree
7616 (when (equal arg '(16))
7617 (org-up-heading-safe)
7618 (org-end-of-subtree t))
7619 ;; Insert a heading
7620 (save-restriction
7621 (widen)
7622 (let* ((level nil)
7623 (on-heading (org-at-heading-p))
7624 (empty-line-p (if on-heading
7625 (org-previous-line-empty-p)
7626 ;; We will decide later
7627 nil))
7628 ;; Get a level string to fall back on
7629 (fix-level
7630 (if (org-before-first-heading-p) "*"
7631 (save-excursion
7632 (org-back-to-heading t)
7633 (if (org-previous-line-empty-p) (setq empty-line-p t))
7634 (looking-at org-outline-regexp)
7635 (make-string (1- (length (match-string 0))) ?*))))
7636 (stars
7637 (save-excursion
7638 (condition-case nil
7639 (progn
7640 (org-back-to-heading invisible-ok)
7641 (when (and (not on-heading)
7642 (featurep 'org-inlinetask)
7643 (integerp org-inlinetask-min-level)
7644 (>= (length (match-string 0))
7645 org-inlinetask-min-level))
7646 ;; Find a heading level before the inline task
7647 (while (and (setq level (org-up-heading-safe))
7648 (>= level org-inlinetask-min-level)))
7649 (if (org-at-heading-p)
7650 (org-back-to-heading invisible-ok)
7651 (error "This should not happen")))
7652 (unless (and (save-excursion
7653 (save-match-data
7654 (org-backward-heading-same-level
7655 1 invisible-ok))
7656 (= (point) (match-beginning 0)))
7657 (not (org-previous-line-empty-p t)))
7658 (setq empty-line-p (or empty-line-p
7659 (org-previous-line-empty-p))))
7660 (match-string 0))
7661 (error (or fix-level "* ")))))
7662 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7663 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7664 pos hide-previous previous-pos)
7666 ;; If we insert after content, move there and clean up whitespace
7667 (when (and respect-content
7668 (not (org-looking-at-p org-outline-regexp-bol)))
7669 (if (not (org-before-first-heading-p))
7670 (org-end-of-subtree nil t)
7671 (re-search-forward org-outline-regexp-bol)
7672 (beginning-of-line 0))
7673 (skip-chars-backward " \r\n")
7674 (and (not (looking-back "^\*+"))
7675 (looking-at "[ \t]+") (replace-match ""))
7676 (unless (eobp) (forward-char 1))
7677 (when (looking-at "^\\*")
7678 (unless (bobp) (backward-char 1))
7679 (insert "\n")))
7681 ;; If we are splitting, grab the text that should be moved to the new headline
7682 (when may-split
7683 (if (org-on-heading-p)
7684 ;; This is a heading, we split intelligently (keeping tags)
7685 (let ((pos (point)))
7686 (goto-char (point-at-bol))
7687 (unless (looking-at org-complex-heading-regexp)
7688 (error "This should not happen"))
7689 (when (and (match-beginning 4)
7690 (> pos (match-beginning 4))
7691 (< pos (match-end 4)))
7692 (setq initial-content (buffer-substring pos (match-end 4)))
7693 (goto-char pos)
7694 (delete-region (point) (match-end 4))
7695 (if (looking-at "[ \t]*$")
7696 (replace-match "")
7697 (insert (make-string (length initial-content) ?\ )))
7698 (setq initial-content (org-trim initial-content)))
7699 (goto-char pos))
7700 ;; a normal line
7701 (setq initial-content
7702 (org-trim (buffer-substring (point) (point-at-eol))))
7703 (delete-region (point) (point-at-eol))))
7705 ;; If we are at the beginning of the line, insert before it. Else after
7706 (cond
7707 ((and (bolp) (looking-at "[ \t]*$")))
7708 ((and (bolp) (not (looking-at "[ \t]*$")))
7709 (open-line 1))
7711 (goto-char (point-at-eol))
7712 (insert "\n")))
7714 ;; Insert the new heading
7715 (insert stars)
7716 (just-one-space)
7717 (insert initial-content)
7718 (when adjust-empty-lines
7719 (if (or (not blank)
7720 (and blank (not (org-previous-line-empty-p))))
7721 (org-N-empty-lines-before-current (if blank 1 0))))
7722 (run-hooks 'org-insert-heading-hook)))))))
7724 (defun org-N-empty-lines-before-current (N)
7725 "Make the number of empty lines before current exactly N.
7726 So this will delete or add empty lines."
7727 (save-excursion
7728 (goto-char (point-at-bol))
7729 (if (looking-back "\\s-+" nil 'greedy)
7730 (replace-match ""))
7731 (or (bobp) (insert "\n"))
7732 (while (> N 0)
7733 (insert "\n")
7734 (setq N (1- N)))))
7736 (defun org-get-heading (&optional no-tags no-todo)
7737 "Return the heading of the current entry, without the stars.
7738 When NO-TAGS is non-nil, don't include tags.
7739 When NO-TODO is non-nil, don't include TODO keywords."
7740 (save-excursion
7741 (org-back-to-heading t)
7742 (cond
7743 ((and no-tags no-todo)
7744 (looking-at org-complex-heading-regexp)
7745 (match-string 4))
7746 (no-tags
7747 (looking-at (concat org-outline-regexp
7748 "\\(.*?\\)"
7749 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7750 (match-string 1))
7751 (no-todo
7752 (looking-at org-todo-line-regexp)
7753 (match-string 3))
7754 (t (looking-at org-heading-regexp)
7755 (match-string 2)))))
7757 (defvar orgstruct-mode) ; defined below
7759 (defun org-heading-components ()
7760 "Return the components of the current heading.
7761 This is a list with the following elements:
7762 - the level as an integer
7763 - the reduced level, different if `org-odd-levels-only' is set.
7764 - the TODO keyword, or nil
7765 - the priority character, like ?A, or nil if no priority is given
7766 - the headline text itself, or the tags string if no headline text
7767 - the tags string, or nil."
7768 (save-excursion
7769 (org-back-to-heading t)
7770 (if (let (case-fold-search)
7771 (looking-at
7772 (if orgstruct-mode
7773 org-heading-regexp
7774 org-complex-heading-regexp)))
7775 (if orgstruct-mode
7776 (list (length (match-string 1))
7777 (org-reduced-level (length (match-string 1)))
7780 (match-string 2)
7781 nil)
7782 (list (length (match-string 1))
7783 (org-reduced-level (length (match-string 1)))
7784 (org-match-string-no-properties 2)
7785 (and (match-end 3) (aref (match-string 3) 2))
7786 (org-match-string-no-properties 4)
7787 (org-match-string-no-properties 5))))))
7789 (defun org-get-entry ()
7790 "Get the entry text, after heading, entire subtree."
7791 (save-excursion
7792 (org-back-to-heading t)
7793 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7795 (defun org-insert-heading-after-current ()
7796 "Insert a new heading with same level as current, after current subtree."
7797 (interactive)
7798 (org-back-to-heading)
7799 (org-insert-heading)
7800 (org-move-subtree-down)
7801 (end-of-line 1))
7803 (defun org-insert-heading-respect-content (&optional invisible-ok)
7804 "Insert heading with `org-insert-heading-respect-content' set to t."
7805 (interactive)
7806 (org-insert-heading '(4) invisible-ok))
7808 (defun org-insert-todo-heading-respect-content (&optional force-state)
7809 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7810 (interactive)
7811 (org-insert-todo-heading force-state '(4)))
7813 (defun org-insert-todo-heading (arg &optional force-heading)
7814 "Insert a new heading with the same level and TODO state as current heading.
7815 If the heading has no TODO state, or if the state is DONE, use the first
7816 state (TODO by default). Also with one prefix arg, force first state. With
7817 two prefix args, force inserting at the end of the parent subtree."
7818 (interactive "P")
7819 (when (or force-heading (not (org-insert-item 'checkbox)))
7820 (org-insert-heading (or (and (equal arg '(16)) '(16))
7821 force-heading))
7822 (save-excursion
7823 (org-back-to-heading)
7824 (outline-previous-heading)
7825 (looking-at org-todo-line-regexp))
7826 (let*
7827 ((new-mark-x
7828 (if (or (equal arg '(4))
7829 (not (match-beginning 2))
7830 (member (match-string 2) org-done-keywords))
7831 (car org-todo-keywords-1)
7832 (match-string 2)))
7833 (new-mark
7835 (run-hook-with-args-until-success
7836 'org-todo-get-default-hook new-mark-x nil)
7837 new-mark-x)))
7838 (beginning-of-line 1)
7839 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7840 (if org-treat-insert-todo-heading-as-state-change
7841 (org-todo new-mark)
7842 (insert new-mark " "))))
7843 (when org-provide-todo-statistics
7844 (org-update-parent-todo-statistics))))
7846 (defun org-insert-subheading (arg)
7847 "Insert a new subheading and demote it.
7848 Works for outline headings and for plain lists alike."
7849 (interactive "P")
7850 (org-insert-heading arg)
7851 (cond
7852 ((org-at-heading-p) (org-do-demote))
7853 ((org-at-item-p) (org-indent-item))))
7855 (defun org-insert-todo-subheading (arg)
7856 "Insert a new subheading with TODO keyword or checkbox and demote it.
7857 Works for outline headings and for plain lists alike."
7858 (interactive "P")
7859 (org-insert-todo-heading arg)
7860 (cond
7861 ((org-at-heading-p) (org-do-demote))
7862 ((org-at-item-p) (org-indent-item))))
7864 ;;; Promotion and Demotion
7866 (defvar org-after-demote-entry-hook nil
7867 "Hook run after an entry has been demoted.
7868 The cursor will be at the beginning of the entry.
7869 When a subtree is being demoted, the hook will be called for each node.")
7871 (defvar org-after-promote-entry-hook nil
7872 "Hook run after an entry has been promoted.
7873 The cursor will be at the beginning of the entry.
7874 When a subtree is being promoted, the hook will be called for each node.")
7876 (defun org-promote-subtree ()
7877 "Promote the entire subtree.
7878 See also `org-promote'."
7879 (interactive)
7880 (save-excursion
7881 (org-with-limited-levels (org-map-tree 'org-promote)))
7882 (org-fix-position-after-promote))
7884 (defun org-demote-subtree ()
7885 "Demote the entire subtree. See `org-demote'.
7886 See also `org-promote'."
7887 (interactive)
7888 (save-excursion
7889 (org-with-limited-levels (org-map-tree 'org-demote)))
7890 (org-fix-position-after-promote))
7893 (defun org-do-promote ()
7894 "Promote the current heading higher up the tree.
7895 If the region is active in `transient-mark-mode', promote all headings
7896 in the region."
7897 (interactive)
7898 (save-excursion
7899 (if (org-region-active-p)
7900 (org-map-region 'org-promote (region-beginning) (region-end))
7901 (org-promote)))
7902 (org-fix-position-after-promote))
7904 (defun org-do-demote ()
7905 "Demote the current heading lower down the tree.
7906 If the region is active in `transient-mark-mode', demote all headings
7907 in the region."
7908 (interactive)
7909 (save-excursion
7910 (if (org-region-active-p)
7911 (org-map-region 'org-demote (region-beginning) (region-end))
7912 (org-demote)))
7913 (org-fix-position-after-promote))
7915 (defun org-fix-position-after-promote ()
7916 "Make sure that after pro/demotion cursor position is right."
7917 (let ((pos (point)))
7918 (when (save-excursion
7919 (beginning-of-line 1)
7920 (looking-at org-todo-line-regexp)
7921 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7922 (cond ((eobp) (insert " "))
7923 ((eolp) (insert " "))
7924 ((equal (char-after) ?\ ) (forward-char 1))))))
7926 (defun org-current-level ()
7927 "Return the level of the current entry, or nil if before the first headline.
7928 The level is the number of stars at the beginning of the headline."
7929 (save-excursion
7930 (org-with-limited-levels
7931 (if (ignore-errors (org-back-to-heading t))
7932 (funcall outline-level)))))
7934 (defun org-get-previous-line-level ()
7935 "Return the outline depth of the last headline before the current line.
7936 Returns 0 for the first headline in the buffer, and nil if before the
7937 first headline."
7938 (and (org-current-level)
7939 (or (and (/= (line-beginning-position) (point-min))
7940 (save-excursion (beginning-of-line 0) (org-current-level)))
7941 0)))
7943 (defun org-reduced-level (l)
7944 "Compute the effective level of a heading.
7945 This takes into account the setting of `org-odd-levels-only'."
7946 (cond
7947 ((zerop l) 0)
7948 (org-odd-levels-only (1+ (floor (/ l 2))))
7949 (t l)))
7951 (defun org-level-increment ()
7952 "Return the number of stars that will be added or removed at a
7953 time to headlines when structure editing, based on the value of
7954 `org-odd-levels-only'."
7955 (if org-odd-levels-only 2 1))
7957 (defun org-get-valid-level (level &optional change)
7958 "Rectify a level change under the influence of `org-odd-levels-only'
7959 LEVEL is a current level, CHANGE is by how much the level should be
7960 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7961 even level numbers will become the next higher odd number."
7962 (if org-odd-levels-only
7963 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7964 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7965 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7966 (max 1 (+ level (or change 0)))))
7968 (if (boundp 'define-obsolete-function-alias)
7969 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7970 (define-obsolete-function-alias 'org-get-legal-level
7971 'org-get-valid-level)
7972 (define-obsolete-function-alias 'org-get-legal-level
7973 'org-get-valid-level "23.1")))
7975 (defun org-promote ()
7976 "Promote the current heading higher up the tree.
7977 If the region is active in `transient-mark-mode', promote all headings
7978 in the region."
7979 (org-back-to-heading t)
7980 (let* ((level (save-match-data (funcall outline-level)))
7981 (after-change-functions (remove 'flyspell-after-change-function
7982 after-change-functions))
7983 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7984 (diff (abs (- level (length up-head) -1))))
7985 (cond ((and (= level 1) org-called-with-limited-levels
7986 org-allow-promoting-top-level-subtree)
7987 (replace-match "# " nil t))
7988 ((= level 1)
7989 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7990 (t (replace-match up-head nil t)))
7991 ;; Fixup tag positioning
7992 (unless (= level 1)
7993 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
7994 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7995 (run-hooks 'org-after-promote-entry-hook)))
7997 (defun org-demote ()
7998 "Demote the current heading lower down the tree.
7999 If the region is active in `transient-mark-mode', demote all headings
8000 in the region."
8001 (org-back-to-heading t)
8002 (let* ((level (save-match-data (funcall outline-level)))
8003 (after-change-functions (remove 'flyspell-after-change-function
8004 after-change-functions))
8005 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8006 (diff (abs (- level (length down-head) -1))))
8007 (replace-match down-head nil t)
8008 ;; Fixup tag positioning
8009 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8010 (if org-adapt-indentation (org-fixup-indentation diff))
8011 (run-hooks 'org-after-demote-entry-hook)))
8013 (defun org-cycle-level ()
8014 "Cycle the level of an empty headline through possible states.
8015 This goes first to child, then to parent, level, then up the hierarchy.
8016 After top level, it switches back to sibling level."
8017 (interactive)
8018 (let ((org-adapt-indentation nil))
8019 (when (org-point-at-end-of-empty-headline)
8020 (setq this-command 'org-cycle-level) ; Only needed for caching
8021 (let ((cur-level (org-current-level))
8022 (prev-level (org-get-previous-line-level)))
8023 (cond
8024 ;; If first headline in file, promote to top-level.
8025 ((= prev-level 0)
8026 (loop repeat (/ (- cur-level 1) (org-level-increment))
8027 do (org-do-promote)))
8028 ;; If same level as prev, demote one.
8029 ((= prev-level cur-level)
8030 (org-do-demote))
8031 ;; If parent is top-level, promote to top level if not already.
8032 ((= prev-level 1)
8033 (loop repeat (/ (- cur-level 1) (org-level-increment))
8034 do (org-do-promote)))
8035 ;; If top-level, return to prev-level.
8036 ((= cur-level 1)
8037 (loop repeat (/ (- prev-level 1) (org-level-increment))
8038 do (org-do-demote)))
8039 ;; If less than prev-level, promote one.
8040 ((< cur-level prev-level)
8041 (org-do-promote))
8042 ;; If deeper than prev-level, promote until higher than
8043 ;; prev-level.
8044 ((> cur-level prev-level)
8045 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8046 do (org-do-promote))))
8047 t))))
8049 (defun org-map-tree (fun)
8050 "Call FUN for every heading underneath the current one."
8051 (org-back-to-heading)
8052 (let ((level (funcall outline-level)))
8053 (save-excursion
8054 (funcall fun)
8055 (while (and (progn
8056 (outline-next-heading)
8057 (> (funcall outline-level) level))
8058 (not (eobp)))
8059 (funcall fun)))))
8061 (defun org-map-region (fun beg end)
8062 "Call FUN for every heading between BEG and END."
8063 (let ((org-ignore-region t))
8064 (save-excursion
8065 (setq end (copy-marker end))
8066 (goto-char beg)
8067 (if (and (re-search-forward org-outline-regexp-bol nil t)
8068 (< (point) end))
8069 (funcall fun))
8070 (while (and (progn
8071 (outline-next-heading)
8072 (< (point) end))
8073 (not (eobp)))
8074 (funcall fun)))))
8076 (defvar org-property-end-re) ; silence byte-compiler
8077 (defun org-fixup-indentation (diff)
8078 "Change the indentation in the current entry by DIFF.
8079 However, if any line in the current entry has no indentation, or if it
8080 would end up with no indentation after the change, nothing at all is done."
8081 (save-excursion
8082 (let ((end (save-excursion (outline-next-heading)
8083 (point-marker)))
8084 (prohibit (if (> diff 0)
8085 "^\\S-"
8086 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8087 col)
8088 (unless (save-excursion (end-of-line 1)
8089 (re-search-forward prohibit end t))
8090 (while (and (< (point) end)
8091 (re-search-forward "^[ \t]+" end t))
8092 (goto-char (match-end 0))
8093 (setq col (current-column))
8094 (if (< diff 0) (replace-match ""))
8095 (org-indent-to-column (+ diff col))))
8096 (move-marker end nil))))
8098 (defun org-convert-to-odd-levels ()
8099 "Convert an org-mode file with all levels allowed to one with odd levels.
8100 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8101 level 5 etc."
8102 (interactive)
8103 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8104 (let ((outline-level 'org-outline-level)
8105 (org-odd-levels-only nil) n)
8106 (save-excursion
8107 (goto-char (point-min))
8108 (while (re-search-forward "^\\*\\*+ " nil t)
8109 (setq n (- (length (match-string 0)) 2))
8110 (while (>= (setq n (1- n)) 0)
8111 (org-demote))
8112 (end-of-line 1))))))
8114 (defun org-convert-to-oddeven-levels ()
8115 "Convert an org-mode file with only odd levels to one with odd/even levels.
8116 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8117 file contains a section with an even level, conversion would
8118 destroy the structure of the file. An error is signaled in this
8119 case."
8120 (interactive)
8121 (goto-char (point-min))
8122 ;; First check if there are no even levels
8123 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8124 (org-show-context t)
8125 (error "Not all levels are odd in this file. Conversion not possible"))
8126 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8127 (let ((outline-regexp org-outline-regexp)
8128 (outline-level 'org-outline-level)
8129 (org-odd-levels-only nil) n)
8130 (save-excursion
8131 (goto-char (point-min))
8132 (while (re-search-forward "^\\*\\*+ " nil t)
8133 (setq n (/ (1- (length (match-string 0))) 2))
8134 (while (>= (setq n (1- n)) 0)
8135 (org-promote))
8136 (end-of-line 1))))))
8138 (defun org-tr-level (n)
8139 "Make N odd if required."
8140 (if org-odd-levels-only (1+ (/ n 2)) n))
8142 ;;; Vertical tree motion, cutting and pasting of subtrees
8144 (defun org-move-subtree-up (&optional arg)
8145 "Move the current subtree up past ARG headlines of the same level."
8146 (interactive "p")
8147 (org-move-subtree-down (- (prefix-numeric-value arg))))
8149 (defun org-move-subtree-down (&optional arg)
8150 "Move the current subtree down past ARG headlines of the same level."
8151 (interactive "p")
8152 (setq arg (prefix-numeric-value arg))
8153 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8154 'org-get-last-sibling))
8155 (ins-point (make-marker))
8156 (cnt (abs arg))
8157 (col (current-column))
8158 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8159 ;; Select the tree
8160 (org-back-to-heading)
8161 (setq beg0 (point))
8162 (save-excursion
8163 (setq ne-beg (org-back-over-empty-lines))
8164 (setq beg (point)))
8165 (save-match-data
8166 (save-excursion (outline-end-of-heading)
8167 (setq folded (outline-invisible-p)))
8168 (progn (org-end-of-subtree nil t)
8169 (unless (eobp) (backward-char))))
8170 (outline-next-heading)
8171 (setq ne-end (org-back-over-empty-lines))
8172 (setq end (point))
8173 (goto-char beg0)
8174 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8175 ;; include less whitespace
8176 (save-excursion
8177 (goto-char beg)
8178 (forward-line (- ne-beg ne-end))
8179 (setq beg (point))))
8180 ;; Find insertion point, with error handling
8181 (while (> cnt 0)
8182 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8183 (progn (goto-char beg0)
8184 (user-error "Cannot move past superior level or buffer limit")))
8185 (setq cnt (1- cnt)))
8186 (if (> arg 0)
8187 ;; Moving forward - still need to move over subtree
8188 (progn (org-end-of-subtree t t)
8189 (save-excursion
8190 (org-back-over-empty-lines)
8191 (or (bolp) (newline)))))
8192 (setq ne-ins (org-back-over-empty-lines))
8193 (move-marker ins-point (point))
8194 (setq txt (buffer-substring beg end))
8195 (org-save-markers-in-region beg end)
8196 (delete-region beg end)
8197 (org-remove-empty-overlays-at beg)
8198 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8199 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8200 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8201 (let ((bbb (point)))
8202 (insert-before-markers txt)
8203 (org-reinstall-markers-in-region bbb)
8204 (move-marker ins-point bbb))
8205 (or (bolp) (insert "\n"))
8206 (setq ins-end (point))
8207 (goto-char ins-point)
8208 (org-skip-whitespace)
8209 (when (and (< arg 0)
8210 (org-first-sibling-p)
8211 (> ne-ins ne-beg))
8212 ;; Move whitespace back to beginning
8213 (save-excursion
8214 (goto-char ins-end)
8215 (let ((kill-whole-line t))
8216 (kill-line (- ne-ins ne-beg)) (point)))
8217 (insert (make-string (- ne-ins ne-beg) ?\n)))
8218 (move-marker ins-point nil)
8219 (if folded
8220 (hide-subtree)
8221 (org-show-entry)
8222 (show-children)
8223 (org-cycle-hide-drawers 'children))
8224 (org-clean-visibility-after-subtree-move)
8225 ;; move back to the initial column we were at
8226 (move-to-column col)))
8228 (defvar org-subtree-clip ""
8229 "Clipboard for cut and paste of subtrees.
8230 This is actually only a copy of the kill, because we use the normal kill
8231 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8233 (defvar org-subtree-clip-folded nil
8234 "Was the last copied subtree folded?
8235 This is used to fold the tree back after pasting.")
8237 (defun org-cut-subtree (&optional n)
8238 "Cut the current subtree into the clipboard.
8239 With prefix arg N, cut this many sequential subtrees.
8240 This is a short-hand for marking the subtree and then cutting it."
8241 (interactive "p")
8242 (org-copy-subtree n 'cut))
8244 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8245 "Copy the current subtree it in the clipboard.
8246 With prefix arg N, copy this many sequential subtrees.
8247 This is a short-hand for marking the subtree and then copying it.
8248 If CUT is non-nil, actually cut the subtree.
8249 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8250 of some markers in the region, even if CUT is non-nil. This is
8251 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8252 (interactive "p")
8253 (let (beg end folded (beg0 (point)))
8254 (if (org-called-interactively-p 'any)
8255 (org-back-to-heading nil) ; take what looks like a subtree
8256 (org-back-to-heading t)) ; take what is really there
8257 (setq beg (point))
8258 (skip-chars-forward " \t\r\n")
8259 (save-match-data
8260 (if nosubtrees
8261 (outline-next-heading)
8262 (save-excursion (outline-end-of-heading)
8263 (setq folded (outline-invisible-p)))
8264 (condition-case nil
8265 (org-forward-heading-same-level (1- n) t)
8266 (error nil))
8267 (org-end-of-subtree t t)))
8268 (setq end (point))
8269 (goto-char beg0)
8270 (when (> end beg)
8271 (setq org-subtree-clip-folded folded)
8272 (when (or cut force-store-markers)
8273 (org-save-markers-in-region beg end))
8274 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8275 (setq org-subtree-clip (current-kill 0))
8276 (message "%s: Subtree(s) with %d characters"
8277 (if cut "Cut" "Copied")
8278 (length org-subtree-clip)))))
8280 (defun org-paste-subtree (&optional level tree for-yank)
8281 "Paste the clipboard as a subtree, with modification of headline level.
8282 The entire subtree is promoted or demoted in order to match a new headline
8283 level.
8285 If the cursor is at the beginning of a headline, the same level as
8286 that headline is used to paste the tree.
8288 If not, the new level is derived from the *visible* headings
8289 before and after the insertion point, and taken to be the inferior headline
8290 level of the two. So if the previous visible heading is level 3 and the
8291 next is level 4 (or vice versa), level 4 will be used for insertion.
8292 This makes sure that the subtree remains an independent subtree and does
8293 not swallow low level entries.
8295 You can also force a different level, either by using a numeric prefix
8296 argument, or by inserting the heading marker by hand. For example, if the
8297 cursor is after \"*****\", then the tree will be shifted to level 5.
8299 If optional TREE is given, use this text instead of the kill ring.
8301 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8302 move back over whitespace before inserting, and move point to the end of
8303 the inserted text when done."
8304 (interactive "P")
8305 (setq tree (or tree (and kill-ring (current-kill 0))))
8306 (unless (org-kill-is-subtree-p tree)
8307 (user-error "%s"
8308 (substitute-command-keys
8309 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8310 (org-with-limited-levels
8311 (let* ((visp (not (outline-invisible-p)))
8312 (txt tree)
8313 (^re_ "\\(\\*+\\)[ \t]*")
8314 (old-level (if (string-match org-outline-regexp-bol txt)
8315 (- (match-end 0) (match-beginning 0) 1)
8316 -1))
8317 (force-level (cond (level (prefix-numeric-value level))
8318 ((and (looking-at "[ \t]*$")
8319 (string-match
8320 "^\\*+$" (buffer-substring
8321 (point-at-bol) (point))))
8322 (- (match-end 0) (match-beginning 0)))
8323 ((and (bolp)
8324 (looking-at org-outline-regexp))
8325 (- (match-end 0) (point) 1))))
8326 (previous-level (save-excursion
8327 (condition-case nil
8328 (progn
8329 (outline-previous-visible-heading 1)
8330 (if (looking-at ^re_)
8331 (- (match-end 0) (match-beginning 0) 1)
8333 (error 1))))
8334 (next-level (save-excursion
8335 (condition-case nil
8336 (progn
8337 (or (looking-at org-outline-regexp)
8338 (outline-next-visible-heading 1))
8339 (if (looking-at ^re_)
8340 (- (match-end 0) (match-beginning 0) 1)
8342 (error 1))))
8343 (new-level (or force-level (max previous-level next-level)))
8344 (shift (if (or (= old-level -1)
8345 (= new-level -1)
8346 (= old-level new-level))
8348 (- new-level old-level)))
8349 (delta (if (> shift 0) -1 1))
8350 (func (if (> shift 0) 'org-demote 'org-promote))
8351 (org-odd-levels-only nil)
8352 beg end newend)
8353 ;; Remove the forced level indicator
8354 (if force-level
8355 (delete-region (point-at-bol) (point)))
8356 ;; Paste
8357 (beginning-of-line (if (bolp) 1 2))
8358 (setq beg (point))
8359 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8360 (insert-before-markers txt)
8361 (unless (string-match "\n\\'" txt) (insert "\n"))
8362 (setq newend (point))
8363 (org-reinstall-markers-in-region beg)
8364 (setq end (point))
8365 (goto-char beg)
8366 (skip-chars-forward " \t\n\r")
8367 (setq beg (point))
8368 (if (and (outline-invisible-p) visp)
8369 (save-excursion (outline-show-heading)))
8370 ;; Shift if necessary
8371 (unless (= shift 0)
8372 (save-restriction
8373 (narrow-to-region beg end)
8374 (while (not (= shift 0))
8375 (org-map-region func (point-min) (point-max))
8376 (setq shift (+ delta shift)))
8377 (goto-char (point-min))
8378 (setq newend (point-max))))
8379 (when (or (org-called-interactively-p 'interactive) for-yank)
8380 (message "Clipboard pasted as level %d subtree" new-level))
8381 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8382 kill-ring
8383 (eq org-subtree-clip (current-kill 0))
8384 org-subtree-clip-folded)
8385 ;; The tree was folded before it was killed/copied
8386 (hide-subtree))
8387 (and for-yank (goto-char newend)))))
8389 (defun org-kill-is-subtree-p (&optional txt)
8390 "Check if the current kill is an outline subtree, or a set of trees.
8391 Returns nil if kill does not start with a headline, or if the first
8392 headline level is not the largest headline level in the tree.
8393 So this will actually accept several entries of equal levels as well,
8394 which is OK for `org-paste-subtree'.
8395 If optional TXT is given, check this string instead of the current kill."
8396 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8397 (re (org-get-limited-outline-regexp))
8398 (^re (concat "^" re))
8399 (start-level (and kill
8400 (string-match
8401 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8402 kill)
8403 (- (match-end 2) (match-beginning 2) 1)))
8404 (start (1+ (or (match-beginning 2) -1))))
8405 (if (not start-level)
8406 (progn
8407 nil) ;; does not even start with a heading
8408 (catch 'exit
8409 (while (setq start (string-match ^re kill (1+ start)))
8410 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8411 (throw 'exit nil)))
8412 t))))
8414 (defvar org-markers-to-move nil
8415 "Markers that should be moved with a cut-and-paste operation.
8416 Those markers are stored together with their positions relative to
8417 the start of the region.")
8419 (defun org-save-markers-in-region (beg end)
8420 "Check markers in region.
8421 If these markers are between BEG and END, record their position relative
8422 to BEG, so that after moving the block of text, we can put the markers back
8423 into place.
8424 This function gets called just before an entry or tree gets cut from the
8425 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8426 called immediately, to move the markers with the entries."
8427 (setq org-markers-to-move nil)
8428 (when (featurep 'org-clock)
8429 (org-clock-save-markers-for-cut-and-paste beg end))
8430 (when (featurep 'org-agenda)
8431 (org-agenda-save-markers-for-cut-and-paste beg end)))
8433 (defun org-check-and-save-marker (marker beg end)
8434 "Check if MARKER is between BEG and END.
8435 If yes, remember the marker and the distance to BEG."
8436 (when (and (marker-buffer marker)
8437 (equal (marker-buffer marker) (current-buffer)))
8438 (if (and (>= marker beg) (< marker end))
8439 (push (cons marker (- marker beg)) org-markers-to-move))))
8441 (defun org-reinstall-markers-in-region (beg)
8442 "Move all remembered markers to their position relative to BEG."
8443 (mapc (lambda (x)
8444 (move-marker (car x) (+ beg (cdr x))))
8445 org-markers-to-move)
8446 (setq org-markers-to-move nil))
8448 (defun org-narrow-to-subtree ()
8449 "Narrow buffer to the current subtree."
8450 (interactive)
8451 (save-excursion
8452 (save-match-data
8453 (org-with-limited-levels
8454 (narrow-to-region
8455 (progn (org-back-to-heading t) (point))
8456 (progn (org-end-of-subtree t t)
8457 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8458 (point)))))))
8460 (defun org-narrow-to-block ()
8461 "Narrow buffer to the current block."
8462 (interactive)
8463 (let* ((case-fold-search t)
8464 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8465 "^[ \t]*#\\+end_.*")))
8466 (if blockp
8467 (narrow-to-region (car blockp) (cdr blockp))
8468 (user-error "Not in a block"))))
8470 (eval-when-compile
8471 (defvar org-property-drawer-re))
8473 (defvar org-property-start-re) ;; defined below
8474 (defun org-clone-subtree-with-time-shift (n &optional shift)
8475 "Clone the task (subtree) at point N times.
8476 The clones will be inserted as siblings.
8478 In interactive use, the user will be prompted for the number of
8479 clones to be produced. If the entry has a timestamp, the user
8480 will also be prompted for a time shift, which may be a repeater
8481 as used in time stamps, for example `+3d'. To disable this,
8482 you can call the function with a universal prefix argument.
8484 When a valid repeater is given and the entry contains any time
8485 stamps, the clones will become a sequence in time, with time
8486 stamps in the subtree shifted for each clone produced. If SHIFT
8487 is nil or the empty string, time stamps will be left alone. The
8488 ID property of the original subtree is removed.
8490 If the original subtree did contain time stamps with a repeater,
8491 the following will happen:
8492 - the repeater will be removed in each clone
8493 - an additional clone will be produced, with the current, unshifted
8494 date(s) in the entry.
8495 - the original entry will be placed *after* all the clones, with
8496 repeater intact.
8497 - the start days in the repeater in the original entry will be shifted
8498 to past the last clone.
8499 In this way you can spell out a number of instances of a repeating task,
8500 and still retain the repeater to cover future instances of the task."
8501 (interactive "nNumber of clones to produce: ")
8502 (let ((shift
8503 (or shift
8504 (if (and (not (equal current-prefix-arg '(4)))
8505 (save-excursion
8506 (re-search-forward org-ts-regexp-both
8507 (save-excursion
8508 (org-end-of-subtree t)
8509 (point)) t)))
8510 (read-from-minibuffer
8511 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8512 ""))) ;; No time shift
8513 (n-no-remove -1)
8514 (drawer-re org-drawer-regexp)
8515 beg end template task idprop
8516 shift-n shift-what doshift nmin nmax)
8517 (if (not (and (integerp n) (> n 0)))
8518 (error "Invalid number of replications %s" n))
8519 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8520 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8521 shift)))
8522 (error "Invalid shift specification %s" shift))
8523 (when doshift
8524 (setq shift-n (string-to-number (match-string 1 shift))
8525 shift-what (cdr (assoc (match-string 2 shift)
8526 '(("d" . day) ("w" . week)
8527 ("m" . month) ("y" . year))))))
8528 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8529 (setq nmin 1 nmax n)
8530 (org-back-to-heading t)
8531 (setq beg (point))
8532 (setq idprop (org-entry-get nil "ID"))
8533 (org-end-of-subtree t t)
8534 (or (bolp) (insert "\n"))
8535 (setq end (point))
8536 (setq template (buffer-substring beg end))
8537 (when (and doshift
8538 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8539 (delete-region beg end)
8540 (setq end beg)
8541 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8542 (goto-char end)
8543 (loop for n from nmin to nmax do
8544 ;; prepare clone
8545 (with-temp-buffer
8546 (insert template)
8547 (org-mode)
8548 (goto-char (point-min))
8549 (org-show-subtree)
8550 (and idprop (if org-clone-delete-id
8551 (org-entry-delete nil "ID")
8552 (org-id-get-create t)))
8553 (unless (= n 0)
8554 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8555 (kill-whole-line))
8556 (goto-char (point-min))
8557 (while (re-search-forward drawer-re nil t)
8558 (mapc (lambda (d)
8559 (org-remove-empty-drawer-at d (point))) org-drawers)))
8560 (goto-char (point-min))
8561 (when doshift
8562 (while (re-search-forward org-ts-regexp-both nil t)
8563 (org-timestamp-change (* n shift-n) shift-what))
8564 (unless (= n n-no-remove)
8565 (goto-char (point-min))
8566 (while (re-search-forward org-ts-regexp nil t)
8567 (save-excursion
8568 (goto-char (match-beginning 0))
8569 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8570 (delete-region (match-beginning 1) (match-end 1)))))))
8571 (setq task (buffer-string)))
8572 (insert task))
8573 (goto-char beg)))
8575 ;;; Outline Sorting
8577 (defun org-sort (with-case)
8578 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8579 Optional argument WITH-CASE means sort case-sensitively."
8580 (interactive "P")
8581 (cond
8582 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8583 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8585 (org-call-with-arg 'org-sort-entries with-case))))
8587 (defun org-sort-remove-invisible (s)
8588 "Remove invisible links from string S."
8589 (remove-text-properties 0 (length s) org-rm-props s)
8590 (while (string-match org-bracket-link-regexp s)
8591 (setq s (replace-match (if (match-end 2)
8592 (match-string 3 s)
8593 (match-string 1 s)) t t s)))
8594 (let ((st (format " %s " s)))
8595 (while (string-match org-emph-re st)
8596 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8597 (setq s (substring st 1 -1)))
8600 (defvar org-priority-regexp) ; defined later in the file
8602 (defvar org-after-sorting-entries-or-items-hook nil
8603 "Hook that is run after a bunch of entries or items have been sorted.
8604 When children are sorted, the cursor is in the parent line when this
8605 hook gets called. When a region or a plain list is sorted, the cursor
8606 will be in the first entry of the sorted region/list.")
8608 (defun org-sort-entries
8609 (&optional with-case sorting-type getkey-func compare-func property)
8610 "Sort entries on a certain level of an outline tree.
8611 If there is an active region, the entries in the region are sorted.
8612 Else, if the cursor is before the first entry, sort the top-level items.
8613 Else, the children of the entry at point are sorted.
8615 Sorting can be alphabetically, numerically, by date/time as given by
8616 a time stamp, by a property, by priority order, or by a custom function.
8618 The command prompts for the sorting type unless it has been given to the
8619 function through the SORTING-TYPE argument, which needs to be a character,
8620 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8621 precise meaning of each character:
8623 n Numerically, by converting the beginning of the entry/item to a number.
8624 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8625 o By order of TODO keywords.
8626 t By date/time, either the first active time stamp in the entry, or, if
8627 none exist, by the first inactive one.
8628 s By the scheduled date/time.
8629 d By deadline date/time.
8630 c By creation time, which is assumed to be the first inactive time stamp
8631 at the beginning of a line.
8632 p By priority according to the cookie.
8633 r By the value of a property.
8635 Capital letters will reverse the sort order.
8637 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8638 called with point at the beginning of the record. It must return either
8639 a string or a number that should serve as the sorting key for that record.
8641 Comparing entries ignores case by default. However, with an optional argument
8642 WITH-CASE, the sorting considers case as well.
8644 Sorting is done against the visible part of the headlines, it ignores hidden
8645 links."
8646 (interactive "P")
8647 (let ((case-func (if with-case 'identity 'downcase))
8648 (cmstr
8649 ;; The clock marker is lost when using `sort-subr', let's
8650 ;; store the clocking string.
8651 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8652 (save-excursion
8653 (goto-char org-clock-marker)
8654 (looking-back "^.*") (match-string-no-properties 0))))
8655 start beg end stars re re2
8656 txt what tmp)
8657 ;; Find beginning and end of region to sort
8658 (cond
8659 ((org-region-active-p)
8660 ;; we will sort the region
8661 (setq end (region-end)
8662 what "region")
8663 (goto-char (region-beginning))
8664 (if (not (org-at-heading-p)) (outline-next-heading))
8665 (setq start (point)))
8666 ((or (org-at-heading-p)
8667 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8668 ;; we will sort the children of the current headline
8669 (org-back-to-heading)
8670 (setq start (point)
8671 end (progn (org-end-of-subtree t t)
8672 (or (bolp) (insert "\n"))
8673 (when (>= (org-back-over-empty-lines) 1)
8674 (forward-line 1))
8675 (point))
8676 what "children")
8677 (goto-char start)
8678 (show-subtree)
8679 (outline-next-heading))
8681 ;; we will sort the top-level entries in this file
8682 (goto-char (point-min))
8683 (or (org-at-heading-p) (outline-next-heading))
8684 (setq start (point))
8685 (goto-char (point-max))
8686 (beginning-of-line 1)
8687 (when (looking-at ".*?\\S-")
8688 ;; File ends in a non-white line
8689 (end-of-line 1)
8690 (insert "\n"))
8691 (setq end (point-max))
8692 (setq what "top-level")
8693 (goto-char start)
8694 (show-all)))
8696 (setq beg (point))
8697 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8699 (looking-at "\\(\\*+\\)")
8700 (setq stars (match-string 1)
8701 re (concat "^" (regexp-quote stars) " +")
8702 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8703 txt (buffer-substring beg end))
8704 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8705 (if (and (not (equal stars "*")) (string-match re2 txt))
8706 (user-error "Region to sort contains a level above the first entry"))
8708 (unless sorting-type
8709 (message
8710 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8711 [t]ime [s]cheduled [d]eadline [c]reated
8712 A/N/P/R/O/F/T/S/D/C means reversed:"
8713 what)
8714 (setq sorting-type (read-char-exclusive))
8716 (unless getkey-func
8717 (and (= (downcase sorting-type) ?f)
8718 (setq getkey-func
8719 (org-icompleting-read "Sort using function: "
8720 obarray 'fboundp t nil nil))
8721 (setq getkey-func (intern getkey-func))))
8723 (and (= (downcase sorting-type) ?r)
8724 (not property)
8725 (setq property
8726 (org-icompleting-read "Property: "
8727 (mapcar 'list (org-buffer-property-keys t))
8728 nil t))))
8730 (message "Sorting entries...")
8732 (save-restriction
8733 (narrow-to-region start end)
8734 (let ((dcst (downcase sorting-type))
8735 (case-fold-search nil)
8736 (now (current-time)))
8737 (sort-subr
8738 (/= dcst sorting-type)
8739 ;; This function moves to the beginning character of the "record" to
8740 ;; be sorted.
8741 (lambda nil
8742 (if (re-search-forward re nil t)
8743 (goto-char (match-beginning 0))
8744 (goto-char (point-max))))
8745 ;; This function moves to the last character of the "record" being
8746 ;; sorted.
8747 (lambda nil
8748 (save-match-data
8749 (condition-case nil
8750 (outline-forward-same-level 1)
8751 (error
8752 (goto-char (point-max))))))
8753 ;; This function returns the value that gets sorted against.
8754 (lambda nil
8755 (cond
8756 ((= dcst ?n)
8757 (if (looking-at org-complex-heading-regexp)
8758 (string-to-number (org-sort-remove-invisible (match-string 4)))
8759 nil))
8760 ((= dcst ?a)
8761 (if (looking-at org-complex-heading-regexp)
8762 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8763 nil))
8764 ((= dcst ?t)
8765 (let ((end (save-excursion (outline-next-heading) (point))))
8766 (if (or (re-search-forward org-ts-regexp end t)
8767 (re-search-forward org-ts-regexp-both end t))
8768 (org-time-string-to-seconds (match-string 0))
8769 (org-float-time now))))
8770 ((= dcst ?c)
8771 (let ((end (save-excursion (outline-next-heading) (point))))
8772 (if (re-search-forward
8773 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8774 end t)
8775 (org-time-string-to-seconds (match-string 0))
8776 (org-float-time now))))
8777 ((= dcst ?s)
8778 (let ((end (save-excursion (outline-next-heading) (point))))
8779 (if (re-search-forward org-scheduled-time-regexp end t)
8780 (org-time-string-to-seconds (match-string 1))
8781 (org-float-time now))))
8782 ((= dcst ?d)
8783 (let ((end (save-excursion (outline-next-heading) (point))))
8784 (if (re-search-forward org-deadline-time-regexp end t)
8785 (org-time-string-to-seconds (match-string 1))
8786 (org-float-time now))))
8787 ((= dcst ?p)
8788 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8789 (string-to-char (match-string 2))
8790 org-default-priority))
8791 ((= dcst ?r)
8792 (or (org-entry-get nil property) ""))
8793 ((= dcst ?o)
8794 (if (looking-at org-complex-heading-regexp)
8795 (- 9999 (length (member (match-string 2)
8796 org-todo-keywords-1)))))
8797 ((= dcst ?f)
8798 (if getkey-func
8799 (progn
8800 (setq tmp (funcall getkey-func))
8801 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8802 tmp)
8803 (error "Invalid key function `%s'" getkey-func)))
8804 (t (error "Invalid sorting type `%c'" sorting-type))))
8806 (cond
8807 ((= dcst ?a) 'string<)
8808 ((= dcst ?f) compare-func)
8809 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8810 (run-hooks 'org-after-sorting-entries-or-items-hook)
8811 ;; Reset the clock marker if needed
8812 (when cmstr
8813 (save-excursion
8814 (goto-char start)
8815 (search-forward cmstr nil t)
8816 (move-marker org-clock-marker (point))))
8817 (message "Sorting entries...done")))
8819 (defun org-do-sort (table what &optional with-case sorting-type)
8820 "Sort TABLE of WHAT according to SORTING-TYPE.
8821 The user will be prompted for the SORTING-TYPE if the call to this
8822 function does not specify it. WHAT is only for the prompt, to indicate
8823 what is being sorted. The sorting key will be extracted from
8824 the car of the elements of the table.
8825 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8826 (unless sorting-type
8827 (message
8828 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8829 what)
8830 (setq sorting-type (read-char-exclusive)))
8831 (let ((dcst (downcase sorting-type))
8832 extractfun comparefun)
8833 ;; Define the appropriate functions
8834 (cond
8835 ((= dcst ?n)
8836 (setq extractfun 'string-to-number
8837 comparefun (if (= dcst sorting-type) '< '>)))
8838 ((= dcst ?a)
8839 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8840 (lambda(x) (downcase (org-sort-remove-invisible x))))
8841 comparefun (if (= dcst sorting-type)
8842 'string<
8843 (lambda (a b) (and (not (string< a b))
8844 (not (string= a b)))))))
8845 ((= dcst ?t)
8846 (setq extractfun
8847 (lambda (x)
8848 (if (or (string-match org-ts-regexp x)
8849 (string-match org-ts-regexp-both x))
8850 (org-float-time
8851 (org-time-string-to-time (match-string 0 x)))
8853 comparefun (if (= dcst sorting-type) '< '>)))
8854 (t (error "Invalid sorting type `%c'" sorting-type)))
8856 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8857 table)
8858 (lambda (a b) (funcall comparefun (car a) (car b))))))
8861 ;;; The orgstruct minor mode
8863 ;; Define a minor mode which can be used in other modes in order to
8864 ;; integrate the org-mode structure editing commands.
8866 ;; This is really a hack, because the org-mode structure commands use
8867 ;; keys which normally belong to the major mode. Here is how it
8868 ;; works: The minor mode defines all the keys necessary to operate the
8869 ;; structure commands, but wraps the commands into a function which
8870 ;; tests if the cursor is currently at a headline or a plain list
8871 ;; item. If that is the case, the structure command is used,
8872 ;; temporarily setting many Org-mode variables like regular
8873 ;; expressions for filling etc. However, when any of those keys is
8874 ;; used at a different location, function uses `key-binding' to look
8875 ;; up if the key has an associated command in another currently active
8876 ;; keymap (minor modes, major mode, global), and executes that
8877 ;; command. There might be problems if any of the keys is otherwise
8878 ;; used as a prefix key.
8880 (defcustom orgstruct-heading-prefix-regexp ""
8881 "Regexp that matches the custom prefix of Org headlines in
8882 orgstruct(++)-mode."
8883 :group 'org
8884 :version "24.4"
8885 :package-version '(Org . "8.3")
8886 :type 'regexp)
8887 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8889 (defcustom orgstruct-setup-hook nil
8890 "Hook run after orgstruct-mode-map is filled."
8891 :group 'org
8892 :version "24.4"
8893 :package-version '(Org . "8.0")
8894 :type 'hook)
8896 (defvar orgstruct-initialized nil)
8898 (defvar org-local-vars nil
8899 "List of local variables, for use by `orgstruct-mode'.")
8901 ;;;###autoload
8902 (define-minor-mode orgstruct-mode
8903 "Toggle the minor mode `orgstruct-mode'.
8904 This mode is for using Org-mode structure commands in other
8905 modes. The following keys behave as if Org-mode were active, if
8906 the cursor is on a headline, or on a plain list item (both as
8907 defined by Org-mode)."
8908 nil " OrgStruct" (make-sparse-keymap)
8909 (funcall (if orgstruct-mode
8910 'add-to-invisibility-spec
8911 'remove-from-invisibility-spec)
8912 '(outline . t))
8913 (when orgstruct-mode
8914 (org-load-modules-maybe)
8915 (unless orgstruct-initialized
8916 (orgstruct-setup)
8917 (setq orgstruct-initialized t))))
8919 ;;;###autoload
8920 (defun turn-on-orgstruct ()
8921 "Unconditionally turn on `orgstruct-mode'."
8922 (orgstruct-mode 1))
8924 (defvar org-fb-vars nil)
8925 (make-variable-buffer-local 'org-fb-vars)
8926 (defun orgstruct++-mode (&optional arg)
8927 "Toggle `orgstruct-mode', the enhanced version of it.
8928 In addition to setting orgstruct-mode, this also exports all
8929 indentation and autofilling variables from org-mode into the
8930 buffer. It will also recognize item context in multiline items."
8931 (interactive "P")
8932 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8933 (if (< arg 1)
8934 (progn (orgstruct-mode -1)
8935 (mapc (lambda(v)
8936 (org-set-local (car v)
8937 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8938 org-fb-vars))
8939 (orgstruct-mode 1)
8940 (setq org-fb-vars nil)
8941 (unless org-local-vars
8942 (setq org-local-vars (org-get-local-variables)))
8943 (let (var val)
8944 (mapc
8945 (lambda (x)
8946 (when (string-match
8947 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8948 (symbol-name (car x)))
8949 (setq var (car x) val (nth 1 x))
8950 (push (list var `(quote ,(eval var))) org-fb-vars)
8951 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8952 org-local-vars)
8953 (org-set-local 'orgstruct-is-++ t))))
8955 (defvar orgstruct-is-++ nil
8956 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8957 (make-variable-buffer-local 'orgstruct-is-++)
8959 ;;;###autoload
8960 (defun turn-on-orgstruct++ ()
8961 "Unconditionally turn on `orgstruct++-mode'."
8962 (orgstruct++-mode 1))
8964 (defun orgstruct-error ()
8965 "Error when there is no default binding for a structure key."
8966 (interactive)
8967 (funcall (if (fboundp 'user-error)
8968 'user-error
8969 'error)
8970 "This key has no function outside structure elements"))
8972 (defun orgstruct-setup ()
8973 "Setup orgstruct keymap."
8974 (dolist (cell '((org-demote . t)
8975 (org-metaleft . t)
8976 (org-metaright . t)
8977 (org-promote . t)
8978 (org-shiftmetaleft . t)
8979 (org-shiftmetaright . t)
8980 org-backward-element
8981 org-backward-heading-same-level
8982 org-ctrl-c-ret
8983 org-ctrl-c-minus
8984 org-ctrl-c-star
8985 org-cycle
8986 org-forward-heading-same-level
8987 org-insert-heading
8988 org-insert-heading-respect-content
8989 org-kill-note-or-show-branches
8990 org-mark-subtree
8991 org-meta-return
8992 org-metadown
8993 org-metaup
8994 org-narrow-to-subtree
8995 org-promote-subtree
8996 org-reveal
8997 org-shiftdown
8998 org-shiftleft
8999 org-shiftmetadown
9000 org-shiftmetaup
9001 org-shiftright
9002 org-shifttab
9003 org-shifttab
9004 org-shiftup
9005 org-show-subtree
9006 org-sort
9007 org-up-element
9008 outline-demote
9009 outline-next-visible-heading
9010 outline-previous-visible-heading
9011 outline-promote
9012 outline-up-heading
9013 show-children))
9014 (let ((f (or (car-safe cell) cell))
9015 (disable-when-heading-prefix (cdr-safe cell)))
9016 (when (fboundp f)
9017 (let ((new-bindings))
9018 (dolist (binding (nconc (where-is-internal f org-mode-map)
9019 (where-is-internal f outline-mode-map)))
9020 (push binding new-bindings)
9021 ;; TODO use local-function-key-map
9022 (dolist (rep '(("<tab>" . "TAB")
9023 ("<return>" . "RET")
9024 ("<escape>" . "ESC")
9025 ("<delete>" . "DEL")))
9026 (setq binding (read-kbd-macro
9027 (let ((case-fold-search))
9028 (replace-regexp-in-string
9029 (regexp-quote (cdr rep))
9030 (car rep)
9031 (key-description binding)))))
9032 (pushnew binding new-bindings :test 'equal)))
9033 (dolist (binding new-bindings)
9034 (let ((key (lookup-key orgstruct-mode-map binding)))
9035 (when (or (not key) (numberp key))
9036 (condition-case nil
9037 (org-defkey orgstruct-mode-map
9038 binding
9039 (orgstruct-make-binding f binding disable-when-heading-prefix))
9040 (error nil)))))))))
9041 (run-hooks 'orgstruct-setup-hook))
9043 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9044 "Create a function for binding in the structure minor mode.
9045 FUN is the command to call inside a table. KEY is the key that
9046 should be checked in for a command to execute outside of tables.
9047 Non-nil `disable-when-heading-prefix' means to disable the command
9048 if `orgstruct-heading-prefix-regexp' is not empty."
9049 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9050 (let ((nname name)
9051 (i 0))
9052 (while (fboundp (intern nname))
9053 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9054 (setq name (intern nname)))
9055 (eval
9056 (let ((bindings '((org-heading-regexp
9057 (concat "^"
9058 orgstruct-heading-prefix-regexp
9059 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9060 (org-outline-regexp
9061 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9062 (org-outline-regexp-bol
9063 (concat "^" org-outline-regexp))
9064 (outline-regexp org-outline-regexp)
9065 (outline-heading-end-regexp "\n")
9066 (outline-level 'org-outline-level)
9067 (outline-heading-alist))))
9068 `(defun ,name (arg)
9069 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9070 "Outside of structure, run the binding of `"
9071 (key-description key) "'."
9072 (when disable-when-heading-prefix
9073 (concat
9074 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9075 "back to the default binding due to limitations of Org's implementation of\n"
9076 "`" (symbol-name fun) "'.")))
9077 (interactive "p")
9078 (let* ((disable
9079 ,(and disable-when-heading-prefix
9080 '(not (string= orgstruct-heading-prefix-regexp ""))))
9081 (fallback
9082 (or disable
9083 (not
9084 (let* ,bindings
9085 (org-context-p 'headline 'item
9086 ,(when (memq fun
9087 '(org-insert-heading
9088 org-insert-heading-respect-content
9089 org-meta-return))
9090 '(when orgstruct-is-++
9091 'item-body))))))))
9092 (if fallback
9093 (let* ((orgstruct-mode)
9094 (binding
9095 (loop with key = ,key
9096 for rep in
9097 '(nil
9098 ("<\\([^>]*\\)tab>" . "\\1TAB")
9099 ("<\\([^>]*\\)return>" . "\\1RET")
9100 ("<\\([^>]*\\)escape>" . "\\1ESC")
9101 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9103 (when rep
9104 (setq key (read-kbd-macro
9105 (let ((case-fold-search))
9106 (replace-regexp-in-string
9107 (car rep)
9108 (cdr rep)
9109 (key-description key))))))
9110 thereis (key-binding key))))
9111 (if (keymapp binding)
9112 (org-set-transient-map binding)
9113 (let ((func (or binding
9114 (unless disable
9115 'orgstruct-error))))
9116 (when func
9117 (call-interactively func)))))
9118 (org-run-like-in-org-mode
9119 (lambda ()
9120 (interactive)
9121 (let* ,bindings
9122 (call-interactively ',fun)))))))))
9123 name))
9125 (defun org-contextualize-keys (alist contexts)
9126 "Return valid elements in ALIST depending on CONTEXTS.
9128 `org-agenda-custom-commands' or `org-capture-templates' are the
9129 values used for ALIST, and `org-agenda-custom-commands-contexts'
9130 or `org-capture-templates-contexts' are the associated contexts
9131 definitions."
9132 (let ((contexts
9133 ;; normalize contexts
9134 (mapcar
9135 (lambda(c) (cond ((listp (cadr c))
9136 (list (car c) (car c) (cadr c)))
9137 ((string= "" (cadr c))
9138 (list (car c) (car c) (caddr c)))
9139 (t c))) contexts))
9140 (a alist) c r s)
9141 ;; loop over all commands or templates
9142 (while (setq c (pop a))
9143 (let (vrules repl)
9144 (cond
9145 ((not (assoc (car c) contexts))
9146 (push c r))
9147 ((and (assoc (car c) contexts)
9148 (setq vrules (org-contextualize-validate-key
9149 (car c) contexts)))
9150 (mapc (lambda (vr)
9151 (when (not (equal (car vr) (cadr vr)))
9152 (setq repl vr))) vrules)
9153 (if (not repl) (push c r)
9154 (push (cadr repl) s)
9155 (push
9156 (cons (car c)
9157 (cdr (or (assoc (cadr repl) alist)
9158 (error "Undefined key `%s' as contextual replacement for `%s'"
9159 (cadr repl) (car c)))))
9160 r))))))
9161 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9162 (delq
9164 (delete-dups
9165 (mapcar (lambda (x)
9166 (let ((tpl (car x)))
9167 (when (not (delq
9169 (mapcar (lambda(y)
9170 (equal y tpl)) s))) x)))
9171 (reverse r))))))
9173 (defun org-contextualize-validate-key (key contexts)
9174 "Check CONTEXTS for agenda or capture KEY."
9175 (let (r rr res)
9176 (while (setq r (pop contexts))
9177 (mapc
9178 (lambda (rr)
9179 (when
9180 (and (equal key (car r))
9181 (if (functionp rr) (funcall rr)
9182 (or (and (eq (car rr) 'in-file)
9183 (buffer-file-name)
9184 (string-match (cdr rr) (buffer-file-name)))
9185 (and (eq (car rr) 'in-mode)
9186 (string-match (cdr rr) (symbol-name major-mode)))
9187 (and (eq (car rr) 'in-buffer)
9188 (string-match (cdr rr) (buffer-name)))
9189 (when (and (eq (car rr) 'not-in-file)
9190 (buffer-file-name))
9191 (not (string-match (cdr rr) (buffer-file-name))))
9192 (when (eq (car rr) 'not-in-mode)
9193 (not (string-match (cdr rr) (symbol-name major-mode))))
9194 (when (eq (car rr) 'not-in-buffer)
9195 (not (string-match (cdr rr) (buffer-name)))))))
9196 (push r res)))
9197 (car (last r))))
9198 (delete-dups (delq nil res))))
9200 (defun org-context-p (&rest contexts)
9201 "Check if local context is any of CONTEXTS.
9202 Possible values in the list of contexts are `table', `headline', and `item'."
9203 (let ((pos (point)))
9204 (goto-char (point-at-bol))
9205 (prog1 (or (and (memq 'table contexts)
9206 (looking-at "[ \t]*|"))
9207 (and (memq 'headline contexts)
9208 (looking-at org-outline-regexp))
9209 (and (memq 'item contexts)
9210 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9211 (and (memq 'item-body contexts)
9212 (org-in-item-p)))
9213 (goto-char pos))))
9215 (defun org-get-local-variables ()
9216 "Return a list of all local variables in an Org mode buffer."
9217 (let (varlist)
9218 (with-current-buffer (get-buffer-create "*Org tmp*")
9219 (erase-buffer)
9220 (org-mode)
9221 (setq varlist (buffer-local-variables)))
9222 (kill-buffer "*Org tmp*")
9223 (delq nil
9224 (mapcar
9225 (lambda (x)
9226 (setq x
9227 (if (symbolp x)
9228 (list x)
9229 (list (car x) (cdr x))))
9230 (if (and (not (get (car x) 'org-state))
9231 (string-match
9232 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9233 (symbol-name (car x))))
9234 x nil))
9235 varlist))))
9237 (defun org-clone-local-variables (from-buffer &optional regexp)
9238 "Clone local variables from FROM-BUFFER.
9239 Optional argument REGEXP selects variables to clone."
9240 (mapc
9241 (lambda (pair)
9242 (and (symbolp (car pair))
9243 (or (null regexp)
9244 (string-match regexp (symbol-name (car pair))))
9245 (set (make-local-variable (car pair))
9246 (cdr pair))))
9247 (buffer-local-variables from-buffer)))
9249 ;;;###autoload
9250 (defun org-run-like-in-org-mode (cmd)
9251 "Run a command, pretending that the current buffer is in Org-mode.
9252 This will temporarily bind local variables that are typically bound in
9253 Org-mode to the values they have in Org-mode, and then interactively
9254 call CMD."
9255 (org-load-modules-maybe)
9256 (unless org-local-vars
9257 (setq org-local-vars (org-get-local-variables)))
9258 (let (binds)
9259 (dolist (var org-local-vars)
9260 (when (or (not (boundp (car var)))
9261 (eq (symbol-value (car var))
9262 (default-value (car var))))
9263 (push (list (car var) `(quote ,(cadr var))) binds)))
9264 (eval `(let ,binds
9265 (call-interactively (quote ,cmd))))))
9267 ;;;; Archiving
9269 (defun org-get-category (&optional pos force-refresh)
9270 "Get the category applying to position POS."
9271 (save-match-data
9272 (if force-refresh (org-refresh-category-properties))
9273 (let ((pos (or pos (point))))
9274 (or (get-text-property pos 'org-category)
9275 (progn (org-refresh-category-properties)
9276 (get-text-property pos 'org-category))))))
9278 (defun org-refresh-category-properties ()
9279 "Refresh category text properties in the buffer."
9280 (let ((case-fold-search t)
9281 (inhibit-read-only t)
9282 (def-cat (cond
9283 ((null org-category)
9284 (if buffer-file-name
9285 (file-name-sans-extension
9286 (file-name-nondirectory buffer-file-name))
9287 "???"))
9288 ((symbolp org-category) (symbol-name org-category))
9289 (t org-category)))
9290 beg end cat pos optionp)
9291 (org-with-silent-modifications
9292 (save-excursion
9293 (save-restriction
9294 (widen)
9295 (goto-char (point-min))
9296 (put-text-property (point) (point-max) 'org-category def-cat)
9297 (while (re-search-forward
9298 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9299 (setq pos (match-end 0)
9300 optionp (equal (char-after (match-beginning 0)) ?#)
9301 cat (org-trim (match-string 2)))
9302 (if optionp
9303 (setq beg (point-at-bol) end (point-max))
9304 (org-back-to-heading t)
9305 (setq beg (point) end (org-end-of-subtree t t)))
9306 (put-text-property beg end 'org-category cat)
9307 (put-text-property beg end 'org-category-position beg)
9308 (goto-char pos)))))))
9310 (defun org-refresh-properties (dprop tprop)
9311 "Refresh buffer text properties.
9312 DPROP is the drawer property and TPROP is the corresponding text
9313 property to set."
9314 (let ((case-fold-search t)
9315 (inhibit-read-only t) p)
9316 (org-with-silent-modifications
9317 (save-excursion
9318 (save-restriction
9319 (widen)
9320 (goto-char (point-min))
9321 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9322 (setq p (org-match-string-no-properties 1))
9323 (save-excursion
9324 (org-back-to-heading t)
9325 (put-text-property
9326 (point-at-bol) (or (outline-next-heading) (point-max)) tprop p))))))))
9329 ;;;; Link Stuff
9331 ;;; Link abbreviations
9333 (defun org-link-expand-abbrev (link)
9334 "Apply replacements as defined in `org-link-abbrev-alist'."
9335 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9336 (let* ((key (match-string 1 link))
9337 (as (or (assoc key org-link-abbrev-alist-local)
9338 (assoc key org-link-abbrev-alist)))
9339 (tag (and (match-end 2) (match-string 3 link)))
9340 rpl)
9341 (if (not as)
9342 link
9343 (setq rpl (cdr as))
9344 (cond
9345 ((symbolp rpl) (funcall rpl tag))
9346 ((string-match "%(\\([^)]+\\))" rpl)
9347 (replace-match
9348 (save-match-data
9349 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9350 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9351 ((string-match "%h" rpl)
9352 (replace-match (url-hexify-string (or tag "")) t t rpl))
9353 (t (concat rpl tag)))))
9354 link))
9356 ;;; Storing and inserting links
9358 (defvar org-insert-link-history nil
9359 "Minibuffer history for links inserted with `org-insert-link'.")
9361 (defvar org-stored-links nil
9362 "Contains the links stored with `org-store-link'.")
9364 (defvar org-store-link-plist nil
9365 "Plist with info about the most recently link created with `org-store-link'.")
9367 (defvar org-link-protocols nil
9368 "Link protocols added to Org-mode using `org-add-link-type'.")
9370 (defvar org-store-link-functions nil
9371 "List of functions that are called to create and store a link.
9372 Each function will be called in turn until one returns a non-nil
9373 value. Each function should check if it is responsible for creating
9374 this link (for example by looking at the major mode).
9375 If not, it must exit and return nil.
9376 If yes, it should return a non-nil value after a calling
9377 `org-store-link-props' with a list of properties and values.
9378 Special properties are:
9380 :type The link prefix, like \"http\". This must be given.
9381 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9382 This is obligatory as well.
9383 :description Optional default description for the second pair
9384 of brackets in an Org-mode link. The user can still change
9385 this when inserting this link into an Org-mode buffer.
9387 In addition to these, any additional properties can be specified
9388 and then used in capture templates.")
9390 (defun org-add-link-type (type &optional follow export)
9391 "Add TYPE to the list of `org-link-types'.
9392 Re-compute all regular expressions depending on `org-link-types'
9394 FOLLOW and EXPORT are two functions.
9396 FOLLOW should take the link path as the single argument and do whatever
9397 is necessary to follow the link, for example find a file or display
9398 a mail message.
9400 EXPORT should format the link path for export to one of the export formats.
9401 It should be a function accepting three arguments:
9403 path the path of the link, the text after the prefix (like \"http:\")
9404 desc the description of the link, if any, or a description added by
9405 org-export-normalize-links if there is none
9406 format the export format, a symbol like `html' or `latex' or `ascii'..
9408 The function may use the FORMAT information to return different values
9409 depending on the format. The return value will be put literally into
9410 the exported file. If the return value is nil, this means Org should
9411 do what it normally does with links which do not have EXPORT defined.
9413 Org-mode has a built-in default for exporting links. If you are happy with
9414 this default, there is no need to define an export function for the link
9415 type. For a simple example of an export function, see `org-bbdb.el'."
9416 (add-to-list 'org-link-types type t)
9417 (org-make-link-regexps)
9418 (if (assoc type org-link-protocols)
9419 (setcdr (assoc type org-link-protocols) (list follow export))
9420 (push (list type follow export) org-link-protocols)))
9422 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9423 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9425 ;;;###autoload
9426 (defun org-store-link (arg)
9427 "\\<org-mode-map>Store an org-link to the current location.
9428 This link is added to `org-stored-links' and can later be inserted
9429 into an org-buffer with \\[org-insert-link].
9431 For some link types, a prefix arg is interpreted.
9432 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9433 For file links, arg negates `org-context-in-file-links'.
9435 A double prefix arg force skipping storing functions that are not
9436 part of Org's core.
9438 A triple prefix arg force storing a link for each line in the
9439 active region."
9440 (interactive "P")
9441 (org-load-modules-maybe)
9442 (if (and (equal arg '(64)) (org-region-active-p))
9443 (save-excursion
9444 (let ((end (region-end)))
9445 (goto-char (region-beginning))
9446 (set-mark (point))
9447 (while (< (point-at-eol) end)
9448 (move-end-of-line 1) (activate-mark)
9449 (let (current-prefix-arg)
9450 (call-interactively 'org-store-link))
9451 (move-beginning-of-line 2)
9452 (set-mark (point)))))
9453 (org-with-limited-levels
9454 (setq org-store-link-plist nil)
9455 (let (link cpltxt desc description search
9456 txt custom-id agenda-link sfuns sfunsn)
9457 (cond
9459 ;; Store a link using an external link type
9460 ((and (not (equal arg '(16)))
9461 (setq sfuns
9462 (delq
9463 nil (mapcar (lambda (f)
9464 (let (fs) (if (funcall f) (push f fs))))
9465 org-store-link-functions))
9466 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9467 (or (and (cdr sfuns)
9468 (funcall (intern
9469 (completing-read
9470 "Which function for creating the link? "
9471 sfunsn nil t (car sfunsn)))))
9472 (funcall (caar sfuns)))
9473 (setq link (plist-get org-store-link-plist :link)
9474 desc (or (plist-get org-store-link-plist
9475 :description) link))))
9477 ;; Store a link from a source code buffer
9478 ((org-src-edit-buffer-p)
9479 (let (label gc)
9480 (while (or (not label)
9481 (save-excursion
9482 (save-restriction
9483 (widen)
9484 (goto-char (point-min))
9485 (re-search-forward
9486 (regexp-quote (format org-coderef-label-format label))
9487 nil t))))
9488 (when label (message "Label exists already") (sit-for 2))
9489 (setq label (read-string "Code line label: " label)))
9490 (end-of-line 1)
9491 (setq link (format org-coderef-label-format label))
9492 (setq gc (- 79 (length link)))
9493 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9494 (insert link)
9495 (setq link (concat "(" label ")") desc nil)))
9497 ;; We are in the agenda, link to referenced location
9498 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9499 (let ((m (or (get-text-property (point) 'org-hd-marker)
9500 (get-text-property (point) 'org-marker))))
9501 (when m
9502 (org-with-point-at m
9503 (setq agenda-link
9504 (if (org-called-interactively-p 'any)
9505 (call-interactively 'org-store-link)
9506 (org-store-link nil)))))))
9508 ((eq major-mode 'calendar-mode)
9509 (let ((cd (calendar-cursor-to-date)))
9510 (setq link
9511 (format-time-string
9512 (car org-time-stamp-formats)
9513 (apply 'encode-time
9514 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9515 nil nil nil))))
9516 (org-store-link-props :type "calendar" :date cd)))
9518 ((eq major-mode 'help-mode)
9519 (setq link (concat "help:" (save-excursion
9520 (goto-char (point-min))
9521 (looking-at "^[^ ]+")
9522 (match-string 0))))
9523 (org-store-link-props :type "help"))
9525 ((eq major-mode 'w3-mode)
9526 (setq cpltxt (if (and (buffer-name)
9527 (not (string-match "Untitled" (buffer-name))))
9528 (buffer-name)
9529 (url-view-url t))
9530 link (url-view-url t))
9531 (org-store-link-props :type "w3" :url (url-view-url t)))
9533 ((eq major-mode 'image-mode)
9534 (setq cpltxt (concat "file:"
9535 (abbreviate-file-name buffer-file-name))
9536 link cpltxt)
9537 (org-store-link-props :type "image" :file buffer-file-name))
9539 ;; In dired, store a link to the file of the current line
9540 ((eq major-mode 'dired-mode)
9541 (let ((file (dired-get-filename nil t)))
9542 (setq file (if file
9543 (abbreviate-file-name
9544 (expand-file-name (dired-get-filename nil t)))
9545 ;; otherwise, no file so use current directory.
9546 default-directory))
9547 (setq cpltxt (concat "file:" file)
9548 link cpltxt)))
9550 ((setq search (run-hook-with-args-until-success
9551 'org-create-file-search-functions))
9552 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9553 "::" search))
9554 (setq cpltxt (or description link)))
9556 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9557 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9558 (cond
9559 ;; Store a link using the target at point
9560 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9561 (setq cpltxt
9562 (concat "file:"
9563 (abbreviate-file-name
9564 (buffer-file-name (buffer-base-buffer)))
9565 "::" (match-string 1))
9566 link cpltxt))
9567 ((and (featurep 'org-id)
9568 (or (eq org-id-link-to-org-use-id t)
9569 (and (org-called-interactively-p 'any)
9570 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9571 (and (eq org-id-link-to-org-use-id
9572 'create-if-interactive-and-no-custom-id)
9573 (not custom-id))))
9574 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9575 ;; Store a link using the ID at point
9576 (setq link (condition-case nil
9577 (prog1 (org-id-store-link)
9578 (setq desc (or (plist-get org-store-link-plist
9579 :description)
9580 "")))
9581 (error
9582 ;; Probably before first headline, link only to file
9583 (concat "file:"
9584 (abbreviate-file-name
9585 (buffer-file-name (buffer-base-buffer))))))))
9587 ;; Just link to current headline
9588 (setq cpltxt (concat "file:"
9589 (abbreviate-file-name
9590 (buffer-file-name (buffer-base-buffer)))))
9591 ;; Add a context search string
9592 (when (org-xor org-context-in-file-links arg)
9593 (let* ((ee (org-element-at-point))
9594 (et (org-element-type ee))
9595 (ev (plist-get (cadr ee) :value))
9596 (ek (plist-get (cadr ee) :key))
9597 (eok (and (stringp ek) (string-match "name" ek))))
9598 (setq txt (cond
9599 ((org-at-heading-p) nil)
9600 ((and (eq et 'keyword) eok) ev)
9601 ((org-region-active-p)
9602 (buffer-substring (region-beginning) (region-end)))))
9603 (when (or (null txt) (string-match "\\S-" txt))
9604 (setq cpltxt
9605 (concat cpltxt "::"
9606 (condition-case nil
9607 (org-make-org-heading-search-string txt)
9608 (error "")))
9609 desc (or (and (eq et 'keyword) eok ev)
9610 (nth 4 (ignore-errors (org-heading-components)))
9611 "NONE")))))
9612 (if (string-match "::\\'" cpltxt)
9613 (setq cpltxt (substring cpltxt 0 -2)))
9614 (setq link cpltxt))))
9616 ((buffer-file-name (buffer-base-buffer))
9617 ;; Just link to this file here.
9618 (setq cpltxt (concat "file:"
9619 (abbreviate-file-name
9620 (buffer-file-name (buffer-base-buffer)))))
9621 ;; Add a context string.
9622 (when (org-xor org-context-in-file-links arg)
9623 (setq txt (if (org-region-active-p)
9624 (buffer-substring (region-beginning) (region-end))
9625 (buffer-substring (point-at-bol) (point-at-eol))))
9626 ;; Only use search option if there is some text.
9627 (when (string-match "\\S-" txt)
9628 (setq cpltxt
9629 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9630 desc "NONE")))
9631 (setq link cpltxt))
9633 ((org-called-interactively-p 'interactive)
9634 (user-error "No method for storing a link from this buffer"))
9636 (t (setq link nil)))
9638 ;; We're done setting link and desc, clean up
9639 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9640 (setq link (or link cpltxt)
9641 desc (or desc cpltxt))
9642 (cond ((equal desc "NONE") (setq desc nil))
9643 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9644 (let ((d0 (match-string 3 desc))
9645 (p0 (match-string 5 desc)))
9646 (setq desc
9647 (replace-regexp-in-string
9648 org-bracket-link-regexp
9649 (concat (or p0 d0)
9650 (if (equal (length (match-string 0 desc))
9651 (length desc)) "*" "")) desc)))))
9653 ;; Return the link
9654 (if (not (and (or (org-called-interactively-p 'any)
9655 executing-kbd-macro) link))
9656 (or agenda-link (and link (org-make-link-string link desc)))
9657 (push (list link desc) org-stored-links)
9658 (message "Stored: %s" (or desc link))
9659 (when custom-id
9660 (setq link (concat "file:" (abbreviate-file-name
9661 (buffer-file-name)) "::#" custom-id))
9662 (push (list link desc) org-stored-links))
9663 (car org-stored-links))))))
9665 (defun org-store-link-props (&rest plist)
9666 "Store link properties, extract names and addresses."
9667 (let (x adr)
9668 (when (setq x (plist-get plist :from))
9669 (setq adr (mail-extract-address-components x))
9670 (setq plist (plist-put plist :fromname (car adr)))
9671 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9672 (when (setq x (plist-get plist :to))
9673 (setq adr (mail-extract-address-components x))
9674 (setq plist (plist-put plist :toname (car adr)))
9675 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9676 (let ((from (plist-get plist :from))
9677 (to (plist-get plist :to)))
9678 (when (and from to org-from-is-user-regexp)
9679 (setq plist
9680 (plist-put plist :fromto
9681 (if (string-match org-from-is-user-regexp from)
9682 (concat "to %t")
9683 (concat "from %f"))))))
9684 (setq org-store-link-plist plist))
9686 (defun org-add-link-props (&rest plist)
9687 "Add these properties to the link property list."
9688 (let (key value)
9689 (while plist
9690 (setq key (pop plist) value (pop plist))
9691 (setq org-store-link-plist
9692 (plist-put org-store-link-plist key value)))))
9694 (defun org-email-link-description (&optional fmt)
9695 "Return the description part of an email link.
9696 This takes information from `org-store-link-plist' and formats it
9697 according to FMT (default from `org-email-link-description-format')."
9698 (setq fmt (or fmt org-email-link-description-format))
9699 (let* ((p org-store-link-plist)
9700 (to (plist-get p :toaddress))
9701 (from (plist-get p :fromaddress))
9702 (table
9703 (list
9704 (cons "%c" (plist-get p :fromto))
9705 (cons "%F" (plist-get p :from))
9706 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9707 (cons "%T" (plist-get p :to))
9708 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9709 (cons "%s" (plist-get p :subject))
9710 (cons "%d" (plist-get p :date))
9711 (cons "%m" (plist-get p :message-id)))))
9712 (when (string-match "%c" fmt)
9713 ;; Check if the user wrote this message
9714 (if (and org-from-is-user-regexp from to
9715 (save-match-data (string-match org-from-is-user-regexp from)))
9716 (setq fmt (replace-match "to %t" t t fmt))
9717 (setq fmt (replace-match "from %f" t t fmt))))
9718 (org-replace-escapes fmt table)))
9720 (defun org-make-org-heading-search-string (&optional string)
9721 "Make search string for the current headline or STRING."
9722 (let ((s (or string
9723 (and (derived-mode-p 'org-mode)
9724 (save-excursion
9725 (org-back-to-heading t)
9726 (org-element-property :raw-value (org-element-at-point))))))
9727 (lines org-context-in-file-links))
9728 (or string (setq s (concat "*" s))) ; Add * for headlines
9729 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9730 (when (and string (integerp lines) (> lines 0))
9731 (let ((slines (org-split-string s "\n")))
9732 (when (< lines (length slines))
9733 (setq s (mapconcat
9734 'identity
9735 (reverse (nthcdr (- (length slines) lines)
9736 (reverse slines))) "\n")))))
9737 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9739 (defun org-make-link-string (link &optional description)
9740 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9741 (unless (string-match "\\S-" link)
9742 (error "Empty link"))
9743 (when (and description
9744 (stringp description)
9745 (not (string-match "\\S-" description)))
9746 (setq description nil))
9747 (when (stringp description)
9748 ;; Remove brackets from the description, they are fatal.
9749 (while (string-match "\\[" description)
9750 (setq description (replace-match "{" t t description)))
9751 (while (string-match "\\]" description)
9752 (setq description (replace-match "}" t t description))))
9753 (when (equal link description)
9754 ;; No description needed, it is identical
9755 (setq description nil))
9756 (when (and (not description)
9757 (not (string-match (org-image-file-name-regexp) link))
9758 (not (equal link (org-link-escape link))))
9759 (setq description (org-extract-attributes link)))
9760 (setq link
9761 (cond ((string-match (org-image-file-name-regexp) link) link)
9762 ((string-match org-link-types-re link)
9763 (concat (match-string 1 link)
9764 (org-link-escape (substring link (match-end 1)))))
9765 (t (org-link-escape link))))
9766 (concat "[[" link "]"
9767 (if description (concat "[" description "]") "")
9768 "]"))
9770 (defconst org-link-escape-chars
9771 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9772 "List of characters that should be escaped in link.
9773 This is the list that is used for internal purposes.")
9775 (defconst org-link-escape-chars-browser
9776 '(?\ ?\")
9777 "List of escapes for characters that are problematic in links.
9778 This is the list that is used before handing over to the browser.")
9780 (defun org-link-escape (text &optional table merge)
9781 "Return percent escaped representation of TEXT.
9782 TEXT is a string with the text to escape.
9783 Optional argument TABLE is a list with characters that should be
9784 escaped. When nil, `org-link-escape-chars' is used.
9785 If optional argument MERGE is set, merge TABLE into
9786 `org-link-escape-chars'."
9787 (cond
9788 ((and table merge)
9789 (mapc (lambda (defchr)
9790 (unless (member defchr table)
9791 (setq table (cons defchr table)))) org-link-escape-chars))
9792 ((null table)
9793 (setq table org-link-escape-chars)))
9794 (mapconcat
9795 (lambda (char)
9796 (if (or (member char table)
9797 (and (or (< char 32) (= char 37) (> char 126))
9798 org-url-hexify-p))
9799 (mapconcat (lambda (sequence-element)
9800 (format "%%%.2X" sequence-element))
9801 (or (encode-coding-char char 'utf-8)
9802 (error "Unable to percent escape character: %s"
9803 (char-to-string char))) "")
9804 (char-to-string char))) text ""))
9806 (defun org-link-unescape (str)
9807 "Unhex hexified Unicode strings as returned from the JavaScript function
9808 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9809 (unless (and (null str) (string= "" str))
9810 (let ((pos 0) (case-fold-search t) unhexed)
9811 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
9812 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9813 (setq str (replace-match unhexed t t str))
9814 (setq pos (+ pos (length unhexed))))))
9815 str)
9817 (defun org-link-unescape-compound (hex)
9818 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9819 Note: this function also decodes single byte encodings like
9820 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9821 (save-match-data
9822 (let* ((bytes (cdr (split-string hex "%")))
9823 (ret "")
9824 (eat 0)
9825 (sum 0))
9826 (while bytes
9827 (let* ((val (string-to-number (pop bytes) 16))
9828 (shift-xor
9829 (if (= 0 eat)
9830 (cond
9831 ((>= val 252) (cons 6 252))
9832 ((>= val 248) (cons 5 248))
9833 ((>= val 240) (cons 4 240))
9834 ((>= val 224) (cons 3 224))
9835 ((>= val 192) (cons 2 192))
9836 (t (cons 0 0)))
9837 (cons 6 128))))
9838 (if (>= val 192) (setq eat (car shift-xor)))
9839 (setq val (logxor val (cdr shift-xor)))
9840 (setq sum (+ (lsh sum (car shift-xor)) val))
9841 (if (> eat 0) (setq eat (- eat 1)))
9842 (cond
9843 ((= 0 eat) ;multi byte
9844 (setq ret (concat ret (org-char-to-string sum)))
9845 (setq sum 0))
9846 ((not bytes) ; single byte(s)
9847 (setq ret (org-link-unescape-single-byte-sequence hex))))
9848 )) ;; end (while bytes
9849 ret )))
9851 (defun org-link-unescape-single-byte-sequence (hex)
9852 "Unhexify hex-encoded single byte character sequences."
9853 (mapconcat (lambda (byte)
9854 (char-to-string (string-to-number byte 16)))
9855 (cdr (split-string hex "%")) ""))
9857 (defun org-xor (a b)
9858 "Exclusive or."
9859 (if a (not b) b))
9861 (defun org-fixup-message-id-for-http (s)
9862 "Replace special characters in a message id, so it can be used in an http query."
9863 (when (string-match "%" s)
9864 (setq s (mapconcat (lambda (c)
9865 (if (eq c ?%)
9866 "%25"
9867 (char-to-string c)))
9868 s "")))
9869 (while (string-match "<" s)
9870 (setq s (replace-match "%3C" t t s)))
9871 (while (string-match ">" s)
9872 (setq s (replace-match "%3E" t t s)))
9873 (while (string-match "@" s)
9874 (setq s (replace-match "%40" t t s)))
9877 (defun org-link-prettify (link)
9878 "Return a human-readable representation of LINK.
9879 The car of LINK must be a raw link the cdr of LINK must be either
9880 a link description or nil."
9881 (let ((desc (or (cadr link) "<no description>")))
9882 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9883 "<" (car link) ">")))
9885 ;;;###autoload
9886 (defun org-insert-link-global ()
9887 "Insert a link like Org-mode does.
9888 This command can be called in any mode to insert a link in Org-mode syntax."
9889 (interactive)
9890 (org-load-modules-maybe)
9891 (org-run-like-in-org-mode 'org-insert-link))
9893 (defun org-insert-all-links (&optional keep)
9894 "Insert all links in `org-stored-links'."
9895 (interactive "P")
9896 (let ((links (copy-sequence org-stored-links)) l)
9897 (while (setq l (if keep (pop links) (pop org-stored-links)))
9898 (insert "- ")
9899 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9900 (insert "\n"))))
9902 (defun org-link-fontify-links-to-this-file ()
9903 "Fontify links to the current file in `org-stored-links'."
9904 (let ((f (buffer-file-name)) a b)
9905 (setq a (mapcar (lambda(l)
9906 (let ((ll (car l)))
9907 (when (and (string-match "^file:\\(.+\\)::" ll)
9908 (equal f (expand-file-name (match-string 1 ll))))
9909 ll)))
9910 org-stored-links))
9911 (when (featurep 'org-id)
9912 (setq b (mapcar (lambda(l)
9913 (let ((ll (car l)))
9914 (when (and (string-match "^id:\\(.+\\)$" ll)
9915 (equal f (expand-file-name
9916 (or (org-id-find-id-file
9917 (match-string 1 ll)) ""))))
9918 ll)))
9919 org-stored-links)))
9920 (mapcar (lambda(l)
9921 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9922 (delq nil (append a b)))))
9924 (defvar org-link-links-in-this-file nil)
9925 (defun org-insert-link (&optional complete-file link-location default-description)
9926 "Insert a link. At the prompt, enter the link.
9928 Completion can be used to insert any of the link protocol prefixes like
9929 http or ftp in use.
9931 The history can be used to select a link previously stored with
9932 `org-store-link'. When the empty string is entered (i.e. if you just
9933 press RET at the prompt), the link defaults to the most recently
9934 stored link. As SPC triggers completion in the minibuffer, you need to
9935 use M-SPC or C-q SPC to force the insertion of a space character.
9937 You will also be prompted for a description, and if one is given, it will
9938 be displayed in the buffer instead of the link.
9940 If there is already a link at point, this command will allow you to edit link
9941 and description parts.
9943 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
9944 be selected using completion. The path to the file will be relative to the
9945 current directory if the file is in the current directory or a subdirectory.
9946 Otherwise, the link will be the absolute path as completed in the minibuffer
9947 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9948 option `org-link-file-path-type'.
9950 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
9951 the current directory or below.
9953 With three \\[universal-argument] prefixes, negate the meaning of
9954 `org-keep-stored-link-after-insertion'.
9956 If `org-make-link-description-function' is non-nil, this function will be
9957 called with the link target, and the result will be the default
9958 link description.
9960 If the LINK-LOCATION parameter is non-nil, this value will be
9961 used as the link location instead of reading one interactively.
9963 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9964 be used as the default description."
9965 (interactive "P")
9966 (let* ((wcf (current-window-configuration))
9967 (origbuf (current-buffer))
9968 (region (if (org-region-active-p)
9969 (buffer-substring (region-beginning) (region-end))))
9970 (remove (and region (list (region-beginning) (region-end))))
9971 (desc region)
9972 tmphist ; byte-compile incorrectly complains about this
9973 (link link-location)
9974 (abbrevs org-link-abbrev-alist-local)
9975 entry file all-prefixes auto-desc)
9976 (cond
9977 (link-location) ; specified by arg, just use it.
9978 ((org-in-regexp org-bracket-link-regexp 1)
9979 ;; We do have a link at point, and we are going to edit it.
9980 (setq remove (list (match-beginning 0) (match-end 0)))
9981 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9982 (setq link (read-string "Link: "
9983 (org-link-unescape
9984 (org-match-string-no-properties 1)))))
9985 ((or (org-in-regexp org-angle-link-re)
9986 (org-in-regexp org-plain-link-re))
9987 ;; Convert to bracket link
9988 (setq remove (list (match-beginning 0) (match-end 0))
9989 link (read-string "Link: "
9990 (org-remove-angle-brackets (match-string 0)))))
9991 ((member complete-file '((4) (16)))
9992 ;; Completing read for file names.
9993 (setq link (org-file-complete-link complete-file)))
9995 ;; Read link, with completion for stored links.
9996 (org-link-fontify-links-to-this-file)
9997 (org-switch-to-buffer-other-window "*Org Links*")
9998 (with-current-buffer "*Org Links*"
9999 (erase-buffer)
10000 (insert "Insert a link.
10001 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10002 (when org-stored-links
10003 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10004 (insert (mapconcat 'org-link-prettify
10005 (reverse org-stored-links) "\n")))
10006 (goto-char (point-min)))
10007 (let ((cw (selected-window)))
10008 (select-window (get-buffer-window "*Org Links*" 'visible))
10009 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10010 (unless (pos-visible-in-window-p (point-max))
10011 (org-fit-window-to-buffer))
10012 (and (window-live-p cw) (select-window cw)))
10013 ;; Fake a link history, containing the stored links.
10014 (setq tmphist (append (mapcar 'car org-stored-links)
10015 org-insert-link-history))
10016 (setq all-prefixes (append (mapcar 'car abbrevs)
10017 (mapcar 'car org-link-abbrev-alist)
10018 org-link-types))
10019 (unwind-protect
10020 (progn
10021 (setq link
10022 (org-completing-read
10023 "Link: "
10024 (append
10025 (mapcar (lambda (x) (concat x ":"))
10026 all-prefixes)
10027 (mapcar 'car org-stored-links))
10028 nil nil nil
10029 'tmphist
10030 (caar org-stored-links)))
10031 (if (not (string-match "\\S-" link))
10032 (user-error "No link selected"))
10033 (mapc (lambda(l)
10034 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10035 org-stored-links)
10036 (if (or (member link all-prefixes)
10037 (and (equal ":" (substring link -1))
10038 (member (substring link 0 -1) all-prefixes)
10039 (setq link (substring link 0 -1))))
10040 (setq link (with-current-buffer origbuf
10041 (org-link-try-special-completion link)))))
10042 (set-window-configuration wcf)
10043 (kill-buffer "*Org Links*"))
10044 (setq entry (assoc link org-stored-links))
10045 (or entry (push link org-insert-link-history))
10046 (setq desc (or desc (nth 1 entry)))))
10048 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10049 (not org-keep-stored-link-after-insertion))
10050 (setq org-stored-links (delq (assoc link org-stored-links)
10051 org-stored-links)))
10053 (if (and (string-match org-plain-link-re link)
10054 (not (string-match org-ts-regexp link)))
10055 ;; URL-like link, normalize the use of angular brackets.
10056 (setq link (org-remove-angle-brackets link)))
10058 ;; Check if we are linking to the current file with a search
10059 ;; option If yes, simplify the link by using only the search
10060 ;; option.
10061 (when (and buffer-file-name
10062 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10063 (let* ((path (match-string 1 link))
10064 (case-fold-search nil)
10065 (search (match-string 2 link)))
10066 (save-match-data
10067 (if (equal (file-truename buffer-file-name) (file-truename path))
10068 ;; We are linking to this same file, with a search option
10069 (setq link search)))))
10071 ;; Check if we can/should use a relative path. If yes, simplify the link
10072 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10073 (let* ((type (match-string 1 link))
10074 (path (match-string 2 link))
10075 (origpath path)
10076 (case-fold-search nil))
10077 (cond
10078 ((or (eq org-link-file-path-type 'absolute)
10079 (equal complete-file '(16)))
10080 (setq path (abbreviate-file-name (expand-file-name path))))
10081 ((eq org-link-file-path-type 'noabbrev)
10082 (setq path (expand-file-name path)))
10083 ((eq org-link-file-path-type 'relative)
10084 (setq path (file-relative-name path)))
10086 (save-match-data
10087 (if (string-match (concat "^" (regexp-quote
10088 (expand-file-name
10089 (file-name-as-directory
10090 default-directory))))
10091 (expand-file-name path))
10092 ;; We are linking a file with relative path name.
10093 (setq path (substring (expand-file-name path)
10094 (match-end 0)))
10095 (setq path (abbreviate-file-name (expand-file-name path)))))))
10096 (setq link (concat type path))
10097 (if (equal desc origpath)
10098 (setq desc path))))
10100 (if org-make-link-description-function
10101 (setq desc
10102 (or (condition-case nil
10103 (funcall org-make-link-description-function link desc)
10104 (error (progn (message "Can't get link description from `%s'"
10105 (symbol-name org-make-link-description-function))
10106 (sit-for 2) nil)))
10107 (read-string "Description: " default-description)))
10108 (if default-description (setq desc default-description)
10109 (setq desc (or (and auto-desc desc)
10110 (read-string "Description: " desc)))))
10112 (unless (string-match "\\S-" desc) (setq desc nil))
10113 (if remove (apply 'delete-region remove))
10114 (insert (org-make-link-string link desc))))
10116 (defun org-link-try-special-completion (type)
10117 "If there is completion support for link type TYPE, offer it."
10118 (let ((fun (intern (concat "org-" type "-complete-link"))))
10119 (if (functionp fun)
10120 (funcall fun)
10121 (read-string "Link (no completion support): " (concat type ":")))))
10123 (defun org-file-complete-link (&optional arg)
10124 "Create a file link using completion."
10125 (let (file link)
10126 (setq file (org-iread-file-name "File: "))
10127 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10128 (pwd1 (file-name-as-directory (abbreviate-file-name
10129 (expand-file-name ".")))))
10130 (cond
10131 ((equal arg '(16))
10132 (setq link (concat
10133 "file:"
10134 (abbreviate-file-name (expand-file-name file)))))
10135 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10136 (setq link (concat "file:" (match-string 1 file))))
10137 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10138 (expand-file-name file))
10139 (setq link (concat
10140 "file:" (match-string 1 (expand-file-name file)))))
10141 (t (setq link (concat "file:" file)))))
10142 link))
10144 (defun org-iread-file-name (&rest args)
10145 "Read-file-name using `ido-mode' speedup if available.
10146 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10147 See `read-file-name' for a description of parameters."
10148 (org-without-partial-completion
10149 (if (and org-completion-use-ido
10150 (fboundp 'ido-read-file-name)
10151 (boundp 'ido-mode) ido-mode
10152 (listp (second args)))
10153 (let ((ido-enter-matching-directory nil))
10154 (apply 'ido-read-file-name args))
10155 (apply 'read-file-name args))))
10157 (defun org-completing-read (&rest args)
10158 "Completing-read with SPACE being a normal character."
10159 (let ((enable-recursive-minibuffers t)
10160 (minibuffer-local-completion-map
10161 (copy-keymap minibuffer-local-completion-map)))
10162 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10163 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10164 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10165 (apply 'org-icompleting-read args)))
10167 (defun org-completing-read-no-i (&rest args)
10168 (let (org-completion-use-ido org-completion-use-iswitchb)
10169 (apply 'org-completing-read args)))
10171 (defun org-iswitchb-completing-read (prompt choices &rest args)
10172 "Use iswitch as a completing-read replacement to choose from choices.
10173 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10174 from."
10175 (let* ((iswitchb-use-virtual-buffers nil)
10176 (iswitchb-make-buflist-hook
10177 (lambda ()
10178 (setq iswitchb-temp-buflist choices))))
10179 (iswitchb-read-buffer prompt)))
10181 (defun org-icompleting-read (&rest args)
10182 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10183 (org-without-partial-completion
10184 (if (and org-completion-use-ido
10185 (fboundp 'ido-completing-read)
10186 (boundp 'ido-mode) ido-mode
10187 (listp (second args)))
10188 (let ((ido-enter-matching-directory nil))
10189 (apply 'ido-completing-read (concat (car args))
10190 (if (consp (car (nth 1 args)))
10191 (mapcar 'car (nth 1 args))
10192 (nth 1 args))
10193 (cddr args)))
10194 (if (and org-completion-use-iswitchb
10195 (boundp 'iswitchb-mode) iswitchb-mode
10196 (listp (second args)))
10197 (apply 'org-iswitchb-completing-read (concat (car args))
10198 (if (consp (car (nth 1 args)))
10199 (mapcar 'car (nth 1 args))
10200 (nth 1 args))
10201 (cddr args))
10202 (apply 'completing-read args)))))
10204 (defun org-extract-attributes (s)
10205 "Extract the attributes cookie from a string and set as text property."
10206 (let (a attr (start 0) key value)
10207 (save-match-data
10208 (when (string-match "{{\\([^}]+\\)}}$" s)
10209 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10210 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10211 (setq key (match-string 1 a) value (match-string 2 a)
10212 start (match-end 0)
10213 attr (plist-put attr (intern key) value))))
10214 (org-add-props s nil 'org-attr attr))
10217 ;;; Opening/following a link
10219 (defvar org-link-search-failed nil)
10221 (defvar org-open-link-functions nil
10222 "Hook for functions finding a plain text link.
10223 These functions must take a single argument, the link content.
10224 They will be called for links that look like [[link text][description]]
10225 when LINK TEXT does not have a protocol like \"http:\" and does not look
10226 like a filename (e.g. \"./blue.png\").
10228 These functions will be called *before* Org attempts to resolve the
10229 link by doing text searches in the current buffer - so if you want a
10230 link \"[[target]]\" to still find \"<<target>>\", your function should
10231 handle this as a special case.
10233 When the function does handle the link, it must return a non-nil value.
10234 If it decides that it is not responsible for this link, it must return
10235 nil to indicate that that Org-mode can continue with other options
10236 like exact and fuzzy text search.")
10238 (defun org-next-link (&optional search-backward)
10239 "Move forward to the next link.
10240 If the link is in hidden text, expose it."
10241 (interactive "P")
10242 (when (and org-link-search-failed (eq this-command last-command))
10243 (goto-char (point-min))
10244 (message "Link search wrapped back to beginning of buffer"))
10245 (setq org-link-search-failed nil)
10246 (let* ((pos (point))
10247 (ct (org-context))
10248 (a (assoc :link ct))
10249 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10250 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10251 ((looking-at org-any-link-re)
10252 ;; Don't stay stuck at link without an org-link face
10253 (forward-char (if search-backward -1 1))))
10254 (if (funcall srch-fun org-any-link-re nil t)
10255 (progn
10256 (goto-char (match-beginning 0))
10257 (if (outline-invisible-p) (org-show-context)))
10258 (goto-char pos)
10259 (setq org-link-search-failed t)
10260 (message "No further link found"))))
10262 (defun org-previous-link ()
10263 "Move backward to the previous link.
10264 If the link is in hidden text, expose it."
10265 (interactive)
10266 (funcall 'org-next-link t))
10268 (defun org-translate-link (s)
10269 "Translate a link string if a translation function has been defined."
10270 (if (and org-link-translation-function
10271 (fboundp org-link-translation-function)
10272 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10273 (progn
10274 (setq s (funcall org-link-translation-function
10275 (match-string 1 s) (match-string 2 s)))
10276 (concat (car s) ":" (cdr s)))
10279 (defun org-translate-link-from-planner (type path)
10280 "Translate a link from Emacs Planner syntax so that Org can follow it.
10281 This is still an experimental function, your mileage may vary."
10282 (cond
10283 ((member type '("http" "https" "news" "ftp"))
10284 ;; standard Internet links are the same.
10285 nil)
10286 ((and (equal type "irc") (string-match "^//" path))
10287 ;; Planner has two / at the beginning of an irc link, we have 1.
10288 ;; We should have zero, actually....
10289 (setq path (substring path 1)))
10290 ((and (equal type "lisp") (string-match "^/" path))
10291 ;; Planner has a slash, we do not.
10292 (setq type "elisp" path (substring path 1)))
10293 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10294 ;; A typical message link. Planner has the id after the final slash,
10295 ;; we separate it with a hash mark
10296 (setq path (concat (match-string 1 path) "#"
10297 (org-remove-angle-brackets (match-string 2 path))))))
10298 (cons type path))
10300 (defun org-find-file-at-mouse (ev)
10301 "Open file link or URL at mouse."
10302 (interactive "e")
10303 (mouse-set-point ev)
10304 (org-open-at-point 'in-emacs))
10306 (defun org-open-at-mouse (ev)
10307 "Open file link or URL at mouse.
10308 See the docstring of `org-open-file' for details."
10309 (interactive "e")
10310 (mouse-set-point ev)
10311 (if (eq major-mode 'org-agenda-mode)
10312 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10313 (org-open-at-point))
10315 (defvar org-window-config-before-follow-link nil
10316 "The window configuration before following a link.
10317 This is saved in case the need arises to restore it.")
10319 (defvar org-open-link-marker (make-marker)
10320 "Marker pointing to the location where `org-open-at-point' was called.")
10322 ;;;###autoload
10323 (defun org-open-at-point-global ()
10324 "Follow a link like Org-mode does.
10325 This command can be called in any mode to follow a link that has
10326 Org-mode syntax."
10327 (interactive)
10328 (org-run-like-in-org-mode 'org-open-at-point))
10330 ;;;###autoload
10331 (defun org-open-link-from-string (s &optional arg reference-buffer)
10332 "Open a link in the string S, as if it was in Org-mode."
10333 (interactive "sLink: \nP")
10334 (let ((reference-buffer (or reference-buffer (current-buffer))))
10335 (with-temp-buffer
10336 (let ((org-inhibit-startup (not reference-buffer)))
10337 (org-mode)
10338 (insert s)
10339 (goto-char (point-min))
10340 (when reference-buffer
10341 (setq org-link-abbrev-alist-local
10342 (with-current-buffer reference-buffer
10343 org-link-abbrev-alist-local)))
10344 (org-open-at-point arg reference-buffer)))))
10346 (defvar org-open-at-point-functions nil
10347 "Hook that is run when following a link at point.
10349 Functions in this hook must return t if they identify and follow
10350 a link at point. If they don't find anything interesting at point,
10351 they must return nil.")
10353 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10354 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10355 (defun org-open-at-point (&optional arg reference-buffer)
10356 "Open link at or after point.
10357 If there is no link at point, this function will search forward up to
10358 the end of the current line.
10359 Normally, files will be opened by an appropriate application. If the
10360 optional prefix argument ARG is non-nil, Emacs will visit the file.
10361 With a double prefix argument, try to open outside of Emacs, in the
10362 application the system uses for this file type."
10363 (interactive "P")
10364 ;; if in a code block, then open the block's results
10365 (unless (call-interactively #'org-babel-open-src-block-result)
10366 (org-load-modules-maybe)
10367 (move-marker org-open-link-marker (point))
10368 (setq org-window-config-before-follow-link (current-window-configuration))
10369 (org-remove-occur-highlights nil nil t)
10370 (cond
10371 ((and (org-at-heading-p)
10372 (not (org-at-timestamp-p t))
10373 (not (org-in-regexp
10374 (concat org-plain-link-re "\\|"
10375 org-bracket-link-regexp "\\|"
10376 org-angle-link-re "\\|"
10377 "[ \t]:[^ \t\n]+:[ \t]*$")))
10378 (not (get-text-property (point) 'org-linked-text)))
10379 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10380 (lk0 (car lkall))
10381 (lk (if (stringp lk0) (list lk0) lk0))
10382 (lkend (cdr lkall)))
10383 (mapcar (lambda(l)
10384 (search-forward l nil lkend)
10385 (goto-char (match-beginning 0))
10386 (org-open-at-point))
10387 lk))
10388 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10389 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10390 ((and (org-at-timestamp-p t)
10391 (not (org-in-regexp org-bracket-link-regexp)))
10392 (org-follow-timestamp-link))
10393 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10394 (not (org-in-regexp org-any-link-re)))
10395 (org-footnote-action))
10397 (let (type path link line search (pos (point)))
10398 (catch 'match
10399 (save-excursion
10400 (or (org-in-regexp org-plain-link-re)
10401 (skip-chars-forward "^]\n\r"))
10402 (when (org-in-regexp org-bracket-link-regexp 1)
10403 (setq link (org-extract-attributes
10404 (org-link-unescape (org-match-string-no-properties 1))))
10405 (while (string-match " *\n *" link)
10406 (setq link (replace-match " " t t link)))
10407 (setq link (org-link-expand-abbrev link))
10408 (cond
10409 ((or (file-name-absolute-p link)
10410 (string-match "^\\.\\.?/" link))
10411 (setq type "file" path link))
10412 ((string-match org-link-re-with-space3 link)
10413 (setq type (match-string 1 link) path (match-string 2 link)))
10414 ((string-match "^help:+\\(.+\\)" link)
10415 (setq type "help" path (match-string 1 link)))
10416 (t (setq type "thisfile" path link)))
10417 (throw 'match t)))
10419 (when (get-text-property (point) 'org-linked-text)
10420 (setq type "thisfile"
10421 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10422 (1+ (point)) (point))
10423 path (buffer-substring
10424 (or (previous-single-property-change pos 'org-linked-text)
10425 (point-min))
10426 (or (next-single-property-change pos 'org-linked-text)
10427 (point-max)))
10428 ;; Ensure we will search for a <<<radio>>> link, not
10429 ;; a simple reference like <<ref>>
10430 path (concat "<" path))
10431 (throw 'match t))
10433 (save-excursion
10434 (when (or (org-in-regexp org-angle-link-re)
10435 (let ((match (org-in-regexp org-plain-link-re)))
10436 ;; Check a plain link is not within a bracket link
10437 (and match
10438 (save-excursion
10439 (save-match-data
10440 (progn
10441 (goto-char (car match))
10442 (not (org-in-regexp org-bracket-link-regexp)))))))
10443 (let ((line_ending (save-excursion (end-of-line) (point))))
10444 ;; We are in a line before a plain or bracket link
10445 (or (re-search-forward org-plain-link-re line_ending t)
10446 (re-search-forward org-bracket-link-regexp line_ending t))))
10447 (setq type (match-string 1)
10448 path (org-link-unescape (match-string 2)))
10449 (throw 'match t)))
10450 (save-excursion
10451 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
10452 (setq type "tags"
10453 path (match-string 1))
10454 (while (string-match ":" path)
10455 (setq path (replace-match "+" t t path)))
10456 (throw 'match t)))
10457 (when (org-in-regexp "<\\([^><\n]+\\)>")
10458 (setq type "tree-match"
10459 path (match-string 1))
10460 (throw 'match t)))
10461 (unless path
10462 (user-error "No link found"))
10464 ;; switch back to reference buffer
10465 ;; needed when if called in a temporary buffer through
10466 ;; org-open-link-from-string
10467 (with-current-buffer (or reference-buffer (current-buffer))
10469 ;; Remove any trailing spaces in path
10470 (if (string-match " +\\'" path)
10471 (setq path (replace-match "" t t path)))
10472 (if (and org-link-translation-function
10473 (fboundp org-link-translation-function))
10474 ;; Check if we need to translate the link
10475 (let ((tmp (funcall org-link-translation-function type path)))
10476 (setq type (car tmp) path (cdr tmp))))
10478 (cond
10480 ((assoc type org-link-protocols)
10481 (funcall (nth 1 (assoc type org-link-protocols)) path))
10483 ((equal type "help")
10484 (let ((f-or-v (intern path)))
10485 (cond ((fboundp f-or-v)
10486 (describe-function f-or-v))
10487 ((boundp f-or-v)
10488 (describe-variable f-or-v))
10489 (t (error "Not a known function or variable")))))
10491 ((equal type "mailto")
10492 (let ((cmd (car org-link-mailto-program))
10493 (args (cdr org-link-mailto-program)) args1
10494 (address path) (subject "") a)
10495 (if (string-match "\\(.*\\)::\\(.*\\)" path)
10496 (setq address (match-string 1 path)
10497 subject (org-link-escape (match-string 2 path))))
10498 (while args
10499 (cond
10500 ((not (stringp (car args))) (push (pop args) args1))
10501 (t (setq a (pop args))
10502 (if (string-match "%a" a)
10503 (setq a (replace-match address t t a)))
10504 (if (string-match "%s" a)
10505 (setq a (replace-match subject t t a)))
10506 (push a args1))))
10507 (apply cmd (nreverse args1))))
10509 ((member type '("http" "https" "ftp" "news"))
10510 (browse-url
10511 (concat type ":"
10512 (if (org-string-match-p
10513 (concat "[[:nonascii:]"
10514 org-link-escape-chars-browser "]")
10515 path)
10516 (org-link-escape path org-link-escape-chars-browser)
10517 path))))
10519 ((string= type "doi")
10520 (browse-url
10521 (concat org-doi-server-url
10522 (if (org-string-match-p
10523 (concat "[[:nonascii:]"
10524 org-link-escape-chars-browser "]")
10525 path)
10526 (org-link-escape path org-link-escape-chars-browser)
10527 path))))
10529 ((member type '("message"))
10530 (browse-url (concat type ":" path)))
10532 ((string= type "tags")
10533 (org-tags-view arg path))
10535 ((string= type "tree-match")
10536 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
10538 ((string= type "file")
10539 (if (string-match "::\\([0-9]+\\)\\'" path)
10540 (setq line (string-to-number (match-string 1 path))
10541 path (substring path 0 (match-beginning 0)))
10542 (if (string-match "::\\(.+\\)\\'" path)
10543 (setq search (match-string 1 path)
10544 path (substring path 0 (match-beginning 0)))))
10545 (if (string-match "[*?{]" (file-name-nondirectory path))
10546 (dired path)
10547 (org-open-file path arg line search)))
10549 ((string= type "shell")
10550 (let ((buf (generate-new-buffer "*Org Shell Output"))
10551 (cmd path))
10552 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10553 (string-match org-confirm-shell-link-not-regexp cmd))
10554 (not org-confirm-shell-link-function)
10555 (funcall org-confirm-shell-link-function
10556 (format "Execute \"%s\" in shell? "
10557 (org-add-props cmd nil
10558 'face 'org-warning))))
10559 (progn
10560 (message "Executing %s" cmd)
10561 (shell-command cmd buf)
10562 (if (featurep 'midnight)
10563 (setq clean-buffer-list-kill-buffer-names
10564 (cons buf clean-buffer-list-kill-buffer-names))))
10565 (error "Abort"))))
10567 ((string= type "elisp")
10568 (let ((cmd path))
10569 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10570 (string-match org-confirm-elisp-link-not-regexp cmd))
10571 (not org-confirm-elisp-link-function)
10572 (funcall org-confirm-elisp-link-function
10573 (format "Execute \"%s\" as elisp? "
10574 (org-add-props cmd nil
10575 'face 'org-warning))))
10576 (message "%s => %s" cmd
10577 (if (equal (string-to-char cmd) ?\()
10578 (eval (read cmd))
10579 (call-interactively (read cmd))))
10580 (error "Abort"))))
10582 ((and (string= type "thisfile")
10583 (or (run-hook-with-args-until-success
10584 'org-open-link-functions path)
10585 (and link
10586 (string-match "^id:" link)
10587 (or (featurep 'org-id) (require 'org-id))
10588 (progn
10589 (funcall (nth 1 (assoc "id" org-link-protocols))
10590 (substring path 3))
10591 t)))))
10593 ((string= type "thisfile")
10594 (if arg
10595 (switch-to-buffer-other-window
10596 (org-get-buffer-for-internal-link (current-buffer)))
10597 (org-mark-ring-push))
10598 (let ((cmd `(org-link-search
10599 ,path
10600 ,(cond ((equal arg '(4)) ''occur)
10601 ((equal arg '(16)) ''org-occur))
10602 ,pos)))
10603 (condition-case nil (let ((org-link-search-inhibit-query t))
10604 (eval cmd))
10605 (error (progn (widen) (eval cmd))))))
10607 (t (browse-url-at-point)))))))
10608 (move-marker org-open-link-marker nil)
10609 (run-hook-with-args 'org-follow-link-hook)))
10611 (defsubst org-uniquify (list)
10612 "Non-destructively remove duplicate elements from LIST."
10613 (let ((res (copy-sequence list))) (delete-dups res)))
10615 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10616 "Offer links in the current entry and return the selected link.
10617 If there is only one link, return it.
10618 If NTH is an integer, return the NTH link found.
10619 If ZERO is a string, check also this string for a link, and if
10620 there is one, return it."
10621 (with-current-buffer buffer
10622 (save-excursion
10623 (save-restriction
10624 (widen)
10625 (goto-char marker)
10626 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10627 "\\(" org-angle-link-re "\\)\\|"
10628 "\\(" org-plain-link-re "\\)"))
10629 (cnt ?0)
10630 (in-emacs (if (integerp nth) nil nth))
10631 have-zero end links link c)
10632 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10633 (push (match-string 0 zero) links)
10634 (setq cnt (1- cnt) have-zero t))
10635 (save-excursion
10636 (org-back-to-heading t)
10637 (setq end (save-excursion (outline-next-heading) (point)))
10638 (while (re-search-forward re end t)
10639 (push (match-string 0) links))
10640 (setq links (org-uniquify (reverse links))))
10641 (cond
10642 ((null links)
10643 (message "No links"))
10644 ((equal (length links) 1)
10645 (setq link (car links)))
10646 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10647 (setq link (nth (if have-zero nth (1- nth)) links)))
10648 (t ; we have to select a link
10649 (save-excursion
10650 (save-window-excursion
10651 (delete-other-windows)
10652 (with-output-to-temp-buffer "*Select Link*"
10653 (mapc (lambda (l)
10654 (if (not (string-match org-bracket-link-regexp l))
10655 (princ (format "[%c] %s\n" (incf cnt)
10656 (org-remove-angle-brackets l)))
10657 (if (match-end 3)
10658 (princ (format "[%c] %s (%s)\n" (incf cnt)
10659 (match-string 3 l) (match-string 1 l)))
10660 (princ (format "[%c] %s\n" (incf cnt)
10661 (match-string 1 l))))))
10662 links))
10663 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10664 (message "Select link to open, RET to open all:")
10665 (setq c (read-char-exclusive))
10666 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10667 (when (equal c ?q) (error "Abort"))
10668 (if (equal c ?\C-m)
10669 (setq link links)
10670 (setq nth (- c ?0))
10671 (if have-zero (setq nth (1+ nth)))
10672 (unless (and (integerp nth) (>= (length links) nth))
10673 (user-error "Invalid link selection"))
10674 (setq link (nth (1- nth) links)))))
10675 (cons link end))))))
10677 ;; Add special file links that specify the way of opening
10679 (org-add-link-type "file+sys" 'org-open-file-with-system)
10680 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10681 (defun org-open-file-with-system (path)
10682 "Open file at PATH using the system way of opening it."
10683 (org-open-file path 'system))
10684 (defun org-open-file-with-emacs (path)
10685 "Open file at PATH in Emacs."
10686 (org-open-file path 'emacs))
10689 ;;; File search
10691 (defvar org-create-file-search-functions nil
10692 "List of functions to construct the right search string for a file link.
10693 These functions are called in turn with point at the location to
10694 which the link should point.
10696 A function in the hook should first test if it would like to
10697 handle this file type, for example by checking the `major-mode'
10698 or the file extension. If it decides not to handle this file, it
10699 should just return nil to give other functions a chance. If it
10700 does handle the file, it must return the search string to be used
10701 when following the link. The search string will be part of the
10702 file link, given after a double colon, and `org-open-at-point'
10703 will automatically search for it. If special measures must be
10704 taken to make the search successful, another function should be
10705 added to the companion hook `org-execute-file-search-functions',
10706 which see.
10708 A function in this hook may also use `setq' to set the variable
10709 `description' to provide a suggestion for the descriptive text to
10710 be used for this link when it gets inserted into an Org-mode
10711 buffer with \\[org-insert-link].")
10713 (defvar org-execute-file-search-functions nil
10714 "List of functions to execute a file search triggered by a link.
10716 Functions added to this hook must accept a single argument, the
10717 search string that was part of the file link, the part after the
10718 double colon. The function must first check if it would like to
10719 handle this search, for example by checking the `major-mode' or
10720 the file extension. If it decides not to handle this search, it
10721 should just return nil to give other functions a chance. If it
10722 does handle the search, it must return a non-nil value to keep
10723 other functions from trying.
10725 Each function can access the current prefix argument through the
10726 variable `current-prefix-arg'. Note that a single prefix is used
10727 to force opening a link in Emacs, so it may be good to only use a
10728 numeric or double prefix to guide the search function.
10730 In case this is needed, a function in this hook can also restore
10731 the window configuration before `org-open-at-point' was called using:
10733 (set-window-configuration org-window-config-before-follow-link)")
10735 (defun org-link-search (s &optional type avoid-pos stealth)
10736 "Search for a link search option.
10737 If S is surrounded by forward slashes, it is interpreted as a
10738 regular expression. In org-mode files, this will create an `org-occur'
10739 sparse tree. In ordinary files, `occur' will be used to list matches.
10740 If the current buffer is in `dired-mode', grep will be used to search
10741 in all files. If AVOID-POS is given, ignore matches near that position.
10743 When optional argument STEALTH is non-nil, do not modify
10744 visibility around point, thus ignoring
10745 `org-show-hierarchy-above', `org-show-following-heading' and
10746 `org-show-siblings' variables."
10747 (let ((case-fold-search t)
10748 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10749 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10750 (append '(("") (" ") ("\t") ("\n"))
10751 org-emphasis-alist)
10752 "\\|") "\\)"))
10753 (pos (point))
10754 (pre nil) (post nil)
10755 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10756 (cond
10757 ;; First check if there are any special search functions
10758 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10759 ;; Now try the builtin stuff
10760 ((and (equal (string-to-char s0) ?#)
10761 (> (length s0) 1)
10762 (save-excursion
10763 (goto-char (point-min))
10764 (and
10765 (re-search-forward
10766 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10767 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10768 (setq type 'dedicated
10769 pos (match-beginning 0))))
10770 ;; There is an exact target for this
10771 (goto-char pos)
10772 (org-back-to-heading t)))
10773 ((save-excursion
10774 (goto-char (point-min))
10775 (and
10776 (re-search-forward
10777 (concat "<<" (regexp-quote s0) ">>") nil t)
10778 (setq type 'dedicated
10779 pos (match-beginning 0))))
10780 ;; There is an exact target for this
10781 (goto-char pos))
10782 ((save-excursion
10783 (goto-char (point-min))
10784 (and
10785 (re-search-forward
10786 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10787 (setq type 'dedicated pos (match-beginning 0))))
10788 ;; Found an element with a matching #+name affiliated keyword.
10789 (goto-char pos))
10790 ((and (string-match "^(\\(.*\\))$" s0)
10791 (save-excursion
10792 (goto-char (point-min))
10793 (and
10794 (re-search-forward
10795 (concat "[^[]" (regexp-quote
10796 (format org-coderef-label-format
10797 (match-string 1 s0))))
10798 nil t)
10799 (setq type 'dedicated
10800 pos (1+ (match-beginning 0))))))
10801 ;; There is a coderef target for this
10802 (goto-char pos))
10803 ((string-match "^/\\(.*\\)/$" s)
10804 ;; A regular expression
10805 (cond
10806 ((derived-mode-p 'org-mode)
10807 (org-occur (match-string 1 s)))
10808 (t (org-do-occur (match-string 1 s)))))
10809 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10810 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10811 (goto-char (point-min))
10812 (cond
10813 ((let (case-fold-search)
10814 (re-search-forward (format org-complex-heading-regexp-format
10815 (regexp-quote s))
10816 nil t))
10817 ;; OK, found a match
10818 (setq type 'dedicated)
10819 (goto-char (match-beginning 0)))
10820 ((and (not org-link-search-inhibit-query)
10821 (eq org-link-search-must-match-exact-headline 'query-to-create)
10822 (y-or-n-p "No match - create this as a new heading? "))
10823 (goto-char (point-max))
10824 (or (bolp) (newline))
10825 (insert "* " s "\n")
10826 (beginning-of-line 0))
10828 (goto-char pos)
10829 (error "No match"))))
10831 ;; A normal search string
10832 (when (equal (string-to-char s) ?*)
10833 ;; Anchor on headlines, post may include tags.
10834 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10835 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10836 s (substring s 1)))
10837 (remove-text-properties
10838 0 (length s)
10839 '(face nil mouse-face nil keymap nil fontified nil) s)
10840 ;; Make a series of regular expressions to find a match
10841 (setq words (org-split-string s "[ \n\r\t]+")
10843 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10844 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10845 "\\)" markers)
10846 re2a_ (concat "\\(" (mapconcat 'downcase words
10847 "[ \t\r\n]+") "\\)[ \t\r\n]")
10848 re2a (concat "[ \t\r\n]" re2a_)
10849 re4_ (concat "\\(" (mapconcat 'downcase words
10850 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10851 re4 (concat "[^a-zA-Z_]" re4_)
10853 re1 (concat pre re2 post)
10854 re3 (concat pre (if pre re4_ re4) post)
10855 re5 (concat pre ".*" re4)
10856 re2 (concat pre re2)
10857 re2a (concat pre (if pre re2a_ re2a))
10858 re4 (concat pre (if pre re4_ re4))
10859 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10860 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10861 re5 "\\)"))
10862 (cond
10863 ((eq type 'org-occur) (org-occur reall))
10864 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10865 (t (goto-char (point-min))
10866 (setq type 'fuzzy)
10867 (if (or (and (org-search-not-self 1 re0 nil t)
10868 (setq type 'dedicated))
10869 (org-search-not-self 1 re1 nil t)
10870 (org-search-not-self 1 re2 nil t)
10871 (org-search-not-self 1 re2a nil t)
10872 (org-search-not-self 1 re3 nil t)
10873 (org-search-not-self 1 re4 nil t)
10874 (org-search-not-self 1 re5 nil t))
10875 (goto-char (match-beginning 1))
10876 (goto-char pos)
10877 (error "No match"))))))
10878 (and (derived-mode-p 'org-mode)
10879 (not stealth)
10880 (org-show-context 'link-search))
10881 type))
10883 (defun org-search-not-self (group &rest args)
10884 "Execute `re-search-forward', but only accept matches that do not
10885 enclose the position of `org-open-link-marker'."
10886 (let ((m org-open-link-marker))
10887 (catch 'exit
10888 (while (apply 're-search-forward args)
10889 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10890 (goto-char (match-end group))
10891 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10892 (> (match-beginning 0) (marker-position m))
10893 (< (match-end 0) (marker-position m)))
10894 (save-match-data
10895 (or (not (org-in-regexp
10896 org-bracket-link-analytic-regexp 1))
10897 (not (match-end 4)) ; no description
10898 (and (<= (match-beginning 4) (point))
10899 (>= (match-end 4) (point))))))
10900 (throw 'exit (point))))))))
10902 (defun org-get-buffer-for-internal-link (buffer)
10903 "Return a buffer to be used for displaying the link target of internal links."
10904 (cond
10905 ((not org-display-internal-link-with-indirect-buffer)
10906 buffer)
10907 ((string-match "(Clone)$" (buffer-name buffer))
10908 (message "Buffer is already a clone, not making another one")
10909 ;; we also do not modify visibility in this case
10910 buffer)
10911 (t ; make a new indirect buffer for displaying the link
10912 (let* ((bn (buffer-name buffer))
10913 (ibn (concat bn "(Clone)"))
10914 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10915 (with-current-buffer ib (org-overview))
10916 ib))))
10918 (defun org-do-occur (regexp &optional cleanup)
10919 "Call the Emacs command `occur'.
10920 If CLEANUP is non-nil, remove the printout of the regular expression
10921 in the *Occur* buffer. This is useful if the regex is long and not useful
10922 to read."
10923 (occur regexp)
10924 (when cleanup
10925 (let ((cwin (selected-window)) win beg end)
10926 (when (setq win (get-buffer-window "*Occur*"))
10927 (select-window win))
10928 (goto-char (point-min))
10929 (when (re-search-forward "match[a-z]+" nil t)
10930 (setq beg (match-end 0))
10931 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10932 (setq end (1- (match-beginning 0)))))
10933 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10934 (goto-char (point-min))
10935 (select-window cwin))))
10937 ;;; The mark ring for links jumps
10939 (defvar org-mark-ring nil
10940 "Mark ring for positions before jumps in Org-mode.")
10941 (defvar org-mark-ring-last-goto nil
10942 "Last position in the mark ring used to go back.")
10943 ;; Fill and close the ring
10944 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10945 (loop for i from 1 to org-mark-ring-length do
10946 (push (make-marker) org-mark-ring))
10947 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10948 org-mark-ring)
10950 (defun org-mark-ring-push (&optional pos buffer)
10951 "Put the current position or POS into the mark ring and rotate it."
10952 (interactive)
10953 (setq pos (or pos (point)))
10954 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10955 (move-marker (car org-mark-ring)
10956 (or pos (point))
10957 (or buffer (current-buffer)))
10958 (message "%s"
10959 (substitute-command-keys
10960 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
10962 (defun org-mark-ring-goto (&optional n)
10963 "Jump to the previous position in the mark ring.
10964 With prefix arg N, jump back that many stored positions. When
10965 called several times in succession, walk through the entire ring.
10966 Org-mode commands jumping to a different position in the current file,
10967 or to another Org-mode file, automatically push the old position
10968 onto the ring."
10969 (interactive "p")
10970 (let (p m)
10971 (if (eq last-command this-command)
10972 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10973 (setq p org-mark-ring))
10974 (setq org-mark-ring-last-goto p)
10975 (setq m (car p))
10976 (org-pop-to-buffer-same-window (marker-buffer m))
10977 (goto-char m)
10978 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10980 (defun org-remove-angle-brackets (s)
10981 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10982 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10984 (defun org-add-angle-brackets (s)
10985 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10986 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10988 (defun org-remove-double-quotes (s)
10989 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
10990 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
10993 ;;; Following specific links
10995 (defun org-follow-timestamp-link ()
10996 "Open an agenda view for the time-stamp date/range at point."
10997 (cond
10998 ((org-at-date-range-p t)
10999 (let ((org-agenda-start-on-weekday)
11000 (t1 (match-string 1))
11001 (t2 (match-string 2)) tt1 tt2)
11002 (setq tt1 (time-to-days (org-time-string-to-time t1))
11003 tt2 (time-to-days (org-time-string-to-time t2)))
11004 (let ((org-agenda-buffer-tmp-name
11005 (format "*Org Agenda(a:%s)"
11006 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11007 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11008 ((org-at-timestamp-p t)
11009 (let ((org-agenda-buffer-tmp-name
11010 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11011 (org-agenda-list nil (time-to-days (org-time-string-to-time
11012 (substring (match-string 1) 0 10)))
11013 1)))
11014 (t (error "This should not happen"))))
11017 ;;; Following file links
11018 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11019 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11020 (declare-function mailcap-mime-info
11021 "mailcap" (string &optional request no-decode))
11022 (defvar org-wait nil)
11023 (defun org-open-file (path &optional in-emacs line search)
11024 "Open the file at PATH.
11025 First, this expands any special file name abbreviations. Then the
11026 configuration variable `org-file-apps' is checked if it contains an
11027 entry for this file type, and if yes, the corresponding command is launched.
11029 If no application is found, Emacs simply visits the file.
11031 With optional prefix argument IN-EMACS, Emacs will visit the file.
11032 With a double \\[universal-argument] \\[universal-argument] \
11033 prefix arg, Org tries to avoid opening in Emacs
11034 and to use an external application to visit the file.
11036 Optional LINE specifies a line to go to, optional SEARCH a string
11037 to search for. If LINE or SEARCH is given, the file will be
11038 opened in Emacs, unless an entry from org-file-apps that makes
11039 use of groups in a regexp matches.
11041 If you want to change the way frames are used when following a
11042 link, please customize `org-link-frame-setup'.
11044 If the file does not exist, an error is thrown."
11045 (let* ((file (if (equal path "")
11046 buffer-file-name
11047 (substitute-in-file-name (expand-file-name path))))
11048 (file-apps (append org-file-apps (org-default-apps)))
11049 (apps (org-remove-if
11050 'org-file-apps-entry-match-against-dlink-p file-apps))
11051 (apps-dlink (org-remove-if-not
11052 'org-file-apps-entry-match-against-dlink-p file-apps))
11053 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11054 (dirp (if remp nil (file-directory-p file)))
11055 (file (if (and dirp org-open-directory-means-index-dot-org)
11056 (concat (file-name-as-directory file) "index.org")
11057 file))
11058 (a-m-a-p (assq 'auto-mode apps))
11059 (dfile (downcase file))
11060 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11061 (link (cond ((and (eq line nil)
11062 (eq search nil))
11063 file)
11064 (line
11065 (concat file "::" (number-to-string line)))
11066 (search
11067 (concat file "::" search))))
11068 (dlink (downcase link))
11069 (old-buffer (current-buffer))
11070 (old-pos (point))
11071 (old-mode major-mode)
11072 ext cmd link-match-data)
11073 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11074 (setq ext (match-string 1 dfile))
11075 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11076 (setq ext (match-string 1 dfile))))
11077 (cond
11078 ((member in-emacs '((16) system))
11079 (setq cmd (cdr (assoc 'system apps))))
11080 (in-emacs (setq cmd 'emacs))
11082 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11083 (and dirp (cdr (assoc 'directory apps)))
11084 ; first, try matching against apps-dlink
11085 ; if we get a match here, store the match data for later
11086 (let ((match (assoc-default dlink apps-dlink
11087 'string-match)))
11088 (if match
11089 (progn (setq link-match-data (match-data))
11090 match)
11091 (progn (setq in-emacs (or in-emacs line search))
11092 nil))) ; if we have no match in apps-dlink,
11093 ; always open the file in emacs if line or search
11094 ; is given (for backwards compatibility)
11095 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11096 'string-match)
11097 (cdr (assoc ext apps))
11098 (cdr (assoc t apps))))))
11099 (when (eq cmd 'system)
11100 (setq cmd (cdr (assoc 'system apps))))
11101 (when (eq cmd 'default)
11102 (setq cmd (cdr (assoc t apps))))
11103 (when (eq cmd 'mailcap)
11104 (require 'mailcap)
11105 (mailcap-parse-mailcaps)
11106 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11107 (command (mailcap-mime-info mime-type)))
11108 (if (stringp command)
11109 (setq cmd command)
11110 (setq cmd 'emacs))))
11111 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11112 (not (file-exists-p file))
11113 (not org-open-non-existing-files))
11114 (user-error "No such file: %s" file))
11115 (cond
11116 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11117 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11118 (while (string-match "['\"]%s['\"]" cmd)
11119 (setq cmd (replace-match "%s" t t cmd)))
11120 (while (string-match "%s" cmd)
11121 (setq cmd (replace-match
11122 (save-match-data
11123 (shell-quote-argument
11124 (convert-standard-filename file)))
11125 t t cmd)))
11127 ;; Replace "%1", "%2" etc. in command with group matches from regex
11128 (save-match-data
11129 (let ((match-index 1)
11130 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11131 (set-match-data link-match-data)
11132 (while (<= match-index number-of-groups)
11133 (let ((regex (concat "%" (number-to-string match-index)))
11134 (replace-with (match-string match-index dlink)))
11135 (while (string-match regex cmd)
11136 (setq cmd (replace-match replace-with t t cmd))))
11137 (setq match-index (+ match-index 1)))))
11139 (save-window-excursion
11140 (message "Running %s...done" cmd)
11141 (start-process-shell-command cmd nil cmd)
11142 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11143 ((or (stringp cmd)
11144 (eq cmd 'emacs))
11145 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11146 (widen)
11147 (if line (org-goto-line line)
11148 (if search (org-link-search search))))
11149 ((consp cmd)
11150 (let ((file (convert-standard-filename file)))
11151 (save-match-data
11152 (set-match-data link-match-data)
11153 (eval cmd))))
11154 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11155 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11156 (or (not (equal old-buffer (current-buffer)))
11157 (not (equal old-pos (point))))
11158 (org-mark-ring-push old-pos old-buffer))))
11160 (defun org-file-apps-entry-match-against-dlink-p (entry)
11161 "This function returns non-nil if `entry' uses a regular
11162 expression which should be matched against the whole link by
11163 org-open-file.
11165 It assumes that is the case when the entry uses a regular
11166 expression which has at least one grouping construct and the
11167 action is either a lisp form or a command string containing
11168 '%1', i.e. using at least one subexpression match as a
11169 parameter."
11170 (let ((selector (car entry))
11171 (action (cdr entry)))
11172 (if (stringp selector)
11173 (and (> (regexp-opt-depth selector) 0)
11174 (or (and (stringp action)
11175 (string-match "%[0-9]" action))
11176 (consp action)))
11177 nil)))
11179 (defun org-default-apps ()
11180 "Return the default applications for this operating system."
11181 (cond
11182 ((eq system-type 'darwin)
11183 org-file-apps-defaults-macosx)
11184 ((eq system-type 'windows-nt)
11185 org-file-apps-defaults-windowsnt)
11186 (t org-file-apps-defaults-gnu)))
11188 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11189 "Convert extensions to regular expressions in the cars of LIST.
11190 Also, weed out any non-string entries, because the return value is used
11191 only for regexp matching.
11192 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11193 point to the symbol `emacs', indicating that the file should
11194 be opened in Emacs."
11195 (append
11196 (delq nil
11197 (mapcar (lambda (x)
11198 (if (not (stringp (car x)))
11200 (if (string-match "\\W" (car x))
11202 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11203 list))
11204 (if add-auto-mode
11205 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11207 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11208 (defun org-file-remote-p (file)
11209 "Test whether FILE specifies a location on a remote system.
11210 Return non-nil if the location is indeed remote.
11212 For example, the filename \"/user@host:/foo\" specifies a location
11213 on the system \"/user@host:\"."
11214 (cond ((fboundp 'file-remote-p)
11215 (file-remote-p file))
11216 ((fboundp 'tramp-handle-file-remote-p)
11217 (tramp-handle-file-remote-p file))
11218 ((and (boundp 'ange-ftp-name-format)
11219 (string-match (car ange-ftp-name-format) file))
11220 t)))
11223 ;;;; Refiling
11225 (defun org-get-org-file ()
11226 "Read a filename, with default directory `org-directory'."
11227 (let ((default (or org-default-notes-file remember-data-file)))
11228 (read-file-name (format "File name [%s]: " default)
11229 (file-name-as-directory org-directory)
11230 default)))
11232 (defun org-notes-order-reversed-p ()
11233 "Check if the current file should receive notes in reversed order."
11234 (cond
11235 ((not org-reverse-note-order) nil)
11236 ((eq t org-reverse-note-order) t)
11237 ((not (listp org-reverse-note-order)) nil)
11238 (t (catch 'exit
11239 (let ((all org-reverse-note-order)
11240 entry)
11241 (while (setq entry (pop all))
11242 (if (string-match (car entry) buffer-file-name)
11243 (throw 'exit (cdr entry))))
11244 nil)))))
11246 (defvar org-refile-target-table nil
11247 "The list of refile targets, created by `org-refile'.")
11249 (defvar org-agenda-new-buffers nil
11250 "Buffers created to visit agenda files.")
11252 (defvar org-refile-cache nil
11253 "Cache for refile targets.")
11255 (defvar org-refile-markers nil
11256 "All the markers used for caching refile locations.")
11258 (defun org-refile-marker (pos)
11259 "Get a new refile marker, but only if caching is in use."
11260 (if (not org-refile-use-cache)
11262 (let ((m (make-marker)))
11263 (move-marker m pos)
11264 (push m org-refile-markers)
11265 m)))
11267 (defun org-refile-cache-clear ()
11268 "Clear the refile cache and disable all the markers."
11269 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11270 (setq org-refile-markers nil)
11271 (setq org-refile-cache nil)
11272 (message "Refile cache has been cleared"))
11274 (defun org-refile-cache-check-set (set)
11275 "Check if all the markers in the cache still have live buffers."
11276 (let (marker)
11277 (catch 'exit
11278 (while (and set (setq marker (nth 3 (pop set))))
11279 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11280 (when (and marker (null (marker-buffer marker)))
11281 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11282 (sit-for 3)
11283 (throw 'exit nil)))
11284 t)))
11286 (defun org-refile-cache-put (set &rest identifiers)
11287 "Push the refile targets SET into the cache, under IDENTIFIERS."
11288 (let* ((key (sha1 (prin1-to-string identifiers)))
11289 (entry (assoc key org-refile-cache)))
11290 (if entry
11291 (setcdr entry set)
11292 (push (cons key set) org-refile-cache))))
11294 (defun org-refile-cache-get (&rest identifiers)
11295 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11296 (cond
11297 ((not org-refile-cache) nil)
11298 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11300 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11301 org-refile-cache))))
11302 (and set (org-refile-cache-check-set set) set)))))
11304 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11305 "Produce a table with refile targets."
11306 (let ((case-fold-search nil)
11307 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11308 (entries (or org-refile-targets '((nil . (:level . 1)))))
11309 targets tgs txt re files f desc descre fast-path-p level pos0)
11310 (message "Getting targets...")
11311 (with-current-buffer (or default-buffer (current-buffer))
11312 (while (setq entry (pop entries))
11313 (setq files (car entry) desc (cdr entry))
11314 (setq fast-path-p nil)
11315 (cond
11316 ((null files) (setq files (list (current-buffer))))
11317 ((eq files 'org-agenda-files)
11318 (setq files (org-agenda-files 'unrestricted)))
11319 ((and (symbolp files) (fboundp files))
11320 (setq files (funcall files)))
11321 ((and (symbolp files) (boundp files))
11322 (setq files (symbol-value files))))
11323 (if (stringp files) (setq files (list files)))
11324 (cond
11325 ((eq (car desc) :tag)
11326 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11327 ((eq (car desc) :todo)
11328 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11329 ((eq (car desc) :regexp)
11330 (setq descre (cdr desc)))
11331 ((eq (car desc) :level)
11332 (setq descre (concat "^\\*\\{" (number-to-string
11333 (if org-odd-levels-only
11334 (1- (* 2 (cdr desc)))
11335 (cdr desc)))
11336 "\\}[ \t]")))
11337 ((eq (car desc) :maxlevel)
11338 (setq fast-path-p t)
11339 (setq descre (concat "^\\*\\{1," (number-to-string
11340 (if org-odd-levels-only
11341 (1- (* 2 (cdr desc)))
11342 (cdr desc)))
11343 "\\}[ \t]")))
11344 (t (error "Bad refiling target description %s" desc)))
11345 (while (setq f (pop files))
11346 (with-current-buffer
11347 (if (bufferp f) f (org-get-agenda-file-buffer f))
11349 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11350 (progn
11351 (if (bufferp f) (setq f (buffer-file-name
11352 (buffer-base-buffer f))))
11353 (setq f (and f (expand-file-name f)))
11354 (if (eq org-refile-use-outline-path 'file)
11355 (push (list (file-name-nondirectory f) f nil nil) tgs))
11356 (save-excursion
11357 (save-restriction
11358 (widen)
11359 (goto-char (point-min))
11360 (while (re-search-forward descre nil t)
11361 (goto-char (setq pos0 (point-at-bol)))
11362 (catch 'next
11363 (when org-refile-target-verify-function
11364 (save-match-data
11365 (or (funcall org-refile-target-verify-function)
11366 (throw 'next t))))
11367 (when (and (looking-at org-complex-heading-regexp)
11368 (not (member (match-string 4) excluded-entries))
11369 (match-string 4))
11370 (setq level (org-reduced-level
11371 (- (match-end 1) (match-beginning 1)))
11372 txt (org-link-display-format (match-string 4))
11373 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11374 re (format org-complex-heading-regexp-format
11375 (regexp-quote (match-string 4))))
11376 (when org-refile-use-outline-path
11377 (setq txt (mapconcat
11378 'org-protect-slash
11379 (append
11380 (if (eq org-refile-use-outline-path
11381 'file)
11382 (list (file-name-nondirectory
11383 (buffer-file-name
11384 (buffer-base-buffer))))
11385 (if (eq org-refile-use-outline-path
11386 'full-file-path)
11387 (list (buffer-file-name
11388 (buffer-base-buffer)))))
11389 (org-get-outline-path fast-path-p
11390 level txt)
11391 (list txt))
11392 "/")))
11393 (push (list txt f re (org-refile-marker (point)))
11394 tgs)))
11395 (when (= (point) pos0)
11396 ;; verification function has not moved point
11397 (goto-char (point-at-eol))))))))
11398 (when org-refile-use-cache
11399 (org-refile-cache-put tgs (buffer-file-name) descre))
11400 (setq targets (append tgs targets))))))
11401 (message "Getting targets...done")
11402 (nreverse targets)))
11404 (defun org-protect-slash (s)
11405 (while (string-match "/" s)
11406 (setq s (replace-match "\\" t t s)))
11409 (defvar org-olpa (make-vector 20 nil))
11411 (defun org-get-outline-path (&optional fastp level heading)
11412 "Return the outline path to the current entry, as a list.
11414 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11415 routine which makes outline path derivations for an entire file,
11416 avoiding backtracing. Refile target collection makes use of that."
11417 (if fastp
11418 (progn
11419 (if (> level 19)
11420 (error "Outline path failure, more than 19 levels"))
11421 (loop for i from level upto 19 do
11422 (aset org-olpa i nil))
11423 (prog1
11424 (delq nil (append org-olpa nil))
11425 (aset org-olpa level heading)))
11426 (let (rtn case-fold-search)
11427 (save-excursion
11428 (save-restriction
11429 (widen)
11430 (while (org-up-heading-safe)
11431 (when (looking-at org-complex-heading-regexp)
11432 (push (org-trim
11433 (replace-regexp-in-string
11434 ;; Remove statistical/checkboxes cookies
11435 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11436 (org-match-string-no-properties 4)))
11437 rtn)))
11438 rtn)))))
11440 (defun org-format-outline-path (path &optional width prefix separator)
11441 "Format the outline path PATH for display.
11442 WIDTH is the maximum number of characters that is available.
11443 PREFIX is a prefix to be included in the returned string,
11444 such as the file name.
11445 SEPARATOR is inserted between the different parts of the path,
11446 the default is \"/\"."
11447 (setq width (or width 79))
11448 (if prefix (setq width (- width (length prefix))))
11449 (if (not path)
11450 (or prefix "")
11451 (let* ((nsteps (length path))
11452 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11453 (maxwidth (if (<= total-width width)
11454 10000 ;; everything fits
11455 ;; we need to shorten the level headings
11456 (/ (- width nsteps) nsteps)))
11457 (org-odd-levels-only nil)
11458 (n 0)
11459 (total (1+ (length prefix))))
11460 (setq maxwidth (max maxwidth 10))
11461 (concat prefix
11462 (if prefix (or separator "/"))
11463 (mapconcat
11464 (lambda (h)
11465 (setq n (1+ n))
11466 (if (and (= n nsteps) (< maxwidth 10000))
11467 (setq maxwidth (- total-width total)))
11468 (if (< (length h) maxwidth)
11469 (progn (setq total (+ total (length h) 1)) h)
11470 (setq h (substring h 0 (- maxwidth 2))
11471 total (+ total maxwidth 1))
11472 (if (string-match "[ \t]+\\'" h)
11473 (setq h (substring h 0 (match-beginning 0))))
11474 (setq h (concat h "..")))
11475 (org-add-props h nil 'face
11476 (nth (% (1- n) org-n-level-faces)
11477 org-level-faces))
11479 path (or separator "/"))))))
11481 (defun org-display-outline-path (&optional file current separator just-return-string)
11482 "Display the current outline path in the echo area.
11484 If FILE is non-nil, prepend the output with the file name.
11485 If CURRENT is non-nil, append the current heading to the output.
11486 SEPARATOR is passed through to `org-format-outline-path'. It separates
11487 the different parts of the path and defaults to \"/\".
11488 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11489 (interactive "P")
11490 (let* (case-fold-search
11491 (bfn (buffer-file-name (buffer-base-buffer)))
11492 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11493 res)
11494 (if current (setq path (append path
11495 (save-excursion
11496 (org-back-to-heading t)
11497 (if (looking-at org-complex-heading-regexp)
11498 (list (match-string 4)))))))
11499 (setq res
11500 (org-format-outline-path
11501 path
11502 (1- (frame-width))
11503 (and file bfn (concat (file-name-nondirectory bfn) separator))
11504 separator))
11505 (if just-return-string
11506 (org-no-properties res)
11507 (org-unlogged-message "%s" res))))
11509 (defvar org-refile-history nil
11510 "History for refiling operations.")
11512 (defvar org-after-refile-insert-hook nil
11513 "Hook run after `org-refile' has inserted its stuff at the new location.
11514 Note that this is still *before* the stuff will be removed from
11515 the *old* location.")
11517 (defvar org-capture-last-stored-marker)
11518 (defvar org-refile-keep nil
11519 "Non-nil means `org-refile' will copy instead of refile.")
11521 (defun org-copy ()
11522 "Like `org-refile', but copy."
11523 (interactive)
11524 (let ((org-refile-keep t))
11525 (funcall 'org-refile nil nil nil "Copy")))
11527 (defun org-refile (&optional goto default-buffer rfloc msg)
11528 "Move the entry or entries at point to another heading.
11529 The list of target headings is compiled using the information in
11530 `org-refile-targets', which see.
11532 At the target location, the entry is filed as a subitem of the target
11533 heading. Depending on `org-reverse-note-order', the new subitem will
11534 either be the first or the last subitem.
11536 If there is an active region, all entries in that region will be moved.
11537 However, the region must fulfill the requirement that the first heading
11538 is the first one sets the top-level of the moved text - at most siblings
11539 below it are allowed.
11541 With prefix arg GOTO, the command will only visit the target location
11542 and not actually move anything.
11544 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11545 go to the location where the last refiling operation has put the subtree.
11547 With a numeric prefix argument of `2', refile to the running clock.
11549 With a numeric prefix argument of `3', emulate `org-refile-keep'
11550 being set to `t' and copy to the target location, don't move it.
11551 Beware that keeping refiled entries may result in duplicated ID
11552 properties.
11554 RFLOC can be a refile location obtained in a different way.
11556 MSG is a string to replace \"Refile\" in the default prompt with
11557 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11559 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11561 If you are using target caching (see `org-refile-use-cache'),
11562 you have to clear the target cache in order to find new targets.
11563 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11564 prefix argument (`C-u C-u C-u C-c C-w')."
11566 (interactive "P")
11567 (if (member goto '(0 (64)))
11568 (org-refile-cache-clear)
11569 (let* ((actionmsg (cond (msg msg)
11570 ((equal goto 3) "Refile (and keep)")
11571 (t "Refile")))
11572 (cbuf (current-buffer))
11573 (regionp (org-region-active-p))
11574 (region-start (and regionp (region-beginning)))
11575 (region-end (and regionp (region-end)))
11576 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11577 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11578 pos it nbuf file re level reversed)
11579 (setq last-command nil)
11580 (when regionp
11581 (goto-char region-start)
11582 (or (bolp) (goto-char (point-at-bol)))
11583 (setq region-start (point))
11584 (unless (or (org-kill-is-subtree-p
11585 (buffer-substring region-start region-end))
11586 (prog1 org-refile-active-region-within-subtree
11587 (let ((s (point-at-eol)))
11588 (org-toggle-heading)
11589 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11590 (user-error "The region is not a (sequence of) subtree(s)")))
11591 (if (equal goto '(16))
11592 (org-refile-goto-last-stored)
11593 (when (or
11594 (and (equal goto 2)
11595 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11596 (prog1
11597 (setq it (list (or org-clock-heading "running clock")
11598 (buffer-file-name
11599 (marker-buffer org-clock-hd-marker))
11601 (marker-position org-clock-hd-marker)))
11602 (setq goto nil)))
11603 (setq it (or rfloc
11604 (let (heading-text)
11605 (save-excursion
11606 (unless (and goto (listp goto))
11607 (org-back-to-heading t)
11608 (setq heading-text
11609 (nth 4 (org-heading-components))))
11611 (org-refile-get-location
11612 (cond ((and goto (listp goto)) "Goto")
11613 (regionp (concat actionmsg " region to"))
11614 (t (concat actionmsg " subtree \""
11615 heading-text "\" to")))
11616 default-buffer
11617 (and (not (equal '(4) goto))
11618 org-refile-allow-creating-parent-nodes)
11619 goto))))))
11620 (setq file (nth 1 it)
11621 re (nth 2 it)
11622 pos (nth 3 it))
11623 (if (and (not goto)
11625 (equal (buffer-file-name) file)
11626 (if regionp
11627 (and (>= pos region-start)
11628 (<= pos region-end))
11629 (and (>= pos (point))
11630 (< pos (save-excursion
11631 (org-end-of-subtree t t))))))
11632 (error "Cannot refile to position inside the tree or region"))
11634 (setq nbuf (or (find-buffer-visiting file)
11635 (find-file-noselect file)))
11636 (if (and goto (not (equal goto 3)))
11637 (progn
11638 (org-pop-to-buffer-same-window nbuf)
11639 (goto-char pos)
11640 (org-show-context 'org-goto))
11641 (if regionp
11642 (progn
11643 (org-kill-new (buffer-substring region-start region-end))
11644 (org-save-markers-in-region region-start region-end))
11645 (org-copy-subtree 1 nil t))
11646 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11647 (find-file-noselect file)))
11648 (setq reversed (org-notes-order-reversed-p))
11649 (save-excursion
11650 (save-restriction
11651 (widen)
11652 (if pos
11653 (progn
11654 (goto-char pos)
11655 (looking-at org-outline-regexp)
11656 (setq level (org-get-valid-level (funcall outline-level) 1))
11657 (goto-char
11658 (if reversed
11659 (or (outline-next-heading) (point-max))
11660 (or (save-excursion (org-get-next-sibling))
11661 (org-end-of-subtree t t)
11662 (point-max)))))
11663 (setq level 1)
11664 (if (not reversed)
11665 (goto-char (point-max))
11666 (goto-char (point-min))
11667 (or (outline-next-heading) (goto-char (point-max)))))
11668 (if (not (bolp)) (newline))
11669 (org-paste-subtree level)
11670 (when org-log-refile
11671 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11672 (unless (eq org-log-refile 'note)
11673 (save-excursion (org-add-log-note))))
11674 (and org-auto-align-tags
11675 (let ((org-loop-over-headlines-in-active-region nil))
11676 (org-set-tags nil t)))
11677 (let ((bookmark-name (plist-get org-bookmark-names-plist
11678 :last-refile)))
11679 (when bookmark-name
11680 (with-demoted-errors
11681 (bookmark-set bookmark-name))))
11682 ;; If we are refiling for capture, make sure that the
11683 ;; last-capture pointers point here
11684 (when (org-bound-and-true-p org-refile-for-capture)
11685 (let ((bookmark-name (plist-get org-bookmark-names-plist
11686 :last-capture-marker)))
11687 (when bookmark-name
11688 (with-demoted-errors
11689 (bookmark-set bookmark-name))))
11690 (move-marker org-capture-last-stored-marker (point)))
11691 (if (fboundp 'deactivate-mark) (deactivate-mark))
11692 (run-hooks 'org-after-refile-insert-hook))))
11693 (unless org-refile-keep
11694 (if regionp
11695 (delete-region (point) (+ (point) (- region-end region-start)))
11696 (delete-region
11697 (and (org-back-to-heading t) (point))
11698 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11699 (when (featurep 'org-inlinetask)
11700 (org-inlinetask-remove-END-maybe))
11701 (setq org-markers-to-move nil)
11702 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11704 (defun org-refile-goto-last-stored ()
11705 "Go to the location where the last refile was stored."
11706 (interactive)
11707 (bookmark-jump "org-refile-last-stored")
11708 (message "This is the location of the last refile"))
11710 (defun org-refile--get-location (refloc tbl)
11711 "When user refile to REFLOC, find the associated target in TBL.
11712 Also check `org-refile-target-table'."
11713 (car (delq
11715 (mapcar
11716 (lambda (r) (or (assoc r tbl)
11717 (assoc r org-refile-target-table)))
11718 (list (replace-regexp-in-string "/$" "" refloc)
11719 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11721 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11722 no-exclude)
11723 "Prompt the user for a refile location, using PROMPT.
11724 PROMPT should not be suffixed with a colon and a space, because
11725 this function appends the default value from
11726 `org-refile-history' automatically, if that is not empty.
11727 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11728 this is used for the GOTO interface."
11729 (let ((org-refile-targets org-refile-targets)
11730 (org-refile-use-outline-path org-refile-use-outline-path)
11731 excluded-entries)
11732 (when (and (derived-mode-p 'org-mode)
11733 (not org-refile-use-cache)
11734 (not no-exclude))
11735 (org-map-tree
11736 (lambda()
11737 (setq excluded-entries
11738 (append excluded-entries (list (org-get-heading t t)))))))
11739 (setq org-refile-target-table
11740 (org-refile-get-targets default-buffer excluded-entries)))
11741 (unless org-refile-target-table
11742 (user-error "No refile targets"))
11743 (let* ((cbuf (current-buffer))
11744 (partial-completion-mode nil)
11745 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11746 (cfunc (if (and org-refile-use-outline-path
11747 org-outline-path-complete-in-steps)
11748 'org-olpath-completing-read
11749 'org-icompleting-read))
11750 (extra (if org-refile-use-outline-path "/" ""))
11751 (cbnex (concat (buffer-name) extra))
11752 (filename (and cfn (expand-file-name cfn)))
11753 (tbl (mapcar
11754 (lambda (x)
11755 (if (and (not (member org-refile-use-outline-path
11756 '(file full-file-path)))
11757 (not (equal filename (nth 1 x))))
11758 (cons (concat (car x) extra " ("
11759 (file-name-nondirectory (nth 1 x)) ")")
11760 (cdr x))
11761 (cons (concat (car x) extra) (cdr x))))
11762 org-refile-target-table))
11763 (completion-ignore-case t)
11764 cdef
11765 (prompt (concat prompt
11766 (or (and (car org-refile-history)
11767 (concat " (default " (car org-refile-history) ")"))
11768 (and (assoc cbnex tbl) (setq cdef cbnex)
11769 (concat " (default " cbnex ")"))) ": "))
11770 pa answ parent-target child parent old-hist)
11771 (setq old-hist org-refile-history)
11772 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11773 nil 'org-refile-history (or cdef (car org-refile-history))))
11774 (if (setq pa (org-refile--get-location answ tbl))
11775 (progn
11776 (org-refile-check-position pa)
11777 (when (or (not org-refile-history)
11778 (not (eq old-hist org-refile-history))
11779 (not (equal (car pa) (car org-refile-history))))
11780 (setq org-refile-history
11781 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11782 org-refile-history
11783 (cdr org-refile-history))))
11784 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11785 (pop org-refile-history)))
11787 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11788 (progn
11789 (setq parent (match-string 1 answ)
11790 child (match-string 2 answ))
11791 (setq parent-target (org-refile--get-location parent tbl))
11792 (when (and parent-target
11793 (or (eq new-nodes t)
11794 (and (eq new-nodes 'confirm)
11795 (y-or-n-p (format "Create new node \"%s\"? "
11796 child)))))
11797 (org-refile-new-child parent-target child)))
11798 (user-error "Invalid target location")))))
11800 (declare-function org-string-nw-p "org-macs" (s))
11801 (defun org-refile-check-position (refile-pointer)
11802 "Check if the refile pointer matches the headline to which it points."
11803 (let* ((file (nth 1 refile-pointer))
11804 (re (nth 2 refile-pointer))
11805 (pos (nth 3 refile-pointer))
11806 buffer)
11807 (if (and (not (markerp pos)) (not file))
11808 (user-error "Please save the buffer to a file before refiling")
11809 (when (org-string-nw-p re)
11810 (setq buffer (if (markerp pos)
11811 (marker-buffer pos)
11812 (or (find-buffer-visiting file)
11813 (find-file-noselect file))))
11814 (with-current-buffer buffer
11815 (save-excursion
11816 (save-restriction
11817 (widen)
11818 (goto-char pos)
11819 (beginning-of-line 1)
11820 (unless (org-looking-at-p re)
11821 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11823 (defun org-refile-new-child (parent-target child)
11824 "Use refile target PARENT-TARGET to add new CHILD below it."
11825 (unless parent-target
11826 (error "Cannot find parent for new node"))
11827 (let ((file (nth 1 parent-target))
11828 (pos (nth 3 parent-target))
11829 level)
11830 (with-current-buffer (or (find-buffer-visiting file)
11831 (find-file-noselect file))
11832 (save-excursion
11833 (save-restriction
11834 (widen)
11835 (if pos
11836 (goto-char pos)
11837 (goto-char (point-max))
11838 (if (not (bolp)) (newline)))
11839 (when (looking-at org-outline-regexp)
11840 (setq level (funcall outline-level))
11841 (org-end-of-subtree t t))
11842 (org-back-over-empty-lines)
11843 (insert "\n" (make-string
11844 (if pos (org-get-valid-level level 1) 1) ?*)
11845 " " child "\n")
11846 (beginning-of-line 0)
11847 (list (concat (car parent-target) "/" child) file "" (point)))))))
11849 (defun org-olpath-completing-read (prompt collection &rest args)
11850 "Read an outline path like a file name."
11851 (let ((thetable collection)
11852 (org-completion-use-ido nil) ; does not work with ido.
11853 (org-completion-use-iswitchb nil)) ; or iswitchb
11854 (apply
11855 'org-icompleting-read prompt
11856 (lambda (string predicate &optional flag)
11857 (let (rtn r f (l (length string)))
11858 (cond
11859 ((eq flag nil)
11860 ;; try completion
11861 (try-completion string thetable))
11862 ((eq flag t)
11863 ;; all-completions
11864 (setq rtn (all-completions string thetable predicate))
11865 (mapcar
11866 (lambda (x)
11867 (setq r (substring x l))
11868 (if (string-match " ([^)]*)$" x)
11869 (setq f (match-string 0 x))
11870 (setq f ""))
11871 (if (string-match "/" r)
11872 (concat string (substring r 0 (match-end 0)) f)
11874 rtn))
11875 ((eq flag 'lambda)
11876 ;; exact match?
11877 (assoc string thetable)))))
11878 args)))
11880 ;;;; Dynamic blocks
11882 (defun org-find-dblock (name)
11883 "Find the first dynamic block with name NAME in the buffer.
11884 If not found, stay at current position and return nil."
11885 (let ((case-fold-search t) pos)
11886 (save-excursion
11887 (goto-char (point-min))
11888 (setq pos (and (re-search-forward
11889 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11890 (match-beginning 0))))
11891 (if pos (goto-char pos))
11892 pos))
11894 (defconst org-dblock-start-re
11895 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
11896 "Matches the start line of a dynamic block, with parameters.")
11898 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
11899 "Matches the end of a dynamic block.")
11901 (defun org-create-dblock (plist)
11902 "Create a dynamic block section, with parameters taken from PLIST.
11903 PLIST must contain a :name entry which is used as name of the block."
11904 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11905 (end-of-line 1)
11906 (newline))
11907 (let ((col (current-column))
11908 (name (plist-get plist :name)))
11909 (insert "#+BEGIN: " name)
11910 (while plist
11911 (if (eq (car plist) :name)
11912 (setq plist (cddr plist))
11913 (insert " " (prin1-to-string (pop plist)))))
11914 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11915 (beginning-of-line -2)))
11917 (defun org-prepare-dblock ()
11918 "Prepare dynamic block for refresh.
11919 This empties the block, puts the cursor at the insert position and returns
11920 the property list including an extra property :name with the block name."
11921 (unless (looking-at org-dblock-start-re)
11922 (user-error "Not at a dynamic block"))
11923 (let* ((begdel (1+ (match-end 0)))
11924 (name (org-no-properties (match-string 1)))
11925 (params (append (list :name name)
11926 (read (concat "(" (match-string 3) ")")))))
11927 (save-excursion
11928 (beginning-of-line 1)
11929 (skip-chars-forward " \t")
11930 (setq params (plist-put params :indentation-column (current-column))))
11931 (unless (re-search-forward org-dblock-end-re nil t)
11932 (error "Dynamic block not terminated"))
11933 (setq params
11934 (append params
11935 (list :content (buffer-substring
11936 begdel (match-beginning 0)))))
11937 (delete-region begdel (match-beginning 0))
11938 (goto-char begdel)
11939 (open-line 1)
11940 params))
11942 (defun org-map-dblocks (&optional command)
11943 "Apply COMMAND to all dynamic blocks in the current buffer.
11944 If COMMAND is not given, use `org-update-dblock'."
11945 (let ((cmd (or command 'org-update-dblock)))
11946 (save-excursion
11947 (goto-char (point-min))
11948 (while (re-search-forward org-dblock-start-re nil t)
11949 (goto-char (match-beginning 0))
11950 (save-excursion
11951 (condition-case nil
11952 (funcall cmd)
11953 (error (message "Error during update of dynamic block"))))
11954 (unless (re-search-forward org-dblock-end-re nil t)
11955 (error "Dynamic block not terminated"))))))
11957 (defun org-dblock-update (&optional arg)
11958 "User command for updating dynamic blocks.
11959 Update the dynamic block at point. With prefix ARG, update all dynamic
11960 blocks in the buffer."
11961 (interactive "P")
11962 (if arg
11963 (org-update-all-dblocks)
11964 (or (looking-at org-dblock-start-re)
11965 (org-beginning-of-dblock))
11966 (org-update-dblock)))
11968 (defun org-update-dblock ()
11969 "Update the dynamic block at point.
11970 This means to empty the block, parse for parameters and then call
11971 the correct writing function."
11972 (interactive)
11973 (save-excursion
11974 (let* ((win (selected-window))
11975 (pos (point))
11976 (line (org-current-line))
11977 (params (org-prepare-dblock))
11978 (name (plist-get params :name))
11979 (indent (plist-get params :indentation-column))
11980 (cmd (intern (concat "org-dblock-write:" name))))
11981 (message "Updating dynamic block `%s' at line %d..." name line)
11982 (funcall cmd params)
11983 (message "Updating dynamic block `%s' at line %d...done" name line)
11984 (goto-char pos)
11985 (when (and indent (> indent 0))
11986 (setq indent (make-string indent ?\ ))
11987 (save-excursion
11988 (select-window win)
11989 (org-beginning-of-dblock)
11990 (forward-line 1)
11991 (while (not (looking-at org-dblock-end-re))
11992 (insert indent)
11993 (beginning-of-line 2))
11994 (when (looking-at org-dblock-end-re)
11995 (and (looking-at "[ \t]+")
11996 (replace-match ""))
11997 (insert indent)))))))
11999 (defun org-beginning-of-dblock ()
12000 "Find the beginning of the dynamic block at point.
12001 Error if there is no such block at point."
12002 (let ((pos (point))
12003 beg)
12004 (end-of-line 1)
12005 (if (and (re-search-backward org-dblock-start-re nil t)
12006 (setq beg (match-beginning 0))
12007 (re-search-forward org-dblock-end-re nil t)
12008 (> (match-end 0) pos))
12009 (goto-char beg)
12010 (goto-char pos)
12011 (error "Not in a dynamic block"))))
12013 (defun org-update-all-dblocks ()
12014 "Update all dynamic blocks in the buffer.
12015 This function can be used in a hook."
12016 (interactive)
12017 (when (derived-mode-p 'org-mode)
12018 (org-map-dblocks 'org-update-dblock)))
12021 ;;;; Completion
12023 (declare-function org-export-backend-name "org-export" (cl-x))
12024 (declare-function org-export-backend-options "org-export" (cl-x))
12025 (defun org-get-export-keywords ()
12026 "Return a list of all currently understood export keywords.
12027 Export keywords include options, block names, attributes and
12028 keywords relative to each registered export back-end."
12029 (let (keywords)
12030 (dolist (backend
12031 (org-bound-and-true-p org-export--registered-backends)
12032 (delq nil keywords))
12033 ;; Back-end name (for keywords, like #+LATEX:)
12034 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12035 (dolist (option-entry (org-export-backend-options backend))
12036 ;; Back-end options.
12037 (push (nth 1 option-entry) keywords)))))
12039 (defconst org-options-keywords
12040 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12041 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12042 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12043 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12044 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12046 (defcustom org-structure-template-alist
12047 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
12048 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
12049 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
12050 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
12051 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
12052 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
12053 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
12054 "<literal style=\"latex\">\n?\n</literal>")
12055 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
12056 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
12057 "<literal style=\"html\">\n?\n</literal>")
12058 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
12059 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
12060 ("A" "#+ASCII: " "")
12061 ("i" "#+INDEX: ?" "#+INDEX: ?")
12062 ("I" "#+INCLUDE: %file ?"
12063 "<include file=%file markup=\"?\">"))
12064 "Structure completion elements.
12065 This is a list of abbreviation keys and values. The value gets inserted
12066 if you type `<' followed by the key and then press the completion key,
12067 usually `M-TAB'. %file will be replaced by a file name after prompting
12068 for the file using completion. The cursor will be placed at the position
12069 of the `?` in the template.
12070 There are two templates for each key, the first uses the original Org syntax,
12071 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12072 the default when the /org-mtags.el/ module has been loaded. See also the
12073 variable `org-mtags-prefer-muse-templates'."
12074 :group 'org-completion
12075 :type '(repeat
12076 (list
12077 (string :tag "Key")
12078 (string :tag "Template")
12079 (string :tag "Muse Template"))))
12081 (defun org-try-structure-completion ()
12082 "Try to complete a structure template before point.
12083 This looks for strings like \"<e\" on an otherwise empty line and
12084 expands them."
12085 (let ((l (buffer-substring (point-at-bol) (point)))
12087 (when (and (looking-at "[ \t]*$")
12088 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12089 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12090 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12091 (match-beginning 1)) a)
12092 t)))
12094 (defun org-complete-expand-structure-template (start cell)
12095 "Expand a structure template."
12096 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12097 (rpl (nth (if musep 2 1) cell))
12098 (ind ""))
12099 (delete-region start (point))
12100 (when (string-match "\\`#\\+" rpl)
12101 (cond
12102 ((bolp))
12103 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12104 (setq ind (buffer-substring (point-at-bol) (point))))
12105 (t (newline))))
12106 (setq start (point))
12107 (if (string-match "%file" rpl)
12108 (setq rpl (replace-match
12109 (concat
12110 "\""
12111 (save-match-data
12112 (abbreviate-file-name (read-file-name "Include file: ")))
12113 "\"")
12114 t t rpl)))
12115 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12116 (concat "\n" ind)))
12117 (insert rpl)
12118 (if (re-search-backward "\\?" start t) (delete-char 1))))
12120 ;;;; TODO, DEADLINE, Comments
12122 (defun org-toggle-comment ()
12123 "Change the COMMENT state of an entry."
12124 (interactive)
12125 (save-excursion
12126 (org-back-to-heading)
12127 (let (case-fold-search)
12128 (cond
12129 ((looking-at (format org-heading-keyword-regexp-format
12130 org-comment-string))
12131 (goto-char (match-end 1))
12132 (looking-at (concat " +" org-comment-string))
12133 (replace-match "" t t)
12134 (when (eolp) (insert " ")))
12135 ((looking-at org-outline-regexp)
12136 (goto-char (match-end 0))
12137 (insert org-comment-string " "))))))
12139 (defvar org-last-todo-state-is-todo nil
12140 "This is non-nil when the last TODO state change led to a TODO state.
12141 If the last change removed the TODO tag or switched to DONE, then
12142 this is nil.")
12144 (defvar org-setting-tags nil) ; dynamically skipped
12146 (defvar org-todo-setup-filter-hook nil
12147 "Hook for functions that pre-filter todo specs.
12148 Each function takes a todo spec and returns either nil or the spec
12149 transformed into canonical form." )
12151 (defvar org-todo-get-default-hook nil
12152 "Hook for functions that get a default item for todo.
12153 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12154 nil or a string to be used for the todo mark." )
12156 (defvar org-agenda-headline-snapshot-before-repeat)
12158 (defun org-current-effective-time ()
12159 "Return current time adjusted for `org-extend-today-until' variable."
12160 (let* ((ct (org-current-time))
12161 (dct (decode-time ct))
12162 (ct1
12163 (cond
12164 (org-use-last-clock-out-time-as-effective-time
12165 (or (org-clock-get-last-clock-out-time) ct))
12166 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12167 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12168 (t ct))))
12169 ct1))
12171 (defun org-todo-yesterday (&optional arg)
12172 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12173 (interactive "P")
12174 (if (eq major-mode 'org-agenda-mode)
12175 (apply 'org-agenda-todo-yesterday arg)
12176 (let* ((hour (third (decode-time
12177 (org-current-time))))
12178 (org-extend-today-until (1+ hour)))
12179 (org-todo arg))))
12181 (defvar org-block-entry-blocking ""
12182 "First entry preventing the TODO state change.")
12184 (defun org-todo (&optional arg)
12185 "Change the TODO state of an item.
12186 The state of an item is given by a keyword at the start of the heading,
12187 like
12188 *** TODO Write paper
12189 *** DONE Call mom
12191 The different keywords are specified in the variable `org-todo-keywords'.
12192 By default the available states are \"TODO\" and \"DONE\".
12193 So for this example: when the item starts with TODO, it is changed to DONE.
12194 When it starts with DONE, the DONE is removed. And when neither TODO nor
12195 DONE are present, add TODO at the beginning of the heading.
12197 With \\[universal-argument] prefix arg, use completion to determine the new \
12198 state.
12199 With numeric prefix arg, switch to that state.
12200 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12201 keywords (nextset).
12202 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12203 With a numeric prefix arg of 0, inhibit note taking for the change.
12205 For calling through lisp, arg is also interpreted in the following way:
12206 'none -> empty state
12207 \"\"(empty string) -> switch to empty state
12208 'done -> switch to DONE
12209 'nextset -> switch to the next set of keywords
12210 'previousset -> switch to the previous set of keywords
12211 \"WAITING\" -> switch to the specified keyword, but only if it
12212 really is a member of `org-todo-keywords'."
12213 (interactive "P")
12214 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12215 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12216 'region-start-level 'region))
12217 org-loop-over-headlines-in-active-region)
12218 (org-map-entries
12219 `(org-todo ,arg)
12220 org-loop-over-headlines-in-active-region
12221 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12222 (if (equal arg '(16)) (setq arg 'nextset))
12223 (let ((org-blocker-hook org-blocker-hook)
12224 commentp
12225 case-fold-search)
12226 (when (equal arg '(64))
12227 (setq arg nil org-blocker-hook nil))
12228 (when (and org-blocker-hook
12229 (or org-inhibit-blocking
12230 (org-entry-get nil "NOBLOCKING")))
12231 (setq org-blocker-hook nil))
12232 (save-excursion
12233 (catch 'exit
12234 (org-back-to-heading t)
12235 (when (looking-at (concat "^\\*+ " org-comment-string))
12236 (org-toggle-comment)
12237 (setq commentp t))
12238 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12239 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12240 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12241 (let* ((match-data (match-data))
12242 (startpos (point-at-bol))
12243 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12244 (org-log-done org-log-done)
12245 (org-log-repeat org-log-repeat)
12246 (org-todo-log-states org-todo-log-states)
12247 (org-inhibit-logging
12248 (if (equal arg 0)
12249 (progn (setq arg nil) 'note) org-inhibit-logging))
12250 (this (match-string 1))
12251 (hl-pos (match-beginning 0))
12252 (head (org-get-todo-sequence-head this))
12253 (ass (assoc head org-todo-kwd-alist))
12254 (interpret (nth 1 ass))
12255 (done-word (nth 3 ass))
12256 (final-done-word (nth 4 ass))
12257 (org-last-state (or this ""))
12258 (completion-ignore-case t)
12259 (member (member this org-todo-keywords-1))
12260 (tail (cdr member))
12261 (org-state (cond
12262 ((and org-todo-key-trigger
12263 (or (and (equal arg '(4))
12264 (eq org-use-fast-todo-selection 'prefix))
12265 (and (not arg) org-use-fast-todo-selection
12266 (not (eq org-use-fast-todo-selection
12267 'prefix)))))
12268 ;; Use fast selection
12269 (org-fast-todo-selection))
12270 ((and (equal arg '(4))
12271 (or (not org-use-fast-todo-selection)
12272 (not org-todo-key-trigger)))
12273 ;; Read a state with completion
12274 (org-icompleting-read
12275 "State: " (mapcar 'list org-todo-keywords-1)
12276 nil t))
12277 ((eq arg 'right)
12278 (if this
12279 (if tail (car tail) nil)
12280 (car org-todo-keywords-1)))
12281 ((eq arg 'left)
12282 (if (equal member org-todo-keywords-1)
12284 (if this
12285 (nth (- (length org-todo-keywords-1)
12286 (length tail) 2)
12287 org-todo-keywords-1)
12288 (org-last org-todo-keywords-1))))
12289 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12290 (setq arg nil))) ; hack to fall back to cycling
12291 (arg
12292 ;; user or caller requests a specific state
12293 (cond
12294 ((equal arg "") nil)
12295 ((eq arg 'none) nil)
12296 ((eq arg 'done) (or done-word (car org-done-keywords)))
12297 ((eq arg 'nextset)
12298 (or (car (cdr (member head org-todo-heads)))
12299 (car org-todo-heads)))
12300 ((eq arg 'previousset)
12301 (let ((org-todo-heads (reverse org-todo-heads)))
12302 (or (car (cdr (member head org-todo-heads)))
12303 (car org-todo-heads))))
12304 ((car (member arg org-todo-keywords-1)))
12305 ((stringp arg)
12306 (user-error "State `%s' not valid in this file" arg))
12307 ((nth (1- (prefix-numeric-value arg))
12308 org-todo-keywords-1))))
12309 ((null member) (or head (car org-todo-keywords-1)))
12310 ((equal this final-done-word) nil) ;; -> make empty
12311 ((null tail) nil) ;; -> first entry
12312 ((memq interpret '(type priority))
12313 (if (eq this-command last-command)
12314 (car tail)
12315 (if (> (length tail) 0)
12316 (or done-word (car org-done-keywords))
12317 nil)))
12319 (car tail))))
12320 (org-state (or
12321 (run-hook-with-args-until-success
12322 'org-todo-get-default-hook org-state org-last-state)
12323 org-state))
12324 (next (if org-state (concat " " org-state " ") " "))
12325 (change-plist (list :type 'todo-state-change :from this :to org-state
12326 :position startpos))
12327 dolog now-done-p)
12328 (when org-blocker-hook
12329 (setq org-last-todo-state-is-todo
12330 (not (member this org-done-keywords)))
12331 (unless (save-excursion
12332 (save-match-data
12333 (org-with-wide-buffer
12334 (run-hook-with-args-until-failure
12335 'org-blocker-hook change-plist))))
12336 (if (org-called-interactively-p 'interactive)
12337 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12338 this org-state org-block-entry-blocking)
12339 ;; fail silently
12340 (message "TODO state change from %s to %s blocked (by \"%s\")"
12341 this org-state org-block-entry-blocking)
12342 (throw 'exit nil))))
12343 (store-match-data match-data)
12344 (replace-match next t t)
12345 (unless (pos-visible-in-window-p hl-pos)
12346 (message "TODO state changed to %s" (org-trim next)))
12347 (unless head
12348 (setq head (org-get-todo-sequence-head org-state)
12349 ass (assoc head org-todo-kwd-alist)
12350 interpret (nth 1 ass)
12351 done-word (nth 3 ass)
12352 final-done-word (nth 4 ass)))
12353 (when (memq arg '(nextset previousset))
12354 (message "Keyword-Set %d/%d: %s"
12355 (- (length org-todo-sets) -1
12356 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12357 (length org-todo-sets)
12358 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12359 (setq org-last-todo-state-is-todo
12360 (not (member org-state org-done-keywords)))
12361 (setq now-done-p (and (member org-state org-done-keywords)
12362 (not (member this org-done-keywords))))
12363 (and logging (org-local-logging logging))
12364 (when (and (or org-todo-log-states org-log-done)
12365 (not (eq org-inhibit-logging t))
12366 (not (memq arg '(nextset previousset))))
12367 ;; we need to look at recording a time and note
12368 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12369 (nth 2 (assoc this org-todo-log-states))))
12370 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12371 (setq dolog 'time))
12372 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12373 (and org-state
12374 (member org-state org-not-done-keywords)
12375 (not (member this org-not-done-keywords))))
12376 ;; This is now a todo state and was not one before
12377 ;; If there was a CLOSED time stamp, get rid of it.
12378 (org-add-planning-info nil nil 'closed))
12379 (when (and now-done-p org-log-done)
12380 ;; It is now done, and it was not done before
12381 (org-add-planning-info 'closed (org-current-effective-time))
12382 (if (and (not dolog) (eq 'note org-log-done))
12383 (org-add-log-setup 'done org-state this 'findpos 'note)))
12384 (when (and org-state dolog)
12385 ;; This is a non-nil state, and we need to log it
12386 (org-add-log-setup 'state org-state this 'findpos dolog)))
12387 ;; Fixup tag positioning
12388 (org-todo-trigger-tag-changes org-state)
12389 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12390 (when org-provide-todo-statistics
12391 (org-update-parent-todo-statistics))
12392 (run-hooks 'org-after-todo-state-change-hook)
12393 (if (and arg (not (member org-state org-done-keywords)))
12394 (setq head (org-get-todo-sequence-head org-state)))
12395 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12396 ;; Do we need to trigger a repeat?
12397 (when now-done-p
12398 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12399 ;; This is for the agenda, take a snapshot of the headline.
12400 (save-match-data
12401 (setq org-agenda-headline-snapshot-before-repeat
12402 (org-get-heading))))
12403 (org-auto-repeat-maybe org-state))
12404 ;; Fixup cursor location if close to the keyword
12405 (if (and (outline-on-heading-p)
12406 (not (bolp))
12407 (save-excursion (beginning-of-line 1)
12408 (looking-at org-todo-line-regexp))
12409 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12410 (progn
12411 (goto-char (or (match-end 2) (match-end 1)))
12412 (and (looking-at " ") (just-one-space))))
12413 (when org-trigger-hook
12414 (save-excursion
12415 (run-hook-with-args 'org-trigger-hook change-plist)))
12416 (when commentp (org-toggle-comment))))))))
12418 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12419 "Block turning an entry into a TODO, using the hierarchy.
12420 This checks whether the current task should be blocked from state
12421 changes. Such blocking occurs when:
12423 1. The task has children which are not all in a completed state.
12425 2. A task has a parent with the property :ORDERED:, and there
12426 are siblings prior to the current task with incomplete
12427 status.
12429 3. The parent of the task is blocked because it has siblings that should
12430 be done first, or is child of a block grandparent TODO entry."
12432 (if (not org-enforce-todo-dependencies)
12433 t ; if locally turned off don't block
12434 (catch 'dont-block
12435 ;; If this is not a todo state change, or if this entry is already DONE,
12436 ;; do not block
12437 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12438 (member (plist-get change-plist :from)
12439 (cons 'done org-done-keywords))
12440 (member (plist-get change-plist :to)
12441 (cons 'todo org-not-done-keywords))
12442 (not (plist-get change-plist :to)))
12443 (throw 'dont-block t))
12444 ;; If this task has children, and any are undone, it's blocked
12445 (save-excursion
12446 (org-back-to-heading t)
12447 (let ((this-level (funcall outline-level)))
12448 (outline-next-heading)
12449 (let ((child-level (funcall outline-level)))
12450 (while (and (not (eobp))
12451 (> child-level this-level))
12452 ;; this todo has children, check whether they are all
12453 ;; completed
12454 (if (and (not (org-entry-is-done-p))
12455 (org-entry-is-todo-p))
12456 (progn (setq org-block-entry-blocking (org-get-heading))
12457 (throw 'dont-block nil)))
12458 (outline-next-heading)
12459 (setq child-level (funcall outline-level))))))
12460 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12461 ;; any previous siblings are undone, it's blocked
12462 (save-excursion
12463 (org-back-to-heading t)
12464 (let* ((pos (point))
12465 (parent-pos (and (org-up-heading-safe) (point))))
12466 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12467 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12468 (forward-line 1)
12469 (re-search-forward org-not-done-heading-regexp pos t))
12470 (setq org-block-entry-blocking (match-string 0))
12471 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12472 ;; Search further up the hierarchy, to see if an ancestor is blocked
12473 (while t
12474 (goto-char parent-pos)
12475 (if (not (looking-at org-not-done-heading-regexp))
12476 (throw 'dont-block t)) ; do not block, parent is not a TODO
12477 (setq pos (point))
12478 (setq parent-pos (and (org-up-heading-safe) (point)))
12479 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12480 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12481 (forward-line 1)
12482 (re-search-forward org-not-done-heading-regexp pos t)
12483 (setq org-block-entry-blocking (org-get-heading)))
12484 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12486 (defcustom org-track-ordered-property-with-tag nil
12487 "Should the ORDERED property also be shown as a tag?
12488 The ORDERED property decides if an entry should require subtasks to be
12489 completed in sequence. Since a property is not very visible, setting
12490 this option means that toggling the ORDERED property with the command
12491 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12492 not relevant for the behavior, but it makes things more visible.
12494 Note that toggling the tag with tags commands will not change the property
12495 and therefore not influence behavior!
12497 This can be t, meaning the tag ORDERED should be used, It can also be a
12498 string to select a different tag for this task."
12499 :group 'org-todo
12500 :type '(choice
12501 (const :tag "No tracking" nil)
12502 (const :tag "Track with ORDERED tag" t)
12503 (string :tag "Use other tag")))
12505 (defun org-toggle-ordered-property ()
12506 "Toggle the ORDERED property of the current entry.
12507 For better visibility, you can track the value of this property with a tag.
12508 See variable `org-track-ordered-property-with-tag'."
12509 (interactive)
12510 (let* ((t1 org-track-ordered-property-with-tag)
12511 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12512 (save-excursion
12513 (org-back-to-heading)
12514 (if (org-entry-get nil "ORDERED")
12515 (progn
12516 (org-delete-property "ORDERED" "PROPERTIES")
12517 (and tag (org-toggle-tag tag 'off))
12518 (message "Subtasks can be completed in arbitrary order"))
12519 (org-entry-put nil "ORDERED" "t")
12520 (and tag (org-toggle-tag tag 'on))
12521 (message "Subtasks must be completed in sequence")))))
12523 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12524 (defun org-block-todo-from-checkboxes (change-plist)
12525 "Block turning an entry into a TODO, using checkboxes.
12526 This checks whether the current task should be blocked from state
12527 changes because there are unchecked boxes in this entry."
12528 (if (not org-enforce-todo-checkbox-dependencies)
12529 t ; if locally turned off don't block
12530 (catch 'dont-block
12531 ;; If this is not a todo state change, or if this entry is already DONE,
12532 ;; do not block
12533 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12534 (member (plist-get change-plist :from)
12535 (cons 'done org-done-keywords))
12536 (member (plist-get change-plist :to)
12537 (cons 'todo org-not-done-keywords))
12538 (not (plist-get change-plist :to)))
12539 (throw 'dont-block t))
12540 ;; If this task has checkboxes that are not checked, it's blocked
12541 (save-excursion
12542 (org-back-to-heading t)
12543 (let ((beg (point)) end)
12544 (outline-next-heading)
12545 (setq end (point))
12546 (goto-char beg)
12547 (if (org-list-search-forward
12548 (concat (org-item-beginning-re)
12549 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12550 "\\[[- ]\\]")
12551 end t)
12552 (progn
12553 (if (boundp 'org-blocked-by-checkboxes)
12554 (setq org-blocked-by-checkboxes t))
12555 (throw 'dont-block nil)))))
12556 t))) ; do not block
12558 (defun org-entry-blocked-p ()
12559 "Is the current entry blocked?"
12560 (org-with-silent-modifications
12561 (if (org-entry-get nil "NOBLOCKING")
12562 nil ;; Never block this entry
12563 (not (run-hook-with-args-until-failure
12564 'org-blocker-hook
12565 (list :type 'todo-state-change
12566 :position (point)
12567 :from 'todo
12568 :to 'done))))))
12570 (defun org-update-statistics-cookies (all)
12571 "Update the statistics cookie, either from TODO or from checkboxes.
12572 This should be called with the cursor in a line with a statistics cookie."
12573 (interactive "P")
12574 (if all
12575 (progn
12576 (org-update-checkbox-count 'all)
12577 (org-map-entries 'org-update-parent-todo-statistics))
12578 (if (not (org-at-heading-p))
12579 (org-update-checkbox-count)
12580 (let ((pos (point-marker))
12581 end l1 l2)
12582 (ignore-errors (org-back-to-heading t))
12583 (if (not (org-at-heading-p))
12584 (org-update-checkbox-count)
12585 (setq l1 (org-outline-level))
12586 (setq end (save-excursion
12587 (outline-next-heading)
12588 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12589 (point)))
12590 (if (and (save-excursion
12591 (re-search-forward
12592 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12593 (not (save-excursion (re-search-forward
12594 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12595 (org-update-checkbox-count)
12596 (if (and l2 (> l2 l1))
12597 (progn
12598 (goto-char end)
12599 (org-update-parent-todo-statistics))
12600 (goto-char pos)
12601 (beginning-of-line 1)
12602 (while (re-search-forward
12603 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12604 (point-at-eol) t)
12605 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12606 (goto-char pos)
12607 (move-marker pos nil)))))
12609 (defvar org-entry-property-inherited-from) ;; defined below
12610 (defun org-update-parent-todo-statistics ()
12611 "Update any statistics cookie in the parent of the current headline.
12612 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12613 the entire subtree and this will travel up the hierarchy and update
12614 statistics everywhere."
12615 (let* ((prop (save-excursion (org-up-heading-safe)
12616 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12617 (recursive (or (not org-hierarchical-todo-statistics)
12618 (and prop (string-match "\\<recursive\\>" prop))))
12619 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12621 (first t)
12622 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12623 level ltoggle l1 new ndel
12624 (cnt-all 0) (cnt-done 0) is-percent kwd
12625 checkbox-beg ov ovs ove cookie-present)
12626 (catch 'exit
12627 (save-excursion
12628 (beginning-of-line 1)
12629 (setq ltoggle (funcall outline-level))
12630 ;; Three situations are to consider:
12632 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12633 ;; to the top-level ancestor on the headline;
12635 ;; 2. If parent has "recursive" property, repeat up to the
12636 ;; headline setting that property, taking inheritance into
12637 ;; account;
12639 ;; 3. Else, move up to direct parent and proceed only once.
12640 (while (and (setq level (org-up-heading-safe))
12641 (or recursive first)
12642 (>= (point) lim))
12643 (setq first nil cookie-present nil)
12644 (unless (and level
12645 (not (string-match
12646 "\\<checkbox\\>"
12647 (downcase (or (org-entry-get nil "COOKIE_DATA")
12648 "")))))
12649 (throw 'exit nil))
12650 (while (re-search-forward box-re (point-at-eol) t)
12651 (setq cnt-all 0 cnt-done 0 cookie-present t)
12652 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12653 (save-match-data
12654 (unless (outline-next-heading) (throw 'exit nil))
12655 (while (and (looking-at org-complex-heading-regexp)
12656 (> (setq l1 (length (match-string 1))) level))
12657 (setq kwd (and (or recursive (= l1 ltoggle))
12658 (match-string 2)))
12659 (if (or (eq org-provide-todo-statistics 'all-headlines)
12660 (and (listp org-provide-todo-statistics)
12661 (or (member kwd org-provide-todo-statistics)
12662 (member kwd org-done-keywords))))
12663 (setq cnt-all (1+ cnt-all))
12664 (if (eq org-provide-todo-statistics t)
12665 (and kwd (setq cnt-all (1+ cnt-all)))))
12666 (and (member kwd org-done-keywords)
12667 (setq cnt-done (1+ cnt-done)))
12668 (outline-next-heading)))
12669 (setq new
12670 (if is-percent
12671 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12672 (format "[%d/%d]" cnt-done cnt-all))
12673 ndel (- (match-end 0) checkbox-beg))
12674 ;; handle overlays when updating cookie from column view
12675 (when (setq ov (car (overlays-at checkbox-beg)))
12676 (setq ovs (overlay-start ov) ove (overlay-end ov))
12677 (delete-overlay ov))
12678 (goto-char checkbox-beg)
12679 (insert new)
12680 (delete-region (point) (+ (point) ndel))
12681 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12682 (when ov (move-overlay ov ovs ove)))
12683 (when cookie-present
12684 (run-hook-with-args 'org-after-todo-statistics-hook
12685 cnt-done (- cnt-all cnt-done))))))
12686 (run-hooks 'org-todo-statistics-hook)))
12688 (defvar org-after-todo-statistics-hook nil
12689 "Hook that is called after a TODO statistics cookie has been updated.
12690 Each function is called with two arguments: the number of not-done entries
12691 and the number of done entries.
12693 For example, the following function, when added to this hook, will switch
12694 an entry to DONE when all children are done, and back to TODO when new
12695 entries are set to a TODO status. Note that this hook is only called
12696 when there is a statistics cookie in the headline!
12698 (defun org-summary-todo (n-done n-not-done)
12699 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12700 (let (org-log-done org-log-states) ; turn off logging
12701 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12704 (defvar org-todo-statistics-hook nil
12705 "Hook that is run whenever Org thinks TODO statistics should be updated.
12706 This hook runs even if there is no statistics cookie present, in which case
12707 `org-after-todo-statistics-hook' would not run.")
12709 (defun org-todo-trigger-tag-changes (state)
12710 "Apply the changes defined in `org-todo-state-tags-triggers'."
12711 (let ((l org-todo-state-tags-triggers)
12712 changes)
12713 (when (or (not state) (equal state ""))
12714 (setq changes (append changes (cdr (assoc "" l)))))
12715 (when (and (stringp state) (> (length state) 0))
12716 (setq changes (append changes (cdr (assoc state l)))))
12717 (when (member state org-not-done-keywords)
12718 (setq changes (append changes (cdr (assoc 'todo l)))))
12719 (when (member state org-done-keywords)
12720 (setq changes (append changes (cdr (assoc 'done l)))))
12721 (dolist (c changes)
12722 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12724 (defun org-local-logging (value)
12725 "Get logging settings from a property VALUE."
12726 (let* (words w a)
12727 ;; directly set the variables, they are already local.
12728 (setq org-log-done nil
12729 org-log-repeat nil
12730 org-todo-log-states nil)
12731 (setq words (org-split-string value))
12732 (while (setq w (pop words))
12733 (cond
12734 ((setq a (assoc w org-startup-options))
12735 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12736 (set (nth 1 a) (nth 2 a))))
12737 ((setq a (org-extract-log-state-settings w))
12738 (and (member (car a) org-todo-keywords-1)
12739 (push a org-todo-log-states)))))))
12741 (defun org-get-todo-sequence-head (kwd)
12742 "Return the head of the TODO sequence to which KWD belongs.
12743 If KWD is not set, check if there is a text property remembering the
12744 right sequence."
12745 (let (p)
12746 (cond
12747 ((not kwd)
12748 (or (get-text-property (point-at-bol) 'org-todo-head)
12749 (progn
12750 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12751 nil (point-at-eol)))
12752 (get-text-property p 'org-todo-head))))
12753 ((not (member kwd org-todo-keywords-1))
12754 (car org-todo-keywords-1))
12755 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12757 (defun org-fast-todo-selection ()
12758 "Fast TODO keyword selection with single keys.
12759 Returns the new TODO keyword, or nil if no state change should occur."
12760 (let* ((fulltable org-todo-key-alist)
12761 (done-keywords org-done-keywords) ;; needed for the faces.
12762 (maxlen (apply 'max (mapcar
12763 (lambda (x)
12764 (if (stringp (car x)) (string-width (car x)) 0))
12765 fulltable)))
12766 (expert nil)
12767 (fwidth (+ maxlen 3 1 3))
12768 (ncol (/ (- (window-width) 4) fwidth))
12769 tg cnt e c tbl
12770 groups ingroup)
12771 (save-excursion
12772 (save-window-excursion
12773 (if expert
12774 (set-buffer (get-buffer-create " *Org todo*"))
12775 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12776 (erase-buffer)
12777 (org-set-local 'org-done-keywords done-keywords)
12778 (setq tbl fulltable cnt 0)
12779 (while (setq e (pop tbl))
12780 (cond
12781 ((equal e '(:startgroup))
12782 (push '() groups) (setq ingroup t)
12783 (when (not (= cnt 0))
12784 (setq cnt 0)
12785 (insert "\n"))
12786 (insert "{ "))
12787 ((equal e '(:endgroup))
12788 (setq ingroup nil cnt 0)
12789 (insert "}\n"))
12790 ((equal e '(:newline))
12791 (when (not (= cnt 0))
12792 (setq cnt 0)
12793 (insert "\n")
12794 (setq e (car tbl))
12795 (while (equal (car tbl) '(:newline))
12796 (insert "\n")
12797 (setq tbl (cdr tbl)))))
12799 (setq tg (car e) c (cdr e))
12800 (if ingroup (push tg (car groups)))
12801 (setq tg (org-add-props tg nil 'face
12802 (org-get-todo-face tg)))
12803 (if (and (= cnt 0) (not ingroup)) (insert " "))
12804 (insert "[" c "] " tg (make-string
12805 (- fwidth 4 (length tg)) ?\ ))
12806 (when (= (setq cnt (1+ cnt)) ncol)
12807 (insert "\n")
12808 (if ingroup (insert " "))
12809 (setq cnt 0)))))
12810 (insert "\n")
12811 (goto-char (point-min))
12812 (if (not expert) (org-fit-window-to-buffer))
12813 (message "[a-z..]:Set [SPC]:clear")
12814 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12815 (cond
12816 ((or (= c ?\C-g)
12817 (and (= c ?q) (not (rassoc c fulltable))))
12818 (setq quit-flag t))
12819 ((= c ?\ ) nil)
12820 ((setq e (rassoc c fulltable) tg (car e))
12822 (t (setq quit-flag t)))))))
12824 (defun org-entry-is-todo-p ()
12825 (member (org-get-todo-state) org-not-done-keywords))
12827 (defun org-entry-is-done-p ()
12828 (member (org-get-todo-state) org-done-keywords))
12830 (defun org-get-todo-state ()
12831 "Return the TODO keyword of the current subtree."
12832 (save-excursion
12833 (org-back-to-heading t)
12834 (and (looking-at org-todo-line-regexp)
12835 (match-end 2)
12836 (match-string 2))))
12838 (defun org-at-date-range-p (&optional inactive-ok)
12839 "Is the cursor inside a date range?"
12840 (interactive)
12841 (save-excursion
12842 (catch 'exit
12843 (let ((pos (point)))
12844 (skip-chars-backward "^[<\r\n")
12845 (skip-chars-backward "<[")
12846 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12847 (>= (match-end 0) pos)
12848 (throw 'exit t))
12849 (skip-chars-backward "^<[\r\n")
12850 (skip-chars-backward "<[")
12851 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12852 (>= (match-end 0) pos)
12853 (throw 'exit t)))
12854 nil)))
12856 (defun org-get-repeat (&optional tagline)
12857 "Check if there is a deadline/schedule with repeater in this entry."
12858 (save-match-data
12859 (save-excursion
12860 (org-back-to-heading t)
12861 (and (re-search-forward (if tagline
12862 (concat tagline "\\s-*" org-repeat-re)
12863 org-repeat-re)
12864 (org-entry-end-position) t)
12865 (match-string-no-properties 1)))))
12867 (defvar org-last-changed-timestamp)
12868 (defvar org-last-inserted-timestamp)
12869 (defvar org-log-post-message)
12870 (defvar org-log-note-purpose)
12871 (defvar org-log-note-how)
12872 (defvar org-log-note-extra)
12873 (defun org-auto-repeat-maybe (done-word)
12874 "Check if the current headline contains a repeated deadline/schedule.
12875 If yes, set TODO state back to what it was and change the base date
12876 of repeating deadline/scheduled time stamps to new date.
12877 This function is run automatically after each state change to a DONE state."
12878 ;; last-state is dynamically scoped into this function
12879 (let* ((repeat (org-get-repeat))
12880 (aa (assoc org-last-state org-todo-kwd-alist))
12881 (interpret (nth 1 aa))
12882 (head (nth 2 aa))
12883 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12884 (msg "Entry repeats: ")
12885 (org-log-done nil)
12886 (org-todo-log-states nil)
12887 re type n what ts time to-state)
12888 (when repeat
12889 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12890 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12891 org-todo-repeat-to-state))
12892 (unless (and to-state (member to-state org-todo-keywords-1))
12893 (setq to-state (if (eq interpret 'type) org-last-state head)))
12894 (org-todo to-state)
12895 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12896 (org-entry-put nil "LAST_REPEAT" (format-time-string
12897 (org-time-stamp-format t t))))
12898 (when org-log-repeat
12899 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12900 (memq 'org-add-log-note post-command-hook))
12901 ;; OK, we are already setup for some record
12902 (if (eq org-log-repeat 'note)
12903 ;; make sure we take a note, not only a time stamp
12904 (setq org-log-note-how 'note))
12905 ;; Set up for taking a record
12906 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12907 org-last-state
12908 'findpos org-log-repeat)))
12909 (org-back-to-heading t)
12910 (org-add-planning-info nil nil 'closed)
12911 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12912 org-deadline-time-regexp "\\)\\|\\("
12913 org-ts-regexp "\\)"))
12914 (while (re-search-forward
12915 re (save-excursion (outline-next-heading) (point)) t)
12916 (setq type (if (match-end 1) org-scheduled-string
12917 (if (match-end 3) org-deadline-string "Plain:"))
12918 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12919 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12920 (setq n (string-to-number (match-string 2 ts))
12921 what (match-string 3 ts))
12922 (if (equal what "w") (setq n (* n 7) what "d"))
12923 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12924 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12925 ;; Preparation, see if we need to modify the start date for the change
12926 (when (match-end 1)
12927 (setq time (save-match-data (org-time-string-to-time ts)))
12928 (cond
12929 ((equal (match-string 1 ts) ".")
12930 ;; Shift starting date to today
12931 (org-timestamp-change
12932 (- (org-today) (time-to-days time))
12933 'day))
12934 ((equal (match-string 1 ts) "+")
12935 (let ((nshiftmax 10) (nshift 0))
12936 (while (or (= nshift 0)
12937 (<= (time-to-days time)
12938 (time-to-days (current-time))))
12939 (when (= (incf nshift) nshiftmax)
12940 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12941 (error "Abort")))
12942 (org-timestamp-change n (cdr (assoc what whata)))
12943 (org-at-timestamp-p t)
12944 (setq ts (match-string 1))
12945 (setq time (save-match-data (org-time-string-to-time ts)))))
12946 (org-timestamp-change (- n) (cdr (assoc what whata)))
12947 ;; rematch, so that we have everything in place for the real shift
12948 (org-at-timestamp-p t)
12949 (setq ts (match-string 1))
12950 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
12951 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12952 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12953 (setq org-log-post-message msg)
12954 (message "%s" msg))))
12956 (defun org-show-todo-tree (arg)
12957 "Make a compact tree which shows all headlines marked with TODO.
12958 The tree will show the lines where the regexp matches, and all higher
12959 headlines above the match.
12960 With a \\[universal-argument] prefix, prompt for a regexp to match.
12961 With a numeric prefix N, construct a sparse tree for the Nth element
12962 of `org-todo-keywords-1'."
12963 (interactive "P")
12964 (let ((case-fold-search nil)
12965 (kwd-re
12966 (cond ((null arg) org-not-done-regexp)
12967 ((equal arg '(4))
12968 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12969 (mapcar 'list org-todo-keywords-1))))
12970 (concat "\\("
12971 (mapconcat 'identity (org-split-string kwd "|") "\\|")
12972 "\\)\\>")))
12973 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12974 (regexp-quote (nth (1- (prefix-numeric-value arg))
12975 org-todo-keywords-1)))
12976 (t (user-error "Invalid prefix argument: %s" arg)))))
12977 (message "%d TODO entries found"
12978 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12980 (defun org-deadline (arg &optional time)
12981 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
12982 With one universal prefix argument, remove any deadline from the item.
12983 With two universal prefix arguments, prompt for a warning delay.
12984 With argument TIME, set the deadline at the corresponding date. TIME
12985 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
12986 (interactive "P")
12987 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12988 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12989 'region-start-level 'region))
12990 org-loop-over-headlines-in-active-region)
12991 (org-map-entries
12992 `(org-deadline ',arg ,time)
12993 org-loop-over-headlines-in-active-region
12994 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12995 (let* ((old-date (org-entry-get nil "DEADLINE"))
12996 (old-date-time (if old-date (org-time-string-to-time old-date)))
12997 (repeater (and old-date
12998 (string-match
12999 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13000 old-date)
13001 (match-string 1 old-date))))
13002 (cond
13003 ((equal arg '(4))
13004 (when (and old-date org-log-redeadline)
13005 (org-add-log-setup 'deldeadline nil old-date 'findpos
13006 org-log-redeadline))
13007 (org-remove-timestamp-with-keyword org-deadline-string)
13008 (message "Item no longer has a deadline."))
13009 ((equal arg '(16))
13010 (save-excursion
13011 (org-back-to-heading t)
13012 (if (re-search-forward
13013 org-deadline-time-regexp
13014 (save-excursion (outline-next-heading) (point)) t)
13015 (let* ((rpl0 (match-string 1))
13016 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13017 (replace-match
13018 (concat org-deadline-string
13019 " <" rpl
13020 (format " -%dd"
13021 (abs
13022 (- (time-to-days
13023 (save-match-data
13024 (org-read-date nil t nil "Warn starting from" old-date-time)))
13025 (time-to-days old-date-time))))
13026 ">") t t))
13027 (user-error "No deadline information to update"))))
13029 (org-add-planning-info 'deadline time 'closed)
13030 (when (and old-date org-log-redeadline
13031 (not (equal old-date
13032 (substring org-last-inserted-timestamp 1 -1))))
13033 (org-add-log-setup 'redeadline nil old-date 'findpos
13034 org-log-redeadline))
13035 (when repeater
13036 (save-excursion
13037 (org-back-to-heading t)
13038 (when (re-search-forward (concat org-deadline-string " "
13039 org-last-inserted-timestamp)
13040 (save-excursion
13041 (outline-next-heading) (point)) t)
13042 (goto-char (1- (match-end 0)))
13043 (insert " " repeater)
13044 (setq org-last-inserted-timestamp
13045 (concat (substring org-last-inserted-timestamp 0 -1)
13046 " " repeater
13047 (substring org-last-inserted-timestamp -1))))))
13048 (message "Deadline on %s" org-last-inserted-timestamp))))))
13050 (defun org-schedule (arg &optional time)
13051 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13052 With one universal prefix argument, remove any scheduling date from the item.
13053 With two universal prefix arguments, prompt for a delay cookie.
13054 With argument TIME, scheduled at the corresponding date. TIME can
13055 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13056 (interactive "P")
13057 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13058 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13059 'region-start-level 'region))
13060 org-loop-over-headlines-in-active-region)
13061 (org-map-entries
13062 `(org-schedule ',arg ,time)
13063 org-loop-over-headlines-in-active-region
13064 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13065 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13066 (old-date-time (if old-date (org-time-string-to-time old-date)))
13067 (repeater (and old-date
13068 (string-match
13069 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13070 old-date)
13071 (match-string 1 old-date))))
13072 (cond
13073 ((equal arg '(4))
13074 (progn
13075 (when (and old-date org-log-reschedule)
13076 (org-add-log-setup 'delschedule nil old-date 'findpos
13077 org-log-reschedule))
13078 (org-remove-timestamp-with-keyword org-scheduled-string)
13079 (message "Item is no longer scheduled.")))
13080 ((equal arg '(16))
13081 (save-excursion
13082 (org-back-to-heading t)
13083 (if (re-search-forward
13084 org-scheduled-time-regexp
13085 (save-excursion (outline-next-heading) (point)) t)
13086 (let* ((rpl0 (match-string 1))
13087 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13088 (replace-match
13089 (concat org-scheduled-string
13090 " <" rpl
13091 (format " -%dd"
13092 (abs
13093 (- (time-to-days
13094 (save-match-data
13095 (org-read-date nil t nil "Delay until" old-date-time)))
13096 (time-to-days old-date-time))))
13097 ">") t t))
13098 (user-error "No scheduled information to update"))))
13100 (org-add-planning-info 'scheduled time 'closed)
13101 (when (and old-date org-log-reschedule
13102 (not (equal old-date
13103 (substring org-last-inserted-timestamp 1 -1))))
13104 (org-add-log-setup 'reschedule nil old-date 'findpos
13105 org-log-reschedule))
13106 (when repeater
13107 (save-excursion
13108 (org-back-to-heading t)
13109 (when (re-search-forward (concat org-scheduled-string " "
13110 org-last-inserted-timestamp)
13111 (save-excursion
13112 (outline-next-heading) (point)) t)
13113 (goto-char (1- (match-end 0)))
13114 (insert " " repeater)
13115 (setq org-last-inserted-timestamp
13116 (concat (substring org-last-inserted-timestamp 0 -1)
13117 " " repeater
13118 (substring org-last-inserted-timestamp -1))))))
13119 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13121 (defun org-get-scheduled-time (pom &optional inherit)
13122 "Get the scheduled time as a time tuple, of a format suitable
13123 for calling org-schedule with, or if there is no scheduling,
13124 returns nil."
13125 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13126 (when time
13127 (apply 'encode-time (org-parse-time-string time)))))
13129 (defun org-get-deadline-time (pom &optional inherit)
13130 "Get the deadline as a time tuple, of a format suitable for
13131 calling org-deadline with, or if there is no scheduling, returns
13132 nil."
13133 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13134 (when time
13135 (apply 'encode-time (org-parse-time-string time)))))
13137 (defun org-remove-timestamp-with-keyword (keyword)
13138 "Remove all time stamps with KEYWORD in the current entry."
13139 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13140 beg)
13141 (save-excursion
13142 (org-back-to-heading t)
13143 (setq beg (point))
13144 (outline-next-heading)
13145 (while (re-search-backward re beg t)
13146 (replace-match "")
13147 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13148 (equal (char-before) ?\ ))
13149 (backward-delete-char 1)
13150 (if (string-match "^[ \t]*$" (buffer-substring
13151 (point-at-bol) (point-at-eol)))
13152 (delete-region (point-at-bol)
13153 (min (point-max) (1+ (point-at-eol))))))))))
13155 (defvar org-time-was-given) ; dynamically scoped parameter
13156 (defvar org-end-time-was-given) ; dynamically scoped parameter
13158 (defun org-add-planning-info (what &optional time &rest remove)
13159 "Insert new timestamp with keyword in the line directly after the headline.
13160 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13161 If non is given, the user is prompted for a date.
13162 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13163 be removed."
13164 (interactive)
13165 (let (org-time-was-given org-end-time-was-given ts
13166 end default-time default-input)
13168 (catch 'exit
13169 (when (and (memq what '(scheduled deadline))
13170 (or (not time)
13171 (and (stringp time)
13172 (string-match "^[-+]+[0-9]" time))))
13173 ;; Try to get a default date/time from existing timestamp
13174 (save-excursion
13175 (org-back-to-heading t)
13176 (setq end (save-excursion (outline-next-heading) (point)))
13177 (when (re-search-forward (if (eq what 'scheduled)
13178 org-scheduled-time-regexp
13179 org-deadline-time-regexp)
13180 end t)
13181 (setq ts (match-string 1)
13182 default-time
13183 (apply 'encode-time (org-parse-time-string ts))
13184 default-input (and ts (org-get-compact-tod ts))))))
13185 (when what
13186 (setq time
13187 (if (stringp time)
13188 ;; This is a string (relative or absolute), set proper date
13189 (apply 'encode-time
13190 (org-read-date-analyze
13191 time default-time (decode-time default-time)))
13192 ;; If necessary, get the time from the user
13193 (or time (org-read-date nil 'to-time nil nil
13194 default-time default-input)))))
13196 (when (and org-insert-labeled-timestamps-at-point
13197 (member what '(scheduled deadline)))
13198 (insert
13199 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13200 (org-insert-time-stamp time org-time-was-given
13201 nil nil nil (list org-end-time-was-given))
13202 (setq what nil))
13203 (save-excursion
13204 (save-restriction
13205 (let (col list elt ts buffer-invisibility-spec)
13206 (org-back-to-heading t)
13207 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13208 (goto-char (match-end 1))
13209 (setq col (current-column))
13210 (goto-char (match-end 0))
13211 (if (eobp) (insert "\n") (forward-char 1))
13212 (when (and (not what)
13213 (not (looking-at
13214 (concat "[ \t]*"
13215 org-keyword-time-not-clock-regexp))))
13216 ;; Nothing to add, nothing to remove...... :-)
13217 (throw 'exit nil))
13218 (if (and (not (looking-at org-outline-regexp))
13219 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13220 "[^\r\n]*"))
13221 (not (equal (match-string 1) org-clock-string)))
13222 (narrow-to-region (match-beginning 0) (match-end 0))
13223 (insert-before-markers "\n")
13224 (backward-char 1)
13225 (narrow-to-region (point) (point))
13226 (and org-adapt-indentation (org-indent-to-column col)))
13227 ;; Check if we have to remove something.
13228 (setq list (cons what remove))
13229 (while list
13230 (setq elt (pop list))
13231 (when (or (and (eq elt 'scheduled)
13232 (re-search-forward org-scheduled-time-regexp nil t))
13233 (and (eq elt 'deadline)
13234 (re-search-forward org-deadline-time-regexp nil t))
13235 (and (eq elt 'closed)
13236 (re-search-forward org-closed-time-regexp nil t)))
13237 (replace-match "")
13238 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13239 (and (looking-at "[ \t]+") (replace-match ""))
13240 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13241 (when what
13242 (insert
13243 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13244 (cond ((eq what 'scheduled) org-scheduled-string)
13245 ((eq what 'deadline) org-deadline-string)
13246 ((eq what 'closed) org-closed-string))
13247 " ")
13248 (setq ts (org-insert-time-stamp
13249 time
13250 (or org-time-was-given
13251 (and (eq what 'closed) org-log-done-with-time))
13252 (eq what 'closed)
13253 nil nil (list org-end-time-was-given)))
13254 (insert
13255 (if (not (or (bolp) (eq (char-before) ?\ )
13256 (memq (char-after) '(32 10))
13257 (eobp))) " " ""))
13258 (end-of-line 1))
13259 (goto-char (point-min))
13260 (widen)
13261 (if (and (looking-at "[ \t]*\n")
13262 (equal (char-before) ?\n))
13263 (delete-region (1- (point)) (point-at-eol)))
13264 ts))))))
13266 (defvar org-log-note-marker (make-marker))
13267 (defvar org-log-note-purpose nil)
13268 (defvar org-log-note-state nil)
13269 (defvar org-log-note-previous-state nil)
13270 (defvar org-log-note-how nil)
13271 (defvar org-log-note-extra nil)
13272 (defvar org-log-note-window-configuration nil)
13273 (defvar org-log-note-return-to (make-marker))
13274 (defvar org-log-note-effective-time nil
13275 "Remembered current time so that dynamically scoped
13276 `org-extend-today-until' affects tha timestamps in state change
13277 log")
13279 (defvar org-log-post-message nil
13280 "Message to be displayed after a log note has been stored.
13281 The auto-repeater uses this.")
13283 (defun org-add-note ()
13284 "Add a note to the current entry.
13285 This is done in the same way as adding a state change note."
13286 (interactive)
13287 (org-add-log-setup 'note nil nil 'findpos nil))
13289 (defvar org-property-end-re)
13290 (defun org-add-log-setup (&optional purpose state prev-state
13291 findpos how extra)
13292 "Set up the post command hook to take a note.
13293 If this is about to TODO state change, the new state is expected in STATE.
13294 When FINDPOS is non-nil, find the correct position for the note in
13295 the current entry. If not, assume that it can be inserted at point.
13296 HOW is an indicator what kind of note should be created.
13297 EXTRA is additional text that will be inserted into the notes buffer."
13298 (let* ((org-log-into-drawer (org-log-into-drawer))
13299 (drawer (cond ((stringp org-log-into-drawer)
13300 org-log-into-drawer)
13301 (org-log-into-drawer "LOGBOOK"))))
13302 (save-restriction
13303 (save-excursion
13304 (when findpos
13305 (org-back-to-heading t)
13306 (narrow-to-region (point) (save-excursion
13307 (outline-next-heading) (point)))
13308 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13309 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13310 "[^\r\n]*\\)?"))
13311 (goto-char (match-end 0))
13312 (cond
13313 (drawer
13314 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13315 nil t)
13316 (progn
13317 (goto-char (match-end 0))
13318 (or org-log-states-order-reversed
13319 (and (re-search-forward org-property-end-re nil t)
13320 (goto-char (1- (match-beginning 0))))))
13321 (insert "\n:" drawer ":\n:END:")
13322 (beginning-of-line 0)
13323 (org-indent-line)
13324 (beginning-of-line 2)
13325 (org-indent-line)
13326 (end-of-line 0)))
13327 ((and org-log-state-notes-insert-after-drawers
13328 (save-excursion
13329 (forward-line) (looking-at org-drawer-regexp)))
13330 (forward-line)
13331 (while (looking-at org-drawer-regexp)
13332 (goto-char (match-end 0))
13333 (re-search-forward org-property-end-re (point-max) t)
13334 (forward-line))
13335 (forward-line -1)))
13336 (unless org-log-states-order-reversed
13337 (and (= (char-after) ?\n) (forward-char 1))
13338 (org-skip-over-state-notes)
13339 (skip-chars-backward " \t\n\r")))
13340 (move-marker org-log-note-marker (point))
13341 (setq org-log-note-purpose purpose
13342 org-log-note-state state
13343 org-log-note-previous-state prev-state
13344 org-log-note-how how
13345 org-log-note-extra extra
13346 org-log-note-effective-time (org-current-effective-time))
13347 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13349 (defun org-skip-over-state-notes ()
13350 "Skip past the list of State notes in an entry."
13351 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13352 (when (ignore-errors (goto-char (org-in-item-p)))
13353 (let* ((struct (org-list-struct))
13354 (prevs (org-list-prevs-alist struct)))
13355 (while (looking-at "[ \t]*- State")
13356 (goto-char (or (org-list-get-next-item (point) struct prevs)
13357 (org-list-get-item-end (point) struct)))))))
13359 (defun org-add-log-note (&optional purpose)
13360 "Pop up a window for taking a note, and add this note later at point."
13361 (remove-hook 'post-command-hook 'org-add-log-note)
13362 (setq org-log-note-window-configuration (current-window-configuration))
13363 (delete-other-windows)
13364 (move-marker org-log-note-return-to (point))
13365 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13366 (goto-char org-log-note-marker)
13367 (org-switch-to-buffer-other-window "*Org Note*")
13368 (erase-buffer)
13369 (if (memq org-log-note-how '(time state))
13370 (let (current-prefix-arg) (org-store-log-note))
13371 (let ((org-inhibit-startup t)) (org-mode))
13372 (insert (format "# Insert note for %s.
13373 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13374 (cond
13375 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13376 ((eq org-log-note-purpose 'done) "closed todo item")
13377 ((eq org-log-note-purpose 'state)
13378 (format "state change from \"%s\" to \"%s\""
13379 (or org-log-note-previous-state "")
13380 (or org-log-note-state "")))
13381 ((eq org-log-note-purpose 'reschedule)
13382 "rescheduling")
13383 ((eq org-log-note-purpose 'delschedule)
13384 "no longer scheduled")
13385 ((eq org-log-note-purpose 'redeadline)
13386 "changing deadline")
13387 ((eq org-log-note-purpose 'deldeadline)
13388 "removing deadline")
13389 ((eq org-log-note-purpose 'refile)
13390 "refiling")
13391 ((eq org-log-note-purpose 'note)
13392 "this entry")
13393 (t (error "This should not happen")))))
13394 (if org-log-note-extra (insert org-log-note-extra))
13395 (org-set-local 'org-finish-function 'org-store-log-note)
13396 (run-hooks 'org-log-buffer-setup-hook)))
13398 (defvar org-note-abort nil) ; dynamically scoped
13399 (defun org-store-log-note ()
13400 "Finish taking a log note, and insert it to where it belongs."
13401 (let ((txt (buffer-string)))
13402 (kill-buffer (current-buffer))
13403 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13404 lines ind bul)
13405 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13406 (setq txt (replace-match "" t t txt)))
13407 (if (string-match "\\s-+\\'" txt)
13408 (setq txt (replace-match "" t t txt)))
13409 (setq lines (org-split-string txt "\n"))
13410 (when (and note (string-match "\\S-" note))
13411 (setq note
13412 (org-replace-escapes
13413 note
13414 (list (cons "%u" (user-login-name))
13415 (cons "%U" user-full-name)
13416 (cons "%t" (format-time-string
13417 (org-time-stamp-format 'long 'inactive)
13418 org-log-note-effective-time))
13419 (cons "%T" (format-time-string
13420 (org-time-stamp-format 'long nil)
13421 org-log-note-effective-time))
13422 (cons "%d" (format-time-string
13423 (org-time-stamp-format nil 'inactive)
13424 org-log-note-effective-time))
13425 (cons "%D" (format-time-string
13426 (org-time-stamp-format nil nil)
13427 org-log-note-effective-time))
13428 (cons "%s" (if org-log-note-state
13429 (concat "\"" org-log-note-state "\"")
13430 ""))
13431 (cons "%S" (if org-log-note-previous-state
13432 (concat "\"" org-log-note-previous-state "\"")
13433 "\"\"")))))
13434 (if lines (setq note (concat note " \\\\")))
13435 (push note lines))
13436 (when (or current-prefix-arg org-note-abort)
13437 (when org-log-into-drawer
13438 (org-remove-empty-drawer-at
13439 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13440 org-log-note-marker))
13441 (setq lines nil))
13442 (when lines
13443 (with-current-buffer (marker-buffer org-log-note-marker)
13444 (save-excursion
13445 (goto-char org-log-note-marker)
13446 (move-marker org-log-note-marker nil)
13447 (end-of-line 1)
13448 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13449 (setq ind (save-excursion
13450 (if (ignore-errors (goto-char (org-in-item-p)))
13451 (let ((struct (org-list-struct)))
13452 (org-list-get-ind
13453 (org-list-get-top-point struct) struct))
13454 (skip-chars-backward " \r\t\n")
13455 (cond
13456 ((and (org-at-heading-p)
13457 org-adapt-indentation)
13458 (1+ (org-current-level)))
13459 ((org-at-heading-p) 0)
13460 (t (org-get-indentation))))))
13461 (setq bul (org-list-bullet-string "-"))
13462 (org-indent-line-to ind)
13463 (insert bul (pop lines))
13464 (let ((ind-body (+ (length bul) ind)))
13465 (while lines
13466 (insert "\n")
13467 (org-indent-line-to ind-body)
13468 (insert (pop lines))))
13469 (message "Note stored")
13470 (org-back-to-heading t)
13471 (org-cycle-hide-drawers 'children))
13472 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13473 ;; from within `org-add-log-note' because `buffer-undo-list'
13474 ;; is then modified outside of `org-with-remote-undo'.
13475 (when (eq this-command 'org-agenda-todo)
13476 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13477 ;; Don't add undo information when called from `org-agenda-todo'
13478 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13479 (set-window-configuration org-log-note-window-configuration)
13480 (with-current-buffer (marker-buffer org-log-note-return-to)
13481 (goto-char org-log-note-return-to))
13482 (move-marker org-log-note-return-to nil)
13483 (and org-log-post-message (message "%s" org-log-post-message))))
13485 (defun org-remove-empty-drawer-at (drawer pos)
13486 "Remove an empty drawer DRAWER at position POS.
13487 POS may also be a marker."
13488 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13489 (save-excursion
13490 (save-restriction
13491 (widen)
13492 (goto-char pos)
13493 (if (org-in-regexp
13494 (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
13495 (replace-match ""))))))
13497 (defvar org-ts-type nil)
13498 (defun org-sparse-tree (&optional arg type)
13499 "Create a sparse tree, prompt for the details.
13500 This command can create sparse trees. You first need to select the type
13501 of match used to create the tree:
13503 t Show all TODO entries.
13504 T Show entries with a specific TODO keyword.
13505 m Show entries selected by a tags/property match.
13506 p Enter a property name and its value (both with completion on existing
13507 names/values) and show entries with that property.
13508 r Show entries matching a regular expression (`/' can be used as well).
13509 b Show deadlines and scheduled items before a date.
13510 a Show deadlines and scheduled items after a date.
13511 d Show deadlines due within `org-deadline-warning-days'.
13512 D Show deadlines and scheduled items between a date range."
13513 (interactive "P")
13514 (setq type (or type org-sparse-tree-default-date-type))
13515 (setq org-ts-type type)
13516 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13517 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13518 [c]ycle through date types: %s"
13519 (case type
13520 (all "all timestamps")
13521 (scheduled "only scheduled")
13522 (deadline "only deadline")
13523 (active "only active timestamps")
13524 (inactive "only inactive timestamps")
13525 (scheduled-or-deadline "scheduled/deadline")
13526 (closed "with a closed time-stamp")
13527 (otherwise "scheduled/deadline")))
13528 (let ((answer (read-char-exclusive)))
13529 (case answer
13531 (org-sparse-tree
13533 (cadr (memq type '(scheduled-or-deadline all scheduled deadline active
13534 inactive closed)))))
13535 (?d (call-interactively #'org-check-deadlines))
13536 (?b (call-interactively #'org-check-before-date))
13537 (?a (call-interactively #'org-check-after-date))
13538 (?D (call-interactively #'org-check-dates-range))
13539 (?t (call-interactively #'org-show-todo-tree))
13540 (?T (org-show-todo-tree '(4)))
13541 (?m (call-interactively #'org-match-sparse-tree))
13542 ((?p ?P)
13543 (let* ((kwd (org-icompleting-read
13544 "Property: " (mapcar #'list (org-buffer-property-keys))))
13545 (value (org-icompleting-read
13546 "Value: " (mapcar #'list (org-property-values kwd)))))
13547 (unless (string-match "\\`{.*}\\'" value)
13548 (setq value (concat "\"" value "\"")))
13549 (org-match-sparse-tree arg (concat kwd "=" value))))
13550 ((?r ?R ?/) (call-interactively #'org-occur))
13551 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13553 (defvar org-occur-highlights nil
13554 "List of overlays used for occur matches.")
13555 (make-variable-buffer-local 'org-occur-highlights)
13556 (defvar org-occur-parameters nil
13557 "Parameters of the active org-occur calls.
13558 This is a list, each call to org-occur pushes as cons cell,
13559 containing the regular expression and the callback, onto the list.
13560 The list can contain several entries if `org-occur' has been called
13561 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13562 will only contain one set of parameters. When the highlights are
13563 removed (for example with `C-c C-c', or with the next edit (depending
13564 on `org-remove-highlights-with-change'), this variable is emptied
13565 as well.")
13566 (make-variable-buffer-local 'org-occur-parameters)
13568 (defun org-occur (regexp &optional keep-previous callback)
13569 "Make a compact tree which shows all matches of REGEXP.
13570 The tree will show the lines where the regexp matches, and all higher
13571 headlines above the match. It will also show the heading after the match,
13572 to make sure editing the matching entry is easy.
13573 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13574 call to `org-occur' will be kept, to allow stacking of calls to this
13575 command.
13576 If CALLBACK is non-nil, it is a function which is called to confirm
13577 that the match should indeed be shown."
13578 (interactive "sRegexp: \nP")
13579 (when (equal regexp "")
13580 (user-error "Regexp cannot be empty"))
13581 (unless keep-previous
13582 (org-remove-occur-highlights nil nil t))
13583 (push (cons regexp callback) org-occur-parameters)
13584 (let ((cnt 0))
13585 (save-excursion
13586 (goto-char (point-min))
13587 (if (or (not keep-previous) ; do not want to keep
13588 (not org-occur-highlights)) ; no previous matches
13589 ;; hide everything
13590 (org-overview))
13591 (while (re-search-forward regexp nil t)
13592 (when (or (not callback)
13593 (save-match-data (funcall callback)))
13594 (setq cnt (1+ cnt))
13595 (when org-highlight-sparse-tree-matches
13596 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13597 (org-show-context 'occur-tree))))
13598 (when org-remove-highlights-with-change
13599 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13600 nil 'local))
13601 (unless org-sparse-tree-open-archived-trees
13602 (org-hide-archived-subtrees (point-min) (point-max)))
13603 (run-hooks 'org-occur-hook)
13604 (if (org-called-interactively-p 'interactive)
13605 (message "%d match(es) for regexp %s" cnt regexp))
13606 cnt))
13608 (defun org-occur-next-match (&optional n reset)
13609 "Function for `next-error-function' to find sparse tree matches.
13610 N is the number of matches to move, when negative move backwards.
13611 RESET is entirely ignored - this function always goes back to the
13612 starting point when no match is found."
13613 (let* ((limit (if (< n 0) (point-min) (point-max)))
13614 (search-func (if (< n 0)
13615 'previous-single-char-property-change
13616 'next-single-char-property-change))
13617 (n (abs n))
13618 (pos (point))
13620 (catch 'exit
13621 (while (setq p1 (funcall search-func (point) 'org-type))
13622 (when (equal p1 limit)
13623 (goto-char pos)
13624 (error "No more matches"))
13625 (when (equal (get-char-property p1 'org-type) 'org-occur)
13626 (setq n (1- n))
13627 (when (= n 0)
13628 (goto-char p1)
13629 (throw 'exit (point))))
13630 (goto-char p1))
13631 (goto-char p1)
13632 (error "No more matches"))))
13634 (defun org-show-context (&optional key)
13635 "Make sure point and context are visible.
13636 How much context is shown depends upon the variables
13637 `org-show-hierarchy-above', `org-show-following-heading',
13638 `org-show-entry-below' and `org-show-siblings'."
13639 (let ((heading-p (org-at-heading-p t))
13640 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13641 (following-p (org-get-alist-option org-show-following-heading key))
13642 (entry-p (org-get-alist-option org-show-entry-below key))
13643 (siblings-p (org-get-alist-option org-show-siblings key)))
13644 ;; Show heading or entry text
13645 (if (and heading-p (not entry-p))
13646 (org-flag-heading nil) ; only show the heading
13647 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13648 (org-show-hidden-entry))) ; show entire entry
13649 (when following-p
13650 ;; Show next sibling, or heading below text
13651 (save-excursion
13652 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13653 (org-flag-heading nil))))
13654 (when siblings-p (org-show-siblings))
13655 (when hierarchy-p
13656 ;; show all higher headings, possibly with siblings
13657 (save-excursion
13658 (while (and (condition-case nil
13659 (progn (org-up-heading-all 1) t)
13660 (error nil))
13661 (not (bobp)))
13662 (org-flag-heading nil)
13663 (when siblings-p (org-show-siblings)))))))
13665 (defvar org-reveal-start-hook nil
13666 "Hook run before revealing a location.")
13668 (defun org-reveal (&optional siblings)
13669 "Show current entry, hierarchy above it, and the following headline.
13670 This can be used to show a consistent set of context around locations
13671 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13672 not t for the search context.
13674 With optional argument SIBLINGS, on each level of the hierarchy all
13675 siblings are shown. This repairs the tree structure to what it would
13676 look like when opened with hierarchical calls to `org-cycle'.
13677 With double optional argument \\[universal-argument] \\[universal-argument], \
13678 go to the parent and show the
13679 entire tree."
13680 (interactive "P")
13681 (run-hooks 'org-reveal-start-hook)
13682 (let ((org-show-hierarchy-above t)
13683 (org-show-following-heading t)
13684 (org-show-siblings (if siblings t org-show-siblings)))
13685 (org-show-context nil))
13686 (when (equal siblings '(16))
13687 (save-excursion
13688 (when (org-up-heading-safe)
13689 (org-show-subtree)
13690 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13692 (defun org-highlight-new-match (beg end)
13693 "Highlight from BEG to END and mark the highlight is an occur headline."
13694 (let ((ov (make-overlay beg end)))
13695 (overlay-put ov 'face 'secondary-selection)
13696 (overlay-put ov 'org-type 'org-occur)
13697 (push ov org-occur-highlights)))
13699 (defun org-remove-occur-highlights (&optional beg end noremove)
13700 "Remove the occur highlights from the buffer.
13701 BEG and END are ignored. If NOREMOVE is nil, remove this function
13702 from the `before-change-functions' in the current buffer."
13703 (interactive)
13704 (unless org-inhibit-highlight-removal
13705 (mapc 'delete-overlay org-occur-highlights)
13706 (setq org-occur-highlights nil)
13707 (setq org-occur-parameters nil)
13708 (unless noremove
13709 (remove-hook 'before-change-functions
13710 'org-remove-occur-highlights 'local))))
13712 ;;;; Priorities
13714 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13715 "Regular expression matching the priority indicator.")
13717 (defvar org-remove-priority-next-time nil)
13719 (defun org-priority-up ()
13720 "Increase the priority of the current item."
13721 (interactive)
13722 (org-priority 'up))
13724 (defun org-priority-down ()
13725 "Decrease the priority of the current item."
13726 (interactive)
13727 (org-priority 'down))
13729 (defun org-priority (&optional action show)
13730 "Change the priority of an item.
13731 ACTION can be `set', `up', `down', or a character."
13732 (interactive "P")
13733 (if (equal action '(4))
13734 (org-show-priority)
13735 (unless org-enable-priority-commands
13736 (user-error "Priority commands are disabled"))
13737 (setq action (or action 'set))
13738 (let (current new news have remove)
13739 (save-excursion
13740 (org-back-to-heading t)
13741 (if (looking-at org-priority-regexp)
13742 (setq current (string-to-char (match-string 2))
13743 have t))
13744 (cond
13745 ((eq action 'remove)
13746 (setq remove t new ?\ ))
13747 ((or (eq action 'set)
13748 (if (featurep 'xemacs) (characterp action) (integerp action)))
13749 (if (not (eq action 'set))
13750 (setq new action)
13751 (message "Priority %c-%c, SPC to remove: "
13752 org-highest-priority org-lowest-priority)
13753 (save-match-data
13754 (setq new (read-char-exclusive))))
13755 (if (and (= (upcase org-highest-priority) org-highest-priority)
13756 (= (upcase org-lowest-priority) org-lowest-priority))
13757 (setq new (upcase new)))
13758 (cond ((equal new ?\ ) (setq remove t))
13759 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13760 (user-error "Priority must be between `%c' and `%c'"
13761 org-highest-priority org-lowest-priority))))
13762 ((eq action 'up)
13763 (setq new (if have
13764 (1- current) ; normal cycling
13765 ;; last priority was empty
13766 (if (eq last-command this-command)
13767 org-lowest-priority ; wrap around empty to lowest
13768 ;; default
13769 (if org-priority-start-cycle-with-default
13770 org-default-priority
13771 (1- org-default-priority))))))
13772 ((eq action 'down)
13773 (setq new (if have
13774 (1+ current) ; normal cycling
13775 ;; last priority was empty
13776 (if (eq last-command this-command)
13777 org-highest-priority ; wrap around empty to highest
13778 ;; default
13779 (if org-priority-start-cycle-with-default
13780 org-default-priority
13781 (1+ org-default-priority))))))
13782 (t (user-error "Invalid action")))
13783 (if (or (< (upcase new) org-highest-priority)
13784 (> (upcase new) org-lowest-priority))
13785 (if (and (memq action '(up down))
13786 (not have) (not (eq last-command this-command)))
13787 ;; `new' is from default priority
13788 (error
13789 "The default can not be set, see `org-default-priority' why")
13790 ;; normal cycling: `new' is beyond highest/lowest priority
13791 ;; and is wrapped around to the empty priority
13792 (setq remove t)))
13793 (setq news (format "%c" new))
13794 (if have
13795 (if remove
13796 (replace-match "" t t nil 1)
13797 (replace-match news t t nil 2))
13798 (if remove
13799 (user-error "No priority cookie found in line")
13800 (let ((case-fold-search nil))
13801 (looking-at org-todo-line-regexp))
13802 (if (match-end 2)
13803 (progn
13804 (goto-char (match-end 2))
13805 (insert " [#" news "]"))
13806 (goto-char (match-beginning 3))
13807 (insert "[#" news "] "))))
13808 (org-preserve-lc (org-set-tags nil 'align)))
13809 (if remove
13810 (message "Priority removed")
13811 (message "Priority of current item set to %s" news)))))
13813 (defun org-show-priority ()
13814 "Show the priority of the current item.
13815 This priority is composed of the main priority given with the [#A] cookies,
13816 and by additional input from the age of a schedules or deadline entry."
13817 (interactive)
13818 (let ((pri (if (eq major-mode 'org-agenda-mode)
13819 (org-get-at-bol 'priority)
13820 (save-excursion
13821 (save-match-data
13822 (beginning-of-line)
13823 (and (looking-at org-heading-regexp)
13824 (org-get-priority (match-string 0))))))))
13825 (message "Priority is %d" (if pri pri -1000))))
13827 (defun org-get-priority (s)
13828 "Find priority cookie and return priority."
13829 (save-match-data
13830 (if (functionp org-get-priority-function)
13831 (funcall org-get-priority-function)
13832 (if (not (string-match org-priority-regexp s))
13833 (* 1000 (- org-lowest-priority org-default-priority))
13834 (* 1000 (- org-lowest-priority
13835 (string-to-char (match-string 2 s))))))))
13837 ;;;; Tags
13839 (defvar org-agenda-archives-mode)
13840 (defvar org-map-continue-from nil
13841 "Position from where mapping should continue.
13842 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13844 (defvar org-scanner-tags nil
13845 "The current tag list while the tags scanner is running.")
13846 (defvar org-trust-scanner-tags nil
13847 "Should `org-get-tags-at' use the tags for the scanner.
13848 This is for internal dynamical scoping only.
13849 When this is non-nil, the function `org-get-tags-at' will return the value
13850 of `org-scanner-tags' instead of building the list by itself. This
13851 can lead to large speed-ups when the tags scanner is used in a file with
13852 many entries, and when the list of tags is retrieved, for example to
13853 obtain a list of properties. Building the tags list for each entry in such
13854 a file becomes an N^2 operation - but with this variable set, it scales
13855 as N.")
13857 (defun org-scan-tags (action matcher todo-only &optional start-level)
13858 "Scan headline tags with inheritance and produce output ACTION.
13860 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13861 or `agenda' to produce an entry list for an agenda view. It can also be
13862 a Lisp form or a function that should be called at each matched headline, in
13863 this case the return value is a list of all return values from these calls.
13865 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13866 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13867 only lines with a not-done TODO keyword are included in the output.
13868 This should be the same variable that was scoped into
13869 and set by `org-make-tags-matcher' when it constructed MATCHER.
13871 START-LEVEL can be a string with asterisks, reducing the scope to
13872 headlines matching this string."
13873 (require 'org-agenda)
13874 (let* ((re (concat "^"
13875 (if start-level
13876 ;; Get the correct level to match
13877 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13878 org-outline-regexp)
13879 " *\\(\\<\\("
13880 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13881 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13882 (props (list 'face 'default
13883 'done-face 'org-agenda-done
13884 'undone-face 'default
13885 'mouse-face 'highlight
13886 'org-not-done-regexp org-not-done-regexp
13887 'org-todo-regexp org-todo-regexp
13888 'org-complex-heading-regexp org-complex-heading-regexp
13889 'help-echo
13890 (format "mouse-2 or RET jump to org file %s"
13891 (abbreviate-file-name
13892 (or (buffer-file-name (buffer-base-buffer))
13893 (buffer-name (buffer-base-buffer)))))))
13894 (org-map-continue-from nil)
13895 lspos tags tags-list
13896 (tags-alist (list (cons 0 org-file-tags)))
13897 (llast 0) rtn rtn1 level category i txt
13898 todo marker entry priority)
13899 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13900 (setq action (list 'lambda nil action)))
13901 (save-excursion
13902 (goto-char (point-min))
13903 (when (eq action 'sparse-tree)
13904 (org-overview)
13905 (org-remove-occur-highlights))
13906 (while (let (case-fold-search)
13907 (re-search-forward re nil t))
13908 (setq org-map-continue-from nil)
13909 (catch :skip
13910 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13911 tags (if (match-end 4) (org-match-string-no-properties 4)))
13912 (goto-char (setq lspos (match-beginning 0)))
13913 (setq level (org-reduced-level (org-outline-level))
13914 category (org-get-category))
13915 (setq i llast llast level)
13916 ;; remove tag lists from same and sublevels
13917 (while (>= i level)
13918 (when (setq entry (assoc i tags-alist))
13919 (setq tags-alist (delete entry tags-alist)))
13920 (setq i (1- i)))
13921 ;; add the next tags
13922 (when tags
13923 (setq tags (org-split-string tags ":")
13924 tags-alist
13925 (cons (cons level tags) tags-alist)))
13926 ;; compile tags for current headline
13927 (setq tags-list
13928 (if org-use-tag-inheritance
13929 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13930 tags)
13931 org-scanner-tags tags-list)
13932 (when org-use-tag-inheritance
13933 (setcdr (car tags-alist)
13934 (mapcar (lambda (x)
13935 (setq x (copy-sequence x))
13936 (org-add-prop-inherited x))
13937 (cdar tags-alist))))
13938 (when (and tags org-use-tag-inheritance
13939 (or (not (eq t org-use-tag-inheritance))
13940 org-tags-exclude-from-inheritance))
13941 ;; selective inheritance, remove uninherited ones
13942 (setcdr (car tags-alist)
13943 (org-remove-uninherited-tags (cdar tags-alist))))
13944 (when (and
13946 ;; eval matcher only when the todo condition is OK
13947 (and (or (not todo-only) (member todo org-not-done-keywords))
13948 (let ((case-fold-search t) (org-trust-scanner-tags t))
13949 (eval matcher)))
13951 ;; Call the skipper, but return t if it does not skip,
13952 ;; so that the `and' form continues evaluating
13953 (progn
13954 (unless (eq action 'sparse-tree) (org-agenda-skip))
13957 ;; Check if timestamps are deselecting this entry
13958 (or (not todo-only)
13959 (and (member todo org-not-done-keywords)
13960 (or (not org-agenda-tags-todo-honor-ignore-options)
13961 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13963 ;; select this headline
13964 (cond
13965 ((eq action 'sparse-tree)
13966 (and org-highlight-sparse-tree-matches
13967 (org-get-heading) (match-end 0)
13968 (org-highlight-new-match
13969 (match-beginning 1) (match-end 1)))
13970 (org-show-context 'tags-tree))
13971 ((eq action 'agenda)
13972 (setq txt (org-agenda-format-item
13974 (concat
13975 (if (eq org-tags-match-list-sublevels 'indented)
13976 (make-string (1- level) ?.) "")
13977 (org-get-heading))
13978 level category
13979 tags-list)
13980 priority (org-get-priority txt))
13981 (goto-char lspos)
13982 (setq marker (org-agenda-new-marker))
13983 (org-add-props txt props
13984 'org-marker marker 'org-hd-marker marker 'org-category category
13985 'todo-state todo
13986 'priority priority 'type "tagsmatch")
13987 (push txt rtn))
13988 ((functionp action)
13989 (setq org-map-continue-from nil)
13990 (save-excursion
13991 (setq rtn1 (funcall action))
13992 (push rtn1 rtn)))
13993 (t (user-error "Invalid action")))
13995 ;; if we are to skip sublevels, jump to end of subtree
13996 (unless org-tags-match-list-sublevels
13997 (org-end-of-subtree t)
13998 (backward-char 1))))
13999 ;; Get the correct position from where to continue
14000 (if org-map-continue-from
14001 (goto-char org-map-continue-from)
14002 (and (= (point) lspos) (end-of-line 1)))))
14003 (when (and (eq action 'sparse-tree)
14004 (not org-sparse-tree-open-archived-trees))
14005 (org-hide-archived-subtrees (point-min) (point-max)))
14006 (nreverse rtn)))
14008 (defun org-remove-uninherited-tags (tags)
14009 "Remove all tags that are not inherited from the list TAGS."
14010 (cond
14011 ((eq org-use-tag-inheritance t)
14012 (if org-tags-exclude-from-inheritance
14013 (org-delete-all org-tags-exclude-from-inheritance tags)
14014 tags))
14015 ((not org-use-tag-inheritance) nil)
14016 ((stringp org-use-tag-inheritance)
14017 (delq nil (mapcar
14018 (lambda (x)
14019 (if (and (string-match org-use-tag-inheritance x)
14020 (not (member x org-tags-exclude-from-inheritance)))
14021 x nil))
14022 tags)))
14023 ((listp org-use-tag-inheritance)
14024 (delq nil (mapcar
14025 (lambda (x)
14026 (if (member x org-use-tag-inheritance) x nil))
14027 tags)))))
14029 (defun org-match-sparse-tree (&optional todo-only match)
14030 "Create a sparse tree according to tags string MATCH.
14031 MATCH can contain positive and negative selection of tags, like
14032 \"+WORK+URGENT-WITHBOSS\".
14033 If optional argument TODO-ONLY is non-nil, only select lines that are
14034 also TODO lines."
14035 (interactive "P")
14036 (org-agenda-prepare-buffers (list (current-buffer)))
14037 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14039 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14041 (defvar org-cached-props nil)
14042 (defun org-cached-entry-get (pom property)
14043 (if (or (eq t org-use-property-inheritance)
14044 (and (stringp org-use-property-inheritance)
14045 (string-match org-use-property-inheritance property))
14046 (and (listp org-use-property-inheritance)
14047 (member property org-use-property-inheritance)))
14048 ;; Caching is not possible, check it directly
14049 (org-entry-get pom property 'inherit)
14050 ;; Get all properties, so that we can do complicated checks easily
14051 (cdr (assoc property (or org-cached-props
14052 (setq org-cached-props
14053 (org-entry-properties pom)))))))
14055 (defun org-global-tags-completion-table (&optional files)
14056 "Return the list of all tags in all agenda buffer/files.
14057 Optional FILES argument is a list of files which can be used
14058 instead of the agenda files."
14059 (save-excursion
14060 (org-uniquify
14061 (delq nil
14062 (apply 'append
14063 (mapcar
14064 (lambda (file)
14065 (set-buffer (find-file-noselect file))
14066 (append (org-get-buffer-tags)
14067 (mapcar (lambda (x) (if (stringp (car-safe x))
14068 (list (car-safe x)) nil))
14069 org-tag-alist)))
14070 (if (and files (car files))
14071 files
14072 (org-agenda-files))))))))
14074 (defun org-make-tags-matcher (match)
14075 "Create the TAGS/TODO matcher form for the selection string MATCH.
14077 The variable `todo-only' is scoped dynamically into this function.
14078 It will be set to t if the matcher restricts matching to TODO entries,
14079 otherwise will not be touched.
14081 Returns a cons of the selection string MATCH and the constructed
14082 lisp form implementing the matcher. The matcher is to be evaluated
14083 at an Org entry, with point on the headline, and returns t if the
14084 entry matches the selection string MATCH. The returned lisp form
14085 references two variables with information about the entry, which
14086 must be bound around the form's evaluation: todo, the TODO keyword
14087 at the entry (or nil of none); and tags-list, the list of all tags
14088 at the entry including inherited ones. Additionally, the category
14089 of the entry (if any) must be specified as the text property
14090 'org-category on the headline.
14092 See also `org-scan-tags'.
14094 (declare (special todo-only))
14095 (unless (boundp 'todo-only)
14096 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14097 (unless match
14098 ;; Get a new match request, with completion against the global
14099 ;; tags table and the local tags in current buffer
14100 (let ((org-last-tags-completion-table
14101 (org-uniquify
14102 (delq nil (append (org-get-buffer-tags)
14103 (org-global-tags-completion-table))))))
14104 (setq match (org-completing-read-no-i
14105 "Match: " 'org-tags-completion-function nil nil nil
14106 'org-tags-history))))
14108 ;; Parse the string and create a lisp form
14109 (let ((match0 match)
14110 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14111 minus tag mm
14112 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14113 orterms term orlist re-p str-p level-p level-op time-p
14114 prop-p pn pv po gv rest (start 0) (ss 0))
14115 ;; Expand group tags
14116 (setq match (org-tags-expand match))
14118 ;; Check if there is a TODO part of this match, which would be the
14119 ;; part after a "/". TO make sure that this slash is not part of
14120 ;; a property value to be matched against, we also check that there
14121 ;; is no " after that slash.
14122 ;; First, find the last slash
14123 (while (string-match "/+" match ss)
14124 (setq start (match-beginning 0) ss (match-end 0)))
14125 (if (and (string-match "/+" match start)
14126 (not (save-match-data (string-match "\"" match start))))
14127 ;; match contains also a todo-matching request
14128 (progn
14129 (setq tagsmatch (substring match 0 (match-beginning 0))
14130 todomatch (substring match (match-end 0)))
14131 (if (string-match "^!" todomatch)
14132 (setq todo-only t todomatch (substring todomatch 1)))
14133 (if (string-match "^\\s-*$" todomatch)
14134 (setq todomatch nil)))
14135 ;; only matching tags
14136 (setq tagsmatch match todomatch nil))
14138 ;; Make the tags matcher
14139 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14140 (setq tagsmatcher t)
14141 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14142 (while (setq term (pop orterms))
14143 (while (and (equal (substring term -1) "\\") orterms)
14144 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14145 (while (string-match re term)
14146 (setq rest (substring term (match-end 0))
14147 minus (and (match-end 1)
14148 (equal (match-string 1 term) "-"))
14149 tag (save-match-data (replace-regexp-in-string
14150 "\\\\-" "-"
14151 (match-string 2 term)))
14152 re-p (equal (string-to-char tag) ?{)
14153 level-p (match-end 4)
14154 prop-p (match-end 5)
14155 mm (cond
14156 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14157 (level-p
14158 (setq level-op (org-op-to-function (match-string 3 term)))
14159 `(,level-op level ,(string-to-number
14160 (match-string 4 term))))
14161 (prop-p
14162 (setq pn (match-string 5 term)
14163 po (match-string 6 term)
14164 pv (match-string 7 term)
14165 re-p (equal (string-to-char pv) ?{)
14166 str-p (equal (string-to-char pv) ?\")
14167 time-p (save-match-data
14168 (string-match "^\"[[<].*[]>]\"$" pv))
14169 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14170 (if time-p (setq pv (org-matcher-time pv)))
14171 (setq po (org-op-to-function po (if time-p 'time str-p)))
14172 (cond
14173 ((equal pn "CATEGORY")
14174 (setq gv '(get-text-property (point) 'org-category)))
14175 ((equal pn "TODO")
14176 (setq gv 'todo))
14178 (setq gv `(org-cached-entry-get nil ,pn))))
14179 (if re-p
14180 (if (eq po 'org<>)
14181 `(not (string-match ,pv (or ,gv "")))
14182 `(string-match ,pv (or ,gv "")))
14183 (if str-p
14184 `(,po (or ,gv "") ,pv)
14185 `(,po (string-to-number (or ,gv ""))
14186 ,(string-to-number pv) ))))
14187 (t `(member ,tag tags-list)))
14188 mm (if minus (list 'not mm) mm)
14189 term rest)
14190 (push mm tagsmatcher))
14191 (push (if (> (length tagsmatcher) 1)
14192 (cons 'and tagsmatcher)
14193 (car tagsmatcher))
14194 orlist)
14195 (setq tagsmatcher nil))
14196 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14197 (setq tagsmatcher
14198 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14199 ;; Make the todo matcher
14200 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14201 (setq todomatcher t)
14202 (setq orterms (org-split-string todomatch "|") orlist nil)
14203 (while (setq term (pop orterms))
14204 (while (string-match re term)
14205 (setq minus (and (match-end 1)
14206 (equal (match-string 1 term) "-"))
14207 kwd (match-string 2 term)
14208 re-p (equal (string-to-char kwd) ?{)
14209 term (substring term (match-end 0))
14210 mm (if re-p
14211 `(string-match ,(substring kwd 1 -1) todo)
14212 (list 'equal 'todo kwd))
14213 mm (if minus (list 'not mm) mm))
14214 (push mm todomatcher))
14215 (push (if (> (length todomatcher) 1)
14216 (cons 'and todomatcher)
14217 (car todomatcher))
14218 orlist)
14219 (setq todomatcher nil))
14220 (setq todomatcher (if (> (length orlist) 1)
14221 (cons 'or orlist) (car orlist))))
14223 ;; Return the string and lisp forms of the matcher
14224 (setq matcher (if todomatcher
14225 (list 'and tagsmatcher todomatcher)
14226 tagsmatcher))
14227 (when todo-only
14228 (setq matcher (list 'and '(member todo org-not-done-keywords)
14229 matcher)))
14230 (cons match0 matcher)))
14232 (defun org-tags-expand (match &optional single-as-list downcased)
14233 "Expand group tags in MATCH.
14235 This replaces every group tag in MATCH with a regexp tag search.
14236 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14237 will be replaced like this:
14239 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14240 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14241 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14243 Replacing by a regexp preserves the structure of the match.
14244 E.g., this expansion
14246 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14248 will match anything tagged with \"Lab\" and \"Home\", or tagged
14249 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14251 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14252 assumed to be a single group tag, and the function will return
14253 the list of tags in this group.
14255 When DOWNCASE is non-nil, expand downcased TAGS."
14256 (if org-group-tags
14257 (let* ((case-fold-search t)
14258 (stable org-mode-syntax-table)
14259 (tal (or org-tag-groups-alist-for-agenda
14260 org-tag-groups-alist))
14261 (tal (if downcased
14262 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14263 (tml (mapcar 'car tal))
14264 (rtnmatch match) rpl)
14265 ;; @ and _ are allowed as word-components in tags
14266 (modify-syntax-entry ?@ "w" stable)
14267 (modify-syntax-entry ?_ "w" stable)
14268 (while (and tml
14269 (with-syntax-table stable
14270 (string-match
14271 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14272 (regexp-opt tml) "\\>\\)") rtnmatch)))
14273 (let* ((dir (match-string 1 rtnmatch))
14274 (tag (match-string 2 rtnmatch))
14275 (tag (if downcased (downcase tag) tag)))
14276 (setq tml (delete tag tml))
14277 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14278 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14279 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14280 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14281 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14282 (if single-as-list
14283 (or (reverse rpl) (list rtnmatch))
14284 rtnmatch))
14285 (if single-as-list (list (if downcased (downcase match) match))
14286 match)))
14288 (defun org-op-to-function (op &optional stringp)
14289 "Turn an operator into the appropriate function."
14290 (setq op
14291 (cond
14292 ((equal op "<" ) '(< string< org-time<))
14293 ((equal op ">" ) '(> org-string> org-time>))
14294 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14295 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14296 ((member op '("=" "==")) '(= string= org-time=))
14297 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14298 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14300 (defun org<> (a b) (not (= a b)))
14301 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14302 (defun org-string>= (a b) (not (string< a b)))
14303 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14304 (defun org-string<> (a b) (not (string= a b)))
14305 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14306 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14307 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14308 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14309 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14310 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14311 (defun org-2ft (s)
14312 "Convert S to a floating point time.
14313 If S is already a number, just return it. If it is a string, parse
14314 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14315 (cond
14316 ((numberp s) s)
14317 ((stringp s)
14318 (condition-case nil
14319 (float-time (apply 'encode-time (org-parse-time-string s)))
14320 (error 0.)))
14321 (t 0.)))
14323 (defun org-time-today ()
14324 "Time in seconds today at 0:00.
14325 Returns the float number of seconds since the beginning of the
14326 epoch to the beginning of today (00:00)."
14327 (float-time (apply 'encode-time
14328 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14330 (defun org-matcher-time (s)
14331 "Interpret a time comparison value."
14332 (save-match-data
14333 (cond
14334 ((string= s "<now>") (float-time))
14335 ((string= s "<today>") (org-time-today))
14336 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14337 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14338 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14339 (+ (org-time-today)
14340 (* (string-to-number (match-string 1 s))
14341 (cdr (assoc (match-string 2 s)
14342 '(("d" . 86400.0) ("w" . 604800.0)
14343 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14344 (t (org-2ft s)))))
14346 (defun org-match-any-p (re list)
14347 "Does re match any element of list?"
14348 (setq list (mapcar (lambda (x) (string-match re x)) list))
14349 (delq nil list))
14351 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14352 (defvar org-tags-overlay (make-overlay 1 1))
14353 (org-detach-overlay org-tags-overlay)
14355 (defun org-get-local-tags-at (&optional pos)
14356 "Get a list of tags defined in the current headline."
14357 (org-get-tags-at pos 'local))
14359 (defun org-get-local-tags ()
14360 "Get a list of tags defined in the current headline."
14361 (org-get-tags-at nil 'local))
14363 (defun org-get-tags-at (&optional pos local)
14364 "Get a list of all headline tags applicable at POS.
14365 POS defaults to point. If tags are inherited, the list contains
14366 the targets in the same sequence as the headlines appear, i.e.
14367 the tags of the current headline come last.
14368 When LOCAL is non-nil, only return tags from the current headline,
14369 ignore inherited ones."
14370 (interactive)
14371 (if (and org-trust-scanner-tags
14372 (or (not pos) (equal pos (point)))
14373 (not local))
14374 org-scanner-tags
14375 (let (tags ltags lastpos parent)
14376 (save-excursion
14377 (save-restriction
14378 (widen)
14379 (goto-char (or pos (point)))
14380 (save-match-data
14381 (catch 'done
14382 (condition-case nil
14383 (progn
14384 (org-back-to-heading t)
14385 (while (not (equal lastpos (point)))
14386 (setq lastpos (point))
14387 (when (looking-at
14388 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14389 (setq ltags (org-split-string
14390 (org-match-string-no-properties 1) ":"))
14391 (when parent
14392 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14393 (setq tags (append
14394 (if parent
14395 (org-remove-uninherited-tags ltags)
14396 ltags)
14397 tags)))
14398 (or org-use-tag-inheritance (throw 'done t))
14399 (if local (throw 'done t))
14400 (or (org-up-heading-safe) (error nil))
14401 (setq parent t)))
14402 (error nil)))))
14403 (if local
14404 tags
14405 (reverse (delete-dups
14406 (reverse (append
14407 (org-remove-uninherited-tags
14408 org-file-tags) tags)))))))))
14410 (defun org-add-prop-inherited (s)
14411 (add-text-properties 0 (length s) '(inherited t) s)
14414 (defun org-toggle-tag (tag &optional onoff)
14415 "Toggle the tag TAG for the current line.
14416 If ONOFF is `on' or `off', don't toggle but set to this state."
14417 (let (res current)
14418 (save-excursion
14419 (org-back-to-heading t)
14420 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14421 (point-at-eol) t)
14422 (progn
14423 (setq current (match-string 1))
14424 (replace-match ""))
14425 (setq current ""))
14426 (setq current (nreverse (org-split-string current ":")))
14427 (cond
14428 ((eq onoff 'on)
14429 (setq res t)
14430 (or (member tag current) (push tag current)))
14431 ((eq onoff 'off)
14432 (or (not (member tag current)) (setq current (delete tag current))))
14433 (t (if (member tag current)
14434 (setq current (delete tag current))
14435 (setq res t)
14436 (push tag current))))
14437 (end-of-line 1)
14438 (if current
14439 (progn
14440 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14441 (org-set-tags nil t))
14442 (delete-horizontal-space))
14443 (run-hooks 'org-after-tags-change-hook))
14444 res))
14446 (defun org-align-tags-here (to-col)
14447 ;; Assumes that this is a headline
14448 "Align tags on the current headline to TO-COL."
14449 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14450 (beginning-of-line 1)
14451 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14452 (< pos (match-beginning 2)))
14453 (progn
14454 (setq tags-l (- (match-end 2) (match-beginning 2)))
14455 (goto-char (match-beginning 1))
14456 (insert " ")
14457 (delete-region (point) (1+ (match-beginning 2)))
14458 (setq ncol (max (current-column)
14459 (1+ col)
14460 (if (> to-col 0)
14461 to-col
14462 (- (abs to-col) tags-l))))
14463 (setq p (point))
14464 (insert (make-string (- ncol (current-column)) ?\ ))
14465 (setq ncol (current-column))
14466 (when indent-tabs-mode (tabify p (point-at-eol)))
14467 (org-move-to-column (min ncol col)))
14468 (goto-char pos))))
14470 (defun org-set-tags-command (&optional arg just-align)
14471 "Call the set-tags command for the current entry."
14472 (interactive "P")
14473 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14474 (org-set-tags arg just-align)
14475 (save-excursion
14476 (unless (and (org-region-active-p)
14477 org-loop-over-headlines-in-active-region)
14478 (org-back-to-heading t))
14479 (org-set-tags arg just-align))))
14481 (defun org-set-tags-to (data)
14482 "Set the tags of the current entry to DATA, replacing the current tags.
14483 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14484 If DATA is nil or the empty string, any tags will be removed."
14485 (interactive "sTags: ")
14486 (setq data
14487 (cond
14488 ((eq data nil) "")
14489 ((equal data "") "")
14490 ((stringp data)
14491 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14492 ":"))
14493 ((listp data)
14494 (concat ":" (mapconcat 'identity data ":") ":"))))
14495 (when data
14496 (save-excursion
14497 (org-back-to-heading t)
14498 (when (looking-at org-complex-heading-regexp)
14499 (if (match-end 5)
14500 (progn
14501 (goto-char (match-beginning 5))
14502 (insert data)
14503 (delete-region (point) (point-at-eol))
14504 (org-set-tags nil 'align))
14505 (goto-char (point-at-eol))
14506 (insert " " data)
14507 (org-set-tags nil 'align)))
14508 (beginning-of-line 1)
14509 (if (looking-at ".*?\\([ \t]+\\)$")
14510 (delete-region (match-beginning 1) (match-end 1))))))
14512 (defun org-align-all-tags ()
14513 "Align the tags i all headings."
14514 (interactive)
14515 (save-excursion
14516 (or (ignore-errors (org-back-to-heading t))
14517 (outline-next-heading))
14518 (if (org-at-heading-p)
14519 (org-set-tags t)
14520 (message "No headings"))))
14522 (defvar org-indent-indentation-per-level)
14523 (defun org-set-tags (&optional arg just-align)
14524 "Set the tags for the current headline.
14525 With prefix ARG, realign all tags in headings in the current buffer.
14526 When JUST-ALIGN is non-nil, only align tags."
14527 (interactive "P")
14528 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14529 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14530 'region-start-level 'region))
14531 org-loop-over-headlines-in-active-region)
14532 (org-map-entries
14533 ;; We don't use ARG and JUST-ALIGN here because these args
14534 ;; are not useful when looping over headlines.
14535 `(org-set-tags)
14536 org-loop-over-headlines-in-active-region
14537 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14538 (let* ((re org-outline-regexp-bol)
14539 (current (unless arg (org-get-tags-string)))
14540 (col (current-column))
14541 (org-setting-tags t)
14542 table current-tags inherited-tags ; computed below when needed
14543 tags p0 c0 c1 rpl di tc level)
14544 (if arg
14545 (save-excursion
14546 (goto-char (point-min))
14547 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14548 (while (re-search-forward re nil t)
14549 (org-set-tags nil t)
14550 (end-of-line 1)))
14551 (message "All tags realigned to column %d" org-tags-column))
14552 (if just-align
14553 (setq tags current)
14554 ;; Get a new set of tags from the user
14555 (save-excursion
14556 (setq table (append org-tag-persistent-alist
14557 (or org-tag-alist (org-get-buffer-tags))
14558 (and
14559 org-complete-tags-always-offer-all-agenda-tags
14560 (org-global-tags-completion-table
14561 (org-agenda-files))))
14562 org-last-tags-completion-table table
14563 current-tags (org-split-string current ":")
14564 inherited-tags (nreverse
14565 (nthcdr (length current-tags)
14566 (nreverse (org-get-tags-at))))
14567 tags
14568 (if (or (eq t org-use-fast-tag-selection)
14569 (and org-use-fast-tag-selection
14570 (delq nil (mapcar 'cdr table))))
14571 (org-fast-tag-selection
14572 current-tags inherited-tags table
14573 (if org-fast-tag-selection-include-todo
14574 org-todo-key-alist))
14575 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14576 (org-trim
14577 (org-icompleting-read "Tags: "
14578 'org-tags-completion-function
14579 nil nil current 'org-tags-history))))))
14580 (while (string-match "[-+&]+" tags)
14581 ;; No boolean logic, just a list
14582 (setq tags (replace-match ":" t t tags))))
14584 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14586 (if org-tags-sort-function
14587 (setq tags (mapconcat 'identity
14588 (sort (org-split-string
14589 tags (org-re "[^[:alnum:]_@#%]+"))
14590 org-tags-sort-function) ":")))
14592 (if (string-match "\\`[\t ]*\\'" tags)
14593 (setq tags "")
14594 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14595 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14597 ;; Insert new tags at the correct column
14598 (beginning-of-line 1)
14599 (setq level (or (and (looking-at org-outline-regexp)
14600 (- (match-end 0) (point) 1))
14602 (cond
14603 ((and (equal current "") (equal tags "")))
14604 ((re-search-forward
14605 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14606 (point-at-eol) t)
14607 (if (equal tags "")
14608 (setq rpl "")
14609 (goto-char (match-beginning 0))
14610 (setq c0 (current-column)
14611 ;; compute offset for the case of org-indent-mode active
14612 di (if (org-bound-and-true-p org-indent-mode)
14613 (* (1- org-indent-indentation-per-level) (1- level))
14615 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14616 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14617 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14618 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14619 (replace-match rpl t t)
14620 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14621 tags)
14622 (t (error "Tags alignment failed")))
14623 (org-move-to-column col)
14624 (unless just-align
14625 (run-hooks 'org-after-tags-change-hook))))))
14627 (defun org-change-tag-in-region (beg end tag off)
14628 "Add or remove TAG for each entry in the region.
14629 This works in the agenda, and also in an org-mode buffer."
14630 (interactive
14631 (list (region-beginning) (region-end)
14632 (let ((org-last-tags-completion-table
14633 (if (derived-mode-p 'org-mode)
14634 (org-uniquify
14635 (delq nil (append (org-get-buffer-tags)
14636 (org-global-tags-completion-table))))
14637 (org-global-tags-completion-table))))
14638 (org-icompleting-read
14639 "Tag: " 'org-tags-completion-function nil nil nil
14640 'org-tags-history))
14641 (progn
14642 (message "[s]et or [r]emove? ")
14643 (equal (read-char-exclusive) ?r))))
14644 (if (fboundp 'deactivate-mark) (deactivate-mark))
14645 (let ((agendap (equal major-mode 'org-agenda-mode))
14646 l1 l2 m buf pos newhead (cnt 0))
14647 (goto-char end)
14648 (setq l2 (1- (org-current-line)))
14649 (goto-char beg)
14650 (setq l1 (org-current-line))
14651 (loop for l from l1 to l2 do
14652 (org-goto-line l)
14653 (setq m (get-text-property (point) 'org-hd-marker))
14654 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14655 (and agendap m))
14656 (setq buf (if agendap (marker-buffer m) (current-buffer))
14657 pos (if agendap m (point)))
14658 (with-current-buffer buf
14659 (save-excursion
14660 (save-restriction
14661 (goto-char pos)
14662 (setq cnt (1+ cnt))
14663 (org-toggle-tag tag (if off 'off 'on))
14664 (setq newhead (org-get-heading)))))
14665 (and agendap (org-agenda-change-all-lines newhead m))))
14666 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14668 (defun org-tags-completion-function (string predicate &optional flag)
14669 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14670 (confirm (lambda (x) (stringp (car x)))))
14671 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14672 (setq s1 (match-string 1 string)
14673 s2 (match-string 2 string))
14674 (setq s1 "" s2 string))
14675 (cond
14676 ((eq flag nil)
14677 ;; try completion
14678 (setq rtn (try-completion s2 ctable confirm))
14679 (if (stringp rtn)
14680 (setq rtn
14681 (concat s1 s2 (substring rtn (length s2))
14682 (if (and org-add-colon-after-tag-completion
14683 (assoc rtn ctable))
14684 ":" ""))))
14685 rtn)
14686 ((eq flag t)
14687 ;; all-completions
14688 (all-completions s2 ctable confirm))
14689 ((eq flag 'lambda)
14690 ;; exact match?
14691 (assoc s2 ctable)))))
14693 (defun org-fast-tag-insert (kwd tags face &optional end)
14694 "Insert KDW, and the TAGS, the latter with face FACE.
14695 Also insert END."
14696 (insert (format "%-12s" (concat kwd ":"))
14697 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14698 (or end "")))
14700 (defun org-fast-tag-show-exit (flag)
14701 (save-excursion
14702 (org-goto-line 3)
14703 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14704 (replace-match ""))
14705 (when flag
14706 (end-of-line 1)
14707 (org-move-to-column (- (window-width) 19) t)
14708 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14710 (defun org-set-current-tags-overlay (current prefix)
14711 "Add an overlay to CURRENT tag with PREFIX."
14712 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14713 (if (featurep 'xemacs)
14714 (org-overlay-display org-tags-overlay (concat prefix s)
14715 'secondary-selection)
14716 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14717 (org-overlay-display org-tags-overlay (concat prefix s)))))
14719 (defvar org-last-tag-selection-key nil)
14720 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14721 "Fast tag selection with single keys.
14722 CURRENT is the current list of tags in the headline, INHERITED is the
14723 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14724 possibly with grouping information. TODO-TABLE is a similar table with
14725 TODO keywords, should these have keys assigned to them.
14726 If the keys are nil, a-z are automatically assigned.
14727 Returns the new tags string, or nil to not change the current settings."
14728 (let* ((fulltable (append table todo-table))
14729 (maxlen (apply 'max (mapcar
14730 (lambda (x)
14731 (if (stringp (car x)) (string-width (car x)) 0))
14732 fulltable)))
14733 (buf (current-buffer))
14734 (expert (eq org-fast-tag-selection-single-key 'expert))
14735 (buffer-tags nil)
14736 (fwidth (+ maxlen 3 1 3))
14737 (ncol (/ (- (window-width) 4) fwidth))
14738 (i-face 'org-done)
14739 (c-face 'org-todo)
14740 tg cnt e c char c1 c2 ntable tbl rtn
14741 ov-start ov-end ov-prefix
14742 (exit-after-next org-fast-tag-selection-single-key)
14743 (done-keywords org-done-keywords)
14744 groups ingroup)
14745 (save-excursion
14746 (beginning-of-line 1)
14747 (if (looking-at
14748 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14749 (setq ov-start (match-beginning 1)
14750 ov-end (match-end 1)
14751 ov-prefix "")
14752 (setq ov-start (1- (point-at-eol))
14753 ov-end (1+ ov-start))
14754 (skip-chars-forward "^\n\r")
14755 (setq ov-prefix
14756 (concat
14757 (buffer-substring (1- (point)) (point))
14758 (if (> (current-column) org-tags-column)
14760 (make-string (- org-tags-column (current-column)) ?\ ))))))
14761 (move-overlay org-tags-overlay ov-start ov-end)
14762 (save-window-excursion
14763 (if expert
14764 (set-buffer (get-buffer-create " *Org tags*"))
14765 (delete-other-windows)
14766 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
14767 (org-switch-to-buffer-other-window " *Org tags*"))
14768 (erase-buffer)
14769 (org-set-local 'org-done-keywords done-keywords)
14770 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14771 (org-fast-tag-insert "Current" current c-face "\n\n")
14772 (org-fast-tag-show-exit exit-after-next)
14773 (org-set-current-tags-overlay current ov-prefix)
14774 (setq tbl fulltable char ?a cnt 0)
14775 (while (setq e (pop tbl))
14776 (cond
14777 ((equal (car e) :startgroup)
14778 (push '() groups) (setq ingroup t)
14779 (when (not (= cnt 0))
14780 (setq cnt 0)
14781 (insert "\n"))
14782 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14783 ((equal (car e) :endgroup)
14784 (setq ingroup nil cnt 0)
14785 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14786 ((equal e '(:newline))
14787 (when (not (= cnt 0))
14788 (setq cnt 0)
14789 (insert "\n")
14790 (setq e (car tbl))
14791 (while (equal (car tbl) '(:newline))
14792 (insert "\n")
14793 (setq tbl (cdr tbl)))))
14794 ((equal e '(:grouptags)) nil)
14796 (setq tg (copy-sequence (car e)) c2 nil)
14797 (if (cdr e)
14798 (setq c (cdr e))
14799 ;; automatically assign a character.
14800 (setq c1 (string-to-char
14801 (downcase (substring
14802 tg (if (= (string-to-char tg) ?@) 1 0)))))
14803 (if (or (rassoc c1 ntable) (rassoc c1 table))
14804 (while (or (rassoc char ntable) (rassoc char table))
14805 (setq char (1+ char)))
14806 (setq c2 c1))
14807 (setq c (or c2 char)))
14808 (if ingroup (push tg (car groups)))
14809 (setq tg (org-add-props tg nil 'face
14810 (cond
14811 ((not (assoc tg table))
14812 (org-get-todo-face tg))
14813 ((member tg current) c-face)
14814 ((member tg inherited) i-face))))
14815 (if (equal (caar tbl) :grouptags)
14816 (org-add-props tg nil 'face 'org-tag-group))
14817 (if (and (= cnt 0) (not ingroup)) (insert " "))
14818 (insert "[" c "] " tg (make-string
14819 (- fwidth 4 (length tg)) ?\ ))
14820 (push (cons tg c) ntable)
14821 (when (= (setq cnt (1+ cnt)) ncol)
14822 (insert "\n")
14823 (if ingroup (insert " "))
14824 (setq cnt 0)))))
14825 (setq ntable (nreverse ntable))
14826 (insert "\n")
14827 (goto-char (point-min))
14828 (if (not expert) (org-fit-window-to-buffer))
14829 (setq rtn
14830 (catch 'exit
14831 (while t
14832 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14833 (if (not groups) "no " "")
14834 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14835 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14836 (setq org-last-tag-selection-key c)
14837 (cond
14838 ((= c ?\r) (throw 'exit t))
14839 ((= c ?!)
14840 (setq groups (not groups))
14841 (goto-char (point-min))
14842 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14843 ((= c ?\C-c)
14844 (if (not expert)
14845 (org-fast-tag-show-exit
14846 (setq exit-after-next (not exit-after-next)))
14847 (setq expert nil)
14848 (delete-other-windows)
14849 (set-window-buffer (split-window-vertically) " *Org tags*")
14850 (org-switch-to-buffer-other-window " *Org tags*")
14851 (org-fit-window-to-buffer)))
14852 ((or (= c ?\C-g)
14853 (and (= c ?q) (not (rassoc c ntable))))
14854 (org-detach-overlay org-tags-overlay)
14855 (setq quit-flag t))
14856 ((= c ?\ )
14857 (setq current nil)
14858 (if exit-after-next (setq exit-after-next 'now)))
14859 ((= c ?\t)
14860 (condition-case nil
14861 (setq tg (org-icompleting-read
14862 "Tag: "
14863 (or buffer-tags
14864 (with-current-buffer buf
14865 (org-get-buffer-tags)))))
14866 (quit (setq tg "")))
14867 (when (string-match "\\S-" tg)
14868 (add-to-list 'buffer-tags (list tg))
14869 (if (member tg current)
14870 (setq current (delete tg current))
14871 (push tg current)))
14872 (if exit-after-next (setq exit-after-next 'now)))
14873 ((setq e (rassoc c todo-table) tg (car e))
14874 (with-current-buffer buf
14875 (save-excursion (org-todo tg)))
14876 (if exit-after-next (setq exit-after-next 'now)))
14877 ((setq e (rassoc c ntable) tg (car e))
14878 (if (member tg current)
14879 (setq current (delete tg current))
14880 (loop for g in groups do
14881 (if (member tg g)
14882 (mapc (lambda (x)
14883 (setq current (delete x current)))
14884 g)))
14885 (push tg current))
14886 (if exit-after-next (setq exit-after-next 'now))))
14888 ;; Create a sorted list
14889 (setq current
14890 (sort current
14891 (lambda (a b)
14892 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14893 (if (eq exit-after-next 'now) (throw 'exit t))
14894 (goto-char (point-min))
14895 (beginning-of-line 2)
14896 (delete-region (point) (point-at-eol))
14897 (org-fast-tag-insert "Current" current c-face)
14898 (org-set-current-tags-overlay current ov-prefix)
14899 (while (re-search-forward
14900 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14901 (setq tg (match-string 1))
14902 (add-text-properties
14903 (match-beginning 1) (match-end 1)
14904 (list 'face
14905 (cond
14906 ((member tg current) c-face)
14907 ((member tg inherited) i-face)
14908 (t (get-text-property (match-beginning 1) 'face))))))
14909 (goto-char (point-min)))))
14910 (org-detach-overlay org-tags-overlay)
14911 (if rtn
14912 (mapconcat 'identity current ":")
14913 nil))))
14915 (defun org-get-tags-string ()
14916 "Get the TAGS string in the current headline."
14917 (unless (org-at-heading-p t)
14918 (user-error "Not on a heading"))
14919 (save-excursion
14920 (beginning-of-line 1)
14921 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14922 (org-match-string-no-properties 1)
14923 "")))
14925 (defun org-get-tags ()
14926 "Get the list of tags specified in the current headline."
14927 (org-split-string (org-get-tags-string) ":"))
14929 (defun org-get-buffer-tags ()
14930 "Get a table of all tags used in the buffer, for completion."
14931 (let (tags)
14932 (save-excursion
14933 (goto-char (point-min))
14934 (while (re-search-forward
14935 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
14936 (when (equal (char-after (point-at-bol 0)) ?*)
14937 (mapc (lambda (x) (add-to-list 'tags x))
14938 (org-split-string (org-match-string-no-properties 1) ":")))))
14939 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14940 (mapcar 'list tags)))
14942 ;;;; The mapping API
14944 (defun org-map-entries (func &optional match scope &rest skip)
14945 "Call FUNC at each headline selected by MATCH in SCOPE.
14947 FUNC is a function or a lisp form. The function will be called without
14948 arguments, with the cursor positioned at the beginning of the headline.
14949 The return values of all calls to the function will be collected and
14950 returned as a list.
14952 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14953 does not need to preserve point. After evaluation, the cursor will be
14954 moved to the end of the line (presumably of the headline of the
14955 processed entry) and search continues from there. Under some
14956 circumstances, this may not produce the wanted results. For example,
14957 if you have removed (e.g. archived) the current (sub)tree it could
14958 mean that the next entry will be skipped entirely. In such cases, you
14959 can specify the position from where search should continue by making
14960 FUNC set the variable `org-map-continue-from' to the desired buffer
14961 position.
14963 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14964 Only headlines that are matched by this query will be considered during
14965 the iteration. When MATCH is nil or t, all headlines will be
14966 visited by the iteration.
14968 SCOPE determines the scope of this command. It can be any of:
14970 nil The current buffer, respecting the restriction if any
14971 tree The subtree started with the entry at point
14972 region The entries within the active region, if any
14973 region-start-level
14974 The entries within the active region, but only those at
14975 the same level than the first one.
14976 file The current buffer, without restriction
14977 file-with-archives
14978 The current buffer, and any archives associated with it
14979 agenda All agenda files
14980 agenda-with-archives
14981 All agenda files with any archive files associated with them
14982 \(file1 file2 ...)
14983 If this is a list, all files in the list will be scanned
14985 The remaining args are treated as settings for the skipping facilities of
14986 the scanner. The following items can be given here:
14988 archive skip trees with the archive tag
14989 comment skip trees with the COMMENT keyword
14990 function or Emacs Lisp form:
14991 will be used as value for `org-agenda-skip-function', so
14992 whenever the function returns a position, FUNC will not be
14993 called for that entry and search will continue from the
14994 position returned
14996 If your function needs to retrieve the tags including inherited tags
14997 at the *current* entry, you can use the value of the variable
14998 `org-scanner-tags' which will be much faster than getting the value
14999 with `org-get-tags-at'. If your function gets properties with
15000 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15001 to t around the call to `org-entry-properties' to get the same speedup.
15002 Note that if your function moves around to retrieve tags and properties at
15003 a *different* entry, you cannot use these techniques."
15004 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15005 (not (org-region-active-p)))
15006 (let* ((org-agenda-archives-mode nil) ; just to make sure
15007 (org-agenda-skip-archived-trees (memq 'archive skip))
15008 (org-agenda-skip-comment-trees (memq 'comment skip))
15009 (org-agenda-skip-function
15010 (car (org-delete-all '(comment archive) skip)))
15011 (org-tags-match-list-sublevels t)
15012 (start-level (eq scope 'region-start-level))
15013 matcher file res
15014 org-todo-keywords-for-agenda
15015 org-done-keywords-for-agenda
15016 org-todo-keyword-alist-for-agenda
15017 org-drawers-for-agenda
15018 org-tag-alist-for-agenda
15019 todo-only)
15021 (cond
15022 ((eq match t) (setq matcher t))
15023 ((eq match nil) (setq matcher t))
15024 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15026 (save-excursion
15027 (save-restriction
15028 (cond ((eq scope 'tree)
15029 (org-back-to-heading t)
15030 (org-narrow-to-subtree)
15031 (setq scope nil))
15032 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15033 (org-region-active-p))
15034 ;; If needed, set start-level to a string like "2"
15035 (when start-level
15036 (save-excursion
15037 (goto-char (region-beginning))
15038 (unless (org-at-heading-p) (outline-next-heading))
15039 (setq start-level (org-current-level))))
15040 (narrow-to-region (region-beginning)
15041 (save-excursion
15042 (goto-char (region-end))
15043 (unless (and (bolp) (org-at-heading-p))
15044 (outline-next-heading))
15045 (point)))
15046 (setq scope nil)))
15048 (if (not scope)
15049 (progn
15050 (org-agenda-prepare-buffers
15051 (list (buffer-file-name (current-buffer))))
15052 (setq res (org-scan-tags func matcher todo-only start-level)))
15053 ;; Get the right scope
15054 (cond
15055 ((and scope (listp scope) (symbolp (car scope)))
15056 (setq scope (eval scope)))
15057 ((eq scope 'agenda)
15058 (setq scope (org-agenda-files t)))
15059 ((eq scope 'agenda-with-archives)
15060 (setq scope (org-agenda-files t))
15061 (setq scope (org-add-archive-files scope)))
15062 ((eq scope 'file)
15063 (setq scope (list (buffer-file-name))))
15064 ((eq scope 'file-with-archives)
15065 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15066 (org-agenda-prepare-buffers scope)
15067 (while (setq file (pop scope))
15068 (with-current-buffer (org-find-base-buffer-visiting file)
15069 (save-excursion
15070 (save-restriction
15071 (widen)
15072 (goto-char (point-min))
15073 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15074 res)))
15076 ;;;; Properties
15078 ;;; Setting and retrieving properties
15080 (defconst org-special-properties
15081 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15082 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15083 "The special properties valid in Org-mode.
15085 These are properties that are not defined in the property drawer,
15086 but in some other way.")
15088 (defconst org-default-properties
15089 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15090 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15091 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15092 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15093 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15094 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15095 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15096 "Some properties that are used by Org-mode for various purposes.
15097 Being in this list makes sure that they are offered for completion.")
15099 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
15100 "Regular expression matching the first line of a property drawer.")
15102 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
15103 "Regular expression matching the last line of a property drawer.")
15105 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
15106 "Regular expression matching the first line of a property drawer.")
15108 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
15109 "Regular expression matching the first line of a property drawer.")
15111 (defconst org-property-drawer-re
15112 (concat "\\(" org-property-start-re "\\)[^\000]*\\("
15113 org-property-end-re "\\)\n?")
15114 "Matches an entire property drawer.")
15116 (defconst org-clock-drawer-re
15117 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
15118 org-property-end-re "\\)\n?")
15119 "Matches an entire clock drawer.")
15121 (defun org-property-action ()
15122 "Do an action on properties."
15123 (interactive)
15124 (let (c)
15125 (org-at-property-p)
15126 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15127 (setq c (read-char-exclusive))
15128 (cond
15129 ((equal c ?s)
15130 (call-interactively 'org-set-property))
15131 ((equal c ?d)
15132 (call-interactively 'org-delete-property))
15133 ((equal c ?D)
15134 (call-interactively 'org-delete-property-globally))
15135 ((equal c ?c)
15136 (call-interactively 'org-compute-property-at-point))
15137 (t (user-error "No such property action %c" c)))))
15139 (defun org-inc-effort ()
15140 "Increment the value of the effort property in the current entry."
15141 (interactive)
15142 (org-set-effort nil t))
15144 (defvar org-clock-effort) ;; Defined in org-clock.el
15145 (defvar org-clock-current-task) ;; Defined in org-clock.el
15146 (defun org-set-effort (&optional value increment)
15147 "Set the effort property of the current entry.
15148 With numerical prefix arg, use the nth allowed value, 0 stands for the
15149 10th allowed value.
15151 When INCREMENT is non-nil, set the property to the next allowed value."
15152 (interactive "P")
15153 (if (equal value 0) (setq value 10))
15154 (let* ((completion-ignore-case t)
15155 (prop org-effort-property)
15156 (cur (org-entry-get nil prop))
15157 (allowed (org-property-get-allowed-values nil prop 'table))
15158 (existing (mapcar 'list (org-property-values prop)))
15159 (heading (nth 4 (org-heading-components)))
15161 (val (cond
15162 ((stringp value) value)
15163 ((and allowed (integerp value))
15164 (or (car (nth (1- value) allowed))
15165 (car (org-last allowed))))
15166 ((and allowed increment)
15167 (or (caadr (member (list cur) allowed))
15168 (user-error "Allowed effort values are not set")))
15169 (allowed
15170 (message "Select 1-9,0, [RET%s]: %s"
15171 (if cur (concat "=" cur) "")
15172 (mapconcat 'car allowed " "))
15173 (setq rpl (read-char-exclusive))
15174 (if (equal rpl ?\r)
15176 (setq rpl (- rpl ?0))
15177 (if (equal rpl 0) (setq rpl 10))
15178 (if (and (> rpl 0) (<= rpl (length allowed)))
15179 (car (nth (1- rpl) allowed))
15180 (org-completing-read "Effort: " allowed nil))))
15182 (let (org-completion-use-ido org-completion-use-iswitchb)
15183 (org-completing-read
15184 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15185 (concat "[" cur "]") "")
15186 ": ")
15187 existing nil nil "" nil cur))))))
15188 (unless (equal (org-entry-get nil prop) val)
15189 (org-entry-put nil prop val))
15190 (save-excursion
15191 (org-back-to-heading t)
15192 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15193 (when (string= heading org-clock-current-task)
15194 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15195 (org-clock-update-mode-line))
15196 (message "%s is now %s" prop val)))
15198 (defun org-at-property-p ()
15199 "Is cursor inside a property drawer?"
15200 (save-excursion
15201 (when (equal 'node-property (car (org-element-at-point)))
15202 (beginning-of-line 1)
15203 (looking-at org-property-re))))
15205 (defun org-get-property-block (&optional beg end force)
15206 "Return the (beg . end) range of the body of the property drawer.
15207 BEG and END are the beginning and end of the current subtree, or of
15208 the part before the first headline. If they are not given, they will
15209 be found. If the drawer does not exist and FORCE is non-nil, create
15210 the drawer."
15211 (catch 'exit
15212 (save-excursion
15213 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15214 (progn (org-back-to-heading t) (point))))
15215 (end (or end (and (not (outline-next-heading)) (point-max))
15216 (point))))
15217 (goto-char beg)
15218 (if (re-search-forward org-property-start-re end t)
15219 (setq beg (1+ (match-end 0)))
15220 (if force
15221 (save-excursion
15222 (org-insert-property-drawer)
15223 (setq end (progn (outline-next-heading) (point))))
15224 (throw 'exit nil))
15225 (goto-char beg)
15226 (if (re-search-forward org-property-start-re end t)
15227 (setq beg (1+ (match-end 0)))))
15228 (if (re-search-forward org-property-end-re end t)
15229 (setq end (match-beginning 0))
15230 (or force (throw 'exit nil))
15231 (goto-char beg)
15232 (setq end beg)
15233 (org-indent-line)
15234 (insert ":END:\n"))
15235 (cons beg end)))))
15237 (defun org-entry-properties (&optional pom which specific)
15238 "Get all properties of the entry at point-or-marker POM.
15239 This includes the TODO keyword, the tags, time strings for deadline,
15240 scheduled, and clocking, and any additional properties defined in the
15241 entry. The return value is an alist, keys may occur multiple times
15242 if the property key was used several times.
15243 POM may also be nil, in which case the current entry is used.
15244 If WHICH is nil or `all', get all properties. If WHICH is
15245 `special' or `standard', only get that subclass. If WHICH
15246 is a string only get exactly this property. SPECIFIC can be a string, the
15247 specific property we are interested in. Specifying it can speed
15248 things up because then unnecessary parsing is avoided."
15249 (setq which (or which 'all))
15250 (org-with-wide-buffer
15251 (org-with-point-at pom
15252 (let ((clockstr (substring org-clock-string 0 -1))
15253 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15254 (case-fold-search nil)
15255 beg end range props sum-props key key1 value string clocksum clocksumt)
15256 (when (and (derived-mode-p 'org-mode)
15257 (ignore-errors (org-back-to-heading t)))
15258 (setq beg (point))
15259 (setq sum-props (get-text-property (point) 'org-summaries))
15260 (setq clocksum (get-text-property (point) :org-clock-minutes)
15261 clocksumt (get-text-property (point) :org-clock-minutes-today))
15262 (outline-next-heading)
15263 (setq end (point))
15264 (when (memq which '(all special))
15265 ;; Get the special properties, like TODO and tags
15266 (goto-char beg)
15267 (when (and (or (not specific) (string= specific "TODO"))
15268 (looking-at org-todo-line-regexp) (match-end 2))
15269 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15270 (when (and (or (not specific) (string= specific "PRIORITY"))
15271 (looking-at org-priority-regexp))
15272 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15273 (when (or (not specific) (string= specific "FILE"))
15274 (push (cons "FILE" buffer-file-name) props))
15275 (when (and (or (not specific) (string= specific "TAGS"))
15276 (setq value (org-get-tags-string))
15277 (string-match "\\S-" value))
15278 (push (cons "TAGS" value) props))
15279 (when (and (or (not specific) (string= specific "ALLTAGS"))
15280 (setq value (org-get-tags-at)))
15281 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15282 ":"))
15283 props))
15284 (when (or (not specific) (string= specific "BLOCKED"))
15285 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15286 (when (or (not specific)
15287 (member specific
15288 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15289 "TIMESTAMP" "TIMESTAMP_IA")))
15290 (catch 'match
15291 (while (and (re-search-forward org-maybe-keyword-time-regexp end t)
15292 (not (text-property-any 0 (length (match-string 0))
15293 'face 'font-lock-comment-face
15294 (match-string 0))))
15295 (setq key (if (match-end 1)
15296 (substring (org-match-string-no-properties 1)
15297 0 -1))
15298 string (if (equal key clockstr)
15299 (org-trim
15300 (buffer-substring-no-properties
15301 (match-beginning 3) (goto-char
15302 (point-at-eol))))
15303 (substring (org-match-string-no-properties 3)
15304 1 -1)))
15305 ;; Get the correct property name from the key. This is
15306 ;; necessary if the user has configured time keywords.
15307 (setq key1 (concat key ":"))
15308 (cond
15309 ((not key)
15310 (setq key
15311 (if (= (char-after (match-beginning 3)) ?\[)
15312 "TIMESTAMP_IA" "TIMESTAMP")))
15313 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15314 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15315 ((equal key1 org-closed-string) (setq key "CLOSED"))
15316 ((equal key1 org-clock-string) (setq key "CLOCK")))
15317 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15318 (progn
15319 (push (cons key string) props)
15320 ;; no need to search further if match is found
15321 (throw 'match t))
15322 (when (or (equal key "CLOCK") (not (assoc key props)))
15323 (push (cons key string) props)))))))
15325 (when (memq which '(all standard))
15326 ;; Get the standard properties, like :PROP: ...
15327 (setq range (org-get-property-block beg end))
15328 (when range
15329 (goto-char (car range))
15330 (while (re-search-forward org-property-re
15331 (cdr range) t)
15332 (setq key (org-match-string-no-properties 2)
15333 value (org-trim (or (org-match-string-no-properties 3) "")))
15334 (unless (member key excluded)
15335 (push (cons key (or value "")) props)))))
15336 (if clocksum
15337 (push (cons "CLOCKSUM"
15338 (org-columns-number-to-string (/ (float clocksum) 60.)
15339 'add_times))
15340 props))
15341 (if clocksumt
15342 (push (cons "CLOCKSUM_T"
15343 (org-columns-number-to-string (/ (float clocksumt) 60.)
15344 'add_times))
15345 props))
15346 (unless (assoc "CATEGORY" props)
15347 (push (cons "CATEGORY" (org-get-category)) props))
15348 (append sum-props (nreverse props)))))))
15350 (defun org-entry-get (pom property &optional inherit literal-nil)
15351 "Get value of PROPERTY for entry or content at point-or-marker POM.
15352 If INHERIT is non-nil and the entry does not have the property,
15353 then also check higher levels of the hierarchy.
15354 If INHERIT is the symbol `selective', use inheritance only if the setting
15355 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15356 If the property is present but empty, the return value is the empty string.
15357 If the property is not present at all, nil is returned.
15359 Return the value as a string.
15361 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15362 do not interpret it as the list atom nil. This is used for inheritance
15363 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15364 (org-with-point-at pom
15365 (if (and inherit (if (eq inherit 'selective)
15366 (org-property-inherit-p property)
15368 (org-entry-get-with-inheritance property literal-nil)
15369 (if (member property org-special-properties)
15370 ;; We need a special property. Use `org-entry-properties'
15371 ;; to retrieve it, but specify the wanted property
15372 (cdr (assoc property (org-entry-properties nil 'special property)))
15373 (org-with-wide-buffer
15374 (let ((range (org-get-property-block)))
15375 (when (and range (not (eq (car range) (cdr range)))
15376 (save-excursion
15377 (goto-char (car range))
15378 (re-search-forward
15379 (concat (org-re-property property) "\\|"
15380 (org-re-property (concat property "+")))
15381 (cdr range) t)))
15382 (let* ((props
15383 (list (or (assoc property org-file-properties)
15384 (assoc property org-global-properties)
15385 (assoc property org-global-properties-fixed))))
15386 (ap (lambda (key)
15387 (when (re-search-forward
15388 (org-re-property key) (cdr range) t)
15389 (setq props
15390 (org-update-property-plist
15392 (if (match-end 3)
15393 (org-match-string-no-properties 3) "")
15394 props)))))
15395 val)
15396 (goto-char (car range))
15397 (funcall ap property)
15398 (goto-char (car range))
15399 (while (funcall ap (concat property "+")))
15400 (setq val (cdr (assoc property props)))
15401 (when val (if literal-nil val (org-not-nil val)))))))))))
15403 (defun org-property-or-variable-value (var &optional inherit)
15404 "Check if there is a property fixing the value of VAR.
15405 If yes, return this value. If not, return the current value of the variable."
15406 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15407 (if (and prop (stringp prop) (string-match "\\S-" prop))
15408 (read prop)
15409 (symbol-value var))))
15411 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15412 "Delete the property PROPERTY from entry at point-or-marker POM.
15413 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15414 an empty drawer to delete."
15415 (org-with-point-at pom
15416 (if (member property org-special-properties)
15417 nil ; cannot delete these properties.
15418 (let ((range (org-get-property-block)))
15419 (if (and range
15420 (goto-char (car range))
15421 (re-search-forward
15422 (org-re-property property nil t)
15423 (cdr range) t))
15424 (progn
15425 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15426 (and delete-empty-drawer
15427 (org-remove-empty-drawer-at
15428 delete-empty-drawer (car range)))
15430 nil)))))
15432 ;; Multi-values properties are properties that contain multiple values
15433 ;; These values are assumed to be single words, separated by whitespace.
15434 (defun org-entry-add-to-multivalued-property (pom property value)
15435 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15436 (let* ((old (org-entry-get pom property))
15437 (values (and old (org-split-string old "[ \t]"))))
15438 (setq value (org-entry-protect-space value))
15439 (unless (member value values)
15440 (setq values (append values (list value)))
15441 (org-entry-put pom property
15442 (mapconcat 'identity values " ")))))
15444 (defun org-entry-remove-from-multivalued-property (pom property value)
15445 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15446 (let* ((old (org-entry-get pom property))
15447 (values (and old (org-split-string old "[ \t]"))))
15448 (setq value (org-entry-protect-space value))
15449 (when (member value values)
15450 (setq values (delete value values))
15451 (org-entry-put pom property
15452 (mapconcat 'identity values " ")))))
15454 (defun org-entry-member-in-multivalued-property (pom property value)
15455 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15456 (let* ((old (org-entry-get pom property))
15457 (values (and old (org-split-string old "[ \t]"))))
15458 (setq value (org-entry-protect-space value))
15459 (member value values)))
15461 (defun org-entry-get-multivalued-property (pom property)
15462 "Return a list of values in a multivalued property."
15463 (let* ((value (org-entry-get pom property))
15464 (values (and value (org-split-string value "[ \t]"))))
15465 (mapcar 'org-entry-restore-space values)))
15467 (defun org-entry-put-multivalued-property (pom property &rest values)
15468 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15469 VALUES should be a list of strings. Spaces will be protected."
15470 (org-entry-put pom property
15471 (mapconcat 'org-entry-protect-space values " "))
15472 (let* ((value (org-entry-get pom property))
15473 (values (and value (org-split-string value "[ \t]"))))
15474 (mapcar 'org-entry-restore-space values)))
15476 (defun org-entry-protect-space (s)
15477 "Protect spaces and newline in string S."
15478 (while (string-match " " s)
15479 (setq s (replace-match "%20" t t s)))
15480 (while (string-match "\n" s)
15481 (setq s (replace-match "%0A" t t s)))
15484 (defun org-entry-restore-space (s)
15485 "Restore spaces and newline in string S."
15486 (while (string-match "%20" s)
15487 (setq s (replace-match " " t t s)))
15488 (while (string-match "%0A" s)
15489 (setq s (replace-match "\n" t t s)))
15492 (defvar org-entry-property-inherited-from (make-marker)
15493 "Marker pointing to the entry from where a property was inherited.
15494 Each call to `org-entry-get-with-inheritance' will set this marker to the
15495 location of the entry where the inheritance search matched. If there was
15496 no match, the marker will point nowhere.
15497 Note that also `org-entry-get' calls this function, if the INHERIT flag
15498 is set.")
15500 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15501 "Get PROPERTY of entry or content at point, search higher levels if needed.
15502 The search will stop at the first ancestor which has the property defined.
15503 If the value found is \"nil\", return nil to show that the property
15504 should be considered as undefined (this is the meaning of nil here).
15505 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15506 (move-marker org-entry-property-inherited-from nil)
15507 (let (tmp)
15508 (save-excursion
15509 (save-restriction
15510 (widen)
15511 (catch 'ex
15512 (while t
15513 (when (setq tmp (org-entry-get nil property nil literal-nil))
15514 (or (ignore-errors (org-back-to-heading t))
15515 (goto-char (point-min)))
15516 (move-marker org-entry-property-inherited-from (point))
15517 (throw 'ex tmp))
15518 (or (ignore-errors (org-up-heading-safe))
15519 (throw 'ex nil))))))
15520 (setq tmp (or tmp
15521 (cdr (assoc property org-file-properties))
15522 (cdr (assoc property org-global-properties))
15523 (cdr (assoc property org-global-properties-fixed))))
15524 (if literal-nil tmp (org-not-nil tmp))))
15526 (defvar org-property-changed-functions nil
15527 "Hook called when the value of a property has changed.
15528 Each hook function should accept two arguments, the name of the property
15529 and the new value.")
15531 (defun org-entry-put (pom property value)
15532 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15533 If the value is `nil', it is converted to the empty string.
15534 If it is not a string, an error is raised."
15535 (cond ((null value) (setq value ""))
15536 ((not (stringp value))
15537 (error "Properties values should be strings.")))
15538 (org-with-point-at pom
15539 (org-back-to-heading t)
15540 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15541 range)
15542 (cond
15543 ((equal property "TODO")
15544 (when (and (string-match "\\S-" value)
15545 (not (member value org-todo-keywords-1)))
15546 (user-error "\"%s\" is not a valid TODO state" value))
15547 (if (or (not value)
15548 (not (string-match "\\S-" value)))
15549 (setq value 'none))
15550 (org-todo value)
15551 (org-set-tags nil 'align))
15552 ((equal property "PRIORITY")
15553 (org-priority (if (and value (string-match "\\S-" value))
15554 (string-to-char value) ?\ ))
15555 (org-set-tags nil 'align))
15556 ((equal property "CLOCKSUM")
15557 (if (not (re-search-forward
15558 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15559 (error "Cannot find a clock log")
15560 (goto-char (- (match-end 1) 2))
15561 (cond
15562 ((eq value 'earlier) (org-timestamp-down))
15563 ((eq value 'later) (org-timestamp-up)))
15564 (org-clock-sum-current-item)))
15565 ((equal property "SCHEDULED")
15566 (if (re-search-forward org-scheduled-time-regexp end t)
15567 (cond
15568 ((eq value 'earlier) (org-timestamp-change -1 'day))
15569 ((eq value 'later) (org-timestamp-change 1 'day))
15570 (t (call-interactively 'org-schedule)))
15571 (call-interactively 'org-schedule)))
15572 ((equal property "DEADLINE")
15573 (if (re-search-forward org-deadline-time-regexp end t)
15574 (cond
15575 ((eq value 'earlier) (org-timestamp-change -1 'day))
15576 ((eq value 'later) (org-timestamp-change 1 'day))
15577 (t (call-interactively 'org-deadline)))
15578 (call-interactively 'org-deadline)))
15579 ((member property org-special-properties)
15580 (error "The %s property can not yet be set with `org-entry-put'"
15581 property))
15582 (t ; a non-special property
15583 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15584 (setq range (org-get-property-block beg end 'force))
15585 (goto-char (car range))
15586 (if (re-search-forward
15587 (org-re-property property nil t) (cdr range) t)
15588 (progn
15589 (delete-region (match-beginning 0) (match-end 0))
15590 (goto-char (match-beginning 0)))
15591 (goto-char (cdr range))
15592 (insert "\n")
15593 (backward-char 1)
15594 (org-indent-line))
15595 (insert ":" property ":")
15596 (and value (insert " " value))
15597 (org-indent-line)))))
15598 (run-hook-with-args 'org-property-changed-functions property value)))
15600 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15601 "Get all property keys in the current buffer.
15602 With INCLUDE-SPECIALS, also list the special properties that reflect things
15603 like tags and TODO state.
15604 With INCLUDE-DEFAULTS, also include properties that has special meaning
15605 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15606 and others.
15607 With INCLUDE-COLUMNS, also include property names given in COLUMN
15608 formats in the current buffer."
15609 (let (rtn range cfmt s p)
15610 (save-excursion
15611 (save-restriction
15612 (widen)
15613 (goto-char (point-min))
15614 (while (re-search-forward org-property-start-re nil t)
15615 (setq range (org-get-property-block))
15616 (goto-char (car range))
15617 (while (re-search-forward org-property-re
15618 (cdr range) t)
15619 (add-to-list 'rtn (org-match-string-no-properties 2)))
15620 (outline-next-heading))))
15622 (when include-specials
15623 (setq rtn (append org-special-properties rtn)))
15625 (when include-defaults
15626 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15627 (add-to-list 'rtn org-effort-property))
15629 (when include-columns
15630 (save-excursion
15631 (save-restriction
15632 (widen)
15633 (goto-char (point-min))
15634 (while (re-search-forward
15635 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15636 nil t)
15637 (setq cfmt (match-string 2) s 0)
15638 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15639 cfmt s)
15640 (setq s (match-end 0)
15641 p (match-string 1 cfmt))
15642 (unless (or (equal p "ITEM")
15643 (member p org-special-properties))
15644 (add-to-list 'rtn (match-string 1 cfmt))))))))
15646 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15648 (defun org-property-values (key)
15649 "Return a list of all values of property KEY in the current buffer."
15650 (save-excursion
15651 (save-restriction
15652 (widen)
15653 (goto-char (point-min))
15654 (let ((re (org-re-property key))
15655 values)
15656 (while (re-search-forward re nil t)
15657 (add-to-list 'values (org-trim (match-string 3))))
15658 (delete "" values)))))
15660 (defun org-insert-property-drawer ()
15661 "Insert a property drawer into the current entry."
15662 (org-back-to-heading t)
15663 (looking-at org-outline-regexp)
15664 (let ((indent (if org-adapt-indentation
15665 (- (match-end 0) (match-beginning 0))
15667 (beg (point))
15668 (re (concat "^[ \t]*" org-keyword-time-regexp))
15669 end hiddenp)
15670 (outline-next-heading)
15671 (setq end (point))
15672 (goto-char beg)
15673 (while (re-search-forward re end t))
15674 (setq hiddenp (outline-invisible-p))
15675 (end-of-line 1)
15676 (and (equal (char-after) ?\n) (forward-char 1))
15677 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15678 (if (member (match-string 1) '("CLOCK:" ":END:"))
15679 ;; just skip this line
15680 (beginning-of-line 2)
15681 ;; Drawer start, find the end
15682 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15683 (beginning-of-line 1)))
15684 (org-skip-over-state-notes)
15685 (skip-chars-backward " \t\n\r")
15686 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15687 (forward-char 1))
15688 (goto-char (point-at-eol))
15689 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15690 (beginning-of-line 0)
15691 (org-indent-to-column indent)
15692 (beginning-of-line 2)
15693 (org-indent-to-column indent)
15694 (beginning-of-line 0)
15695 (if hiddenp
15696 (save-excursion
15697 (org-back-to-heading t)
15698 (hide-entry))
15699 (org-flag-drawer t))))
15701 (defun org-insert-drawer (&optional arg drawer)
15702 "Insert a drawer at point.
15704 Optional argument DRAWER, when non-nil, is a string representing
15705 drawer's name. Otherwise, the user is prompted for a name.
15707 If a region is active, insert the drawer around that region
15708 instead.
15710 Point is left between drawer's boundaries."
15711 (interactive "P")
15712 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15713 "LOGBOOK"))
15714 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15715 ;; internally by Org. They are meant to be inserted
15716 ;; automatically.
15717 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15718 ;; Remove system drawers from list. Note: For some reason,
15719 ;; `org-completing-read' ignores the predicate while
15720 ;; `completing-read' handles it fine.
15721 (drawer (if arg "PROPERTIES"
15722 (or drawer
15723 (completing-read
15724 "Drawer: " org-drawers
15725 (lambda (d) (not (member d system-drawers))))))))
15726 (cond
15727 ;; With C-u, fall back on `org-insert-property-drawer'
15728 (arg (org-insert-property-drawer))
15729 ;; With an active region, insert a drawer at point.
15730 ((not (org-region-active-p))
15731 (progn
15732 (unless (bolp) (insert "\n"))
15733 (insert (format ":%s:\n\n:END:\n" drawer))
15734 (forward-line -2)))
15735 ;; Otherwise, insert the drawer at point
15737 (let ((rbeg (region-beginning))
15738 (rend (copy-marker (region-end))))
15739 (unwind-protect
15740 (progn
15741 (goto-char rbeg)
15742 (beginning-of-line)
15743 (when (save-excursion
15744 (re-search-forward org-outline-regexp-bol rend t))
15745 (user-error "Drawers cannot contain headlines"))
15746 ;; Position point at the beginning of the first
15747 ;; non-blank line in region. Insert drawer's opening
15748 ;; there, then indent it.
15749 (org-skip-whitespace)
15750 (beginning-of-line)
15751 (insert ":" drawer ":\n")
15752 (forward-line -1)
15753 (indent-for-tab-command)
15754 ;; Move point to the beginning of the first blank line
15755 ;; after the last non-blank line in region. Insert
15756 ;; drawer's closing, then indent it.
15757 (goto-char rend)
15758 (skip-chars-backward " \r\t\n")
15759 (insert "\n:END:")
15760 (deactivate-mark t)
15761 (indent-for-tab-command)
15762 (unless (eolp) (insert "\n")))
15763 ;; Clear marker, whatever the outcome of insertion is.
15764 (set-marker rend nil)))))))
15766 (defvar org-property-set-functions-alist nil
15767 "Property set function alist.
15768 Each entry should have the following format:
15770 (PROPERTY . READ-FUNCTION)
15772 The read function will be called with the same argument as
15773 `org-completing-read'.")
15775 (defun org-set-property-function (property)
15776 "Get the function that should be used to set PROPERTY.
15777 This is computed according to `org-property-set-functions-alist'."
15778 (or (cdr (assoc property org-property-set-functions-alist))
15779 'org-completing-read))
15781 (defun org-read-property-value (property)
15782 "Read PROPERTY value from user."
15783 (let* ((completion-ignore-case t)
15784 (allowed (org-property-get-allowed-values nil property 'table))
15785 (cur (org-entry-get nil property))
15786 (prompt (concat property " value"
15787 (if (and cur (string-match "\\S-" cur))
15788 (concat " [" cur "]") "") ": "))
15789 (set-function (org-set-property-function property))
15790 (val (if allowed
15791 (funcall set-function prompt allowed nil
15792 (not (get-text-property 0 'org-unrestricted
15793 (caar allowed))))
15794 (let (org-completion-use-ido org-completion-use-iswitchb)
15795 (funcall set-function prompt
15796 (mapcar 'list (org-property-values property))
15797 nil nil "" nil cur)))))
15798 (org-trim val)))
15800 (defvar org-last-set-property nil)
15801 (defvar org-last-set-property-value nil)
15802 (defun org-read-property-name ()
15803 "Read a property name."
15804 (let* ((completion-ignore-case t)
15805 (keys (org-buffer-property-keys nil t t))
15806 (default-prop (or (save-excursion
15807 (save-match-data
15808 (beginning-of-line)
15809 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15810 (null (string= (match-string 1) "END"))
15811 (match-string 1))))
15812 org-last-set-property))
15813 (property (org-icompleting-read
15814 (concat "Property"
15815 (if default-prop (concat " [" default-prop "]") "")
15816 ": ")
15817 (mapcar 'list keys)
15818 nil nil nil nil
15819 default-prop)))
15820 (if (member property keys)
15821 property
15822 (or (cdr (assoc (downcase property)
15823 (mapcar (lambda (x) (cons (downcase x) x))
15824 keys)))
15825 property))))
15827 (defun org-set-property-and-value (use-last)
15828 "Allow to set [PROPERTY]: [value] direction from prompt.
15829 When use-default, don't even ask, just use the last
15830 \"[PROPERTY]: [value]\" string from the history."
15831 (interactive "P")
15832 (let* ((completion-ignore-case t)
15833 (pv (or (and use-last org-last-set-property-value)
15834 (org-completing-read
15835 "Enter a \"[Property]: [value]\" pair: "
15836 nil nil nil nil nil
15837 org-last-set-property-value)))
15838 prop val)
15839 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15840 (setq prop (match-string 1 pv)
15841 val (match-string 2 pv))
15842 (org-set-property prop val))))
15844 (defun org-set-property (property value)
15845 "In the current entry, set PROPERTY to VALUE.
15846 When called interactively, this will prompt for a property name, offering
15847 completion on existing and default properties. And then it will prompt
15848 for a value, offering completion either on allowed values (via an inherited
15849 xxx_ALL property) or on existing values in other instances of this property
15850 in the current file."
15851 (interactive (list nil nil))
15852 (let* ((property (or property (org-read-property-name)))
15853 (value (or value (org-read-property-value property)))
15854 (fn (cdr (assoc property org-properties-postprocess-alist))))
15855 (setq org-last-set-property property)
15856 (setq org-last-set-property-value (concat property ": " value))
15857 ;; Possibly postprocess the inserted value:
15858 (when fn (setq value (funcall fn value)))
15859 (unless (equal (org-entry-get nil property) value)
15860 (org-entry-put nil property value))))
15862 (defun org-delete-property (property &optional delete-empty-drawer)
15863 "In the current entry, delete PROPERTY.
15864 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15865 an empty drawer to delete."
15866 (interactive
15867 (let* ((completion-ignore-case t)
15868 (cat (org-entry-get (point) "CATEGORY"))
15869 (props0 (org-entry-properties nil 'standard))
15870 (props (if cat props0
15871 (delete `("CATEGORY" . ,(org-get-category)) props0)))
15872 (prop (if (< 1 (length props))
15873 (org-icompleting-read "Property: " props nil t)
15874 (caar props))))
15875 (list prop)))
15876 (if (not property)
15877 (message "No property to delete in this entry")
15878 (org-entry-delete nil property delete-empty-drawer)
15879 (message "Property \"%s\" deleted" property)))
15881 (defun org-delete-property-globally (property)
15882 "Remove PROPERTY globally, from all entries."
15883 (interactive
15884 (let* ((completion-ignore-case t)
15885 (prop (org-icompleting-read
15886 "Globally remove property: "
15887 (mapcar 'list (org-buffer-property-keys)))))
15888 (list prop)))
15889 (save-excursion
15890 (save-restriction
15891 (widen)
15892 (goto-char (point-min))
15893 (let ((cnt 0))
15894 (while (re-search-forward
15895 (org-re-property property)
15896 nil t)
15897 (setq cnt (1+ cnt))
15898 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15899 (message "Property \"%s\" removed from %d entries" property cnt)))))
15901 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15903 (defun org-compute-property-at-point ()
15904 "Compute the property at point.
15905 This looks for an enclosing column format, extracts the operator and
15906 then applies it to the property in the column format's scope."
15907 (interactive)
15908 (unless (org-at-property-p)
15909 (user-error "Not at a property"))
15910 (let ((prop (org-match-string-no-properties 2)))
15911 (org-columns-get-format-and-top-level)
15912 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15913 (user-error "No operator defined for property %s" prop))
15914 (org-columns-compute prop)))
15916 (defvar org-property-allowed-value-functions nil
15917 "Hook for functions supplying allowed values for a specific property.
15918 The functions must take a single argument, the name of the property, and
15919 return a flat list of allowed values. If \":ETC\" is one of
15920 the values, this means that these values are intended as defaults for
15921 completion, but that other values should be allowed too.
15922 The functions must return nil if they are not responsible for this
15923 property.")
15925 (defun org-property-get-allowed-values (pom property &optional table)
15926 "Get allowed values for the property PROPERTY.
15927 When TABLE is non-nil, return an alist that can directly be used for
15928 completion."
15929 (let (vals)
15930 (cond
15931 ((equal property "TODO")
15932 (setq vals (org-with-point-at pom
15933 (append org-todo-keywords-1 '("")))))
15934 ((equal property "PRIORITY")
15935 (let ((n org-lowest-priority))
15936 (while (>= n org-highest-priority)
15937 (push (char-to-string n) vals)
15938 (setq n (1- n)))))
15939 ((member property org-special-properties))
15940 ((setq vals (run-hook-with-args-until-success
15941 'org-property-allowed-value-functions property)))
15943 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15944 (when (and vals (string-match "\\S-" vals))
15945 (setq vals (car (read-from-string (concat "(" vals ")"))))
15946 (setq vals (mapcar (lambda (x)
15947 (cond ((stringp x) x)
15948 ((numberp x) (number-to-string x))
15949 ((symbolp x) (symbol-name x))
15950 (t "???")))
15951 vals)))))
15952 (when (member ":ETC" vals)
15953 (setq vals (remove ":ETC" vals))
15954 (org-add-props (car vals) '(org-unrestricted t)))
15955 (if table (mapcar 'list vals) vals)))
15957 (defun org-property-previous-allowed-value (&optional previous)
15958 "Switch to the next allowed value for this property."
15959 (interactive)
15960 (org-property-next-allowed-value t))
15962 (defun org-property-next-allowed-value (&optional previous)
15963 "Switch to the next allowed value for this property."
15964 (interactive)
15965 (unless (org-at-property-p)
15966 (user-error "Not at a property"))
15967 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15968 (key (match-string 2))
15969 (value (match-string 3))
15970 (allowed (or (org-property-get-allowed-values (point) key)
15971 (and (member value '("[ ]" "[-]" "[X]"))
15972 '("[ ]" "[X]"))))
15973 (heading (save-match-data (nth 4 (org-heading-components))))
15974 nval)
15975 (unless allowed
15976 (user-error "Allowed values for this property have not been defined"))
15977 (if previous (setq allowed (reverse allowed)))
15978 (if (member value allowed)
15979 (setq nval (car (cdr (member value allowed)))))
15980 (setq nval (or nval (car allowed)))
15981 (if (equal nval value)
15982 (user-error "Only one allowed value for this property"))
15983 (org-at-property-p)
15984 (replace-match (concat " :" key ": " nval) t t)
15985 (org-indent-line)
15986 (beginning-of-line 1)
15987 (skip-chars-forward " \t")
15988 (when (equal prop org-effort-property)
15989 (save-excursion
15990 (org-back-to-heading t)
15991 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15992 (when (string= org-clock-current-task heading)
15993 (setq org-clock-effort nval)
15994 (org-clock-update-mode-line)))
15995 (run-hook-with-args 'org-property-changed-functions key nval)))
15997 (defun org-find-olp (path &optional this-buffer)
15998 "Return a marker pointing to the entry at outline path OLP.
15999 If anything goes wrong, throw an error.
16000 You can wrap this call to catch the error like this:
16002 (condition-case msg
16003 (org-mobile-locate-entry (match-string 4))
16004 (error (nth 1 msg)))
16006 The return value will then be either a string with the error message,
16007 or a marker if everything is OK.
16009 If THIS-BUFFER is set, the outline path does not contain a file,
16010 only headings."
16011 (let* ((file (if this-buffer buffer-file-name (pop path)))
16012 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16013 (level 1)
16014 (lmin 1)
16015 (lmax 1)
16016 limit re end found pos heading cnt flevel)
16017 (unless buffer (error "File not found :%s" file))
16018 (with-current-buffer buffer
16019 (save-excursion
16020 (save-restriction
16021 (widen)
16022 (setq limit (point-max))
16023 (goto-char (point-min))
16024 (while (setq heading (pop path))
16025 (setq re (format org-complex-heading-regexp-format
16026 (regexp-quote heading)))
16027 (setq cnt 0 pos (point))
16028 (while (re-search-forward re end t)
16029 (setq level (- (match-end 1) (match-beginning 1)))
16030 (if (and (>= level lmin) (<= level lmax))
16031 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16032 (when (= cnt 0) (error "Heading not found on level %d: %s"
16033 lmax heading))
16034 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16035 lmax heading))
16036 (goto-char found)
16037 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16038 (setq end (save-excursion (org-end-of-subtree t t))))
16039 (when (org-at-heading-p)
16040 (point-marker)))))))
16042 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16043 "Find node HEADING in BUFFER.
16044 Return a marker to the heading if it was found, or nil if not.
16045 If POS-ONLY is set, return just the position instead of a marker.
16047 The heading text must match exact, but it may have a TODO keyword,
16048 a priority cookie and tags in the standard locations."
16049 (with-current-buffer (or buffer (current-buffer))
16050 (save-excursion
16051 (save-restriction
16052 (widen)
16053 (goto-char (point-min))
16054 (let (case-fold-search)
16055 (if (re-search-forward
16056 (format org-complex-heading-regexp-format
16057 (regexp-quote heading)) nil t)
16058 (if pos-only
16059 (match-beginning 0)
16060 (move-marker (make-marker) (match-beginning 0)))))))))
16062 (defun org-find-exact-heading-in-directory (heading &optional dir)
16063 "Find Org node headline HEADING in all .org files in directory DIR.
16064 When the target headline is found, return a marker to this location."
16065 (let ((files (directory-files (or dir default-directory)
16066 nil "\\`[^.#].*\\.org\\'"))
16067 file visiting m buffer)
16068 (catch 'found
16069 (while (setq file (pop files))
16070 (message "trying %s" file)
16071 (setq visiting (org-find-base-buffer-visiting file))
16072 (setq buffer (or visiting (find-file-noselect file)))
16073 (setq m (org-find-exact-headline-in-buffer
16074 heading buffer))
16075 (when (and (not m) (not visiting)) (kill-buffer buffer))
16076 (and m (throw 'found m))))))
16078 (defun org-find-entry-with-id (ident)
16079 "Locate the entry that contains the ID property with exact value IDENT.
16080 IDENT can be a string, a symbol or a number, this function will search for
16081 the string representation of it.
16082 Return the position where this entry starts, or nil if there is no such entry."
16083 (interactive "sID: ")
16084 (let ((id (cond
16085 ((stringp ident) ident)
16086 ((symbol-name ident) (symbol-name ident))
16087 ((numberp ident) (number-to-string ident))
16088 (t (error "IDENT %s must be a string, symbol or number" ident))))
16089 (case-fold-search nil))
16090 (save-excursion
16091 (save-restriction
16092 (widen)
16093 (goto-char (point-min))
16094 (when (re-search-forward
16095 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16096 nil t)
16097 (org-back-to-heading t)
16098 (point))))))
16100 ;;;; Timestamps
16102 (defvar org-last-changed-timestamp nil)
16103 (defvar org-last-inserted-timestamp nil
16104 "The last time stamp inserted with `org-insert-time-stamp'.")
16105 (defvar org-ts-what) ; dynamically scoped parameter
16107 (defun org-time-stamp (arg &optional inactive)
16108 "Prompt for a date/time and insert a time stamp.
16109 If the user specifies a time like HH:MM or if this command is
16110 called with at least one prefix argument, the time stamp contains
16111 the date and the time. Otherwise, only the date is be included.
16113 All parts of a date not specified by the user is filled in from
16114 the current date/time. So if you just press return without
16115 typing anything, the time stamp will represent the current
16116 date/time.
16118 If there is already a timestamp at the cursor, it will be
16119 modified.
16121 With two universal prefix arguments, insert an active timestamp
16122 with the current time without prompting the user.
16124 When called from lisp, the timestamp is inactive if INACTIVE is
16125 non-nil."
16126 (interactive "P")
16127 (let* ((ts nil)
16128 (default-time
16129 ;; Default time is either today, or, when entering a range,
16130 ;; the range start.
16131 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16132 (save-excursion
16133 (re-search-backward
16134 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16135 (- (point) 20) t)))
16136 (apply 'encode-time (org-parse-time-string (match-string 1)))
16137 (current-time)))
16138 (default-input (and ts (org-get-compact-tod ts)))
16139 (repeater (save-excursion
16140 (save-match-data
16141 (beginning-of-line)
16142 (when (re-search-forward
16143 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16144 (save-excursion (progn (end-of-line) (point))) t)
16145 (match-string 0)))))
16146 org-time-was-given org-end-time-was-given time)
16147 (cond
16148 ((and (org-at-timestamp-p t)
16149 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16150 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16151 (insert "--")
16152 (setq time (let ((this-command this-command))
16153 (org-read-date arg 'totime nil nil
16154 default-time default-input inactive)))
16155 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16156 ((org-at-timestamp-p t)
16157 (setq time (let ((this-command this-command))
16158 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16159 (when (org-at-timestamp-p t) ; just to get the match data
16160 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16161 (replace-match "")
16162 (setq org-last-changed-timestamp
16163 (org-insert-time-stamp
16164 time (or org-time-was-given arg)
16165 inactive nil nil (list org-end-time-was-given)))
16166 (when repeater (goto-char (1- (point))) (insert " " repeater)
16167 (setq org-last-changed-timestamp
16168 (concat (substring org-last-inserted-timestamp 0 -1)
16169 " " repeater ">"))))
16170 (message "Timestamp updated"))
16171 ((equal arg '(16))
16172 (org-insert-time-stamp (current-time) t inactive))
16174 (setq time (let ((this-command this-command))
16175 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16176 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16177 nil nil (list org-end-time-was-given))))))
16179 ;; FIXME: can we use this for something else, like computing time differences?
16180 (defun org-get-compact-tod (s)
16181 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16182 (let* ((t1 (match-string 1 s))
16183 (h1 (string-to-number (match-string 2 s)))
16184 (m1 (string-to-number (match-string 3 s)))
16185 (t2 (and (match-end 4) (match-string 5 s)))
16186 (h2 (and t2 (string-to-number (match-string 6 s))))
16187 (m2 (and t2 (string-to-number (match-string 7 s))))
16188 dh dm)
16189 (if (not t2)
16191 (setq dh (- h2 h1) dm (- m2 m1))
16192 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16193 (concat t1 "+" (number-to-string dh)
16194 (and (/= 0 dm) (format ":%02d" dm)))))))
16196 (defun org-time-stamp-inactive (&optional arg)
16197 "Insert an inactive time stamp.
16198 An inactive time stamp is enclosed in square brackets instead of angle
16199 brackets. It is inactive in the sense that it does not trigger agenda entries,
16200 does not link to the calendar and cannot be changed with the S-cursor keys.
16201 So these are more for recording a certain time/date."
16202 (interactive "P")
16203 (org-time-stamp arg 'inactive))
16205 (defvar org-date-ovl (make-overlay 1 1))
16206 (overlay-put org-date-ovl 'face 'org-date-selected)
16207 (org-detach-overlay org-date-ovl)
16209 (defvar org-ans1) ; dynamically scoped parameter
16210 (defvar org-ans2) ; dynamically scoped parameter
16212 (defvar org-plain-time-of-day-regexp) ; defined below
16214 (defvar org-overriding-default-time nil) ; dynamically scoped
16215 (defvar org-read-date-overlay nil)
16216 (defvar org-dcst nil) ; dynamically scoped
16217 (defvar org-read-date-history nil)
16218 (defvar org-read-date-final-answer nil)
16219 (defvar org-read-date-analyze-futurep nil)
16220 (defvar org-read-date-analyze-forced-year nil)
16221 (defvar org-read-date-inactive)
16223 (defvar org-read-date-minibuffer-local-map
16224 (let* ((org-replace-disputed-keys nil)
16225 (map (make-sparse-keymap)))
16226 (set-keymap-parent map minibuffer-local-map)
16227 (org-defkey map (kbd ".")
16228 (lambda () (interactive)
16229 ;; Are we at the beginning of the prompt?
16230 (if (looking-back "^[^:]+: ")
16231 (org-eval-in-calendar '(calendar-goto-today))
16232 (insert "."))))
16233 (org-defkey map (kbd "C-.")
16234 (lambda () (interactive)
16235 (org-eval-in-calendar '(calendar-goto-today))))
16236 (org-defkey map [(meta shift left)]
16237 (lambda () (interactive)
16238 (org-eval-in-calendar '(calendar-backward-month 1))))
16239 (org-defkey map [(meta shift right)]
16240 (lambda () (interactive)
16241 (org-eval-in-calendar '(calendar-forward-month 1))))
16242 (org-defkey map [(meta shift up)]
16243 (lambda () (interactive)
16244 (org-eval-in-calendar '(calendar-backward-year 1))))
16245 (org-defkey map [(meta shift down)]
16246 (lambda () (interactive)
16247 (org-eval-in-calendar '(calendar-forward-year 1))))
16248 (org-defkey map [?\e (shift left)]
16249 (lambda () (interactive)
16250 (org-eval-in-calendar '(calendar-backward-month 1))))
16251 (org-defkey map [?\e (shift right)]
16252 (lambda () (interactive)
16253 (org-eval-in-calendar '(calendar-forward-month 1))))
16254 (org-defkey map [?\e (shift up)]
16255 (lambda () (interactive)
16256 (org-eval-in-calendar '(calendar-backward-year 1))))
16257 (org-defkey map [?\e (shift down)]
16258 (lambda () (interactive)
16259 (org-eval-in-calendar '(calendar-forward-year 1))))
16260 (org-defkey map [(shift up)]
16261 (lambda () (interactive)
16262 (org-eval-in-calendar '(calendar-backward-week 1))))
16263 (org-defkey map [(shift down)]
16264 (lambda () (interactive)
16265 (org-eval-in-calendar '(calendar-forward-week 1))))
16266 (org-defkey map [(shift left)]
16267 (lambda () (interactive)
16268 (org-eval-in-calendar '(calendar-backward-day 1))))
16269 (org-defkey map [(shift right)]
16270 (lambda () (interactive)
16271 (org-eval-in-calendar '(calendar-forward-day 1))))
16272 (org-defkey map "!"
16273 (lambda () (interactive)
16274 (org-eval-in-calendar '(diary-view-entries))
16275 (message "")))
16276 (org-defkey map ">"
16277 (lambda () (interactive)
16278 (org-eval-in-calendar '(scroll-calendar-left 1))))
16279 (org-defkey map "<"
16280 (lambda () (interactive)
16281 (org-eval-in-calendar '(scroll-calendar-right 1))))
16282 (org-defkey map "\C-v"
16283 (lambda () (interactive)
16284 (org-eval-in-calendar
16285 '(calendar-scroll-left-three-months 1))))
16286 (org-defkey map "\M-v"
16287 (lambda () (interactive)
16288 (org-eval-in-calendar
16289 '(calendar-scroll-right-three-months 1))))
16290 map)
16291 "Keymap for minibuffer commands when using `org-read-date'.")
16293 (defvar org-def)
16294 (defvar org-defdecode)
16295 (defvar org-with-time)
16297 (defun org-read-date (&optional org-with-time to-time from-string prompt
16298 default-time default-input inactive)
16299 "Read a date, possibly a time, and make things smooth for the user.
16300 The prompt will suggest to enter an ISO date, but you can also enter anything
16301 which will at least partially be understood by `parse-time-string'.
16302 Unrecognized parts of the date will default to the current day, month, year,
16303 hour and minute. If this command is called to replace a timestamp at point,
16304 or to enter the second timestamp of a range, the default time is taken
16305 from the existing stamp. Furthermore, the command prefers the future,
16306 so if you are giving a date where the year is not given, and the day-month
16307 combination is already past in the current year, it will assume you
16308 mean next year. For details, see the manual. A few examples:
16310 3-2-5 --> 2003-02-05
16311 feb 15 --> currentyear-02-15
16312 2/15 --> currentyear-02-15
16313 sep 12 9 --> 2009-09-12
16314 12:45 --> today 12:45
16315 22 sept 0:34 --> currentyear-09-22 0:34
16316 12 --> currentyear-currentmonth-12
16317 Fri --> nearest Friday after today
16318 -Tue --> last Tuesday
16319 etc.
16321 Furthermore you can specify a relative date by giving, as the *first* thing
16322 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16323 change in days weeks, months, years.
16324 With a single plus or minus, the date is relative to today. With a double
16325 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16326 +4d --> four days from today
16327 +4 --> same as above
16328 +2w --> two weeks from today
16329 ++5 --> five days from default date
16331 The function understands only English month and weekday abbreviations.
16333 While prompting, a calendar is popped up - you can also select the
16334 date with the mouse (button 1). The calendar shows a period of three
16335 months. To scroll it to other months, use the keys `>' and `<'.
16336 If you don't like the calendar, turn it off with
16337 \(setq org-read-date-popup-calendar nil)
16339 With optional argument TO-TIME, the date will immediately be converted
16340 to an internal time.
16341 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16342 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16343 still enter a time, and this function will inform the calling routine
16344 about this change. The calling routine may then choose to change the
16345 format used to insert the time stamp into the buffer to include the time.
16346 With optional argument FROM-STRING, read from this string instead from
16347 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16348 the time/date that is used for everything that is not specified by the
16349 user."
16350 (require 'parse-time)
16351 (let* ((org-time-stamp-rounding-minutes
16352 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16353 (org-dcst org-display-custom-times)
16354 (ct (org-current-time))
16355 (org-def (or org-overriding-default-time default-time ct))
16356 (org-defdecode (decode-time org-def))
16357 (dummy (progn
16358 (when (< (nth 2 org-defdecode) org-extend-today-until)
16359 (setcar (nthcdr 2 org-defdecode) -1)
16360 (setcar (nthcdr 1 org-defdecode) 59)
16361 (setq org-def (apply 'encode-time org-defdecode)
16362 org-defdecode (decode-time org-def)))))
16363 (mouse-autoselect-window nil) ; Don't let the mouse jump
16364 (calendar-frame-setup nil)
16365 (calendar-setup nil)
16366 (calendar-move-hook nil)
16367 (calendar-view-diary-initially-flag nil)
16368 (calendar-view-holidays-initially-flag nil)
16369 (timestr (format-time-string
16370 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16371 (prompt (concat (if prompt (concat prompt " ") "")
16372 (format "Date+time [%s]: " timestr)))
16373 ans (org-ans0 "") org-ans1 org-ans2 final)
16375 (cond
16376 (from-string (setq ans from-string))
16377 (org-read-date-popup-calendar
16378 (save-excursion
16379 (save-window-excursion
16380 (calendar)
16381 (org-eval-in-calendar '(setq cursor-type nil) t)
16382 (unwind-protect
16383 (progn
16384 (calendar-forward-day (- (time-to-days org-def)
16385 (calendar-absolute-from-gregorian
16386 (calendar-current-date))))
16387 (org-eval-in-calendar nil t)
16388 (let* ((old-map (current-local-map))
16389 (map (copy-keymap calendar-mode-map))
16390 (minibuffer-local-map
16391 (copy-keymap org-read-date-minibuffer-local-map)))
16392 (org-defkey map (kbd "RET") 'org-calendar-select)
16393 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16394 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16395 (unwind-protect
16396 (progn
16397 (use-local-map map)
16398 (setq org-read-date-inactive inactive)
16399 (add-hook 'post-command-hook 'org-read-date-display)
16400 (setq org-ans0 (read-string prompt default-input
16401 'org-read-date-history nil))
16402 ;; org-ans0: from prompt
16403 ;; org-ans1: from mouse click
16404 ;; org-ans2: from calendar motion
16405 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16406 (remove-hook 'post-command-hook 'org-read-date-display)
16407 (use-local-map old-map)
16408 (when org-read-date-overlay
16409 (delete-overlay org-read-date-overlay)
16410 (setq org-read-date-overlay nil)))))
16411 (bury-buffer "*Calendar*")))))
16413 (t ; Naked prompt only
16414 (unwind-protect
16415 (setq ans (read-string prompt default-input
16416 'org-read-date-history timestr))
16417 (when org-read-date-overlay
16418 (delete-overlay org-read-date-overlay)
16419 (setq org-read-date-overlay nil)))))
16421 (setq final (org-read-date-analyze ans org-def org-defdecode))
16423 (when org-read-date-analyze-forced-year
16424 (message "Year was forced into %s"
16425 (if org-read-date-force-compatible-dates
16426 "compatible range (1970-2037)"
16427 "range representable on this machine"))
16428 (ding))
16430 ;; One round trip to get rid of 34th of August and stuff like that....
16431 (setq final (decode-time (apply 'encode-time final)))
16433 (setq org-read-date-final-answer ans)
16435 (if to-time
16436 (apply 'encode-time final)
16437 (if (and (boundp 'org-time-was-given) org-time-was-given)
16438 (format "%04d-%02d-%02d %02d:%02d"
16439 (nth 5 final) (nth 4 final) (nth 3 final)
16440 (nth 2 final) (nth 1 final))
16441 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16443 (defun org-read-date-display ()
16444 "Display the current date prompt interpretation in the minibuffer."
16445 (when org-read-date-display-live
16446 (when org-read-date-overlay
16447 (delete-overlay org-read-date-overlay))
16448 (when (minibufferp (current-buffer))
16449 (save-excursion
16450 (end-of-line 1)
16451 (while (not (equal (buffer-substring
16452 (max (point-min) (- (point) 4)) (point))
16453 " "))
16454 (insert " ")))
16455 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16456 " " (or org-ans1 org-ans2)))
16457 (org-end-time-was-given nil)
16458 (f (org-read-date-analyze ans org-def org-defdecode))
16459 (fmts (if org-dcst
16460 org-time-stamp-custom-formats
16461 org-time-stamp-formats))
16462 (fmt (if (or org-with-time
16463 (and (boundp 'org-time-was-given) org-time-was-given))
16464 (cdr fmts)
16465 (car fmts)))
16466 (txt (format-time-string fmt (apply 'encode-time f)))
16467 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16468 (txt (concat "=> " txt)))
16469 (when (and org-end-time-was-given
16470 (string-match org-plain-time-of-day-regexp txt))
16471 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16472 org-end-time-was-given
16473 (substring txt (match-end 0)))))
16474 (when org-read-date-analyze-futurep
16475 (setq txt (concat txt " (=>F)")))
16476 (setq org-read-date-overlay
16477 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16478 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16480 (defun org-read-date-analyze (ans org-def org-defdecode)
16481 "Analyze the combined answer of the date prompt."
16482 ;; FIXME: cleanup and comment
16483 (let ((nowdecode (decode-time (current-time)))
16484 delta deltan deltaw deltadef year month day
16485 hour minute second wday pm h2 m2 tl wday1
16486 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16487 (setq org-read-date-analyze-futurep nil
16488 org-read-date-analyze-forced-year nil)
16489 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16490 (setq ans "+0"))
16492 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16493 (setq ans (replace-match "" t t ans)
16494 deltan (car delta)
16495 deltaw (nth 1 delta)
16496 deltadef (nth 2 delta)))
16498 ;; Check if there is an iso week date in there. If yes, store the
16499 ;; info and postpone interpreting it until the rest of the parsing
16500 ;; is done.
16501 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16502 (setq iso-year (if (match-end 1)
16503 (org-small-year-to-year
16504 (string-to-number (match-string 1 ans))))
16505 iso-weekday (if (match-end 3)
16506 (string-to-number (match-string 3 ans)))
16507 iso-week (string-to-number (match-string 2 ans)))
16508 (setq ans (replace-match "" t t ans)))
16510 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16511 (when (string-match
16512 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16513 (setq year (if (match-end 2)
16514 (string-to-number (match-string 2 ans))
16515 (progn (setq kill-year t)
16516 (string-to-number (format-time-string "%Y"))))
16517 month (string-to-number (match-string 3 ans))
16518 day (string-to-number (match-string 4 ans)))
16519 (if (< year 100) (setq year (+ 2000 year)))
16520 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16521 t nil ans)))
16523 ;; Help matching dotted european dates
16524 (when (string-match
16525 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16526 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16527 (setq kill-year t)
16528 (string-to-number (format-time-string "%Y")))
16529 day (string-to-number (match-string 1 ans))
16530 month (string-to-number (match-string 2 ans))
16531 ans (replace-match (format "%04d-%02d-%02d" year month day)
16532 t nil ans)))
16534 ;; Help matching american dates, like 5/30 or 5/30/7
16535 (when (string-match
16536 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16537 (setq year (if (match-end 4)
16538 (string-to-number (match-string 4 ans))
16539 (progn (setq kill-year t)
16540 (string-to-number (format-time-string "%Y"))))
16541 month (string-to-number (match-string 1 ans))
16542 day (string-to-number (match-string 2 ans)))
16543 (if (< year 100) (setq year (+ 2000 year)))
16544 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16545 t nil ans)))
16546 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16547 ;; If there is a time with am/pm, and *no* time without it, we convert
16548 ;; so that matching will be successful.
16549 (loop for i from 1 to 2 do ; twice, for end time as well
16550 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16551 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16552 (setq hour (string-to-number (match-string 1 ans))
16553 minute (if (match-end 3)
16554 (string-to-number (match-string 3 ans))
16556 pm (equal ?p
16557 (string-to-char (downcase (match-string 4 ans)))))
16558 (if (and (= hour 12) (not pm))
16559 (setq hour 0)
16560 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16561 (setq ans (replace-match (format "%02d:%02d" hour minute)
16562 t t ans))))
16564 ;; Check if a time range is given as a duration
16565 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16566 (setq hour (string-to-number (match-string 1 ans))
16567 h2 (+ hour (string-to-number (match-string 3 ans)))
16568 minute (string-to-number (match-string 2 ans))
16569 m2 (+ minute (if (match-end 5) (string-to-number
16570 (match-string 5 ans))0)))
16571 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16572 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16573 t t ans)))
16575 ;; Check if there is a time range
16576 (when (boundp 'org-end-time-was-given)
16577 (setq org-time-was-given nil)
16578 (when (and (string-match org-plain-time-of-day-regexp ans)
16579 (match-end 8))
16580 (setq org-end-time-was-given (match-string 8 ans))
16581 (setq ans (concat (substring ans 0 (match-beginning 7))
16582 (substring ans (match-end 7))))))
16584 (setq tl (parse-time-string ans)
16585 day (or (nth 3 tl) (nth 3 org-defdecode))
16586 month (or (nth 4 tl)
16587 (if (and org-read-date-prefer-future
16588 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16589 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16590 (nth 4 org-defdecode)))
16591 year (or (and (not kill-year) (nth 5 tl))
16592 (if (and org-read-date-prefer-future
16593 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16594 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16595 (nth 5 org-defdecode)))
16596 hour (or (nth 2 tl) (nth 2 org-defdecode))
16597 minute (or (nth 1 tl) (nth 1 org-defdecode))
16598 second (or (nth 0 tl) 0)
16599 wday (nth 6 tl))
16601 (when (and (eq org-read-date-prefer-future 'time)
16602 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16603 (equal day (nth 3 nowdecode))
16604 (equal month (nth 4 nowdecode))
16605 (equal year (nth 5 nowdecode))
16606 (nth 2 tl)
16607 (or (< (nth 2 tl) (nth 2 nowdecode))
16608 (and (= (nth 2 tl) (nth 2 nowdecode))
16609 (nth 1 tl)
16610 (< (nth 1 tl) (nth 1 nowdecode)))))
16611 (setq day (1+ day)
16612 futurep t))
16614 ;; Special date definitions below
16615 (cond
16616 (iso-week
16617 ;; There was an iso week
16618 (require 'cal-iso)
16619 (setq futurep nil)
16620 (setq year (or iso-year year)
16621 day (or iso-weekday wday 1)
16622 wday nil ; to make sure that the trigger below does not match
16623 iso-date (calendar-gregorian-from-absolute
16624 (calendar-absolute-from-iso
16625 (list iso-week day year))))
16626 ; FIXME: Should we also push ISO weeks into the future?
16627 ; (when (and org-read-date-prefer-future
16628 ; (not iso-year)
16629 ; (< (calendar-absolute-from-gregorian iso-date)
16630 ; (time-to-days (current-time))))
16631 ; (setq year (1+ year)
16632 ; iso-date (calendar-gregorian-from-absolute
16633 ; (calendar-absolute-from-iso
16634 ; (list iso-week day year)))))
16635 (setq month (car iso-date)
16636 year (nth 2 iso-date)
16637 day (nth 1 iso-date)))
16638 (deltan
16639 (setq futurep nil)
16640 (unless deltadef
16641 (let ((now (decode-time (current-time))))
16642 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16643 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16644 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16645 ((equal deltaw "m") (setq month (+ month deltan)))
16646 ((equal deltaw "y") (setq year (+ year deltan)))))
16647 ((and wday (not (nth 3 tl)))
16648 ;; Weekday was given, but no day, so pick that day in the week
16649 ;; on or after the derived date.
16650 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16651 (unless (equal wday wday1)
16652 (setq day (+ day (% (- wday wday1 -7) 7))))))
16653 (if (and (boundp 'org-time-was-given)
16654 (nth 2 tl))
16655 (setq org-time-was-given t))
16656 (if (< year 100) (setq year (+ 2000 year)))
16657 ;; Check of the date is representable
16658 (if org-read-date-force-compatible-dates
16659 (progn
16660 (if (< year 1970)
16661 (setq year 1970 org-read-date-analyze-forced-year t))
16662 (if (> year 2037)
16663 (setq year 2037 org-read-date-analyze-forced-year t)))
16664 (condition-case nil
16665 (ignore (encode-time second minute hour day month year))
16666 (error
16667 (setq year (nth 5 org-defdecode))
16668 (setq org-read-date-analyze-forced-year t))))
16669 (setq org-read-date-analyze-futurep futurep)
16670 (list second minute hour day month year)))
16672 (defvar parse-time-weekdays)
16673 (defun org-read-date-get-relative (s today default)
16674 "Check string S for special relative date string.
16675 TODAY and DEFAULT are internal times, for today and for a default.
16676 Return shift list (N what def-flag)
16677 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16678 N is the number of WHATs to shift.
16679 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16680 the DEFAULT date rather than TODAY."
16681 (require 'parse-time)
16682 (when (and
16683 (string-match
16684 (concat
16685 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16686 "\\([0-9]+\\)?"
16687 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16688 "\\([ \t]\\|$\\)") s)
16689 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16690 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16691 (string-to-char (substring (match-string 1 s) -1))
16692 ?+))
16693 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16694 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16695 (what (if (match-end 3) (match-string 3 s) "d"))
16696 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16697 (date (if rel default today))
16698 (wday (nth 6 (decode-time date)))
16699 delta)
16700 (if wday1
16701 (progn
16702 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16703 (if (= delta 0) (setq delta 7))
16704 (if (= dir ?-)
16705 (progn
16706 (setq delta (- delta 7))
16707 (if (= delta 0) (setq delta -7))))
16708 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16709 (list delta "d" rel))
16710 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16712 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16713 "Turn a user-specified date into the internal representation.
16714 The internal representation needed by the calendar is (month day year).
16715 This is a wrapper to handle the brain-dead convention in calendar that
16716 user function argument order change dependent on argument order."
16717 (if (boundp 'calendar-date-style)
16718 (cond
16719 ((eq calendar-date-style 'american)
16720 (list arg1 arg2 arg3))
16721 ((eq calendar-date-style 'european)
16722 (list arg2 arg1 arg3))
16723 ((eq calendar-date-style 'iso)
16724 (list arg2 arg3 arg1)))
16725 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16726 (if (org-bound-and-true-p european-calendar-style)
16727 (list arg2 arg1 arg3)
16728 (list arg1 arg2 arg3)))))
16730 (defun org-eval-in-calendar (form &optional keepdate)
16731 "Eval FORM in the calendar window and return to current window.
16732 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16733 otherwise stick to the current value of `org-ans2'."
16734 (let ((sf (selected-frame))
16735 (sw (selected-window)))
16736 (select-window (get-buffer-window "*Calendar*" t))
16737 (eval form)
16738 (when (and (not keepdate) (calendar-cursor-to-date))
16739 (let* ((date (calendar-cursor-to-date))
16740 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16741 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16742 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16743 (select-window sw)
16744 (org-select-frame-set-input-focus sf)))
16746 (defun org-calendar-select ()
16747 "Return to `org-read-date' with the date currently selected.
16748 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16749 (interactive)
16750 (when (calendar-cursor-to-date)
16751 (let* ((date (calendar-cursor-to-date))
16752 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16753 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16754 (if (active-minibuffer-window) (exit-minibuffer))))
16756 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16757 "Insert a date stamp for the date given by the internal TIME.
16758 WITH-HM means use the stamp format that includes the time of the day.
16759 INACTIVE means use square brackets instead of angular ones, so that the
16760 stamp will not contribute to the agenda.
16761 PRE and POST are optional strings to be inserted before and after the
16762 stamp.
16763 The command returns the inserted time stamp."
16764 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16765 stamp)
16766 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16767 (insert-before-markers (or pre ""))
16768 (when (listp extra)
16769 (setq extra (car extra))
16770 (if (and (stringp extra)
16771 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16772 (setq extra (format "-%02d:%02d"
16773 (string-to-number (match-string 1 extra))
16774 (string-to-number (match-string 2 extra))))
16775 (setq extra nil)))
16776 (when extra
16777 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16778 (insert-before-markers (setq stamp (format-time-string fmt time)))
16779 (insert-before-markers (or post ""))
16780 (setq org-last-inserted-timestamp stamp)))
16782 (defun org-toggle-time-stamp-overlays ()
16783 "Toggle the use of custom time stamp formats."
16784 (interactive)
16785 (setq org-display-custom-times (not org-display-custom-times))
16786 (unless org-display-custom-times
16787 (let ((p (point-min)) (bmp (buffer-modified-p)))
16788 (while (setq p (next-single-property-change p 'display))
16789 (if (and (get-text-property p 'display)
16790 (eq (get-text-property p 'face) 'org-date))
16791 (remove-text-properties
16792 p (setq p (next-single-property-change p 'display))
16793 '(display t))))
16794 (set-buffer-modified-p bmp)))
16795 (if (featurep 'xemacs)
16796 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16797 (org-restart-font-lock)
16798 (setq org-table-may-need-update t)
16799 (if org-display-custom-times
16800 (message "Time stamps are overlaid with custom format")
16801 (message "Time stamp overlays removed")))
16803 (defun org-display-custom-time (beg end)
16804 "Overlay modified time stamp format over timestamp between BEG and END."
16805 (let* ((ts (buffer-substring beg end))
16806 t1 w1 with-hm tf time str w2 (off 0))
16807 (save-match-data
16808 (setq t1 (org-parse-time-string ts t))
16809 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16810 (setq off (- (match-end 0) (match-beginning 0)))))
16811 (setq end (- end off))
16812 (setq w1 (- end beg)
16813 with-hm (and (nth 1 t1) (nth 2 t1))
16814 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16815 time (org-fix-decoded-time t1)
16816 str (org-add-props
16817 (format-time-string
16818 (substring tf 1 -1) (apply 'encode-time time))
16819 nil 'mouse-face 'highlight)
16820 w2 (length str))
16821 (if (not (= w2 w1))
16822 (add-text-properties (1+ beg) (+ 2 beg)
16823 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16824 (if (featurep 'xemacs)
16825 (progn
16826 (put-text-property beg end 'invisible t)
16827 (put-text-property beg end 'end-glyph (make-glyph str)))
16828 (put-text-property beg end 'display str))))
16830 (defun org-translate-time (string)
16831 "Translate all timestamps in STRING to custom format.
16832 But do this only if the variable `org-display-custom-times' is set."
16833 (when org-display-custom-times
16834 (save-match-data
16835 (let* ((start 0)
16836 (re org-ts-regexp-both)
16837 t1 with-hm inactive tf time str beg end)
16838 (while (setq start (string-match re string start))
16839 (setq beg (match-beginning 0)
16840 end (match-end 0)
16841 t1 (save-match-data
16842 (org-parse-time-string (substring string beg end) t))
16843 with-hm (and (nth 1 t1) (nth 2 t1))
16844 inactive (equal (substring string beg (1+ beg)) "[")
16845 tf (funcall (if with-hm 'cdr 'car)
16846 org-time-stamp-custom-formats)
16847 time (org-fix-decoded-time t1)
16848 str (format-time-string
16849 (concat
16850 (if inactive "[" "<") (substring tf 1 -1)
16851 (if inactive "]" ">"))
16852 (apply 'encode-time time))
16853 string (replace-match str t t string)
16854 start (+ start (length str)))))))
16855 string)
16857 (defun org-fix-decoded-time (time)
16858 "Set 0 instead of nil for the first 6 elements of time.
16859 Don't touch the rest."
16860 (let ((n 0))
16861 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16863 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16865 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16866 "Difference between TIMESTAMP-STRING and now in days.
16867 If SECONDS is non-nil, return the difference in seconds."
16868 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16869 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16870 (funcall fdiff (current-time)))))
16872 (defun org-deadline-close (timestamp-string &optional ndays)
16873 "Is the time in TIMESTAMP-STRING close to the current date?"
16874 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16875 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16876 (not (org-entry-is-done-p))))
16878 (defun org-get-wdays (ts &optional delay zero-delay)
16879 "Get the deadline lead time appropriate for timestring TS.
16880 When DELAY is non-nil, get the delay time for scheduled items
16881 instead of the deadline lead time. When ZERO-DELAY is non-nil
16882 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16883 don't try to find the delay cookie in the scheduled timestamp."
16884 (let ((tv (if delay org-scheduled-delay-days
16885 org-deadline-warning-days)))
16886 (cond
16887 ((or (and delay (< tv 0))
16888 (and delay zero-delay (<= tv 0))
16889 (and (not delay) (<= tv 0)))
16890 ;; Enforce this value no matter what
16891 (- tv))
16892 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16893 ;; lead time is specified.
16894 (floor (* (string-to-number (match-string 1 ts))
16895 (cdr (assoc (match-string 2 ts)
16896 '(("d" . 1) ("w" . 7)
16897 ("m" . 30.4) ("y" . 365.25)
16898 ("h" . 0.041667)))))))
16899 ;; go for the default.
16900 (t tv))))
16902 (defun org-calendar-select-mouse (ev)
16903 "Return to `org-read-date' with the date currently selected.
16904 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16905 (interactive "e")
16906 (mouse-set-point ev)
16907 (when (calendar-cursor-to-date)
16908 (let* ((date (calendar-cursor-to-date))
16909 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16910 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16911 (if (active-minibuffer-window) (exit-minibuffer))))
16913 (defun org-check-deadlines (ndays)
16914 "Check if there are any deadlines due or past due.
16915 A deadline is considered due if it happens within `org-deadline-warning-days'
16916 days from today's date. If the deadline appears in an entry marked DONE,
16917 it is not shown. The prefix arg NDAYS can be used to test that many
16918 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16919 (interactive "P")
16920 (let* ((org-warn-days
16921 (cond
16922 ((equal ndays '(4)) 100000)
16923 (ndays (prefix-numeric-value ndays))
16924 (t (abs org-deadline-warning-days))))
16925 (case-fold-search nil)
16926 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16927 (callback
16928 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16930 (message "%d deadlines past-due or due within %d days"
16931 (org-occur regexp nil callback)
16932 org-warn-days)))
16934 (defsubst org-re-timestamp (type)
16935 "Return a regexp for timestamp TYPE.
16936 Allowed values for TYPE are:
16938 all: all timestamps
16939 active: only active timestamps (<...>)
16940 inactive: only inactive timestamps ([...])
16941 scheduled: only scheduled timestamps
16942 deadline: only deadline timestamps
16943 closed: only closed time-stamps
16945 When TYPE is nil, fall back on returning a regexp that matches
16946 both scheduled and deadline timestamps."
16947 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16948 ((eq type 'active) org-ts-regexp)
16949 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16950 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16951 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16952 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16953 ((eq type 'scheduled-or-deadline)
16954 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16956 (defun org-check-before-date (date)
16957 "Check if there are deadlines or scheduled entries before DATE."
16958 (interactive (list (org-read-date)))
16959 (let ((case-fold-search nil)
16960 (regexp (org-re-timestamp org-ts-type))
16961 (callback
16962 (lambda () (time-less-p
16963 (org-time-string-to-time (match-string 1))
16964 (org-time-string-to-time date)))))
16965 (message "%d entries before %s"
16966 (org-occur regexp nil callback) date)))
16968 (defun org-check-after-date (date)
16969 "Check if there are deadlines or scheduled entries after DATE."
16970 (interactive (list (org-read-date)))
16971 (let ((case-fold-search nil)
16972 (regexp (org-re-timestamp org-ts-type))
16973 (callback
16974 (lambda () (not
16975 (time-less-p
16976 (org-time-string-to-time (match-string 1))
16977 (org-time-string-to-time date))))))
16978 (message "%d entries after %s"
16979 (org-occur regexp nil callback) date)))
16981 (defun org-check-dates-range (start-date end-date)
16982 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16983 (interactive (list (org-read-date nil nil nil "Range starts")
16984 (org-read-date nil nil nil "Range end")))
16985 (let ((case-fold-search nil)
16986 (regexp (org-re-timestamp org-ts-type))
16987 (callback
16988 (lambda ()
16989 (let ((match (match-string 1)))
16990 (and
16991 (not (time-less-p
16992 (org-time-string-to-time match)
16993 (org-time-string-to-time start-date)))
16994 (time-less-p
16995 (org-time-string-to-time match)
16996 (org-time-string-to-time end-date)))))))
16997 (message "%d entries between %s and %s"
16998 (org-occur regexp nil callback) start-date end-date)))
17000 (defun org-evaluate-time-range (&optional to-buffer)
17001 "Evaluate a time range by computing the difference between start and end.
17002 Normally the result is just printed in the echo area, but with prefix arg
17003 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17004 If the time range is actually in a table, the result is inserted into the
17005 next column.
17006 For time difference computation, a year is assumed to be exactly 365
17007 days in order to avoid rounding problems."
17008 (interactive "P")
17010 (org-clock-update-time-maybe)
17011 (save-excursion
17012 (unless (org-at-date-range-p t)
17013 (goto-char (point-at-bol))
17014 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17015 (if (not (org-at-date-range-p t))
17016 (user-error "Not at a time-stamp range, and none found in current line")))
17017 (let* ((ts1 (match-string 1))
17018 (ts2 (match-string 2))
17019 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17020 (match-end (match-end 0))
17021 (time1 (org-time-string-to-time ts1))
17022 (time2 (org-time-string-to-time ts2))
17023 (t1 (org-float-time time1))
17024 (t2 (org-float-time time2))
17025 (diff (abs (- t2 t1)))
17026 (negative (< (- t2 t1) 0))
17027 ;; (ys (floor (* 365 24 60 60)))
17028 (ds (* 24 60 60))
17029 (hs (* 60 60))
17030 (fy "%dy %dd %02d:%02d")
17031 (fy1 "%dy %dd")
17032 (fd "%dd %02d:%02d")
17033 (fd1 "%dd")
17034 (fh "%02d:%02d")
17035 y d h m align)
17036 (if havetime
17037 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17039 d (floor (/ diff ds)) diff (mod diff ds)
17040 h (floor (/ diff hs)) diff (mod diff hs)
17041 m (floor (/ diff 60)))
17042 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17044 d (floor (+ (/ diff ds) 0.5))
17045 h 0 m 0))
17046 (if (not to-buffer)
17047 (message "%s" (org-make-tdiff-string y d h m))
17048 (if (org-at-table-p)
17049 (progn
17050 (goto-char match-end)
17051 (setq align t)
17052 (and (looking-at " *|") (goto-char (match-end 0))))
17053 (goto-char match-end))
17054 (if (looking-at
17055 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17056 (replace-match ""))
17057 (if negative (insert " -"))
17058 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17059 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17060 (insert " " (format fh h m))))
17061 (if align (org-table-align))
17062 (message "Time difference inserted")))))
17064 (defun org-make-tdiff-string (y d h m)
17065 (let ((fmt "")
17066 (l nil))
17067 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17068 l (push y l)))
17069 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17070 l (push d l)))
17071 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17072 l (push h l)))
17073 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17074 l (push m l)))
17075 (apply 'format fmt (nreverse l))))
17077 (defun org-time-string-to-time (s &optional buffer pos)
17078 "Convert a timestamp string into internal time."
17079 (condition-case errdata
17080 (apply 'encode-time (org-parse-time-string s))
17081 (error (error "Bad timestamp `%s'%s\nError was: %s"
17082 s (if (not (and buffer pos))
17084 (format " at %d in buffer `%s'" pos buffer))
17085 (cdr errdata)))))
17087 (defun org-time-string-to-seconds (s)
17088 "Convert a timestamp string to a number of seconds."
17089 (org-float-time (org-time-string-to-time s)))
17091 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17092 "Convert a time stamp to an absolute day number.
17093 If there is a specifier for a cyclic time stamp, get the closest
17094 date to DAYNR.
17095 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17096 The variable `date' is bound by the calendar when this is called."
17097 (cond
17098 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17099 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17100 daynr
17101 (+ daynr 1000)))
17102 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17103 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17104 (time-to-days (current-time))) (match-string 0 s)
17105 prefer show-all))
17106 (t (time-to-days
17107 (condition-case errdata
17108 (apply 'encode-time (org-parse-time-string s))
17109 (error (error "Bad timestamp `%s'%s\nError was: %s"
17110 s (if (not (and buffer pos))
17112 (format " at %d in buffer `%s'" pos buffer))
17113 (cdr errdata))))))))
17115 (defun org-days-to-iso-week (days)
17116 "Return the iso week number."
17117 (require 'cal-iso)
17118 (car (calendar-iso-from-absolute days)))
17120 (defun org-small-year-to-year (year)
17121 "Convert 2-digit years into 4-digit years.
17122 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17123 The year 2000 cannot be abbreviated. Any year larger than 99
17124 is returned unchanged."
17125 (if (< year 38)
17126 (setq year (+ 2000 year))
17127 (if (< year 100)
17128 (setq year (+ 1900 year))))
17129 year)
17131 (defun org-time-from-absolute (d)
17132 "Return the time corresponding to date D.
17133 D may be an absolute day number, or a calendar-type list (month day year)."
17134 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17135 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17137 (defun org-calendar-holiday ()
17138 "List of holidays, for Diary display in Org-mode."
17139 (require 'holidays)
17140 (let ((hl (funcall
17141 (if (fboundp 'calendar-check-holidays)
17142 'calendar-check-holidays 'check-calendar-holidays) date)))
17143 (if hl (mapconcat 'identity hl "; "))))
17145 (defun org-diary-sexp-entry (sexp entry date)
17146 "Process a SEXP diary ENTRY for DATE."
17147 (require 'diary-lib)
17148 (let ((result (if calendar-debug-sexp
17149 (let ((stack-trace-on-error t))
17150 (eval (car (read-from-string sexp))))
17151 (condition-case nil
17152 (eval (car (read-from-string sexp)))
17153 (error
17154 (beep)
17155 (message "Bad sexp at line %d in %s: %s"
17156 (org-current-line)
17157 (buffer-file-name) sexp)
17158 (sleep-for 2))))))
17159 (cond ((stringp result) (split-string result "; "))
17160 ((and (consp result)
17161 (not (consp (cdr result)))
17162 (stringp (cdr result))) (cdr result))
17163 ((and (consp result)
17164 (stringp (car result))) result)
17165 (result entry))))
17167 (defun org-diary-to-ical-string (frombuf)
17168 "Get iCalendar entries from diary entries in buffer FROMBUF.
17169 This uses the icalendar.el library."
17170 (let* ((tmpdir (if (featurep 'xemacs)
17171 (temp-directory)
17172 temporary-file-directory))
17173 (tmpfile (make-temp-name
17174 (expand-file-name "orgics" tmpdir)))
17175 buf rtn b e)
17176 (with-current-buffer frombuf
17177 (icalendar-export-region (point-min) (point-max) tmpfile)
17178 (setq buf (find-buffer-visiting tmpfile))
17179 (set-buffer buf)
17180 (goto-char (point-min))
17181 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17182 (setq b (match-beginning 0)))
17183 (goto-char (point-max))
17184 (if (re-search-backward "^END:VEVENT" nil t)
17185 (setq e (match-end 0)))
17186 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17187 (kill-buffer buf)
17188 (delete-file tmpfile)
17189 rtn))
17191 (defun org-closest-date (start current change prefer show-all)
17192 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17193 When PREFER is `past', return a date that is either CURRENT or past.
17194 When PREFER is `future', return a date that is either CURRENT or future.
17195 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17196 ;; Make the proper lists from the dates
17197 (catch 'exit
17198 (let ((a1 '(("h" . hour)
17199 ("d" . day)
17200 ("w" . week)
17201 ("m" . month)
17202 ("y" . year)))
17203 (shour (nth 2 (org-parse-time-string start)))
17204 dn dw sday cday n1 n2 n0
17205 d m y y1 y2 date1 date2 nmonths nm ny m2)
17207 (setq start (org-date-to-gregorian start)
17208 current (org-date-to-gregorian
17209 (if show-all
17210 current
17211 (time-to-days (current-time))))
17212 sday (calendar-absolute-from-gregorian start)
17213 cday (calendar-absolute-from-gregorian current))
17215 (if (<= cday sday) (throw 'exit sday))
17217 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17218 (setq dn (string-to-number (match-string 1 change))
17219 dw (cdr (assoc (match-string 2 change) a1)))
17220 (user-error "Invalid change specifier: %s" change))
17221 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17222 (cond
17223 ((eq dw 'hour)
17224 (let ((missing-hours
17225 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17226 dn)))
17227 (setq n1 (if (zerop missing-hours) cday
17228 (- cday (1+ (floor (/ missing-hours 24)))))
17229 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17230 ((eq dw 'day)
17231 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17232 n2 (+ n1 dn)))
17233 ((eq dw 'year)
17234 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17235 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17236 (setq date1 (list m d y1)
17237 n1 (calendar-absolute-from-gregorian date1)
17238 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17239 n2 (calendar-absolute-from-gregorian date2)))
17240 ((eq dw 'month)
17241 ;; approx number of month between the two dates
17242 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17243 ;; How often does dn fit in there?
17244 (setq d (nth 1 start) m (car start) y (nth 2 start)
17245 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17246 m (+ m nm)
17247 ny (floor (/ m 12))
17248 y (+ y ny)
17249 m (- m (* ny 12)))
17250 (while (> m 12) (setq m (- m 12) y (1+ y)))
17251 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17252 (setq m2 (+ m dn) y2 y)
17253 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17254 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17255 (while (<= n2 cday)
17256 (setq n1 n2 m m2 y y2)
17257 (setq m2 (+ m dn) y2 y)
17258 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17259 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17260 ;; Make sure n1 is the earlier date
17261 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17262 (if show-all
17263 (cond
17264 ((eq prefer 'past) (if (= cday n2) n2 n1))
17265 ((eq prefer 'future) (if (= cday n1) n1 n2))
17266 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17267 (cond
17268 ((eq prefer 'past) (if (= cday n2) n2 n1))
17269 ((eq prefer 'future) (if (= cday n1) n1 n2))
17270 (t (if (= cday n1) n1 n2)))))))
17272 (defun org-date-to-gregorian (date)
17273 "Turn any specification of DATE into a Gregorian date for the calendar."
17274 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17275 ((and (listp date) (= (length date) 3)) date)
17276 ((stringp date)
17277 (setq date (org-parse-time-string date))
17278 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17279 ((listp date)
17280 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17282 (defun org-parse-time-string (s &optional nodefault)
17283 "Parse the standard Org-mode time string.
17284 This should be a lot faster than the normal `parse-time-string'.
17285 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17286 hour and minute fields will be nil if not given."
17287 (cond ((string-match org-ts-regexp0 s)
17288 (list 0
17289 (if (or (match-beginning 8) (not nodefault))
17290 (string-to-number (or (match-string 8 s) "0")))
17291 (if (or (match-beginning 7) (not nodefault))
17292 (string-to-number (or (match-string 7 s) "0")))
17293 (string-to-number (match-string 4 s))
17294 (string-to-number (match-string 3 s))
17295 (string-to-number (match-string 2 s))
17296 nil nil nil))
17297 ((string-match "^<[^>]+>$" s)
17298 (decode-time (seconds-to-time (org-matcher-time s))))
17299 (t (error "Not a standard Org-mode time string: %s" s))))
17301 (defun org-timestamp-up (&optional arg)
17302 "Increase the date item at the cursor by one.
17303 If the cursor is on the year, change the year. If it is on the month,
17304 the day or the time, change that.
17305 With prefix ARG, change by that many units."
17306 (interactive "p")
17307 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17309 (defun org-timestamp-down (&optional arg)
17310 "Decrease the date item at the cursor by one.
17311 If the cursor is on the year, change the year. If it is on the month,
17312 the day or the time, change that.
17313 With prefix ARG, change by that many units."
17314 (interactive "p")
17315 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17317 (defun org-timestamp-up-day (&optional arg)
17318 "Increase the date in the time stamp by one day.
17319 With prefix ARG, change that many days."
17320 (interactive "p")
17321 (if (and (not (org-at-timestamp-p t))
17322 (org-at-heading-p))
17323 (org-todo 'up)
17324 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17326 (defun org-timestamp-down-day (&optional arg)
17327 "Decrease the date in the time stamp by one day.
17328 With prefix ARG, change that many days."
17329 (interactive "p")
17330 (if (and (not (org-at-timestamp-p t))
17331 (org-at-heading-p))
17332 (org-todo 'down)
17333 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17335 (defun org-at-timestamp-p (&optional inactive-ok)
17336 "Determine if the cursor is in or at a timestamp."
17337 (interactive)
17338 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17339 (pos (point))
17340 (ans (or (looking-at tsr)
17341 (save-excursion
17342 (skip-chars-backward "^[<\n\r\t")
17343 (if (> (point) (point-min)) (backward-char 1))
17344 (and (looking-at tsr)
17345 (> (- (match-end 0) pos) -1))))))
17346 (and ans
17347 (boundp 'org-ts-what)
17348 (setq org-ts-what
17349 (cond
17350 ((= pos (match-beginning 0)) 'bracket)
17351 ;; Point is considered to be "on the bracket" whether
17352 ;; it's really on it or right after it.
17353 ((= pos (1- (match-end 0))) 'bracket)
17354 ((= pos (match-end 0)) 'after)
17355 ((org-pos-in-match-range pos 2) 'year)
17356 ((org-pos-in-match-range pos 3) 'month)
17357 ((org-pos-in-match-range pos 7) 'hour)
17358 ((org-pos-in-match-range pos 8) 'minute)
17359 ((or (org-pos-in-match-range pos 4)
17360 (org-pos-in-match-range pos 5)) 'day)
17361 ((and (> pos (or (match-end 8) (match-end 5)))
17362 (< pos (match-end 0)))
17363 (- pos (or (match-end 8) (match-end 5))))
17364 (t 'day))))
17365 ans))
17367 (defun org-toggle-timestamp-type ()
17368 "Toggle the type (<active> or [inactive]) of a time stamp."
17369 (interactive)
17370 (when (org-at-timestamp-p t)
17371 (let ((beg (match-beginning 0)) (end (match-end 0))
17372 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17373 (save-excursion
17374 (goto-char beg)
17375 (while (re-search-forward "[][<>]" end t)
17376 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17377 t t)))
17378 (message "Timestamp is now %sactive"
17379 (if (equal (char-after beg) ?<) "" "in")))))
17381 (defun org-at-clock-log-p nil
17382 "Is the cursor on the clock log line?"
17383 (save-excursion
17384 (move-beginning-of-line 1)
17385 (looking-at "^[ \t]*CLOCK:")))
17387 (defvar org-clock-history) ; defined in org-clock.el
17388 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17389 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17390 "Change the date in the time stamp at point.
17391 The date will be changed by N times WHAT. WHAT can be `day', `month',
17392 `year', `minute', `second'. If WHAT is not given, the cursor position
17393 in the timestamp determines what will be changed.
17394 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17395 (let ((origin (point)) origin-cat
17396 with-hm inactive
17397 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17398 org-ts-what
17399 extra rem
17400 ts time time0 fixnext clrgx)
17401 (if (not (org-at-timestamp-p t))
17402 (user-error "Not at a timestamp"))
17403 (if (and (not what) (eq org-ts-what 'bracket))
17404 (org-toggle-timestamp-type)
17405 ;; Point isn't on brackets. Remember the part of the time-stamp
17406 ;; the point was in. Indeed, size of time-stamps may change,
17407 ;; but point must be kept in the same category nonetheless.
17408 (setq origin-cat org-ts-what)
17409 (if (and (not what) (not (eq org-ts-what 'day))
17410 org-display-custom-times
17411 (get-text-property (point) 'display)
17412 (not (get-text-property (1- (point)) 'display)))
17413 (setq org-ts-what 'day))
17414 (setq org-ts-what (or what org-ts-what)
17415 inactive (= (char-after (match-beginning 0)) ?\[)
17416 ts (match-string 0))
17417 (replace-match "")
17418 (when (string-match
17419 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17421 (setq extra (match-string 1 ts))
17422 (if suppress-tmp-delay
17423 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17424 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17425 (setq with-hm t))
17426 (setq time0 (org-parse-time-string ts))
17427 (when (and updown
17428 (eq org-ts-what 'minute)
17429 (not current-prefix-arg))
17430 ;; This looks like s-up and s-down. Change by one rounding step.
17431 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17432 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17433 (setcar (cdr time0) (+ (nth 1 time0)
17434 (if (> n 0) (- rem) (- dm rem))))))
17435 (setq time
17436 (encode-time (or (car time0) 0)
17437 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17438 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17439 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17440 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17441 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17442 (nthcdr 6 time0)))
17443 (when (and (member org-ts-what '(hour minute))
17444 extra
17445 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17446 (setq extra (org-modify-ts-extra
17447 extra
17448 (if (eq org-ts-what 'hour) 2 5)
17449 n dm)))
17450 (when (integerp org-ts-what)
17451 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17452 (if (eq what 'calendar)
17453 (let ((cal-date (org-get-date-from-calendar)))
17454 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17455 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17456 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17457 (setcar time0 (or (car time0) 0))
17458 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17459 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17460 (setq time (apply 'encode-time time0))))
17461 ;; Insert the new time-stamp, and ensure point stays in the same
17462 ;; category as before (i.e. not after the last position in that
17463 ;; category).
17464 (let ((pos (point)))
17465 ;; Stay before inserted string. `save-excursion' is of no use.
17466 (setq org-last-changed-timestamp
17467 (org-insert-time-stamp time with-hm inactive nil nil extra))
17468 (goto-char pos))
17469 (save-match-data
17470 (looking-at org-ts-regexp3)
17471 (goto-char (cond
17472 ;; `day' category ends before `hour' if any, or at
17473 ;; the end of the day name.
17474 ((eq origin-cat 'day)
17475 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17476 ((eq origin-cat 'hour) (min (match-end 7) origin))
17477 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17478 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17479 ;; `year' and `month' have both fixed size: point
17480 ;; couldn't have moved into another part.
17481 (t origin))))
17482 ;; Update clock if on a CLOCK line.
17483 (org-clock-update-time-maybe)
17484 ;; Maybe adjust the closest clock in `org-clock-history'
17485 (when org-clock-adjust-closest
17486 (if (not (and (org-at-clock-log-p)
17487 (< 1 (length (delq nil (mapcar 'marker-position
17488 org-clock-history))))))
17489 (message "No clock to adjust")
17490 (cond ((save-excursion ; fix previous clock?
17491 (re-search-backward org-ts-regexp0 nil t)
17492 (org-looking-back (concat org-clock-string " \\[")))
17493 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17494 ((save-excursion ; fix next clock?
17495 (re-search-backward org-ts-regexp0 nil t)
17496 (looking-at (concat org-ts-regexp0 "\\] =>")))
17497 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17498 (save-window-excursion
17499 ;; Find closest clock to point, adjust the previous/next one in history
17500 (let* ((p (save-excursion (org-back-to-heading t)))
17501 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17502 (clfixnth
17503 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17504 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17505 (if (not clfixpos)
17506 (message "No clock to adjust")
17507 (save-excursion
17508 (org-goto-marker-or-bmk clfixpos)
17509 (org-show-subtree)
17510 (when (re-search-forward clrgx nil t)
17511 (goto-char (match-beginning 1))
17512 (let (org-clock-adjust-closest)
17513 (org-timestamp-change n org-ts-what updown))
17514 (message "Clock adjusted in %s for heading: %s"
17515 (file-name-nondirectory (buffer-file-name))
17516 (org-get-heading t t)))))))))
17517 ;; Try to recenter the calendar window, if any.
17518 (if (and org-calendar-follow-timestamp-change
17519 (get-buffer-window "*Calendar*" t)
17520 (memq org-ts-what '(day month year)))
17521 (org-recenter-calendar (time-to-days time))))))
17523 (defun org-modify-ts-extra (s pos n dm)
17524 "Change the different parts of the lead-time and repeat fields in timestamp."
17525 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17526 ng h m new rem)
17527 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17528 (cond
17529 ((or (org-pos-in-match-range pos 2)
17530 (org-pos-in-match-range pos 3))
17531 (setq m (string-to-number (match-string 3 s))
17532 h (string-to-number (match-string 2 s)))
17533 (if (org-pos-in-match-range pos 2)
17534 (setq h (+ h n))
17535 (setq n (* dm (org-no-warnings (signum n))))
17536 (when (not (= 0 (setq rem (% m dm))))
17537 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17538 (setq m (+ m n)))
17539 (if (< m 0) (setq m (+ m 60) h (1- h)))
17540 (if (> m 59) (setq m (- m 60) h (1+ h)))
17541 (setq h (min 24 (max 0 h)))
17542 (setq ng 1 new (format "-%02d:%02d" h m)))
17543 ((org-pos-in-match-range pos 6)
17544 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17545 ((org-pos-in-match-range pos 5)
17546 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17548 ((org-pos-in-match-range pos 9)
17549 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17550 ((org-pos-in-match-range pos 8)
17551 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17553 (when ng
17554 (setq s (concat
17555 (substring s 0 (match-beginning ng))
17557 (substring s (match-end ng))))))
17560 (defun org-recenter-calendar (date)
17561 "If the calendar is visible, recenter it to DATE."
17562 (let ((cwin (get-buffer-window "*Calendar*" t)))
17563 (when cwin
17564 (let ((calendar-move-hook nil))
17565 (with-selected-window cwin
17566 (calendar-goto-date (if (listp date) date
17567 (calendar-gregorian-from-absolute date))))))))
17569 (defun org-goto-calendar (&optional arg)
17570 "Go to the Emacs calendar at the current date.
17571 If there is a time stamp in the current line, go to that date.
17572 A prefix ARG can be used to force the current date."
17573 (interactive "P")
17574 (let ((tsr org-ts-regexp) diff
17575 (calendar-move-hook nil)
17576 (calendar-view-holidays-initially-flag nil)
17577 (calendar-view-diary-initially-flag nil))
17578 (if (or (org-at-timestamp-p)
17579 (save-excursion
17580 (beginning-of-line 1)
17581 (looking-at (concat ".*" tsr))))
17582 (let ((d1 (time-to-days (current-time)))
17583 (d2 (time-to-days
17584 (org-time-string-to-time (match-string 1)))))
17585 (setq diff (- d2 d1))))
17586 (calendar)
17587 (calendar-goto-today)
17588 (if (and diff (not arg)) (calendar-forward-day diff))))
17590 (defun org-get-date-from-calendar ()
17591 "Return a list (month day year) of date at point in calendar."
17592 (with-current-buffer "*Calendar*"
17593 (save-match-data
17594 (calendar-cursor-to-date))))
17596 (defun org-date-from-calendar ()
17597 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17598 If there is already a time stamp at the cursor position, update it."
17599 (interactive)
17600 (if (org-at-timestamp-p t)
17601 (org-timestamp-change 0 'calendar)
17602 (let ((cal-date (org-get-date-from-calendar)))
17603 (org-insert-time-stamp
17604 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17606 (defcustom org-effort-durations
17607 `(("h" . 60)
17608 ("d" . ,(* 60 8))
17609 ("w" . ,(* 60 8 5))
17610 ("m" . ,(* 60 8 5 4))
17611 ("y" . ,(* 60 8 5 40)))
17612 "Conversion factor to minutes for an effort modifier.
17614 Each entry has the form (MODIFIER . MINUTES).
17616 In an effort string, a number followed by MODIFIER is multiplied
17617 by the specified number of MINUTES to obtain an effort in
17618 minutes.
17620 For example, if the value of this variable is ((\"hours\" . 60)), then an
17621 effort string \"2hours\" is equivalent to 120 minutes."
17622 :group 'org-agenda
17623 :version "24.1"
17624 :type '(alist :key-type (string :tag "Modifier")
17625 :value-type (number :tag "Minutes")))
17627 (defun org-minutes-to-clocksum-string (m)
17628 "Format number of minutes as a clocksum string.
17629 The format is determined by `org-time-clocksum-format',
17630 `org-time-clocksum-use-fractional' and
17631 `org-time-clocksum-fractional-format' and
17632 `org-time-clocksum-use-effort-durations'."
17633 (let ((clocksum "")
17634 (m (round m)) ; Don't allow fractions of minutes
17635 h d w mo y fmt n)
17636 (setq h (if org-time-clocksum-use-effort-durations
17637 (cdr (assoc "h" org-effort-durations)) 60)
17638 d (if org-time-clocksum-use-effort-durations
17639 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17640 w (if org-time-clocksum-use-effort-durations
17641 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17642 mo (if org-time-clocksum-use-effort-durations
17643 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17644 y (if org-time-clocksum-use-effort-durations
17645 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17646 ;; fractional format
17647 (if org-time-clocksum-use-fractional
17648 (cond
17649 ;; single format string
17650 ((stringp org-time-clocksum-fractional-format)
17651 (format org-time-clocksum-fractional-format (/ m (float h))))
17652 ;; choice of fractional formats for different time units
17653 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17654 (> (/ (truncate m) (* y d h)) 0))
17655 (format fmt (/ m (* y d (float h)))))
17656 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17657 (> (/ (truncate m) (* mo d h)) 0))
17658 (format fmt (/ m (* mo d (float h)))))
17659 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17660 (> (/ (truncate m) (* w d h)) 0))
17661 (format fmt (/ m (* w d (float h)))))
17662 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17663 (> (/ (truncate m) (* d h)) 0))
17664 (format fmt (/ m (* d (float h)))))
17665 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17666 (> (/ (truncate m) h) 0))
17667 (format fmt (/ m (float h))))
17668 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17669 (format fmt m))
17670 ;; fall back to smallest time unit with a format
17671 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17672 (format fmt (/ m (float h))))
17673 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17674 (format fmt (/ m (* d (float h)))))
17675 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17676 (format fmt (/ m (* w d (float h)))))
17677 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17678 (format fmt (/ m (* mo d (float h)))))
17679 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17680 (format fmt (/ m (* y d (float h))))))
17681 ;; standard (non-fractional) format, with single format string
17682 (if (stringp org-time-clocksum-format)
17683 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17684 ;; separate formats components
17685 (and (setq fmt (plist-get org-time-clocksum-format :years))
17686 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17687 (plist-get org-time-clocksum-format :require-years))
17688 (setq clocksum (concat clocksum (format fmt n))
17689 m (- m (* n y d h))))
17690 (and (setq fmt (plist-get org-time-clocksum-format :months))
17691 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17692 (plist-get org-time-clocksum-format :require-months))
17693 (setq clocksum (concat clocksum (format fmt n))
17694 m (- m (* n mo d h))))
17695 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17696 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17697 (plist-get org-time-clocksum-format :require-weeks))
17698 (setq clocksum (concat clocksum (format fmt n))
17699 m (- m (* n w d h))))
17700 (and (setq fmt (plist-get org-time-clocksum-format :days))
17701 (or (> (setq n (/ (truncate m) (* d h))) 0)
17702 (plist-get org-time-clocksum-format :require-days))
17703 (setq clocksum (concat clocksum (format fmt n))
17704 m (- m (* n d h))))
17705 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17706 (or (> (setq n (/ (truncate m) h)) 0)
17707 (plist-get org-time-clocksum-format :require-hours))
17708 (setq clocksum (concat clocksum (format fmt n))
17709 m (- m (* n h))))
17710 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17711 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17712 (setq clocksum (concat clocksum (format fmt m))))
17713 ;; return formatted time duration
17714 clocksum))))
17716 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17717 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17718 "Org mode version 8.0")
17720 (defun org-hours-to-clocksum-string (n)
17721 (org-minutes-to-clocksum-string (* n 60)))
17723 (defun org-hh:mm-string-to-minutes (s)
17724 "Convert a string H:MM to a number of minutes.
17725 If the string is just a number, interpret it as minutes.
17726 In fact, the first hh:mm or number in the string will be taken,
17727 there can be extra stuff in the string.
17728 If no number is found, the return value is 0."
17729 (cond
17730 ((integerp s) s)
17731 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17732 (+ (* (string-to-number (match-string 1 s)) 60)
17733 (string-to-number (match-string 2 s))))
17734 ((string-match "\\([0-9]+\\)" s)
17735 (string-to-number (match-string 1 s)))
17736 (t 0)))
17738 (defcustom org-image-actual-width t
17739 "Should we use the actual width of images when inlining them?
17741 When set to `t', always use the image width.
17743 When set to a number, use imagemagick (when available) to set
17744 the image's width to this value.
17746 When set to a number in a list, try to get the width from any
17747 #+ATTR.* keyword if it matches a width specification like
17749 #+ATTR_HTML: :width 300px
17751 and fall back on that number if none is found.
17753 When set to nil, try to get the width from an #+ATTR.* keyword
17754 and fall back on the original width if none is found.
17756 This requires Emacs >= 24.1, build with imagemagick support."
17757 :group 'org-appearance
17758 :version "24.4"
17759 :package-version '(Org . "8.0")
17760 :type '(choice
17761 (const :tag "Use the image width" t)
17762 (integer :tag "Use a number of pixels")
17763 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17764 (const :tag "Use #+ATTR* or don't resize" nil)))
17766 (defcustom org-agenda-inhibit-startup nil
17767 "Inhibit startup when preparing agenda buffers.
17768 When this variable is `t', the initialization of the Org agenda
17769 buffers is inhibited: e.g. the visibility state is not set, the
17770 tables are not re-aligned, etc."
17771 :type 'boolean
17772 :version "24.3"
17773 :group 'org-agenda)
17775 (defcustom org-agenda-ignore-drawer-properties nil
17776 "Avoid updating text properties when building the agenda.
17777 Properties are used to prepare buffers for effort estimates, appointments,
17778 and subtree-local categories.
17779 If you don't use these in the agenda, you can add them to this list and
17780 agenda building will be a bit faster.
17781 The value is a list, with zero or more of the symbols `effort', `appt',
17782 or `category'."
17783 :type '(set :greedy t
17784 (const effort)
17785 (const appt)
17786 (const category))
17787 :version "24.3"
17788 :group 'org-agenda)
17790 (defun org-duration-string-to-minutes (s &optional output-to-string)
17791 "Convert a duration string S to minutes.
17793 A bare number is interpreted as minutes, modifiers can be set by
17794 customizing `org-effort-durations' (which see).
17796 Entries containing a colon are interpreted as H:MM by
17797 `org-hh:mm-string-to-minutes'."
17798 (let ((result 0)
17799 (re (concat "\\([0-9.]+\\) *\\("
17800 (regexp-opt (mapcar 'car org-effort-durations))
17801 "\\)")))
17802 (while (string-match re s)
17803 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17804 (string-to-number (match-string 1 s))))
17805 (setq s (replace-match "" nil t s)))
17806 (setq result (floor result))
17807 (incf result (org-hh:mm-string-to-minutes s))
17808 (if output-to-string (number-to-string result) result)))
17810 ;;;; Files
17812 (defun org-save-all-org-buffers ()
17813 "Save all Org-mode buffers without user confirmation."
17814 (interactive)
17815 (message "Saving all Org-mode buffers...")
17816 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17817 (when (featurep 'org-id) (org-id-locations-save))
17818 (message "Saving all Org-mode buffers... done"))
17820 (defun org-revert-all-org-buffers ()
17821 "Revert all Org-mode buffers.
17822 Prompt for confirmation when there are unsaved changes.
17823 Be sure you know what you are doing before letting this function
17824 overwrite your changes.
17826 This function is useful in a setup where one tracks org files
17827 with a version control system, to revert on one machine after pulling
17828 changes from another. I believe the procedure must be like this:
17830 1. M-x org-save-all-org-buffers
17831 2. Pull changes from the other machine, resolve conflicts
17832 3. M-x org-revert-all-org-buffers"
17833 (interactive)
17834 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17835 (user-error "Abort"))
17836 (save-excursion
17837 (save-window-excursion
17838 (mapc
17839 (lambda (b)
17840 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17841 (with-current-buffer b buffer-file-name))
17842 (org-pop-to-buffer-same-window b)
17843 (revert-buffer t 'no-confirm)))
17844 (buffer-list))
17845 (when (and (featurep 'org-id) org-id-track-globally)
17846 (org-id-locations-load)))))
17848 ;;;; Agenda files
17850 ;;;###autoload
17851 (defun org-switchb (&optional arg)
17852 "Switch between Org buffers.
17853 With one prefix argument, restrict available buffers to files.
17854 With two prefix arguments, restrict available buffers to agenda files.
17856 Defaults to `iswitchb' for buffer name completion.
17857 Set `org-completion-use-ido' to make it use ido instead."
17858 (interactive "P")
17859 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17860 ((equal arg '(16)) (org-buffer-list 'agenda))
17861 (t (org-buffer-list))))
17862 (org-completion-use-iswitchb org-completion-use-iswitchb)
17863 (org-completion-use-ido org-completion-use-ido))
17864 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17865 (setq org-completion-use-iswitchb t))
17866 (org-pop-to-buffer-same-window
17867 (org-icompleting-read "Org buffer: "
17868 (mapcar 'list (mapcar 'buffer-name blist))
17869 nil t))))
17871 ;;; Define some older names previously used for this functionality
17872 ;;;###autoload
17873 (defalias 'org-ido-switchb 'org-switchb)
17874 ;;;###autoload
17875 (defalias 'org-iswitchb 'org-switchb)
17877 (defun org-buffer-list (&optional predicate exclude-tmp)
17878 "Return a list of Org buffers.
17879 PREDICATE can be `export', `files' or `agenda'.
17881 export restrict the list to Export buffers.
17882 files restrict the list to buffers visiting Org files.
17883 agenda restrict the list to buffers visiting agenda files.
17885 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17886 (let* ((bfn nil)
17887 (agenda-files (and (eq predicate 'agenda)
17888 (mapcar 'file-truename (org-agenda-files t))))
17889 (filter
17890 (cond
17891 ((eq predicate 'files)
17892 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17893 ((eq predicate 'export)
17894 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17895 ((eq predicate 'agenda)
17896 (lambda (b)
17897 (with-current-buffer b
17898 (and (derived-mode-p 'org-mode)
17899 (setq bfn (buffer-file-name b))
17900 (member (file-truename bfn) agenda-files)))))
17901 (t (lambda (b) (with-current-buffer b
17902 (or (derived-mode-p 'org-mode)
17903 (string-match "\*Org .*Export"
17904 (buffer-name b)))))))))
17905 (delq nil
17906 (mapcar
17907 (lambda(b)
17908 (if (and (funcall filter b)
17909 (or (not exclude-tmp)
17910 (not (string-match "tmp" (buffer-name b)))))
17912 nil))
17913 (buffer-list)))))
17915 (defun org-agenda-files (&optional unrestricted archives)
17916 "Get the list of agenda files.
17917 Optional UNRESTRICTED means return the full list even if a restriction
17918 is currently in place.
17919 When ARCHIVES is t, include all archive files that are really being
17920 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17921 `org-agenda-archives-mode' is t."
17922 (let ((files
17923 (cond
17924 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17925 ((stringp org-agenda-files) (org-read-agenda-file-list))
17926 ((listp org-agenda-files) org-agenda-files)
17927 (t (error "Invalid value of `org-agenda-files'")))))
17928 (setq files (apply 'append
17929 (mapcar (lambda (f)
17930 (if (file-directory-p f)
17931 (directory-files
17932 f t org-agenda-file-regexp)
17933 (list f)))
17934 files)))
17935 (when org-agenda-skip-unavailable-files
17936 (setq files (delq nil
17937 (mapcar (function
17938 (lambda (file)
17939 (and (file-readable-p file) file)))
17940 files))))
17941 (when (or (eq archives t)
17942 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17943 (setq files (org-add-archive-files files)))
17944 files))
17946 (defun org-agenda-file-p (&optional file)
17947 "Return non-nil, if FILE is an agenda file.
17948 If FILE is omitted, use the file associated with the current
17949 buffer."
17950 (member (or file (buffer-file-name))
17951 (org-agenda-files t)))
17953 (defun org-edit-agenda-file-list ()
17954 "Edit the list of agenda files.
17955 Depending on setup, this either uses customize to edit the variable
17956 `org-agenda-files', or it visits the file that is holding the list. In the
17957 latter case, the buffer is set up in a way that saving it automatically kills
17958 the buffer and restores the previous window configuration."
17959 (interactive)
17960 (if (stringp org-agenda-files)
17961 (let ((cw (current-window-configuration)))
17962 (find-file org-agenda-files)
17963 (org-set-local 'org-window-configuration cw)
17964 (org-add-hook 'after-save-hook
17965 (lambda ()
17966 (set-window-configuration
17967 (prog1 org-window-configuration
17968 (kill-buffer (current-buffer))))
17969 (org-install-agenda-files-menu)
17970 (message "New agenda file list installed"))
17971 nil 'local)
17972 (message "%s" (substitute-command-keys
17973 "Edit list and finish with \\[save-buffer]")))
17974 (customize-variable 'org-agenda-files)))
17976 (defun org-store-new-agenda-file-list (list)
17977 "Set new value for the agenda file list and save it correctly."
17978 (if (stringp org-agenda-files)
17979 (let ((fe (org-read-agenda-file-list t)) b u)
17980 (while (setq b (find-buffer-visiting org-agenda-files))
17981 (kill-buffer b))
17982 (with-temp-file org-agenda-files
17983 (insert
17984 (mapconcat
17985 (lambda (f) ;; Keep un-expanded entries.
17986 (if (setq u (assoc f fe))
17987 (cdr u)
17989 list "\n")
17990 "\n")))
17991 (let ((org-mode-hook nil) (org-inhibit-startup t)
17992 (org-insert-mode-line-in-empty-file nil))
17993 (setq org-agenda-files list)
17994 (customize-save-variable 'org-agenda-files org-agenda-files))))
17996 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17997 "Read the list of agenda files from a file.
17998 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17999 filenames, used by `org-store-new-agenda-file-list' to write back
18000 un-expanded file names."
18001 (when (file-directory-p org-agenda-files)
18002 (error "`org-agenda-files' cannot be a single directory"))
18003 (when (stringp org-agenda-files)
18004 (with-temp-buffer
18005 (insert-file-contents org-agenda-files)
18006 (mapcar
18007 (lambda (f)
18008 (let ((e (expand-file-name (substitute-in-file-name f)
18009 org-directory)))
18010 (if pair-with-expansion
18011 (cons e f)
18012 e)))
18013 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18015 ;;;###autoload
18016 (defun org-cycle-agenda-files ()
18017 "Cycle through the files in `org-agenda-files'.
18018 If the current buffer visits an agenda file, find the next one in the list.
18019 If the current buffer does not, find the first agenda file."
18020 (interactive)
18021 (let* ((fs (org-agenda-files t))
18022 (files (append fs (list (car fs))))
18023 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18024 file)
18025 (unless files (user-error "No agenda files"))
18026 (catch 'exit
18027 (while (setq file (pop files))
18028 (if (equal (file-truename file) tcf)
18029 (when (car files)
18030 (find-file (car files))
18031 (throw 'exit t))))
18032 (find-file (car fs)))
18033 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18035 (defun org-agenda-file-to-front (&optional to-end)
18036 "Move/add the current file to the top of the agenda file list.
18037 If the file is not present in the list, it is added to the front. If it is
18038 present, it is moved there. With optional argument TO-END, add/move to the
18039 end of the list."
18040 (interactive "P")
18041 (let ((org-agenda-skip-unavailable-files nil)
18042 (file-alist (mapcar (lambda (x)
18043 (cons (file-truename x) x))
18044 (org-agenda-files t)))
18045 (ctf (file-truename
18046 (or buffer-file-name
18047 (user-error "Please save the current buffer to a file"))))
18048 x had)
18049 (setq x (assoc ctf file-alist) had x)
18051 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18052 (if to-end
18053 (setq file-alist (append (delq x file-alist) (list x)))
18054 (setq file-alist (cons x (delq x file-alist))))
18055 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18056 (org-install-agenda-files-menu)
18057 (message "File %s to %s of agenda file list"
18058 (if had "moved" "added") (if to-end "end" "front"))))
18060 (defun org-remove-file (&optional file)
18061 "Remove current file from the list of files in variable `org-agenda-files'.
18062 These are the files which are being checked for agenda entries.
18063 Optional argument FILE means use this file instead of the current."
18064 (interactive)
18065 (let* ((org-agenda-skip-unavailable-files nil)
18066 (file (or file buffer-file-name
18067 (user-error "Current buffer does not visit a file")))
18068 (true-file (file-truename file))
18069 (afile (abbreviate-file-name file))
18070 (files (delq nil (mapcar
18071 (lambda (x)
18072 (if (equal true-file
18073 (file-truename x))
18074 nil x))
18075 (org-agenda-files t)))))
18076 (if (not (= (length files) (length (org-agenda-files t))))
18077 (progn
18078 (org-store-new-agenda-file-list files)
18079 (org-install-agenda-files-menu)
18080 (message "Removed file: %s" afile))
18081 (message "File was not in list: %s (not removed)" afile))))
18083 (defun org-file-menu-entry (file)
18084 (vector file (list 'find-file file) t))
18086 (defun org-check-agenda-file (file)
18087 "Make sure FILE exists. If not, ask user what to do."
18088 (when (not (file-exists-p file))
18089 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18090 (abbreviate-file-name file))
18091 (let ((r (downcase (read-char-exclusive))))
18092 (cond
18093 ((equal r ?r)
18094 (org-remove-file file)
18095 (throw 'nextfile t))
18096 (t (error "Abort"))))))
18098 (defun org-get-agenda-file-buffer (file)
18099 "Get a buffer visiting FILE. If the buffer needs to be created, add
18100 it to the list of buffers which might be released later."
18101 (let ((buf (org-find-base-buffer-visiting file)))
18102 (if buf
18103 buf ; just return it
18104 ;; Make a new buffer and remember it
18105 (setq buf (find-file-noselect file))
18106 (if buf (push buf org-agenda-new-buffers))
18107 buf)))
18109 (defun org-release-buffers (blist)
18110 "Release all buffers in list, asking the user for confirmation when needed.
18111 When a buffer is unmodified, it is just killed. When modified, it is saved
18112 \(if the user agrees) and then killed."
18113 (let (buf file)
18114 (while (setq buf (pop blist))
18115 (setq file (buffer-file-name buf))
18116 (when (and (buffer-modified-p buf)
18117 file
18118 (y-or-n-p (format "Save file %s? " file)))
18119 (with-current-buffer buf (save-buffer)))
18120 (kill-buffer buf))))
18122 (defun org-agenda-prepare-buffers (files)
18123 "Create buffers for all agenda files, protect archived trees and comments."
18124 (interactive)
18125 (let ((pa '(:org-archived t))
18126 (pc '(:org-comment t))
18127 (pall '(:org-archived t :org-comment t))
18128 (inhibit-read-only t)
18129 (org-inhibit-startup org-agenda-inhibit-startup)
18130 (rea (concat ":" org-archive-tag ":"))
18131 file re pos)
18132 (setq org-tag-alist-for-agenda nil
18133 org-tag-groups-alist-for-agenda nil)
18134 (save-excursion
18135 (save-restriction
18136 (while (setq file (pop files))
18137 (catch 'nextfile
18138 (if (bufferp file)
18139 (set-buffer file)
18140 (org-check-agenda-file file)
18141 (set-buffer (org-get-agenda-file-buffer file)))
18142 (widen)
18143 (org-set-regexps-and-options-for-tags)
18144 (setq pos (point))
18145 (goto-char (point-min))
18146 (let ((case-fold-search t))
18147 (when (search-forward "#+setupfile" nil t)
18148 ;; Don't set all regexps and options systematically as
18149 ;; this is only run for setting agenda tags from setup
18150 ;; file
18151 (org-set-regexps-and-options)))
18152 (or (memq 'category org-agenda-ignore-drawer-properties)
18153 (org-refresh-category-properties))
18154 (or (memq 'effort org-agenda-ignore-drawer-properties)
18155 (org-refresh-properties org-effort-property 'org-effort))
18156 (or (memq 'appt org-agenda-ignore-drawer-properties)
18157 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18158 (setq org-todo-keywords-for-agenda
18159 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18160 (setq org-done-keywords-for-agenda
18161 (append org-done-keywords-for-agenda org-done-keywords))
18162 (setq org-todo-keyword-alist-for-agenda
18163 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18164 (setq org-drawers-for-agenda
18165 (append org-drawers-for-agenda org-drawers))
18166 (setq org-tag-alist-for-agenda
18167 (org-uniquify
18168 (append org-tag-alist-for-agenda
18169 org-tag-alist
18170 org-tag-persistent-alist)))
18171 (if org-group-tags
18172 (setq org-tag-groups-alist-for-agenda
18173 (org-uniquify-alist
18174 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18175 (org-with-silent-modifications
18176 (save-excursion
18177 (remove-text-properties (point-min) (point-max) pall)
18178 (when org-agenda-skip-archived-trees
18179 (goto-char (point-min))
18180 (while (re-search-forward rea nil t)
18181 (if (org-at-heading-p t)
18182 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18183 (goto-char (point-min))
18184 (setq re (format org-heading-keyword-regexp-format
18185 org-comment-string))
18186 (while (re-search-forward re nil t)
18187 (add-text-properties
18188 (match-beginning 0) (org-end-of-subtree t) pc))))
18189 (goto-char pos)))))
18190 (setq org-todo-keywords-for-agenda
18191 (org-uniquify org-todo-keywords-for-agenda))
18192 (setq org-todo-keyword-alist-for-agenda
18193 (org-uniquify org-todo-keyword-alist-for-agenda))))
18196 ;;;; CDLaTeX minor mode
18198 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18199 "Keymap for the minor `org-cdlatex-mode'.")
18201 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18202 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18203 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18204 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18205 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18207 (defvar org-cdlatex-texmathp-advice-is-done nil
18208 "Flag remembering if we have applied the advice to texmathp already.")
18210 (define-minor-mode org-cdlatex-mode
18211 "Toggle the minor `org-cdlatex-mode'.
18212 This mode supports entering LaTeX environment and math in LaTeX fragments
18213 in Org-mode.
18214 \\{org-cdlatex-mode-map}"
18215 nil " OCDL" nil
18216 (when org-cdlatex-mode
18217 (require 'cdlatex)
18218 (run-hooks 'cdlatex-mode-hook)
18219 (cdlatex-compute-tables))
18220 (unless org-cdlatex-texmathp-advice-is-done
18221 (setq org-cdlatex-texmathp-advice-is-done t)
18222 (defadvice texmathp (around org-math-always-on activate)
18223 "Always return t in org-mode buffers.
18224 This is because we want to insert math symbols without dollars even outside
18225 the LaTeX math segments. If Orgmode thinks that point is actually inside
18226 an embedded LaTeX fragment, let texmathp do its job.
18227 \\[org-cdlatex-mode-map]"
18228 (interactive)
18229 (let (p)
18230 (cond
18231 ((not (derived-mode-p 'org-mode)) ad-do-it)
18232 ((eq this-command 'cdlatex-math-symbol)
18233 (setq ad-return-value t
18234 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18236 (let ((p (org-inside-LaTeX-fragment-p)))
18237 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18238 (setq ad-return-value t
18239 texmathp-why '("Org-mode embedded math" . 0))
18240 (if p ad-do-it)))))))))
18242 (defun turn-on-org-cdlatex ()
18243 "Unconditionally turn on `org-cdlatex-mode'."
18244 (org-cdlatex-mode 1))
18246 (defun org-try-cdlatex-tab ()
18247 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18248 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18249 - inside a LaTeX fragment, or
18250 - after the first word in a line, where an abbreviation expansion could
18251 insert a LaTeX environment."
18252 (when org-cdlatex-mode
18253 (cond
18254 ;; Before any word on the line: No expansion possible.
18255 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18256 ;; Just after first word on the line: Expand it. Make sure it
18257 ;; cannot happen on headlines, though.
18258 ((save-excursion
18259 (skip-chars-backward "a-zA-Z0-9*")
18260 (skip-chars-backward " \t")
18261 (and (bolp) (not (org-at-heading-p))))
18262 (cdlatex-tab) t)
18263 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18265 (defun org-cdlatex-underscore-caret (&optional arg)
18266 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18267 Revert to the normal definition outside of these fragments."
18268 (interactive "P")
18269 (if (org-inside-LaTeX-fragment-p)
18270 (call-interactively 'cdlatex-sub-superscript)
18271 (let (org-cdlatex-mode)
18272 (call-interactively (key-binding (vector last-input-event))))))
18274 (defun org-cdlatex-math-modify (&optional arg)
18275 "Execute `cdlatex-math-modify' in LaTeX fragments.
18276 Revert to the normal definition outside of these fragments."
18277 (interactive "P")
18278 (if (org-inside-LaTeX-fragment-p)
18279 (call-interactively 'cdlatex-math-modify)
18280 (let (org-cdlatex-mode)
18281 (call-interactively (key-binding (vector last-input-event))))))
18285 ;;;; LaTeX fragments
18287 (defvar org-latex-regexps
18288 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
18289 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18290 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
18291 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18292 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18293 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
18294 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
18295 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
18296 "Regular expressions for matching embedded LaTeX.")
18298 (defun org-inside-LaTeX-fragment-p ()
18299 "Test if point is inside a LaTeX fragment.
18300 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18301 sequence appearing also before point.
18302 Even though the matchers for math are configurable, this function assumes
18303 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18304 delimiters are skipped when they have been removed by customization.
18305 The return value is nil, or a cons cell with the delimiter and the
18306 position of this delimiter.
18308 This function does a reasonably good job, but can locally be fooled by
18309 for example currency specifications. For example it will assume being in
18310 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18311 fragments that are properly closed, but during editing, we have to live
18312 with the uncertainty caused by missing closing delimiters. This function
18313 looks only before point, not after."
18314 (catch 'exit
18315 (let ((pos (point))
18316 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18317 (lim (progn
18318 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18319 (point)))
18320 dd-on str (start 0) m re)
18321 (goto-char pos)
18322 (when dodollar
18323 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18324 re (nth 1 (assoc "$" org-latex-regexps)))
18325 (while (string-match re str start)
18326 (cond
18327 ((= (match-end 0) (length str))
18328 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18329 ((= (match-end 0) (- (length str) 5))
18330 (throw 'exit nil))
18331 (t (setq start (match-end 0))))))
18332 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18333 (goto-char pos)
18334 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18335 (and (match-beginning 2) (throw 'exit nil))
18336 ;; count $$
18337 (while (re-search-backward "\\$\\$" lim t)
18338 (setq dd-on (not dd-on)))
18339 (goto-char pos)
18340 (if dd-on (cons "$$" m))))))
18342 (defun org-inside-latex-macro-p ()
18343 "Is point inside a LaTeX macro or its arguments?"
18344 (save-match-data
18345 (org-in-regexp
18346 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18348 (defvar org-latex-fragment-image-overlays nil
18349 "List of overlays carrying the images of latex fragments.")
18350 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18352 (defun org-remove-latex-fragment-image-overlays ()
18353 "Remove all overlays with LaTeX fragment images in current buffer."
18354 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18355 (setq org-latex-fragment-image-overlays nil))
18357 (defun org-preview-latex-fragment (&optional subtree)
18358 "Preview the LaTeX fragment at point, or all locally or globally.
18359 If the cursor is in a LaTeX fragment, create the image and overlay
18360 it over the source code. If there is no fragment at point, display
18361 all fragments in the current text, from one headline to the next. With
18362 prefix SUBTREE, display all fragments in the current subtree. With a
18363 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18364 the cursor is before the first headline,
18365 display all fragments in the buffer.
18366 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18367 (interactive "P")
18368 (unless buffer-file-name
18369 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18370 (when (display-graphic-p)
18371 (org-remove-latex-fragment-image-overlays)
18372 (save-excursion
18373 (save-restriction
18374 (let (beg end at msg)
18375 (cond
18376 ((or (equal subtree '(16))
18377 (not (save-excursion
18378 (re-search-backward org-outline-regexp-bol nil t))))
18379 (setq beg (point-min) end (point-max)
18380 msg "Creating images for buffer...%s"))
18381 ((equal subtree '(4))
18382 (org-back-to-heading)
18383 (setq beg (point) end (org-end-of-subtree t)
18384 msg "Creating images for subtree...%s"))
18386 (if (setq at (org-inside-LaTeX-fragment-p))
18387 (goto-char (max (point-min) (- (cdr at) 2)))
18388 (org-back-to-heading))
18389 (setq beg (point) end (progn (outline-next-heading) (point))
18390 msg (if at "Creating image...%s"
18391 "Creating images for entry...%s"))))
18392 (message msg "")
18393 (narrow-to-region beg end)
18394 (goto-char beg)
18395 (org-format-latex
18396 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18397 (file-name-nondirectory
18398 buffer-file-name)))
18399 default-directory 'overlays msg at 'forbuffer
18400 org-latex-create-formula-image-program)
18401 (message msg "done. Use `C-c C-c' to remove images."))))))
18403 (defun org-format-latex (prefix &optional dir overlays msg at
18404 forbuffer processing-type)
18405 "Replace LaTeX fragments with links to an image, and produce images.
18406 Some of the options can be changed using the variable
18407 `org-format-latex-options'."
18408 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18409 (let* ((prefixnodir (file-name-nondirectory prefix))
18410 (absprefix (expand-file-name prefix dir))
18411 (todir (file-name-directory absprefix))
18412 (opt org-format-latex-options)
18413 (optnew org-format-latex-options)
18414 (matchers (plist-get opt :matchers))
18415 (re-list org-latex-regexps)
18416 (cnt 0) txt hash link beg end re e checkdir
18417 string
18418 m n block-type block linkfile movefile ov)
18419 ;; Check the different regular expressions
18420 (while (setq e (pop re-list))
18421 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18422 block (if block-type "\n\n" ""))
18423 (when (member m matchers)
18424 (goto-char (point-min))
18425 (while (re-search-forward re nil t)
18426 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18427 (or (not overlays)
18428 (not (eq (get-char-property (match-beginning n)
18429 'org-overlay-type)
18430 'org-latex-overlay))))
18431 (cond
18432 ((eq processing-type 'verbatim))
18433 ((eq processing-type 'mathjax)
18434 ;; Prepare for MathJax processing.
18435 (setq string (match-string n))
18436 (when (member m '("$" "$1"))
18437 (save-excursion
18438 (delete-region (match-beginning n) (match-end n))
18439 (goto-char (match-beginning n))
18440 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18441 ((or (eq processing-type 'dvipng)
18442 (eq processing-type 'imagemagick))
18443 ;; Process to an image.
18444 (setq txt (match-string n)
18445 beg (match-beginning n) end (match-end n)
18446 cnt (1+ cnt))
18447 (let ((face (face-at-point))
18448 (fg (plist-get opt :foreground))
18449 (bg (plist-get opt :background))
18450 ;; Ensure full list is printed.
18451 print-length print-level)
18452 (when forbuffer
18453 ;; Get the colors from the face at point.
18454 (goto-char beg)
18455 (when (eq fg 'auto)
18456 (setq fg (face-attribute face :foreground nil 'default)))
18457 (when (eq bg 'auto)
18458 (setq bg (face-attribute face :background nil 'default)))
18459 (setq optnew (copy-sequence opt))
18460 (plist-put optnew :foreground fg)
18461 (plist-put optnew :background bg))
18462 (setq hash (sha1 (prin1-to-string
18463 (list org-format-latex-header
18464 org-latex-default-packages-alist
18465 org-latex-packages-alist
18466 org-format-latex-options
18467 forbuffer txt fg bg)))
18468 linkfile (format "%s_%s.png" prefix hash)
18469 movefile (format "%s_%s.png" absprefix hash)))
18470 (setq link (concat block "[[file:" linkfile "]]" block))
18471 (if msg (message msg cnt))
18472 (goto-char beg)
18473 (unless checkdir ; Ensure the directory exists.
18474 (setq checkdir t)
18475 (or (file-directory-p todir) (make-directory todir t)))
18476 (unless (file-exists-p movefile)
18477 (org-create-formula-image
18478 txt movefile optnew forbuffer processing-type))
18479 (if overlays
18480 (progn
18481 (mapc (lambda (o)
18482 (if (eq (overlay-get o 'org-overlay-type)
18483 'org-latex-overlay)
18484 (delete-overlay o)))
18485 (overlays-in beg end))
18486 (setq ov (make-overlay beg end))
18487 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18488 (if (featurep 'xemacs)
18489 (progn
18490 (overlay-put ov 'invisible t)
18491 (overlay-put
18492 ov 'end-glyph
18493 (make-glyph (vector 'png :file movefile))))
18494 (overlay-put
18495 ov 'display
18496 (list 'image :type 'png :file movefile :ascent 'center)))
18497 (push ov org-latex-fragment-image-overlays)
18498 (goto-char end))
18499 (delete-region beg end)
18500 (insert (org-add-props link
18501 (list 'org-latex-src
18502 (replace-regexp-in-string
18503 "\"" "" txt)
18504 'org-latex-src-embed-type
18505 (if block-type 'paragraph 'character))))))
18506 ((eq processing-type 'mathml)
18507 ;; Process to MathML
18508 (unless (save-match-data (org-format-latex-mathml-available-p))
18509 (user-error "LaTeX to MathML converter not configured"))
18510 (setq txt (match-string n)
18511 beg (match-beginning n) end (match-end n)
18512 cnt (1+ cnt))
18513 (if msg (message msg cnt))
18514 (goto-char beg)
18515 (delete-region beg end)
18516 (insert (org-format-latex-as-mathml
18517 txt block-type prefix dir)))
18519 (error "Unknown conversion type %s for LaTeX fragments"
18520 processing-type)))))))))
18522 (defun org-create-math-formula (latex-frag &optional mathml-file)
18523 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18524 Use `org-latex-to-mathml-convert-command'. If the conversion is
18525 sucessful, return the portion between \"<math...> </math>\"
18526 elements otherwise return nil. When MATHML-FILE is specified,
18527 write the results in to that file. When invoked as an
18528 interactive command, prompt for LATEX-FRAG, with initial value
18529 set to the current active region and echo the results for user
18530 inspection."
18531 (interactive (list (let ((frag (when (org-region-active-p)
18532 (buffer-substring-no-properties
18533 (region-beginning) (region-end)))))
18534 (read-string "LaTeX Fragment: " frag nil frag))))
18535 (unless latex-frag (error "Invalid LaTeX fragment"))
18536 (let* ((tmp-in-file (file-relative-name
18537 (make-temp-name (expand-file-name "ltxmathml-in"))))
18538 (ignore (write-region latex-frag nil tmp-in-file))
18539 (tmp-out-file (file-relative-name
18540 (make-temp-name (expand-file-name "ltxmathml-out"))))
18541 (cmd (format-spec
18542 org-latex-to-mathml-convert-command
18543 `((?j . ,(shell-quote-argument
18544 (expand-file-name org-latex-to-mathml-jar-file)))
18545 (?I . ,(shell-quote-argument tmp-in-file))
18546 (?o . ,(shell-quote-argument tmp-out-file)))))
18547 mathml shell-command-output)
18548 (when (org-called-interactively-p 'any)
18549 (unless (org-format-latex-mathml-available-p)
18550 (user-error "LaTeX to MathML converter not configured")))
18551 (message "Running %s" cmd)
18552 (setq shell-command-output (shell-command-to-string cmd))
18553 (setq mathml
18554 (when (file-readable-p tmp-out-file)
18555 (with-current-buffer (find-file-noselect tmp-out-file t)
18556 (goto-char (point-min))
18557 (when (re-search-forward
18558 (concat
18559 (regexp-quote
18560 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18561 "\\(.\\|\n\\)*"
18562 (regexp-quote "</math>")) nil t)
18563 (prog1 (match-string 0) (kill-buffer))))))
18564 (cond
18565 (mathml
18566 (setq mathml
18567 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18568 (when mathml-file
18569 (write-region mathml nil mathml-file))
18570 (when (org-called-interactively-p 'any)
18571 (message mathml)))
18572 ((message "LaTeX to MathML conversion failed")
18573 (message shell-command-output)))
18574 (delete-file tmp-in-file)
18575 (when (file-exists-p tmp-out-file)
18576 (delete-file tmp-out-file))
18577 mathml))
18579 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18580 prefix &optional dir)
18581 "Use `org-create-math-formula' but check local cache first."
18582 (let* ((absprefix (expand-file-name prefix dir))
18583 (print-length nil) (print-level nil)
18584 (formula-id (concat
18585 "formula-"
18586 (sha1
18587 (prin1-to-string
18588 (list latex-frag
18589 org-latex-to-mathml-convert-command)))))
18590 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18591 (formula-cache-dir (file-name-directory formula-cache)))
18593 (unless (file-directory-p formula-cache-dir)
18594 (make-directory formula-cache-dir t))
18596 (unless (file-exists-p formula-cache)
18597 (org-create-math-formula latex-frag formula-cache))
18599 (if (file-exists-p formula-cache)
18600 ;; Successful conversion. Return the link to MathML file.
18601 (org-add-props
18602 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18603 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18604 'org-latex-src-embed-type (if latex-frag-type
18605 'paragraph 'character)))
18606 ;; Failed conversion. Return the LaTeX fragment verbatim
18607 latex-frag)))
18609 (defun org-create-formula-image (string tofile options buffer &optional type)
18610 "Create an image from LaTeX source using dvipng or convert.
18611 This function calls either `org-create-formula-image-with-dvipng'
18612 or `org-create-formula-image-with-imagemagick' depending on the
18613 value of `org-latex-create-formula-image-program' or on the value
18614 of the optional TYPE variable.
18616 Note: ultimately these two function should be combined as they
18617 share a good deal of logic."
18618 (org-check-external-command
18619 "latex" "needed to convert LaTeX fragments to images")
18620 (funcall
18621 (case (or type org-latex-create-formula-image-program)
18622 ('dvipng
18623 (org-check-external-command
18624 "dvipng" "needed to convert LaTeX fragments to images")
18625 #'org-create-formula-image-with-dvipng)
18626 ('imagemagick
18627 (org-check-external-command
18628 "convert" "you need to install imagemagick")
18629 #'org-create-formula-image-with-imagemagick)
18630 (t (error
18631 "Invalid value of `org-latex-create-formula-image-program'")))
18632 string tofile options buffer))
18634 (declare-function org-export-get-backend "ox" (name))
18635 (declare-function org-export--get-global-options "ox" (&optional backend))
18636 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18637 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18638 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18639 (defun org-create-formula--latex-header ()
18640 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18641 (let ((info (org-combine-plists (org-export--get-global-options
18642 (org-export-get-backend 'latex))
18643 (org-export--get-inbuffer-options
18644 (org-export-get-backend 'latex)))))
18645 (org-latex-guess-babel-language
18646 (org-latex-guess-inputenc
18647 (org-splice-latex-header
18648 org-format-latex-header
18649 org-latex-default-packages-alist
18650 org-latex-packages-alist t
18651 (plist-get info :latex-header)))
18652 info)))
18654 ;; This function borrows from Ganesh Swami's latex2png.el
18655 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18656 "This calls dvipng."
18657 (require 'ox-latex)
18658 (let* ((tmpdir (if (featurep 'xemacs)
18659 (temp-directory)
18660 temporary-file-directory))
18661 (texfilebase (make-temp-name
18662 (expand-file-name "orgtex" tmpdir)))
18663 (texfile (concat texfilebase ".tex"))
18664 (dvifile (concat texfilebase ".dvi"))
18665 (pngfile (concat texfilebase ".png"))
18666 (fnh (if (featurep 'xemacs)
18667 (font-height (face-font 'default))
18668 (face-attribute 'default :height nil)))
18669 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18670 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18671 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18672 "Black"))
18673 (bg (or (plist-get options (if buffer :background :html-background))
18674 "Transparent")))
18675 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18676 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18677 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18678 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18679 (let ((latex-header (org-create-formula--latex-header)))
18680 (with-temp-file texfile
18681 (insert latex-header)
18682 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18683 (let ((dir default-directory))
18684 (condition-case nil
18685 (progn
18686 (cd tmpdir)
18687 (call-process "latex" nil nil nil texfile))
18688 (error nil))
18689 (cd dir))
18690 (if (not (file-exists-p dvifile))
18691 (progn (message "Failed to create dvi file from %s" texfile) nil)
18692 (condition-case nil
18693 (if (featurep 'xemacs)
18694 (call-process "dvipng" nil nil nil
18695 "-fg" fg "-bg" bg
18696 "-T" "tight"
18697 "-o" pngfile
18698 dvifile)
18699 (call-process "dvipng" nil nil nil
18700 "-fg" fg "-bg" bg
18701 "-D" dpi
18702 ;;"-x" scale "-y" scale
18703 "-T" "tight"
18704 "-o" pngfile
18705 dvifile))
18706 (error nil))
18707 (if (not (file-exists-p pngfile))
18708 (if org-format-latex-signal-error
18709 (error "Failed to create png file from %s" texfile)
18710 (message "Failed to create png file from %s" texfile)
18711 nil)
18712 ;; Use the requested file name and clean up
18713 (copy-file pngfile tofile 'replace)
18714 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18715 (if (file-exists-p (concat texfilebase e))
18716 (delete-file (concat texfilebase e))))
18717 pngfile))))
18719 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18720 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18721 "This calls convert, which is included into imagemagick."
18722 (require 'ox-latex)
18723 (let* ((tmpdir (if (featurep 'xemacs)
18724 (temp-directory)
18725 temporary-file-directory))
18726 (texfilebase (make-temp-name
18727 (expand-file-name "orgtex" tmpdir)))
18728 (texfile (concat texfilebase ".tex"))
18729 (pdffile (concat texfilebase ".pdf"))
18730 (pngfile (concat texfilebase ".png"))
18731 (fnh (if (featurep 'xemacs)
18732 (font-height (face-font 'default))
18733 (face-attribute 'default :height nil)))
18734 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18735 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18736 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18737 "black"))
18738 (bg (or (plist-get options (if buffer :background :html-background))
18739 "white")))
18740 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18741 (setq fg (org-latex-color-format fg)))
18742 (if (eq bg 'default) (setq bg (org-latex-color :background))
18743 (setq bg (org-latex-color-format
18744 (if (string= bg "Transparent") "white" bg))))
18745 (let ((latex-header (org-create-formula--latex-header)))
18746 (with-temp-file texfile
18747 (insert latex-header)
18748 (insert "\n\\begin{document}\n"
18749 "\\definecolor{fg}{rgb}{" fg "}\n"
18750 "\\definecolor{bg}{rgb}{" bg "}\n"
18751 "\n\\pagecolor{bg}\n"
18752 "\n{\\color{fg}\n"
18753 string
18754 "\n}\n"
18755 "\n\\end{document}\n")))
18756 (org-latex-compile texfile t)
18757 (if (not (file-exists-p pdffile))
18758 (progn (message "Failed to create pdf file from %s" texfile) nil)
18759 (condition-case nil
18760 (if (featurep 'xemacs)
18761 (call-process "convert" nil nil nil
18762 "-density" "96"
18763 "-trim"
18764 "-antialias"
18765 pdffile
18766 "-quality" "100"
18767 ;; "-sharpen" "0x1.0"
18768 pngfile)
18769 (call-process "convert" nil nil nil
18770 "-density" dpi
18771 "-trim"
18772 "-antialias"
18773 pdffile
18774 "-quality" "100"
18775 ;; "-sharpen" "0x1.0"
18776 pngfile))
18777 (error nil))
18778 (if (not (file-exists-p pngfile))
18779 (if org-format-latex-signal-error
18780 (error "Failed to create png file from %s" texfile)
18781 (message "Failed to create png file from %s" texfile)
18782 nil)
18783 ;; Use the requested file name and clean up
18784 (copy-file pngfile tofile 'replace)
18785 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18786 (if (file-exists-p (concat texfilebase e))
18787 (delete-file (concat texfilebase e))))
18788 pngfile))))
18790 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18791 "Fill a LaTeX header template TPL.
18792 In the template, the following place holders will be recognized:
18794 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18795 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18796 [PACKAGES] \\usepackage statements for PKG
18797 [NO-PACKAGES] do not include PKG
18798 [EXTRA] the string EXTRA
18799 [NO-EXTRA] do not include EXTRA
18801 For backward compatibility, if both the positive and the negative place
18802 holder is missing, the positive one (without the \"NO-\") will be
18803 assumed to be present at the end of the template.
18804 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18805 EXTRA is a string.
18806 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18807 (let (rpl (end ""))
18808 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18809 (setq rpl (if (or (match-end 1) (not def-pkg))
18810 "" (org-latex-packages-to-string def-pkg snippets-p t))
18811 tpl (replace-match rpl t t tpl))
18812 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18814 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18815 (setq rpl (if (or (match-end 1) (not pkg))
18816 "" (org-latex-packages-to-string pkg snippets-p t))
18817 tpl (replace-match rpl t t tpl))
18818 (if pkg (setq end
18819 (concat end "\n"
18820 (org-latex-packages-to-string pkg snippets-p)))))
18822 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18823 (setq rpl (if (or (match-end 1) (not extra))
18824 "" (concat extra "\n"))
18825 tpl (replace-match rpl t t tpl))
18826 (if (and extra (string-match "\\S-" extra))
18827 (setq end (concat end "\n" extra))))
18829 (if (string-match "\\S-" end)
18830 (concat tpl "\n" end)
18831 tpl)))
18833 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18834 "Turn an alist of packages into a string with the \\usepackage macros."
18835 (setq pkg (mapconcat (lambda(p)
18836 (cond
18837 ((stringp p) p)
18838 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18839 (format "%% Package %s omitted" (cadr p)))
18840 ((equal "" (car p))
18841 (format "\\usepackage{%s}" (cadr p)))
18843 (format "\\usepackage[%s]{%s}"
18844 (car p) (cadr p)))))
18846 "\n"))
18847 (if newline (concat pkg "\n") pkg))
18849 (defun org-dvipng-color (attr)
18850 "Return a RGB color specification for dvipng."
18851 (apply 'format "rgb %s %s %s"
18852 (mapcar 'org-normalize-color
18853 (if (featurep 'xemacs)
18854 (color-rgb-components
18855 (face-property 'default
18856 (cond ((eq attr :foreground) 'foreground)
18857 ((eq attr :background) 'background))))
18858 (color-values (face-attribute 'default attr nil))))))
18860 (defun org-dvipng-color-format (color-name)
18861 "Convert COLOR-NAME to a RGB color value for dvipng."
18862 (apply 'format "rgb %s %s %s"
18863 (mapcar 'org-normalize-color
18864 (color-values color-name))))
18866 (defun org-latex-color (attr)
18867 "Return a RGB color for the LaTeX color package."
18868 (apply 'format "%s,%s,%s"
18869 (mapcar 'org-normalize-color
18870 (if (featurep 'xemacs)
18871 (color-rgb-components
18872 (face-property 'default
18873 (cond ((eq attr :foreground) 'foreground)
18874 ((eq attr :background) 'background))))
18875 (color-values (face-attribute 'default attr nil))))))
18877 (defun org-latex-color-format (color-name)
18878 "Convert COLOR-NAME to a RGB color value."
18879 (apply 'format "%s,%s,%s"
18880 (mapcar 'org-normalize-color
18881 (color-values color-name))))
18883 (defun org-normalize-color (value)
18884 "Return string to be used as color value for an RGB component."
18885 (format "%g" (/ value 65535.0)))
18889 ;; Image display
18891 (defvar org-inline-image-overlays nil)
18892 (make-variable-buffer-local 'org-inline-image-overlays)
18894 (defun org-toggle-inline-images (&optional include-linked)
18895 "Toggle the display of inline images.
18896 INCLUDE-LINKED is passed to `org-display-inline-images'."
18897 (interactive "P")
18898 (if org-inline-image-overlays
18899 (progn
18900 (org-remove-inline-images)
18901 (message "Inline image display turned off"))
18902 (org-display-inline-images include-linked)
18903 (if (and (org-called-interactively-p)
18904 org-inline-image-overlays)
18905 (message "%d images displayed inline"
18906 (length org-inline-image-overlays))
18907 (message "No images to display inline"))))
18909 (defun org-redisplay-inline-images ()
18910 "Refresh the display of inline images."
18911 (interactive)
18912 (if (not org-inline-image-overlays)
18913 (org-toggle-inline-images)
18914 (org-toggle-inline-images)
18915 (org-toggle-inline-images)))
18917 (defun org-display-inline-images (&optional include-linked refresh beg end)
18918 "Display inline images.
18919 Normally only links without a description part are inlined, because this
18920 is how it will work for export. When INCLUDE-LINKED is set, also links
18921 with a description part will be inlined. This can be nice for a quick
18922 look at those images, but it does not reflect what exported files will look
18923 like.
18924 When REFRESH is set, refresh existing images between BEG and END.
18925 This will create new image displays only if necessary.
18926 BEG and END default to the buffer boundaries."
18927 (interactive "P")
18928 (when (display-graphic-p)
18929 (unless refresh
18930 (org-remove-inline-images)
18931 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18932 (save-excursion
18933 (save-restriction
18934 (widen)
18935 (setq beg (or beg (point-min)) end (or end (point-max)))
18936 (goto-char beg)
18937 (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
18938 (substring (org-image-file-name-regexp) 0 -2)
18939 "\\)\\]" (if include-linked "" "\\]")))
18940 (case-fold-search t)
18941 old file ov img type attrwidth width)
18942 (while (re-search-forward re end t)
18943 (setq old (get-char-property-and-overlay (match-beginning 1)
18944 'org-image-overlay)
18945 file (expand-file-name
18946 (concat (or (match-string 3) "") (match-string 4))))
18947 (when (image-type-available-p 'imagemagick)
18948 (setq attrwidth (if (or (listp org-image-actual-width)
18949 (null org-image-actual-width))
18950 (save-excursion
18951 (save-match-data
18952 (when (re-search-backward
18953 "#\\+attr.*:width[ \t]+\\([^ ]+\\)"
18954 (save-excursion
18955 (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
18956 (string-to-number (match-string 1))))))
18957 width (cond ((eq org-image-actual-width t) nil)
18958 ((null org-image-actual-width) attrwidth)
18959 ((numberp org-image-actual-width)
18960 org-image-actual-width)
18961 ((listp org-image-actual-width)
18962 (or attrwidth (car org-image-actual-width))))
18963 type (if width 'imagemagick)))
18964 (when (file-exists-p file)
18965 (if (and (car-safe old) refresh)
18966 (image-refresh (overlay-get (cdr old) 'display))
18967 (setq img (save-match-data (create-image file type nil :width width)))
18968 (when img
18969 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18970 (overlay-put ov 'display img)
18971 (overlay-put ov 'face 'default)
18972 (overlay-put ov 'org-image-overlay t)
18973 (overlay-put ov 'modification-hooks
18974 (list 'org-display-inline-remove-overlay))
18975 (push ov org-inline-image-overlays))))))))))
18977 (define-obsolete-function-alias
18978 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18980 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18981 "Remove inline-display overlay if a corresponding region is modified."
18982 (let ((inhibit-modification-hooks t))
18983 (when (and ov after)
18984 (delete ov org-inline-image-overlays)
18985 (delete-overlay ov))))
18987 (defun org-remove-inline-images ()
18988 "Remove inline display of images."
18989 (interactive)
18990 (mapc 'delete-overlay org-inline-image-overlays)
18991 (setq org-inline-image-overlays nil))
18993 ;;;; Key bindings
18995 ;; Outline functions from `outline-mode-prefix-map'
18996 ;; that can be remapped in Org:
18997 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18998 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18999 (define-key org-mode-map [remap outline-forward-same-level]
19000 'org-forward-heading-same-level)
19001 (define-key org-mode-map [remap outline-backward-same-level]
19002 'org-backward-heading-same-level)
19003 (define-key org-mode-map [remap show-branches]
19004 'org-kill-note-or-show-branches)
19005 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19006 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19007 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19009 ;; Outline functions from `outline-mode-prefix-map' that can not
19010 ;; be remapped in Org:
19012 ;; - the column "key binding" shows whether the Outline function is still
19013 ;; available in Org mode on the same key that it has been bound to in
19014 ;; Outline mode:
19015 ;; - "overridden": key used for a different functionality in Org mode
19016 ;; - else: key still bound to the same Outline function in Org mode
19018 ;; | Outline function | key binding | Org replacement |
19019 ;; |------------------------------------+-------------+-----------------------|
19020 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19021 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19022 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19023 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19024 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19025 ;; | `show-entry' | overridden | no replacement |
19026 ;; | `show-children' | `C-c C-i' | visibility cycling |
19027 ;; | `show-branches' | `C-c C-k' | still same function |
19028 ;; | `show-subtree' | overridden | visibility cycling |
19029 ;; | `show-all' | overridden | no replacement |
19030 ;; | `hide-subtree' | overridden | visibility cycling |
19031 ;; | `hide-body' | overridden | no replacement |
19032 ;; | `hide-entry' | overridden | visibility cycling |
19033 ;; | `hide-leaves' | overridden | no replacement |
19034 ;; | `hide-sublevels' | overridden | no replacement |
19035 ;; | `hide-other' | overridden | no replacement |
19037 ;; Make `C-c C-x' a prefix key
19038 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19040 ;; TAB key with modifiers
19041 (org-defkey org-mode-map "\C-i" 'org-cycle)
19042 (org-defkey org-mode-map [(tab)] 'org-cycle)
19043 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19044 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19045 ;; The following line is necessary under Suse GNU/Linux
19046 (unless (featurep 'xemacs)
19047 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19048 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19049 (define-key org-mode-map [backtab] 'org-shifttab)
19051 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19052 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19053 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19055 ;; Cursor keys with modifiers
19056 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19057 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19058 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19059 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19061 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19062 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19063 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19064 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19066 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19067 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19068 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19069 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19071 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19072 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19073 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19074 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19076 ;; Babel keys
19077 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19078 (mapc (lambda (pair)
19079 (define-key org-babel-map (car pair) (cdr pair)))
19080 org-babel-key-bindings)
19082 ;;; Extra keys for tty access.
19083 ;; We only set them when really needed because otherwise the
19084 ;; menus don't show the simple keys
19086 (when (or org-use-extra-keys
19087 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19088 (not window-system))
19089 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19090 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19091 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19092 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19093 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19094 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19095 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19096 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19097 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19098 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19099 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19100 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19101 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19102 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19103 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19104 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19105 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19106 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19107 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19108 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19109 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19110 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19111 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19112 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19113 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19114 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19115 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19116 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19118 ;; All the other keys
19120 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19121 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19122 (if (boundp 'narrow-map)
19123 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19124 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19125 (if (boundp 'narrow-map)
19126 (org-defkey narrow-map "b" 'org-narrow-to-block)
19127 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19128 (if (boundp 'narrow-map)
19129 (org-defkey narrow-map "e" 'org-narrow-to-element)
19130 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19131 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19132 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19133 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19134 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19135 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19136 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19137 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19138 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19139 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19140 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19141 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19142 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19143 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19144 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19145 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19146 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19147 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19148 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19149 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19150 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19151 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19152 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19153 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19154 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19155 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19156 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19157 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19158 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19159 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19160 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19161 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19162 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19163 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19164 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19165 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19166 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19167 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19168 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19169 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19170 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19171 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19172 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19173 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19174 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19175 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19176 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19177 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19178 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19179 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19180 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19181 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19182 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19183 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19184 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19185 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19186 (org-defkey org-mode-map "\C-c^" 'org-sort)
19187 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19188 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19189 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19190 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19191 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19192 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19193 (org-defkey org-mode-map "\C-m" 'org-return)
19194 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19195 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19196 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19197 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19198 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19199 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19200 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19201 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19202 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19203 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19204 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19205 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19206 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19207 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19208 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19209 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19210 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19211 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19212 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19213 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19214 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19215 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19216 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19218 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19219 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19220 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19222 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19223 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19224 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19225 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19226 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19227 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19228 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19229 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19230 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19231 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19232 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19233 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19234 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19235 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19236 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19237 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19238 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19239 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19240 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19241 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19242 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19243 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19244 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19246 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19247 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19248 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19249 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19250 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19252 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19254 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19256 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19257 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19259 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19262 (when (featurep 'xemacs)
19263 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19266 (defconst org-speed-commands-default
19268 ("Outline Navigation")
19269 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19270 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19271 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19272 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19273 ("F" . org-next-block)
19274 ("B" . org-previous-block)
19275 ("u" . (org-speed-move-safe 'outline-up-heading))
19276 ("j" . org-goto)
19277 ("g" . (org-refile t))
19278 ("Outline Visibility")
19279 ("c" . org-cycle)
19280 ("C" . org-shifttab)
19281 (" " . org-display-outline-path)
19282 ("s" . org-narrow-to-subtree)
19283 ("=" . org-columns)
19284 ("Outline Structure Editing")
19285 ("U" . org-shiftmetaup)
19286 ("D" . org-shiftmetadown)
19287 ("r" . org-metaright)
19288 ("l" . org-metaleft)
19289 ("R" . org-shiftmetaright)
19290 ("L" . org-shiftmetaleft)
19291 ("i" . (progn (forward-char 1) (call-interactively
19292 'org-insert-heading-respect-content)))
19293 ("^" . org-sort)
19294 ("w" . org-refile)
19295 ("a" . org-archive-subtree-default-with-confirmation)
19296 ("@" . org-mark-subtree)
19297 ("#" . org-toggle-comment)
19298 ("Clock Commands")
19299 ("I" . org-clock-in)
19300 ("O" . org-clock-out)
19301 ("Meta Data Editing")
19302 ("t" . org-todo)
19303 ("," . (org-priority))
19304 ("0" . (org-priority ?\ ))
19305 ("1" . (org-priority ?A))
19306 ("2" . (org-priority ?B))
19307 ("3" . (org-priority ?C))
19308 (":" . org-set-tags-command)
19309 ("e" . org-set-effort)
19310 ("E" . org-inc-effort)
19311 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19312 (org-entry-put (point) "APPT_WARNTIME" m)))
19313 ("Agenda Views etc")
19314 ("v" . org-agenda)
19315 ("/" . org-sparse-tree)
19316 ("Misc")
19317 ("o" . org-open-at-point)
19318 ("?" . org-speed-command-help)
19319 ("<" . (org-agenda-set-restriction-lock 'subtree))
19320 (">" . (org-agenda-remove-restriction-lock))
19322 "The default speed commands.")
19324 (defun org-print-speed-command (e)
19325 (if (> (length (car e)) 1)
19326 (progn
19327 (princ "\n")
19328 (princ (car e))
19329 (princ "\n")
19330 (princ (make-string (length (car e)) ?-))
19331 (princ "\n"))
19332 (princ (car e))
19333 (princ " ")
19334 (if (symbolp (cdr e))
19335 (princ (symbol-name (cdr e)))
19336 (prin1 (cdr e)))
19337 (princ "\n")))
19339 (defun org-speed-command-help ()
19340 "Show the available speed commands."
19341 (interactive)
19342 (if (not org-use-speed-commands)
19343 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19344 (with-output-to-temp-buffer "*Help*"
19345 (princ "User-defined Speed commands\n===========================\n")
19346 (mapc 'org-print-speed-command org-speed-commands-user)
19347 (princ "\n")
19348 (princ "Built-in Speed commands\n=======================\n")
19349 (mapc 'org-print-speed-command org-speed-commands-default))
19350 (with-current-buffer "*Help*"
19351 (setq truncate-lines t))))
19353 (defun org-speed-move-safe (cmd)
19354 "Execute CMD, but make sure that the cursor always ends up in a headline.
19355 If not, return to the original position and throw an error."
19356 (interactive)
19357 (let ((pos (point)))
19358 (call-interactively cmd)
19359 (unless (and (bolp) (org-at-heading-p))
19360 (goto-char pos)
19361 (error "Boundary reached while executing %s" cmd))))
19363 (defvar org-self-insert-command-undo-counter 0)
19365 (defvar org-table-auto-blank-field) ; defined in org-table.el
19366 (defvar org-speed-command nil)
19368 (define-obsolete-function-alias
19369 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19371 (defun org-speed-command-activate (keys)
19372 "Hook for activating single-letter speed commands.
19373 `org-speed-commands-default' specifies a minimal command set.
19374 Use `org-speed-commands-user' for further customization."
19375 (when (or (and (bolp) (looking-at org-outline-regexp))
19376 (and (functionp org-use-speed-commands)
19377 (funcall org-use-speed-commands)))
19378 (cdr (assoc keys (append org-speed-commands-user
19379 org-speed-commands-default)))))
19381 (define-obsolete-function-alias
19382 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19384 (defun org-babel-speed-command-activate (keys)
19385 "Hook for activating single-letter code block commands."
19386 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19387 (cdr (assoc keys org-babel-key-bindings))))
19389 (defcustom org-speed-command-hook
19390 '(org-speed-command-default-hook org-babel-speed-command-hook)
19391 "Hook for activating speed commands at strategic locations.
19392 Hook functions are called in sequence until a valid handler is
19393 found.
19395 Each hook takes a single argument, a user-pressed command key
19396 which is also a `self-insert-command' from the global map.
19398 Within the hook, examine the cursor position and the command key
19399 and return nil or a valid handler as appropriate. Handler could
19400 be one of an interactive command, a function, or a form.
19402 Set `org-use-speed-commands' to non-nil value to enable this
19403 hook. The default setting is `org-speed-command-activate'."
19404 :group 'org-structure
19405 :version "24.1"
19406 :type 'hook)
19408 (defun org-self-insert-command (N)
19409 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19410 If the cursor is in a table looking at whitespace, the whitespace is
19411 overwritten, and the table is not marked as requiring realignment."
19412 (interactive "p")
19413 (org-check-before-invisible-edit 'insert)
19414 (cond
19415 ((and org-use-speed-commands
19416 (setq org-speed-command
19417 (run-hook-with-args-until-success
19418 'org-speed-command-hook (this-command-keys))))
19419 (cond
19420 ((commandp org-speed-command)
19421 (setq this-command org-speed-command)
19422 (call-interactively org-speed-command))
19423 ((functionp org-speed-command)
19424 (funcall org-speed-command))
19425 ((and org-speed-command (listp org-speed-command))
19426 (eval org-speed-command))
19427 (t (let (org-use-speed-commands)
19428 (call-interactively 'org-self-insert-command)))))
19429 ((and
19430 (org-table-p)
19431 (progn
19432 ;; check if we blank the field, and if that triggers align
19433 (and (featurep 'org-table) org-table-auto-blank-field
19434 (member last-command
19435 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19436 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19437 ;; got extra space, this field does not determine column width
19438 (let (org-table-may-need-update) (org-table-blank-field))
19439 ;; no extra space, this field may determine column width
19440 (org-table-blank-field)))
19442 (eq N 1)
19443 (looking-at "[^|\n]* |"))
19444 (let (org-table-may-need-update)
19445 (goto-char (1- (match-end 0)))
19446 (backward-delete-char 1)
19447 (goto-char (match-beginning 0))
19448 (self-insert-command N)))
19450 (setq org-table-may-need-update t)
19451 (self-insert-command N)
19452 (org-fix-tags-on-the-fly)
19453 (if org-self-insert-cluster-for-undo
19454 (if (not (eq last-command 'org-self-insert-command))
19455 (setq org-self-insert-command-undo-counter 1)
19456 (if (>= org-self-insert-command-undo-counter 20)
19457 (setq org-self-insert-command-undo-counter 1)
19458 (and (> org-self-insert-command-undo-counter 0)
19459 buffer-undo-list (listp buffer-undo-list)
19460 (not (cadr buffer-undo-list)) ; remove nil entry
19461 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19462 (setq org-self-insert-command-undo-counter
19463 (1+ org-self-insert-command-undo-counter))))))))
19465 (defun org-check-before-invisible-edit (kind)
19466 "Check is editing if kind KIND would be dangerous with invisible text around.
19467 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19468 ;; First, try to get out of here as quickly as possible, to reduce overhead
19469 (if (and org-catch-invisible-edits
19470 (or (not (boundp 'visible-mode)) (not visible-mode))
19471 (or (get-char-property (point) 'invisible)
19472 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19473 ;; OK, we need to take a closer look
19474 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19475 (invisible-before-point (if (bobp) nil (get-char-property
19476 (1- (point)) 'invisible)))
19477 (border-and-ok-direction
19479 ;; Check if we are acting predictably before invisible text
19480 (and invisible-at-point (not invisible-before-point)
19481 (memq kind '(insert delete-backward)))
19482 ;; Check if we are acting predictably after invisible text
19483 ;; This works not well, and I have turned it off. It seems
19484 ;; better to always show and stop after invisible text.
19485 ;; (and (not invisible-at-point) invisible-before-point
19486 ;; (memq kind '(insert delete)))
19488 (when (or (memq invisible-at-point '(outline org-hide-block t))
19489 (memq invisible-before-point '(outline org-hide-block t)))
19490 (if (eq org-catch-invisible-edits 'error)
19491 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19492 (if (and org-custom-properties-overlays
19493 (y-or-n-p "Display invisible properties in this buffer? "))
19494 (org-toggle-custom-properties-visibility)
19495 ;; Make the area visible
19496 (save-excursion
19497 (if invisible-before-point
19498 (goto-char (previous-single-char-property-change
19499 (point) 'invisible)))
19500 (show-subtree))
19501 (cond
19502 ((eq org-catch-invisible-edits 'show)
19503 ;; That's it, we do the edit after showing
19504 (message
19505 "Unfolding invisible region around point before editing")
19506 (sit-for 1))
19507 ((and (eq org-catch-invisible-edits 'smart)
19508 border-and-ok-direction)
19509 (message "Unfolding invisible region around point before editing"))
19511 ;; Don't do the edit, make the user repeat it in full visibility
19512 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19514 (defun org-fix-tags-on-the-fly ()
19515 (when (and (equal (char-after (point-at-bol)) ?*)
19516 (org-at-heading-p))
19517 (org-align-tags-here org-tags-column)))
19519 (defun org-delete-backward-char (N)
19520 "Like `delete-backward-char', insert whitespace at field end in tables.
19521 When deleting backwards, in tables this function will insert whitespace in
19522 front of the next \"|\" separator, to keep the table aligned. The table will
19523 still be marked for re-alignment if the field did fill the entire column,
19524 because, in this case the deletion might narrow the column."
19525 (interactive "p")
19526 (save-match-data
19527 (org-check-before-invisible-edit 'delete-backward)
19528 (if (and (org-table-p)
19529 (eq N 1)
19530 (string-match "|" (buffer-substring (point-at-bol) (point)))
19531 (looking-at ".*?|"))
19532 (let ((pos (point))
19533 (noalign (looking-at "[^|\n\r]* |"))
19534 (c org-table-may-need-update))
19535 (backward-delete-char N)
19536 (if (not overwrite-mode)
19537 (progn
19538 (skip-chars-forward "^|")
19539 (insert " ")
19540 (goto-char (1- pos))))
19541 ;; noalign: if there were two spaces at the end, this field
19542 ;; does not determine the width of the column.
19543 (if noalign (setq org-table-may-need-update c)))
19544 (backward-delete-char N)
19545 (org-fix-tags-on-the-fly))))
19547 (defun org-delete-char (N)
19548 "Like `delete-char', but insert whitespace at field end in tables.
19549 When deleting characters, in tables this function will insert whitespace in
19550 front of the next \"|\" separator, to keep the table aligned. The table will
19551 still be marked for re-alignment if the field did fill the entire column,
19552 because, in this case the deletion might narrow the column."
19553 (interactive "p")
19554 (save-match-data
19555 (org-check-before-invisible-edit 'delete)
19556 (if (and (org-table-p)
19557 (not (bolp))
19558 (not (= (char-after) ?|))
19559 (eq N 1))
19560 (if (looking-at ".*?|")
19561 (let ((pos (point))
19562 (noalign (looking-at "[^|\n\r]* |"))
19563 (c org-table-may-need-update))
19564 (replace-match
19565 (concat (substring (match-string 0) 1 -1) " |") nil t)
19566 (goto-char pos)
19567 ;; noalign: if there were two spaces at the end, this field
19568 ;; does not determine the width of the column.
19569 (if noalign (setq org-table-may-need-update c)))
19570 (delete-char N))
19571 (delete-char N)
19572 (org-fix-tags-on-the-fly))))
19574 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19575 (put 'org-self-insert-command 'delete-selection
19576 (lambda ()
19577 (not (run-hook-with-args-until-success
19578 'self-insert-uses-region-functions))))
19579 (put 'orgtbl-self-insert-command 'delete-selection
19580 (lambda ()
19581 (not (run-hook-with-args-until-success
19582 'self-insert-uses-region-functions))))
19583 (put 'org-delete-char 'delete-selection 'supersede)
19584 (put 'org-delete-backward-char 'delete-selection 'supersede)
19585 (put 'org-yank 'delete-selection 'yank)
19587 ;; Make `flyspell-mode' delay after some commands
19588 (put 'org-self-insert-command 'flyspell-delayed t)
19589 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19590 (put 'org-delete-char 'flyspell-delayed t)
19591 (put 'org-delete-backward-char 'flyspell-delayed t)
19593 ;; Make pabbrev-mode expand after org-mode commands
19594 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19595 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19597 (defun org-remap (map &rest commands)
19598 "In MAP, remap the functions given in COMMANDS.
19599 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19600 (let (new old)
19601 (while commands
19602 (setq old (pop commands) new (pop commands))
19603 (if (fboundp 'command-remapping)
19604 (org-defkey map (vector 'remap old) new)
19605 (substitute-key-definition old new map global-map)))))
19607 (defun org-transpose-words ()
19608 "Transpose words for Org.
19609 This uses the `org-mode-transpose-word-syntax-table' syntax
19610 table, which interprets characters in `org-emphasis-alist' as
19611 word constituents."
19612 (interactive)
19613 (with-syntax-table org-mode-transpose-word-syntax-table
19614 (call-interactively 'transpose-words)))
19615 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19617 (when (eq org-enable-table-editor 'optimized)
19618 ;; If the user wants maximum table support, we need to hijack
19619 ;; some standard editing functions
19620 (org-remap org-mode-map
19621 'self-insert-command 'org-self-insert-command
19622 'delete-char 'org-delete-char
19623 'delete-backward-char 'org-delete-backward-char)
19624 (org-defkey org-mode-map "|" 'org-force-self-insert))
19626 (defvar org-ctrl-c-ctrl-c-hook nil
19627 "Hook for functions attaching themselves to `C-c C-c'.
19629 This can be used to add additional functionality to the C-c C-c
19630 key which executes context-dependent commands. This hook is run
19631 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19632 run after the last test.
19634 Each function will be called with no arguments. The function
19635 must check if the context is appropriate for it to act. If yes,
19636 it should do its thing and then return a non-nil value. If the
19637 context is wrong, just do nothing and return nil.")
19639 (defvar org-ctrl-c-ctrl-c-final-hook nil
19640 "Hook for functions attaching themselves to `C-c C-c'.
19642 This can be used to add additional functionality to the C-c C-c
19643 key which executes context-dependent commands. This hook is run
19644 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19645 before the first test.
19647 Each function will be called with no arguments. The function
19648 must check if the context is appropriate for it to act. If yes,
19649 it should do its thing and then return a non-nil value. If the
19650 context is wrong, just do nothing and return nil.")
19652 (defvar org-tab-first-hook nil
19653 "Hook for functions to attach themselves to TAB.
19654 See `org-ctrl-c-ctrl-c-hook' for more information.
19655 This hook runs as the first action when TAB is pressed, even before
19656 `org-cycle' messes around with the `outline-regexp' to cater for
19657 inline tasks and plain list item folding.
19658 If any function in this hook returns t, any other actions that
19659 would have been caused by TAB (such as table field motion or visibility
19660 cycling) will not occur.")
19662 (defvar org-tab-after-check-for-table-hook nil
19663 "Hook for functions to attach themselves to TAB.
19664 See `org-ctrl-c-ctrl-c-hook' for more information.
19665 This hook runs after it has been established that the cursor is not in a
19666 table, but before checking if the cursor is in a headline or if global cycling
19667 should be done.
19668 If any function in this hook returns t, not other actions like visibility
19669 cycling will be done.")
19671 (defvar org-tab-after-check-for-cycling-hook nil
19672 "Hook for functions to attach themselves to TAB.
19673 See `org-ctrl-c-ctrl-c-hook' for more information.
19674 This hook runs after it has been established that not table field motion and
19675 not visibility should be done because of current context. This is probably
19676 the place where a package like yasnippets can hook in.")
19678 (defvar org-tab-before-tab-emulation-hook nil
19679 "Hook for functions to attach themselves to TAB.
19680 See `org-ctrl-c-ctrl-c-hook' for more information.
19681 This hook runs after every other options for TAB have been exhausted, but
19682 before indentation and \t insertion takes place.")
19684 (defvar org-metaleft-hook nil
19685 "Hook for functions attaching themselves to `M-left'.
19686 See `org-ctrl-c-ctrl-c-hook' for more information.")
19687 (defvar org-metaright-hook nil
19688 "Hook for functions attaching themselves to `M-right'.
19689 See `org-ctrl-c-ctrl-c-hook' for more information.")
19690 (defvar org-metaup-hook nil
19691 "Hook for functions attaching themselves to `M-up'.
19692 See `org-ctrl-c-ctrl-c-hook' for more information.")
19693 (defvar org-metadown-hook nil
19694 "Hook for functions attaching themselves to `M-down'.
19695 See `org-ctrl-c-ctrl-c-hook' for more information.")
19696 (defvar org-shiftmetaleft-hook nil
19697 "Hook for functions attaching themselves to `M-S-left'.
19698 See `org-ctrl-c-ctrl-c-hook' for more information.")
19699 (defvar org-shiftmetaright-hook nil
19700 "Hook for functions attaching themselves to `M-S-right'.
19701 See `org-ctrl-c-ctrl-c-hook' for more information.")
19702 (defvar org-shiftmetaup-hook nil
19703 "Hook for functions attaching themselves to `M-S-up'.
19704 See `org-ctrl-c-ctrl-c-hook' for more information.")
19705 (defvar org-shiftmetadown-hook nil
19706 "Hook for functions attaching themselves to `M-S-down'.
19707 See `org-ctrl-c-ctrl-c-hook' for more information.")
19708 (defvar org-metareturn-hook nil
19709 "Hook for functions attaching themselves to `M-RET'.
19710 See `org-ctrl-c-ctrl-c-hook' for more information.")
19711 (defvar org-shiftup-hook nil
19712 "Hook for functions attaching themselves to `S-up'.
19713 See `org-ctrl-c-ctrl-c-hook' for more information.")
19714 (defvar org-shiftup-final-hook nil
19715 "Hook for functions attaching themselves to `S-up'.
19716 This one runs after all other options except shift-select have been excluded.
19717 See `org-ctrl-c-ctrl-c-hook' for more information.")
19718 (defvar org-shiftdown-hook nil
19719 "Hook for functions attaching themselves to `S-down'.
19720 See `org-ctrl-c-ctrl-c-hook' for more information.")
19721 (defvar org-shiftdown-final-hook nil
19722 "Hook for functions attaching themselves to `S-down'.
19723 This one runs after all other options except shift-select have been excluded.
19724 See `org-ctrl-c-ctrl-c-hook' for more information.")
19725 (defvar org-shiftleft-hook nil
19726 "Hook for functions attaching themselves to `S-left'.
19727 See `org-ctrl-c-ctrl-c-hook' for more information.")
19728 (defvar org-shiftleft-final-hook nil
19729 "Hook for functions attaching themselves to `S-left'.
19730 This one runs after all other options except shift-select have been excluded.
19731 See `org-ctrl-c-ctrl-c-hook' for more information.")
19732 (defvar org-shiftright-hook nil
19733 "Hook for functions attaching themselves to `S-right'.
19734 See `org-ctrl-c-ctrl-c-hook' for more information.")
19735 (defvar org-shiftright-final-hook nil
19736 "Hook for functions attaching themselves to `S-right'.
19737 This one runs after all other options except shift-select have been excluded.
19738 See `org-ctrl-c-ctrl-c-hook' for more information.")
19740 (defun org-modifier-cursor-error ()
19741 "Throw an error, a modified cursor command was applied in wrong context."
19742 (user-error "This command is active in special context like tables, headlines or items"))
19744 (defun org-shiftselect-error ()
19745 "Throw an error because Shift-Cursor command was applied in wrong context."
19746 (if (and (boundp 'shift-select-mode) shift-select-mode)
19747 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19748 (user-error "This command works only in special context like headlines or timestamps")))
19750 (defun org-call-for-shift-select (cmd)
19751 (let ((this-command-keys-shift-translated t))
19752 (call-interactively cmd)))
19754 (defun org-shifttab (&optional arg)
19755 "Global visibility cycling or move to previous table field.
19756 Call `org-table-previous-field' within a table.
19757 When ARG is nil, cycle globally through visibility states.
19758 When ARG is a numeric prefix, show contents of this level."
19759 (interactive "P")
19760 (cond
19761 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19762 ((integerp arg)
19763 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19764 (message "Content view to level: %d" arg)
19765 (org-content (prefix-numeric-value arg2))
19766 (org-cycle-show-empty-lines t)
19767 (setq org-cycle-global-status 'overview)))
19768 (t (call-interactively 'org-global-cycle))))
19770 (defun org-shiftmetaleft ()
19771 "Promote subtree or delete table column.
19772 Calls `org-promote-subtree', `org-outdent-item-tree', or
19773 `org-table-delete-column', depending on context. See the
19774 individual commands for more information."
19775 (interactive)
19776 (cond
19777 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19778 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19779 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19780 ((if (not (org-region-active-p)) (org-at-item-p)
19781 (save-excursion (goto-char (region-beginning))
19782 (org-at-item-p)))
19783 (call-interactively 'org-outdent-item-tree))
19784 (t (org-modifier-cursor-error))))
19786 (defun org-shiftmetaright ()
19787 "Demote subtree or insert table column.
19788 Calls `org-demote-subtree', `org-indent-item-tree', or
19789 `org-table-insert-column', depending on context. See the
19790 individual commands for more information."
19791 (interactive)
19792 (cond
19793 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19794 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19795 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19796 ((if (not (org-region-active-p)) (org-at-item-p)
19797 (save-excursion (goto-char (region-beginning))
19798 (org-at-item-p)))
19799 (call-interactively 'org-indent-item-tree))
19800 (t (org-modifier-cursor-error))))
19802 (defun org-shiftmetaup (&optional arg)
19803 "Move subtree up or kill table row.
19804 Calls `org-move-subtree-up' or `org-table-kill-row' or
19805 `org-move-item-up' or `org-timestamp-up', depending on context.
19806 See the individual commands for more information."
19807 (interactive "P")
19808 (cond
19809 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19810 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19811 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19812 ((org-at-item-p) (call-interactively 'org-move-item-up))
19813 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19814 (call-interactively 'org-timestamp-up)))
19815 (t (call-interactively 'org-drag-line-backward))))
19817 (defun org-shiftmetadown (&optional arg)
19818 "Move subtree down or insert table row.
19819 Calls `org-move-subtree-down' or `org-table-insert-row' or
19820 `org-move-item-down' or `org-timestamp-up', depending on context.
19821 See the individual commands for more information."
19822 (interactive "P")
19823 (cond
19824 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19825 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19826 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19827 ((org-at-item-p) (call-interactively 'org-move-item-down))
19828 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19829 (call-interactively 'org-timestamp-down)))
19830 (t (call-interactively 'org-drag-line-forward))))
19832 (defsubst org-hidden-tree-error ()
19833 (user-error
19834 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19836 (defun org-metaleft (&optional arg)
19837 "Promote heading or move table column to left.
19838 Calls `org-do-promote' or `org-table-move-column', depending on context.
19839 With no specific context, calls the Emacs default `backward-word'.
19840 See the individual commands for more information."
19841 (interactive "P")
19842 (cond
19843 ((run-hook-with-args-until-success 'org-metaleft-hook))
19844 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19845 ((org-with-limited-levels
19846 (or (org-at-heading-p)
19847 (and (org-region-active-p)
19848 (save-excursion
19849 (goto-char (region-beginning))
19850 (org-at-heading-p)))))
19851 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19852 (call-interactively 'org-do-promote))
19853 ;; At an inline task.
19854 ((org-at-heading-p)
19855 (call-interactively 'org-inlinetask-promote))
19856 ((or (org-at-item-p)
19857 (and (org-region-active-p)
19858 (save-excursion
19859 (goto-char (region-beginning))
19860 (org-at-item-p))))
19861 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19862 (call-interactively 'org-outdent-item))
19863 (t (call-interactively 'backward-word))))
19865 (defun org-metaright (&optional arg)
19866 "Demote a subtree, a list item or move table column to right.
19867 In front of a drawer or a block keyword, indent it correctly.
19868 With no specific context, calls the Emacs default `forward-word'.
19869 See the individual commands for more information."
19870 (interactive "P")
19871 (cond
19872 ((run-hook-with-args-until-success 'org-metaright-hook))
19873 ((org-at-table-p) (call-interactively 'org-table-move-column))
19874 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19875 ((org-at-block-p) (call-interactively 'org-indent-block))
19876 ((org-with-limited-levels
19877 (or (org-at-heading-p)
19878 (and (org-region-active-p)
19879 (save-excursion
19880 (goto-char (region-beginning))
19881 (org-at-heading-p)))))
19882 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19883 (call-interactively 'org-do-demote))
19884 ;; At an inline task.
19885 ((org-at-heading-p)
19886 (call-interactively 'org-inlinetask-demote))
19887 ((or (org-at-item-p)
19888 (and (org-region-active-p)
19889 (save-excursion
19890 (goto-char (region-beginning))
19891 (org-at-item-p))))
19892 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19893 (call-interactively 'org-indent-item))
19894 (t (call-interactively 'forward-word))))
19896 (defun org-check-for-hidden (what)
19897 "Check if there are hidden headlines/items in the current visual line.
19898 WHAT can be either `headlines' or `items'. If the current line is
19899 an outline or item heading and it has a folded subtree below it,
19900 this function returns t, nil otherwise."
19901 (let ((re (cond
19902 ((eq what 'headlines) org-outline-regexp-bol)
19903 ((eq what 'items) (org-item-beginning-re))
19904 (t (error "This should not happen"))))
19905 beg end)
19906 (save-excursion
19907 (catch 'exit
19908 (unless (org-region-active-p)
19909 (setq beg (point-at-bol))
19910 (beginning-of-line 2)
19911 (while (and (not (eobp)) ;; this is like `next-line'
19912 (get-char-property (1- (point)) 'invisible))
19913 (beginning-of-line 2))
19914 (setq end (point))
19915 (goto-char beg)
19916 (goto-char (point-at-eol))
19917 (setq end (max end (point)))
19918 (while (re-search-forward re end t)
19919 (if (get-char-property (match-beginning 0) 'invisible)
19920 (throw 'exit t))))
19921 nil))))
19923 (defun org-metaup (&optional arg)
19924 "Move subtree up or move table row up.
19925 Calls `org-move-subtree-up' or `org-table-move-row' or
19926 `org-move-item-up', depending on context. See the individual commands
19927 for more information."
19928 (interactive "P")
19929 (cond
19930 ((run-hook-with-args-until-success 'org-metaup-hook))
19931 ((org-region-active-p)
19932 (let* ((a (min (region-beginning) (region-end)))
19933 (b (1- (max (region-beginning) (region-end))))
19934 (c (save-excursion (goto-char a)
19935 (move-beginning-of-line 0)))
19936 (d (save-excursion (goto-char a)
19937 (move-end-of-line 0) (point))))
19938 (transpose-regions a b c d)
19939 (goto-char c)))
19940 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19941 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19942 ((org-at-item-p) (call-interactively 'org-move-item-up))
19943 (t (org-drag-element-backward))))
19945 (defun org-metadown (&optional arg)
19946 "Move subtree down or move table row down.
19947 Calls `org-move-subtree-down' or `org-table-move-row' or
19948 `org-move-item-down', depending on context. See the individual
19949 commands for more information."
19950 (interactive "P")
19951 (cond
19952 ((run-hook-with-args-until-success 'org-metadown-hook))
19953 ((org-region-active-p)
19954 (let* ((a (min (region-beginning) (region-end)))
19955 (b (max (region-beginning) (region-end)))
19956 (c (save-excursion (goto-char b)
19957 (move-beginning-of-line 1)))
19958 (d (save-excursion (goto-char b)
19959 (move-end-of-line 1) (1+ (point)))))
19960 (transpose-regions a b c d)
19961 (goto-char d)))
19962 ((org-at-table-p) (call-interactively 'org-table-move-row))
19963 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19964 ((org-at-item-p) (call-interactively 'org-move-item-down))
19965 (t (org-drag-element-forward))))
19967 (defun org-shiftup (&optional arg)
19968 "Increase item in timestamp or increase priority of current headline.
19969 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19970 depending on context. See the individual commands for more information."
19971 (interactive "P")
19972 (cond
19973 ((run-hook-with-args-until-success 'org-shiftup-hook))
19974 ((and org-support-shift-select (org-region-active-p))
19975 (org-call-for-shift-select 'previous-line))
19976 ((org-at-timestamp-p t)
19977 (call-interactively (if org-edit-timestamp-down-means-later
19978 'org-timestamp-down 'org-timestamp-up)))
19979 ((and (not (eq org-support-shift-select 'always))
19980 org-enable-priority-commands
19981 (org-at-heading-p))
19982 (call-interactively 'org-priority-up))
19983 ((and (not org-support-shift-select) (org-at-item-p))
19984 (call-interactively 'org-previous-item))
19985 ((org-clocktable-try-shift 'up arg))
19986 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19987 (org-support-shift-select
19988 (org-call-for-shift-select 'previous-line))
19989 (t (org-shiftselect-error))))
19991 (defun org-shiftdown (&optional arg)
19992 "Decrease item in timestamp or decrease priority of current headline.
19993 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19994 depending on context. See the individual commands for more information."
19995 (interactive "P")
19996 (cond
19997 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19998 ((and org-support-shift-select (org-region-active-p))
19999 (org-call-for-shift-select 'next-line))
20000 ((org-at-timestamp-p t)
20001 (call-interactively (if org-edit-timestamp-down-means-later
20002 'org-timestamp-up 'org-timestamp-down)))
20003 ((and (not (eq org-support-shift-select 'always))
20004 org-enable-priority-commands
20005 (org-at-heading-p))
20006 (call-interactively 'org-priority-down))
20007 ((and (not org-support-shift-select) (org-at-item-p))
20008 (call-interactively 'org-next-item))
20009 ((org-clocktable-try-shift 'down arg))
20010 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20011 (org-support-shift-select
20012 (org-call-for-shift-select 'next-line))
20013 (t (org-shiftselect-error))))
20015 (defun org-shiftright (&optional arg)
20016 "Cycle the thing at point or in the current line, depending on context.
20017 Depending on context, this does one of the following:
20019 - switch a timestamp at point one day into the future
20020 - on a headline, switch to the next TODO keyword.
20021 - on an item, switch entire list to the next bullet type
20022 - on a property line, switch to the next allowed value
20023 - on a clocktable definition line, move time block into the future"
20024 (interactive "P")
20025 (cond
20026 ((run-hook-with-args-until-success 'org-shiftright-hook))
20027 ((and org-support-shift-select (org-region-active-p))
20028 (org-call-for-shift-select 'forward-char))
20029 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20030 ((and (not (eq org-support-shift-select 'always))
20031 (org-at-heading-p))
20032 (let ((org-inhibit-logging
20033 (not org-treat-S-cursor-todo-selection-as-state-change))
20034 (org-inhibit-blocking
20035 (not org-treat-S-cursor-todo-selection-as-state-change)))
20036 (org-call-with-arg 'org-todo 'right)))
20037 ((or (and org-support-shift-select
20038 (not (eq org-support-shift-select 'always))
20039 (org-at-item-bullet-p))
20040 (and (not org-support-shift-select) (org-at-item-p)))
20041 (org-call-with-arg 'org-cycle-list-bullet nil))
20042 ((and (not (eq org-support-shift-select 'always))
20043 (org-at-property-p))
20044 (call-interactively 'org-property-next-allowed-value))
20045 ((org-clocktable-try-shift 'right arg))
20046 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20047 (org-support-shift-select
20048 (org-call-for-shift-select 'forward-char))
20049 (t (org-shiftselect-error))))
20051 (defun org-shiftleft (&optional arg)
20052 "Cycle the thing at point or in the current line, depending on context.
20053 Depending on context, this does one of the following:
20055 - switch a timestamp at point one day into the past
20056 - on a headline, switch to the previous TODO keyword.
20057 - on an item, switch entire list to the previous bullet type
20058 - on a property line, switch to the previous allowed value
20059 - on a clocktable definition line, move time block into the past"
20060 (interactive "P")
20061 (cond
20062 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20063 ((and org-support-shift-select (org-region-active-p))
20064 (org-call-for-shift-select 'backward-char))
20065 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20066 ((and (not (eq org-support-shift-select 'always))
20067 (org-at-heading-p))
20068 (let ((org-inhibit-logging
20069 (not org-treat-S-cursor-todo-selection-as-state-change))
20070 (org-inhibit-blocking
20071 (not org-treat-S-cursor-todo-selection-as-state-change)))
20072 (org-call-with-arg 'org-todo 'left)))
20073 ((or (and org-support-shift-select
20074 (not (eq org-support-shift-select 'always))
20075 (org-at-item-bullet-p))
20076 (and (not org-support-shift-select) (org-at-item-p)))
20077 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20078 ((and (not (eq org-support-shift-select 'always))
20079 (org-at-property-p))
20080 (call-interactively 'org-property-previous-allowed-value))
20081 ((org-clocktable-try-shift 'left arg))
20082 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20083 (org-support-shift-select
20084 (org-call-for-shift-select 'backward-char))
20085 (t (org-shiftselect-error))))
20087 (defun org-shiftcontrolright ()
20088 "Switch to next TODO set."
20089 (interactive)
20090 (cond
20091 ((and org-support-shift-select (org-region-active-p))
20092 (org-call-for-shift-select 'forward-word))
20093 ((and (not (eq org-support-shift-select 'always))
20094 (org-at-heading-p))
20095 (org-call-with-arg 'org-todo 'nextset))
20096 (org-support-shift-select
20097 (org-call-for-shift-select 'forward-word))
20098 (t (org-shiftselect-error))))
20100 (defun org-shiftcontrolleft ()
20101 "Switch to previous TODO set."
20102 (interactive)
20103 (cond
20104 ((and org-support-shift-select (org-region-active-p))
20105 (org-call-for-shift-select 'backward-word))
20106 ((and (not (eq org-support-shift-select 'always))
20107 (org-at-heading-p))
20108 (org-call-with-arg 'org-todo 'previousset))
20109 (org-support-shift-select
20110 (org-call-for-shift-select 'backward-word))
20111 (t (org-shiftselect-error))))
20113 (defun org-shiftcontrolup (&optional n)
20114 "Change timestamps synchronously up in CLOCK log lines.
20115 Optional argument N tells to change by that many units."
20116 (interactive "P")
20117 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20118 (let (org-support-shift-select)
20119 (org-clock-timestamps-up n))
20120 (user-error "Not at a clock log")))
20122 (defun org-shiftcontroldown (&optional n)
20123 "Change timestamps synchronously down in CLOCK log lines.
20124 Optional argument N tells to change by that many units."
20125 (interactive "P")
20126 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20127 (let (org-support-shift-select)
20128 (org-clock-timestamps-down n))
20129 (user-error "Not at a clock log")))
20131 (defun org-ctrl-c-ret ()
20132 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20133 (interactive)
20134 (cond
20135 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20136 (t (call-interactively 'org-insert-heading))))
20138 (defun org-find-visible ()
20139 (let ((s (point)))
20140 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20141 (get-char-property s 'invisible)))
20143 (defun org-find-invisible ()
20144 (let ((s (point)))
20145 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20146 (not (get-char-property s 'invisible))))
20149 (defun org-copy-visible (beg end)
20150 "Copy the visible parts of the region."
20151 (interactive "r")
20152 (let (snippets s)
20153 (save-excursion
20154 (save-restriction
20155 (narrow-to-region beg end)
20156 (setq s (goto-char (point-min)))
20157 (while (not (= (point) (point-max)))
20158 (goto-char (org-find-invisible))
20159 (push (buffer-substring s (point)) snippets)
20160 (setq s (goto-char (org-find-visible))))))
20161 (kill-new (apply 'concat (nreverse snippets)))))
20163 (defun org-copy-special ()
20164 "Copy region in table or copy current subtree.
20165 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20166 See the individual commands for more information."
20167 (interactive)
20168 (call-interactively
20169 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20171 (defun org-cut-special ()
20172 "Cut region in table or cut current subtree.
20173 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20174 See the individual commands for more information."
20175 (interactive)
20176 (call-interactively
20177 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20179 (defun org-paste-special (arg)
20180 "Paste rectangular region into table, or past subtree relative to level.
20181 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20182 See the individual commands for more information."
20183 (interactive "P")
20184 (if (org-at-table-p)
20185 (org-table-paste-rectangle)
20186 (org-paste-subtree arg)))
20188 (defsubst org-in-fixed-width-region-p ()
20189 "Is point in a fixed-width region?"
20190 (save-match-data
20191 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20193 (defun org-edit-special (&optional arg)
20194 "Call a special editor for the element at point.
20195 When at a table, call the formula editor with `org-table-edit-formulas'.
20196 When in a source code block, call `org-edit-src-code'.
20197 When in a fixed-width region, call `org-edit-fixed-width-region'.
20198 When at an #+INCLUDE keyword, visit the included file.
20199 On a link, call `ffap' to visit the link at point.
20200 Otherwise, return a user error."
20201 (interactive "P")
20202 (let ((element (org-element-at-point)))
20203 (assert (not buffer-read-only) nil
20204 "Buffer is read-only: %s" (buffer-name))
20205 (case (org-element-type element)
20206 (src-block
20207 (if (not arg) (org-edit-src-code)
20208 (let* ((info (org-babel-get-src-block-info))
20209 (lang (nth 0 info))
20210 (params (nth 2 info))
20211 (session (cdr (assq :session params))))
20212 (if (not session) (org-edit-src-code)
20213 ;; At a src-block with a session and function called with
20214 ;; an ARG: switch to the buffer related to the inferior
20215 ;; process.
20216 (switch-to-buffer
20217 (funcall (intern (concat "org-babel-prep-session:" lang))
20218 session params))))))
20219 (keyword
20220 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20221 (find-file
20222 (org-remove-double-quotes
20223 (car (org-split-string (org-element-property :value element)))))
20224 (user-error "No special environment to edit here")))
20225 (table
20226 (if (eq (org-element-property :type element) 'table.el)
20227 (org-edit-src-code)
20228 (call-interactively 'org-table-edit-formulas)))
20229 ;; Only Org tables contain `table-row' type elements.
20230 (table-row (call-interactively 'org-table-edit-formulas))
20231 ((example-block export-block) (org-edit-src-code))
20232 (fixed-width (org-edit-fixed-width-region))
20233 (otherwise
20234 ;; No notable element at point. Though, we may be at a link,
20235 ;; which is an object. Thus, scan deeper.
20236 (if (eq (org-element-type (org-element-context element)) 'link)
20237 (call-interactively 'ffap)
20238 (user-error "No special environment to edit here"))))))
20240 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20241 (defun org-ctrl-c-ctrl-c (&optional arg)
20242 "Set tags in headline, or update according to changed information at point.
20244 This command does many different things, depending on context:
20246 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20247 this is what we do.
20249 - If the cursor is on a statistics cookie, update it.
20251 - If the cursor is in a headline, prompt for tags and insert them
20252 into the current line, aligned to `org-tags-column'. When called
20253 with prefix arg, realign all tags in the current buffer.
20255 - If the cursor is in one of the special #+KEYWORD lines, this
20256 triggers scanning the buffer for these lines and updating the
20257 information.
20259 - If the cursor is inside a table, realign the table. This command
20260 works even if the automatic table editor has been turned off.
20262 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20263 the entire table.
20265 - If the cursor is at a footnote reference or definition, jump to
20266 the corresponding definition or references, respectively.
20268 - If the cursor is a the beginning of a dynamic block, update it.
20270 - If the current buffer is a capture buffer, close note and file it.
20272 - If the cursor is on a <<<target>>>, update radio targets and
20273 corresponding links in this buffer.
20275 - If the cursor is on a numbered item in a plain list, renumber the
20276 ordered list.
20278 - If the cursor is on a checkbox, toggle it.
20280 - If the cursor is on a code block, evaluate it. The variable
20281 `org-confirm-babel-evaluate' can be used to control prompting
20282 before code block evaluation, by default every code block
20283 evaluation requires confirmation. Code block evaluation can be
20284 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20285 (interactive "P")
20286 (cond
20287 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20288 org-occur-highlights
20289 org-latex-fragment-image-overlays)
20290 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20291 (org-remove-occur-highlights)
20292 (org-remove-latex-fragment-image-overlays)
20293 (message "Temporary highlights/overlays removed from current buffer"))
20294 ((and (local-variable-p 'org-finish-function (current-buffer))
20295 (fboundp org-finish-function))
20296 (funcall org-finish-function))
20297 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20299 (let* ((context (org-element-context)) (type (org-element-type context)))
20300 ;; Test if point is within a blank line.
20301 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20302 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20303 (user-error "C-c C-c can do nothing useful at this location"))
20304 (case type
20305 ;; When at a link, act according to the parent instead.
20306 (link (setq context (org-element-property :parent context))
20307 (setq type (org-element-type context)))
20308 ;; Unsupported object types: refer to the first supported
20309 ;; element or object containing it.
20310 ((bold code entity export-snippet inline-babel-call inline-src-block
20311 italic latex-fragment line-break macro strike-through subscript
20312 superscript underline verbatim)
20313 (while (and (setq context (org-element-property :parent context))
20314 (not (memq (setq type (org-element-type context))
20315 '(radio-target paragraph verse-block
20316 table-cell)))))))
20317 ;; For convenience: at the first line of a paragraph on the
20318 ;; same line as an item, apply function on that item instead.
20319 (when (eq type 'paragraph)
20320 (let ((parent (org-element-property :parent context)))
20321 (when (and (eq (org-element-type parent) 'item)
20322 (= (point-at-bol) (org-element-property :begin parent)))
20323 (setq context parent type 'item))))
20324 ;; Act according to type of element or object at point.
20325 (case type
20326 (clock (org-clock-update-time-maybe))
20327 (dynamic-block
20328 (save-excursion
20329 (goto-char (org-element-property :post-affiliated context))
20330 (org-update-dblock)))
20331 (footnote-definition
20332 (goto-char (org-element-property :post-affiliated context))
20333 (call-interactively 'org-footnote-action))
20334 (footnote-reference (call-interactively 'org-footnote-action))
20335 ((headline inlinetask)
20336 (save-excursion (goto-char (org-element-property :begin context))
20337 (call-interactively 'org-set-tags)))
20338 (item
20339 ;; At an item: a double C-u set checkbox to "[-]"
20340 ;; unconditionally, whereas a single one will toggle its
20341 ;; presence. Without an universal argument, if the item
20342 ;; has a checkbox, toggle it. Otherwise repair the list.
20343 (let* ((box (org-element-property :checkbox context))
20344 (struct (org-element-property :structure context))
20345 (old-struct (copy-tree struct))
20346 (parents (org-list-parents-alist struct))
20347 (prevs (org-list-prevs-alist struct))
20348 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20349 (org-list-set-checkbox
20350 (org-element-property :begin context) struct
20351 (cond ((equal arg '(16)) "[-]")
20352 ((and (not box) (equal arg '(4))) "[ ]")
20353 ((or (not box) (equal arg '(4))) nil)
20354 ((eq box 'on) "[ ]")
20355 (t "[X]")))
20356 ;; Mimic `org-list-write-struct' but with grabbing
20357 ;; a return value from `org-list-struct-fix-box'.
20358 (org-list-struct-fix-ind struct parents 2)
20359 (org-list-struct-fix-item-end struct)
20360 (org-list-struct-fix-bul struct prevs)
20361 (org-list-struct-fix-ind struct parents)
20362 (let ((block-item
20363 (org-list-struct-fix-box struct parents prevs orderedp)))
20364 (if (and box (equal struct old-struct))
20365 (if (equal arg '(16))
20366 (message "Checkboxes already reset")
20367 (user-error "Cannot toggle this checkbox: %s"
20368 (if (eq box 'on)
20369 "all subitems checked"
20370 "unchecked subitems")))
20371 (org-list-struct-apply-struct struct old-struct)
20372 (org-update-checkbox-count-maybe))
20373 (when block-item
20374 (message "Checkboxes were removed due to empty box at line %d"
20375 (org-current-line block-item))))))
20376 (keyword
20377 (let ((org-inhibit-startup-visibility-stuff t)
20378 (org-startup-align-all-tables nil))
20379 (when (boundp 'org-table-coordinate-overlays)
20380 (mapc 'delete-overlay org-table-coordinate-overlays)
20381 (setq org-table-coordinate-overlays nil))
20382 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20383 (message "Local setup has been refreshed"))
20384 (plain-list
20385 ;; At a plain list, with a double C-u argument, set
20386 ;; checkboxes of each item to "[-]", whereas a single one
20387 ;; will toggle their presence according to the state of the
20388 ;; first item in the list. Without an argument, repair the
20389 ;; list.
20390 (let* ((begin (org-element-property :contents-begin context))
20391 (beginm (move-marker (make-marker) begin))
20392 (struct (org-element-property :structure context))
20393 (old-struct (copy-tree struct))
20394 (first-box (save-excursion
20395 (goto-char begin)
20396 (looking-at org-list-full-item-re)
20397 (match-string-no-properties 3)))
20398 (new-box (cond ((equal arg '(16)) "[-]")
20399 ((equal arg '(4)) (unless first-box "[ ]"))
20400 ((equal first-box "[X]") "[ ]")
20401 (t "[X]"))))
20402 (cond
20403 (arg
20404 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20405 (org-list-get-all-items
20406 begin struct (org-list-prevs-alist struct))))
20407 ((and first-box (eq (point) begin))
20408 ;; For convenience, when point is at bol on the first
20409 ;; item of the list and no argument is provided, simply
20410 ;; toggle checkbox of that item, if any.
20411 (org-list-set-checkbox begin struct new-box)))
20412 (org-list-write-struct
20413 struct (org-list-parents-alist struct) old-struct)
20414 (org-update-checkbox-count-maybe)
20415 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20416 ((property-drawer node-property)
20417 (call-interactively 'org-property-action))
20418 ((radio-target target)
20419 (call-interactively 'org-update-radio-target-regexp))
20420 (statistics-cookie
20421 (call-interactively 'org-update-statistics-cookies))
20422 ((table table-cell table-row)
20423 ;; At a table, recalculate every field and align it. Also
20424 ;; send the table if necessary. If the table has
20425 ;; a `table.el' type, just give up. At a table row or
20426 ;; cell, maybe recalculate line but always align table.
20427 (if (eq (org-element-property :type context) 'table.el)
20428 (message "Use C-c ' to edit table.el tables")
20429 (let ((org-enable-table-editor t))
20430 (if (or (eq type 'table)
20431 ;; Check if point is at a TBLFM line.
20432 (and (eq type 'table-row)
20433 (= (point) (org-element-property :end context))))
20434 (save-excursion
20435 (if (org-at-TBLFM-p)
20436 (progn (require 'org-table)
20437 (org-table-calc-current-TBLFM))
20438 (goto-char (org-element-property :contents-begin context))
20439 (org-call-with-arg 'org-table-recalculate (or arg t))
20440 (orgtbl-send-table 'maybe)))
20441 (org-table-maybe-eval-formula)
20442 (cond (arg (call-interactively 'org-table-recalculate))
20443 ((org-table-maybe-recalculate-line))
20444 (t (org-table-align)))))))
20445 (timestamp (org-timestamp-change 0 'day))
20446 (otherwise
20447 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20448 (user-error
20449 "C-c C-c can do nothing useful at this location")))))))))
20451 (defun org-mode-restart ()
20452 (interactive)
20453 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20454 (funcall major-mode)
20455 (hack-local-variables)
20456 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20457 (org-indent-mode -1)))
20458 (message "%s restarted" major-mode))
20460 (defun org-kill-note-or-show-branches ()
20461 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20462 (interactive)
20463 (if (not org-finish-function)
20464 (progn
20465 (hide-subtree)
20466 (call-interactively 'show-branches))
20467 (let ((org-note-abort t))
20468 (funcall org-finish-function))))
20470 (defun org-open-line (n)
20471 "Insert a new row in tables, call `open-line' elsewhere.
20472 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20473 (interactive "*p")
20474 (cond
20475 ((not org-special-ctrl-o)
20476 (open-line n))
20477 ((org-at-table-p)
20478 (org-table-insert-row))
20480 (open-line n))))
20482 (defun org-return (&optional indent)
20483 "Goto next table row or insert a newline.
20484 Calls `org-table-next-row' or `newline', depending on context.
20485 See the individual commands for more information."
20486 (interactive)
20487 (let (org-ts-what)
20488 (cond
20489 ((or (bobp) (org-in-src-block-p))
20490 (if indent (newline-and-indent) (newline)))
20491 ((org-at-table-p)
20492 (org-table-justify-field-maybe)
20493 (call-interactively 'org-table-next-row))
20494 ;; when `newline-and-indent' is called within a list, make sure
20495 ;; text moved stays inside the item.
20496 ((and (org-in-item-p) indent)
20497 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20498 (progn
20499 (save-match-data (newline))
20500 (org-indent-line-to (length (match-string 0))))
20501 (let ((ind (org-get-indentation)))
20502 (newline)
20503 (if (org-looking-back org-list-end-re)
20504 (org-indent-line)
20505 (org-indent-line-to ind)))))
20506 ((and org-return-follows-link
20507 (org-at-timestamp-p t)
20508 (not (eq org-ts-what 'after)))
20509 (org-follow-timestamp-link))
20510 ((and org-return-follows-link
20511 (let ((tprop (get-text-property (point) 'face)))
20512 (or (eq tprop 'org-link)
20513 (and (listp tprop) (memq 'org-link tprop)))))
20514 (call-interactively 'org-open-at-point))
20515 ((and (org-at-heading-p)
20516 (looking-at
20517 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20518 (org-show-entry)
20519 (end-of-line 1)
20520 (newline))
20521 (t (if indent (newline-and-indent) (newline))))))
20523 (defun org-return-indent ()
20524 "Goto next table row or insert a newline and indent.
20525 Calls `org-table-next-row' or `newline-and-indent', depending on
20526 context. See the individual commands for more information."
20527 (interactive)
20528 (org-return t))
20530 (defun org-ctrl-c-star ()
20531 "Compute table, or change heading status of lines.
20532 Calls `org-table-recalculate' or `org-toggle-heading',
20533 depending on context."
20534 (interactive)
20535 (cond
20536 ((org-at-table-p)
20537 (call-interactively 'org-table-recalculate))
20539 ;; Convert all lines in region to list items
20540 (call-interactively 'org-toggle-heading))))
20542 (defun org-ctrl-c-minus ()
20543 "Insert separator line in table or modify bullet status of line.
20544 Also turns a plain line or a region of lines into list items.
20545 Calls `org-table-insert-hline', `org-toggle-item', or
20546 `org-cycle-list-bullet', depending on context."
20547 (interactive)
20548 (cond
20549 ((org-at-table-p)
20550 (call-interactively 'org-table-insert-hline))
20551 ((org-region-active-p)
20552 (call-interactively 'org-toggle-item))
20553 ((org-in-item-p)
20554 (call-interactively 'org-cycle-list-bullet))
20556 (call-interactively 'org-toggle-item))))
20558 (defun org-toggle-item (arg)
20559 "Convert headings or normal lines to items, items to normal lines.
20560 If there is no active region, only the current line is considered.
20562 If the first non blank line in the region is a headline, convert
20563 all headlines to items, shifting text accordingly.
20565 If it is an item, convert all items to normal lines.
20567 If it is normal text, change region into a list of items.
20568 With a prefix argument ARG, change the region in a single item."
20569 (interactive "P")
20570 (let ((shift-text
20571 (function
20572 ;; Shift text in current section to IND, from point to END.
20573 ;; The function leaves point to END line.
20574 (lambda (ind end)
20575 (let ((min-i 1000) (end (copy-marker end)))
20576 ;; First determine the minimum indentation (MIN-I) of
20577 ;; the text.
20578 (save-excursion
20579 (catch 'exit
20580 (while (< (point) end)
20581 (let ((i (org-get-indentation)))
20582 (cond
20583 ;; Skip blank lines and inline tasks.
20584 ((looking-at "^[ \t]*$"))
20585 ((looking-at org-outline-regexp-bol))
20586 ;; We can't find less than 0 indentation.
20587 ((zerop i) (throw 'exit (setq min-i 0)))
20588 ((< i min-i) (setq min-i i))))
20589 (forward-line))))
20590 ;; Then indent each line so that a line indented to
20591 ;; MIN-I becomes indented to IND. Ignore blank lines
20592 ;; and inline tasks in the process.
20593 (let ((delta (- ind min-i)))
20594 (while (< (point) end)
20595 (unless (or (looking-at "^[ \t]*$")
20596 (looking-at org-outline-regexp-bol))
20597 (org-indent-line-to (+ (org-get-indentation) delta)))
20598 (forward-line)))))))
20599 (skip-blanks
20600 (function
20601 ;; Return beginning of first non-blank line, starting from
20602 ;; line at POS.
20603 (lambda (pos)
20604 (save-excursion
20605 (goto-char pos)
20606 (skip-chars-forward " \r\t\n")
20607 (point-at-bol)))))
20608 beg end)
20609 ;; Determine boundaries of changes.
20610 (if (org-region-active-p)
20611 (setq beg (funcall skip-blanks (region-beginning))
20612 end (copy-marker (region-end)))
20613 (setq beg (funcall skip-blanks (point-at-bol))
20614 end (copy-marker (point-at-eol))))
20615 ;; Depending on the starting line, choose an action on the text
20616 ;; between BEG and END.
20617 (org-with-limited-levels
20618 (save-excursion
20619 (goto-char beg)
20620 (cond
20621 ;; Case 1. Start at an item: de-itemize. Note that it only
20622 ;; happens when a region is active: `org-ctrl-c-minus'
20623 ;; would call `org-cycle-list-bullet' otherwise.
20624 ((org-at-item-p)
20625 (while (< (point) end)
20626 (when (org-at-item-p)
20627 (skip-chars-forward " \t")
20628 (delete-region (point) (match-end 0)))
20629 (forward-line)))
20630 ;; Case 2. Start at an heading: convert to items.
20631 ((org-at-heading-p)
20632 (let* ((bul (org-list-bullet-string "-"))
20633 (bul-len (length bul))
20634 ;; Indentation of the first heading. It should be
20635 ;; relative to the indentation of its parent, if any.
20636 (start-ind (save-excursion
20637 (cond
20638 ((not org-adapt-indentation) 0)
20639 ((not (outline-previous-heading)) 0)
20640 (t (length (match-string 0))))))
20641 ;; Level of first heading. Further headings will be
20642 ;; compared to it to determine hierarchy in the list.
20643 (ref-level (org-reduced-level (org-outline-level))))
20644 (while (< (point) end)
20645 (let* ((level (org-reduced-level (org-outline-level)))
20646 (delta (max 0 (- level ref-level))))
20647 ;; If current headline is less indented than the first
20648 ;; one, set it as reference, in order to preserve
20649 ;; subtrees.
20650 (when (< level ref-level) (setq ref-level level))
20651 (replace-match bul t t)
20652 (org-indent-line-to (+ start-ind (* delta bul-len)))
20653 ;; Ensure all text down to END (or SECTION-END) belongs
20654 ;; to the newly created item.
20655 (let ((section-end (save-excursion
20656 (or (outline-next-heading) (point)))))
20657 (forward-line)
20658 (funcall shift-text
20659 (+ start-ind (* (1+ delta) bul-len))
20660 (min end section-end)))))))
20661 ;; Case 3. Normal line with ARG: make the first line of region
20662 ;; an item, and shift indentation of others lines to
20663 ;; set them as item's body.
20664 (arg (let* ((bul (org-list-bullet-string "-"))
20665 (bul-len (length bul))
20666 (ref-ind (org-get-indentation)))
20667 (skip-chars-forward " \t")
20668 (insert bul)
20669 (forward-line)
20670 (while (< (point) end)
20671 ;; Ensure that lines less indented than first one
20672 ;; still get included in item body.
20673 (funcall shift-text
20674 (+ ref-ind bul-len)
20675 (min end (save-excursion (or (outline-next-heading)
20676 (point)))))
20677 (forward-line))))
20678 ;; Case 4. Normal line without ARG: turn each non-item line
20679 ;; into an item.
20681 (while (< (point) end)
20682 (unless (or (org-at-heading-p) (org-at-item-p))
20683 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20684 (replace-match
20685 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20686 (forward-line))))))))
20688 (defun org-toggle-heading (&optional nstars)
20689 "Convert headings to normal text, or items or text to headings.
20690 If there is no active region, only convert the current line.
20692 With a \\[universal-argument] prefix, convert the whole list at
20693 point into heading.
20695 In a region:
20697 - If the first non blank line is a headline, remove the stars
20698 from all headlines in the region.
20700 - If it is a normal line, turn each and every normal line (i.e.,
20701 not an heading or an item) in the region into headings. If you
20702 want to convert only the first line of this region, use one
20703 universal prefix argument.
20705 - If it is a plain list item, turn all plain list items into headings.
20707 When converting a line into a heading, the number of stars is chosen
20708 such that the lines become children of the current entry. However,
20709 when a numeric prefix argument is given, its value determines the
20710 number of stars to add."
20711 (interactive "P")
20712 (let ((skip-blanks
20713 (function
20714 ;; Return beginning of first non-blank line, starting from
20715 ;; line at POS.
20716 (lambda (pos)
20717 (save-excursion
20718 (goto-char pos)
20719 (while (org-at-comment-p) (forward-line))
20720 (skip-chars-forward " \r\t\n")
20721 (point-at-bol)))))
20722 beg end toggled)
20723 ;; Determine boundaries of changes. If a universal prefix has
20724 ;; been given, put the list in a region. If region ends at a bol,
20725 ;; do not consider the last line to be in the region.
20727 (when (and current-prefix-arg (org-at-item-p))
20728 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20729 (org-mark-element))
20731 (if (org-region-active-p)
20732 (setq beg (funcall skip-blanks (region-beginning))
20733 end (copy-marker (save-excursion
20734 (goto-char (region-end))
20735 (if (bolp) (point) (point-at-eol)))))
20736 (setq beg (funcall skip-blanks (point-at-bol))
20737 end (copy-marker (point-at-eol))))
20738 ;; Ensure inline tasks don't count as headings.
20739 (org-with-limited-levels
20740 (save-excursion
20741 (goto-char beg)
20742 (cond
20743 ;; Case 1. Started at an heading: de-star headings.
20744 ((org-at-heading-p)
20745 (while (< (point) end)
20746 (when (org-at-heading-p t)
20747 (looking-at org-outline-regexp) (replace-match "")
20748 (setq toggled t))
20749 (forward-line)))
20750 ;; Case 2. Started at an item: change items into headlines.
20751 ;; One star will be added by `org-list-to-subtree'.
20752 ((org-at-item-p)
20753 (let* ((stars (make-string
20754 ;; subtract the star that will be added again by
20755 ;; `org-list-to-subtree'
20756 (if (numberp nstars) (1- nstars)
20757 (or (org-current-level) 0))
20758 ?*))
20759 (add-stars
20760 (cond (nstars "") ; stars from prefix only
20761 ((equal stars "") "") ; before first heading
20762 (org-odd-levels-only "*") ; inside heading, odd
20763 (t "")))) ; inside heading, oddeven
20764 (while (< (point) end)
20765 (when (org-at-item-p)
20766 ;; Pay attention to cases when region ends before list.
20767 (let* ((struct (org-list-struct))
20768 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20769 (save-restriction
20770 (narrow-to-region (point) list-end)
20771 (insert
20772 (org-list-to-subtree
20773 (org-list-parse-list t)
20774 '(:istart (concat stars add-stars (funcall get-stars depth))
20775 :icount (concat stars add-stars (funcall get-stars depth)))))))
20776 (setq toggled t))
20777 (forward-line))))
20778 ;; Case 3. Started at normal text: make every line an heading,
20779 ;; skipping headlines and items.
20780 (t (let* ((stars
20781 (make-string
20782 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20783 (add-stars
20784 (cond (nstars "") ; stars from prefix only
20785 ((equal stars "") "*") ; before first heading
20786 (org-odd-levels-only "**") ; inside heading, odd
20787 (t "*"))) ; inside heading, oddeven
20788 (rpl (concat stars add-stars " "))
20789 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20790 (while (< (point) (if (equal nstars '(4)) lend end))
20791 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20792 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20793 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20794 (forward-line)))))))
20795 (unless toggled (message "Cannot toggle heading from here"))))
20797 (defun org-meta-return (&optional arg)
20798 "Insert a new heading or wrap a region in a table.
20799 Calls `org-insert-heading' or `org-table-wrap-region', depending
20800 on context. See the individual commands for more information."
20801 (interactive "P")
20802 (org-check-before-invisible-edit 'insert)
20803 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20804 (let* ((element (org-element-at-point))
20805 (type (org-element-type element)))
20806 (when (eq type 'table-row)
20807 (setq element (org-element-property :parent element))
20808 (setq type 'table))
20809 (if (and (eq type 'table)
20810 (eq (org-element-property :type element) 'org)
20811 (>= (point) (org-element-property :contents-begin element))
20812 (< (point) (org-element-property :contents-end element)))
20813 (call-interactively 'org-table-wrap-region)
20814 (call-interactively 'org-insert-heading)))))
20816 ;;; Menu entries
20818 (defsubst org-in-subtree-not-table-p ()
20819 "Are we in a subtree and not in a table?"
20820 (and (not (org-before-first-heading-p))
20821 (not (org-at-table-p))))
20823 ;; Define the Org-mode menus
20824 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20825 '("Tbl"
20826 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20827 ["Next Field" org-cycle (org-at-table-p)]
20828 ["Previous Field" org-shifttab (org-at-table-p)]
20829 ["Next Row" org-return (org-at-table-p)]
20830 "--"
20831 ["Blank Field" org-table-blank-field (org-at-table-p)]
20832 ["Edit Field" org-table-edit-field (org-at-table-p)]
20833 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20834 "--"
20835 ("Column"
20836 ["Move Column Left" org-metaleft (org-at-table-p)]
20837 ["Move Column Right" org-metaright (org-at-table-p)]
20838 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20839 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20840 ("Row"
20841 ["Move Row Up" org-metaup (org-at-table-p)]
20842 ["Move Row Down" org-metadown (org-at-table-p)]
20843 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20844 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20845 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20846 "--"
20847 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20848 ("Rectangle"
20849 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20850 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20851 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20852 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20853 "--"
20854 ("Calculate"
20855 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20856 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20857 ["Edit Formulas" org-edit-special (org-at-table-p)]
20858 "--"
20859 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20860 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20861 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20862 "--"
20863 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20864 "--"
20865 ["Sum Column/Rectangle" org-table-sum
20866 (or (org-at-table-p) (org-region-active-p))]
20867 ["Which Column?" org-table-current-column (org-at-table-p)])
20868 ["Debug Formulas"
20869 org-table-toggle-formula-debugger
20870 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20871 ["Show Col/Row Numbers"
20872 org-table-toggle-coordinate-overlays
20873 :style toggle
20874 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20875 "--"
20876 ["Create" org-table-create (and (not (org-at-table-p))
20877 org-enable-table-editor)]
20878 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20879 ["Import from File" org-table-import (not (org-at-table-p))]
20880 ["Export to File" org-table-export (org-at-table-p)]
20881 "--"
20882 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20884 (easy-menu-define org-org-menu org-mode-map "Org menu"
20885 '("Org"
20886 ("Show/Hide"
20887 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20888 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20889 ["Sparse Tree..." org-sparse-tree t]
20890 ["Reveal Context" org-reveal t]
20891 ["Show All" show-all t]
20892 "--"
20893 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20894 "--"
20895 ["New Heading" org-insert-heading t]
20896 ("Navigate Headings"
20897 ["Up" outline-up-heading t]
20898 ["Next" outline-next-visible-heading t]
20899 ["Previous" outline-previous-visible-heading t]
20900 ["Next Same Level" outline-forward-same-level t]
20901 ["Previous Same Level" outline-backward-same-level t]
20902 "--"
20903 ["Jump" org-goto t])
20904 ("Edit Structure"
20905 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20906 "--"
20907 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20908 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20909 "--"
20910 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20911 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20912 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20913 "--"
20914 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20915 "--"
20916 ["Copy visible text" org-copy-visible t]
20917 "--"
20918 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20919 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20920 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20921 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20922 "--"
20923 ["Sort Region/Children" org-sort t]
20924 "--"
20925 ["Convert to odd levels" org-convert-to-odd-levels t]
20926 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20927 ("Editing"
20928 ["Emphasis..." org-emphasize t]
20929 ["Edit Source Example" org-edit-special t]
20930 "--"
20931 ["Footnote new/jump" org-footnote-action t]
20932 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20933 ("Archive"
20934 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20935 "--"
20936 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20937 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20938 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20940 "--"
20941 ("Hyperlinks"
20942 ["Store Link (Global)" org-store-link t]
20943 ["Find existing link to here" org-occur-link-in-agenda-files t]
20944 ["Insert Link" org-insert-link t]
20945 ["Follow Link" org-open-at-point t]
20946 "--"
20947 ["Next link" org-next-link t]
20948 ["Previous link" org-previous-link t]
20949 "--"
20950 ["Descriptive Links"
20951 org-toggle-link-display
20952 :style radio
20953 :selected org-descriptive-links
20955 ["Literal Links"
20956 org-toggle-link-display
20957 :style radio
20958 :selected (not org-descriptive-links)])
20959 "--"
20960 ("TODO Lists"
20961 ["TODO/DONE/-" org-todo t]
20962 ("Select keyword"
20963 ["Next keyword" org-shiftright (org-at-heading-p)]
20964 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20965 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20966 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20967 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20968 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20969 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20970 "--"
20971 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20972 :selected org-enforce-todo-dependencies :style toggle :active t]
20973 "Settings for tree at point"
20974 ["Do Children sequentially" org-toggle-ordered-property :style radio
20975 :selected (org-entry-get nil "ORDERED")
20976 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20977 ["Do Children parallel" org-toggle-ordered-property :style radio
20978 :selected (not (org-entry-get nil "ORDERED"))
20979 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20980 "--"
20981 ["Set Priority" org-priority t]
20982 ["Priority Up" org-shiftup t]
20983 ["Priority Down" org-shiftdown t]
20984 "--"
20985 ["Get news from all feeds" org-feed-update-all t]
20986 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20987 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20988 ("TAGS and Properties"
20989 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20990 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20991 "--"
20992 ["Set property" org-set-property (not (org-before-first-heading-p))]
20993 ["Column view of properties" org-columns t]
20994 ["Insert Column View DBlock" org-insert-columns-dblock t])
20995 ("Dates and Scheduling"
20996 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20997 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20998 ("Change Date"
20999 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21000 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21001 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21002 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21003 ["Compute Time Range" org-evaluate-time-range t]
21004 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21005 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21006 "--"
21007 ["Custom time format" org-toggle-time-stamp-overlays
21008 :style radio :selected org-display-custom-times]
21009 "--"
21010 ["Goto Calendar" org-goto-calendar t]
21011 ["Date from Calendar" org-date-from-calendar t]
21012 "--"
21013 ["Start/Restart Timer" org-timer-start t]
21014 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21015 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21016 ["Insert Timer String" org-timer t]
21017 ["Insert Timer Item" org-timer-item t])
21018 ("Logging work"
21019 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21020 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21021 ["Clock out" org-clock-out t]
21022 ["Clock cancel" org-clock-cancel t]
21023 "--"
21024 ["Mark as default task" org-clock-mark-default-task t]
21025 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21026 ["Goto running clock" org-clock-goto t]
21027 "--"
21028 ["Display times" org-clock-display t]
21029 ["Create clock table" org-clock-report t]
21030 "--"
21031 ["Record DONE time"
21032 (progn (setq org-log-done (not org-log-done))
21033 (message "Switching to %s will %s record a timestamp"
21034 (car org-done-keywords)
21035 (if org-log-done "automatically" "not")))
21036 :style toggle :selected org-log-done])
21037 "--"
21038 ["Agenda Command..." org-agenda t]
21039 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21040 ("File List for Agenda")
21041 ("Special views current file"
21042 ["TODO Tree" org-show-todo-tree t]
21043 ["Check Deadlines" org-check-deadlines t]
21044 ["Timeline" org-timeline t]
21045 ["Tags/Property tree" org-match-sparse-tree t])
21046 "--"
21047 ["Export/Publish..." org-export-dispatch t]
21048 ("LaTeX"
21049 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21050 :selected org-cdlatex-mode]
21051 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21052 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21053 ["Modify math symbol" org-cdlatex-math-modify
21054 (org-inside-LaTeX-fragment-p)]
21055 ["Insert citation" org-reftex-citation t]
21056 "--"
21057 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21058 "--"
21059 ("MobileOrg"
21060 ["Push Files and Views" org-mobile-push t]
21061 ["Get Captured and Flagged" org-mobile-pull t]
21062 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21063 "--"
21064 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21065 "--"
21066 ("Documentation"
21067 ["Show Version" org-version t]
21068 ["Info Documentation" org-info t])
21069 ("Customize"
21070 ["Browse Org Group" org-customize t]
21071 "--"
21072 ["Expand This Menu" org-create-customize-menu
21073 (fboundp 'customize-menu-create)])
21074 ["Send bug report" org-submit-bug-report t]
21075 "--"
21076 ("Refresh/Reload"
21077 ["Refresh setup current buffer" org-mode-restart t]
21078 ["Reload Org (after update)" org-reload t]
21079 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21082 (defun org-info (&optional node)
21083 "Read documentation for Org-mode in the info system.
21084 With optional NODE, go directly to that node."
21085 (interactive)
21086 (info (format "(org)%s" (or node ""))))
21088 ;;;###autoload
21089 (defun org-submit-bug-report ()
21090 "Submit a bug report on Org-mode via mail.
21092 Don't hesitate to report any problems or inaccurate documentation.
21094 If you don't have setup sending mail from (X)Emacs, please copy the
21095 output buffer into your mail program, as it gives us important
21096 information about your Org-mode version and configuration."
21097 (interactive)
21098 (require 'reporter)
21099 (org-load-modules-maybe)
21100 (org-require-autoloaded-modules)
21101 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21102 (reporter-submit-bug-report
21103 "emacs-orgmode@gnu.org"
21104 (org-version nil 'full)
21105 (let (list)
21106 (save-window-excursion
21107 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21108 (delete-other-windows)
21109 (erase-buffer)
21110 (insert "You are about to submit a bug report to the Org-mode mailing list.
21112 We would like to add your full Org-mode and Outline configuration to the
21113 bug report. This greatly simplifies the work of the maintainer and
21114 other experts on the mailing list.
21116 HOWEVER, some variables you have customized may contain private
21117 information. The names of customers, colleagues, or friends, might
21118 appear in the form of file names, tags, todo states, or search strings.
21119 If you answer yes to the prompt, you might want to check and remove
21120 such private information before sending the email.")
21121 (add-text-properties (point-min) (point-max) '(face org-warning))
21122 (when (yes-or-no-p "Include your Org-mode configuration ")
21123 (mapatoms
21124 (lambda (v)
21125 (and (boundp v)
21126 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21127 (or (and (symbol-value v)
21128 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21129 (and
21130 (get v 'custom-type) (get v 'standard-value)
21131 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21132 (push v list)))))
21133 (kill-buffer (get-buffer "*Warn about privacy*"))
21134 list))
21135 nil nil
21136 "Remember to cover the basics, that is, what you expected to happen and
21137 what in fact did happen. You don't know how to make a good report? See
21139 http://orgmode.org/manual/Feedback.html#Feedback
21141 Your bug report will be posted to the Org-mode mailing list.
21142 ------------------------------------------------------------------------")
21143 (save-excursion
21144 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21145 (replace-match "\\1Bug: \\3 [\\2]")))))
21148 (defun org-install-agenda-files-menu ()
21149 (let ((bl (buffer-list)))
21150 (save-excursion
21151 (while bl
21152 (set-buffer (pop bl))
21153 (if (derived-mode-p 'org-mode) (setq bl nil)))
21154 (when (derived-mode-p 'org-mode)
21155 (easy-menu-change
21156 '("Org") "File List for Agenda"
21157 (append
21158 (list
21159 ["Edit File List" (org-edit-agenda-file-list) t]
21160 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21161 ["Remove Current File from List" org-remove-file t]
21162 ["Cycle through agenda files" org-cycle-agenda-files t]
21163 ["Occur in all agenda files" org-occur-in-agenda-files t]
21164 "--")
21165 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21167 ;;;; Documentation
21169 (defun org-require-autoloaded-modules ()
21170 (interactive)
21171 (mapc 'require
21172 '(org-agenda org-archive org-attach org-clock org-colview org-id
21173 org-table org-timer)))
21175 ;;;###autoload
21176 (defun org-reload (&optional uncompiled)
21177 "Reload all org lisp files.
21178 With prefix arg UNCOMPILED, load the uncompiled versions."
21179 (interactive "P")
21180 (require 'loadhist)
21181 (let* ((org-dir (org-find-library-dir "org"))
21182 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21183 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21184 (remove-re (mapconcat 'identity
21185 (mapcar (lambda (f) (concat "^" f "$"))
21186 (list (if (featurep 'xemacs)
21187 "org-colview"
21188 "org-colview-xemacs")
21189 "org" "org-loaddefs" "org-version"))
21190 "\\|"))
21191 (feats (delete-dups
21192 (mapcar 'file-name-sans-extension
21193 (mapcar 'file-name-nondirectory
21194 (delq nil
21195 (mapcar 'feature-file
21196 features))))))
21197 (lfeat (append
21198 (sort
21199 (setq feats
21200 (delq nil (mapcar
21201 (lambda (f)
21202 (if (and (string-match feature-re f)
21203 (not (string-match remove-re f)))
21204 f nil))
21205 feats)))
21206 'string-lessp)
21207 (list "org-version" "org")))
21208 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21209 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21210 load-uncore load-misses)
21211 (setq load-misses
21212 (delq 't
21213 (mapcar (lambda (f)
21214 (or (org-load-noerror-mustsuffix (concat org-dir f))
21215 (and (string= org-dir contrib-dir)
21216 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21217 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21218 (add-to-list 'load-uncore f 'append)
21221 lfeat)))
21222 (if load-uncore
21223 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21224 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21225 (if load-misses
21226 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21227 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21228 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21230 ;;;###autoload
21231 (defun org-customize ()
21232 "Call the customize function with org as argument."
21233 (interactive)
21234 (org-load-modules-maybe)
21235 (org-require-autoloaded-modules)
21236 (customize-browse 'org))
21238 (defun org-create-customize-menu ()
21239 "Create a full customization menu for Org-mode, insert it into the menu."
21240 (interactive)
21241 (org-load-modules-maybe)
21242 (org-require-autoloaded-modules)
21243 (if (fboundp 'customize-menu-create)
21244 (progn
21245 (easy-menu-change
21246 '("Org") "Customize"
21247 `(["Browse Org group" org-customize t]
21248 "--"
21249 ,(customize-menu-create 'org)
21250 ["Set" Custom-set t]
21251 ["Save" Custom-save t]
21252 ["Reset to Current" Custom-reset-current t]
21253 ["Reset to Saved" Custom-reset-saved t]
21254 ["Reset to Standard Settings" Custom-reset-standard t]))
21255 (message "\"Org\"-menu now contains full customization menu"))
21256 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21258 ;;;; Miscellaneous stuff
21260 ;;; Generally useful functions
21262 (defun org-get-at-bol (property)
21263 "Get text property PROPERTY at beginning of line."
21264 (get-text-property (point-at-bol) property))
21266 (defun org-find-text-property-in-string (prop s)
21267 "Return the first non-nil value of property PROP in string S."
21268 (or (get-text-property 0 prop s)
21269 (get-text-property (or (next-single-property-change 0 prop s) 0)
21270 prop s)))
21272 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21273 "Display the given MESSAGE as a warning."
21274 (if (fboundp 'display-warning)
21275 (display-warning 'org message
21276 (if (featurep 'xemacs) 'warning :warning))
21277 (let ((buf (get-buffer-create "*Org warnings*")))
21278 (with-current-buffer buf
21279 (goto-char (point-max))
21280 (insert "Warning (Org): " message)
21281 (unless (bolp)
21282 (newline)))
21283 (display-buffer buf)
21284 (sit-for 0))))
21286 (defun org-eval (form)
21287 "Eval FORM and return result."
21288 (condition-case error
21289 (eval form)
21290 (error (format "%%![Error: %s]" error))))
21292 (defun org-in-clocktable-p ()
21293 "Check if the cursor is in a clocktable."
21294 (let ((pos (point)) start)
21295 (save-excursion
21296 (end-of-line 1)
21297 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21298 (setq start (match-beginning 0))
21299 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21300 (>= (match-end 0) pos)
21301 start))))
21303 (defun org-in-commented-line ()
21304 "Is point in a line starting with `#'?"
21305 (equal (char-after (point-at-bol)) ?#))
21307 (defun org-in-indented-comment-line ()
21308 "Is point in a line starting with `#' after some white space?"
21309 (save-excursion
21310 (save-match-data
21311 (goto-char (point-at-bol))
21312 (looking-at "[ \t]*#"))))
21314 (defun org-in-verbatim-emphasis ()
21315 (save-match-data
21316 (and (org-in-regexp org-emph-re 2)
21317 (>= (point) (match-beginning 3))
21318 (<= (point) (match-end 4))
21319 (member (match-string 3) '("=" "~")))))
21321 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21322 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21323 (if (and marker (marker-buffer marker)
21324 (buffer-live-p (marker-buffer marker)))
21325 (progn
21326 (org-pop-to-buffer-same-window (marker-buffer marker))
21327 (if (or (> marker (point-max)) (< marker (point-min)))
21328 (widen))
21329 (goto-char marker)
21330 (org-show-context 'org-goto))
21331 (if bookmark
21332 (bookmark-jump bookmark)
21333 (error "Cannot find location"))))
21335 (defun org-quote-csv-field (s)
21336 "Quote field for inclusion in CSV material."
21337 (if (string-match "[\",]" s)
21338 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21341 (defun org-force-self-insert (N)
21342 "Needed to enforce self-insert under remapping."
21343 (interactive "p")
21344 (self-insert-command N))
21346 (defun org-string-width (s)
21347 "Compute width of string, ignoring invisible characters.
21348 This ignores character with invisibility property `org-link', and also
21349 characters with property `org-cwidth', because these will become invisible
21350 upon the next fontification round."
21351 (let (b l)
21352 (when (or (eq t buffer-invisibility-spec)
21353 (assq 'org-link buffer-invisibility-spec))
21354 (while (setq b (text-property-any 0 (length s)
21355 'invisible 'org-link s))
21356 (setq s (concat (substring s 0 b)
21357 (substring s (or (next-single-property-change
21358 b 'invisible s) (length s)))))))
21359 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21360 (setq s (concat (substring s 0 b)
21361 (substring s (or (next-single-property-change
21362 b 'org-cwidth s) (length s))))))
21363 (setq l (string-width s) b -1)
21364 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21365 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21368 (defun org-shorten-string (s maxlength)
21369 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21370 If the string is shorter or has length MAXLENGTH, just return the
21371 original string. If it is longer, the functions finds a space in the
21372 string, breaks this string off at that locations and adds three dots
21373 as ellipsis. Including the ellipsis, the string will not be longer
21374 than MAXLENGTH. If finding a good breaking point in the string does
21375 not work, the string is just chopped off in the middle of a word
21376 if necessary."
21377 (if (<= (length s) maxlength)
21379 (let* ((n (max (- maxlength 4) 1))
21380 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21381 (if (string-match re s)
21382 (concat (match-string 1 s) "...")
21383 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21385 (defun org-get-indentation (&optional line)
21386 "Get the indentation of the current line, interpreting tabs.
21387 When LINE is given, assume it represents a line and compute its indentation."
21388 (if line
21389 (if (string-match "^ *" (org-remove-tabs line))
21390 (match-end 0))
21391 (save-excursion
21392 (beginning-of-line 1)
21393 (skip-chars-forward " \t")
21394 (current-column))))
21396 (defun org-get-string-indentation (s)
21397 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21398 (let ((n -1) (i 0) (w tab-width) c)
21399 (catch 'exit
21400 (while (< (setq n (1+ n)) (length s))
21401 (setq c (aref s n))
21402 (cond ((= c ?\ ) (setq i (1+ i)))
21403 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21404 (t (throw 'exit t)))))
21407 (defun org-remove-tabs (s &optional width)
21408 "Replace tabulators in S with spaces.
21409 Assumes that s is a single line, starting in column 0."
21410 (setq width (or width tab-width))
21411 (while (string-match "\t" s)
21412 (setq s (replace-match
21413 (make-string
21414 (- (* width (/ (+ (match-beginning 0) width) width))
21415 (match-beginning 0)) ?\ )
21416 t t s)))
21419 (defun org-fix-indentation (line ind)
21420 "Fix indentation in LINE.
21421 IND is a cons cell with target and minimum indentation.
21422 If the current indentation in LINE is smaller than the minimum,
21423 leave it alone. If it is larger than ind, set it to the target."
21424 (let* ((l (org-remove-tabs line))
21425 (i (org-get-indentation l))
21426 (i1 (car ind)) (i2 (cdr ind)))
21427 (if (>= i i2) (setq l (substring line i2)))
21428 (if (> i1 0)
21429 (concat (make-string i1 ?\ ) l)
21430 l)))
21432 (defun org-remove-indentation (code &optional n)
21433 "Remove the maximum common indentation from the lines in CODE.
21434 N may optionally be the number of spaces to remove."
21435 (with-temp-buffer
21436 (insert code)
21437 (org-do-remove-indentation n)
21438 (buffer-string)))
21440 (defun org-do-remove-indentation (&optional n)
21441 "Remove the maximum common indentation from the buffer."
21442 (untabify (point-min) (point-max))
21443 (let ((min 10000) re)
21444 (if n
21445 (setq min n)
21446 (goto-char (point-min))
21447 (while (re-search-forward "^ *[^ \n]" nil t)
21448 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21449 (unless (or (= min 0) (= min 10000))
21450 (setq re (format "^ \\{%d\\}" min))
21451 (goto-char (point-min))
21452 (while (re-search-forward re nil t)
21453 (replace-match "")
21454 (end-of-line 1))
21455 min)))
21457 (defun org-fill-template (template alist)
21458 "Find each %key of ALIST in TEMPLATE and replace it."
21459 (let ((case-fold-search nil)
21460 entry key value)
21461 (setq alist (sort (copy-sequence alist)
21462 (lambda (a b) (< (length (car a)) (length (car b))))))
21463 (while (setq entry (pop alist))
21464 (setq template
21465 (replace-regexp-in-string
21466 (concat "%" (regexp-quote (car entry)))
21467 (or (cdr entry) "") template t t)))
21468 template))
21470 (defun org-base-buffer (buffer)
21471 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21472 (if (not buffer)
21473 buffer
21474 (or (buffer-base-buffer buffer)
21475 buffer)))
21477 (defun org-trim (s)
21478 "Remove whitespace at beginning and end of string."
21479 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21480 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21483 (defun org-wrap (string &optional width lines)
21484 "Wrap string to either a number of lines, or a width in characters.
21485 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21486 that costs. If there is a word longer than WIDTH, the text is actually
21487 wrapped to the length of that word.
21488 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21489 many lines, whatever width that takes.
21490 The return value is a list of lines, without newlines at the end."
21491 (let* ((words (org-split-string string "[ \t\n]+"))
21492 (maxword (apply 'max (mapcar 'org-string-width words)))
21493 w ll)
21494 (cond (width
21495 (org-do-wrap words (max maxword width)))
21496 (lines
21497 (setq w maxword)
21498 (setq ll (org-do-wrap words maxword))
21499 (if (<= (length ll) lines)
21501 (setq ll words)
21502 (while (> (length ll) lines)
21503 (setq w (1+ w))
21504 (setq ll (org-do-wrap words w)))
21505 ll))
21506 (t (error "Cannot wrap this")))))
21508 (defun org-do-wrap (words width)
21509 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21510 (let (lines line)
21511 (while words
21512 (setq line (pop words))
21513 (while (and words (< (+ (length line) (length (car words))) width))
21514 (setq line (concat line " " (pop words))))
21515 (setq lines (push line lines)))
21516 (nreverse lines)))
21518 (defun org-split-string (string &optional separators)
21519 "Splits STRING into substrings at SEPARATORS.
21520 No empty strings are returned if there are matches at the beginning
21521 and end of string."
21522 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21523 (start 0)
21524 notfirst
21525 (list nil))
21526 (while (and (string-match rexp string
21527 (if (and notfirst
21528 (= start (match-beginning 0))
21529 (< start (length string)))
21530 (1+ start) start))
21531 (< (match-beginning 0) (length string)))
21532 (setq notfirst t)
21533 (or (eq (match-beginning 0) 0)
21534 (and (eq (match-beginning 0) (match-end 0))
21535 (eq (match-beginning 0) start))
21536 (setq list
21537 (cons (substring string start (match-beginning 0))
21538 list)))
21539 (setq start (match-end 0)))
21540 (or (eq start (length string))
21541 (setq list
21542 (cons (substring string start)
21543 list)))
21544 (nreverse list)))
21546 (defun org-quote-vert (s)
21547 "Replace \"|\" with \"\\vert\"."
21548 (while (string-match "|" s)
21549 (setq s (replace-match "\\vert" t t s)))
21552 (defun org-uuidgen-p (s)
21553 "Is S an ID created by UUIDGEN?"
21554 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21556 (defun org-in-src-block-p (&optional inside)
21557 "Whether point is in a code source block.
21558 When INSIDE is non-nil, don't consider we are within a src block
21559 when point is at #+BEGIN_SRC or #+END_SRC."
21560 (let ((case-fold-search t) ov)
21561 (or (and (setq ov (overlays-at (point)))
21562 (memq 'org-block-background
21563 (overlay-properties (car ov))))
21564 (and (not inside)
21565 (save-match-data
21566 (save-excursion
21567 (beginning-of-line)
21568 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21570 (defun org-context ()
21571 "Return a list of contexts of the current cursor position.
21572 If several contexts apply, all are returned.
21573 Each context entry is a list with a symbol naming the context, and
21574 two positions indicating start and end of the context. Possible
21575 contexts are:
21577 :headline anywhere in a headline
21578 :headline-stars on the leading stars in a headline
21579 :todo-keyword on a TODO keyword (including DONE) in a headline
21580 :tags on the TAGS in a headline
21581 :priority on the priority cookie in a headline
21582 :item on the first line of a plain list item
21583 :item-bullet on the bullet/number of a plain list item
21584 :checkbox on the checkbox in a plain list item
21585 :table in an org-mode table
21586 :table-special on a special filed in a table
21587 :table-table in a table.el table
21588 :clocktable in a clocktable
21589 :src-block in a source block
21590 :link on a hyperlink
21591 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21592 :target on a <<target>>
21593 :radio-target on a <<<radio-target>>>
21594 :latex-fragment on a LaTeX fragment
21595 :latex-preview on a LaTeX fragment with overlaid preview image
21597 This function expects the position to be visible because it uses font-lock
21598 faces as a help to recognize the following contexts: :table-special, :link,
21599 and :keyword."
21600 (let* ((f (get-text-property (point) 'face))
21601 (faces (if (listp f) f (list f)))
21602 (case-fold-search t)
21603 (p (point)) clist o)
21604 ;; First the large context
21605 (cond
21606 ((org-at-heading-p t)
21607 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21608 (when (progn
21609 (beginning-of-line 1)
21610 (looking-at org-todo-line-tags-regexp))
21611 (push (org-point-in-group p 1 :headline-stars) clist)
21612 (push (org-point-in-group p 2 :todo-keyword) clist)
21613 (push (org-point-in-group p 4 :tags) clist))
21614 (goto-char p)
21615 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21616 (if (looking-at "\\[#[A-Z0-9]\\]")
21617 (push (org-point-in-group p 0 :priority) clist)))
21619 ((org-at-item-p)
21620 (push (org-point-in-group p 2 :item-bullet) clist)
21621 (push (list :item (point-at-bol)
21622 (save-excursion (org-end-of-item) (point)))
21623 clist)
21624 (and (org-at-item-checkbox-p)
21625 (push (org-point-in-group p 0 :checkbox) clist)))
21627 ((org-at-table-p)
21628 (push (list :table (org-table-begin) (org-table-end)) clist)
21629 (if (memq 'org-formula faces)
21630 (push (list :table-special
21631 (previous-single-property-change p 'face)
21632 (next-single-property-change p 'face)) clist)))
21633 ((org-at-table-p 'any)
21634 (push (list :table-table) clist)))
21635 (goto-char p)
21637 (let ((case-fold-search t))
21638 ;; New the "medium" contexts: clocktables, source blocks
21639 (cond ((org-in-clocktable-p)
21640 (push (list :clocktable
21641 (and (or (looking-at "#\\+BEGIN: clocktable")
21642 (search-backward "#+BEGIN: clocktable" nil t))
21643 (match-beginning 0))
21644 (and (re-search-forward "#\\+END:?" nil t)
21645 (match-end 0))) clist))
21646 ((org-in-src-block-p)
21647 (push (list :src-block
21648 (and (or (looking-at "#\\+BEGIN_SRC")
21649 (search-backward "#+BEGIN_SRC" nil t))
21650 (match-beginning 0))
21651 (and (search-forward "#+END_SRC" nil t)
21652 (match-beginning 0))) clist))))
21653 (goto-char p)
21655 ;; Now the small context
21656 (cond
21657 ((org-at-timestamp-p)
21658 (push (org-point-in-group p 0 :timestamp) clist))
21659 ((memq 'org-link faces)
21660 (push (list :link
21661 (previous-single-property-change p 'face)
21662 (next-single-property-change p 'face)) clist))
21663 ((memq 'org-special-keyword faces)
21664 (push (list :keyword
21665 (previous-single-property-change p 'face)
21666 (next-single-property-change p 'face)) clist))
21667 ((org-at-target-p)
21668 (push (org-point-in-group p 0 :target) clist)
21669 (goto-char (1- (match-beginning 0)))
21670 (if (looking-at org-radio-target-regexp)
21671 (push (org-point-in-group p 0 :radio-target) clist))
21672 (goto-char p))
21673 ((setq o (car (delq nil
21674 (mapcar
21675 (lambda (x)
21676 (if (memq x org-latex-fragment-image-overlays) x))
21677 (overlays-at (point))))))
21678 (push (list :latex-fragment
21679 (overlay-start o) (overlay-end o)) clist)
21680 (push (list :latex-preview
21681 (overlay-start o) (overlay-end o)) clist))
21682 ((org-inside-LaTeX-fragment-p)
21683 ;; FIXME: positions wrong.
21684 (push (list :latex-fragment (point) (point)) clist)))
21686 (setq clist (nreverse (delq nil clist)))
21687 clist))
21689 ;; FIXME: Compare with at-regexp-p Do we need both?
21690 (defun org-in-regexp (re &optional nlines visually)
21691 "Check if point is inside a match of regexp.
21692 Normally only the current line is checked, but you can include NLINES extra
21693 lines both before and after point into the search.
21694 If VISUALLY is set, require that the cursor is not after the match but
21695 really on, so that the block visually is on the match."
21696 (catch 'exit
21697 (let ((pos (point))
21698 (eol (point-at-eol (+ 1 (or nlines 0))))
21699 (inc (if visually 1 0)))
21700 (save-excursion
21701 (beginning-of-line (- 1 (or nlines 0)))
21702 (while (re-search-forward re eol t)
21703 (if (and (<= (match-beginning 0) pos)
21704 (>= (+ inc (match-end 0)) pos))
21705 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21707 (defun org-at-regexp-p (regexp)
21708 "Is point inside a match of REGEXP in the current line?"
21709 (catch 'exit
21710 (save-excursion
21711 (let ((pos (point)) (end (point-at-eol)))
21712 (beginning-of-line 1)
21713 (while (re-search-forward regexp end t)
21714 (if (and (<= (match-beginning 0) pos)
21715 (>= (match-end 0) pos))
21716 (throw 'exit t)))
21717 nil))))
21719 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21720 "Non-nil when point is between matches of START-RE and END-RE.
21722 Also return a non-nil value when point is on one of the matches.
21724 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21725 buffer positions. Default values are the positions of headlines
21726 surrounding the point.
21728 The functions returns a cons cell whose car (resp. cdr) is the
21729 position before START-RE (resp. after END-RE)."
21730 (save-match-data
21731 (let ((pos (point))
21732 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21733 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21734 beg end)
21735 (save-excursion
21736 ;; Point is on a block when on START-RE or if START-RE can be
21737 ;; found before it...
21738 (and (or (org-at-regexp-p start-re)
21739 (re-search-backward start-re limit-up t))
21740 (setq beg (match-beginning 0))
21741 ;; ... and END-RE after it...
21742 (goto-char (match-end 0))
21743 (re-search-forward end-re limit-down t)
21744 (> (setq end (match-end 0)) pos)
21745 ;; ... without another START-RE in-between.
21746 (goto-char (match-beginning 0))
21747 (not (re-search-backward start-re (1+ beg) t))
21748 ;; Return value.
21749 (cons beg end))))))
21751 (defun org-in-block-p (names)
21752 "Non-nil when point belongs to a block whose name belongs to NAMES.
21754 NAMES is a list of strings containing names of blocks.
21756 Return first block name matched, or nil. Beware that in case of
21757 nested blocks, the returned name may not belong to the closest
21758 block from point."
21759 (save-match-data
21760 (catch 'exit
21761 (let ((case-fold-search t)
21762 (lim-up (save-excursion (outline-previous-heading)))
21763 (lim-down (save-excursion (outline-next-heading))))
21764 (mapc (lambda (name)
21765 (let ((n (regexp-quote name)))
21766 (when (org-between-regexps-p
21767 (concat "^[ \t]*#\\+begin_" n)
21768 (concat "^[ \t]*#\\+end_" n)
21769 lim-up lim-down)
21770 (throw 'exit n))))
21771 names))
21772 nil)))
21774 (defun org-in-drawer-p ()
21775 "Is point within a drawer?"
21776 (save-match-data
21777 (let ((case-fold-search t)
21778 (lim-up (save-excursion (outline-previous-heading)))
21779 (lim-down (save-excursion (outline-next-heading))))
21780 (org-between-regexps-p
21781 (concat "^[ \t]*:" (regexp-opt org-drawers) ":")
21782 "^[ \t]*:end:.*$"
21783 lim-up lim-down))))
21785 (defun org-occur-in-agenda-files (regexp &optional nlines)
21786 "Call `multi-occur' with buffers for all agenda files."
21787 (interactive "sOrg-files matching: \np")
21788 (let* ((files (org-agenda-files))
21789 (tnames (mapcar 'file-truename files))
21790 (extra org-agenda-text-search-extra-files)
21792 (when (eq (car extra) 'agenda-archives)
21793 (setq extra (cdr extra))
21794 (setq files (org-add-archive-files files)))
21795 (while (setq f (pop extra))
21796 (unless (member (file-truename f) tnames)
21797 (add-to-list 'files f 'append)
21798 (add-to-list 'tnames (file-truename f) 'append)))
21799 (multi-occur
21800 (mapcar (lambda (x)
21801 (with-current-buffer
21802 (or (get-file-buffer x) (find-file-noselect x))
21803 (widen)
21804 (current-buffer)))
21805 files)
21806 regexp)))
21808 (if (boundp 'occur-mode-find-occurrence-hook)
21809 ;; Emacs 23
21810 (add-hook 'occur-mode-find-occurrence-hook
21811 (lambda ()
21812 (when (derived-mode-p 'org-mode)
21813 (org-reveal))))
21814 ;; Emacs 22
21815 (defadvice occur-mode-goto-occurrence
21816 (after org-occur-reveal activate)
21817 (and (derived-mode-p 'org-mode) (org-reveal)))
21818 (defadvice occur-mode-goto-occurrence-other-window
21819 (after org-occur-reveal activate)
21820 (and (derived-mode-p 'org-mode) (org-reveal)))
21821 (defadvice occur-mode-display-occurrence
21822 (after org-occur-reveal activate)
21823 (when (derived-mode-p 'org-mode)
21824 (let ((pos (occur-mode-find-occurrence)))
21825 (with-current-buffer (marker-buffer pos)
21826 (save-excursion
21827 (goto-char pos)
21828 (org-reveal)))))))
21830 (defun org-occur-link-in-agenda-files ()
21831 "Create a link and search for it in the agendas.
21832 The link is not stored in `org-stored-links', it is just created
21833 for the search purpose."
21834 (interactive)
21835 (let ((link (condition-case nil
21836 (org-store-link nil)
21837 (error "Unable to create a link to here"))))
21838 (org-occur-in-agenda-files (regexp-quote link))))
21840 (defun org-reverse-string (string)
21841 "Return the reverse of STRING."
21842 (apply 'string (reverse (string-to-list string))))
21844 ;; defsubst org-uniquify must be defined before first use
21846 (defun org-uniquify-alist (alist)
21847 "Merge elements of ALIST with the same key.
21849 For example, in this alist:
21851 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21852 => '((a 1 3) (b 2))
21854 merge (a 1) and (a 3) into (a 1 3).
21856 The function returns the new ALIST."
21857 (let (rtn)
21858 (mapc
21859 (lambda (e)
21860 (let (n)
21861 (if (not (assoc (car e) rtn))
21862 (push e rtn)
21863 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21864 (setq rtn (assq-delete-all (car e) rtn))
21865 (push n rtn))))
21866 alist)
21867 rtn))
21869 (defun org-delete-all (elts list)
21870 "Remove all elements in ELTS from LIST."
21871 (while elts
21872 (setq list (delete (pop elts) list)))
21873 list)
21875 (defun org-count (cl-item cl-seq)
21876 "Count the number of occurrences of ITEM in SEQ.
21877 Taken from `count' in cl-seq.el with all keyword arguments removed."
21878 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21879 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21880 (while (< cl-start cl-end)
21881 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21882 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21883 (setq cl-start (1+ cl-start)))
21884 cl-count))
21886 (defun org-remove-if (predicate seq)
21887 "Remove everything from SEQ that fulfills PREDICATE."
21888 (let (res e)
21889 (while seq
21890 (setq e (pop seq))
21891 (if (not (funcall predicate e)) (push e res)))
21892 (nreverse res)))
21894 (defun org-remove-if-not (predicate seq)
21895 "Remove everything from SEQ that does not fulfill PREDICATE."
21896 (let (res e)
21897 (while seq
21898 (setq e (pop seq))
21899 (if (funcall predicate e) (push e res)))
21900 (nreverse res)))
21902 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21903 "Reduce two-argument FUNCTION across SEQ.
21904 Taken from `reduce' in cl-seq.el with all keyword arguments but
21905 \":initial-value\" removed."
21906 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21907 (cadr (memq :initial-value cl-keys)))
21908 (cl-seq (pop cl-seq))
21909 (t (funcall cl-func)))))
21910 (while cl-seq
21911 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21912 cl-accum))
21914 (defun org-every (pred seq)
21915 "Return true if PREDICATE is true of every element of SEQ.
21916 Adapted from `every' in cl.el."
21917 (catch 'org-every
21918 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21921 (defun org-some (pred seq)
21922 "Return true if PREDICATE is true of any element of SEQ.
21923 Adapted from `some' in cl.el."
21924 (catch 'org-some
21925 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21926 nil))
21928 (defun org-back-over-empty-lines ()
21929 "Move backwards over whitespace, to the beginning of the first empty line.
21930 Returns the number of empty lines passed."
21931 (let ((pos (point)))
21932 (if (cdr (assoc 'heading org-blank-before-new-entry))
21933 (skip-chars-backward " \t\n\r")
21934 (unless (eobp)
21935 (forward-line -1)))
21936 (beginning-of-line 2)
21937 (goto-char (min (point) pos))
21938 (count-lines (point) pos)))
21940 (defun org-skip-whitespace ()
21941 (skip-chars-forward " \t\n\r"))
21943 (defun org-point-in-group (point group &optional context)
21944 "Check if POINT is in match-group GROUP.
21945 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21946 match. If the match group does not exist or point is not inside it,
21947 return nil."
21948 (and (match-beginning group)
21949 (>= point (match-beginning group))
21950 (<= point (match-end group))
21951 (if context
21952 (list context (match-beginning group) (match-end group))
21953 t)))
21955 (defun org-switch-to-buffer-other-window (&rest args)
21956 "Switch to buffer in a second window on the current frame.
21957 In particular, do not allow pop-up frames.
21958 Returns the newly created buffer."
21959 (org-no-popups
21960 (apply 'switch-to-buffer-other-window args)))
21962 (defun org-combine-plists (&rest plists)
21963 "Create a single property list from all plists in PLISTS.
21964 The process starts by copying the first list, and then setting properties
21965 from the other lists. Settings in the last list are the most significant
21966 ones and overrule settings in the other lists."
21967 (let ((rtn (copy-sequence (pop plists)))
21968 p v ls)
21969 (while plists
21970 (setq ls (pop plists))
21971 (while ls
21972 (setq p (pop ls) v (pop ls))
21973 (setq rtn (plist-put rtn p v))))
21974 rtn))
21976 (defun org-replace-escapes (string table)
21977 "Replace %-escapes in STRING with values in TABLE.
21978 TABLE is an association list with keys like \"%a\" and string values.
21979 The sequences in STRING may contain normal field width and padding information,
21980 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
21981 so values can contain further %-escapes if they are define later in TABLE."
21982 (let ((tbl (copy-alist table))
21983 (case-fold-search nil)
21984 (pchg 0)
21985 e re rpl)
21986 (while (setq e (pop tbl))
21987 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21988 (when (and (cdr e) (string-match re (cdr e)))
21989 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21990 (safe "SREF"))
21991 (add-text-properties 0 3 (list 'sref sref) safe)
21992 (setcdr e (replace-match safe t t (cdr e)))))
21993 (while (string-match re string)
21994 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21995 (cdr e)))
21996 (setq string (replace-match rpl t t string))))
21997 (while (setq pchg (next-property-change pchg string))
21998 (let ((sref (get-text-property pchg 'sref string)))
21999 (when (and sref (string-match "SREF" string pchg))
22000 (setq string (replace-match sref t t string)))))
22001 string))
22003 (defun org-sublist (list start end)
22004 "Return a section of LIST, from START to END.
22005 Counting starts at 1."
22006 (let (rtn (c start))
22007 (setq list (nthcdr (1- start) list))
22008 (while (and list (<= c end))
22009 (push (pop list) rtn)
22010 (setq c (1+ c)))
22011 (nreverse rtn)))
22013 (defun org-find-base-buffer-visiting (file)
22014 "Like `find-buffer-visiting' but always return the base buffer and
22015 not an indirect buffer."
22016 (let ((buf (or (get-file-buffer file)
22017 (find-buffer-visiting file))))
22018 (if buf
22019 (or (buffer-base-buffer buf) buf)
22020 nil)))
22022 (defun org-image-file-name-regexp (&optional extensions)
22023 "Return regexp matching the file names of images.
22024 If EXTENSIONS is given, only match these."
22025 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22026 (image-file-name-regexp)
22027 (let ((image-file-name-extensions
22028 (or extensions
22029 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22030 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22031 (concat "\\."
22032 (regexp-opt (nconc (mapcar 'upcase
22033 image-file-name-extensions)
22034 image-file-name-extensions)
22036 "\\'"))))
22038 (defun org-file-image-p (file &optional extensions)
22039 "Return non-nil if FILE is an image."
22040 (save-match-data
22041 (string-match (org-image-file-name-regexp extensions) file)))
22043 (defun org-get-cursor-date (&optional with-time)
22044 "Return the date at cursor in as a time.
22045 This works in the calendar and in the agenda, anywhere else it just
22046 returns the current time.
22047 If WITH-TIME is non-nil, returns the time of the event at point (in
22048 the agenda) or the current time of the day."
22049 (let (date day defd tp tm hod mod)
22050 (when with-time
22051 (setq tp (get-text-property (point) 'time))
22052 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22053 (setq hod (string-to-number (match-string 1 tp))
22054 mod (string-to-number (match-string 2 tp))))
22055 (or tp (setq hod (nth 2 (decode-time (current-time)))
22056 mod (nth 1 (decode-time (current-time))))))
22057 (cond
22058 ((eq major-mode 'calendar-mode)
22059 (setq date (calendar-cursor-to-date)
22060 defd (encode-time 0 (or mod 0) (or hod 0)
22061 (nth 1 date) (nth 0 date) (nth 2 date))))
22062 ((eq major-mode 'org-agenda-mode)
22063 (setq day (get-text-property (point) 'day))
22064 (if day
22065 (setq date (calendar-gregorian-from-absolute day)
22066 defd (encode-time 0 (or mod 0) (or hod 0)
22067 (nth 1 date) (nth 0 date) (nth 2 date))))))
22068 (or defd (current-time))))
22070 (defun org-mark-subtree (&optional up)
22071 "Mark the current subtree.
22072 This puts point at the start of the current subtree, and mark at
22073 the end. If a numeric prefix UP is given, move up into the
22074 hierarchy of headlines by UP levels before marking the subtree."
22075 (interactive "P")
22076 (org-with-limited-levels
22077 (cond ((org-at-heading-p) (beginning-of-line))
22078 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22079 (t (outline-previous-visible-heading 1))))
22080 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22081 (if (org-called-interactively-p 'any)
22082 (call-interactively 'org-mark-element)
22083 (org-mark-element)))
22086 ;;; Indentation
22088 (defun org-indent-line ()
22089 "Indent line depending on context."
22090 (interactive)
22091 (let* ((pos (point))
22092 (itemp (org-at-item-p))
22093 (case-fold-search t)
22094 (org-drawer-regexp (or org-drawer-regexp "\000"))
22095 (inline-task-p (and (featurep 'org-inlinetask)
22096 (org-inlinetask-in-task-p)))
22097 (inline-re (and inline-task-p
22098 (org-inlinetask-outline-regexp)))
22099 column)
22100 (if (and orgstruct-is-++ (eq pos (point)))
22101 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22102 (indent-according-to-mode))
22103 (beginning-of-line 1)
22104 (cond
22105 ;; Headings
22106 ((looking-at org-outline-regexp) (setq column 0))
22107 ;; Footnote definition
22108 ((looking-at org-footnote-definition-re) (setq column 0))
22109 ;; Literal examples
22110 ((looking-at "[ \t]*:\\( \\|$\\)")
22111 (setq column (org-get-indentation))) ; do nothing
22112 ;; Lists
22113 ((ignore-errors (goto-char (org-in-item-p)))
22114 (setq column (if itemp
22115 (org-get-indentation)
22116 (org-list-item-body-column (point))))
22117 (goto-char pos))
22118 ;; Drawers
22119 ((and (looking-at "[ \t]*:END:")
22120 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22121 (save-excursion
22122 (goto-char (1- (match-beginning 1)))
22123 (setq column (current-column))))
22124 ;; Special blocks
22125 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22126 (save-excursion
22127 (re-search-backward
22128 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22129 (setq column (org-get-indentation (match-string 0))))
22130 ((and (not (looking-at "[ \t]*#\\+begin_"))
22131 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22132 (save-excursion
22133 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22134 (setq column
22135 (cond ((equal (downcase (match-string 1)) "src")
22136 ;; src blocks: let `org-edit-src-exit' handle them
22137 (org-get-indentation))
22138 ((equal (downcase (match-string 1)) "example")
22139 (max (org-get-indentation)
22140 (org-get-indentation (match-string 0))))
22142 (org-get-indentation (match-string 0))))))
22143 ;; This line has nothing special, look at the previous relevant
22144 ;; line to compute indentation
22146 (beginning-of-line 0)
22147 (while (and (not (bobp))
22148 (not (looking-at org-table-line-regexp))
22149 (not (looking-at org-drawer-regexp))
22150 ;; When point started in an inline task, do not move
22151 ;; above task starting line.
22152 (not (and inline-task-p (looking-at inline-re)))
22153 ;; Skip drawers, blocks, empty lines, verbatim,
22154 ;; comments, tables, footnotes definitions, lists,
22155 ;; inline tasks.
22156 (or (and (looking-at "[ \t]*:END:")
22157 (re-search-backward org-drawer-regexp nil t))
22158 (and (looking-at "[ \t]*#\\+end_")
22159 (re-search-backward "[ \t]*#\\+begin_"nil t))
22160 (looking-at "[ \t]*[\n:#|]")
22161 (looking-at org-footnote-definition-re)
22162 (and (not inline-task-p)
22163 (featurep 'org-inlinetask)
22164 (org-inlinetask-in-task-p)
22165 (or (org-inlinetask-goto-beginning) t))))
22166 (beginning-of-line 0))
22167 (cond
22168 ;; There was a list item above.
22169 ((ignore-errors (goto-char (org-in-item-p)))
22170 (goto-char (org-list-get-top-point (org-list-struct)))
22171 (setq column (org-get-indentation)))
22172 ;; There was an heading above.
22173 ((looking-at "\\*+[ \t]+")
22174 (if (not org-adapt-indentation)
22175 (setq column 0)
22176 (goto-char (match-end 0))
22177 (setq column (current-column))))
22178 ;; A drawer had started and is unfinished
22179 ((looking-at org-drawer-regexp)
22180 (goto-char (1- (match-beginning 1)))
22181 (setq column (current-column)))
22182 ;; Else, nothing noticeable found: get indentation and go on.
22183 (t (setq column (org-get-indentation))))))
22184 ;; Now apply indentation and move cursor accordingly
22185 (goto-char pos)
22186 (if (<= (current-column) (current-indentation))
22187 (org-indent-line-to column)
22188 (save-excursion (org-indent-line-to column)))
22189 ;; Special polishing for properties, see `org-property-format'
22190 (setq column (current-column))
22191 (beginning-of-line 1)
22192 (if (looking-at org-property-re)
22193 (replace-match (concat (match-string 4)
22194 (format org-property-format
22195 (match-string 1) (match-string 3)))
22196 t t))
22197 (org-move-to-column column))))
22199 (defun org-indent-drawer ()
22200 "Indent the drawer at point."
22201 (interactive)
22202 (let ((p (point))
22203 (e (and (save-excursion (re-search-forward ":END:" nil t))
22204 (match-end 0)))
22205 (folded
22206 (save-excursion
22207 (end-of-line)
22208 (when (overlays-at (point))
22209 (member 'invisible (overlay-properties
22210 (car (overlays-at (point)))))))))
22211 (when folded (org-cycle))
22212 (indent-for-tab-command)
22213 (while (and (move-beginning-of-line 2) (< (point) e))
22214 (indent-for-tab-command))
22215 (goto-char p)
22216 (when folded (org-cycle)))
22217 (message "Drawer at point indented"))
22219 (defun org-indent-block ()
22220 "Indent the block at point."
22221 (interactive)
22222 (let ((p (point))
22223 (case-fold-search t)
22224 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22225 (match-end 0)))
22226 (folded
22227 (save-excursion
22228 (end-of-line)
22229 (when (overlays-at (point))
22230 (member 'invisible (overlay-properties
22231 (car (overlays-at (point)))))))))
22232 (when folded (org-cycle))
22233 (indent-for-tab-command)
22234 (while (and (move-beginning-of-line 2) (< (point) e))
22235 (indent-for-tab-command))
22236 (goto-char p)
22237 (when folded (org-cycle)))
22238 (message "Block at point indented"))
22240 (defun org-indent-region (start end)
22241 "Indent region."
22242 (interactive "r")
22243 (save-excursion
22244 (let ((line-end (org-current-line end)))
22245 (goto-char start)
22246 (while (< (org-current-line) line-end)
22247 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22248 (t (call-interactively 'org-indent-line)))
22249 (move-beginning-of-line 2)))))
22252 ;;; Filling
22254 ;; We use our own fill-paragraph and auto-fill functions.
22256 ;; `org-fill-paragraph' relies on adaptive filling and context
22257 ;; checking. Appropriate `fill-prefix' is computed with
22258 ;; `org-adaptive-fill-function'.
22260 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22261 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22262 ;; `org-adaptive-fill-function' value. Internally,
22263 ;; `org-comment-line-break-function' breaks the line.
22265 ;; `org-setup-filling' installs filling and auto-filling related
22266 ;; variables during `org-mode' initialization.
22268 (defvar org-element-paragraph-separate) ; org-element.el
22269 (defun org-setup-filling ()
22270 (require 'org-element)
22271 ;; Prevent auto-fill from inserting unwanted new items.
22272 (when (boundp 'fill-nobreak-predicate)
22273 (org-set-local
22274 'fill-nobreak-predicate
22275 (org-uniquify
22276 (append fill-nobreak-predicate
22277 '(org-fill-line-break-nobreak-p
22278 org-fill-paragraph-with-timestamp-nobreak-p)))))
22279 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22280 (org-set-local 'paragraph-start paragraph-ending)
22281 (org-set-local 'paragraph-separate paragraph-ending))
22282 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22283 (org-set-local 'auto-fill-inhibit-regexp nil)
22284 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22285 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22286 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22288 (defun org-fill-line-break-nobreak-p ()
22289 "Non-nil when a new line at point would create an Org line break."
22290 (save-excursion
22291 (skip-chars-backward "[ \t]")
22292 (skip-chars-backward "\\\\")
22293 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22295 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22296 "Non-nil when a new line at point would split a timestamp."
22297 (and (org-at-timestamp-p t)
22298 (not (looking-at org-ts-regexp-both))))
22300 (declare-function message-in-body-p "message" ())
22301 (defvar orgtbl-line-start-regexp) ; From org-table.el
22302 (defun org-adaptive-fill-function ()
22303 "Compute a fill prefix for the current line.
22304 Return fill prefix, as a string, or nil if current line isn't
22305 meant to be filled. For convenience, if `adaptive-fill-regexp'
22306 matches in paragraphs or comments, use it."
22307 (catch 'exit
22308 (when (derived-mode-p 'message-mode)
22309 (save-excursion
22310 (beginning-of-line)
22311 (cond ((or (not (message-in-body-p))
22312 (looking-at orgtbl-line-start-regexp))
22313 (throw 'exit nil))
22314 ((looking-at message-cite-prefix-regexp)
22315 (throw 'exit (match-string-no-properties 0)))
22316 ((looking-at org-outline-regexp)
22317 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22318 (org-with-wide-buffer
22319 (let* ((p (line-beginning-position))
22320 (element (save-excursion
22321 (beginning-of-line)
22322 (or (ignore-errors (org-element-at-point))
22323 (user-error "An element cannot be parsed line %d"
22324 (line-number-at-pos (point))))))
22325 (type (org-element-type element))
22326 (post-affiliated (org-element-property :post-affiliated element)))
22327 (unless (and post-affiliated (< p post-affiliated))
22328 (case type
22329 (comment
22330 (save-excursion
22331 (beginning-of-line)
22332 (looking-at "[ \t]*")
22333 (concat (match-string 0) "# ")))
22334 (footnote-definition "")
22335 ((item plain-list)
22336 (make-string (org-list-item-body-column
22337 (or post-affiliated
22338 (org-element-property :begin element)))
22339 ? ))
22340 (paragraph
22341 ;; Fill prefix is usually the same as the current line,
22342 ;; unless the paragraph is at the beginning of an item.
22343 (let ((parent (org-element-property :parent element)))
22344 (save-excursion
22345 (beginning-of-line)
22346 (cond ((eq (org-element-type parent) 'item)
22347 (make-string (org-list-item-body-column
22348 (org-element-property :begin parent))
22349 ? ))
22350 ((and adaptive-fill-regexp
22351 ;; Locally disable
22352 ;; `adaptive-fill-function' to let
22353 ;; `fill-context-prefix' handle
22354 ;; `adaptive-fill-regexp' variable.
22355 (let (adaptive-fill-function)
22356 (fill-context-prefix
22357 post-affiliated
22358 (org-element-property :end element)))))
22359 ((looking-at "[ \t]+") (match-string 0))
22360 (t "")))))
22361 (comment-block
22362 ;; Only fill contents if P is within block boundaries.
22363 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22364 (forward-line)
22365 (point)))
22366 (cend (save-excursion
22367 (goto-char (org-element-property :end element))
22368 (skip-chars-backward " \r\t\n")
22369 (line-beginning-position))))
22370 (when (and (>= p cbeg) (< p cend))
22371 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22372 (match-string 0)
22373 ""))))))))))
22375 (declare-function message-goto-body "message" ())
22376 (defvar message-cite-prefix-regexp) ; From message.el
22377 (defun org-fill-paragraph (&optional justify)
22378 "Fill element at point, when applicable.
22380 This function only applies to comment blocks, comments, example
22381 blocks and paragraphs. Also, as a special case, re-align table
22382 when point is at one.
22384 If JUSTIFY is non-nil (interactively, with prefix argument),
22385 justify as well. If `sentence-end-double-space' is non-nil, then
22386 period followed by one space does not end a sentence, so don't
22387 break a line there. The variable `fill-column' controls the
22388 width for filling.
22390 For convenience, when point is at a plain list, an item or
22391 a footnote definition, try to fill the first paragraph within."
22392 (interactive)
22393 (if (and (derived-mode-p 'message-mode)
22394 (or (not (message-in-body-p))
22395 (save-excursion (move-beginning-of-line 1)
22396 (looking-at message-cite-prefix-regexp))))
22397 ;; First ensure filling is correct in message-mode.
22398 (let ((fill-paragraph-function
22399 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22400 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22401 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22402 (paragraph-separate
22403 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22404 (fill-paragraph nil))
22405 (with-syntax-table org-mode-transpose-word-syntax-table
22406 ;; Move to end of line in order to get the first paragraph
22407 ;; within a plain list or a footnote definition.
22408 (let ((element (save-excursion
22409 (end-of-line)
22410 (or (ignore-errors (org-element-at-point))
22411 (user-error "An element cannot be parsed line %d"
22412 (line-number-at-pos (point)))))))
22413 ;; First check if point is in a blank line at the beginning of
22414 ;; the buffer. In that case, ignore filling.
22415 (case (org-element-type element)
22416 ;; Use major mode filling function is src blocks.
22417 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22418 ;; Align Org tables, leave table.el tables as-is.
22419 (table-row (org-table-align) t)
22420 (table
22421 (when (eq (org-element-property :type element) 'org)
22422 (save-excursion
22423 (goto-char (org-element-property :post-affiliated element))
22424 (org-table-align)))
22426 (paragraph
22427 ;; Paragraphs may contain `line-break' type objects.
22428 (let ((beg (max (point-min)
22429 (org-element-property :contents-begin element)))
22430 (end (min (point-max)
22431 (org-element-property :contents-end element))))
22432 ;; Do nothing if point is at an affiliated keyword.
22433 (if (< (line-end-position) beg) t
22434 (when (derived-mode-p 'message-mode)
22435 ;; In `message-mode', do not fill following citation
22436 ;; in current paragraph nor text before message body.
22437 (let ((body-start (save-excursion (message-goto-body))))
22438 (when body-start (setq beg (max body-start beg))))
22439 (when (save-excursion
22440 (re-search-forward
22441 (concat "^" message-cite-prefix-regexp) end t))
22442 (setq end (match-beginning 0))))
22443 ;; Fill paragraph, taking line breaks into account.
22444 ;; For that, slice the paragraph using line breaks as
22445 ;; separators, and fill the parts in reverse order to
22446 ;; avoid messing with markers.
22447 (save-excursion
22448 (goto-char end)
22449 (mapc
22450 (lambda (pos)
22451 (fill-region-as-paragraph pos (point) justify)
22452 (goto-char pos))
22453 ;; Find the list of ending positions for line breaks
22454 ;; in the current paragraph. Add paragraph
22455 ;; beginning to include first slice.
22456 (nreverse
22457 (cons beg
22458 (org-element-map
22459 (org-element--parse-objects
22460 beg end nil (org-element-restriction 'paragraph))
22461 'line-break
22462 (lambda (lb) (org-element-property :end lb)))))))
22463 t)))
22464 ;; Contents of `comment-block' type elements should be
22465 ;; filled as plain text, but only if point is within block
22466 ;; markers.
22467 (comment-block
22468 (let* ((case-fold-search t)
22469 (beg (save-excursion
22470 (goto-char (org-element-property :begin element))
22471 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22472 (forward-line)
22473 (point)))
22474 (end (save-excursion
22475 (goto-char (org-element-property :end element))
22476 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22477 (line-beginning-position))))
22478 (if (or (< (point) beg) (> (point) end)) t
22479 (fill-region-as-paragraph
22480 (save-excursion (end-of-line)
22481 (re-search-backward "^[ \t]*$" beg 'move)
22482 (line-beginning-position))
22483 (save-excursion (beginning-of-line)
22484 (re-search-forward "^[ \t]*$" end 'move)
22485 (line-beginning-position))
22486 justify))))
22487 ;; Fill comments.
22488 (comment
22489 (let ((begin (org-element-property :post-affiliated element))
22490 (end (org-element-property :end element)))
22491 (when (and (>= (point) begin) (<= (point) end))
22492 (let ((begin (save-excursion
22493 (end-of-line)
22494 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22495 (progn (forward-line) (point))
22496 begin)))
22497 (end (save-excursion
22498 (end-of-line)
22499 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22500 (1- (line-beginning-position))
22501 (skip-chars-backward " \r\t\n")
22502 (line-end-position)))))
22503 ;; Do not fill comments when at a blank line.
22504 (when (> end begin)
22505 (let ((fill-prefix
22506 (save-excursion
22507 (beginning-of-line)
22508 (looking-at "[ \t]*#")
22509 (let ((comment-prefix (match-string 0)))
22510 (goto-char (match-end 0))
22511 (if (looking-at adaptive-fill-regexp)
22512 (concat comment-prefix (match-string 0))
22513 (concat comment-prefix " "))))))
22514 (save-excursion
22515 (fill-region-as-paragraph begin end justify))))))
22517 ;; Ignore every other element.
22518 (otherwise t))))))
22520 (defun org-auto-fill-function ()
22521 "Auto-fill function."
22522 ;; Check if auto-filling is meaningful.
22523 (let ((fc (current-fill-column)))
22524 (when (and fc (> (current-column) fc))
22525 (let* ((fill-prefix (org-adaptive-fill-function))
22526 ;; Enforce empty fill prefix, if required. Otherwise, it
22527 ;; will be computed again.
22528 (adaptive-fill-mode (not (equal fill-prefix ""))))
22529 (when fill-prefix (do-auto-fill))))))
22531 (defun org-comment-line-break-function (&optional soft)
22532 "Break line at point and indent, continuing comment if within one.
22533 The inserted newline is marked hard if variable
22534 `use-hard-newlines' is true, unless optional argument SOFT is
22535 non-nil."
22536 (if soft (insert-and-inherit ?\n) (newline 1))
22537 (save-excursion (forward-char -1) (delete-horizontal-space))
22538 (delete-horizontal-space)
22539 (indent-to-left-margin)
22540 (insert-before-markers-and-inherit fill-prefix))
22543 ;;; Comments
22545 ;; Org comments syntax is quite complex. It requires the entire line
22546 ;; to be just a comment. Also, even with the right syntax at the
22547 ;; beginning of line, some some elements (i.e. verse-block or
22548 ;; example-block) don't accept comments. Usual Emacs comment commands
22549 ;; cannot cope with those requirements. Therefore, Org replaces them.
22551 ;; Org still relies on `comment-dwim', but cannot trust
22552 ;; `comment-only-p'. So, `comment-region-function' and
22553 ;; `uncomment-region-function' both point
22554 ;; to`org-comment-or-uncomment-region'. Eventually,
22555 ;; `org-insert-comment' takes care of insertion of comments at the
22556 ;; beginning of line.
22558 ;; `org-setup-comments-handling' install comments related variables
22559 ;; during `org-mode' initialization.
22561 (defun org-setup-comments-handling ()
22562 (interactive)
22563 (org-set-local 'comment-use-syntax nil)
22564 (org-set-local 'comment-start "# ")
22565 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22566 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22567 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22568 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22570 (defun org-insert-comment ()
22571 "Insert an empty comment above current line.
22572 If the line is empty, insert comment at its beginning."
22573 (beginning-of-line)
22574 (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
22575 (org-indent-line)
22576 (insert "# "))
22578 (defvar comment-empty-lines) ; From newcomment.el.
22579 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22580 "Comment or uncomment each non-blank line in the region.
22581 Uncomment each non-blank line between BEG and END if it only
22582 contains commented lines. Otherwise, comment them."
22583 (save-restriction
22584 ;; Restrict region
22585 (narrow-to-region (save-excursion (goto-char beg)
22586 (skip-chars-forward " \r\t\n" end)
22587 (line-beginning-position))
22588 (save-excursion (goto-char end)
22589 (skip-chars-backward " \r\t\n" beg)
22590 (line-end-position)))
22591 (let ((uncommentp
22592 ;; UNCOMMENTP is non-nil when every non blank line between
22593 ;; BEG and END is a comment.
22594 (save-excursion
22595 (goto-char (point-min))
22596 (while (and (not (eobp))
22597 (let ((element (org-element-at-point)))
22598 (and (eq (org-element-type element) 'comment)
22599 (goto-char (min (point-max)
22600 (org-element-property
22601 :end element)))))))
22602 (eobp))))
22603 (if uncommentp
22604 ;; Only blank lines and comments in region: uncomment it.
22605 (save-excursion
22606 (goto-char (point-min))
22607 (while (not (eobp))
22608 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22609 (replace-match "" nil nil nil 1))
22610 (forward-line)))
22611 ;; Comment each line in region.
22612 (let ((min-indent (point-max)))
22613 ;; First find the minimum indentation across all lines.
22614 (save-excursion
22615 (goto-char (point-min))
22616 (while (and (not (eobp)) (not (zerop min-indent)))
22617 (unless (looking-at "[ \t]*$")
22618 (setq min-indent (min min-indent (current-indentation))))
22619 (forward-line)))
22620 ;; Then loop over all lines.
22621 (save-excursion
22622 (goto-char (point-min))
22623 (while (not (eobp))
22624 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22625 ;; Don't get fooled by invisible text (e.g. link path)
22626 ;; when moving to column MIN-INDENT.
22627 (let ((buffer-invisibility-spec nil))
22628 (org-move-to-column min-indent t))
22629 (insert comment-start))
22630 (forward-line))))))))
22633 ;;; Planning
22635 ;; This section contains tools to operate on timestamp objects, as
22636 ;; returned by, e.g. `org-element-context'.
22638 (defun org-timestamp-has-time-p (timestamp)
22639 "Non-nil when TIMESTAMP has a time specified."
22640 (org-element-property :hour-start timestamp))
22642 (defun org-timestamp-format (timestamp format &optional end utc)
22643 "Format a TIMESTAMP element into a string.
22645 FORMAT is a format specifier to be passed to
22646 `format-time-string'.
22648 When optional argument END is non-nil, use end of date-range or
22649 time-range, if possible.
22651 When optional argument UTC is non-nil, time will be expressed as
22652 Universal Time."
22653 (format-time-string
22654 format
22655 (apply 'encode-time
22656 (cons 0
22657 (mapcar
22658 (lambda (prop) (or (org-element-property prop timestamp) 0))
22659 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22660 '(:minute-start :hour-start :day-start :month-start
22661 :year-start)))))
22662 utc))
22664 (defun org-timestamp-split-range (timestamp &optional end)
22665 "Extract a timestamp object from a date or time range.
22667 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22668 the end of the range. Otherwise, extract its start.
22670 Return a new timestamp object sharing the same parent as
22671 TIMESTAMP."
22672 (let ((type (org-element-property :type timestamp)))
22673 (if (memq type '(active inactive diary)) timestamp
22674 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22675 ;; Set new type.
22676 (org-element-put-property
22677 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22678 ;; Copy start properties over end properties if END is
22679 ;; non-nil. Otherwise, copy end properties over `start' ones.
22680 (let ((p-alist '((:minute-start . :minute-end)
22681 (:hour-start . :hour-end)
22682 (:day-start . :day-end)
22683 (:month-start . :month-end)
22684 (:year-start . :year-end))))
22685 (dolist (p-cell p-alist)
22686 (org-element-put-property
22687 split-ts
22688 (funcall (if end 'car 'cdr) p-cell)
22689 (org-element-property
22690 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22691 ;; Eventually refresh `:raw-value'.
22692 (org-element-put-property split-ts :raw-value nil)
22693 (org-element-put-property
22694 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22696 (defun org-timestamp-translate (timestamp &optional boundary)
22697 "Apply `org-translate-time' on a TIMESTAMP object.
22698 When optional argument BOUNDARY is non-nil, it is either the
22699 symbol `start' or `end'. In this case, only translate the
22700 starting or ending part of TIMESTAMP if it is a date or time
22701 range. Otherwise, translate both parts."
22702 (if (and (not boundary)
22703 (memq (org-element-property :type timestamp)
22704 '(active-range inactive-range)))
22705 (concat
22706 (org-translate-time
22707 (org-element-property :raw-value
22708 (org-timestamp-split-range timestamp)))
22709 "--"
22710 (org-translate-time
22711 (org-element-property :raw-value
22712 (org-timestamp-split-range timestamp t))))
22713 (org-translate-time
22714 (org-element-property
22715 :raw-value
22716 (if (not boundary) timestamp
22717 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22721 ;;; Other stuff.
22723 (defun org-toggle-fixed-width-section (arg)
22724 "Toggle the fixed-width export.
22725 If there is no active region, the QUOTE keyword at the current headline is
22726 inserted or removed. When present, it causes the text between this headline
22727 and the next to be exported as fixed-width text, and unmodified.
22728 If there is an active region, this command adds or removes a colon as the
22729 first character of this line. If the first character of a line is a colon,
22730 this line is also exported in fixed-width font."
22731 (interactive "P")
22732 (let* ((cc 0)
22733 (regionp (org-region-active-p))
22734 (beg (if regionp (region-beginning) (point)))
22735 (end (if regionp (region-end)))
22736 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22737 (case-fold-search nil)
22738 (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
22739 off)
22740 (if regionp
22741 (save-excursion
22742 (goto-char beg)
22743 (setq cc (current-column))
22744 (beginning-of-line 1)
22745 (setq off (looking-at re))
22746 (while (> nlines 0)
22747 (setq nlines (1- nlines))
22748 (beginning-of-line 1)
22749 (cond
22750 (arg
22751 (org-move-to-column cc t)
22752 (insert ": \n")
22753 (forward-line -1))
22754 ((and off (looking-at re))
22755 (replace-match "" t t nil 1))
22756 ((not off) (org-move-to-column cc t) (insert ": ")))
22757 (forward-line 1)))
22758 (save-excursion
22759 (org-back-to-heading)
22760 (cond
22761 ((looking-at (format org-heading-keyword-regexp-format
22762 org-quote-string))
22763 (goto-char (match-end 1))
22764 (looking-at (concat " +" org-quote-string))
22765 (replace-match "" t t)
22766 (when (eolp) (insert " ")))
22767 ((looking-at org-outline-regexp)
22768 (goto-char (match-end 0))
22769 (insert org-quote-string " ")))))))
22771 (defun org-reftex-citation ()
22772 "Use reftex-citation to insert a citation into the buffer.
22773 This looks for a line like
22775 #+BIBLIOGRAPHY: foo plain option:-d
22777 and derives from it that foo.bib is the bibliography file relevant
22778 for this document. It then installs the necessary environment for RefTeX
22779 to work in this buffer and calls `reftex-citation' to insert a citation
22780 into the buffer.
22782 Export of such citations to both LaTeX and HTML is handled by the contributed
22783 package ox-bibtex by Taru Karttunen."
22784 (interactive)
22785 (let ((reftex-docstruct-symbol 'rds)
22786 (reftex-cite-format "\\cite{%l}")
22787 rds bib)
22788 (save-excursion
22789 (save-restriction
22790 (widen)
22791 (let ((case-fold-search t)
22792 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22793 (if (not (save-excursion
22794 (or (re-search-forward re nil t)
22795 (re-search-backward re nil t))))
22796 (error "No bibliography defined in file")
22797 (setq bib (concat (match-string 1) ".bib")
22798 rds (list (list 'bib bib)))))))
22799 (call-interactively 'reftex-citation)))
22801 ;;;; Functions extending outline functionality
22803 (defun org-beginning-of-line (&optional arg)
22804 "Go to the beginning of the current line. If that is invisible, continue
22805 to a visible line beginning. This makes the function of C-a more intuitive.
22806 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22807 first attempt, and only move to after the tags when the cursor is already
22808 beyond the end of the headline."
22809 (interactive "P")
22810 (let ((pos (point))
22811 (special (if (consp org-special-ctrl-a/e)
22812 (car org-special-ctrl-a/e)
22813 org-special-ctrl-a/e))
22814 deactivate-mark refpos)
22815 (if (org-bound-and-true-p visual-line-mode)
22816 (beginning-of-visual-line 1)
22817 (beginning-of-line 1))
22818 (if (and arg (fboundp 'move-beginning-of-line))
22819 (call-interactively 'move-beginning-of-line)
22820 (if (bobp)
22822 (backward-char 1)
22823 (if (org-truely-invisible-p)
22824 (while (and (not (bobp)) (org-truely-invisible-p))
22825 (backward-char 1)
22826 (beginning-of-line 1))
22827 (forward-char 1))))
22828 (when special
22829 (cond
22830 ((and (looking-at org-complex-heading-regexp)
22831 (= (char-after (match-end 1)) ?\ ))
22832 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22833 (point-at-eol)))
22834 (goto-char
22835 (if (eq special t)
22836 (cond ((> pos refpos) refpos)
22837 ((= pos (point)) refpos)
22838 (t (point)))
22839 (cond ((> pos (point)) (point))
22840 ((not (eq last-command this-command)) (point))
22841 (t refpos)))))
22842 ((org-at-item-p)
22843 ;; Being at an item and not looking at an the item means point
22844 ;; was previously moved to beginning of a visual line, which
22845 ;; doesn't contain the item. Therefore, do nothing special,
22846 ;; just stay here.
22847 (when (looking-at org-list-full-item-re)
22848 ;; Set special position at first white space character after
22849 ;; bullet, and check-box, if any.
22850 (let ((after-bullet
22851 (let ((box (match-end 3)))
22852 (if (not box) (match-end 1)
22853 (let ((after (char-after box)))
22854 (if (and after (= after ? )) (1+ box) box))))))
22855 ;; Special case: Move point to special position when
22856 ;; currently after it or at beginning of line.
22857 (if (eq special t)
22858 (when (or (> pos after-bullet) (= (point) pos))
22859 (goto-char after-bullet))
22860 ;; Reversed case: Move point to special position when
22861 ;; point was already at beginning of line and command is
22862 ;; repeated.
22863 (when (and (= (point) pos) (eq last-command this-command))
22864 (goto-char after-bullet))))))))
22865 (org-no-warnings
22866 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22867 (setq disable-point-adjustment
22868 (or (not (invisible-p (point)))
22869 (not (invisible-p (max (point-min) (1- (point))))))))
22871 (defun org-end-of-line (&optional arg)
22872 "Go to the end of the line.
22873 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22874 tags on the first attempt, and only move to after the tags when
22875 the cursor is already beyond the end of the headline."
22876 (interactive "P")
22877 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22878 org-special-ctrl-a/e))
22879 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22880 'end-of-visual-line)
22881 ((fboundp 'move-end-of-line) 'move-end-of-line)
22882 (t 'end-of-line)))
22883 deactivate-mark)
22884 (if (or (not special) arg) (call-interactively move-fun)
22885 (let* ((element (save-excursion (beginning-of-line)
22886 (org-element-at-point)))
22887 (type (org-element-type element)))
22888 (cond
22889 ((memq type '(headline inlinetask))
22890 (let ((pos (point)))
22891 (beginning-of-line 1)
22892 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
22893 (if (eq special t)
22894 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22895 (goto-char (match-beginning 1))
22896 (goto-char (match-end 0)))
22897 (if (or (< pos (match-end 0))
22898 (not (eq this-command last-command)))
22899 (goto-char (match-end 0))
22900 (goto-char (match-beginning 1))))
22901 (call-interactively move-fun))))
22902 ((org-element-property :hiddenp element)
22903 ;; If element is hidden, `move-end-of-line' would put point
22904 ;; after it. Use `end-of-line' to stay on current line.
22905 (call-interactively 'end-of-line))
22906 (t (call-interactively move-fun)))))
22907 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22908 (setq disable-point-adjustment
22909 (or (not (invisible-p (point)))
22910 (not (invisible-p (max (point-min) (1- (point))))))))
22912 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22913 (define-key org-mode-map "\C-e" 'org-end-of-line)
22915 (defun org-backward-sentence (&optional arg)
22916 "Go to beginning of sentence, or beginning of table field.
22917 This will call `backward-sentence' or `org-table-beginning-of-field',
22918 depending on context."
22919 (interactive "P")
22920 (cond
22921 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22922 (t (call-interactively 'backward-sentence))))
22924 (defun org-forward-sentence (&optional arg)
22925 "Go to end of sentence, or end of table field.
22926 This will call `forward-sentence' or `org-table-end-of-field',
22927 depending on context."
22928 (interactive "P")
22929 (cond
22930 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22931 (t (call-interactively 'forward-sentence))))
22933 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22934 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22936 (defun org-kill-line (&optional arg)
22937 "Kill line, to tags or end of line."
22938 (interactive "P")
22939 (cond
22940 ((or (not org-special-ctrl-k)
22941 (bolp)
22942 (not (org-at-heading-p)))
22943 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22944 org-ctrl-k-protect-subtree)
22945 (if (or (eq org-ctrl-k-protect-subtree 'error)
22946 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22947 (user-error "C-k aborted as it would kill a hidden subtree")))
22948 (call-interactively
22949 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22950 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
22951 (kill-region (point) (match-beginning 1))
22952 (org-set-tags nil t))
22953 (t (kill-region (point) (point-at-eol)))))
22955 (define-key org-mode-map "\C-k" 'org-kill-line)
22957 (defun org-yank (&optional arg)
22958 "Yank. If the kill is a subtree, treat it specially.
22959 This command will look at the current kill and check if is a single
22960 subtree, or a series of subtrees[1]. If it passes the test, and if the
22961 cursor is at the beginning of a line or after the stars of a currently
22962 empty headline, then the yank is handled specially. How exactly depends
22963 on the value of the following variables, both set by default.
22965 org-yank-folded-subtrees
22966 When set, the subtree(s) will be folded after insertion, but only
22967 if doing so would now swallow text after the yanked text.
22969 org-yank-adjusted-subtrees
22970 When set, the subtree will be promoted or demoted in order to
22971 fit into the local outline tree structure, which means that the level
22972 will be adjusted so that it becomes the smaller one of the two
22973 *visible* surrounding headings.
22975 Any prefix to this command will cause `yank' to be called directly with
22976 no special treatment. In particular, a simple \\[universal-argument] prefix \
22977 will just
22978 plainly yank the text as it is.
22980 \[1] The test checks if the first non-white line is a heading
22981 and if there are no other headings with fewer stars."
22982 (interactive "P")
22983 (org-yank-generic 'yank arg))
22985 (defun org-yank-generic (command arg)
22986 "Perform some yank-like command.
22988 This function implements the behavior described in the `org-yank'
22989 documentation. However, it has been generalized to work for any
22990 interactive command with similar behavior."
22992 ;; pretend to be command COMMAND
22993 (setq this-command command)
22995 (if arg
22996 (call-interactively command)
22998 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22999 (and (org-kill-is-subtree-p)
23000 (or (bolp)
23001 (and (looking-at "[ \t]*$")
23002 (string-match
23003 "\\`\\*+\\'"
23004 (buffer-substring (point-at-bol) (point)))))))
23005 swallowp)
23006 (cond
23007 ((and subtreep org-yank-folded-subtrees)
23008 (let ((beg (point))
23009 end)
23010 (if (and subtreep org-yank-adjusted-subtrees)
23011 (org-paste-subtree nil nil 'for-yank)
23012 (call-interactively command))
23014 (setq end (point))
23015 (goto-char beg)
23016 (when (and (bolp) subtreep
23017 (not (setq swallowp
23018 (org-yank-folding-would-swallow-text beg end))))
23019 (org-with-limited-levels
23020 (or (looking-at org-outline-regexp)
23021 (re-search-forward org-outline-regexp-bol end t))
23022 (while (and (< (point) end) (looking-at org-outline-regexp))
23023 (hide-subtree)
23024 (org-cycle-show-empty-lines 'folded)
23025 (condition-case nil
23026 (outline-forward-same-level 1)
23027 (error (goto-char end))))))
23028 (when swallowp
23029 (message
23030 "Inserted text not folded because that would swallow text"))
23032 (goto-char end)
23033 (skip-chars-forward " \t\n\r")
23034 (beginning-of-line 1)
23035 (push-mark beg 'nomsg)))
23036 ((and subtreep org-yank-adjusted-subtrees)
23037 (let ((beg (point-at-bol)))
23038 (org-paste-subtree nil nil 'for-yank)
23039 (push-mark beg 'nomsg)))
23041 (call-interactively command))))))
23043 (defun org-yank-folding-would-swallow-text (beg end)
23044 "Would hide-subtree at BEG swallow any text after END?"
23045 (let (level)
23046 (org-with-limited-levels
23047 (save-excursion
23048 (goto-char beg)
23049 (when (or (looking-at org-outline-regexp)
23050 (re-search-forward org-outline-regexp-bol end t))
23051 (setq level (org-outline-level)))
23052 (goto-char end)
23053 (skip-chars-forward " \t\r\n\v\f")
23054 (if (or (eobp)
23055 (and (bolp) (looking-at org-outline-regexp)
23056 (<= (org-outline-level) level)))
23057 nil ; Nothing would be swallowed
23058 t))))) ; something would swallow
23060 (define-key org-mode-map "\C-y" 'org-yank)
23062 (defun org-truely-invisible-p ()
23063 "Check if point is at a character currently not visible.
23064 This version does not only check the character property, but also
23065 `visible-mode'."
23066 ;; Early versions of noutline don't have `outline-invisible-p'.
23067 (if (org-bound-and-true-p visible-mode)
23069 (outline-invisible-p)))
23071 (defun org-invisible-p2 ()
23072 "Check if point is at a character currently not visible."
23073 (save-excursion
23074 (if (and (eolp) (not (bobp))) (backward-char 1))
23075 ;; Early versions of noutline don't have `outline-invisible-p'.
23076 (outline-invisible-p)))
23078 (defun org-back-to-heading (&optional invisible-ok)
23079 "Call `outline-back-to-heading', but provide a better error message."
23080 (condition-case nil
23081 (outline-back-to-heading invisible-ok)
23082 (error (error "Before first headline at position %d in buffer %s"
23083 (point) (current-buffer)))))
23085 (defun org-before-first-heading-p ()
23086 "Before first heading?"
23087 (save-excursion
23088 (end-of-line)
23089 (null (re-search-backward org-outline-regexp-bol nil t))))
23091 (defun org-at-heading-p (&optional ignored)
23092 (outline-on-heading-p t))
23093 ;; Compatibility alias with Org versions < 7.8.03
23094 (defalias 'org-on-heading-p 'org-at-heading-p)
23096 (defun org-at-comment-p nil
23097 "Is cursor in a line starting with a # character?"
23098 (save-excursion
23099 (beginning-of-line)
23100 (looking-at "^#")))
23102 (defun org-at-drawer-p nil
23103 "Is cursor at a drawer keyword?"
23104 (save-excursion
23105 (move-beginning-of-line 1)
23106 (looking-at org-drawer-regexp)))
23108 (defun org-at-block-p nil
23109 "Is cursor at a block keyword?"
23110 (save-excursion
23111 (move-beginning-of-line 1)
23112 (looking-at org-block-regexp)))
23114 (defun org-point-at-end-of-empty-headline ()
23115 "If point is at the end of an empty headline, return t, else nil.
23116 If the heading only contains a TODO keyword, it is still still considered
23117 empty."
23118 (and (looking-at "[ \t]*$")
23119 (when org-todo-line-regexp
23120 (save-excursion
23121 (beginning-of-line 1)
23122 (let ((case-fold-search nil))
23123 (looking-at org-todo-line-regexp)
23124 (string= (match-string 3) ""))))))
23126 (defun org-at-heading-or-item-p ()
23127 (or (org-at-heading-p) (org-at-item-p)))
23129 (defun org-at-target-p ()
23130 (or (org-in-regexp org-radio-target-regexp)
23131 (org-in-regexp org-target-regexp)))
23132 ;; Compatibility alias with Org versions < 7.8.03
23133 (defalias 'org-on-target-p 'org-at-target-p)
23135 (defun org-up-heading-all (arg)
23136 "Move to the heading line of which the present line is a subheading.
23137 This function considers both visible and invisible heading lines.
23138 With argument, move up ARG levels."
23139 (if (fboundp 'outline-up-heading-all)
23140 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23141 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23143 (defun org-up-heading-safe ()
23144 "Move to the heading line of which the present line is a subheading.
23145 This version will not throw an error. It will return the level of the
23146 headline found, or nil if no higher level is found.
23148 Also, this function will be a lot faster than `outline-up-heading',
23149 because it relies on stars being the outline starters. This can really
23150 make a significant difference in outlines with very many siblings."
23151 (let (start-level re)
23152 (org-back-to-heading t)
23153 (setq start-level (funcall outline-level))
23154 (if (equal start-level 1)
23156 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23157 (if (re-search-backward re nil t)
23158 (funcall outline-level)))))
23160 (defun org-first-sibling-p ()
23161 "Is this heading the first child of its parents?"
23162 (interactive)
23163 (let ((re org-outline-regexp-bol)
23164 level l)
23165 (unless (org-at-heading-p t)
23166 (user-error "Not at a heading"))
23167 (setq level (funcall outline-level))
23168 (save-excursion
23169 (if (not (re-search-backward re nil t))
23171 (setq l (funcall outline-level))
23172 (< l level)))))
23174 (defun org-goto-sibling (&optional previous)
23175 "Goto the next sibling, even if it is invisible.
23176 When PREVIOUS is set, go to the previous sibling instead. Returns t
23177 when a sibling was found. When none is found, return nil and don't
23178 move point."
23179 (let ((fun (if previous 're-search-backward 're-search-forward))
23180 (pos (point))
23181 (re org-outline-regexp-bol)
23182 level l)
23183 (when (condition-case nil (org-back-to-heading t) (error nil))
23184 (setq level (funcall outline-level))
23185 (catch 'exit
23186 (or previous (forward-char 1))
23187 (while (funcall fun re nil t)
23188 (setq l (funcall outline-level))
23189 (when (< l level) (goto-char pos) (throw 'exit nil))
23190 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23191 (goto-char pos)
23192 nil))))
23194 (defun org-show-siblings ()
23195 "Show all siblings of the current headline."
23196 (save-excursion
23197 (while (org-goto-sibling) (org-flag-heading nil)))
23198 (save-excursion
23199 (while (org-goto-sibling 'previous)
23200 (org-flag-heading nil))))
23202 (defun org-goto-first-child ()
23203 "Goto the first child, even if it is invisible.
23204 Return t when a child was found. Otherwise don't move point and
23205 return nil."
23206 (let (level (pos (point)) (re org-outline-regexp-bol))
23207 (when (condition-case nil (org-back-to-heading t) (error nil))
23208 (setq level (outline-level))
23209 (forward-char 1)
23210 (if (and (re-search-forward re nil t) (> (outline-level) level))
23211 (progn (goto-char (match-beginning 0)) t)
23212 (goto-char pos) nil))))
23214 (defun org-show-hidden-entry ()
23215 "Show an entry where even the heading is hidden."
23216 (save-excursion
23217 (org-show-entry)))
23219 (defun org-flag-heading (flag &optional entry)
23220 "Flag the current heading. FLAG non-nil means make invisible.
23221 When ENTRY is non-nil, show the entire entry."
23222 (save-excursion
23223 (org-back-to-heading t)
23224 ;; Check if we should show the entire entry
23225 (if entry
23226 (progn
23227 (org-show-entry)
23228 (save-excursion
23229 (and (outline-next-heading)
23230 (org-flag-heading nil))))
23231 (outline-flag-region (max (point-min) (1- (point)))
23232 (save-excursion (outline-end-of-heading) (point))
23233 flag))))
23235 (defun org-get-next-sibling ()
23236 "Move to next heading of the same level, and return point.
23237 If there is no such heading, return nil.
23238 This is like outline-next-sibling, but invisible headings are ok."
23239 (let ((level (funcall outline-level)))
23240 (outline-next-heading)
23241 (while (and (not (eobp)) (> (funcall outline-level) level))
23242 (outline-next-heading))
23243 (if (or (eobp) (< (funcall outline-level) level))
23245 (point))))
23247 (defun org-get-last-sibling ()
23248 "Move to previous heading of the same level, and return point.
23249 If there is no such heading, return nil."
23250 (let ((opoint (point))
23251 (level (funcall outline-level)))
23252 (outline-previous-heading)
23253 (when (and (/= (point) opoint) (outline-on-heading-p t))
23254 (while (and (> (funcall outline-level) level)
23255 (not (bobp)))
23256 (outline-previous-heading))
23257 (if (< (funcall outline-level) level)
23259 (point)))))
23261 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23262 "Goto to the end of a subtree."
23263 ;; This contains an exact copy of the original function, but it uses
23264 ;; `org-back-to-heading', to make it work also in invisible
23265 ;; trees. And is uses an invisible-ok argument.
23266 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23267 ;; Furthermore, when used inside Org, finding the end of a large subtree
23268 ;; with many children and grandchildren etc, this can be much faster
23269 ;; than the outline version.
23270 (org-back-to-heading invisible-ok)
23271 (let ((first t)
23272 (level (funcall outline-level)))
23273 (if (and (derived-mode-p 'org-mode) (< level 1000))
23274 ;; A true heading (not a plain list item), in Org-mode
23275 ;; This means we can easily find the end by looking
23276 ;; only for the right number of stars. Using a regexp to do
23277 ;; this is so much faster than using a Lisp loop.
23278 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23279 (forward-char 1)
23280 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23281 ;; something else, do it the slow way
23282 (while (and (not (eobp))
23283 (or first (> (funcall outline-level) level)))
23284 (setq first nil)
23285 (outline-next-heading)))
23286 (unless to-heading
23287 (if (memq (preceding-char) '(?\n ?\^M))
23288 (progn
23289 ;; Go to end of line before heading
23290 (forward-char -1)
23291 (if (memq (preceding-char) '(?\n ?\^M))
23292 ;; leave blank line before heading
23293 (forward-char -1))))))
23294 (point))
23296 (defun org-end-of-meta-data-and-drawers ()
23297 "Jump to the first text after meta data and drawers in the current entry.
23298 This will move over empty lines, lines with planning time stamps,
23299 clocking lines, and drawers."
23300 (org-back-to-heading t)
23301 (let ((end (save-excursion (outline-next-heading) (point)))
23302 (re (concat "\\(" org-drawer-regexp "\\)"
23303 "\\|" "[ \t]*" org-keyword-time-regexp)))
23304 (forward-line 1)
23305 (while (re-search-forward re end t)
23306 (if (not (match-end 1))
23307 ;; empty or planning line
23308 (forward-line 1)
23309 ;; a drawer, find the end
23310 (re-search-forward "^[ \t]*:END:" end 'move)
23311 (forward-line 1)))
23312 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23313 (point)))
23315 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23316 "Move forward to the ARG'th subheading at same level as this one.
23317 Stop at the first and last subheadings of a superior heading.
23318 Normally this only looks at visible headings, but when INVISIBLE-OK is
23319 non-nil it will also look at invisible ones."
23320 (interactive "p")
23321 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23322 (if (and arg (< arg 0))
23323 (goto-char (point-min))
23324 (outline-next-heading))
23325 (org-at-heading-p)
23326 (let ((level (- (match-end 0) (match-beginning 0) 1))
23327 (f (if (and arg (< arg 0))
23328 're-search-backward
23329 're-search-forward))
23330 (count (if arg (abs arg) 1))
23331 (result (point)))
23332 (while (and (prog1 (> count 0)
23333 (forward-char (if (and arg (< arg 0)) -1 1)))
23334 (funcall f org-outline-regexp-bol nil 'move))
23335 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23336 (cond ((< l level) (setq count 0))
23337 ((and (= l level)
23338 (or invisible-ok
23339 (progn
23340 (goto-char (line-beginning-position))
23341 (not (outline-invisible-p)))))
23342 (setq count (1- count))
23343 (when (eq l level)
23344 (setq result (point)))))))
23345 (goto-char result))
23346 (beginning-of-line 1)))
23348 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23349 "Move backward to the ARG'th subheading at same level as this one.
23350 Stop at the first and last subheadings of a superior heading."
23351 (interactive "p")
23352 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23354 (defun org-next-block (arg &optional backward block-regexp)
23355 "Jump to the next block.
23356 With a prefix argument ARG, jump forward ARG many source blocks.
23357 When BACKWARD is non-nil, jump to the previous block.
23358 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23359 (interactive "p")
23360 (let ((re (or block-regexp org-block-regexp))
23361 (re-search-fn (or (and backward 're-search-backward)
23362 're-search-forward)))
23363 (if (looking-at re) (forward-char 1))
23364 (condition-case nil
23365 (funcall re-search-fn re nil nil arg)
23366 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23367 (goto-char (match-beginning 0)) (org-show-context)))
23369 (defun org-previous-block (arg &optional block-regexp)
23370 "Jump to the previous block.
23371 With a prefix argument ARG, jump backward ARG many source blocks.
23372 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23373 (interactive "p")
23374 (org-next-block arg t block-regexp))
23376 (defun org-forward-paragraph ()
23377 "Move forward to beginning of next paragraph or equivalent.
23379 The function moves point to the beginning of the next visible
23380 structural element, which can be a paragraph, a table, a list
23381 item, etc. It also provides some special moves for convenience:
23383 - On an affiliated keyword, jump to the beginning of the
23384 relative element.
23385 - On an item or a footnote definition, move to the second
23386 element inside, if any.
23387 - On a table or a property drawer, jump after it.
23388 - On a verse or source block, stop after blank lines."
23389 (interactive)
23390 (when (eobp) (user-error "Cannot move further down"))
23391 (let* ((deactivate-mark nil)
23392 (element (org-element-at-point))
23393 (type (org-element-type element))
23394 (post-affiliated (org-element-property :post-affiliated element))
23395 (contents-begin (org-element-property :contents-begin element))
23396 (contents-end (org-element-property :contents-end element))
23397 (end (let ((end (org-element-property :end element)) (parent element))
23398 (while (and (setq parent (org-element-property :parent parent))
23399 (= (org-element-property :contents-end parent) end))
23400 (setq end (org-element-property :end parent)))
23401 end)))
23402 (cond ((not element)
23403 (skip-chars-forward " \r\t\n")
23404 (or (eobp) (beginning-of-line)))
23405 ;; On affiliated keywords, move to element's beginning.
23406 ((and post-affiliated (< (point) post-affiliated))
23407 (goto-char post-affiliated))
23408 ;; At a table row, move to the end of the table. Similarly,
23409 ;; at a node property, move to the end of the property
23410 ;; drawer.
23411 ((memq type '(node-property table-row))
23412 (goto-char (org-element-property
23413 :end (org-element-property :parent element))))
23414 ((memq type '(property-drawer table)) (goto-char end))
23415 ;; Consider blank lines as separators in verse and source
23416 ;; blocks to ease editing.
23417 ((memq type '(src-block verse-block))
23418 (when (eq type 'src-block)
23419 (setq contents-end
23420 (save-excursion (goto-char end)
23421 (skip-chars-backward " \r\t\n")
23422 (line-beginning-position))))
23423 (beginning-of-line)
23424 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23425 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23426 (goto-char end)
23427 (skip-chars-forward " \r\t\n")
23428 (if (= (point) contents-end) (goto-char end)
23429 (beginning-of-line))))
23430 ;; With no contents, just skip element.
23431 ((not contents-begin) (goto-char end))
23432 ;; If contents are invisible, skip the element altogether.
23433 ((outline-invisible-p (line-end-position))
23434 (case type
23435 (headline
23436 (org-with-limited-levels (outline-next-visible-heading 1)))
23437 ;; At a plain list, make sure we move to the next item
23438 ;; instead of skipping the whole list.
23439 (plain-list (forward-char)
23440 (org-forward-paragraph))
23441 (otherwise (goto-char end))))
23442 ((>= (point) contents-end) (goto-char end))
23443 ((>= (point) contents-begin)
23444 ;; This can only happen on paragraphs and plain lists.
23445 (case type
23446 (paragraph (goto-char end))
23447 ;; At a plain list, try to move to second element in
23448 ;; first item, if possible.
23449 (plain-list (end-of-line)
23450 (org-forward-paragraph))))
23451 ;; When contents start on the middle of a line (e.g. in
23452 ;; items and footnote definitions), try to reach first
23453 ;; element starting after current line.
23454 ((> (line-end-position) contents-begin)
23455 (end-of-line)
23456 (org-forward-paragraph))
23457 (t (goto-char contents-begin)))))
23459 (defun org-backward-paragraph ()
23460 "Move backward to start of previous paragraph or equivalent.
23462 The function moves point to the beginning of the current
23463 structural element, which can be a paragraph, a table, a list
23464 item, etc., or to the beginning of the previous visible one if
23465 point is already there. It also provides some special moves for
23466 convenience:
23468 - On an affiliated keyword, jump to the first one.
23469 - On a table or a property drawer, move to its beginning.
23470 - On a verse or source block, stop before blank lines."
23471 (interactive)
23472 (when (bobp) (user-error "Cannot move further up"))
23473 (let* ((deactivate-mark nil)
23474 (element (org-element-at-point))
23475 (type (org-element-type element))
23476 (contents-begin (org-element-property :contents-begin element))
23477 (contents-end (org-element-property :contents-end element))
23478 (post-affiliated (org-element-property :post-affiliated element))
23479 (begin (org-element-property :begin element)))
23480 (cond
23481 ((not element) (goto-char (point-min)))
23482 ((= (point) begin)
23483 (backward-char)
23484 (org-backward-paragraph))
23485 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23486 ((memq type '(node-property table-row))
23487 (goto-char (org-element-property
23488 :post-affiliated (org-element-property :parent element))))
23489 ((memq type '(property-drawer table)) (goto-char begin))
23490 ((memq type '(src-block verse-block))
23491 (when (eq type 'src-block)
23492 (setq contents-begin
23493 (save-excursion (goto-char begin) (forward-line) (point))))
23494 (if (= (point) contents-begin) (goto-char post-affiliated)
23495 ;; Inside a verse block, see blank lines as paragraph
23496 ;; separators.
23497 (let ((origin (point)))
23498 (skip-chars-backward " \r\t\n" contents-begin)
23499 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23500 (skip-chars-forward " \r\t\n" origin)
23501 (if (= (point) origin) (goto-char contents-begin)
23502 (beginning-of-line))))))
23503 ((not contents-begin) (goto-char (or post-affiliated begin)))
23504 ((eq type 'paragraph)
23505 (goto-char contents-begin)
23506 ;; When at first paragraph in an item or a footnote definition,
23507 ;; move directly to beginning of line.
23508 (let ((parent-contents
23509 (org-element-property
23510 :contents-begin (org-element-property :parent element))))
23511 (when (and parent-contents (= parent-contents contents-begin))
23512 (beginning-of-line))))
23513 ;; At the end of a greater element, move to the beginning of the
23514 ;; last element within.
23515 ((>= (point) contents-end)
23516 (goto-char (1- contents-end))
23517 (org-backward-paragraph))
23518 (t (goto-char (or post-affiliated begin))))
23519 ;; Ensure we never leave point invisible.
23520 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23522 (defun org-forward-element ()
23523 "Move forward by one element.
23524 Move to the next element at the same level, when possible."
23525 (interactive)
23526 (cond ((eobp) (user-error "Cannot move further down"))
23527 ((org-with-limited-levels (org-at-heading-p))
23528 (let ((origin (point)))
23529 (goto-char (org-end-of-subtree nil t))
23530 (unless (org-with-limited-levels (org-at-heading-p))
23531 (goto-char origin)
23532 (user-error "Cannot move further down"))))
23534 (let* ((elem (org-element-at-point))
23535 (end (org-element-property :end elem))
23536 (parent (org-element-property :parent elem)))
23537 (cond ((and parent (= (org-element-property :contents-end parent) end))
23538 (goto-char (org-element-property :end parent)))
23539 ((integer-or-marker-p end) (goto-char end))
23540 (t (message "No element at point")))))))
23542 (defun org-backward-element ()
23543 "Move backward by one element.
23544 Move to the previous element at the same level, when possible."
23545 (interactive)
23546 (cond ((bobp) (user-error "Cannot move further up"))
23547 ((org-with-limited-levels (org-at-heading-p))
23548 ;; At a headline, move to the previous one, if any, or stay
23549 ;; here.
23550 (let ((origin (point)))
23551 (org-with-limited-levels (org-backward-heading-same-level 1))
23552 ;; When current headline has no sibling above, move to its
23553 ;; parent.
23554 (when (= (point) origin)
23555 (or (org-with-limited-levels (org-up-heading-safe))
23556 (progn (goto-char origin)
23557 (user-error "Cannot move further up"))))))
23559 (let* ((trail (org-element-at-point 'keep-trail))
23560 (elem (car trail))
23561 (prev-elem (nth 1 trail))
23562 (beg (org-element-property :begin elem)))
23563 (cond
23564 ;; Move to beginning of current element if point isn't
23565 ;; there already.
23566 ((null beg) (message "No element at point"))
23567 ((/= (point) beg) (goto-char beg))
23568 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23569 ((org-before-first-heading-p) (goto-char (point-min)))
23570 (t (org-back-to-heading)))))))
23572 (defun org-up-element ()
23573 "Move to upper element."
23574 (interactive)
23575 (if (org-with-limited-levels (org-at-heading-p))
23576 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23577 (let* ((elem (org-element-at-point))
23578 (parent (org-element-property :parent elem)))
23579 (if parent (goto-char (org-element-property :begin parent))
23580 (if (org-with-limited-levels (org-before-first-heading-p))
23581 (user-error "No surrounding element")
23582 (org-with-limited-levels (org-back-to-heading)))))))
23584 (defvar org-element-greater-elements)
23585 (defun org-down-element ()
23586 "Move to inner element."
23587 (interactive)
23588 (let ((element (org-element-at-point)))
23589 (cond
23590 ((memq (org-element-type element) '(plain-list table))
23591 (goto-char (org-element-property :contents-begin element))
23592 (forward-char))
23593 ((memq (org-element-type element) org-element-greater-elements)
23594 ;; If contents are hidden, first disclose them.
23595 (when (org-element-property :hiddenp element) (org-cycle))
23596 (goto-char (or (org-element-property :contents-begin element)
23597 (user-error "No content for this element"))))
23598 (t (user-error "No inner element")))))
23600 (defun org-drag-element-backward ()
23601 "Move backward element at point."
23602 (interactive)
23603 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23604 (let* ((trail (org-element-at-point 'keep-trail))
23605 (elem (car trail))
23606 (prev-elem (nth 1 trail)))
23607 ;; Error out if no previous element or previous element is
23608 ;; a parent of the current one.
23609 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23610 (user-error "Cannot drag element backward")
23611 (let ((pos (point)))
23612 (org-element-swap-A-B prev-elem elem)
23613 (goto-char (+ (org-element-property :begin prev-elem)
23614 (- pos (org-element-property :begin elem)))))))))
23616 (defun org-drag-element-forward ()
23617 "Move forward element at point."
23618 (interactive)
23619 (let* ((pos (point))
23620 (elem (org-element-at-point)))
23621 (when (= (point-max) (org-element-property :end elem))
23622 (user-error "Cannot drag element forward"))
23623 (goto-char (org-element-property :end elem))
23624 (let ((next-elem (org-element-at-point)))
23625 (when (or (org-element-nested-p elem next-elem)
23626 (and (eq (org-element-type next-elem) 'headline)
23627 (not (eq (org-element-type elem) 'headline))))
23628 (goto-char pos)
23629 (user-error "Cannot drag element forward"))
23630 ;; Compute new position of point: it's shifted by NEXT-ELEM
23631 ;; body's length (without final blanks) and by the length of
23632 ;; blanks between ELEM and NEXT-ELEM.
23633 (let ((size-next (- (save-excursion
23634 (goto-char (org-element-property :end next-elem))
23635 (skip-chars-backward " \r\t\n")
23636 (forward-line)
23637 ;; Small correction if buffer doesn't end
23638 ;; with a newline character.
23639 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23640 (org-element-property :begin next-elem)))
23641 (size-blank (- (org-element-property :end elem)
23642 (save-excursion
23643 (goto-char (org-element-property :end elem))
23644 (skip-chars-backward " \r\t\n")
23645 (forward-line)
23646 (point)))))
23647 (org-element-swap-A-B elem next-elem)
23648 (goto-char (+ pos size-next size-blank))))))
23650 (defun org-drag-line-forward (arg)
23651 "Drag the line at point ARG lines forward."
23652 (interactive "p")
23653 (dotimes (n (abs arg))
23654 (let ((c (current-column)))
23655 (if (< 0 arg)
23656 (progn
23657 (beginning-of-line 2)
23658 (transpose-lines 1)
23659 (beginning-of-line 0))
23660 (transpose-lines 1)
23661 (beginning-of-line -1))
23662 (org-move-to-column c))))
23664 (defun org-drag-line-backward (arg)
23665 "Drag the line at point ARG lines backward."
23666 (interactive "p")
23667 (org-drag-line-forward (- arg)))
23669 (defun org-mark-element ()
23670 "Put point at beginning of this element, mark at end.
23672 Interactively, if this command is repeated or (in Transient Mark
23673 mode) if the mark is active, it marks the next element after the
23674 ones already marked."
23675 (interactive)
23676 (let (deactivate-mark)
23677 (if (and (org-called-interactively-p 'any)
23678 (or (and (eq last-command this-command) (mark t))
23679 (and transient-mark-mode mark-active)))
23680 (set-mark
23681 (save-excursion
23682 (goto-char (mark))
23683 (goto-char (org-element-property :end (org-element-at-point)))))
23684 (let ((element (org-element-at-point)))
23685 (end-of-line)
23686 (push-mark (org-element-property :end element) t t)
23687 (goto-char (org-element-property :begin element))))))
23689 (defun org-narrow-to-element ()
23690 "Narrow buffer to current element."
23691 (interactive)
23692 (let ((elem (org-element-at-point)))
23693 (cond
23694 ((eq (car elem) 'headline)
23695 (narrow-to-region
23696 (org-element-property :begin elem)
23697 (org-element-property :end elem)))
23698 ((memq (car elem) org-element-greater-elements)
23699 (narrow-to-region
23700 (org-element-property :contents-begin elem)
23701 (org-element-property :contents-end elem)))
23703 (narrow-to-region
23704 (org-element-property :begin elem)
23705 (org-element-property :end elem))))))
23707 (defun org-transpose-element ()
23708 "Transpose current and previous elements, keeping blank lines between.
23709 Point is moved after both elements."
23710 (interactive)
23711 (org-skip-whitespace)
23712 (let ((end (org-element-property :end (org-element-at-point))))
23713 (org-drag-element-backward)
23714 (goto-char end)))
23716 (defun org-unindent-buffer ()
23717 "Un-indent the visible part of the buffer.
23718 Relative indentation (between items, inside blocks, etc.) isn't
23719 modified."
23720 (interactive)
23721 (unless (eq major-mode 'org-mode)
23722 (user-error "Cannot un-indent a buffer not in Org mode"))
23723 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23724 unindent-tree ; For byte-compiler.
23725 (unindent-tree
23726 (function
23727 (lambda (contents)
23728 (mapc
23729 (lambda (element)
23730 (if (memq (org-element-type element) '(headline section))
23731 (funcall unindent-tree (org-element-contents element))
23732 (save-excursion
23733 (save-restriction
23734 (narrow-to-region
23735 (org-element-property :begin element)
23736 (org-element-property :end element))
23737 (org-do-remove-indentation)))))
23738 (reverse contents))))))
23739 (funcall unindent-tree (org-element-contents parse-tree))))
23741 (defun org-show-subtree ()
23742 "Show everything after this heading at deeper levels."
23743 (interactive)
23744 (outline-flag-region
23745 (point)
23746 (save-excursion
23747 (org-end-of-subtree t t))
23748 nil))
23750 (defun org-show-entry ()
23751 "Show the body directly following this heading.
23752 Show the heading too, if it is currently invisible."
23753 (interactive)
23754 (save-excursion
23755 (condition-case nil
23756 (progn
23757 (org-back-to-heading t)
23758 (outline-flag-region
23759 (max (point-min) (1- (point)))
23760 (save-excursion
23761 (if (re-search-forward
23762 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23763 (match-beginning 1)
23764 (point-max)))
23765 nil)
23766 (org-cycle-hide-drawers 'children))
23767 (error nil))))
23769 (defun org-make-options-regexp (kwds &optional extra)
23770 "Make a regular expression for keyword lines."
23771 (concat
23772 "^#\\+\\("
23773 (mapconcat 'regexp-quote kwds "\\|")
23774 (if extra (concat "\\|" extra))
23775 "\\):[ \t]*\\(.*\\)"))
23777 ;; Make isearch reveal the necessary context
23778 (defun org-isearch-end ()
23779 "Reveal context after isearch exits."
23780 (when isearch-success ; only if search was successful
23781 (if (featurep 'xemacs)
23782 ;; Under XEmacs, the hook is run in the correct place,
23783 ;; we directly show the context.
23784 (org-show-context 'isearch)
23785 ;; In Emacs the hook runs *before* restoring the overlays.
23786 ;; So we have to use a one-time post-command-hook to do this.
23787 ;; (Emacs 22 has a special variable, see function `org-mode')
23788 (unless (and (boundp 'isearch-mode-end-hook-quit)
23789 isearch-mode-end-hook-quit)
23790 ;; Only when the isearch was not quitted.
23791 (org-add-hook 'post-command-hook 'org-isearch-post-command
23792 'append 'local)))))
23794 (defun org-isearch-post-command ()
23795 "Remove self from hook, and show context."
23796 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23797 (org-show-context 'isearch))
23800 ;;;; Integration with and fixes for other packages
23802 ;;; Imenu support
23804 (defvar org-imenu-markers nil
23805 "All markers currently used by Imenu.")
23806 (make-variable-buffer-local 'org-imenu-markers)
23808 (defun org-imenu-new-marker (&optional pos)
23809 "Return a new marker for use by Imenu, and remember the marker."
23810 (let ((m (make-marker)))
23811 (move-marker m (or pos (point)))
23812 (push m org-imenu-markers)
23815 (defun org-imenu-get-tree ()
23816 "Produce the index for Imenu."
23817 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23818 (setq org-imenu-markers nil)
23819 (let* ((n org-imenu-depth)
23820 (re (concat "^" (org-get-limited-outline-regexp)))
23821 (subs (make-vector (1+ n) nil))
23822 (last-level 0)
23823 m level head0 head)
23824 (save-excursion
23825 (save-restriction
23826 (widen)
23827 (goto-char (point-max))
23828 (while (re-search-backward re nil t)
23829 (setq level (org-reduced-level (funcall outline-level)))
23830 (when (and (<= level n)
23831 (looking-at org-complex-heading-regexp)
23832 (setq head0 (org-match-string-no-properties 4)))
23833 (setq head (org-link-display-format head0)
23834 m (org-imenu-new-marker))
23835 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23836 (if (>= level last-level)
23837 (push (cons head m) (aref subs level))
23838 (push (cons head (aref subs (1+ level))) (aref subs level))
23839 (loop for i from (1+ level) to n do (aset subs i nil)))
23840 (setq last-level level)))))
23841 (aref subs 1)))
23843 (eval-after-load "imenu"
23844 '(progn
23845 (add-hook 'imenu-after-jump-hook
23846 (lambda ()
23847 (if (derived-mode-p 'org-mode)
23848 (org-show-context 'org-goto))))))
23850 (defun org-link-display-format (link)
23851 "Replace a link with its the description.
23852 If there is no description, use the link target."
23853 (save-match-data
23854 (if (string-match org-bracket-link-analytic-regexp link)
23855 (replace-match (if (match-end 5)
23856 (match-string 5 link)
23857 (concat (match-string 1 link)
23858 (match-string 3 link)))
23859 nil t link)
23860 link)))
23862 (defun org-toggle-link-display ()
23863 "Toggle the literal or descriptive display of links."
23864 (interactive)
23865 (if org-descriptive-links
23866 (progn (org-remove-from-invisibility-spec '(org-link))
23867 (org-restart-font-lock)
23868 (setq org-descriptive-links nil))
23869 (progn (add-to-invisibility-spec '(org-link))
23870 (org-restart-font-lock)
23871 (setq org-descriptive-links t))))
23873 ;; Speedbar support
23875 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23876 "Overlay marking the agenda restriction line in speedbar.")
23877 (overlay-put org-speedbar-restriction-lock-overlay
23878 'face 'org-agenda-restriction-lock)
23879 (overlay-put org-speedbar-restriction-lock-overlay
23880 'help-echo "Agendas are currently limited to this item.")
23881 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23883 (defun org-speedbar-set-agenda-restriction ()
23884 "Restrict future agenda commands to the location at point in speedbar.
23885 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
23886 (interactive)
23887 (require 'org-agenda)
23888 (let (p m tp np dir txt)
23889 (cond
23890 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23891 'org-imenu t))
23892 (setq m (get-text-property p 'org-imenu-marker))
23893 (with-current-buffer (marker-buffer m)
23894 (goto-char m)
23895 (org-agenda-set-restriction-lock 'subtree)))
23896 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23897 'speedbar-function 'speedbar-find-file))
23898 (setq tp (previous-single-property-change
23899 (1+ p) 'speedbar-function)
23900 np (next-single-property-change
23901 tp 'speedbar-function)
23902 dir (speedbar-line-directory)
23903 txt (buffer-substring-no-properties (or tp (point-min))
23904 (or np (point-max))))
23905 (with-current-buffer (find-file-noselect
23906 (let ((default-directory dir))
23907 (expand-file-name txt)))
23908 (unless (derived-mode-p 'org-mode)
23909 (user-error "Cannot restrict to non-Org-mode file"))
23910 (org-agenda-set-restriction-lock 'file)))
23911 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23912 (move-overlay org-speedbar-restriction-lock-overlay
23913 (point-at-bol) (point-at-eol))
23914 (setq current-prefix-arg nil)
23915 (org-agenda-maybe-redo)))
23917 (defvar speedbar-file-key-map)
23918 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23919 (eval-after-load "speedbar"
23920 '(progn
23921 (speedbar-add-supported-extension ".org")
23922 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23923 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23924 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23925 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23926 (add-hook 'speedbar-visiting-tag-hook
23927 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23929 ;;; Fixes and Hacks for problems with other packages
23931 ;; Make flyspell not check words in links, to not mess up our keymap
23932 (defvar org-element-affiliated-keywords) ; From org-element.el
23933 (defvar org-element-block-name-alist) ; From org-element.el
23934 (defun org-mode-flyspell-verify ()
23935 "Don't let flyspell put overlays at active buttons, or on
23936 {todo,all-time,additional-option-like}-keywords."
23937 (require 'org-element) ; For `org-element-affiliated-keywords'
23938 (let ((pos (max (1- (point)) (point-min)))
23939 (word (thing-at-point 'word)))
23940 (and (not (get-text-property pos 'keymap))
23941 (not (get-text-property pos 'org-no-flyspell))
23942 (not (member word org-todo-keywords-1))
23943 (not (member word org-all-time-keywords))
23944 (not (member word org-options-keywords))
23945 (not (member word (mapcar 'car org-startup-options)))
23946 (not (member-ignore-case word org-element-affiliated-keywords))
23947 (not (member-ignore-case word (org-get-export-keywords)))
23948 (not (member-ignore-case
23949 word (mapcar 'car org-element-block-name-alist)))
23950 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23951 (not (org-in-src-block-p)))))
23953 (defun org-remove-flyspell-overlays-in (beg end)
23954 "Remove flyspell overlays in region."
23955 (and (org-bound-and-true-p flyspell-mode)
23956 (fboundp 'flyspell-delete-region-overlays)
23957 (flyspell-delete-region-overlays beg end))
23958 (add-text-properties beg end '(org-no-flyspell t)))
23960 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23961 (eval-after-load "bookmark"
23962 '(if (boundp 'bookmark-after-jump-hook)
23963 ;; We can use the hook
23964 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23965 ;; Hook not available, use advice
23966 (defadvice bookmark-jump (after org-make-visible activate)
23967 "Make the position visible."
23968 (org-bookmark-jump-unhide))))
23970 ;; Make sure saveplace shows the location if it was hidden
23971 (eval-after-load "saveplace"
23972 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23973 "Make the position visible."
23974 (org-bookmark-jump-unhide)))
23976 ;; Make sure ecb shows the location if it was hidden
23977 (eval-after-load "ecb"
23978 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23979 "Make hierarchy visible when jumping into location from ECB tree buffer."
23980 (if (derived-mode-p 'org-mode)
23981 (org-show-context))))
23983 (defun org-bookmark-jump-unhide ()
23984 "Unhide the current position, to show the bookmark location."
23985 (and (derived-mode-p 'org-mode)
23986 (or (outline-invisible-p)
23987 (save-excursion (goto-char (max (point-min) (1- (point))))
23988 (outline-invisible-p)))
23989 (org-show-context 'bookmark-jump)))
23991 ;; Make session.el ignore our circular variable
23992 (defvar session-globals-exclude)
23993 (eval-after-load "session"
23994 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23996 ;;;; Finish up
23998 (provide 'org)
24000 (run-hooks 'org-load-hook)
24002 ;;; org.el ends here