org.el: Fix bindings of < and > for calendar scrolling
[org-mode.git] / lisp / org.el
blob7f4be6bdb0fecc318fa945db9681341670eb5a2c
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.
6157 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6158 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6159 non-nil, match properties even without a value.
6161 Match group 3 is set to the value when it exists. If there is no
6162 value and ALLOW-NULL is non-nil, it is set to the empty string."
6163 (concat
6164 "^\\(?4:[ \t]*\\)"
6165 (format "\\(?1::\\(?2:%s\\):\\)"
6166 (if literal property (regexp-quote property)))
6167 (if allow-null
6168 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6169 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6171 (defconst org-property-re
6172 (org-re-property ".*?" 'literal t)
6173 "Regular expression matching a property line.
6174 There are four matching groups:
6175 1: :PROPKEY: including the leading and trailing colon,
6176 2: PROPKEY without the leading and trailing colon,
6177 3: PROPVAL without leading or trailing spaces,
6178 4: the indentation of the current line,
6179 5: trailing whitespace.")
6181 (defvar org-font-lock-hook nil
6182 "Functions to be called for special font lock stuff.")
6184 (defvar org-font-lock-set-keywords-hook nil
6185 "Functions that can manipulate `org-font-lock-extra-keywords'.
6186 This is called after `org-font-lock-extra-keywords' is defined, but before
6187 it is installed to be used by font lock. This can be useful if something
6188 needs to be inserted at a specific position in the font-lock sequence.")
6190 (defun org-font-lock-hook (limit)
6191 "Run `org-font-lock-hook' within LIMIT."
6192 (run-hook-with-args 'org-font-lock-hook limit))
6194 (defun org-set-font-lock-defaults ()
6195 "Set font lock defaults for the current buffer."
6196 (let* ((em org-fontify-emphasized-text)
6197 (lk org-activate-links)
6198 (org-font-lock-extra-keywords
6199 (list
6200 ;; Call the hook
6201 '(org-font-lock-hook)
6202 ;; Headlines
6203 `(,(if org-fontify-whole-heading-line
6204 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6205 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6206 (1 (org-get-level-face 1))
6207 (2 (org-get-level-face 2))
6208 (3 (org-get-level-face 3)))
6209 ;; Table lines
6210 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6211 (1 'org-table t))
6212 ;; Table internals
6213 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6214 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6215 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6216 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6217 ;; Drawers
6218 (list org-drawer-regexp '(0 'org-special-keyword t))
6219 (list "^[ \t]*:END:" '(0 'org-special-keyword t))
6220 ;; Properties
6221 (list org-property-re
6222 '(1 'org-special-keyword t)
6223 '(3 'org-property-value t))
6224 ;; Links
6225 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6226 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6227 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6228 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6229 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6230 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6231 (if (memq 'footnote lk) '(org-activate-footnote-links))
6232 ;; Targets.
6233 (list org-any-target-regexp '(0 'org-target t))
6234 ;; Diary sexps.
6235 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6236 ;; Macro
6237 '("{{{.+}}}" (0 'org-macro t))
6238 '(org-hide-wide-columns (0 nil append))
6239 ;; TODO keyword
6240 (list (format org-heading-keyword-regexp-format
6241 org-todo-regexp)
6242 '(2 (org-get-todo-face 2) t))
6243 ;; DONE
6244 (if org-fontify-done-headline
6245 (list (format org-heading-keyword-regexp-format
6246 (concat
6247 "\\(?:"
6248 (mapconcat 'regexp-quote org-done-keywords "\\|")
6249 "\\)"))
6250 '(2 'org-headline-done t))
6251 nil)
6252 ;; Priorities
6253 '(org-font-lock-add-priority-faces)
6254 ;; Tags
6255 '(org-font-lock-add-tag-faces)
6256 ;; Tags groups
6257 (if (and org-group-tags org-tag-groups-alist)
6258 (list (concat org-outline-regexp-bol ".+\\(:"
6259 (regexp-opt (mapcar 'car org-tag-groups-alist))
6260 ":\\).*$")
6261 '(1 'org-tag-group prepend)))
6262 ;; Special keywords
6263 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6264 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6265 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6266 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6267 ;; Emphasis
6268 (if em
6269 (if (featurep 'xemacs)
6270 '(org-do-emphasis-faces (0 nil append))
6271 '(org-do-emphasis-faces)))
6272 ;; Checkboxes
6273 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6274 1 'org-checkbox prepend)
6275 (if (cdr (assq 'checkbox org-list-automatic-rules))
6276 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6277 (0 (org-get-checkbox-statistics-face) t)))
6278 ;; Description list items
6279 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6280 1 'org-list-dt prepend)
6281 ;; ARCHIVEd headings
6282 (list (concat
6283 org-outline-regexp-bol
6284 "\\(.*:" org-archive-tag ":.*\\)")
6285 '(1 'org-archived prepend))
6286 ;; Specials
6287 '(org-do-latex-and-related)
6288 '(org-fontify-entities)
6289 '(org-raise-scripts)
6290 ;; Code
6291 '(org-activate-code (1 'org-code t))
6292 ;; COMMENT
6293 (list (format org-heading-keyword-regexp-format
6294 (concat "\\("
6295 org-comment-string "\\|" org-quote-string
6296 "\\)"))
6297 '(2 'org-special-keyword t))
6298 ;; Blocks and meta lines
6299 '(org-fontify-meta-lines-and-blocks))))
6300 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6301 (run-hooks 'org-font-lock-set-keywords-hook)
6302 ;; Now set the full font-lock-keywords
6303 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6304 (org-set-local 'font-lock-defaults
6305 '(org-font-lock-keywords t nil nil backward-paragraph))
6306 (kill-local-variable 'font-lock-keywords) nil))
6308 (defun org-toggle-pretty-entities ()
6309 "Toggle the composition display of entities as UTF8 characters."
6310 (interactive)
6311 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6312 (org-restart-font-lock)
6313 (if org-pretty-entities
6314 (message "Entities are now displayed as UTF8 characters")
6315 (save-restriction
6316 (widen)
6317 (org-decompose-region (point-min) (point-max))
6318 (message "Entities are now displayed as plain text"))))
6320 (defvar org-custom-properties-overlays nil
6321 "List of overlays used for custom properties.")
6322 (make-variable-buffer-local 'org-custom-properties-overlays)
6324 (defun org-toggle-custom-properties-visibility ()
6325 "Display or hide properties in `org-custom-properties'."
6326 (interactive)
6327 (if org-custom-properties-overlays
6328 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6329 (setq org-custom-properties-overlays nil))
6330 (unless (not org-custom-properties)
6331 (save-excursion
6332 (save-restriction
6333 (widen)
6334 (goto-char (point-min))
6335 (while (re-search-forward org-property-re nil t)
6336 (mapc (lambda(p)
6337 (when (equal p (substring (match-string 1) 1 -1))
6338 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6339 (overlay-put o 'invisible t)
6340 (overlay-put o 'org-custom-property t)
6341 (push o org-custom-properties-overlays))))
6342 org-custom-properties)))))))
6344 (defun org-fontify-entities (limit)
6345 "Find an entity to fontify."
6346 (let (ee)
6347 (when org-pretty-entities
6348 (catch 'match
6349 (while (re-search-forward
6350 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6351 limit t)
6352 (if (and (not (org-in-indented-comment-line))
6353 (setq ee (org-entity-get (match-string 1)))
6354 (= (length (nth 6 ee)) 1))
6355 (let*
6356 ((end (if (equal (match-string 2) "{}")
6357 (match-end 2)
6358 (match-end 1))))
6359 (add-text-properties
6360 (match-beginning 0) end
6361 (list 'font-lock-fontified t))
6362 (compose-region (match-beginning 0) end
6363 (nth 6 ee) nil)
6364 (backward-char 1)
6365 (throw 'match t))))
6366 nil))))
6368 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6369 "Fontify string S like in Org-mode."
6370 (with-temp-buffer
6371 (insert s)
6372 (let ((org-odd-levels-only odd-levels))
6373 (org-mode)
6374 (font-lock-fontify-buffer)
6375 (buffer-string))))
6377 (defvar org-m nil)
6378 (defvar org-l nil)
6379 (defvar org-f nil)
6380 (defun org-get-level-face (n)
6381 "Get the right face for match N in font-lock matching of headlines."
6382 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6383 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6384 (if org-cycle-level-faces
6385 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6386 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6387 (cond
6388 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6389 ((eq n 2) org-f)
6390 (t (if org-level-color-stars-only nil org-f))))
6393 (defun org-get-todo-face (kwd)
6394 "Get the right face for a TODO keyword KWD.
6395 If KWD is a number, get the corresponding match group."
6396 (if (numberp kwd) (setq kwd (match-string kwd)))
6397 (or (org-face-from-face-or-color
6398 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6399 (and (member kwd org-done-keywords) 'org-done)
6400 'org-todo))
6402 (defun org-face-from-face-or-color (context inherit face-or-color)
6403 "Create a face list that inherits INHERIT, but sets the foreground color.
6404 When FACE-OR-COLOR is not a string, just return it."
6405 (if (stringp face-or-color)
6406 (list :inherit inherit
6407 (cdr (assoc context org-faces-easy-properties))
6408 face-or-color)
6409 face-or-color))
6411 (defun org-font-lock-add-tag-faces (limit)
6412 "Add the special tag faces."
6413 (when (and org-tag-faces org-tags-special-faces-re)
6414 (while (re-search-forward org-tags-special-faces-re limit t)
6415 (add-text-properties (match-beginning 1) (match-end 1)
6416 (list 'face (org-get-tag-face 1)
6417 'font-lock-fontified t))
6418 (backward-char 1))))
6420 (defun org-font-lock-add-priority-faces (limit)
6421 "Add the special priority faces."
6422 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6423 (when (save-match-data (org-at-heading-p))
6424 (add-text-properties
6425 (match-beginning 0) (match-end 0)
6426 (list 'face (or (org-face-from-face-or-color
6427 'priority 'org-priority
6428 (cdr (assoc (char-after (match-beginning 1))
6429 org-priority-faces)))
6430 'org-priority)
6431 'font-lock-fontified t)))))
6433 (defun org-get-tag-face (kwd)
6434 "Get the right face for a TODO keyword KWD.
6435 If KWD is a number, get the corresponding match group."
6436 (if (numberp kwd) (setq kwd (match-string kwd)))
6437 (or (org-face-from-face-or-color
6438 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6439 'org-tag))
6441 (defun org-unfontify-region (beg end &optional maybe_loudly)
6442 "Remove fontification and activation overlays from links."
6443 (font-lock-default-unfontify-region beg end)
6444 (let* ((buffer-undo-list t)
6445 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6446 (inhibit-modification-hooks t)
6447 deactivate-mark buffer-file-name buffer-file-truename)
6448 (org-decompose-region beg end)
6449 (remove-text-properties beg end
6450 '(mouse-face t keymap t org-linked-text t
6451 invisible t intangible t
6452 org-no-flyspell t org-emphasis t))
6453 (org-remove-font-lock-display-properties beg end)))
6455 (defconst org-script-display '(((raise -0.3) (height 0.7))
6456 ((raise 0.3) (height 0.7))
6457 ((raise -0.5))
6458 ((raise 0.5)))
6459 "Display properties for showing superscripts and subscripts.")
6461 (defun org-remove-font-lock-display-properties (beg end)
6462 "Remove specific display properties that have been added by font lock.
6463 The will remove the raise properties that are used to show superscripts
6464 and subscripts."
6465 (let (next prop)
6466 (while (< beg end)
6467 (setq next (next-single-property-change beg 'display nil end)
6468 prop (get-text-property beg 'display))
6469 (if (member prop org-script-display)
6470 (put-text-property beg next 'display nil))
6471 (setq beg next))))
6473 (defun org-raise-scripts (limit)
6474 "Add raise properties to sub/superscripts."
6475 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6476 (if (re-search-forward
6477 (if (eq org-use-sub-superscripts t)
6478 org-match-substring-regexp
6479 org-match-substring-with-braces-regexp)
6480 limit t)
6481 (let* ((pos (point)) table-p comment-p
6482 (mpos (match-beginning 3))
6483 (emph-p (get-text-property mpos 'org-emphasis))
6484 (link-p (get-text-property mpos 'mouse-face))
6485 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6486 (goto-char (point-at-bol))
6487 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6488 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6489 (goto-char pos)
6490 ;; Handle a_b^c
6491 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6492 (if (or comment-p emph-p link-p keyw-p)
6494 (put-text-property (match-beginning 3) (match-end 0)
6495 'display
6496 (if (equal (char-after (match-beginning 2)) ?^)
6497 (nth (if table-p 3 1) org-script-display)
6498 (nth (if table-p 2 0) org-script-display)))
6499 (add-text-properties (match-beginning 2) (match-end 2)
6500 (list 'invisible t
6501 'org-dwidth t 'org-dwidth-n 1))
6502 (if (and (eq (char-after (match-beginning 3)) ?{)
6503 (eq (char-before (match-end 3)) ?}))
6504 (progn
6505 (add-text-properties
6506 (match-beginning 3) (1+ (match-beginning 3))
6507 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6508 (add-text-properties
6509 (1- (match-end 3)) (match-end 3)
6510 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6511 t)))))
6513 ;;;; Visibility cycling, including org-goto and indirect buffer
6515 ;;; Cycling
6517 (defvar org-cycle-global-status nil)
6518 (make-variable-buffer-local 'org-cycle-global-status)
6519 (put 'org-cycle-global-status 'org-state t)
6520 (defvar org-cycle-subtree-status nil)
6521 (make-variable-buffer-local 'org-cycle-subtree-status)
6522 (put 'org-cycle-subtree-status 'org-state t)
6524 (defvar org-inlinetask-min-level)
6526 (defun org-unlogged-message (&rest args)
6527 "Display a message, but avoid logging it in the *Messages* buffer."
6528 (let ((message-log-max nil))
6529 (apply 'message args)))
6531 ;;;###autoload
6532 (defun org-cycle (&optional arg)
6533 "TAB-action and visibility cycling for Org-mode.
6535 This is the command invoked in Org-mode by the TAB key. Its main purpose
6536 is outline visibility cycling, but it also invokes other actions
6537 in special contexts.
6539 - When this function is called with a prefix argument, rotate the entire
6540 buffer through 3 states (global cycling)
6541 1. OVERVIEW: Show only top-level headlines.
6542 2. CONTENTS: Show all headlines of all levels, but no body text.
6543 3. SHOW ALL: Show everything.
6544 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6545 determined by the variable `org-startup-folded', and by any VISIBILITY
6546 properties in the buffer.
6547 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6548 including any drawers.
6550 - When inside a table, re-align the table and move to the next field.
6552 - When point is at the beginning of a headline, rotate the subtree started
6553 by this line through 3 different states (local cycling)
6554 1. FOLDED: Only the main headline is shown.
6555 2. CHILDREN: The main headline and the direct children are shown.
6556 From this state, you can move to one of the children
6557 and zoom in further.
6558 3. SUBTREE: Show the entire subtree, including body text.
6559 If there is no subtree, switch directly from CHILDREN to FOLDED.
6561 - When point is at the beginning of an empty headline and the variable
6562 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6563 of the headline by demoting and promoting it to likely levels. This
6564 speeds up creation document structure by pressing TAB once or several
6565 times right after creating a new headline.
6567 - When there is a numeric prefix, go up to a heading with level ARG, do
6568 a `show-subtree' and return to the previous cursor position. If ARG
6569 is negative, go up that many levels.
6571 - When point is not at the beginning of a headline, execute the global
6572 binding for TAB, which is re-indenting the line. See the option
6573 `org-cycle-emulate-tab' for details.
6575 - Special case: if point is at the beginning of the buffer and there is
6576 no headline in line 1, this function will act as if called with prefix arg
6577 (C-u TAB, same as S-TAB) also when called without prefix arg.
6578 But only if also the variable `org-cycle-global-at-bob' is t."
6579 (interactive "P")
6580 (org-load-modules-maybe)
6581 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6582 (and org-cycle-level-after-item/entry-creation
6583 (or (org-cycle-level)
6584 (org-cycle-item-indentation))))
6585 (let* ((limit-level
6586 (or org-cycle-max-level
6587 (and (boundp 'org-inlinetask-min-level)
6588 org-inlinetask-min-level
6589 (1- org-inlinetask-min-level))))
6590 (nstars (and limit-level
6591 (if org-odd-levels-only
6592 (and limit-level (1- (* limit-level 2)))
6593 limit-level)))
6594 (org-outline-regexp
6595 (if (not (derived-mode-p 'org-mode))
6596 outline-regexp
6597 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6598 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6599 (not (looking-at org-outline-regexp))))
6600 (org-cycle-hook
6601 (if bob-special
6602 (delq 'org-optimize-window-after-visibility-change
6603 (copy-sequence org-cycle-hook))
6604 org-cycle-hook))
6605 (pos (point)))
6607 (if (or bob-special (equal arg '(4)))
6608 ;; special case: use global cycling
6609 (setq arg t))
6611 (cond
6613 ((equal arg '(16))
6614 (setq last-command 'dummy)
6615 (org-set-startup-visibility)
6616 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6618 ((equal arg '(64))
6619 (show-all)
6620 (org-unlogged-message "Entire buffer visible, including drawers"))
6622 ;; Try cdlatex TAB completion
6623 ((org-try-cdlatex-tab))
6625 ;; Table: enter it or move to the next field.
6626 ((org-at-table-p 'any)
6627 (if (org-at-table.el-p)
6628 (message "Use C-c ' to edit table.el tables")
6629 (if arg (org-table-edit-field t)
6630 (org-table-justify-field-maybe)
6631 (call-interactively 'org-table-next-field))))
6633 ((run-hook-with-args-until-success
6634 'org-tab-after-check-for-table-hook))
6636 ;; Global cycling: delegate to `org-cycle-internal-global'.
6637 ((eq arg t) (org-cycle-internal-global))
6639 ;; Drawers: delegate to `org-flag-drawer'.
6640 ((and org-drawers org-drawer-regexp
6641 (save-excursion
6642 (beginning-of-line 1)
6643 (looking-at org-drawer-regexp)))
6644 (org-flag-drawer ; toggle block visibility
6645 (not (get-char-property (match-end 0) 'invisible))))
6647 ;; Show-subtree, ARG levels up from here.
6648 ((integerp arg)
6649 (save-excursion
6650 (org-back-to-heading)
6651 (outline-up-heading (if (< arg 0) (- arg)
6652 (- (funcall outline-level) arg)))
6653 (org-show-subtree)))
6655 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6656 ((and (featurep 'org-inlinetask)
6657 (org-inlinetask-at-task-p)
6658 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6659 (org-inlinetask-toggle-visibility))
6661 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6662 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6663 (save-excursion (beginning-of-line 1)
6664 (looking-at org-outline-regexp)))
6665 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6666 (org-cycle-internal-local))
6668 ;; From there: TAB emulation and template completion.
6669 (buffer-read-only (org-back-to-heading))
6671 ((run-hook-with-args-until-success
6672 'org-tab-after-check-for-cycling-hook))
6674 ((org-try-structure-completion))
6676 ((run-hook-with-args-until-success
6677 'org-tab-before-tab-emulation-hook))
6679 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6680 (or (not (bolp))
6681 (not (looking-at org-outline-regexp))))
6682 (call-interactively (global-key-binding "\t")))
6684 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6685 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6686 (or (and (eq org-cycle-emulate-tab 'white)
6687 (= (match-end 0) (point-at-eol)))
6688 (and (eq org-cycle-emulate-tab 'whitestart)
6689 (>= (match-end 0) pos))))
6691 (eq org-cycle-emulate-tab t))
6692 (call-interactively (global-key-binding "\t")))
6694 (t (save-excursion
6695 (org-back-to-heading)
6696 (org-cycle)))))))
6698 (defun org-cycle-internal-global ()
6699 "Do the global cycling action."
6700 ;; Hack to avoid display of messages for .org attachments in Gnus
6701 (let ((ga (string-match "\\*fontification" (buffer-name))))
6702 (cond
6703 ((and (eq last-command this-command)
6704 (eq org-cycle-global-status 'overview))
6705 ;; We just created the overview - now do table of contents
6706 ;; This can be slow in very large buffers, so indicate action
6707 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6708 (unless ga (org-unlogged-message "CONTENTS..."))
6709 (org-content)
6710 (unless ga (org-unlogged-message "CONTENTS...done"))
6711 (setq org-cycle-global-status 'contents)
6712 (run-hook-with-args 'org-cycle-hook 'contents))
6714 ((and (eq last-command this-command)
6715 (eq org-cycle-global-status 'contents))
6716 ;; We just showed the table of contents - now show everything
6717 (run-hook-with-args 'org-pre-cycle-hook 'all)
6718 (show-all)
6719 (unless ga (org-unlogged-message "SHOW ALL"))
6720 (setq org-cycle-global-status 'all)
6721 (run-hook-with-args 'org-cycle-hook 'all))
6724 ;; Default action: go to overview
6725 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6726 (org-overview)
6727 (unless ga (org-unlogged-message "OVERVIEW"))
6728 (setq org-cycle-global-status 'overview)
6729 (run-hook-with-args 'org-cycle-hook 'overview)))))
6731 (defvar org-called-with-limited-levels nil
6732 "Non-nil when `org-with-limited-levels' is currently active.")
6734 (defun org-cycle-internal-local ()
6735 "Do the local cycling action."
6736 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6737 ;; First, determine end of headline (EOH), end of subtree or item
6738 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6739 (save-excursion
6740 (if (org-at-item-p)
6741 (progn
6742 (beginning-of-line)
6743 (setq struct (org-list-struct))
6744 (setq eoh (point-at-eol))
6745 (setq eos (org-list-get-item-end-before-blank (point) struct))
6746 (setq has-children (org-list-has-child-p (point) struct)))
6747 (org-back-to-heading)
6748 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6749 (setq eos (save-excursion (org-end-of-subtree t t)
6750 (when (bolp) (backward-char)) (point)))
6751 (setq has-children
6752 (or (save-excursion
6753 (let ((level (funcall outline-level)))
6754 (outline-next-heading)
6755 (and (org-at-heading-p t)
6756 (> (funcall outline-level) level))))
6757 (save-excursion
6758 (org-list-search-forward (org-item-beginning-re) eos t)))))
6759 ;; Determine end invisible part of buffer (EOL)
6760 (beginning-of-line 2)
6761 ;; XEmacs doesn't have `next-single-char-property-change'
6762 (if (featurep 'xemacs)
6763 (while (and (not (eobp)) ;; this is like `next-line'
6764 (get-char-property (1- (point)) 'invisible))
6765 (beginning-of-line 2))
6766 (while (and (not (eobp)) ;; this is like `next-line'
6767 (get-char-property (1- (point)) 'invisible))
6768 (goto-char (next-single-char-property-change (point) 'invisible))
6769 (and (eolp) (beginning-of-line 2))))
6770 (setq eol (point)))
6771 ;; Find out what to do next and set `this-command'
6772 (cond
6773 ((= eos eoh)
6774 ;; Nothing is hidden behind this heading
6775 (unless (org-before-first-heading-p)
6776 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6777 (org-unlogged-message "EMPTY ENTRY")
6778 (setq org-cycle-subtree-status nil)
6779 (save-excursion
6780 (goto-char eos)
6781 (outline-next-heading)
6782 (if (outline-invisible-p) (org-flag-heading nil))))
6783 ((and (or (>= eol eos)
6784 (not (string-match "\\S-" (buffer-substring eol eos))))
6785 (or has-children
6786 (not (setq children-skipped
6787 org-cycle-skip-children-state-if-no-children))))
6788 ;; Entire subtree is hidden in one line: children view
6789 (unless (org-before-first-heading-p)
6790 (run-hook-with-args 'org-pre-cycle-hook 'children))
6791 (if (org-at-item-p)
6792 (org-list-set-item-visibility (point-at-bol) struct 'children)
6793 (org-show-entry)
6794 (org-with-limited-levels (show-children))
6795 ;; FIXME: This slows down the func way too much.
6796 ;; How keep drawers hidden in subtree anyway?
6797 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6798 ;; (org-cycle-hide-drawers 'subtree))
6800 ;; Fold every list in subtree to top-level items.
6801 (when (eq org-cycle-include-plain-lists 'integrate)
6802 (save-excursion
6803 (org-back-to-heading)
6804 (while (org-list-search-forward (org-item-beginning-re) eos t)
6805 (beginning-of-line 1)
6806 (let* ((struct (org-list-struct))
6807 (prevs (org-list-prevs-alist struct))
6808 (end (org-list-get-bottom-point struct)))
6809 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6810 (org-list-get-all-items (point) struct prevs))
6811 (goto-char (if (< end eos) end eos)))))))
6812 (org-unlogged-message "CHILDREN")
6813 (save-excursion
6814 (goto-char eos)
6815 (outline-next-heading)
6816 (if (outline-invisible-p) (org-flag-heading nil)))
6817 (setq org-cycle-subtree-status 'children)
6818 (unless (org-before-first-heading-p)
6819 (run-hook-with-args 'org-cycle-hook 'children)))
6820 ((or children-skipped
6821 (and (eq last-command this-command)
6822 (eq org-cycle-subtree-status 'children)))
6823 ;; We just showed the children, or no children are there,
6824 ;; now show everything.
6825 (unless (org-before-first-heading-p)
6826 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6827 (outline-flag-region eoh eos nil)
6828 (org-unlogged-message
6829 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6830 (setq org-cycle-subtree-status 'subtree)
6831 (unless (org-before-first-heading-p)
6832 (run-hook-with-args 'org-cycle-hook 'subtree)))
6834 ;; Default action: hide the subtree.
6835 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6836 (outline-flag-region eoh eos t)
6837 (org-unlogged-message "FOLDED")
6838 (setq org-cycle-subtree-status 'folded)
6839 (unless (org-before-first-heading-p)
6840 (run-hook-with-args 'org-cycle-hook 'folded))))))
6842 ;;;###autoload
6843 (defun org-global-cycle (&optional arg)
6844 "Cycle the global visibility. For details see `org-cycle'.
6845 With \\[universal-argument] prefix arg, switch to startup visibility.
6846 With a numeric prefix, show all headlines up to that level."
6847 (interactive "P")
6848 (let ((org-cycle-include-plain-lists
6849 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6850 (cond
6851 ((integerp arg)
6852 (show-all)
6853 (hide-sublevels arg)
6854 (setq org-cycle-global-status 'contents))
6855 ((equal arg '(4))
6856 (org-set-startup-visibility)
6857 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6859 (org-cycle '(4))))))
6861 (defun org-set-startup-visibility ()
6862 "Set the visibility required by startup options and properties."
6863 (cond
6864 ((eq org-startup-folded t)
6865 (org-overview))
6866 ((eq org-startup-folded 'content)
6867 (org-content))
6868 ((or (eq org-startup-folded 'showeverything)
6869 (eq org-startup-folded nil))
6870 (show-all)))
6871 (unless (eq org-startup-folded 'showeverything)
6872 (if org-hide-block-startup (org-hide-block-all))
6873 (org-set-visibility-according-to-property 'no-cleanup)
6874 (org-cycle-hide-archived-subtrees 'all)
6875 (org-cycle-hide-drawers 'all)
6876 (org-cycle-show-empty-lines t)))
6878 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6879 "Switch subtree visibilities according to :VISIBILITY: property."
6880 (interactive)
6881 (let (org-show-entry-below state)
6882 (save-excursion
6883 (goto-char (point-min))
6884 (while (re-search-forward
6885 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6886 nil t)
6887 (setq state (match-string 1))
6888 (save-excursion
6889 (org-back-to-heading t)
6890 (hide-subtree)
6891 (org-reveal)
6892 (cond
6893 ((equal state '("fold" "folded"))
6894 (hide-subtree))
6895 ((equal state "children")
6896 (org-show-hidden-entry)
6897 (show-children))
6898 ((equal state "content")
6899 (save-excursion
6900 (save-restriction
6901 (org-narrow-to-subtree)
6902 (org-content))))
6903 ((member state '("all" "showall"))
6904 (show-subtree)))))
6905 (unless no-cleanup
6906 (org-cycle-hide-archived-subtrees 'all)
6907 (org-cycle-hide-drawers 'all)
6908 (org-cycle-show-empty-lines 'all)))))
6910 ;; This function uses outline-regexp instead of the more fundamental
6911 ;; org-outline-regexp so that org-cycle-global works outside of Org
6912 ;; buffers, where outline-regexp is needed.
6913 (defun org-overview ()
6914 "Switch to overview mode, showing only top-level headlines.
6915 This shows all headlines with a level equal or greater than the level
6916 of the first headline in the buffer. This is important, because if the
6917 first headline is not level one, then (hide-sublevels 1) gives confusing
6918 results."
6919 (interactive)
6920 (save-excursion
6921 (let ((level
6922 (save-excursion
6923 (goto-char (point-min))
6924 (if (re-search-forward (concat "^" outline-regexp) nil t)
6925 (progn
6926 (goto-char (match-beginning 0))
6927 (funcall outline-level))))))
6928 (and level (hide-sublevels level)))))
6930 (defun org-content (&optional arg)
6931 "Show all headlines in the buffer, like a table of contents.
6932 With numerical argument N, show content up to level N."
6933 (interactive "P")
6934 (org-overview)
6935 (save-excursion
6936 ;; Visit all headings and show their offspring
6937 (and (integerp arg) (org-overview))
6938 (goto-char (point-max))
6939 (catch 'exit
6940 (while (and (progn (condition-case nil
6941 (outline-previous-visible-heading 1)
6942 (error (goto-char (point-min))))
6944 (looking-at org-outline-regexp))
6945 (if (integerp arg)
6946 (show-children (1- arg))
6947 (show-branches))
6948 (if (bobp) (throw 'exit nil))))))
6950 (defun org-optimize-window-after-visibility-change (state)
6951 "Adjust the window after a change in outline visibility.
6952 This function is the default value of the hook `org-cycle-hook'."
6953 (when (get-buffer-window (current-buffer))
6954 (cond
6955 ((eq state 'content) nil)
6956 ((eq state 'all) nil)
6957 ((eq state 'folded) nil)
6958 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6959 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6961 (defun org-remove-empty-overlays-at (pos)
6962 "Remove outline overlays that do not contain non-white stuff."
6963 (mapc
6964 (lambda (o)
6965 (and (eq 'outline (overlay-get o 'invisible))
6966 (not (string-match "\\S-" (buffer-substring (overlay-start o)
6967 (overlay-end o))))
6968 (delete-overlay o)))
6969 (overlays-at pos)))
6971 (defun org-clean-visibility-after-subtree-move ()
6972 "Fix visibility issues after moving a subtree."
6973 ;; First, find a reasonable region to look at:
6974 ;; Start two siblings above, end three below
6975 (let* ((beg (save-excursion
6976 (and (org-get-last-sibling)
6977 (org-get-last-sibling))
6978 (point)))
6979 (end (save-excursion
6980 (and (org-get-next-sibling)
6981 (org-get-next-sibling)
6982 (org-get-next-sibling))
6983 (if (org-at-heading-p)
6984 (point-at-eol)
6985 (point))))
6986 (level (looking-at "\\*+"))
6987 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
6988 (save-excursion
6989 (save-restriction
6990 (narrow-to-region beg end)
6991 (when re
6992 ;; Properly fold already folded siblings
6993 (goto-char (point-min))
6994 (while (re-search-forward re nil t)
6995 (if (and (not (outline-invisible-p))
6996 (save-excursion
6997 (goto-char (point-at-eol)) (outline-invisible-p)))
6998 (hide-entry))))
6999 (org-cycle-show-empty-lines 'overview)
7000 (org-cycle-hide-drawers 'overview)))))
7002 (defun org-cycle-show-empty-lines (state)
7003 "Show empty lines above all visible headlines.
7004 The region to be covered depends on STATE when called through
7005 `org-cycle-hook'. Lisp program can use t for STATE to get the
7006 entire buffer covered. Note that an empty line is only shown if there
7007 are at least `org-cycle-separator-lines' empty lines before the headline."
7008 (when (not (= org-cycle-separator-lines 0))
7009 (save-excursion
7010 (let* ((n (abs org-cycle-separator-lines))
7011 (re (cond
7012 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7013 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7014 (t (let ((ns (number-to-string (- n 2))))
7015 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7016 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7017 beg end b e)
7018 (cond
7019 ((memq state '(overview contents t))
7020 (setq beg (point-min) end (point-max)))
7021 ((memq state '(children folded))
7022 (setq beg (point) end (progn (org-end-of-subtree t t)
7023 (beginning-of-line 2)
7024 (point)))))
7025 (when beg
7026 (goto-char beg)
7027 (while (re-search-forward re end t)
7028 (unless (get-char-property (match-end 1) 'invisible)
7029 (setq e (match-end 1))
7030 (if (< org-cycle-separator-lines 0)
7031 (setq b (save-excursion
7032 (goto-char (match-beginning 0))
7033 (org-back-over-empty-lines)
7034 (if (save-excursion
7035 (goto-char (max (point-min) (1- (point))))
7036 (org-at-heading-p))
7037 (1- (point))
7038 (point))))
7039 (setq b (match-beginning 1)))
7040 (outline-flag-region b e nil)))))))
7041 ;; Never hide empty lines at the end of the file.
7042 (save-excursion
7043 (goto-char (point-max))
7044 (outline-previous-heading)
7045 (outline-end-of-heading)
7046 (if (and (looking-at "[ \t\n]+")
7047 (= (match-end 0) (point-max)))
7048 (outline-flag-region (point) (match-end 0) nil))))
7050 (defun org-show-empty-lines-in-parent ()
7051 "Move to the parent and re-show empty lines before visible headlines."
7052 (save-excursion
7053 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7054 (org-cycle-show-empty-lines context))))
7056 (defun org-files-list ()
7057 "Return `org-agenda-files' list, plus all open org-mode files.
7058 This is useful for operations that need to scan all of a user's
7059 open and agenda-wise Org files."
7060 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7061 (dolist (buf (buffer-list))
7062 (with-current-buffer buf
7063 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7064 (let ((file (expand-file-name (buffer-file-name))))
7065 (unless (member file files)
7066 (push file files))))))
7067 files))
7069 (defsubst org-entry-beginning-position ()
7070 "Return the beginning position of the current entry."
7071 (save-excursion (outline-back-to-heading t) (point)))
7073 (defsubst org-entry-end-position ()
7074 "Return the end position of the current entry."
7075 (save-excursion (outline-next-heading) (point)))
7077 (defun org-cycle-hide-drawers (state)
7078 "Re-hide all drawers after a visibility state change."
7079 (when (and (derived-mode-p 'org-mode)
7080 (not (memq state '(overview folded contents))))
7081 (save-excursion
7082 (let* ((globalp (memq state '(contents all)))
7083 (beg (if globalp (point-min) (point)))
7084 (end (if globalp (point-max)
7085 (if (eq state 'children)
7086 (save-excursion (outline-next-heading) (point))
7087 (org-end-of-subtree t)))))
7088 (goto-char beg)
7089 (while (re-search-forward org-drawer-regexp end t)
7090 (org-flag-drawer t))))))
7092 (defun org-cycle-hide-inline-tasks (state)
7093 "Re-hide inline tasks when switching to 'contents or 'children
7094 visibility state."
7095 (case state
7096 (contents
7097 (when (org-bound-and-true-p org-inlinetask-min-level)
7098 (hide-sublevels (1- org-inlinetask-min-level))))
7099 (children
7100 (when (featurep 'org-inlinetask)
7101 (save-excursion
7102 (while (and (outline-next-heading)
7103 (org-inlinetask-at-task-p))
7104 (org-inlinetask-toggle-visibility)
7105 (org-inlinetask-goto-end)))))))
7107 (defun org-flag-drawer (flag)
7108 "When FLAG is non-nil, hide the drawer we are within.
7109 Otherwise make it visible."
7110 (save-excursion
7111 (beginning-of-line 1)
7112 (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
7113 (let ((b (match-end 0)))
7114 (if (re-search-forward
7115 "^[ \t]*:END:"
7116 (save-excursion (outline-next-heading) (point)) t)
7117 (outline-flag-region b (point-at-eol) flag)
7118 (user-error ":END: line missing at position %s" b))))))
7120 (defun org-subtree-end-visible-p ()
7121 "Is the end of the current subtree visible?"
7122 (pos-visible-in-window-p
7123 (save-excursion (org-end-of-subtree t) (point))))
7125 (defun org-first-headline-recenter ()
7126 "Move cursor to the first headline and recenter the headline."
7127 (goto-char (point-min))
7128 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7129 (set-window-start (selected-window) (point-at-bol))))
7131 ;;; Saving and restoring visibility
7133 (defun org-outline-overlay-data (&optional use-markers)
7134 "Return a list of the locations of all outline overlays.
7135 These are overlays with the `invisible' property value `outline'.
7136 The return value is a list of cons cells, with start and stop
7137 positions for each overlay.
7138 If USE-MARKERS is set, return the positions as markers."
7139 (let (beg end)
7140 (save-excursion
7141 (save-restriction
7142 (widen)
7143 (delq nil
7144 (mapcar (lambda (o)
7145 (when (eq (overlay-get o 'invisible) 'outline)
7146 (setq beg (overlay-start o)
7147 end (overlay-end o))
7148 (and beg end (> end beg)
7149 (if use-markers
7150 (cons (move-marker (make-marker) beg)
7151 (move-marker (make-marker) end))
7152 (cons beg end)))))
7153 (overlays-in (point-min) (point-max))))))))
7155 (defun org-set-outline-overlay-data (data)
7156 "Create visibility overlays for all positions in DATA.
7157 DATA should have been made by `org-outline-overlay-data'."
7158 (let (o)
7159 (save-excursion
7160 (save-restriction
7161 (widen)
7162 (show-all)
7163 (mapc (lambda (c)
7164 (outline-flag-region (car c) (cdr c) t))
7165 data)))))
7167 ;;; Folding of blocks
7169 (defvar org-hide-block-overlays nil
7170 "Overlays hiding blocks.")
7171 (make-variable-buffer-local 'org-hide-block-overlays)
7173 (defun org-block-map (function &optional start end)
7174 "Call FUNCTION at the head of all source blocks in the current buffer.
7175 Optional arguments START and END can be used to limit the range."
7176 (let ((start (or start (point-min)))
7177 (end (or end (point-max))))
7178 (save-excursion
7179 (goto-char start)
7180 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7181 (save-excursion
7182 (save-match-data
7183 (goto-char (match-beginning 0))
7184 (funcall function)))))))
7186 (defun org-hide-block-toggle-all ()
7187 "Toggle the visibility of all blocks in the current buffer."
7188 (org-block-map #'org-hide-block-toggle))
7190 (defun org-hide-block-all ()
7191 "Fold all blocks in the current buffer."
7192 (interactive)
7193 (org-show-block-all)
7194 (org-block-map #'org-hide-block-toggle-maybe))
7196 (defun org-show-block-all ()
7197 "Unfold all blocks in the current buffer."
7198 (interactive)
7199 (mapc 'delete-overlay org-hide-block-overlays)
7200 (setq org-hide-block-overlays nil))
7202 (defun org-hide-block-toggle-maybe ()
7203 "Toggle visibility of block at point."
7204 (interactive)
7205 (let ((case-fold-search t))
7206 (if (save-excursion
7207 (beginning-of-line 1)
7208 (looking-at org-block-regexp))
7209 (progn (org-hide-block-toggle)
7210 t) ;; to signal that we took action
7211 nil))) ;; to signal that we did not
7213 (defun org-hide-block-toggle (&optional force)
7214 "Toggle the visibility of the current block."
7215 (interactive)
7216 (save-excursion
7217 (beginning-of-line)
7218 (if (re-search-forward org-block-regexp nil t)
7219 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7220 (end (match-end 0)) ;; end of entire body
7222 (if (memq t (mapcar (lambda (overlay)
7223 (eq (overlay-get overlay 'invisible)
7224 'org-hide-block))
7225 (overlays-at start)))
7226 (if (or (not force) (eq force 'off))
7227 (mapc (lambda (ov)
7228 (when (member ov org-hide-block-overlays)
7229 (setq org-hide-block-overlays
7230 (delq ov org-hide-block-overlays)))
7231 (when (eq (overlay-get ov 'invisible)
7232 'org-hide-block)
7233 (delete-overlay ov)))
7234 (overlays-at start)))
7235 (setq ov (make-overlay start end))
7236 (overlay-put ov 'invisible 'org-hide-block)
7237 ;; make the block accessible to isearch
7238 (overlay-put
7239 ov 'isearch-open-invisible
7240 (lambda (ov)
7241 (when (member ov org-hide-block-overlays)
7242 (setq org-hide-block-overlays
7243 (delq ov org-hide-block-overlays)))
7244 (when (eq (overlay-get ov 'invisible)
7245 'org-hide-block)
7246 (delete-overlay ov))))
7247 (push ov org-hide-block-overlays)))
7248 (user-error "Not looking at a source block"))))
7250 ;; org-tab-after-check-for-cycling-hook
7251 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7252 ;; Remove overlays when changing major mode
7253 (add-hook 'org-mode-hook
7254 (lambda () (org-add-hook 'change-major-mode-hook
7255 'org-show-block-all 'append 'local)))
7257 ;;; Org-goto
7259 (defvar org-goto-window-configuration nil)
7260 (defvar org-goto-marker nil)
7261 (defvar org-goto-map)
7262 (defun org-goto-map ()
7263 "Set the keymap `org-goto'."
7264 (setq org-goto-map
7265 (let ((map (make-sparse-keymap)))
7266 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7267 mouse-drag-region universal-argument org-occur))
7268 cmd)
7269 (while (setq cmd (pop cmds))
7270 (substitute-key-definition cmd cmd map global-map)))
7271 (suppress-keymap map)
7272 (org-defkey map "\C-m" 'org-goto-ret)
7273 (org-defkey map [(return)] 'org-goto-ret)
7274 (org-defkey map [(left)] 'org-goto-left)
7275 (org-defkey map [(right)] 'org-goto-right)
7276 (org-defkey map [(control ?g)] 'org-goto-quit)
7277 (org-defkey map "\C-i" 'org-cycle)
7278 (org-defkey map [(tab)] 'org-cycle)
7279 (org-defkey map [(down)] 'outline-next-visible-heading)
7280 (org-defkey map [(up)] 'outline-previous-visible-heading)
7281 (if org-goto-auto-isearch
7282 (if (fboundp 'define-key-after)
7283 (define-key-after map [t] 'org-goto-local-auto-isearch)
7284 nil)
7285 (org-defkey map "q" 'org-goto-quit)
7286 (org-defkey map "n" 'outline-next-visible-heading)
7287 (org-defkey map "p" 'outline-previous-visible-heading)
7288 (org-defkey map "f" 'outline-forward-same-level)
7289 (org-defkey map "b" 'outline-backward-same-level)
7290 (org-defkey map "u" 'outline-up-heading))
7291 (org-defkey map "/" 'org-occur)
7292 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7293 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7294 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7295 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7296 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7297 map)))
7299 (defconst org-goto-help
7300 "Browse buffer copy, to find location or copy text.%s
7301 RET=jump to location C-g=quit and return to previous location
7302 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7304 (defvar org-goto-start-pos) ; dynamically scoped parameter
7306 (defun org-goto (&optional alternative-interface)
7307 "Look up a different location in the current file, keeping current visibility.
7309 When you want look-up or go to a different location in a
7310 document, the fastest way is often to fold the entire buffer and
7311 then dive into the tree. This method has the disadvantage, that
7312 the previous location will be folded, which may not be what you
7313 want.
7315 This command works around this by showing a copy of the current
7316 buffer in an indirect buffer, in overview mode. You can dive
7317 into the tree in that copy, use org-occur and incremental search
7318 to find a location. When pressing RET or `Q', the command
7319 returns to the original buffer in which the visibility is still
7320 unchanged. After RET it will also jump to the location selected
7321 in the indirect buffer and expose the headline hierarchy above.
7323 With a prefix argument, use the alternative interface: e.g. if
7324 `org-goto-interface' is 'outline use 'outline-path-completion."
7325 (interactive "P")
7326 (org-goto-map)
7327 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7328 (org-refile-use-outline-path t)
7329 (org-refile-target-verify-function nil)
7330 (interface
7331 (if (not alternative-interface)
7332 org-goto-interface
7333 (if (eq org-goto-interface 'outline)
7334 'outline-path-completion
7335 'outline)))
7336 (org-goto-start-pos (point))
7337 (selected-point
7338 (if (eq interface 'outline)
7339 (car (org-get-location (current-buffer) org-goto-help))
7340 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7341 (org-refile-check-position pa)
7342 (nth 3 pa)))))
7343 (if selected-point
7344 (progn
7345 (org-mark-ring-push org-goto-start-pos)
7346 (goto-char selected-point)
7347 (if (or (outline-invisible-p) (org-invisible-p2))
7348 (org-show-context 'org-goto)))
7349 (message "Quit"))))
7351 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7352 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7353 (defvar org-goto-local-auto-isearch-map) ; defined below
7355 (defun org-get-location (buf help)
7356 "Let the user select a location in the Org-mode buffer BUF.
7357 This function uses a recursive edit. It returns the selected position
7358 or nil."
7359 (org-no-popups
7360 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7361 (isearch-hide-immediately nil)
7362 (isearch-search-fun-function
7363 (lambda () 'org-goto-local-search-headings))
7364 (org-goto-selected-point org-goto-exit-command))
7365 (save-excursion
7366 (save-window-excursion
7367 (delete-other-windows)
7368 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7369 (org-pop-to-buffer-same-window
7370 (condition-case nil
7371 (make-indirect-buffer (current-buffer) "*org-goto*")
7372 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7373 (with-output-to-temp-buffer "*Org Help*"
7374 (princ (format help (if org-goto-auto-isearch
7375 " Just type for auto-isearch."
7376 " n/p/f/b/u to navigate, q to quit."))))
7377 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7378 (setq buffer-read-only nil)
7379 (let ((org-startup-truncated t)
7380 (org-startup-folded nil)
7381 (org-startup-align-all-tables nil))
7382 (org-mode)
7383 (org-overview))
7384 (setq buffer-read-only t)
7385 (if (and (boundp 'org-goto-start-pos)
7386 (integer-or-marker-p org-goto-start-pos))
7387 (let ((org-show-hierarchy-above t)
7388 (org-show-siblings t)
7389 (org-show-following-heading t))
7390 (goto-char org-goto-start-pos)
7391 (and (outline-invisible-p) (org-show-context)))
7392 (goto-char (point-min)))
7393 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7394 (message "Select location and press RET")
7395 (use-local-map org-goto-map)
7396 (recursive-edit)))
7397 (kill-buffer "*org-goto*")
7398 (cons org-goto-selected-point org-goto-exit-command))))
7400 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7401 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7402 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7403 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7405 (defun org-goto-local-search-headings (string bound noerror)
7406 "Search and make sure that any matches are in headlines."
7407 (catch 'return
7408 (while (if isearch-forward
7409 (search-forward string bound noerror)
7410 (search-backward string bound noerror))
7411 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7412 (and (member :headline context)
7413 (not (member :tags context))))
7414 (throw 'return (point))))))
7416 (defun org-goto-local-auto-isearch ()
7417 "Start isearch."
7418 (interactive)
7419 (goto-char (point-min))
7420 (let ((keys (this-command-keys)))
7421 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7422 (isearch-mode t)
7423 (isearch-process-search-char (string-to-char keys)))))
7425 (defun org-goto-ret (&optional arg)
7426 "Finish `org-goto' by going to the new location."
7427 (interactive "P")
7428 (setq org-goto-selected-point (point)
7429 org-goto-exit-command 'return)
7430 (throw 'exit nil))
7432 (defun org-goto-left ()
7433 "Finish `org-goto' by going to the new location."
7434 (interactive)
7435 (if (org-at-heading-p)
7436 (progn
7437 (beginning-of-line 1)
7438 (setq org-goto-selected-point (point)
7439 org-goto-exit-command 'left)
7440 (throw 'exit nil))
7441 (user-error "Not on a heading")))
7443 (defun org-goto-right ()
7444 "Finish `org-goto' by going to the new location."
7445 (interactive)
7446 (if (org-at-heading-p)
7447 (progn
7448 (setq org-goto-selected-point (point)
7449 org-goto-exit-command 'right)
7450 (throw 'exit nil))
7451 (user-error "Not on a heading")))
7453 (defun org-goto-quit ()
7454 "Finish `org-goto' without cursor motion."
7455 (interactive)
7456 (setq org-goto-selected-point nil)
7457 (setq org-goto-exit-command 'quit)
7458 (throw 'exit nil))
7460 ;;; Indirect buffer display of subtrees
7462 (defvar org-indirect-dedicated-frame nil
7463 "This is the frame being used for indirect tree display.")
7464 (defvar org-last-indirect-buffer nil)
7466 (defun org-tree-to-indirect-buffer (&optional arg)
7467 "Create indirect buffer and narrow it to current subtree.
7468 With a numerical prefix ARG, go up to this level and then take that tree.
7469 If ARG is negative, go up that many levels.
7471 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7472 indirect buffer previously made with this command, to avoid proliferation of
7473 indirect buffers. However, when you call the command with a \
7474 \\[universal-argument] prefix, or
7475 when `org-indirect-buffer-display' is `new-frame', the last buffer
7476 is kept so that you can work with several indirect buffers at the same time.
7477 If `org-indirect-buffer-display' is `dedicated-frame', the \
7478 \\[universal-argument] prefix also
7479 requests that a new frame be made for the new buffer, so that the dedicated
7480 frame is not changed."
7481 (interactive "P")
7482 (let ((cbuf (current-buffer))
7483 (cwin (selected-window))
7484 (pos (point))
7485 beg end level heading ibuf)
7486 (save-excursion
7487 (org-back-to-heading t)
7488 (when (numberp arg)
7489 (setq level (org-outline-level))
7490 (if (< arg 0) (setq arg (+ level arg)))
7491 (while (> (setq level (org-outline-level)) arg)
7492 (org-up-heading-safe)))
7493 (setq beg (point)
7494 heading (org-get-heading))
7495 (org-end-of-subtree t t)
7496 (if (org-at-heading-p) (backward-char 1))
7497 (setq end (point)))
7498 (if (and (buffer-live-p org-last-indirect-buffer)
7499 (not (eq org-indirect-buffer-display 'new-frame))
7500 (not arg))
7501 (kill-buffer org-last-indirect-buffer))
7502 (setq ibuf (org-get-indirect-buffer cbuf)
7503 org-last-indirect-buffer ibuf)
7504 (cond
7505 ((or (eq org-indirect-buffer-display 'new-frame)
7506 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7507 (select-frame (make-frame))
7508 (delete-other-windows)
7509 (org-pop-to-buffer-same-window ibuf)
7510 (org-set-frame-title heading))
7511 ((eq org-indirect-buffer-display 'dedicated-frame)
7512 (raise-frame
7513 (select-frame (or (and org-indirect-dedicated-frame
7514 (frame-live-p org-indirect-dedicated-frame)
7515 org-indirect-dedicated-frame)
7516 (setq org-indirect-dedicated-frame (make-frame)))))
7517 (delete-other-windows)
7518 (org-pop-to-buffer-same-window ibuf)
7519 (org-set-frame-title (concat "Indirect: " heading)))
7520 ((eq org-indirect-buffer-display 'current-window)
7521 (org-pop-to-buffer-same-window ibuf))
7522 ((eq org-indirect-buffer-display 'other-window)
7523 (pop-to-buffer ibuf))
7524 (t (error "Invalid value")))
7525 (if (featurep 'xemacs)
7526 (save-excursion (org-mode) (turn-on-font-lock)))
7527 (narrow-to-region beg end)
7528 (show-all)
7529 (goto-char pos)
7530 (run-hook-with-args 'org-cycle-hook 'all)
7531 (and (window-live-p cwin) (select-window cwin))))
7533 (defun org-get-indirect-buffer (&optional buffer)
7534 (setq buffer (or buffer (current-buffer)))
7535 (let ((n 1) (base (buffer-name buffer)) bname)
7536 (while (buffer-live-p
7537 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7538 (setq n (1+ n)))
7539 (condition-case nil
7540 (make-indirect-buffer buffer bname 'clone)
7541 (error (make-indirect-buffer buffer bname)))))
7543 (defun org-set-frame-title (title)
7544 "Set the title of the current frame to the string TITLE."
7545 ;; FIXME: how to name a single frame in XEmacs???
7546 (unless (featurep 'xemacs)
7547 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7549 ;;;; Structure editing
7551 ;;; Inserting headlines
7553 (defun org-previous-line-empty-p (&optional next)
7554 "Is the previous line a blank line?
7555 When NEXT is non-nil, check the next line instead."
7556 (save-excursion
7557 (and (not (bobp))
7558 (or (beginning-of-line (if next 2 0)) t)
7559 (save-match-data
7560 (looking-at "[ \t]*$")))))
7562 (defun org-insert-heading (&optional arg invisible-ok)
7563 "Insert a new heading or an item with the same depth at point.
7565 If point is at the beginning of a heading or a list item, insert
7566 a new heading or a new item above the current one. If point is
7567 at the beginning of a normal line, turn the line into a heading.
7569 If point is in the middle of a headline or a list item, split the
7570 headline or the item and create a new headline/item with the text
7571 in the current line after point \(see `org-M-RET-may-split-line'
7572 on how to modify this behavior).
7574 With one universal prefirx argument, set the user option
7575 `org-insert-heading-respect-content' to t for the duration of
7576 the command. This modifies the behavior described above in this
7577 ways: on list items and at the beginning of normal lines, force
7578 the insertion of a heading after the current subtree.
7580 With two universal prefix arguments, insert the heading at the
7581 end of the grandparent subtree. For example, if point is within
7582 a 2nd-level heading, then it will insert a 2nd-level heading at
7583 the end of the 1st-level parent heading.
7585 When INVISIBLE-OK is set, stop at invisible headlines when going
7586 back. This is important for non-interactive uses of the
7587 command."
7588 (interactive "P")
7589 (if (org-called-interactively-p 'any) (org-reveal))
7590 (let ((itemp (org-in-item-p))
7591 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7592 (respect-content (or org-insert-heading-respect-content
7593 (equal arg '(4))))
7594 (initial-content "")
7595 (adjust-empty-lines t))
7597 (cond
7599 ((or (= (buffer-size) 0)
7600 (and (not (save-excursion
7601 (and (ignore-errors (org-back-to-heading invisible-ok))
7602 (org-at-heading-p))))
7603 (or arg (not itemp))))
7604 ;; At beginning of buffer or so high up that only a heading
7605 ;; makes sense.
7606 (cond ((and (bolp) (not respect-content)) (insert "* "))
7607 ((not respect-content)
7608 (unless may-split (end-of-line))
7609 (insert "\n* "))
7610 ((re-search-forward org-outline-regexp-bol nil t)
7611 (beginning-of-line)
7612 (insert "* \n")
7613 (backward-char))
7614 (t (goto-char (point-max))
7615 (insert "\n* ")))
7616 (run-hooks 'org-insert-heading-hook))
7618 ((and itemp (not (member arg '((4) (16)))))
7619 ;; Insert an item
7620 (org-insert-item))
7623 ;; Maybe move at the end of the subtree
7624 (when (equal arg '(16))
7625 (org-up-heading-safe)
7626 (org-end-of-subtree t))
7627 ;; Insert a heading
7628 (save-restriction
7629 (widen)
7630 (let* ((level nil)
7631 (on-heading (org-at-heading-p))
7632 (empty-line-p (if on-heading
7633 (org-previous-line-empty-p)
7634 ;; We will decide later
7635 nil))
7636 ;; Get a level string to fall back on
7637 (fix-level
7638 (if (org-before-first-heading-p) "*"
7639 (save-excursion
7640 (org-back-to-heading t)
7641 (if (org-previous-line-empty-p) (setq empty-line-p t))
7642 (looking-at org-outline-regexp)
7643 (make-string (1- (length (match-string 0))) ?*))))
7644 (stars
7645 (save-excursion
7646 (condition-case nil
7647 (progn
7648 (org-back-to-heading invisible-ok)
7649 (when (and (not on-heading)
7650 (featurep 'org-inlinetask)
7651 (integerp org-inlinetask-min-level)
7652 (>= (length (match-string 0))
7653 org-inlinetask-min-level))
7654 ;; Find a heading level before the inline task
7655 (while (and (setq level (org-up-heading-safe))
7656 (>= level org-inlinetask-min-level)))
7657 (if (org-at-heading-p)
7658 (org-back-to-heading invisible-ok)
7659 (error "This should not happen")))
7660 (unless (and (save-excursion
7661 (save-match-data
7662 (org-backward-heading-same-level
7663 1 invisible-ok))
7664 (= (point) (match-beginning 0)))
7665 (not (org-previous-line-empty-p t)))
7666 (setq empty-line-p (or empty-line-p
7667 (org-previous-line-empty-p))))
7668 (match-string 0))
7669 (error (or fix-level "* ")))))
7670 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7671 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7672 pos hide-previous previous-pos)
7674 ;; If we insert after content, move there and clean up whitespace
7675 (when (and respect-content
7676 (not (org-looking-at-p org-outline-regexp-bol)))
7677 (if (not (org-before-first-heading-p))
7678 (org-end-of-subtree nil t)
7679 (re-search-forward org-outline-regexp-bol)
7680 (beginning-of-line 0))
7681 (skip-chars-backward " \r\n")
7682 (and (not (looking-back "^\*+"))
7683 (looking-at "[ \t]+") (replace-match ""))
7684 (unless (eobp) (forward-char 1))
7685 (when (looking-at "^\\*")
7686 (unless (bobp) (backward-char 1))
7687 (insert "\n")))
7689 ;; If we are splitting, grab the text that should be moved to the new headline
7690 (when may-split
7691 (if (org-on-heading-p)
7692 ;; This is a heading, we split intelligently (keeping tags)
7693 (let ((pos (point)))
7694 (goto-char (point-at-bol))
7695 (unless (looking-at org-complex-heading-regexp)
7696 (error "This should not happen"))
7697 (when (and (match-beginning 4)
7698 (> pos (match-beginning 4))
7699 (< pos (match-end 4)))
7700 (setq initial-content (buffer-substring pos (match-end 4)))
7701 (goto-char pos)
7702 (delete-region (point) (match-end 4))
7703 (if (looking-at "[ \t]*$")
7704 (replace-match "")
7705 (insert (make-string (length initial-content) ?\ )))
7706 (setq initial-content (org-trim initial-content)))
7707 (goto-char pos))
7708 ;; a normal line
7709 (setq initial-content
7710 (org-trim (buffer-substring (point) (point-at-eol))))
7711 (delete-region (point) (point-at-eol))))
7713 ;; If we are at the beginning of the line, insert before it. Else after
7714 (cond
7715 ((and (bolp) (looking-at "[ \t]*$")))
7716 ((and (bolp) (not (looking-at "[ \t]*$")))
7717 (open-line 1))
7719 (goto-char (point-at-eol))
7720 (insert "\n")))
7722 ;; Insert the new heading
7723 (insert stars)
7724 (just-one-space)
7725 (insert initial-content)
7726 (when adjust-empty-lines
7727 (if (or (not blank)
7728 (and blank (not (org-previous-line-empty-p))))
7729 (org-N-empty-lines-before-current (if blank 1 0))))
7730 (run-hooks 'org-insert-heading-hook)))))))
7732 (defun org-N-empty-lines-before-current (N)
7733 "Make the number of empty lines before current exactly N.
7734 So this will delete or add empty lines."
7735 (save-excursion
7736 (beginning-of-line)
7737 (let ((p (point)))
7738 (skip-chars-backward " \r\t\n")
7739 (unless (bolp) (forward-line))
7740 (delete-region (point) p))
7741 (when (> N 0) (insert (make-string N ?\n)))))
7743 (defun org-get-heading (&optional no-tags no-todo)
7744 "Return the heading of the current entry, without the stars.
7745 When NO-TAGS is non-nil, don't include tags.
7746 When NO-TODO is non-nil, don't include TODO keywords."
7747 (save-excursion
7748 (org-back-to-heading t)
7749 (cond
7750 ((and no-tags no-todo)
7751 (looking-at org-complex-heading-regexp)
7752 (match-string 4))
7753 (no-tags
7754 (looking-at (concat org-outline-regexp
7755 "\\(.*?\\)"
7756 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7757 (match-string 1))
7758 (no-todo
7759 (looking-at org-todo-line-regexp)
7760 (match-string 3))
7761 (t (looking-at org-heading-regexp)
7762 (match-string 2)))))
7764 (defvar orgstruct-mode) ; defined below
7766 (defun org-heading-components ()
7767 "Return the components of the current heading.
7768 This is a list with the following elements:
7769 - the level as an integer
7770 - the reduced level, different if `org-odd-levels-only' is set.
7771 - the TODO keyword, or nil
7772 - the priority character, like ?A, or nil if no priority is given
7773 - the headline text itself, or the tags string if no headline text
7774 - the tags string, or nil."
7775 (save-excursion
7776 (org-back-to-heading t)
7777 (if (let (case-fold-search)
7778 (looking-at
7779 (if orgstruct-mode
7780 org-heading-regexp
7781 org-complex-heading-regexp)))
7782 (if orgstruct-mode
7783 (list (length (match-string 1))
7784 (org-reduced-level (length (match-string 1)))
7787 (match-string 2)
7788 nil)
7789 (list (length (match-string 1))
7790 (org-reduced-level (length (match-string 1)))
7791 (org-match-string-no-properties 2)
7792 (and (match-end 3) (aref (match-string 3) 2))
7793 (org-match-string-no-properties 4)
7794 (org-match-string-no-properties 5))))))
7796 (defun org-get-entry ()
7797 "Get the entry text, after heading, entire subtree."
7798 (save-excursion
7799 (org-back-to-heading t)
7800 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7802 (defun org-insert-heading-after-current ()
7803 "Insert a new heading with same level as current, after current subtree."
7804 (interactive)
7805 (org-back-to-heading)
7806 (org-insert-heading)
7807 (org-move-subtree-down)
7808 (end-of-line 1))
7810 (defun org-insert-heading-respect-content (&optional invisible-ok)
7811 "Insert heading with `org-insert-heading-respect-content' set to t."
7812 (interactive)
7813 (org-insert-heading '(4) invisible-ok))
7815 (defun org-insert-todo-heading-respect-content (&optional force-state)
7816 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7817 (interactive)
7818 (org-insert-todo-heading force-state '(4)))
7820 (defun org-insert-todo-heading (arg &optional force-heading)
7821 "Insert a new heading with the same level and TODO state as current heading.
7822 If the heading has no TODO state, or if the state is DONE, use the first
7823 state (TODO by default). Also with one prefix arg, force first state. With
7824 two prefix args, force inserting at the end of the parent subtree."
7825 (interactive "P")
7826 (when (or force-heading (not (org-insert-item 'checkbox)))
7827 (org-insert-heading (or (and (equal arg '(16)) '(16))
7828 force-heading))
7829 (save-excursion
7830 (org-back-to-heading)
7831 (outline-previous-heading)
7832 (looking-at org-todo-line-regexp))
7833 (let*
7834 ((new-mark-x
7835 (if (or (equal arg '(4))
7836 (not (match-beginning 2))
7837 (member (match-string 2) org-done-keywords))
7838 (car org-todo-keywords-1)
7839 (match-string 2)))
7840 (new-mark
7842 (run-hook-with-args-until-success
7843 'org-todo-get-default-hook new-mark-x nil)
7844 new-mark-x)))
7845 (beginning-of-line 1)
7846 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7847 (if org-treat-insert-todo-heading-as-state-change
7848 (org-todo new-mark)
7849 (insert new-mark " "))))
7850 (when org-provide-todo-statistics
7851 (org-update-parent-todo-statistics))))
7853 (defun org-insert-subheading (arg)
7854 "Insert a new subheading and demote it.
7855 Works for outline headings and for plain lists alike."
7856 (interactive "P")
7857 (org-insert-heading arg)
7858 (cond
7859 ((org-at-heading-p) (org-do-demote))
7860 ((org-at-item-p) (org-indent-item))))
7862 (defun org-insert-todo-subheading (arg)
7863 "Insert a new subheading with TODO keyword or checkbox and demote it.
7864 Works for outline headings and for plain lists alike."
7865 (interactive "P")
7866 (org-insert-todo-heading arg)
7867 (cond
7868 ((org-at-heading-p) (org-do-demote))
7869 ((org-at-item-p) (org-indent-item))))
7871 ;;; Promotion and Demotion
7873 (defvar org-after-demote-entry-hook nil
7874 "Hook run after an entry has been demoted.
7875 The cursor will be at the beginning of the entry.
7876 When a subtree is being demoted, the hook will be called for each node.")
7878 (defvar org-after-promote-entry-hook nil
7879 "Hook run after an entry has been promoted.
7880 The cursor will be at the beginning of the entry.
7881 When a subtree is being promoted, the hook will be called for each node.")
7883 (defun org-promote-subtree ()
7884 "Promote the entire subtree.
7885 See also `org-promote'."
7886 (interactive)
7887 (save-excursion
7888 (org-with-limited-levels (org-map-tree 'org-promote)))
7889 (org-fix-position-after-promote))
7891 (defun org-demote-subtree ()
7892 "Demote the entire subtree. See `org-demote'.
7893 See also `org-promote'."
7894 (interactive)
7895 (save-excursion
7896 (org-with-limited-levels (org-map-tree 'org-demote)))
7897 (org-fix-position-after-promote))
7900 (defun org-do-promote ()
7901 "Promote the current heading higher up the tree.
7902 If the region is active in `transient-mark-mode', promote all headings
7903 in the region."
7904 (interactive)
7905 (save-excursion
7906 (if (org-region-active-p)
7907 (org-map-region 'org-promote (region-beginning) (region-end))
7908 (org-promote)))
7909 (org-fix-position-after-promote))
7911 (defun org-do-demote ()
7912 "Demote the current heading lower down the tree.
7913 If the region is active in `transient-mark-mode', demote all headings
7914 in the region."
7915 (interactive)
7916 (save-excursion
7917 (if (org-region-active-p)
7918 (org-map-region 'org-demote (region-beginning) (region-end))
7919 (org-demote)))
7920 (org-fix-position-after-promote))
7922 (defun org-fix-position-after-promote ()
7923 "Make sure that after pro/demotion cursor position is right."
7924 (let ((pos (point)))
7925 (when (save-excursion
7926 (beginning-of-line 1)
7927 (looking-at org-todo-line-regexp)
7928 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7929 (cond ((eobp) (insert " "))
7930 ((eolp) (insert " "))
7931 ((equal (char-after) ?\ ) (forward-char 1))))))
7933 (defun org-current-level ()
7934 "Return the level of the current entry, or nil if before the first headline.
7935 The level is the number of stars at the beginning of the headline."
7936 (save-excursion
7937 (org-with-limited-levels
7938 (if (ignore-errors (org-back-to-heading t))
7939 (funcall outline-level)))))
7941 (defun org-get-previous-line-level ()
7942 "Return the outline depth of the last headline before the current line.
7943 Returns 0 for the first headline in the buffer, and nil if before the
7944 first headline."
7945 (and (org-current-level)
7946 (or (and (/= (line-beginning-position) (point-min))
7947 (save-excursion (beginning-of-line 0) (org-current-level)))
7948 0)))
7950 (defun org-reduced-level (l)
7951 "Compute the effective level of a heading.
7952 This takes into account the setting of `org-odd-levels-only'."
7953 (cond
7954 ((zerop l) 0)
7955 (org-odd-levels-only (1+ (floor (/ l 2))))
7956 (t l)))
7958 (defun org-level-increment ()
7959 "Return the number of stars that will be added or removed at a
7960 time to headlines when structure editing, based on the value of
7961 `org-odd-levels-only'."
7962 (if org-odd-levels-only 2 1))
7964 (defun org-get-valid-level (level &optional change)
7965 "Rectify a level change under the influence of `org-odd-levels-only'
7966 LEVEL is a current level, CHANGE is by how much the level should be
7967 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7968 even level numbers will become the next higher odd number."
7969 (if org-odd-levels-only
7970 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7971 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7972 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7973 (max 1 (+ level (or change 0)))))
7975 (if (boundp 'define-obsolete-function-alias)
7976 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7977 (define-obsolete-function-alias 'org-get-legal-level
7978 'org-get-valid-level)
7979 (define-obsolete-function-alias 'org-get-legal-level
7980 'org-get-valid-level "23.1")))
7982 (defun org-promote ()
7983 "Promote the current heading higher up the tree.
7984 If the region is active in `transient-mark-mode', promote all headings
7985 in the region."
7986 (org-back-to-heading t)
7987 (let* ((level (save-match-data (funcall outline-level)))
7988 (after-change-functions (remove 'flyspell-after-change-function
7989 after-change-functions))
7990 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7991 (diff (abs (- level (length up-head) -1))))
7992 (cond ((and (= level 1) org-called-with-limited-levels
7993 org-allow-promoting-top-level-subtree)
7994 (replace-match "# " nil t))
7995 ((= level 1)
7996 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7997 (t (replace-match up-head nil t)))
7998 ;; Fixup tag positioning
7999 (unless (= level 1)
8000 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8001 (if org-adapt-indentation (org-fixup-indentation (- diff))))
8002 (run-hooks 'org-after-promote-entry-hook)))
8004 (defun org-demote ()
8005 "Demote the current heading lower down the tree.
8006 If the region is active in `transient-mark-mode', demote all headings
8007 in the region."
8008 (org-back-to-heading t)
8009 (let* ((level (save-match-data (funcall outline-level)))
8010 (after-change-functions (remove 'flyspell-after-change-function
8011 after-change-functions))
8012 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8013 (diff (abs (- level (length down-head) -1))))
8014 (replace-match down-head nil t)
8015 ;; Fixup tag positioning
8016 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8017 (if org-adapt-indentation (org-fixup-indentation diff))
8018 (run-hooks 'org-after-demote-entry-hook)))
8020 (defun org-cycle-level ()
8021 "Cycle the level of an empty headline through possible states.
8022 This goes first to child, then to parent, level, then up the hierarchy.
8023 After top level, it switches back to sibling level."
8024 (interactive)
8025 (let ((org-adapt-indentation nil))
8026 (when (org-point-at-end-of-empty-headline)
8027 (setq this-command 'org-cycle-level) ; Only needed for caching
8028 (let ((cur-level (org-current-level))
8029 (prev-level (org-get-previous-line-level)))
8030 (cond
8031 ;; If first headline in file, promote to top-level.
8032 ((= prev-level 0)
8033 (loop repeat (/ (- cur-level 1) (org-level-increment))
8034 do (org-do-promote)))
8035 ;; If same level as prev, demote one.
8036 ((= prev-level cur-level)
8037 (org-do-demote))
8038 ;; If parent is top-level, promote to top level if not already.
8039 ((= prev-level 1)
8040 (loop repeat (/ (- cur-level 1) (org-level-increment))
8041 do (org-do-promote)))
8042 ;; If top-level, return to prev-level.
8043 ((= cur-level 1)
8044 (loop repeat (/ (- prev-level 1) (org-level-increment))
8045 do (org-do-demote)))
8046 ;; If less than prev-level, promote one.
8047 ((< cur-level prev-level)
8048 (org-do-promote))
8049 ;; If deeper than prev-level, promote until higher than
8050 ;; prev-level.
8051 ((> cur-level prev-level)
8052 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8053 do (org-do-promote))))
8054 t))))
8056 (defun org-map-tree (fun)
8057 "Call FUN for every heading underneath the current one."
8058 (org-back-to-heading)
8059 (let ((level (funcall outline-level)))
8060 (save-excursion
8061 (funcall fun)
8062 (while (and (progn
8063 (outline-next-heading)
8064 (> (funcall outline-level) level))
8065 (not (eobp)))
8066 (funcall fun)))))
8068 (defun org-map-region (fun beg end)
8069 "Call FUN for every heading between BEG and END."
8070 (let ((org-ignore-region t))
8071 (save-excursion
8072 (setq end (copy-marker end))
8073 (goto-char beg)
8074 (if (and (re-search-forward org-outline-regexp-bol nil t)
8075 (< (point) end))
8076 (funcall fun))
8077 (while (and (progn
8078 (outline-next-heading)
8079 (< (point) end))
8080 (not (eobp)))
8081 (funcall fun)))))
8083 (defvar org-property-end-re) ; silence byte-compiler
8084 (defun org-fixup-indentation (diff)
8085 "Change the indentation in the current entry by DIFF.
8086 However, if any line in the current entry has no indentation, or if it
8087 would end up with no indentation after the change, nothing at all is done."
8088 (save-excursion
8089 (let ((end (save-excursion (outline-next-heading)
8090 (point-marker)))
8091 (prohibit (if (> diff 0)
8092 "^\\S-"
8093 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8094 col)
8095 (unless (save-excursion (end-of-line 1)
8096 (re-search-forward prohibit end t))
8097 (while (and (< (point) end)
8098 (re-search-forward "^[ \t]+" end t))
8099 (goto-char (match-end 0))
8100 (setq col (current-column))
8101 (if (< diff 0) (replace-match ""))
8102 (org-indent-to-column (+ diff col))))
8103 (move-marker end nil))))
8105 (defun org-convert-to-odd-levels ()
8106 "Convert an org-mode file with all levels allowed to one with odd levels.
8107 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8108 level 5 etc."
8109 (interactive)
8110 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8111 (let ((outline-level 'org-outline-level)
8112 (org-odd-levels-only nil) n)
8113 (save-excursion
8114 (goto-char (point-min))
8115 (while (re-search-forward "^\\*\\*+ " nil t)
8116 (setq n (- (length (match-string 0)) 2))
8117 (while (>= (setq n (1- n)) 0)
8118 (org-demote))
8119 (end-of-line 1))))))
8121 (defun org-convert-to-oddeven-levels ()
8122 "Convert an org-mode file with only odd levels to one with odd/even levels.
8123 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8124 file contains a section with an even level, conversion would
8125 destroy the structure of the file. An error is signaled in this
8126 case."
8127 (interactive)
8128 (goto-char (point-min))
8129 ;; First check if there are no even levels
8130 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8131 (org-show-context t)
8132 (error "Not all levels are odd in this file. Conversion not possible"))
8133 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8134 (let ((outline-regexp org-outline-regexp)
8135 (outline-level 'org-outline-level)
8136 (org-odd-levels-only nil) n)
8137 (save-excursion
8138 (goto-char (point-min))
8139 (while (re-search-forward "^\\*\\*+ " nil t)
8140 (setq n (/ (1- (length (match-string 0))) 2))
8141 (while (>= (setq n (1- n)) 0)
8142 (org-promote))
8143 (end-of-line 1))))))
8145 (defun org-tr-level (n)
8146 "Make N odd if required."
8147 (if org-odd-levels-only (1+ (/ n 2)) n))
8149 ;;; Vertical tree motion, cutting and pasting of subtrees
8151 (defun org-move-subtree-up (&optional arg)
8152 "Move the current subtree up past ARG headlines of the same level."
8153 (interactive "p")
8154 (org-move-subtree-down (- (prefix-numeric-value arg))))
8156 (defun org-move-subtree-down (&optional arg)
8157 "Move the current subtree down past ARG headlines of the same level."
8158 (interactive "p")
8159 (setq arg (prefix-numeric-value arg))
8160 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8161 'org-get-last-sibling))
8162 (ins-point (make-marker))
8163 (cnt (abs arg))
8164 (col (current-column))
8165 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8166 ;; Select the tree
8167 (org-back-to-heading)
8168 (setq beg0 (point))
8169 (save-excursion
8170 (setq ne-beg (org-back-over-empty-lines))
8171 (setq beg (point)))
8172 (save-match-data
8173 (save-excursion (outline-end-of-heading)
8174 (setq folded (outline-invisible-p)))
8175 (progn (org-end-of-subtree nil t)
8176 (unless (eobp) (backward-char))))
8177 (outline-next-heading)
8178 (setq ne-end (org-back-over-empty-lines))
8179 (setq end (point))
8180 (goto-char beg0)
8181 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8182 ;; include less whitespace
8183 (save-excursion
8184 (goto-char beg)
8185 (forward-line (- ne-beg ne-end))
8186 (setq beg (point))))
8187 ;; Find insertion point, with error handling
8188 (while (> cnt 0)
8189 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8190 (progn (goto-char beg0)
8191 (user-error "Cannot move past superior level or buffer limit")))
8192 (setq cnt (1- cnt)))
8193 (if (> arg 0)
8194 ;; Moving forward - still need to move over subtree
8195 (progn (org-end-of-subtree t t)
8196 (save-excursion
8197 (org-back-over-empty-lines)
8198 (or (bolp) (newline)))))
8199 (setq ne-ins (org-back-over-empty-lines))
8200 (move-marker ins-point (point))
8201 (setq txt (buffer-substring beg end))
8202 (org-save-markers-in-region beg end)
8203 (delete-region beg end)
8204 (org-remove-empty-overlays-at beg)
8205 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8206 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8207 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8208 (let ((bbb (point)))
8209 (insert-before-markers txt)
8210 (org-reinstall-markers-in-region bbb)
8211 (move-marker ins-point bbb))
8212 (or (bolp) (insert "\n"))
8213 (setq ins-end (point))
8214 (goto-char ins-point)
8215 (org-skip-whitespace)
8216 (when (and (< arg 0)
8217 (org-first-sibling-p)
8218 (> ne-ins ne-beg))
8219 ;; Move whitespace back to beginning
8220 (save-excursion
8221 (goto-char ins-end)
8222 (let ((kill-whole-line t))
8223 (kill-line (- ne-ins ne-beg)) (point)))
8224 (insert (make-string (- ne-ins ne-beg) ?\n)))
8225 (move-marker ins-point nil)
8226 (if folded
8227 (hide-subtree)
8228 (org-show-entry)
8229 (show-children)
8230 (org-cycle-hide-drawers 'children))
8231 (org-clean-visibility-after-subtree-move)
8232 ;; move back to the initial column we were at
8233 (move-to-column col)))
8235 (defvar org-subtree-clip ""
8236 "Clipboard for cut and paste of subtrees.
8237 This is actually only a copy of the kill, because we use the normal kill
8238 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8240 (defvar org-subtree-clip-folded nil
8241 "Was the last copied subtree folded?
8242 This is used to fold the tree back after pasting.")
8244 (defun org-cut-subtree (&optional n)
8245 "Cut the current subtree into the clipboard.
8246 With prefix arg N, cut this many sequential subtrees.
8247 This is a short-hand for marking the subtree and then cutting it."
8248 (interactive "p")
8249 (org-copy-subtree n 'cut))
8251 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8252 "Copy the current subtree it in the clipboard.
8253 With prefix arg N, copy this many sequential subtrees.
8254 This is a short-hand for marking the subtree and then copying it.
8255 If CUT is non-nil, actually cut the subtree.
8256 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8257 of some markers in the region, even if CUT is non-nil. This is
8258 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8259 (interactive "p")
8260 (let (beg end folded (beg0 (point)))
8261 (if (org-called-interactively-p 'any)
8262 (org-back-to-heading nil) ; take what looks like a subtree
8263 (org-back-to-heading t)) ; take what is really there
8264 (setq beg (point))
8265 (skip-chars-forward " \t\r\n")
8266 (save-match-data
8267 (if nosubtrees
8268 (outline-next-heading)
8269 (save-excursion (outline-end-of-heading)
8270 (setq folded (outline-invisible-p)))
8271 (condition-case nil
8272 (org-forward-heading-same-level (1- n) t)
8273 (error nil))
8274 (org-end-of-subtree t t)))
8275 (setq end (point))
8276 (goto-char beg0)
8277 (when (> end beg)
8278 (setq org-subtree-clip-folded folded)
8279 (when (or cut force-store-markers)
8280 (org-save-markers-in-region beg end))
8281 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8282 (setq org-subtree-clip (current-kill 0))
8283 (message "%s: Subtree(s) with %d characters"
8284 (if cut "Cut" "Copied")
8285 (length org-subtree-clip)))))
8287 (defun org-paste-subtree (&optional level tree for-yank)
8288 "Paste the clipboard as a subtree, with modification of headline level.
8289 The entire subtree is promoted or demoted in order to match a new headline
8290 level.
8292 If the cursor is at the beginning of a headline, the same level as
8293 that headline is used to paste the tree.
8295 If not, the new level is derived from the *visible* headings
8296 before and after the insertion point, and taken to be the inferior headline
8297 level of the two. So if the previous visible heading is level 3 and the
8298 next is level 4 (or vice versa), level 4 will be used for insertion.
8299 This makes sure that the subtree remains an independent subtree and does
8300 not swallow low level entries.
8302 You can also force a different level, either by using a numeric prefix
8303 argument, or by inserting the heading marker by hand. For example, if the
8304 cursor is after \"*****\", then the tree will be shifted to level 5.
8306 If optional TREE is given, use this text instead of the kill ring.
8308 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8309 move back over whitespace before inserting, and move point to the end of
8310 the inserted text when done."
8311 (interactive "P")
8312 (setq tree (or tree (and kill-ring (current-kill 0))))
8313 (unless (org-kill-is-subtree-p tree)
8314 (user-error "%s"
8315 (substitute-command-keys
8316 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8317 (org-with-limited-levels
8318 (let* ((visp (not (outline-invisible-p)))
8319 (txt tree)
8320 (^re_ "\\(\\*+\\)[ \t]*")
8321 (old-level (if (string-match org-outline-regexp-bol txt)
8322 (- (match-end 0) (match-beginning 0) 1)
8323 -1))
8324 (force-level (cond (level (prefix-numeric-value level))
8325 ((and (looking-at "[ \t]*$")
8326 (string-match
8327 "^\\*+$" (buffer-substring
8328 (point-at-bol) (point))))
8329 (- (match-end 0) (match-beginning 0)))
8330 ((and (bolp)
8331 (looking-at org-outline-regexp))
8332 (- (match-end 0) (point) 1))))
8333 (previous-level (save-excursion
8334 (condition-case nil
8335 (progn
8336 (outline-previous-visible-heading 1)
8337 (if (looking-at ^re_)
8338 (- (match-end 0) (match-beginning 0) 1)
8340 (error 1))))
8341 (next-level (save-excursion
8342 (condition-case nil
8343 (progn
8344 (or (looking-at org-outline-regexp)
8345 (outline-next-visible-heading 1))
8346 (if (looking-at ^re_)
8347 (- (match-end 0) (match-beginning 0) 1)
8349 (error 1))))
8350 (new-level (or force-level (max previous-level next-level)))
8351 (shift (if (or (= old-level -1)
8352 (= new-level -1)
8353 (= old-level new-level))
8355 (- new-level old-level)))
8356 (delta (if (> shift 0) -1 1))
8357 (func (if (> shift 0) 'org-demote 'org-promote))
8358 (org-odd-levels-only nil)
8359 beg end newend)
8360 ;; Remove the forced level indicator
8361 (if force-level
8362 (delete-region (point-at-bol) (point)))
8363 ;; Paste
8364 (beginning-of-line (if (bolp) 1 2))
8365 (setq beg (point))
8366 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8367 (insert-before-markers txt)
8368 (unless (string-match "\n\\'" txt) (insert "\n"))
8369 (setq newend (point))
8370 (org-reinstall-markers-in-region beg)
8371 (setq end (point))
8372 (goto-char beg)
8373 (skip-chars-forward " \t\n\r")
8374 (setq beg (point))
8375 (if (and (outline-invisible-p) visp)
8376 (save-excursion (outline-show-heading)))
8377 ;; Shift if necessary
8378 (unless (= shift 0)
8379 (save-restriction
8380 (narrow-to-region beg end)
8381 (while (not (= shift 0))
8382 (org-map-region func (point-min) (point-max))
8383 (setq shift (+ delta shift)))
8384 (goto-char (point-min))
8385 (setq newend (point-max))))
8386 (when (or (org-called-interactively-p 'interactive) for-yank)
8387 (message "Clipboard pasted as level %d subtree" new-level))
8388 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8389 kill-ring
8390 (eq org-subtree-clip (current-kill 0))
8391 org-subtree-clip-folded)
8392 ;; The tree was folded before it was killed/copied
8393 (hide-subtree))
8394 (and for-yank (goto-char newend)))))
8396 (defun org-kill-is-subtree-p (&optional txt)
8397 "Check if the current kill is an outline subtree, or a set of trees.
8398 Returns nil if kill does not start with a headline, or if the first
8399 headline level is not the largest headline level in the tree.
8400 So this will actually accept several entries of equal levels as well,
8401 which is OK for `org-paste-subtree'.
8402 If optional TXT is given, check this string instead of the current kill."
8403 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8404 (re (org-get-limited-outline-regexp))
8405 (^re (concat "^" re))
8406 (start-level (and kill
8407 (string-match
8408 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8409 kill)
8410 (- (match-end 2) (match-beginning 2) 1)))
8411 (start (1+ (or (match-beginning 2) -1))))
8412 (if (not start-level)
8413 (progn
8414 nil) ;; does not even start with a heading
8415 (catch 'exit
8416 (while (setq start (string-match ^re kill (1+ start)))
8417 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8418 (throw 'exit nil)))
8419 t))))
8421 (defvar org-markers-to-move nil
8422 "Markers that should be moved with a cut-and-paste operation.
8423 Those markers are stored together with their positions relative to
8424 the start of the region.")
8426 (defun org-save-markers-in-region (beg end)
8427 "Check markers in region.
8428 If these markers are between BEG and END, record their position relative
8429 to BEG, so that after moving the block of text, we can put the markers back
8430 into place.
8431 This function gets called just before an entry or tree gets cut from the
8432 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8433 called immediately, to move the markers with the entries."
8434 (setq org-markers-to-move nil)
8435 (when (featurep 'org-clock)
8436 (org-clock-save-markers-for-cut-and-paste beg end))
8437 (when (featurep 'org-agenda)
8438 (org-agenda-save-markers-for-cut-and-paste beg end)))
8440 (defun org-check-and-save-marker (marker beg end)
8441 "Check if MARKER is between BEG and END.
8442 If yes, remember the marker and the distance to BEG."
8443 (when (and (marker-buffer marker)
8444 (equal (marker-buffer marker) (current-buffer)))
8445 (if (and (>= marker beg) (< marker end))
8446 (push (cons marker (- marker beg)) org-markers-to-move))))
8448 (defun org-reinstall-markers-in-region (beg)
8449 "Move all remembered markers to their position relative to BEG."
8450 (mapc (lambda (x)
8451 (move-marker (car x) (+ beg (cdr x))))
8452 org-markers-to-move)
8453 (setq org-markers-to-move nil))
8455 (defun org-narrow-to-subtree ()
8456 "Narrow buffer to the current subtree."
8457 (interactive)
8458 (save-excursion
8459 (save-match-data
8460 (org-with-limited-levels
8461 (narrow-to-region
8462 (progn (org-back-to-heading t) (point))
8463 (progn (org-end-of-subtree t t)
8464 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8465 (point)))))))
8467 (defun org-narrow-to-block ()
8468 "Narrow buffer to the current block."
8469 (interactive)
8470 (let* ((case-fold-search t)
8471 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8472 "^[ \t]*#\\+end_.*")))
8473 (if blockp
8474 (narrow-to-region (car blockp) (cdr blockp))
8475 (user-error "Not in a block"))))
8477 (eval-when-compile
8478 (defvar org-property-drawer-re))
8480 (defvar org-property-start-re) ;; defined below
8481 (defun org-clone-subtree-with-time-shift (n &optional shift)
8482 "Clone the task (subtree) at point N times.
8483 The clones will be inserted as siblings.
8485 In interactive use, the user will be prompted for the number of
8486 clones to be produced. If the entry has a timestamp, the user
8487 will also be prompted for a time shift, which may be a repeater
8488 as used in time stamps, for example `+3d'. To disable this,
8489 you can call the function with a universal prefix argument.
8491 When a valid repeater is given and the entry contains any time
8492 stamps, the clones will become a sequence in time, with time
8493 stamps in the subtree shifted for each clone produced. If SHIFT
8494 is nil or the empty string, time stamps will be left alone. The
8495 ID property of the original subtree is removed.
8497 If the original subtree did contain time stamps with a repeater,
8498 the following will happen:
8499 - the repeater will be removed in each clone
8500 - an additional clone will be produced, with the current, unshifted
8501 date(s) in the entry.
8502 - the original entry will be placed *after* all the clones, with
8503 repeater intact.
8504 - the start days in the repeater in the original entry will be shifted
8505 to past the last clone.
8506 In this way you can spell out a number of instances of a repeating task,
8507 and still retain the repeater to cover future instances of the task."
8508 (interactive "nNumber of clones to produce: ")
8509 (let ((shift
8510 (or shift
8511 (if (and (not (equal current-prefix-arg '(4)))
8512 (save-excursion
8513 (re-search-forward org-ts-regexp-both
8514 (save-excursion
8515 (org-end-of-subtree t)
8516 (point)) t)))
8517 (read-from-minibuffer
8518 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8519 ""))) ;; No time shift
8520 (n-no-remove -1)
8521 (drawer-re org-drawer-regexp)
8522 beg end template task idprop
8523 shift-n shift-what doshift nmin nmax)
8524 (if (not (and (integerp n) (> n 0)))
8525 (error "Invalid number of replications %s" n))
8526 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8527 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8528 shift)))
8529 (error "Invalid shift specification %s" shift))
8530 (when doshift
8531 (setq shift-n (string-to-number (match-string 1 shift))
8532 shift-what (cdr (assoc (match-string 2 shift)
8533 '(("d" . day) ("w" . week)
8534 ("m" . month) ("y" . year))))))
8535 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8536 (setq nmin 1 nmax n)
8537 (org-back-to-heading t)
8538 (setq beg (point))
8539 (setq idprop (org-entry-get nil "ID"))
8540 (org-end-of-subtree t t)
8541 (or (bolp) (insert "\n"))
8542 (setq end (point))
8543 (setq template (buffer-substring beg end))
8544 (when (and doshift
8545 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8546 (delete-region beg end)
8547 (setq end beg)
8548 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8549 (goto-char end)
8550 (loop for n from nmin to nmax do
8551 ;; prepare clone
8552 (with-temp-buffer
8553 (insert template)
8554 (org-mode)
8555 (goto-char (point-min))
8556 (org-show-subtree)
8557 (and idprop (if org-clone-delete-id
8558 (org-entry-delete nil "ID")
8559 (org-id-get-create t)))
8560 (unless (= n 0)
8561 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8562 (kill-whole-line))
8563 (goto-char (point-min))
8564 (while (re-search-forward drawer-re nil t)
8565 (mapc (lambda (d)
8566 (org-remove-empty-drawer-at d (point))) org-drawers)))
8567 (goto-char (point-min))
8568 (when doshift
8569 (while (re-search-forward org-ts-regexp-both nil t)
8570 (org-timestamp-change (* n shift-n) shift-what))
8571 (unless (= n n-no-remove)
8572 (goto-char (point-min))
8573 (while (re-search-forward org-ts-regexp nil t)
8574 (save-excursion
8575 (goto-char (match-beginning 0))
8576 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8577 (delete-region (match-beginning 1) (match-end 1)))))))
8578 (setq task (buffer-string)))
8579 (insert task))
8580 (goto-char beg)))
8582 ;;; Outline Sorting
8584 (defun org-sort (with-case)
8585 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8586 Optional argument WITH-CASE means sort case-sensitively."
8587 (interactive "P")
8588 (cond
8589 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8590 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8592 (org-call-with-arg 'org-sort-entries with-case))))
8594 (defun org-sort-remove-invisible (s)
8595 "Remove invisible links from string S."
8596 (remove-text-properties 0 (length s) org-rm-props s)
8597 (while (string-match org-bracket-link-regexp s)
8598 (setq s (replace-match (if (match-end 2)
8599 (match-string 3 s)
8600 (match-string 1 s)) t t s)))
8601 (let ((st (format " %s " s)))
8602 (while (string-match org-emph-re st)
8603 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8604 (setq s (substring st 1 -1)))
8607 (defvar org-priority-regexp) ; defined later in the file
8609 (defvar org-after-sorting-entries-or-items-hook nil
8610 "Hook that is run after a bunch of entries or items have been sorted.
8611 When children are sorted, the cursor is in the parent line when this
8612 hook gets called. When a region or a plain list is sorted, the cursor
8613 will be in the first entry of the sorted region/list.")
8615 (defun org-sort-entries
8616 (&optional with-case sorting-type getkey-func compare-func property)
8617 "Sort entries on a certain level of an outline tree.
8618 If there is an active region, the entries in the region are sorted.
8619 Else, if the cursor is before the first entry, sort the top-level items.
8620 Else, the children of the entry at point are sorted.
8622 Sorting can be alphabetically, numerically, by date/time as given by
8623 a time stamp, by a property, by priority order, or by a custom function.
8625 The command prompts for the sorting type unless it has been given to the
8626 function through the SORTING-TYPE argument, which needs to be a character,
8627 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8628 precise meaning of each character:
8630 n Numerically, by converting the beginning of the entry/item to a number.
8631 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8632 o By order of TODO keywords.
8633 t By date/time, either the first active time stamp in the entry, or, if
8634 none exist, by the first inactive one.
8635 s By the scheduled date/time.
8636 d By deadline date/time.
8637 c By creation time, which is assumed to be the first inactive time stamp
8638 at the beginning of a line.
8639 p By priority according to the cookie.
8640 r By the value of a property.
8642 Capital letters will reverse the sort order.
8644 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8645 called with point at the beginning of the record. It must return either
8646 a string or a number that should serve as the sorting key for that record.
8648 Comparing entries ignores case by default. However, with an optional argument
8649 WITH-CASE, the sorting considers case as well.
8651 Sorting is done against the visible part of the headlines, it ignores hidden
8652 links."
8653 (interactive "P")
8654 (let ((case-func (if with-case 'identity 'downcase))
8655 (cmstr
8656 ;; The clock marker is lost when using `sort-subr', let's
8657 ;; store the clocking string.
8658 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8659 (save-excursion
8660 (goto-char org-clock-marker)
8661 (looking-back "^.*") (match-string-no-properties 0))))
8662 start beg end stars re re2
8663 txt what tmp)
8664 ;; Find beginning and end of region to sort
8665 (cond
8666 ((org-region-active-p)
8667 ;; we will sort the region
8668 (setq end (region-end)
8669 what "region")
8670 (goto-char (region-beginning))
8671 (if (not (org-at-heading-p)) (outline-next-heading))
8672 (setq start (point)))
8673 ((or (org-at-heading-p)
8674 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8675 ;; we will sort the children of the current headline
8676 (org-back-to-heading)
8677 (setq start (point)
8678 end (progn (org-end-of-subtree t t)
8679 (or (bolp) (insert "\n"))
8680 (when (>= (org-back-over-empty-lines) 1)
8681 (forward-line 1))
8682 (point))
8683 what "children")
8684 (goto-char start)
8685 (show-subtree)
8686 (outline-next-heading))
8688 ;; we will sort the top-level entries in this file
8689 (goto-char (point-min))
8690 (or (org-at-heading-p) (outline-next-heading))
8691 (setq start (point))
8692 (goto-char (point-max))
8693 (beginning-of-line 1)
8694 (when (looking-at ".*?\\S-")
8695 ;; File ends in a non-white line
8696 (end-of-line 1)
8697 (insert "\n"))
8698 (setq end (point-max))
8699 (setq what "top-level")
8700 (goto-char start)
8701 (show-all)))
8703 (setq beg (point))
8704 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8706 (looking-at "\\(\\*+\\)")
8707 (setq stars (match-string 1)
8708 re (concat "^" (regexp-quote stars) " +")
8709 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8710 txt (buffer-substring beg end))
8711 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8712 (if (and (not (equal stars "*")) (string-match re2 txt))
8713 (user-error "Region to sort contains a level above the first entry"))
8715 (unless sorting-type
8716 (message
8717 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8718 [t]ime [s]cheduled [d]eadline [c]reated
8719 A/N/P/R/O/F/T/S/D/C means reversed:"
8720 what)
8721 (setq sorting-type (read-char-exclusive))
8723 (unless getkey-func
8724 (and (= (downcase sorting-type) ?f)
8725 (setq getkey-func
8726 (org-icompleting-read "Sort using function: "
8727 obarray 'fboundp t nil nil))
8728 (setq getkey-func (intern getkey-func))))
8730 (and (= (downcase sorting-type) ?r)
8731 (not property)
8732 (setq property
8733 (org-icompleting-read "Property: "
8734 (mapcar 'list (org-buffer-property-keys t))
8735 nil t))))
8737 (message "Sorting entries...")
8739 (save-restriction
8740 (narrow-to-region start end)
8741 (let ((dcst (downcase sorting-type))
8742 (case-fold-search nil)
8743 (now (current-time)))
8744 (sort-subr
8745 (/= dcst sorting-type)
8746 ;; This function moves to the beginning character of the "record" to
8747 ;; be sorted.
8748 (lambda nil
8749 (if (re-search-forward re nil t)
8750 (goto-char (match-beginning 0))
8751 (goto-char (point-max))))
8752 ;; This function moves to the last character of the "record" being
8753 ;; sorted.
8754 (lambda nil
8755 (save-match-data
8756 (condition-case nil
8757 (outline-forward-same-level 1)
8758 (error
8759 (goto-char (point-max))))))
8760 ;; This function returns the value that gets sorted against.
8761 (lambda nil
8762 (cond
8763 ((= dcst ?n)
8764 (if (looking-at org-complex-heading-regexp)
8765 (string-to-number (org-sort-remove-invisible (match-string 4)))
8766 nil))
8767 ((= dcst ?a)
8768 (if (looking-at org-complex-heading-regexp)
8769 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8770 nil))
8771 ((= dcst ?t)
8772 (let ((end (save-excursion (outline-next-heading) (point))))
8773 (if (or (re-search-forward org-ts-regexp end t)
8774 (re-search-forward org-ts-regexp-both end t))
8775 (org-time-string-to-seconds (match-string 0))
8776 (org-float-time now))))
8777 ((= dcst ?c)
8778 (let ((end (save-excursion (outline-next-heading) (point))))
8779 (if (re-search-forward
8780 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8781 end t)
8782 (org-time-string-to-seconds (match-string 0))
8783 (org-float-time now))))
8784 ((= dcst ?s)
8785 (let ((end (save-excursion (outline-next-heading) (point))))
8786 (if (re-search-forward org-scheduled-time-regexp end t)
8787 (org-time-string-to-seconds (match-string 1))
8788 (org-float-time now))))
8789 ((= dcst ?d)
8790 (let ((end (save-excursion (outline-next-heading) (point))))
8791 (if (re-search-forward org-deadline-time-regexp end t)
8792 (org-time-string-to-seconds (match-string 1))
8793 (org-float-time now))))
8794 ((= dcst ?p)
8795 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8796 (string-to-char (match-string 2))
8797 org-default-priority))
8798 ((= dcst ?r)
8799 (or (org-entry-get nil property) ""))
8800 ((= dcst ?o)
8801 (if (looking-at org-complex-heading-regexp)
8802 (- 9999 (length (member (match-string 2)
8803 org-todo-keywords-1)))))
8804 ((= dcst ?f)
8805 (if getkey-func
8806 (progn
8807 (setq tmp (funcall getkey-func))
8808 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8809 tmp)
8810 (error "Invalid key function `%s'" getkey-func)))
8811 (t (error "Invalid sorting type `%c'" sorting-type))))
8813 (cond
8814 ((= dcst ?a) 'string<)
8815 ((= dcst ?f) compare-func)
8816 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8817 (run-hooks 'org-after-sorting-entries-or-items-hook)
8818 ;; Reset the clock marker if needed
8819 (when cmstr
8820 (save-excursion
8821 (goto-char start)
8822 (search-forward cmstr nil t)
8823 (move-marker org-clock-marker (point))))
8824 (message "Sorting entries...done")))
8826 (defun org-do-sort (table what &optional with-case sorting-type)
8827 "Sort TABLE of WHAT according to SORTING-TYPE.
8828 The user will be prompted for the SORTING-TYPE if the call to this
8829 function does not specify it. WHAT is only for the prompt, to indicate
8830 what is being sorted. The sorting key will be extracted from
8831 the car of the elements of the table.
8832 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8833 (unless sorting-type
8834 (message
8835 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8836 what)
8837 (setq sorting-type (read-char-exclusive)))
8838 (let ((dcst (downcase sorting-type))
8839 extractfun comparefun)
8840 ;; Define the appropriate functions
8841 (cond
8842 ((= dcst ?n)
8843 (setq extractfun 'string-to-number
8844 comparefun (if (= dcst sorting-type) '< '>)))
8845 ((= dcst ?a)
8846 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8847 (lambda(x) (downcase (org-sort-remove-invisible x))))
8848 comparefun (if (= dcst sorting-type)
8849 'string<
8850 (lambda (a b) (and (not (string< a b))
8851 (not (string= a b)))))))
8852 ((= dcst ?t)
8853 (setq extractfun
8854 (lambda (x)
8855 (if (or (string-match org-ts-regexp x)
8856 (string-match org-ts-regexp-both x))
8857 (org-float-time
8858 (org-time-string-to-time (match-string 0 x)))
8860 comparefun (if (= dcst sorting-type) '< '>)))
8861 (t (error "Invalid sorting type `%c'" sorting-type)))
8863 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8864 table)
8865 (lambda (a b) (funcall comparefun (car a) (car b))))))
8868 ;;; The orgstruct minor mode
8870 ;; Define a minor mode which can be used in other modes in order to
8871 ;; integrate the org-mode structure editing commands.
8873 ;; This is really a hack, because the org-mode structure commands use
8874 ;; keys which normally belong to the major mode. Here is how it
8875 ;; works: The minor mode defines all the keys necessary to operate the
8876 ;; structure commands, but wraps the commands into a function which
8877 ;; tests if the cursor is currently at a headline or a plain list
8878 ;; item. If that is the case, the structure command is used,
8879 ;; temporarily setting many Org-mode variables like regular
8880 ;; expressions for filling etc. However, when any of those keys is
8881 ;; used at a different location, function uses `key-binding' to look
8882 ;; up if the key has an associated command in another currently active
8883 ;; keymap (minor modes, major mode, global), and executes that
8884 ;; command. There might be problems if any of the keys is otherwise
8885 ;; used as a prefix key.
8887 (defcustom orgstruct-heading-prefix-regexp ""
8888 "Regexp that matches the custom prefix of Org headlines in
8889 orgstruct(++)-mode."
8890 :group 'org
8891 :version "24.4"
8892 :package-version '(Org . "8.3")
8893 :type 'regexp)
8894 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8896 (defcustom orgstruct-setup-hook nil
8897 "Hook run after orgstruct-mode-map is filled."
8898 :group 'org
8899 :version "24.4"
8900 :package-version '(Org . "8.0")
8901 :type 'hook)
8903 (defvar orgstruct-initialized nil)
8905 (defvar org-local-vars nil
8906 "List of local variables, for use by `orgstruct-mode'.")
8908 ;;;###autoload
8909 (define-minor-mode orgstruct-mode
8910 "Toggle the minor mode `orgstruct-mode'.
8911 This mode is for using Org-mode structure commands in other
8912 modes. The following keys behave as if Org-mode were active, if
8913 the cursor is on a headline, or on a plain list item (both as
8914 defined by Org-mode)."
8915 nil " OrgStruct" (make-sparse-keymap)
8916 (funcall (if orgstruct-mode
8917 'add-to-invisibility-spec
8918 'remove-from-invisibility-spec)
8919 '(outline . t))
8920 (when orgstruct-mode
8921 (org-load-modules-maybe)
8922 (unless orgstruct-initialized
8923 (orgstruct-setup)
8924 (setq orgstruct-initialized t))))
8926 ;;;###autoload
8927 (defun turn-on-orgstruct ()
8928 "Unconditionally turn on `orgstruct-mode'."
8929 (orgstruct-mode 1))
8931 (defvar org-fb-vars nil)
8932 (make-variable-buffer-local 'org-fb-vars)
8933 (defun orgstruct++-mode (&optional arg)
8934 "Toggle `orgstruct-mode', the enhanced version of it.
8935 In addition to setting orgstruct-mode, this also exports all
8936 indentation and autofilling variables from org-mode into the
8937 buffer. It will also recognize item context in multiline items."
8938 (interactive "P")
8939 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8940 (if (< arg 1)
8941 (progn (orgstruct-mode -1)
8942 (mapc (lambda(v)
8943 (org-set-local (car v)
8944 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8945 org-fb-vars))
8946 (orgstruct-mode 1)
8947 (setq org-fb-vars nil)
8948 (unless org-local-vars
8949 (setq org-local-vars (org-get-local-variables)))
8950 (let (var val)
8951 (mapc
8952 (lambda (x)
8953 (when (string-match
8954 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8955 (symbol-name (car x)))
8956 (setq var (car x) val (nth 1 x))
8957 (push (list var `(quote ,(eval var))) org-fb-vars)
8958 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8959 org-local-vars)
8960 (org-set-local 'orgstruct-is-++ t))))
8962 (defvar orgstruct-is-++ nil
8963 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8964 (make-variable-buffer-local 'orgstruct-is-++)
8966 ;;;###autoload
8967 (defun turn-on-orgstruct++ ()
8968 "Unconditionally turn on `orgstruct++-mode'."
8969 (orgstruct++-mode 1))
8971 (defun orgstruct-error ()
8972 "Error when there is no default binding for a structure key."
8973 (interactive)
8974 (funcall (if (fboundp 'user-error)
8975 'user-error
8976 'error)
8977 "This key has no function outside structure elements"))
8979 (defun orgstruct-setup ()
8980 "Setup orgstruct keymap."
8981 (dolist (cell '((org-demote . t)
8982 (org-metaleft . t)
8983 (org-metaright . t)
8984 (org-promote . t)
8985 (org-shiftmetaleft . t)
8986 (org-shiftmetaright . t)
8987 org-backward-element
8988 org-backward-heading-same-level
8989 org-ctrl-c-ret
8990 org-ctrl-c-minus
8991 org-ctrl-c-star
8992 org-cycle
8993 org-forward-heading-same-level
8994 org-insert-heading
8995 org-insert-heading-respect-content
8996 org-kill-note-or-show-branches
8997 org-mark-subtree
8998 org-meta-return
8999 org-metadown
9000 org-metaup
9001 org-narrow-to-subtree
9002 org-promote-subtree
9003 org-reveal
9004 org-shiftdown
9005 org-shiftleft
9006 org-shiftmetadown
9007 org-shiftmetaup
9008 org-shiftright
9009 org-shifttab
9010 org-shifttab
9011 org-shiftup
9012 org-show-subtree
9013 org-sort
9014 org-up-element
9015 outline-demote
9016 outline-next-visible-heading
9017 outline-previous-visible-heading
9018 outline-promote
9019 outline-up-heading
9020 show-children))
9021 (let ((f (or (car-safe cell) cell))
9022 (disable-when-heading-prefix (cdr-safe cell)))
9023 (when (fboundp f)
9024 (let ((new-bindings))
9025 (dolist (binding (nconc (where-is-internal f org-mode-map)
9026 (where-is-internal f outline-mode-map)))
9027 (push binding new-bindings)
9028 ;; TODO use local-function-key-map
9029 (dolist (rep '(("<tab>" . "TAB")
9030 ("<return>" . "RET")
9031 ("<escape>" . "ESC")
9032 ("<delete>" . "DEL")))
9033 (setq binding (read-kbd-macro
9034 (let ((case-fold-search))
9035 (replace-regexp-in-string
9036 (regexp-quote (cdr rep))
9037 (car rep)
9038 (key-description binding)))))
9039 (pushnew binding new-bindings :test 'equal)))
9040 (dolist (binding new-bindings)
9041 (let ((key (lookup-key orgstruct-mode-map binding)))
9042 (when (or (not key) (numberp key))
9043 (condition-case nil
9044 (org-defkey orgstruct-mode-map
9045 binding
9046 (orgstruct-make-binding f binding disable-when-heading-prefix))
9047 (error nil)))))))))
9048 (run-hooks 'orgstruct-setup-hook))
9050 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9051 "Create a function for binding in the structure minor mode.
9052 FUN is the command to call inside a table. KEY is the key that
9053 should be checked in for a command to execute outside of tables.
9054 Non-nil `disable-when-heading-prefix' means to disable the command
9055 if `orgstruct-heading-prefix-regexp' is not empty."
9056 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9057 (let ((nname name)
9058 (i 0))
9059 (while (fboundp (intern nname))
9060 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9061 (setq name (intern nname)))
9062 (eval
9063 (let ((bindings '((org-heading-regexp
9064 (concat "^"
9065 orgstruct-heading-prefix-regexp
9066 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9067 (org-outline-regexp
9068 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9069 (org-outline-regexp-bol
9070 (concat "^" org-outline-regexp))
9071 (outline-regexp org-outline-regexp)
9072 (outline-heading-end-regexp "\n")
9073 (outline-level 'org-outline-level)
9074 (outline-heading-alist))))
9075 `(defun ,name (arg)
9076 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9077 "Outside of structure, run the binding of `"
9078 (key-description key) "'."
9079 (when disable-when-heading-prefix
9080 (concat
9081 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9082 "back to the default binding due to limitations of Org's implementation of\n"
9083 "`" (symbol-name fun) "'.")))
9084 (interactive "p")
9085 (let* ((disable
9086 ,(and disable-when-heading-prefix
9087 '(not (string= orgstruct-heading-prefix-regexp ""))))
9088 (fallback
9089 (or disable
9090 (not
9091 (let* ,bindings
9092 (org-context-p 'headline 'item
9093 ,(when (memq fun
9094 '(org-insert-heading
9095 org-insert-heading-respect-content
9096 org-meta-return))
9097 '(when orgstruct-is-++
9098 'item-body))))))))
9099 (if fallback
9100 (let* ((orgstruct-mode)
9101 (binding
9102 (let ((key ,key))
9103 (catch 'exit
9104 (dolist
9105 (rep
9106 '(nil
9107 ("<\\([^>]*\\)tab>" . "\\1TAB")
9108 ("<\\([^>]*\\)return>" . "\\1RET")
9109 ("<\\([^>]*\\)escape>" . "\\1ESC")
9110 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9111 nil)
9112 (when rep
9113 (setq key (read-kbd-macro
9114 (let ((case-fold-search))
9115 (replace-regexp-in-string
9116 (car rep)
9117 (cdr rep)
9118 (key-description key))))))
9119 (when (key-binding key)
9120 (throw 'exit (key-binding key))))))))
9121 (if (keymapp binding)
9122 (org-set-transient-map binding)
9123 (let ((func (or binding
9124 (unless disable
9125 'orgstruct-error))))
9126 (when func
9127 (call-interactively func)))))
9128 (org-run-like-in-org-mode
9129 (lambda ()
9130 (interactive)
9131 (let* ,bindings
9132 (call-interactively ',fun)))))))))
9133 name))
9135 (defun org-contextualize-keys (alist contexts)
9136 "Return valid elements in ALIST depending on CONTEXTS.
9138 `org-agenda-custom-commands' or `org-capture-templates' are the
9139 values used for ALIST, and `org-agenda-custom-commands-contexts'
9140 or `org-capture-templates-contexts' are the associated contexts
9141 definitions."
9142 (let ((contexts
9143 ;; normalize contexts
9144 (mapcar
9145 (lambda(c) (cond ((listp (cadr c))
9146 (list (car c) (car c) (cadr c)))
9147 ((string= "" (cadr c))
9148 (list (car c) (car c) (caddr c)))
9149 (t c))) contexts))
9150 (a alist) c r s)
9151 ;; loop over all commands or templates
9152 (while (setq c (pop a))
9153 (let (vrules repl)
9154 (cond
9155 ((not (assoc (car c) contexts))
9156 (push c r))
9157 ((and (assoc (car c) contexts)
9158 (setq vrules (org-contextualize-validate-key
9159 (car c) contexts)))
9160 (mapc (lambda (vr)
9161 (when (not (equal (car vr) (cadr vr)))
9162 (setq repl vr))) vrules)
9163 (if (not repl) (push c r)
9164 (push (cadr repl) s)
9165 (push
9166 (cons (car c)
9167 (cdr (or (assoc (cadr repl) alist)
9168 (error "Undefined key `%s' as contextual replacement for `%s'"
9169 (cadr repl) (car c)))))
9170 r))))))
9171 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9172 (delq
9174 (delete-dups
9175 (mapcar (lambda (x)
9176 (let ((tpl (car x)))
9177 (when (not (delq
9179 (mapcar (lambda(y)
9180 (equal y tpl)) s))) x)))
9181 (reverse r))))))
9183 (defun org-contextualize-validate-key (key contexts)
9184 "Check CONTEXTS for agenda or capture KEY."
9185 (let (r rr res)
9186 (while (setq r (pop contexts))
9187 (mapc
9188 (lambda (rr)
9189 (when
9190 (and (equal key (car r))
9191 (if (functionp rr) (funcall rr)
9192 (or (and (eq (car rr) 'in-file)
9193 (buffer-file-name)
9194 (string-match (cdr rr) (buffer-file-name)))
9195 (and (eq (car rr) 'in-mode)
9196 (string-match (cdr rr) (symbol-name major-mode)))
9197 (and (eq (car rr) 'in-buffer)
9198 (string-match (cdr rr) (buffer-name)))
9199 (when (and (eq (car rr) 'not-in-file)
9200 (buffer-file-name))
9201 (not (string-match (cdr rr) (buffer-file-name))))
9202 (when (eq (car rr) 'not-in-mode)
9203 (not (string-match (cdr rr) (symbol-name major-mode))))
9204 (when (eq (car rr) 'not-in-buffer)
9205 (not (string-match (cdr rr) (buffer-name)))))))
9206 (push r res)))
9207 (car (last r))))
9208 (delete-dups (delq nil res))))
9210 (defun org-context-p (&rest contexts)
9211 "Check if local context is any of CONTEXTS.
9212 Possible values in the list of contexts are `table', `headline', and `item'."
9213 (let ((pos (point)))
9214 (goto-char (point-at-bol))
9215 (prog1 (or (and (memq 'table contexts)
9216 (looking-at "[ \t]*|"))
9217 (and (memq 'headline contexts)
9218 (looking-at org-outline-regexp))
9219 (and (memq 'item contexts)
9220 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9221 (and (memq 'item-body contexts)
9222 (org-in-item-p)))
9223 (goto-char pos))))
9225 (defun org-get-local-variables ()
9226 "Return a list of all local variables in an Org mode buffer."
9227 (let (varlist)
9228 (with-current-buffer (get-buffer-create "*Org tmp*")
9229 (erase-buffer)
9230 (org-mode)
9231 (setq varlist (buffer-local-variables)))
9232 (kill-buffer "*Org tmp*")
9233 (delq nil
9234 (mapcar
9235 (lambda (x)
9236 (setq x
9237 (if (symbolp x)
9238 (list x)
9239 (list (car x) (cdr x))))
9240 (if (and (not (get (car x) 'org-state))
9241 (string-match
9242 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9243 (symbol-name (car x))))
9244 x nil))
9245 varlist))))
9247 (defun org-clone-local-variables (from-buffer &optional regexp)
9248 "Clone local variables from FROM-BUFFER.
9249 Optional argument REGEXP selects variables to clone."
9250 (mapc
9251 (lambda (pair)
9252 (and (symbolp (car pair))
9253 (or (null regexp)
9254 (string-match regexp (symbol-name (car pair))))
9255 (set (make-local-variable (car pair))
9256 (cdr pair))))
9257 (buffer-local-variables from-buffer)))
9259 ;;;###autoload
9260 (defun org-run-like-in-org-mode (cmd)
9261 "Run a command, pretending that the current buffer is in Org-mode.
9262 This will temporarily bind local variables that are typically bound in
9263 Org-mode to the values they have in Org-mode, and then interactively
9264 call CMD."
9265 (org-load-modules-maybe)
9266 (unless org-local-vars
9267 (setq org-local-vars (org-get-local-variables)))
9268 (let (binds)
9269 (dolist (var org-local-vars)
9270 (when (or (not (boundp (car var)))
9271 (eq (symbol-value (car var))
9272 (default-value (car var))))
9273 (push (list (car var) `(quote ,(cadr var))) binds)))
9274 (eval `(let ,binds
9275 (call-interactively (quote ,cmd))))))
9277 ;;;; Archiving
9279 (defun org-get-category (&optional pos force-refresh)
9280 "Get the category applying to position POS."
9281 (save-match-data
9282 (if force-refresh (org-refresh-category-properties))
9283 (let ((pos (or pos (point))))
9284 (or (get-text-property pos 'org-category)
9285 (progn (org-refresh-category-properties)
9286 (get-text-property pos 'org-category))))))
9288 (defun org-refresh-category-properties ()
9289 "Refresh category text properties in the buffer."
9290 (let ((case-fold-search t)
9291 (inhibit-read-only t)
9292 (def-cat (cond
9293 ((null org-category)
9294 (if buffer-file-name
9295 (file-name-sans-extension
9296 (file-name-nondirectory buffer-file-name))
9297 "???"))
9298 ((symbolp org-category) (symbol-name org-category))
9299 (t org-category)))
9300 beg end cat pos optionp)
9301 (org-with-silent-modifications
9302 (save-excursion
9303 (save-restriction
9304 (widen)
9305 (goto-char (point-min))
9306 (put-text-property (point) (point-max) 'org-category def-cat)
9307 (while (re-search-forward
9308 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9309 (setq pos (match-end 0)
9310 optionp (equal (char-after (match-beginning 0)) ?#)
9311 cat (org-trim (match-string 2)))
9312 (if optionp
9313 (setq beg (point-at-bol) end (point-max))
9314 (org-back-to-heading t)
9315 (setq beg (point) end (org-end-of-subtree t t)))
9316 (put-text-property beg end 'org-category cat)
9317 (put-text-property beg end 'org-category-position beg)
9318 (goto-char pos)))))))
9320 (defun org-refresh-properties (dprop tprop)
9321 "Refresh buffer text properties.
9322 DPROP is the drawer property and TPROP is the corresponding text
9323 property to set."
9324 (let ((case-fold-search t)
9325 (inhibit-read-only t) p)
9326 (org-with-silent-modifications
9327 (save-excursion
9328 (save-restriction
9329 (widen)
9330 (goto-char (point-min))
9331 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9332 (setq p (org-match-string-no-properties 1))
9333 (save-excursion
9334 (org-back-to-heading t)
9335 (put-text-property
9336 (point-at-bol) (or (outline-next-heading) (point-max)) tprop p))))))))
9339 ;;;; Link Stuff
9341 ;;; Link abbreviations
9343 (defun org-link-expand-abbrev (link)
9344 "Apply replacements as defined in `org-link-abbrev-alist'."
9345 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9346 (let* ((key (match-string 1 link))
9347 (as (or (assoc key org-link-abbrev-alist-local)
9348 (assoc key org-link-abbrev-alist)))
9349 (tag (and (match-end 2) (match-string 3 link)))
9350 rpl)
9351 (if (not as)
9352 link
9353 (setq rpl (cdr as))
9354 (cond
9355 ((symbolp rpl) (funcall rpl tag))
9356 ((string-match "%(\\([^)]+\\))" rpl)
9357 (replace-match
9358 (save-match-data
9359 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9360 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9361 ((string-match "%h" rpl)
9362 (replace-match (url-hexify-string (or tag "")) t t rpl))
9363 (t (concat rpl tag)))))
9364 link))
9366 ;;; Storing and inserting links
9368 (defvar org-insert-link-history nil
9369 "Minibuffer history for links inserted with `org-insert-link'.")
9371 (defvar org-stored-links nil
9372 "Contains the links stored with `org-store-link'.")
9374 (defvar org-store-link-plist nil
9375 "Plist with info about the most recently link created with `org-store-link'.")
9377 (defvar org-link-protocols nil
9378 "Link protocols added to Org-mode using `org-add-link-type'.")
9380 (defvar org-store-link-functions nil
9381 "List of functions that are called to create and store a link.
9382 Each function will be called in turn until one returns a non-nil
9383 value. Each function should check if it is responsible for creating
9384 this link (for example by looking at the major mode).
9385 If not, it must exit and return nil.
9386 If yes, it should return a non-nil value after a calling
9387 `org-store-link-props' with a list of properties and values.
9388 Special properties are:
9390 :type The link prefix, like \"http\". This must be given.
9391 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9392 This is obligatory as well.
9393 :description Optional default description for the second pair
9394 of brackets in an Org-mode link. The user can still change
9395 this when inserting this link into an Org-mode buffer.
9397 In addition to these, any additional properties can be specified
9398 and then used in capture templates.")
9400 (defun org-add-link-type (type &optional follow export)
9401 "Add TYPE to the list of `org-link-types'.
9402 Re-compute all regular expressions depending on `org-link-types'
9404 FOLLOW and EXPORT are two functions.
9406 FOLLOW should take the link path as the single argument and do whatever
9407 is necessary to follow the link, for example find a file or display
9408 a mail message.
9410 EXPORT should format the link path for export to one of the export formats.
9411 It should be a function accepting three arguments:
9413 path the path of the link, the text after the prefix (like \"http:\")
9414 desc the description of the link, if any, or a description added by
9415 org-export-normalize-links if there is none
9416 format the export format, a symbol like `html' or `latex' or `ascii'..
9418 The function may use the FORMAT information to return different values
9419 depending on the format. The return value will be put literally into
9420 the exported file. If the return value is nil, this means Org should
9421 do what it normally does with links which do not have EXPORT defined.
9423 Org-mode has a built-in default for exporting links. If you are happy with
9424 this default, there is no need to define an export function for the link
9425 type. For a simple example of an export function, see `org-bbdb.el'."
9426 (add-to-list 'org-link-types type t)
9427 (org-make-link-regexps)
9428 (if (assoc type org-link-protocols)
9429 (setcdr (assoc type org-link-protocols) (list follow export))
9430 (push (list type follow export) org-link-protocols)))
9432 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9433 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9435 ;;;###autoload
9436 (defun org-store-link (arg)
9437 "\\<org-mode-map>Store an org-link to the current location.
9438 This link is added to `org-stored-links' and can later be inserted
9439 into an org-buffer with \\[org-insert-link].
9441 For some link types, a prefix arg is interpreted.
9442 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9443 For file links, arg negates `org-context-in-file-links'.
9445 A double prefix arg force skipping storing functions that are not
9446 part of Org's core.
9448 A triple prefix arg force storing a link for each line in the
9449 active region."
9450 (interactive "P")
9451 (org-load-modules-maybe)
9452 (if (and (equal arg '(64)) (org-region-active-p))
9453 (save-excursion
9454 (let ((end (region-end)))
9455 (goto-char (region-beginning))
9456 (set-mark (point))
9457 (while (< (point-at-eol) end)
9458 (move-end-of-line 1) (activate-mark)
9459 (let (current-prefix-arg)
9460 (call-interactively 'org-store-link))
9461 (move-beginning-of-line 2)
9462 (set-mark (point)))))
9463 (org-with-limited-levels
9464 (setq org-store-link-plist nil)
9465 (let (link cpltxt desc description search
9466 txt custom-id agenda-link sfuns sfunsn)
9467 (cond
9469 ;; Store a link using an external link type
9470 ((and (not (equal arg '(16)))
9471 (setq sfuns
9472 (delq
9473 nil (mapcar (lambda (f)
9474 (let (fs) (if (funcall f) (push f fs))))
9475 org-store-link-functions))
9476 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9477 (or (and (cdr sfuns)
9478 (funcall (intern
9479 (completing-read
9480 "Which function for creating the link? "
9481 sfunsn nil t (car sfunsn)))))
9482 (funcall (caar sfuns)))
9483 (setq link (plist-get org-store-link-plist :link)
9484 desc (or (plist-get org-store-link-plist
9485 :description) link))))
9487 ;; Store a link from a source code buffer
9488 ((org-src-edit-buffer-p)
9489 (let (label gc)
9490 (while (or (not label)
9491 (save-excursion
9492 (save-restriction
9493 (widen)
9494 (goto-char (point-min))
9495 (re-search-forward
9496 (regexp-quote (format org-coderef-label-format label))
9497 nil t))))
9498 (when label (message "Label exists already") (sit-for 2))
9499 (setq label (read-string "Code line label: " label)))
9500 (end-of-line 1)
9501 (setq link (format org-coderef-label-format label))
9502 (setq gc (- 79 (length link)))
9503 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9504 (insert link)
9505 (setq link (concat "(" label ")") desc nil)))
9507 ;; We are in the agenda, link to referenced location
9508 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9509 (let ((m (or (get-text-property (point) 'org-hd-marker)
9510 (get-text-property (point) 'org-marker))))
9511 (when m
9512 (org-with-point-at m
9513 (setq agenda-link
9514 (if (org-called-interactively-p 'any)
9515 (call-interactively 'org-store-link)
9516 (org-store-link nil)))))))
9518 ((eq major-mode 'calendar-mode)
9519 (let ((cd (calendar-cursor-to-date)))
9520 (setq link
9521 (format-time-string
9522 (car org-time-stamp-formats)
9523 (apply 'encode-time
9524 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9525 nil nil nil))))
9526 (org-store-link-props :type "calendar" :date cd)))
9528 ((eq major-mode 'help-mode)
9529 (setq link (concat "help:" (save-excursion
9530 (goto-char (point-min))
9531 (looking-at "^[^ ]+")
9532 (match-string 0))))
9533 (org-store-link-props :type "help"))
9535 ((eq major-mode 'w3-mode)
9536 (setq cpltxt (if (and (buffer-name)
9537 (not (string-match "Untitled" (buffer-name))))
9538 (buffer-name)
9539 (url-view-url t))
9540 link (url-view-url t))
9541 (org-store-link-props :type "w3" :url (url-view-url t)))
9543 ((eq major-mode 'image-mode)
9544 (setq cpltxt (concat "file:"
9545 (abbreviate-file-name buffer-file-name))
9546 link cpltxt)
9547 (org-store-link-props :type "image" :file buffer-file-name))
9549 ;; In dired, store a link to the file of the current line
9550 ((eq major-mode 'dired-mode)
9551 (let ((file (dired-get-filename nil t)))
9552 (setq file (if file
9553 (abbreviate-file-name
9554 (expand-file-name (dired-get-filename nil t)))
9555 ;; otherwise, no file so use current directory.
9556 default-directory))
9557 (setq cpltxt (concat "file:" file)
9558 link cpltxt)))
9560 ((setq search (run-hook-with-args-until-success
9561 'org-create-file-search-functions))
9562 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9563 "::" search))
9564 (setq cpltxt (or description link)))
9566 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9567 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9568 (cond
9569 ;; Store a link using the target at point
9570 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9571 (setq cpltxt
9572 (concat "file:"
9573 (abbreviate-file-name
9574 (buffer-file-name (buffer-base-buffer)))
9575 "::" (match-string 1))
9576 link cpltxt))
9577 ((and (featurep 'org-id)
9578 (or (eq org-id-link-to-org-use-id t)
9579 (and (org-called-interactively-p 'any)
9580 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9581 (and (eq org-id-link-to-org-use-id
9582 'create-if-interactive-and-no-custom-id)
9583 (not custom-id))))
9584 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9585 ;; Store a link using the ID at point
9586 (setq link (condition-case nil
9587 (prog1 (org-id-store-link)
9588 (setq desc (or (plist-get org-store-link-plist
9589 :description)
9590 "")))
9591 (error
9592 ;; Probably before first headline, link only to file
9593 (concat "file:"
9594 (abbreviate-file-name
9595 (buffer-file-name (buffer-base-buffer))))))))
9597 ;; Just link to current headline
9598 (setq cpltxt (concat "file:"
9599 (abbreviate-file-name
9600 (buffer-file-name (buffer-base-buffer)))))
9601 ;; Add a context search string
9602 (when (org-xor org-context-in-file-links arg)
9603 (let* ((ee (org-element-at-point))
9604 (et (org-element-type ee))
9605 (ev (plist-get (cadr ee) :value))
9606 (ek (plist-get (cadr ee) :key))
9607 (eok (and (stringp ek) (string-match "name" ek))))
9608 (setq txt (cond
9609 ((org-at-heading-p) nil)
9610 ((and (eq et 'keyword) eok) ev)
9611 ((org-region-active-p)
9612 (buffer-substring (region-beginning) (region-end)))))
9613 (when (or (null txt) (string-match "\\S-" txt))
9614 (setq cpltxt
9615 (concat cpltxt "::"
9616 (condition-case nil
9617 (org-make-org-heading-search-string txt)
9618 (error "")))
9619 desc (or (and (eq et 'keyword) eok ev)
9620 (nth 4 (ignore-errors (org-heading-components)))
9621 "NONE")))))
9622 (if (string-match "::\\'" cpltxt)
9623 (setq cpltxt (substring cpltxt 0 -2)))
9624 (setq link cpltxt))))
9626 ((buffer-file-name (buffer-base-buffer))
9627 ;; Just link to this file here.
9628 (setq cpltxt (concat "file:"
9629 (abbreviate-file-name
9630 (buffer-file-name (buffer-base-buffer)))))
9631 ;; Add a context string.
9632 (when (org-xor org-context-in-file-links arg)
9633 (setq txt (if (org-region-active-p)
9634 (buffer-substring (region-beginning) (region-end))
9635 (buffer-substring (point-at-bol) (point-at-eol))))
9636 ;; Only use search option if there is some text.
9637 (when (string-match "\\S-" txt)
9638 (setq cpltxt
9639 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9640 desc "NONE")))
9641 (setq link cpltxt))
9643 ((org-called-interactively-p 'interactive)
9644 (user-error "No method for storing a link from this buffer"))
9646 (t (setq link nil)))
9648 ;; We're done setting link and desc, clean up
9649 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9650 (setq link (or link cpltxt)
9651 desc (or desc cpltxt))
9652 (cond ((equal desc "NONE") (setq desc nil))
9653 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9654 (let ((d0 (match-string 3 desc))
9655 (p0 (match-string 5 desc)))
9656 (setq desc
9657 (replace-regexp-in-string
9658 org-bracket-link-regexp
9659 (concat (or p0 d0)
9660 (if (equal (length (match-string 0 desc))
9661 (length desc)) "*" "")) desc)))))
9663 ;; Return the link
9664 (if (not (and (or (org-called-interactively-p 'any)
9665 executing-kbd-macro) link))
9666 (or agenda-link (and link (org-make-link-string link desc)))
9667 (push (list link desc) org-stored-links)
9668 (message "Stored: %s" (or desc link))
9669 (when custom-id
9670 (setq link (concat "file:" (abbreviate-file-name
9671 (buffer-file-name)) "::#" custom-id))
9672 (push (list link desc) org-stored-links))
9673 (car org-stored-links))))))
9675 (defun org-store-link-props (&rest plist)
9676 "Store link properties, extract names and addresses."
9677 (let (x adr)
9678 (when (setq x (plist-get plist :from))
9679 (setq adr (mail-extract-address-components x))
9680 (setq plist (plist-put plist :fromname (car adr)))
9681 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9682 (when (setq x (plist-get plist :to))
9683 (setq adr (mail-extract-address-components x))
9684 (setq plist (plist-put plist :toname (car adr)))
9685 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9686 (let ((from (plist-get plist :from))
9687 (to (plist-get plist :to)))
9688 (when (and from to org-from-is-user-regexp)
9689 (setq plist
9690 (plist-put plist :fromto
9691 (if (string-match org-from-is-user-regexp from)
9692 (concat "to %t")
9693 (concat "from %f"))))))
9694 (setq org-store-link-plist plist))
9696 (defun org-add-link-props (&rest plist)
9697 "Add these properties to the link property list."
9698 (let (key value)
9699 (while plist
9700 (setq key (pop plist) value (pop plist))
9701 (setq org-store-link-plist
9702 (plist-put org-store-link-plist key value)))))
9704 (defun org-email-link-description (&optional fmt)
9705 "Return the description part of an email link.
9706 This takes information from `org-store-link-plist' and formats it
9707 according to FMT (default from `org-email-link-description-format')."
9708 (setq fmt (or fmt org-email-link-description-format))
9709 (let* ((p org-store-link-plist)
9710 (to (plist-get p :toaddress))
9711 (from (plist-get p :fromaddress))
9712 (table
9713 (list
9714 (cons "%c" (plist-get p :fromto))
9715 (cons "%F" (plist-get p :from))
9716 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9717 (cons "%T" (plist-get p :to))
9718 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9719 (cons "%s" (plist-get p :subject))
9720 (cons "%d" (plist-get p :date))
9721 (cons "%m" (plist-get p :message-id)))))
9722 (when (string-match "%c" fmt)
9723 ;; Check if the user wrote this message
9724 (if (and org-from-is-user-regexp from to
9725 (save-match-data (string-match org-from-is-user-regexp from)))
9726 (setq fmt (replace-match "to %t" t t fmt))
9727 (setq fmt (replace-match "from %f" t t fmt))))
9728 (org-replace-escapes fmt table)))
9730 (defun org-make-org-heading-search-string (&optional string)
9731 "Make search string for the current headline or STRING."
9732 (let ((s (or string
9733 (and (derived-mode-p 'org-mode)
9734 (save-excursion
9735 (org-back-to-heading t)
9736 (org-element-property :raw-value (org-element-at-point))))))
9737 (lines org-context-in-file-links))
9738 (or string (setq s (concat "*" s))) ; Add * for headlines
9739 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9740 (when (and string (integerp lines) (> lines 0))
9741 (let ((slines (org-split-string s "\n")))
9742 (when (< lines (length slines))
9743 (setq s (mapconcat
9744 'identity
9745 (reverse (nthcdr (- (length slines) lines)
9746 (reverse slines))) "\n")))))
9747 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9749 (defun org-make-link-string (link &optional description)
9750 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9751 (unless (string-match "\\S-" link)
9752 (error "Empty link"))
9753 (when (and description
9754 (stringp description)
9755 (not (string-match "\\S-" description)))
9756 (setq description nil))
9757 (when (stringp description)
9758 ;; Remove brackets from the description, they are fatal.
9759 (while (string-match "\\[" description)
9760 (setq description (replace-match "{" t t description)))
9761 (while (string-match "\\]" description)
9762 (setq description (replace-match "}" t t description))))
9763 (when (equal link description)
9764 ;; No description needed, it is identical
9765 (setq description nil))
9766 (when (and (not description)
9767 (not (string-match (org-image-file-name-regexp) link))
9768 (not (equal link (org-link-escape link))))
9769 (setq description (org-extract-attributes link)))
9770 (setq link
9771 (cond ((string-match (org-image-file-name-regexp) link) link)
9772 ((string-match org-link-types-re link)
9773 (concat (match-string 1 link)
9774 (org-link-escape (substring link (match-end 1)))))
9775 (t (org-link-escape link))))
9776 (concat "[[" link "]"
9777 (if description (concat "[" description "]") "")
9778 "]"))
9780 (defconst org-link-escape-chars
9781 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9782 "List of characters that should be escaped in link.
9783 This is the list that is used for internal purposes.")
9785 (defconst org-link-escape-chars-browser
9786 '(?\ ?\")
9787 "List of escapes for characters that are problematic in links.
9788 This is the list that is used before handing over to the browser.")
9790 (defun org-link-escape (text &optional table merge)
9791 "Return percent escaped representation of TEXT.
9792 TEXT is a string with the text to escape.
9793 Optional argument TABLE is a list with characters that should be
9794 escaped. When nil, `org-link-escape-chars' is used.
9795 If optional argument MERGE is set, merge TABLE into
9796 `org-link-escape-chars'."
9797 (cond
9798 ((and table merge)
9799 (mapc (lambda (defchr)
9800 (unless (member defchr table)
9801 (setq table (cons defchr table)))) org-link-escape-chars))
9802 ((null table)
9803 (setq table org-link-escape-chars)))
9804 (mapconcat
9805 (lambda (char)
9806 (if (or (member char table)
9807 (and (or (< char 32) (= char 37) (> char 126))
9808 org-url-hexify-p))
9809 (mapconcat (lambda (sequence-element)
9810 (format "%%%.2X" sequence-element))
9811 (or (encode-coding-char char 'utf-8)
9812 (error "Unable to percent escape character: %s"
9813 (char-to-string char))) "")
9814 (char-to-string char))) text ""))
9816 (defun org-link-unescape (str)
9817 "Unhex hexified Unicode strings as returned from the JavaScript function
9818 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9819 (unless (and (null str) (string= "" str))
9820 (let ((pos 0) (case-fold-search t) unhexed)
9821 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
9822 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9823 (setq str (replace-match unhexed t t str))
9824 (setq pos (+ pos (length unhexed))))))
9825 str)
9827 (defun org-link-unescape-compound (hex)
9828 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9829 Note: this function also decodes single byte encodings like
9830 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9831 (save-match-data
9832 (let* ((bytes (cdr (split-string hex "%")))
9833 (ret "")
9834 (eat 0)
9835 (sum 0))
9836 (while bytes
9837 (let* ((val (string-to-number (pop bytes) 16))
9838 (shift-xor
9839 (if (= 0 eat)
9840 (cond
9841 ((>= val 252) (cons 6 252))
9842 ((>= val 248) (cons 5 248))
9843 ((>= val 240) (cons 4 240))
9844 ((>= val 224) (cons 3 224))
9845 ((>= val 192) (cons 2 192))
9846 (t (cons 0 0)))
9847 (cons 6 128))))
9848 (if (>= val 192) (setq eat (car shift-xor)))
9849 (setq val (logxor val (cdr shift-xor)))
9850 (setq sum (+ (lsh sum (car shift-xor)) val))
9851 (if (> eat 0) (setq eat (- eat 1)))
9852 (cond
9853 ((= 0 eat) ;multi byte
9854 (setq ret (concat ret (org-char-to-string sum)))
9855 (setq sum 0))
9856 ((not bytes) ; single byte(s)
9857 (setq ret (org-link-unescape-single-byte-sequence hex))))
9858 )) ;; end (while bytes
9859 ret )))
9861 (defun org-link-unescape-single-byte-sequence (hex)
9862 "Unhexify hex-encoded single byte character sequences."
9863 (mapconcat (lambda (byte)
9864 (char-to-string (string-to-number byte 16)))
9865 (cdr (split-string hex "%")) ""))
9867 (defun org-xor (a b)
9868 "Exclusive or."
9869 (if a (not b) b))
9871 (defun org-fixup-message-id-for-http (s)
9872 "Replace special characters in a message id, so it can be used in an http query."
9873 (when (string-match "%" s)
9874 (setq s (mapconcat (lambda (c)
9875 (if (eq c ?%)
9876 "%25"
9877 (char-to-string c)))
9878 s "")))
9879 (while (string-match "<" s)
9880 (setq s (replace-match "%3C" t t s)))
9881 (while (string-match ">" s)
9882 (setq s (replace-match "%3E" t t s)))
9883 (while (string-match "@" s)
9884 (setq s (replace-match "%40" t t s)))
9887 (defun org-link-prettify (link)
9888 "Return a human-readable representation of LINK.
9889 The car of LINK must be a raw link the cdr of LINK must be either
9890 a link description or nil."
9891 (let ((desc (or (cadr link) "<no description>")))
9892 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9893 "<" (car link) ">")))
9895 ;;;###autoload
9896 (defun org-insert-link-global ()
9897 "Insert a link like Org-mode does.
9898 This command can be called in any mode to insert a link in Org-mode syntax."
9899 (interactive)
9900 (org-load-modules-maybe)
9901 (org-run-like-in-org-mode 'org-insert-link))
9903 (defun org-insert-all-links (&optional keep)
9904 "Insert all links in `org-stored-links'."
9905 (interactive "P")
9906 (let ((links (copy-sequence org-stored-links)) l)
9907 (while (setq l (if keep (pop links) (pop org-stored-links)))
9908 (insert "- ")
9909 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9910 (insert "\n"))))
9912 (defun org-link-fontify-links-to-this-file ()
9913 "Fontify links to the current file in `org-stored-links'."
9914 (let ((f (buffer-file-name)) a b)
9915 (setq a (mapcar (lambda(l)
9916 (let ((ll (car l)))
9917 (when (and (string-match "^file:\\(.+\\)::" ll)
9918 (equal f (expand-file-name (match-string 1 ll))))
9919 ll)))
9920 org-stored-links))
9921 (when (featurep 'org-id)
9922 (setq b (mapcar (lambda(l)
9923 (let ((ll (car l)))
9924 (when (and (string-match "^id:\\(.+\\)$" ll)
9925 (equal f (expand-file-name
9926 (or (org-id-find-id-file
9927 (match-string 1 ll)) ""))))
9928 ll)))
9929 org-stored-links)))
9930 (mapcar (lambda(l)
9931 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9932 (delq nil (append a b)))))
9934 (defvar org-link-links-in-this-file nil)
9935 (defun org-insert-link (&optional complete-file link-location default-description)
9936 "Insert a link. At the prompt, enter the link.
9938 Completion can be used to insert any of the link protocol prefixes like
9939 http or ftp in use.
9941 The history can be used to select a link previously stored with
9942 `org-store-link'. When the empty string is entered (i.e. if you just
9943 press RET at the prompt), the link defaults to the most recently
9944 stored link. As SPC triggers completion in the minibuffer, you need to
9945 use M-SPC or C-q SPC to force the insertion of a space character.
9947 You will also be prompted for a description, and if one is given, it will
9948 be displayed in the buffer instead of the link.
9950 If there is already a link at point, this command will allow you to edit link
9951 and description parts.
9953 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
9954 be selected using completion. The path to the file will be relative to the
9955 current directory if the file is in the current directory or a subdirectory.
9956 Otherwise, the link will be the absolute path as completed in the minibuffer
9957 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9958 option `org-link-file-path-type'.
9960 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
9961 the current directory or below.
9963 With three \\[universal-argument] prefixes, negate the meaning of
9964 `org-keep-stored-link-after-insertion'.
9966 If `org-make-link-description-function' is non-nil, this function will be
9967 called with the link target, and the result will be the default
9968 link description.
9970 If the LINK-LOCATION parameter is non-nil, this value will be
9971 used as the link location instead of reading one interactively.
9973 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9974 be used as the default description."
9975 (interactive "P")
9976 (let* ((wcf (current-window-configuration))
9977 (origbuf (current-buffer))
9978 (region (if (org-region-active-p)
9979 (buffer-substring (region-beginning) (region-end))))
9980 (remove (and region (list (region-beginning) (region-end))))
9981 (desc region)
9982 tmphist ; byte-compile incorrectly complains about this
9983 (link link-location)
9984 (abbrevs org-link-abbrev-alist-local)
9985 entry file all-prefixes auto-desc)
9986 (cond
9987 (link-location) ; specified by arg, just use it.
9988 ((org-in-regexp org-bracket-link-regexp 1)
9989 ;; We do have a link at point, and we are going to edit it.
9990 (setq remove (list (match-beginning 0) (match-end 0)))
9991 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9992 (setq link (read-string "Link: "
9993 (org-link-unescape
9994 (org-match-string-no-properties 1)))))
9995 ((or (org-in-regexp org-angle-link-re)
9996 (org-in-regexp org-plain-link-re))
9997 ;; Convert to bracket link
9998 (setq remove (list (match-beginning 0) (match-end 0))
9999 link (read-string "Link: "
10000 (org-remove-angle-brackets (match-string 0)))))
10001 ((member complete-file '((4) (16)))
10002 ;; Completing read for file names.
10003 (setq link (org-file-complete-link complete-file)))
10005 ;; Read link, with completion for stored links.
10006 (org-link-fontify-links-to-this-file)
10007 (org-switch-to-buffer-other-window "*Org Links*")
10008 (with-current-buffer "*Org Links*"
10009 (erase-buffer)
10010 (insert "Insert a link.
10011 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10012 (when org-stored-links
10013 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10014 (insert (mapconcat 'org-link-prettify
10015 (reverse org-stored-links) "\n")))
10016 (goto-char (point-min)))
10017 (let ((cw (selected-window)))
10018 (select-window (get-buffer-window "*Org Links*" 'visible))
10019 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10020 (unless (pos-visible-in-window-p (point-max))
10021 (org-fit-window-to-buffer))
10022 (and (window-live-p cw) (select-window cw)))
10023 ;; Fake a link history, containing the stored links.
10024 (setq tmphist (append (mapcar 'car org-stored-links)
10025 org-insert-link-history))
10026 (setq all-prefixes (append (mapcar 'car abbrevs)
10027 (mapcar 'car org-link-abbrev-alist)
10028 org-link-types))
10029 (unwind-protect
10030 (progn
10031 (setq link
10032 (org-completing-read
10033 "Link: "
10034 (append
10035 (mapcar (lambda (x) (concat x ":"))
10036 all-prefixes)
10037 (mapcar 'car org-stored-links))
10038 nil nil nil
10039 'tmphist
10040 (caar org-stored-links)))
10041 (if (not (string-match "\\S-" link))
10042 (user-error "No link selected"))
10043 (mapc (lambda(l)
10044 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10045 org-stored-links)
10046 (if (or (member link all-prefixes)
10047 (and (equal ":" (substring link -1))
10048 (member (substring link 0 -1) all-prefixes)
10049 (setq link (substring link 0 -1))))
10050 (setq link (with-current-buffer origbuf
10051 (org-link-try-special-completion link)))))
10052 (set-window-configuration wcf)
10053 (kill-buffer "*Org Links*"))
10054 (setq entry (assoc link org-stored-links))
10055 (or entry (push link org-insert-link-history))
10056 (setq desc (or desc (nth 1 entry)))))
10058 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10059 (not org-keep-stored-link-after-insertion))
10060 (setq org-stored-links (delq (assoc link org-stored-links)
10061 org-stored-links)))
10063 (if (and (string-match org-plain-link-re link)
10064 (not (string-match org-ts-regexp link)))
10065 ;; URL-like link, normalize the use of angular brackets.
10066 (setq link (org-remove-angle-brackets link)))
10068 ;; Check if we are linking to the current file with a search
10069 ;; option If yes, simplify the link by using only the search
10070 ;; option.
10071 (when (and buffer-file-name
10072 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10073 (let* ((path (match-string 1 link))
10074 (case-fold-search nil)
10075 (search (match-string 2 link)))
10076 (save-match-data
10077 (if (equal (file-truename buffer-file-name) (file-truename path))
10078 ;; We are linking to this same file, with a search option
10079 (setq link search)))))
10081 ;; Check if we can/should use a relative path. If yes, simplify the link
10082 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10083 (let* ((type (match-string 1 link))
10084 (path (match-string 2 link))
10085 (origpath path)
10086 (case-fold-search nil))
10087 (cond
10088 ((or (eq org-link-file-path-type 'absolute)
10089 (equal complete-file '(16)))
10090 (setq path (abbreviate-file-name (expand-file-name path))))
10091 ((eq org-link-file-path-type 'noabbrev)
10092 (setq path (expand-file-name path)))
10093 ((eq org-link-file-path-type 'relative)
10094 (setq path (file-relative-name path)))
10096 (save-match-data
10097 (if (string-match (concat "^" (regexp-quote
10098 (expand-file-name
10099 (file-name-as-directory
10100 default-directory))))
10101 (expand-file-name path))
10102 ;; We are linking a file with relative path name.
10103 (setq path (substring (expand-file-name path)
10104 (match-end 0)))
10105 (setq path (abbreviate-file-name (expand-file-name path)))))))
10106 (setq link (concat type path))
10107 (if (equal desc origpath)
10108 (setq desc path))))
10110 (if org-make-link-description-function
10111 (setq desc
10112 (or (condition-case nil
10113 (funcall org-make-link-description-function link desc)
10114 (error (progn (message "Can't get link description from `%s'"
10115 (symbol-name org-make-link-description-function))
10116 (sit-for 2) nil)))
10117 (read-string "Description: " default-description)))
10118 (if default-description (setq desc default-description)
10119 (setq desc (or (and auto-desc desc)
10120 (read-string "Description: " desc)))))
10122 (unless (string-match "\\S-" desc) (setq desc nil))
10123 (if remove (apply 'delete-region remove))
10124 (insert (org-make-link-string link desc))))
10126 (defun org-link-try-special-completion (type)
10127 "If there is completion support for link type TYPE, offer it."
10128 (let ((fun (intern (concat "org-" type "-complete-link"))))
10129 (if (functionp fun)
10130 (funcall fun)
10131 (read-string "Link (no completion support): " (concat type ":")))))
10133 (defun org-file-complete-link (&optional arg)
10134 "Create a file link using completion."
10135 (let (file link)
10136 (setq file (org-iread-file-name "File: "))
10137 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10138 (pwd1 (file-name-as-directory (abbreviate-file-name
10139 (expand-file-name ".")))))
10140 (cond
10141 ((equal arg '(16))
10142 (setq link (concat
10143 "file:"
10144 (abbreviate-file-name (expand-file-name file)))))
10145 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10146 (setq link (concat "file:" (match-string 1 file))))
10147 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10148 (expand-file-name file))
10149 (setq link (concat
10150 "file:" (match-string 1 (expand-file-name file)))))
10151 (t (setq link (concat "file:" file)))))
10152 link))
10154 (defun org-iread-file-name (&rest args)
10155 "Read-file-name using `ido-mode' speedup if available.
10156 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10157 See `read-file-name' for a description of parameters."
10158 (org-without-partial-completion
10159 (if (and org-completion-use-ido
10160 (fboundp 'ido-read-file-name)
10161 (boundp 'ido-mode) ido-mode
10162 (listp (second args)))
10163 (let ((ido-enter-matching-directory nil))
10164 (apply 'ido-read-file-name args))
10165 (apply 'read-file-name args))))
10167 (defun org-completing-read (&rest args)
10168 "Completing-read with SPACE being a normal character."
10169 (let ((enable-recursive-minibuffers t)
10170 (minibuffer-local-completion-map
10171 (copy-keymap minibuffer-local-completion-map)))
10172 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10173 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10174 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10175 (apply 'org-icompleting-read args)))
10177 (defun org-completing-read-no-i (&rest args)
10178 (let (org-completion-use-ido org-completion-use-iswitchb)
10179 (apply 'org-completing-read args)))
10181 (defun org-iswitchb-completing-read (prompt choices &rest args)
10182 "Use iswitch as a completing-read replacement to choose from choices.
10183 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10184 from."
10185 (let* ((iswitchb-use-virtual-buffers nil)
10186 (iswitchb-make-buflist-hook
10187 (lambda ()
10188 (setq iswitchb-temp-buflist choices))))
10189 (iswitchb-read-buffer prompt)))
10191 (defun org-icompleting-read (&rest args)
10192 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10193 (org-without-partial-completion
10194 (if (and org-completion-use-ido
10195 (fboundp 'ido-completing-read)
10196 (boundp 'ido-mode) ido-mode
10197 (listp (second args)))
10198 (let ((ido-enter-matching-directory nil))
10199 (apply 'ido-completing-read (concat (car args))
10200 (if (consp (car (nth 1 args)))
10201 (mapcar 'car (nth 1 args))
10202 (nth 1 args))
10203 (cddr args)))
10204 (if (and org-completion-use-iswitchb
10205 (boundp 'iswitchb-mode) iswitchb-mode
10206 (listp (second args)))
10207 (apply 'org-iswitchb-completing-read (concat (car args))
10208 (if (consp (car (nth 1 args)))
10209 (mapcar 'car (nth 1 args))
10210 (nth 1 args))
10211 (cddr args))
10212 (apply 'completing-read args)))))
10214 (defun org-extract-attributes (s)
10215 "Extract the attributes cookie from a string and set as text property."
10216 (let (a attr (start 0) key value)
10217 (save-match-data
10218 (when (string-match "{{\\([^}]+\\)}}$" s)
10219 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10220 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10221 (setq key (match-string 1 a) value (match-string 2 a)
10222 start (match-end 0)
10223 attr (plist-put attr (intern key) value))))
10224 (org-add-props s nil 'org-attr attr))
10227 ;;; Opening/following a link
10229 (defvar org-link-search-failed nil)
10231 (defvar org-open-link-functions nil
10232 "Hook for functions finding a plain text link.
10233 These functions must take a single argument, the link content.
10234 They will be called for links that look like [[link text][description]]
10235 when LINK TEXT does not have a protocol like \"http:\" and does not look
10236 like a filename (e.g. \"./blue.png\").
10238 These functions will be called *before* Org attempts to resolve the
10239 link by doing text searches in the current buffer - so if you want a
10240 link \"[[target]]\" to still find \"<<target>>\", your function should
10241 handle this as a special case.
10243 When the function does handle the link, it must return a non-nil value.
10244 If it decides that it is not responsible for this link, it must return
10245 nil to indicate that that Org-mode can continue with other options
10246 like exact and fuzzy text search.")
10248 (defun org-next-link (&optional search-backward)
10249 "Move forward to the next link.
10250 If the link is in hidden text, expose it."
10251 (interactive "P")
10252 (when (and org-link-search-failed (eq this-command last-command))
10253 (goto-char (point-min))
10254 (message "Link search wrapped back to beginning of buffer"))
10255 (setq org-link-search-failed nil)
10256 (let* ((pos (point))
10257 (ct (org-context))
10258 (a (assoc :link ct))
10259 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10260 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10261 ((looking-at org-any-link-re)
10262 ;; Don't stay stuck at link without an org-link face
10263 (forward-char (if search-backward -1 1))))
10264 (if (funcall srch-fun org-any-link-re nil t)
10265 (progn
10266 (goto-char (match-beginning 0))
10267 (if (outline-invisible-p) (org-show-context)))
10268 (goto-char pos)
10269 (setq org-link-search-failed t)
10270 (message "No further link found"))))
10272 (defun org-previous-link ()
10273 "Move backward to the previous link.
10274 If the link is in hidden text, expose it."
10275 (interactive)
10276 (funcall 'org-next-link t))
10278 (defun org-translate-link (s)
10279 "Translate a link string if a translation function has been defined."
10280 (if (and org-link-translation-function
10281 (fboundp org-link-translation-function)
10282 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10283 (progn
10284 (setq s (funcall org-link-translation-function
10285 (match-string 1 s) (match-string 2 s)))
10286 (concat (car s) ":" (cdr s)))
10289 (defun org-translate-link-from-planner (type path)
10290 "Translate a link from Emacs Planner syntax so that Org can follow it.
10291 This is still an experimental function, your mileage may vary."
10292 (cond
10293 ((member type '("http" "https" "news" "ftp"))
10294 ;; standard Internet links are the same.
10295 nil)
10296 ((and (equal type "irc") (string-match "^//" path))
10297 ;; Planner has two / at the beginning of an irc link, we have 1.
10298 ;; We should have zero, actually....
10299 (setq path (substring path 1)))
10300 ((and (equal type "lisp") (string-match "^/" path))
10301 ;; Planner has a slash, we do not.
10302 (setq type "elisp" path (substring path 1)))
10303 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10304 ;; A typical message link. Planner has the id after the final slash,
10305 ;; we separate it with a hash mark
10306 (setq path (concat (match-string 1 path) "#"
10307 (org-remove-angle-brackets (match-string 2 path))))))
10308 (cons type path))
10310 (defun org-find-file-at-mouse (ev)
10311 "Open file link or URL at mouse."
10312 (interactive "e")
10313 (mouse-set-point ev)
10314 (org-open-at-point 'in-emacs))
10316 (defun org-open-at-mouse (ev)
10317 "Open file link or URL at mouse.
10318 See the docstring of `org-open-file' for details."
10319 (interactive "e")
10320 (mouse-set-point ev)
10321 (if (eq major-mode 'org-agenda-mode)
10322 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10323 (org-open-at-point))
10325 (defvar org-window-config-before-follow-link nil
10326 "The window configuration before following a link.
10327 This is saved in case the need arises to restore it.")
10329 (defvar org-open-link-marker (make-marker)
10330 "Marker pointing to the location where `org-open-at-point' was called.")
10332 ;;;###autoload
10333 (defun org-open-at-point-global ()
10334 "Follow a link like Org-mode does.
10335 This command can be called in any mode to follow a link that has
10336 Org-mode syntax."
10337 (interactive)
10338 (org-run-like-in-org-mode 'org-open-at-point))
10340 ;;;###autoload
10341 (defun org-open-link-from-string (s &optional arg reference-buffer)
10342 "Open a link in the string S, as if it was in Org-mode."
10343 (interactive "sLink: \nP")
10344 (let ((reference-buffer (or reference-buffer (current-buffer))))
10345 (with-temp-buffer
10346 (let ((org-inhibit-startup (not reference-buffer)))
10347 (org-mode)
10348 (insert s)
10349 (goto-char (point-min))
10350 (when reference-buffer
10351 (setq org-link-abbrev-alist-local
10352 (with-current-buffer reference-buffer
10353 org-link-abbrev-alist-local)))
10354 (org-open-at-point arg reference-buffer)))))
10356 (defvar org-open-at-point-functions nil
10357 "Hook that is run when following a link at point.
10359 Functions in this hook must return t if they identify and follow
10360 a link at point. If they don't find anything interesting at point,
10361 they must return nil.")
10363 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10364 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10365 (defun org-open-at-point (&optional arg reference-buffer)
10366 "Open link at or after point.
10367 If there is no link at point, this function will search forward up to
10368 the end of the current line.
10369 Normally, files will be opened by an appropriate application. If the
10370 optional prefix argument ARG is non-nil, Emacs will visit the file.
10371 With a double prefix argument, try to open outside of Emacs, in the
10372 application the system uses for this file type."
10373 (interactive "P")
10374 ;; if in a code block, then open the block's results
10375 (unless (call-interactively #'org-babel-open-src-block-result)
10376 (org-load-modules-maybe)
10377 (move-marker org-open-link-marker (point))
10378 (setq org-window-config-before-follow-link (current-window-configuration))
10379 (org-remove-occur-highlights nil nil t)
10380 (cond
10381 ((and (org-at-heading-p)
10382 (not (org-at-timestamp-p t))
10383 (not (org-in-regexp
10384 (concat org-plain-link-re "\\|"
10385 org-bracket-link-regexp "\\|"
10386 org-angle-link-re "\\|"
10387 "[ \t]:[^ \t\n]+:[ \t]*$")))
10388 (not (get-text-property (point) 'org-linked-text)))
10389 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10390 (lk0 (car lkall))
10391 (lk (if (stringp lk0) (list lk0) lk0))
10392 (lkend (cdr lkall)))
10393 (mapcar (lambda(l)
10394 (search-forward l nil lkend)
10395 (goto-char (match-beginning 0))
10396 (org-open-at-point))
10397 lk))
10398 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10399 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10400 ((and (org-at-timestamp-p t)
10401 (not (org-in-regexp org-bracket-link-regexp)))
10402 (org-follow-timestamp-link))
10403 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10404 (not (org-in-regexp org-any-link-re)))
10405 (org-footnote-action))
10407 (let (type path link line search (pos (point)))
10408 (catch 'match
10409 (save-excursion
10410 (or (org-in-regexp org-plain-link-re)
10411 (skip-chars-forward "^]\n\r"))
10412 (when (org-in-regexp org-bracket-link-regexp 1)
10413 (setq link (org-extract-attributes
10414 (org-link-unescape (org-match-string-no-properties 1))))
10415 (while (string-match " *\n *" link)
10416 (setq link (replace-match " " t t link)))
10417 (setq link (org-link-expand-abbrev link))
10418 (cond
10419 ((or (file-name-absolute-p link)
10420 (string-match "^\\.\\.?/" link))
10421 (setq type "file" path link))
10422 ((string-match org-link-re-with-space3 link)
10423 (setq type (match-string 1 link) path (match-string 2 link)))
10424 ((string-match "^help:+\\(.+\\)" link)
10425 (setq type "help" path (match-string 1 link)))
10426 (t (setq type "thisfile" path link)))
10427 (throw 'match t)))
10429 (when (get-text-property (point) 'org-linked-text)
10430 (setq type "thisfile"
10431 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10432 (1+ (point)) (point))
10433 path (buffer-substring
10434 (or (previous-single-property-change pos 'org-linked-text)
10435 (point-min))
10436 (or (next-single-property-change pos 'org-linked-text)
10437 (point-max)))
10438 ;; Ensure we will search for a <<<radio>>> link, not
10439 ;; a simple reference like <<ref>>
10440 path (concat "<" path))
10441 (throw 'match t))
10443 (save-excursion
10444 (when (or (org-in-regexp org-angle-link-re)
10445 (let ((match (org-in-regexp org-plain-link-re)))
10446 ;; Check a plain link is not within a bracket link
10447 (and match
10448 (save-excursion
10449 (save-match-data
10450 (progn
10451 (goto-char (car match))
10452 (not (org-in-regexp org-bracket-link-regexp)))))))
10453 (let ((line_ending (save-excursion (end-of-line) (point))))
10454 ;; We are in a line before a plain or bracket link
10455 (or (re-search-forward org-plain-link-re line_ending t)
10456 (re-search-forward org-bracket-link-regexp line_ending t))))
10457 (setq type (match-string 1)
10458 path (org-link-unescape (match-string 2)))
10459 (throw 'match t)))
10460 (save-excursion
10461 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
10462 (setq type "tags"
10463 path (match-string 1))
10464 (while (string-match ":" path)
10465 (setq path (replace-match "+" t t path)))
10466 (throw 'match t)))
10467 (when (org-in-regexp "<\\([^><\n]+\\)>")
10468 (setq type "tree-match"
10469 path (match-string 1))
10470 (throw 'match t)))
10471 (unless path
10472 (user-error "No link found"))
10474 ;; switch back to reference buffer
10475 ;; needed when if called in a temporary buffer through
10476 ;; org-open-link-from-string
10477 (with-current-buffer (or reference-buffer (current-buffer))
10479 ;; Remove any trailing spaces in path
10480 (if (string-match " +\\'" path)
10481 (setq path (replace-match "" t t path)))
10482 (if (and org-link-translation-function
10483 (fboundp org-link-translation-function))
10484 ;; Check if we need to translate the link
10485 (let ((tmp (funcall org-link-translation-function type path)))
10486 (setq type (car tmp) path (cdr tmp))))
10488 (cond
10490 ((assoc type org-link-protocols)
10491 (funcall (nth 1 (assoc type org-link-protocols)) path))
10493 ((equal type "help")
10494 (let ((f-or-v (intern path)))
10495 (cond ((fboundp f-or-v)
10496 (describe-function f-or-v))
10497 ((boundp f-or-v)
10498 (describe-variable f-or-v))
10499 (t (error "Not a known function or variable")))))
10501 ((equal type "mailto")
10502 (let ((cmd (car org-link-mailto-program))
10503 (args (cdr org-link-mailto-program)) args1
10504 (address path) (subject "") a)
10505 (if (string-match "\\(.*\\)::\\(.*\\)" path)
10506 (setq address (match-string 1 path)
10507 subject (org-link-escape (match-string 2 path))))
10508 (while args
10509 (cond
10510 ((not (stringp (car args))) (push (pop args) args1))
10511 (t (setq a (pop args))
10512 (if (string-match "%a" a)
10513 (setq a (replace-match address t t a)))
10514 (if (string-match "%s" a)
10515 (setq a (replace-match subject t t a)))
10516 (push a args1))))
10517 (apply cmd (nreverse args1))))
10519 ((member type '("http" "https" "ftp" "news"))
10520 (browse-url
10521 (concat type ":"
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 ((string= type "doi")
10530 (browse-url
10531 (concat org-doi-server-url
10532 (if (org-string-match-p
10533 (concat "[[:nonascii:]"
10534 org-link-escape-chars-browser "]")
10535 path)
10536 (org-link-escape path org-link-escape-chars-browser)
10537 path))))
10539 ((member type '("message"))
10540 (browse-url (concat type ":" path)))
10542 ((string= type "tags")
10543 (org-tags-view arg path))
10545 ((string= type "tree-match")
10546 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
10548 ((string= type "file")
10549 (if (string-match "::\\([0-9]+\\)\\'" path)
10550 (setq line (string-to-number (match-string 1 path))
10551 path (substring path 0 (match-beginning 0)))
10552 (if (string-match "::\\(.+\\)\\'" path)
10553 (setq search (match-string 1 path)
10554 path (substring path 0 (match-beginning 0)))))
10555 (if (string-match "[*?{]" (file-name-nondirectory path))
10556 (dired path)
10557 (org-open-file path arg line search)))
10559 ((string= type "shell")
10560 (let ((buf (generate-new-buffer "*Org Shell Output"))
10561 (cmd path))
10562 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10563 (string-match org-confirm-shell-link-not-regexp cmd))
10564 (not org-confirm-shell-link-function)
10565 (funcall org-confirm-shell-link-function
10566 (format "Execute \"%s\" in shell? "
10567 (org-add-props cmd nil
10568 'face 'org-warning))))
10569 (progn
10570 (message "Executing %s" cmd)
10571 (shell-command cmd buf)
10572 (if (featurep 'midnight)
10573 (setq clean-buffer-list-kill-buffer-names
10574 (cons buf clean-buffer-list-kill-buffer-names))))
10575 (error "Abort"))))
10577 ((string= type "elisp")
10578 (let ((cmd path))
10579 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10580 (string-match org-confirm-elisp-link-not-regexp cmd))
10581 (not org-confirm-elisp-link-function)
10582 (funcall org-confirm-elisp-link-function
10583 (format "Execute \"%s\" as elisp? "
10584 (org-add-props cmd nil
10585 'face 'org-warning))))
10586 (message "%s => %s" cmd
10587 (if (equal (string-to-char cmd) ?\()
10588 (eval (read cmd))
10589 (call-interactively (read cmd))))
10590 (error "Abort"))))
10592 ((and (string= type "thisfile")
10593 (or (run-hook-with-args-until-success
10594 'org-open-link-functions path)
10595 (and link
10596 (string-match "^id:" link)
10597 (or (featurep 'org-id) (require 'org-id))
10598 (progn
10599 (funcall (nth 1 (assoc "id" org-link-protocols))
10600 (substring path 3))
10601 t)))))
10603 ((string= type "thisfile")
10604 (if arg
10605 (switch-to-buffer-other-window
10606 (org-get-buffer-for-internal-link (current-buffer)))
10607 (org-mark-ring-push))
10608 (let ((cmd `(org-link-search
10609 ,path
10610 ,(cond ((equal arg '(4)) ''occur)
10611 ((equal arg '(16)) ''org-occur))
10612 ,pos)))
10613 (condition-case nil (let ((org-link-search-inhibit-query t))
10614 (eval cmd))
10615 (error (progn (widen) (eval cmd))))))
10617 (t (browse-url-at-point)))))))
10618 (move-marker org-open-link-marker nil)
10619 (run-hook-with-args 'org-follow-link-hook)))
10621 (defsubst org-uniquify (list)
10622 "Non-destructively remove duplicate elements from LIST."
10623 (let ((res (copy-sequence list))) (delete-dups res)))
10625 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10626 "Offer links in the current entry and return the selected link.
10627 If there is only one link, return it.
10628 If NTH is an integer, return the NTH link found.
10629 If ZERO is a string, check also this string for a link, and if
10630 there is one, return it."
10631 (with-current-buffer buffer
10632 (save-excursion
10633 (save-restriction
10634 (widen)
10635 (goto-char marker)
10636 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10637 "\\(" org-angle-link-re "\\)\\|"
10638 "\\(" org-plain-link-re "\\)"))
10639 (cnt ?0)
10640 (in-emacs (if (integerp nth) nil nth))
10641 have-zero end links link c)
10642 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10643 (push (match-string 0 zero) links)
10644 (setq cnt (1- cnt) have-zero t))
10645 (save-excursion
10646 (org-back-to-heading t)
10647 (setq end (save-excursion (outline-next-heading) (point)))
10648 (while (re-search-forward re end t)
10649 (push (match-string 0) links))
10650 (setq links (org-uniquify (reverse links))))
10651 (cond
10652 ((null links)
10653 (message "No links"))
10654 ((equal (length links) 1)
10655 (setq link (car links)))
10656 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10657 (setq link (nth (if have-zero nth (1- nth)) links)))
10658 (t ; we have to select a link
10659 (save-excursion
10660 (save-window-excursion
10661 (delete-other-windows)
10662 (with-output-to-temp-buffer "*Select Link*"
10663 (mapc (lambda (l)
10664 (if (not (string-match org-bracket-link-regexp l))
10665 (princ (format "[%c] %s\n" (incf cnt)
10666 (org-remove-angle-brackets l)))
10667 (if (match-end 3)
10668 (princ (format "[%c] %s (%s)\n" (incf cnt)
10669 (match-string 3 l) (match-string 1 l)))
10670 (princ (format "[%c] %s\n" (incf cnt)
10671 (match-string 1 l))))))
10672 links))
10673 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10674 (message "Select link to open, RET to open all:")
10675 (setq c (read-char-exclusive))
10676 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10677 (when (equal c ?q) (error "Abort"))
10678 (if (equal c ?\C-m)
10679 (setq link links)
10680 (setq nth (- c ?0))
10681 (if have-zero (setq nth (1+ nth)))
10682 (unless (and (integerp nth) (>= (length links) nth))
10683 (user-error "Invalid link selection"))
10684 (setq link (nth (1- nth) links)))))
10685 (cons link end))))))
10687 ;; Add special file links that specify the way of opening
10689 (org-add-link-type "file+sys" 'org-open-file-with-system)
10690 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10691 (defun org-open-file-with-system (path)
10692 "Open file at PATH using the system way of opening it."
10693 (org-open-file path 'system))
10694 (defun org-open-file-with-emacs (path)
10695 "Open file at PATH in Emacs."
10696 (org-open-file path 'emacs))
10699 ;;; File search
10701 (defvar org-create-file-search-functions nil
10702 "List of functions to construct the right search string for a file link.
10703 These functions are called in turn with point at the location to
10704 which the link should point.
10706 A function in the hook should first test if it would like to
10707 handle this file type, for example by checking the `major-mode'
10708 or the file extension. If it decides not to handle this file, it
10709 should just return nil to give other functions a chance. If it
10710 does handle the file, it must return the search string to be used
10711 when following the link. The search string will be part of the
10712 file link, given after a double colon, and `org-open-at-point'
10713 will automatically search for it. If special measures must be
10714 taken to make the search successful, another function should be
10715 added to the companion hook `org-execute-file-search-functions',
10716 which see.
10718 A function in this hook may also use `setq' to set the variable
10719 `description' to provide a suggestion for the descriptive text to
10720 be used for this link when it gets inserted into an Org-mode
10721 buffer with \\[org-insert-link].")
10723 (defvar org-execute-file-search-functions nil
10724 "List of functions to execute a file search triggered by a link.
10726 Functions added to this hook must accept a single argument, the
10727 search string that was part of the file link, the part after the
10728 double colon. The function must first check if it would like to
10729 handle this search, for example by checking the `major-mode' or
10730 the file extension. If it decides not to handle this search, it
10731 should just return nil to give other functions a chance. If it
10732 does handle the search, it must return a non-nil value to keep
10733 other functions from trying.
10735 Each function can access the current prefix argument through the
10736 variable `current-prefix-arg'. Note that a single prefix is used
10737 to force opening a link in Emacs, so it may be good to only use a
10738 numeric or double prefix to guide the search function.
10740 In case this is needed, a function in this hook can also restore
10741 the window configuration before `org-open-at-point' was called using:
10743 (set-window-configuration org-window-config-before-follow-link)")
10745 (defun org-link-search (s &optional type avoid-pos stealth)
10746 "Search for a link search option.
10747 If S is surrounded by forward slashes, it is interpreted as a
10748 regular expression. In org-mode files, this will create an `org-occur'
10749 sparse tree. In ordinary files, `occur' will be used to list matches.
10750 If the current buffer is in `dired-mode', grep will be used to search
10751 in all files. If AVOID-POS is given, ignore matches near that position.
10753 When optional argument STEALTH is non-nil, do not modify
10754 visibility around point, thus ignoring
10755 `org-show-hierarchy-above', `org-show-following-heading' and
10756 `org-show-siblings' variables."
10757 (let ((case-fold-search t)
10758 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10759 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10760 (append '(("") (" ") ("\t") ("\n"))
10761 org-emphasis-alist)
10762 "\\|") "\\)"))
10763 (pos (point))
10764 (pre nil) (post nil)
10765 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10766 (cond
10767 ;; First check if there are any special search functions
10768 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10769 ;; Now try the builtin stuff
10770 ((and (equal (string-to-char s0) ?#)
10771 (> (length s0) 1)
10772 (save-excursion
10773 (goto-char (point-min))
10774 (and
10775 (re-search-forward
10776 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10777 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10778 (setq type 'dedicated
10779 pos (match-beginning 0))))
10780 ;; There is an exact target for this
10781 (goto-char pos)
10782 (org-back-to-heading t)))
10783 ((save-excursion
10784 (goto-char (point-min))
10785 (and
10786 (re-search-forward
10787 (concat "<<" (regexp-quote s0) ">>") nil t)
10788 (setq type 'dedicated
10789 pos (match-beginning 0))))
10790 ;; There is an exact target for this
10791 (goto-char pos))
10792 ((save-excursion
10793 (goto-char (point-min))
10794 (and
10795 (re-search-forward
10796 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10797 (setq type 'dedicated pos (match-beginning 0))))
10798 ;; Found an element with a matching #+name affiliated keyword.
10799 (goto-char pos))
10800 ((and (string-match "^(\\(.*\\))$" s0)
10801 (save-excursion
10802 (goto-char (point-min))
10803 (and
10804 (re-search-forward
10805 (concat "[^[]" (regexp-quote
10806 (format org-coderef-label-format
10807 (match-string 1 s0))))
10808 nil t)
10809 (setq type 'dedicated
10810 pos (1+ (match-beginning 0))))))
10811 ;; There is a coderef target for this
10812 (goto-char pos))
10813 ((string-match "^/\\(.*\\)/$" s)
10814 ;; A regular expression
10815 (cond
10816 ((derived-mode-p 'org-mode)
10817 (org-occur (match-string 1 s)))
10818 (t (org-do-occur (match-string 1 s)))))
10819 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10820 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10821 (goto-char (point-min))
10822 (cond
10823 ((let (case-fold-search)
10824 (re-search-forward (format org-complex-heading-regexp-format
10825 (regexp-quote s))
10826 nil t))
10827 ;; OK, found a match
10828 (setq type 'dedicated)
10829 (goto-char (match-beginning 0)))
10830 ((and (not org-link-search-inhibit-query)
10831 (eq org-link-search-must-match-exact-headline 'query-to-create)
10832 (y-or-n-p "No match - create this as a new heading? "))
10833 (goto-char (point-max))
10834 (or (bolp) (newline))
10835 (insert "* " s "\n")
10836 (beginning-of-line 0))
10838 (goto-char pos)
10839 (error "No match"))))
10841 ;; A normal search string
10842 (when (equal (string-to-char s) ?*)
10843 ;; Anchor on headlines, post may include tags.
10844 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10845 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10846 s (substring s 1)))
10847 (remove-text-properties
10848 0 (length s)
10849 '(face nil mouse-face nil keymap nil fontified nil) s)
10850 ;; Make a series of regular expressions to find a match
10851 (setq words (org-split-string s "[ \n\r\t]+")
10853 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10854 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10855 "\\)" markers)
10856 re2a_ (concat "\\(" (mapconcat 'downcase words
10857 "[ \t\r\n]+") "\\)[ \t\r\n]")
10858 re2a (concat "[ \t\r\n]" re2a_)
10859 re4_ (concat "\\(" (mapconcat 'downcase words
10860 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10861 re4 (concat "[^a-zA-Z_]" re4_)
10863 re1 (concat pre re2 post)
10864 re3 (concat pre (if pre re4_ re4) post)
10865 re5 (concat pre ".*" re4)
10866 re2 (concat pre re2)
10867 re2a (concat pre (if pre re2a_ re2a))
10868 re4 (concat pre (if pre re4_ re4))
10869 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10870 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10871 re5 "\\)"))
10872 (cond
10873 ((eq type 'org-occur) (org-occur reall))
10874 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10875 (t (goto-char (point-min))
10876 (setq type 'fuzzy)
10877 (if (or (and (org-search-not-self 1 re0 nil t)
10878 (setq type 'dedicated))
10879 (org-search-not-self 1 re1 nil t)
10880 (org-search-not-self 1 re2 nil t)
10881 (org-search-not-self 1 re2a nil t)
10882 (org-search-not-self 1 re3 nil t)
10883 (org-search-not-self 1 re4 nil t)
10884 (org-search-not-self 1 re5 nil t))
10885 (goto-char (match-beginning 1))
10886 (goto-char pos)
10887 (error "No match"))))))
10888 (and (derived-mode-p 'org-mode)
10889 (not stealth)
10890 (org-show-context 'link-search))
10891 type))
10893 (defun org-search-not-self (group &rest args)
10894 "Execute `re-search-forward', but only accept matches that do not
10895 enclose the position of `org-open-link-marker'."
10896 (let ((m org-open-link-marker))
10897 (catch 'exit
10898 (while (apply 're-search-forward args)
10899 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10900 (goto-char (match-end group))
10901 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10902 (> (match-beginning 0) (marker-position m))
10903 (< (match-end 0) (marker-position m)))
10904 (save-match-data
10905 (or (not (org-in-regexp
10906 org-bracket-link-analytic-regexp 1))
10907 (not (match-end 4)) ; no description
10908 (and (<= (match-beginning 4) (point))
10909 (>= (match-end 4) (point))))))
10910 (throw 'exit (point))))))))
10912 (defun org-get-buffer-for-internal-link (buffer)
10913 "Return a buffer to be used for displaying the link target of internal links."
10914 (cond
10915 ((not org-display-internal-link-with-indirect-buffer)
10916 buffer)
10917 ((string-match "(Clone)$" (buffer-name buffer))
10918 (message "Buffer is already a clone, not making another one")
10919 ;; we also do not modify visibility in this case
10920 buffer)
10921 (t ; make a new indirect buffer for displaying the link
10922 (let* ((bn (buffer-name buffer))
10923 (ibn (concat bn "(Clone)"))
10924 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10925 (with-current-buffer ib (org-overview))
10926 ib))))
10928 (defun org-do-occur (regexp &optional cleanup)
10929 "Call the Emacs command `occur'.
10930 If CLEANUP is non-nil, remove the printout of the regular expression
10931 in the *Occur* buffer. This is useful if the regex is long and not useful
10932 to read."
10933 (occur regexp)
10934 (when cleanup
10935 (let ((cwin (selected-window)) win beg end)
10936 (when (setq win (get-buffer-window "*Occur*"))
10937 (select-window win))
10938 (goto-char (point-min))
10939 (when (re-search-forward "match[a-z]+" nil t)
10940 (setq beg (match-end 0))
10941 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10942 (setq end (1- (match-beginning 0)))))
10943 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10944 (goto-char (point-min))
10945 (select-window cwin))))
10947 ;;; The mark ring for links jumps
10949 (defvar org-mark-ring nil
10950 "Mark ring for positions before jumps in Org-mode.")
10951 (defvar org-mark-ring-last-goto nil
10952 "Last position in the mark ring used to go back.")
10953 ;; Fill and close the ring
10954 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10955 (loop for i from 1 to org-mark-ring-length do
10956 (push (make-marker) org-mark-ring))
10957 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10958 org-mark-ring)
10960 (defun org-mark-ring-push (&optional pos buffer)
10961 "Put the current position or POS into the mark ring and rotate it."
10962 (interactive)
10963 (setq pos (or pos (point)))
10964 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10965 (move-marker (car org-mark-ring)
10966 (or pos (point))
10967 (or buffer (current-buffer)))
10968 (message "%s"
10969 (substitute-command-keys
10970 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
10972 (defun org-mark-ring-goto (&optional n)
10973 "Jump to the previous position in the mark ring.
10974 With prefix arg N, jump back that many stored positions. When
10975 called several times in succession, walk through the entire ring.
10976 Org-mode commands jumping to a different position in the current file,
10977 or to another Org-mode file, automatically push the old position
10978 onto the ring."
10979 (interactive "p")
10980 (let (p m)
10981 (if (eq last-command this-command)
10982 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10983 (setq p org-mark-ring))
10984 (setq org-mark-ring-last-goto p)
10985 (setq m (car p))
10986 (org-pop-to-buffer-same-window (marker-buffer m))
10987 (goto-char m)
10988 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10990 (defun org-remove-angle-brackets (s)
10991 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10992 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10994 (defun org-add-angle-brackets (s)
10995 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10996 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10998 (defun org-remove-double-quotes (s)
10999 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11000 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11003 ;;; Following specific links
11005 (defun org-follow-timestamp-link ()
11006 "Open an agenda view for the time-stamp date/range at point."
11007 (cond
11008 ((org-at-date-range-p t)
11009 (let ((org-agenda-start-on-weekday)
11010 (t1 (match-string 1))
11011 (t2 (match-string 2)) tt1 tt2)
11012 (setq tt1 (time-to-days (org-time-string-to-time t1))
11013 tt2 (time-to-days (org-time-string-to-time t2)))
11014 (let ((org-agenda-buffer-tmp-name
11015 (format "*Org Agenda(a:%s)"
11016 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11017 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11018 ((org-at-timestamp-p t)
11019 (let ((org-agenda-buffer-tmp-name
11020 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11021 (org-agenda-list nil (time-to-days (org-time-string-to-time
11022 (substring (match-string 1) 0 10)))
11023 1)))
11024 (t (error "This should not happen"))))
11027 ;;; Following file links
11028 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11029 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11030 (declare-function mailcap-mime-info
11031 "mailcap" (string &optional request no-decode))
11032 (defvar org-wait nil)
11033 (defun org-open-file (path &optional in-emacs line search)
11034 "Open the file at PATH.
11035 First, this expands any special file name abbreviations. Then the
11036 configuration variable `org-file-apps' is checked if it contains an
11037 entry for this file type, and if yes, the corresponding command is launched.
11039 If no application is found, Emacs simply visits the file.
11041 With optional prefix argument IN-EMACS, Emacs will visit the file.
11042 With a double \\[universal-argument] \\[universal-argument] \
11043 prefix arg, Org tries to avoid opening in Emacs
11044 and to use an external application to visit the file.
11046 Optional LINE specifies a line to go to, optional SEARCH a string
11047 to search for. If LINE or SEARCH is given, the file will be
11048 opened in Emacs, unless an entry from org-file-apps that makes
11049 use of groups in a regexp matches.
11051 If you want to change the way frames are used when following a
11052 link, please customize `org-link-frame-setup'.
11054 If the file does not exist, an error is thrown."
11055 (let* ((file (if (equal path "")
11056 buffer-file-name
11057 (substitute-in-file-name (expand-file-name path))))
11058 (file-apps (append org-file-apps (org-default-apps)))
11059 (apps (org-remove-if
11060 'org-file-apps-entry-match-against-dlink-p file-apps))
11061 (apps-dlink (org-remove-if-not
11062 'org-file-apps-entry-match-against-dlink-p file-apps))
11063 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11064 (dirp (if remp nil (file-directory-p file)))
11065 (file (if (and dirp org-open-directory-means-index-dot-org)
11066 (concat (file-name-as-directory file) "index.org")
11067 file))
11068 (a-m-a-p (assq 'auto-mode apps))
11069 (dfile (downcase file))
11070 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11071 (link (cond ((and (eq line nil)
11072 (eq search nil))
11073 file)
11074 (line
11075 (concat file "::" (number-to-string line)))
11076 (search
11077 (concat file "::" search))))
11078 (dlink (downcase link))
11079 (old-buffer (current-buffer))
11080 (old-pos (point))
11081 (old-mode major-mode)
11082 ext cmd link-match-data)
11083 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11084 (setq ext (match-string 1 dfile))
11085 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11086 (setq ext (match-string 1 dfile))))
11087 (cond
11088 ((member in-emacs '((16) system))
11089 (setq cmd (cdr (assoc 'system apps))))
11090 (in-emacs (setq cmd 'emacs))
11092 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11093 (and dirp (cdr (assoc 'directory apps)))
11094 ; first, try matching against apps-dlink
11095 ; if we get a match here, store the match data for later
11096 (let ((match (assoc-default dlink apps-dlink
11097 'string-match)))
11098 (if match
11099 (progn (setq link-match-data (match-data))
11100 match)
11101 (progn (setq in-emacs (or in-emacs line search))
11102 nil))) ; if we have no match in apps-dlink,
11103 ; always open the file in emacs if line or search
11104 ; is given (for backwards compatibility)
11105 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11106 'string-match)
11107 (cdr (assoc ext apps))
11108 (cdr (assoc t apps))))))
11109 (when (eq cmd 'system)
11110 (setq cmd (cdr (assoc 'system apps))))
11111 (when (eq cmd 'default)
11112 (setq cmd (cdr (assoc t apps))))
11113 (when (eq cmd 'mailcap)
11114 (require 'mailcap)
11115 (mailcap-parse-mailcaps)
11116 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11117 (command (mailcap-mime-info mime-type)))
11118 (if (stringp command)
11119 (setq cmd command)
11120 (setq cmd 'emacs))))
11121 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11122 (not (file-exists-p file))
11123 (not org-open-non-existing-files))
11124 (user-error "No such file: %s" file))
11125 (cond
11126 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11127 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11128 (while (string-match "['\"]%s['\"]" cmd)
11129 (setq cmd (replace-match "%s" t t cmd)))
11130 (while (string-match "%s" cmd)
11131 (setq cmd (replace-match
11132 (save-match-data
11133 (shell-quote-argument
11134 (convert-standard-filename file)))
11135 t t cmd)))
11137 ;; Replace "%1", "%2" etc. in command with group matches from regex
11138 (save-match-data
11139 (let ((match-index 1)
11140 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11141 (set-match-data link-match-data)
11142 (while (<= match-index number-of-groups)
11143 (let ((regex (concat "%" (number-to-string match-index)))
11144 (replace-with (match-string match-index dlink)))
11145 (while (string-match regex cmd)
11146 (setq cmd (replace-match replace-with t t cmd))))
11147 (setq match-index (+ match-index 1)))))
11149 (save-window-excursion
11150 (message "Running %s...done" cmd)
11151 (start-process-shell-command cmd nil cmd)
11152 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11153 ((or (stringp cmd)
11154 (eq cmd 'emacs))
11155 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11156 (widen)
11157 (if line (org-goto-line line)
11158 (if search (org-link-search search))))
11159 ((consp cmd)
11160 (let ((file (convert-standard-filename file)))
11161 (save-match-data
11162 (set-match-data link-match-data)
11163 (eval cmd))))
11164 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11165 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11166 (or (not (equal old-buffer (current-buffer)))
11167 (not (equal old-pos (point))))
11168 (org-mark-ring-push old-pos old-buffer))))
11170 (defun org-file-apps-entry-match-against-dlink-p (entry)
11171 "This function returns non-nil if `entry' uses a regular
11172 expression which should be matched against the whole link by
11173 org-open-file.
11175 It assumes that is the case when the entry uses a regular
11176 expression which has at least one grouping construct and the
11177 action is either a lisp form or a command string containing
11178 '%1', i.e. using at least one subexpression match as a
11179 parameter."
11180 (let ((selector (car entry))
11181 (action (cdr entry)))
11182 (if (stringp selector)
11183 (and (> (regexp-opt-depth selector) 0)
11184 (or (and (stringp action)
11185 (string-match "%[0-9]" action))
11186 (consp action)))
11187 nil)))
11189 (defun org-default-apps ()
11190 "Return the default applications for this operating system."
11191 (cond
11192 ((eq system-type 'darwin)
11193 org-file-apps-defaults-macosx)
11194 ((eq system-type 'windows-nt)
11195 org-file-apps-defaults-windowsnt)
11196 (t org-file-apps-defaults-gnu)))
11198 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11199 "Convert extensions to regular expressions in the cars of LIST.
11200 Also, weed out any non-string entries, because the return value is used
11201 only for regexp matching.
11202 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11203 point to the symbol `emacs', indicating that the file should
11204 be opened in Emacs."
11205 (append
11206 (delq nil
11207 (mapcar (lambda (x)
11208 (if (not (stringp (car x)))
11210 (if (string-match "\\W" (car x))
11212 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11213 list))
11214 (if add-auto-mode
11215 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11217 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11218 (defun org-file-remote-p (file)
11219 "Test whether FILE specifies a location on a remote system.
11220 Return non-nil if the location is indeed remote.
11222 For example, the filename \"/user@host:/foo\" specifies a location
11223 on the system \"/user@host:\"."
11224 (cond ((fboundp 'file-remote-p)
11225 (file-remote-p file))
11226 ((fboundp 'tramp-handle-file-remote-p)
11227 (tramp-handle-file-remote-p file))
11228 ((and (boundp 'ange-ftp-name-format)
11229 (string-match (car ange-ftp-name-format) file))
11230 t)))
11233 ;;;; Refiling
11235 (defun org-get-org-file ()
11236 "Read a filename, with default directory `org-directory'."
11237 (let ((default (or org-default-notes-file remember-data-file)))
11238 (read-file-name (format "File name [%s]: " default)
11239 (file-name-as-directory org-directory)
11240 default)))
11242 (defun org-notes-order-reversed-p ()
11243 "Check if the current file should receive notes in reversed order."
11244 (cond
11245 ((not org-reverse-note-order) nil)
11246 ((eq t org-reverse-note-order) t)
11247 ((not (listp org-reverse-note-order)) nil)
11248 (t (catch 'exit
11249 (let ((all org-reverse-note-order)
11250 entry)
11251 (while (setq entry (pop all))
11252 (if (string-match (car entry) buffer-file-name)
11253 (throw 'exit (cdr entry))))
11254 nil)))))
11256 (defvar org-refile-target-table nil
11257 "The list of refile targets, created by `org-refile'.")
11259 (defvar org-agenda-new-buffers nil
11260 "Buffers created to visit agenda files.")
11262 (defvar org-refile-cache nil
11263 "Cache for refile targets.")
11265 (defvar org-refile-markers nil
11266 "All the markers used for caching refile locations.")
11268 (defun org-refile-marker (pos)
11269 "Get a new refile marker, but only if caching is in use."
11270 (if (not org-refile-use-cache)
11272 (let ((m (make-marker)))
11273 (move-marker m pos)
11274 (push m org-refile-markers)
11275 m)))
11277 (defun org-refile-cache-clear ()
11278 "Clear the refile cache and disable all the markers."
11279 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11280 (setq org-refile-markers nil)
11281 (setq org-refile-cache nil)
11282 (message "Refile cache has been cleared"))
11284 (defun org-refile-cache-check-set (set)
11285 "Check if all the markers in the cache still have live buffers."
11286 (let (marker)
11287 (catch 'exit
11288 (while (and set (setq marker (nth 3 (pop set))))
11289 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11290 (when (and marker (null (marker-buffer marker)))
11291 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11292 (sit-for 3)
11293 (throw 'exit nil)))
11294 t)))
11296 (defun org-refile-cache-put (set &rest identifiers)
11297 "Push the refile targets SET into the cache, under IDENTIFIERS."
11298 (let* ((key (sha1 (prin1-to-string identifiers)))
11299 (entry (assoc key org-refile-cache)))
11300 (if entry
11301 (setcdr entry set)
11302 (push (cons key set) org-refile-cache))))
11304 (defun org-refile-cache-get (&rest identifiers)
11305 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11306 (cond
11307 ((not org-refile-cache) nil)
11308 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11310 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11311 org-refile-cache))))
11312 (and set (org-refile-cache-check-set set) set)))))
11314 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11315 "Produce a table with refile targets."
11316 (let ((case-fold-search nil)
11317 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11318 (entries (or org-refile-targets '((nil . (:level . 1)))))
11319 targets tgs txt re files f desc descre fast-path-p level pos0)
11320 (message "Getting targets...")
11321 (with-current-buffer (or default-buffer (current-buffer))
11322 (while (setq entry (pop entries))
11323 (setq files (car entry) desc (cdr entry))
11324 (setq fast-path-p nil)
11325 (cond
11326 ((null files) (setq files (list (current-buffer))))
11327 ((eq files 'org-agenda-files)
11328 (setq files (org-agenda-files 'unrestricted)))
11329 ((and (symbolp files) (fboundp files))
11330 (setq files (funcall files)))
11331 ((and (symbolp files) (boundp files))
11332 (setq files (symbol-value files))))
11333 (if (stringp files) (setq files (list files)))
11334 (cond
11335 ((eq (car desc) :tag)
11336 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11337 ((eq (car desc) :todo)
11338 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11339 ((eq (car desc) :regexp)
11340 (setq descre (cdr desc)))
11341 ((eq (car desc) :level)
11342 (setq descre (concat "^\\*\\{" (number-to-string
11343 (if org-odd-levels-only
11344 (1- (* 2 (cdr desc)))
11345 (cdr desc)))
11346 "\\}[ \t]")))
11347 ((eq (car desc) :maxlevel)
11348 (setq fast-path-p t)
11349 (setq descre (concat "^\\*\\{1," (number-to-string
11350 (if org-odd-levels-only
11351 (1- (* 2 (cdr desc)))
11352 (cdr desc)))
11353 "\\}[ \t]")))
11354 (t (error "Bad refiling target description %s" desc)))
11355 (while (setq f (pop files))
11356 (with-current-buffer
11357 (if (bufferp f) f (org-get-agenda-file-buffer f))
11359 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11360 (progn
11361 (if (bufferp f) (setq f (buffer-file-name
11362 (buffer-base-buffer f))))
11363 (setq f (and f (expand-file-name f)))
11364 (if (eq org-refile-use-outline-path 'file)
11365 (push (list (file-name-nondirectory f) f nil nil) tgs))
11366 (save-excursion
11367 (save-restriction
11368 (widen)
11369 (goto-char (point-min))
11370 (while (re-search-forward descre nil t)
11371 (goto-char (setq pos0 (point-at-bol)))
11372 (catch 'next
11373 (when org-refile-target-verify-function
11374 (save-match-data
11375 (or (funcall org-refile-target-verify-function)
11376 (throw 'next t))))
11377 (when (and (looking-at org-complex-heading-regexp)
11378 (not (member (match-string 4) excluded-entries))
11379 (match-string 4))
11380 (setq level (org-reduced-level
11381 (- (match-end 1) (match-beginning 1)))
11382 txt (org-link-display-format (match-string 4))
11383 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11384 re (format org-complex-heading-regexp-format
11385 (regexp-quote (match-string 4))))
11386 (when org-refile-use-outline-path
11387 (setq txt (mapconcat
11388 'org-protect-slash
11389 (append
11390 (if (eq org-refile-use-outline-path
11391 'file)
11392 (list (file-name-nondirectory
11393 (buffer-file-name
11394 (buffer-base-buffer))))
11395 (if (eq org-refile-use-outline-path
11396 'full-file-path)
11397 (list (buffer-file-name
11398 (buffer-base-buffer)))))
11399 (org-get-outline-path fast-path-p
11400 level txt)
11401 (list txt))
11402 "/")))
11403 (push (list txt f re (org-refile-marker (point)))
11404 tgs)))
11405 (when (= (point) pos0)
11406 ;; verification function has not moved point
11407 (goto-char (point-at-eol))))))))
11408 (when org-refile-use-cache
11409 (org-refile-cache-put tgs (buffer-file-name) descre))
11410 (setq targets (append tgs targets))))))
11411 (message "Getting targets...done")
11412 (nreverse targets)))
11414 (defun org-protect-slash (s)
11415 (while (string-match "/" s)
11416 (setq s (replace-match "\\" t t s)))
11419 (defvar org-olpa (make-vector 20 nil))
11421 (defun org-get-outline-path (&optional fastp level heading)
11422 "Return the outline path to the current entry, as a list.
11424 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11425 routine which makes outline path derivations for an entire file,
11426 avoiding backtracing. Refile target collection makes use of that."
11427 (if fastp
11428 (progn
11429 (if (> level 19)
11430 (error "Outline path failure, more than 19 levels"))
11431 (loop for i from level upto 19 do
11432 (aset org-olpa i nil))
11433 (prog1
11434 (delq nil (append org-olpa nil))
11435 (aset org-olpa level heading)))
11436 (let (rtn case-fold-search)
11437 (save-excursion
11438 (save-restriction
11439 (widen)
11440 (while (org-up-heading-safe)
11441 (when (looking-at org-complex-heading-regexp)
11442 (push (org-trim
11443 (replace-regexp-in-string
11444 ;; Remove statistical/checkboxes cookies
11445 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11446 (org-match-string-no-properties 4)))
11447 rtn)))
11448 rtn)))))
11450 (defun org-format-outline-path (path &optional width prefix separator)
11451 "Format the outline path PATH for display.
11452 WIDTH is the maximum number of characters that is available.
11453 PREFIX is a prefix to be included in the returned string,
11454 such as the file name.
11455 SEPARATOR is inserted between the different parts of the path,
11456 the default is \"/\"."
11457 (setq width (or width 79))
11458 (if prefix (setq width (- width (length prefix))))
11459 (if (not path)
11460 (or prefix "")
11461 (let* ((nsteps (length path))
11462 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11463 (maxwidth (if (<= total-width width)
11464 10000 ;; everything fits
11465 ;; we need to shorten the level headings
11466 (/ (- width nsteps) nsteps)))
11467 (org-odd-levels-only nil)
11468 (n 0)
11469 (total (1+ (length prefix))))
11470 (setq maxwidth (max maxwidth 10))
11471 (concat prefix
11472 (if prefix (or separator "/"))
11473 (mapconcat
11474 (lambda (h)
11475 (setq n (1+ n))
11476 (if (and (= n nsteps) (< maxwidth 10000))
11477 (setq maxwidth (- total-width total)))
11478 (if (< (length h) maxwidth)
11479 (progn (setq total (+ total (length h) 1)) h)
11480 (setq h (substring h 0 (- maxwidth 2))
11481 total (+ total maxwidth 1))
11482 (if (string-match "[ \t]+\\'" h)
11483 (setq h (substring h 0 (match-beginning 0))))
11484 (setq h (concat h "..")))
11485 (org-add-props h nil 'face
11486 (nth (% (1- n) org-n-level-faces)
11487 org-level-faces))
11489 path (or separator "/"))))))
11491 (defun org-display-outline-path (&optional file current separator just-return-string)
11492 "Display the current outline path in the echo area.
11494 If FILE is non-nil, prepend the output with the file name.
11495 If CURRENT is non-nil, append the current heading to the output.
11496 SEPARATOR is passed through to `org-format-outline-path'. It separates
11497 the different parts of the path and defaults to \"/\".
11498 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11499 (interactive "P")
11500 (let* (case-fold-search
11501 (bfn (buffer-file-name (buffer-base-buffer)))
11502 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11503 res)
11504 (if current (setq path (append path
11505 (save-excursion
11506 (org-back-to-heading t)
11507 (if (looking-at org-complex-heading-regexp)
11508 (list (match-string 4)))))))
11509 (setq res
11510 (org-format-outline-path
11511 path
11512 (1- (frame-width))
11513 (and file bfn (concat (file-name-nondirectory bfn) separator))
11514 separator))
11515 (if just-return-string
11516 (org-no-properties res)
11517 (org-unlogged-message "%s" res))))
11519 (defvar org-refile-history nil
11520 "History for refiling operations.")
11522 (defvar org-after-refile-insert-hook nil
11523 "Hook run after `org-refile' has inserted its stuff at the new location.
11524 Note that this is still *before* the stuff will be removed from
11525 the *old* location.")
11527 (defvar org-capture-last-stored-marker)
11528 (defvar org-refile-keep nil
11529 "Non-nil means `org-refile' will copy instead of refile.")
11531 (defun org-copy ()
11532 "Like `org-refile', but copy."
11533 (interactive)
11534 (let ((org-refile-keep t))
11535 (funcall 'org-refile nil nil nil "Copy")))
11537 (defun org-refile (&optional goto default-buffer rfloc msg)
11538 "Move the entry or entries at point to another heading.
11539 The list of target headings is compiled using the information in
11540 `org-refile-targets', which see.
11542 At the target location, the entry is filed as a subitem of the target
11543 heading. Depending on `org-reverse-note-order', the new subitem will
11544 either be the first or the last subitem.
11546 If there is an active region, all entries in that region will be moved.
11547 However, the region must fulfill the requirement that the first heading
11548 is the first one sets the top-level of the moved text - at most siblings
11549 below it are allowed.
11551 With prefix arg GOTO, the command will only visit the target location
11552 and not actually move anything.
11554 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11555 go to the location where the last refiling operation has put the subtree.
11557 With a numeric prefix argument of `2', refile to the running clock.
11559 With a numeric prefix argument of `3', emulate `org-refile-keep'
11560 being set to `t' and copy to the target location, don't move it.
11561 Beware that keeping refiled entries may result in duplicated ID
11562 properties.
11564 RFLOC can be a refile location obtained in a different way.
11566 MSG is a string to replace \"Refile\" in the default prompt with
11567 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11569 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11571 If you are using target caching (see `org-refile-use-cache'),
11572 you have to clear the target cache in order to find new targets.
11573 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11574 prefix argument (`C-u C-u C-u C-c C-w')."
11576 (interactive "P")
11577 (if (member goto '(0 (64)))
11578 (org-refile-cache-clear)
11579 (let* ((actionmsg (cond (msg msg)
11580 ((equal goto 3) "Refile (and keep)")
11581 (t "Refile")))
11582 (cbuf (current-buffer))
11583 (regionp (org-region-active-p))
11584 (region-start (and regionp (region-beginning)))
11585 (region-end (and regionp (region-end)))
11586 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11587 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11588 pos it nbuf file re level reversed)
11589 (setq last-command nil)
11590 (when regionp
11591 (goto-char region-start)
11592 (or (bolp) (goto-char (point-at-bol)))
11593 (setq region-start (point))
11594 (unless (or (org-kill-is-subtree-p
11595 (buffer-substring region-start region-end))
11596 (prog1 org-refile-active-region-within-subtree
11597 (let ((s (point-at-eol)))
11598 (org-toggle-heading)
11599 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11600 (user-error "The region is not a (sequence of) subtree(s)")))
11601 (if (equal goto '(16))
11602 (org-refile-goto-last-stored)
11603 (when (or
11604 (and (equal goto 2)
11605 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11606 (prog1
11607 (setq it (list (or org-clock-heading "running clock")
11608 (buffer-file-name
11609 (marker-buffer org-clock-hd-marker))
11611 (marker-position org-clock-hd-marker)))
11612 (setq goto nil)))
11613 (setq it (or rfloc
11614 (let (heading-text)
11615 (save-excursion
11616 (unless (and goto (listp goto))
11617 (org-back-to-heading t)
11618 (setq heading-text
11619 (nth 4 (org-heading-components))))
11621 (org-refile-get-location
11622 (cond ((and goto (listp goto)) "Goto")
11623 (regionp (concat actionmsg " region to"))
11624 (t (concat actionmsg " subtree \""
11625 heading-text "\" to")))
11626 default-buffer
11627 (and (not (equal '(4) goto))
11628 org-refile-allow-creating-parent-nodes)
11629 goto))))))
11630 (setq file (nth 1 it)
11631 re (nth 2 it)
11632 pos (nth 3 it))
11633 (if (and (not goto)
11635 (equal (buffer-file-name) file)
11636 (if regionp
11637 (and (>= pos region-start)
11638 (<= pos region-end))
11639 (and (>= pos (point))
11640 (< pos (save-excursion
11641 (org-end-of-subtree t t))))))
11642 (error "Cannot refile to position inside the tree or region"))
11644 (setq nbuf (or (find-buffer-visiting file)
11645 (find-file-noselect file)))
11646 (if (and goto (not (equal goto 3)))
11647 (progn
11648 (org-pop-to-buffer-same-window nbuf)
11649 (goto-char pos)
11650 (org-show-context 'org-goto))
11651 (if regionp
11652 (progn
11653 (org-kill-new (buffer-substring region-start region-end))
11654 (org-save-markers-in-region region-start region-end))
11655 (org-copy-subtree 1 nil t))
11656 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11657 (find-file-noselect file)))
11658 (setq reversed (org-notes-order-reversed-p))
11659 (save-excursion
11660 (save-restriction
11661 (widen)
11662 (if pos
11663 (progn
11664 (goto-char pos)
11665 (looking-at org-outline-regexp)
11666 (setq level (org-get-valid-level (funcall outline-level) 1))
11667 (goto-char
11668 (if reversed
11669 (or (outline-next-heading) (point-max))
11670 (or (save-excursion (org-get-next-sibling))
11671 (org-end-of-subtree t t)
11672 (point-max)))))
11673 (setq level 1)
11674 (if (not reversed)
11675 (goto-char (point-max))
11676 (goto-char (point-min))
11677 (or (outline-next-heading) (goto-char (point-max)))))
11678 (if (not (bolp)) (newline))
11679 (org-paste-subtree level)
11680 (when org-log-refile
11681 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11682 (unless (eq org-log-refile 'note)
11683 (save-excursion (org-add-log-note))))
11684 (and org-auto-align-tags
11685 (let ((org-loop-over-headlines-in-active-region nil))
11686 (org-set-tags nil t)))
11687 (let ((bookmark-name (plist-get org-bookmark-names-plist
11688 :last-refile)))
11689 (when bookmark-name
11690 (with-demoted-errors
11691 (bookmark-set bookmark-name))))
11692 ;; If we are refiling for capture, make sure that the
11693 ;; last-capture pointers point here
11694 (when (org-bound-and-true-p org-refile-for-capture)
11695 (let ((bookmark-name (plist-get org-bookmark-names-plist
11696 :last-capture-marker)))
11697 (when bookmark-name
11698 (with-demoted-errors
11699 (bookmark-set bookmark-name))))
11700 (move-marker org-capture-last-stored-marker (point)))
11701 (if (fboundp 'deactivate-mark) (deactivate-mark))
11702 (run-hooks 'org-after-refile-insert-hook))))
11703 (unless org-refile-keep
11704 (if regionp
11705 (delete-region (point) (+ (point) (- region-end region-start)))
11706 (delete-region
11707 (and (org-back-to-heading t) (point))
11708 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11709 (when (featurep 'org-inlinetask)
11710 (org-inlinetask-remove-END-maybe))
11711 (setq org-markers-to-move nil)
11712 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11714 (defun org-refile-goto-last-stored ()
11715 "Go to the location where the last refile was stored."
11716 (interactive)
11717 (bookmark-jump "org-refile-last-stored")
11718 (message "This is the location of the last refile"))
11720 (defun org-refile--get-location (refloc tbl)
11721 "When user refile to REFLOC, find the associated target in TBL.
11722 Also check `org-refile-target-table'."
11723 (car (delq
11725 (mapcar
11726 (lambda (r) (or (assoc r tbl)
11727 (assoc r org-refile-target-table)))
11728 (list (replace-regexp-in-string "/$" "" refloc)
11729 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11731 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11732 no-exclude)
11733 "Prompt the user for a refile location, using PROMPT.
11734 PROMPT should not be suffixed with a colon and a space, because
11735 this function appends the default value from
11736 `org-refile-history' automatically, if that is not empty.
11737 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11738 this is used for the GOTO interface."
11739 (let ((org-refile-targets org-refile-targets)
11740 (org-refile-use-outline-path org-refile-use-outline-path)
11741 excluded-entries)
11742 (when (and (derived-mode-p 'org-mode)
11743 (not org-refile-use-cache)
11744 (not no-exclude))
11745 (org-map-tree
11746 (lambda()
11747 (setq excluded-entries
11748 (append excluded-entries (list (org-get-heading t t)))))))
11749 (setq org-refile-target-table
11750 (org-refile-get-targets default-buffer excluded-entries)))
11751 (unless org-refile-target-table
11752 (user-error "No refile targets"))
11753 (let* ((cbuf (current-buffer))
11754 (partial-completion-mode nil)
11755 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11756 (cfunc (if (and org-refile-use-outline-path
11757 org-outline-path-complete-in-steps)
11758 'org-olpath-completing-read
11759 'org-icompleting-read))
11760 (extra (if org-refile-use-outline-path "/" ""))
11761 (cbnex (concat (buffer-name) extra))
11762 (filename (and cfn (expand-file-name cfn)))
11763 (tbl (mapcar
11764 (lambda (x)
11765 (if (and (not (member org-refile-use-outline-path
11766 '(file full-file-path)))
11767 (not (equal filename (nth 1 x))))
11768 (cons (concat (car x) extra " ("
11769 (file-name-nondirectory (nth 1 x)) ")")
11770 (cdr x))
11771 (cons (concat (car x) extra) (cdr x))))
11772 org-refile-target-table))
11773 (completion-ignore-case t)
11774 cdef
11775 (prompt (concat prompt
11776 (or (and (car org-refile-history)
11777 (concat " (default " (car org-refile-history) ")"))
11778 (and (assoc cbnex tbl) (setq cdef cbnex)
11779 (concat " (default " cbnex ")"))) ": "))
11780 pa answ parent-target child parent old-hist)
11781 (setq old-hist org-refile-history)
11782 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11783 nil 'org-refile-history (or cdef (car org-refile-history))))
11784 (if (setq pa (org-refile--get-location answ tbl))
11785 (progn
11786 (org-refile-check-position pa)
11787 (when (or (not org-refile-history)
11788 (not (eq old-hist org-refile-history))
11789 (not (equal (car pa) (car org-refile-history))))
11790 (setq org-refile-history
11791 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11792 org-refile-history
11793 (cdr org-refile-history))))
11794 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11795 (pop org-refile-history)))
11797 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11798 (progn
11799 (setq parent (match-string 1 answ)
11800 child (match-string 2 answ))
11801 (setq parent-target (org-refile--get-location parent tbl))
11802 (when (and parent-target
11803 (or (eq new-nodes t)
11804 (and (eq new-nodes 'confirm)
11805 (y-or-n-p (format "Create new node \"%s\"? "
11806 child)))))
11807 (org-refile-new-child parent-target child)))
11808 (user-error "Invalid target location")))))
11810 (declare-function org-string-nw-p "org-macs" (s))
11811 (defun org-refile-check-position (refile-pointer)
11812 "Check if the refile pointer matches the headline to which it points."
11813 (let* ((file (nth 1 refile-pointer))
11814 (re (nth 2 refile-pointer))
11815 (pos (nth 3 refile-pointer))
11816 buffer)
11817 (if (and (not (markerp pos)) (not file))
11818 (user-error "Please save the buffer to a file before refiling")
11819 (when (org-string-nw-p re)
11820 (setq buffer (if (markerp pos)
11821 (marker-buffer pos)
11822 (or (find-buffer-visiting file)
11823 (find-file-noselect file))))
11824 (with-current-buffer buffer
11825 (save-excursion
11826 (save-restriction
11827 (widen)
11828 (goto-char pos)
11829 (beginning-of-line 1)
11830 (unless (org-looking-at-p re)
11831 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11833 (defun org-refile-new-child (parent-target child)
11834 "Use refile target PARENT-TARGET to add new CHILD below it."
11835 (unless parent-target
11836 (error "Cannot find parent for new node"))
11837 (let ((file (nth 1 parent-target))
11838 (pos (nth 3 parent-target))
11839 level)
11840 (with-current-buffer (or (find-buffer-visiting file)
11841 (find-file-noselect file))
11842 (save-excursion
11843 (save-restriction
11844 (widen)
11845 (if pos
11846 (goto-char pos)
11847 (goto-char (point-max))
11848 (if (not (bolp)) (newline)))
11849 (when (looking-at org-outline-regexp)
11850 (setq level (funcall outline-level))
11851 (org-end-of-subtree t t))
11852 (org-back-over-empty-lines)
11853 (insert "\n" (make-string
11854 (if pos (org-get-valid-level level 1) 1) ?*)
11855 " " child "\n")
11856 (beginning-of-line 0)
11857 (list (concat (car parent-target) "/" child) file "" (point)))))))
11859 (defun org-olpath-completing-read (prompt collection &rest args)
11860 "Read an outline path like a file name."
11861 (let ((thetable collection)
11862 (org-completion-use-ido nil) ; does not work with ido.
11863 (org-completion-use-iswitchb nil)) ; or iswitchb
11864 (apply
11865 'org-icompleting-read prompt
11866 (lambda (string predicate &optional flag)
11867 (let (rtn r f (l (length string)))
11868 (cond
11869 ((eq flag nil)
11870 ;; try completion
11871 (try-completion string thetable))
11872 ((eq flag t)
11873 ;; all-completions
11874 (setq rtn (all-completions string thetable predicate))
11875 (mapcar
11876 (lambda (x)
11877 (setq r (substring x l))
11878 (if (string-match " ([^)]*)$" x)
11879 (setq f (match-string 0 x))
11880 (setq f ""))
11881 (if (string-match "/" r)
11882 (concat string (substring r 0 (match-end 0)) f)
11884 rtn))
11885 ((eq flag 'lambda)
11886 ;; exact match?
11887 (assoc string thetable)))))
11888 args)))
11890 ;;;; Dynamic blocks
11892 (defun org-find-dblock (name)
11893 "Find the first dynamic block with name NAME in the buffer.
11894 If not found, stay at current position and return nil."
11895 (let ((case-fold-search t) pos)
11896 (save-excursion
11897 (goto-char (point-min))
11898 (setq pos (and (re-search-forward
11899 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11900 (match-beginning 0))))
11901 (if pos (goto-char pos))
11902 pos))
11904 (defconst org-dblock-start-re
11905 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
11906 "Matches the start line of a dynamic block, with parameters.")
11908 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
11909 "Matches the end of a dynamic block.")
11911 (defun org-create-dblock (plist)
11912 "Create a dynamic block section, with parameters taken from PLIST.
11913 PLIST must contain a :name entry which is used as name of the block."
11914 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11915 (end-of-line 1)
11916 (newline))
11917 (let ((col (current-column))
11918 (name (plist-get plist :name)))
11919 (insert "#+BEGIN: " name)
11920 (while plist
11921 (if (eq (car plist) :name)
11922 (setq plist (cddr plist))
11923 (insert " " (prin1-to-string (pop plist)))))
11924 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11925 (beginning-of-line -2)))
11927 (defun org-prepare-dblock ()
11928 "Prepare dynamic block for refresh.
11929 This empties the block, puts the cursor at the insert position and returns
11930 the property list including an extra property :name with the block name."
11931 (unless (looking-at org-dblock-start-re)
11932 (user-error "Not at a dynamic block"))
11933 (let* ((begdel (1+ (match-end 0)))
11934 (name (org-no-properties (match-string 1)))
11935 (params (append (list :name name)
11936 (read (concat "(" (match-string 3) ")")))))
11937 (save-excursion
11938 (beginning-of-line 1)
11939 (skip-chars-forward " \t")
11940 (setq params (plist-put params :indentation-column (current-column))))
11941 (unless (re-search-forward org-dblock-end-re nil t)
11942 (error "Dynamic block not terminated"))
11943 (setq params
11944 (append params
11945 (list :content (buffer-substring
11946 begdel (match-beginning 0)))))
11947 (delete-region begdel (match-beginning 0))
11948 (goto-char begdel)
11949 (open-line 1)
11950 params))
11952 (defun org-map-dblocks (&optional command)
11953 "Apply COMMAND to all dynamic blocks in the current buffer.
11954 If COMMAND is not given, use `org-update-dblock'."
11955 (let ((cmd (or command 'org-update-dblock)))
11956 (save-excursion
11957 (goto-char (point-min))
11958 (while (re-search-forward org-dblock-start-re nil t)
11959 (goto-char (match-beginning 0))
11960 (save-excursion
11961 (condition-case nil
11962 (funcall cmd)
11963 (error (message "Error during update of dynamic block"))))
11964 (unless (re-search-forward org-dblock-end-re nil t)
11965 (error "Dynamic block not terminated"))))))
11967 (defun org-dblock-update (&optional arg)
11968 "User command for updating dynamic blocks.
11969 Update the dynamic block at point. With prefix ARG, update all dynamic
11970 blocks in the buffer."
11971 (interactive "P")
11972 (if arg
11973 (org-update-all-dblocks)
11974 (or (looking-at org-dblock-start-re)
11975 (org-beginning-of-dblock))
11976 (org-update-dblock)))
11978 (defun org-update-dblock ()
11979 "Update the dynamic block at point.
11980 This means to empty the block, parse for parameters and then call
11981 the correct writing function."
11982 (interactive)
11983 (save-excursion
11984 (let* ((win (selected-window))
11985 (pos (point))
11986 (line (org-current-line))
11987 (params (org-prepare-dblock))
11988 (name (plist-get params :name))
11989 (indent (plist-get params :indentation-column))
11990 (cmd (intern (concat "org-dblock-write:" name))))
11991 (message "Updating dynamic block `%s' at line %d..." name line)
11992 (funcall cmd params)
11993 (message "Updating dynamic block `%s' at line %d...done" name line)
11994 (goto-char pos)
11995 (when (and indent (> indent 0))
11996 (setq indent (make-string indent ?\ ))
11997 (save-excursion
11998 (select-window win)
11999 (org-beginning-of-dblock)
12000 (forward-line 1)
12001 (while (not (looking-at org-dblock-end-re))
12002 (insert indent)
12003 (beginning-of-line 2))
12004 (when (looking-at org-dblock-end-re)
12005 (and (looking-at "[ \t]+")
12006 (replace-match ""))
12007 (insert indent)))))))
12009 (defun org-beginning-of-dblock ()
12010 "Find the beginning of the dynamic block at point.
12011 Error if there is no such block at point."
12012 (let ((pos (point))
12013 beg)
12014 (end-of-line 1)
12015 (if (and (re-search-backward org-dblock-start-re nil t)
12016 (setq beg (match-beginning 0))
12017 (re-search-forward org-dblock-end-re nil t)
12018 (> (match-end 0) pos))
12019 (goto-char beg)
12020 (goto-char pos)
12021 (error "Not in a dynamic block"))))
12023 (defun org-update-all-dblocks ()
12024 "Update all dynamic blocks in the buffer.
12025 This function can be used in a hook."
12026 (interactive)
12027 (when (derived-mode-p 'org-mode)
12028 (org-map-dblocks 'org-update-dblock)))
12031 ;;;; Completion
12033 (declare-function org-export-backend-name "org-export" (cl-x))
12034 (declare-function org-export-backend-options "org-export" (cl-x))
12035 (defun org-get-export-keywords ()
12036 "Return a list of all currently understood export keywords.
12037 Export keywords include options, block names, attributes and
12038 keywords relative to each registered export back-end."
12039 (let (keywords)
12040 (dolist (backend
12041 (org-bound-and-true-p org-export--registered-backends)
12042 (delq nil keywords))
12043 ;; Back-end name (for keywords, like #+LATEX:)
12044 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12045 (dolist (option-entry (org-export-backend-options backend))
12046 ;; Back-end options.
12047 (push (nth 1 option-entry) keywords)))))
12049 (defconst org-options-keywords
12050 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12051 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12052 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12053 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12054 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12056 (defcustom org-structure-template-alist
12057 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
12058 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
12059 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
12060 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
12061 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
12062 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
12063 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
12064 "<literal style=\"latex\">\n?\n</literal>")
12065 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
12066 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
12067 "<literal style=\"html\">\n?\n</literal>")
12068 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
12069 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
12070 ("A" "#+ASCII: " "")
12071 ("i" "#+INDEX: ?" "#+INDEX: ?")
12072 ("I" "#+INCLUDE: %file ?"
12073 "<include file=%file markup=\"?\">"))
12074 "Structure completion elements.
12075 This is a list of abbreviation keys and values. The value gets inserted
12076 if you type `<' followed by the key and then press the completion key,
12077 usually `M-TAB'. %file will be replaced by a file name after prompting
12078 for the file using completion. The cursor will be placed at the position
12079 of the `?` in the template.
12080 There are two templates for each key, the first uses the original Org syntax,
12081 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12082 the default when the /org-mtags.el/ module has been loaded. See also the
12083 variable `org-mtags-prefer-muse-templates'."
12084 :group 'org-completion
12085 :type '(repeat
12086 (list
12087 (string :tag "Key")
12088 (string :tag "Template")
12089 (string :tag "Muse Template"))))
12091 (defun org-try-structure-completion ()
12092 "Try to complete a structure template before point.
12093 This looks for strings like \"<e\" on an otherwise empty line and
12094 expands them."
12095 (let ((l (buffer-substring (point-at-bol) (point)))
12097 (when (and (looking-at "[ \t]*$")
12098 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12099 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12100 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12101 (match-beginning 1)) a)
12102 t)))
12104 (defun org-complete-expand-structure-template (start cell)
12105 "Expand a structure template."
12106 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12107 (rpl (nth (if musep 2 1) cell))
12108 (ind ""))
12109 (delete-region start (point))
12110 (when (string-match "\\`#\\+" rpl)
12111 (cond
12112 ((bolp))
12113 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12114 (setq ind (buffer-substring (point-at-bol) (point))))
12115 (t (newline))))
12116 (setq start (point))
12117 (if (string-match "%file" rpl)
12118 (setq rpl (replace-match
12119 (concat
12120 "\""
12121 (save-match-data
12122 (abbreviate-file-name (read-file-name "Include file: ")))
12123 "\"")
12124 t t rpl)))
12125 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12126 (concat "\n" ind)))
12127 (insert rpl)
12128 (if (re-search-backward "\\?" start t) (delete-char 1))))
12130 ;;;; TODO, DEADLINE, Comments
12132 (defun org-toggle-comment ()
12133 "Change the COMMENT state of an entry."
12134 (interactive)
12135 (save-excursion
12136 (org-back-to-heading)
12137 (let (case-fold-search)
12138 (cond
12139 ((looking-at (format org-heading-keyword-regexp-format
12140 org-comment-string))
12141 (goto-char (match-end 1))
12142 (looking-at (concat " +" org-comment-string))
12143 (replace-match "" t t)
12144 (when (eolp) (insert " ")))
12145 ((looking-at org-outline-regexp)
12146 (goto-char (match-end 0))
12147 (insert org-comment-string " "))))))
12149 (defvar org-last-todo-state-is-todo nil
12150 "This is non-nil when the last TODO state change led to a TODO state.
12151 If the last change removed the TODO tag or switched to DONE, then
12152 this is nil.")
12154 (defvar org-setting-tags nil) ; dynamically skipped
12156 (defvar org-todo-setup-filter-hook nil
12157 "Hook for functions that pre-filter todo specs.
12158 Each function takes a todo spec and returns either nil or the spec
12159 transformed into canonical form." )
12161 (defvar org-todo-get-default-hook nil
12162 "Hook for functions that get a default item for todo.
12163 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12164 nil or a string to be used for the todo mark." )
12166 (defvar org-agenda-headline-snapshot-before-repeat)
12168 (defun org-current-effective-time ()
12169 "Return current time adjusted for `org-extend-today-until' variable."
12170 (let* ((ct (org-current-time))
12171 (dct (decode-time ct))
12172 (ct1
12173 (cond
12174 (org-use-last-clock-out-time-as-effective-time
12175 (or (org-clock-get-last-clock-out-time) ct))
12176 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12177 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12178 (t ct))))
12179 ct1))
12181 (defun org-todo-yesterday (&optional arg)
12182 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12183 (interactive "P")
12184 (if (eq major-mode 'org-agenda-mode)
12185 (apply 'org-agenda-todo-yesterday arg)
12186 (let* ((hour (third (decode-time
12187 (org-current-time))))
12188 (org-extend-today-until (1+ hour)))
12189 (org-todo arg))))
12191 (defvar org-block-entry-blocking ""
12192 "First entry preventing the TODO state change.")
12194 (defun org-todo (&optional arg)
12195 "Change the TODO state of an item.
12196 The state of an item is given by a keyword at the start of the heading,
12197 like
12198 *** TODO Write paper
12199 *** DONE Call mom
12201 The different keywords are specified in the variable `org-todo-keywords'.
12202 By default the available states are \"TODO\" and \"DONE\".
12203 So for this example: when the item starts with TODO, it is changed to DONE.
12204 When it starts with DONE, the DONE is removed. And when neither TODO nor
12205 DONE are present, add TODO at the beginning of the heading.
12207 With \\[universal-argument] prefix arg, use completion to determine the new \
12208 state.
12209 With numeric prefix arg, switch to that state.
12210 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12211 keywords (nextset).
12212 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12213 With a numeric prefix arg of 0, inhibit note taking for the change.
12215 For calling through lisp, arg is also interpreted in the following way:
12216 'none -> empty state
12217 \"\"(empty string) -> switch to empty state
12218 'done -> switch to DONE
12219 'nextset -> switch to the next set of keywords
12220 'previousset -> switch to the previous set of keywords
12221 \"WAITING\" -> switch to the specified keyword, but only if it
12222 really is a member of `org-todo-keywords'."
12223 (interactive "P")
12224 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12225 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12226 'region-start-level 'region))
12227 org-loop-over-headlines-in-active-region)
12228 (org-map-entries
12229 `(org-todo ,arg)
12230 org-loop-over-headlines-in-active-region
12231 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12232 (if (equal arg '(16)) (setq arg 'nextset))
12233 (let ((org-blocker-hook org-blocker-hook)
12234 commentp
12235 case-fold-search)
12236 (when (equal arg '(64))
12237 (setq arg nil org-blocker-hook nil))
12238 (when (and org-blocker-hook
12239 (or org-inhibit-blocking
12240 (org-entry-get nil "NOBLOCKING")))
12241 (setq org-blocker-hook nil))
12242 (save-excursion
12243 (catch 'exit
12244 (org-back-to-heading t)
12245 (when (looking-at (concat "^\\*+ " org-comment-string))
12246 (org-toggle-comment)
12247 (setq commentp t))
12248 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12249 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12250 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12251 (let* ((match-data (match-data))
12252 (startpos (point-at-bol))
12253 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12254 (org-log-done org-log-done)
12255 (org-log-repeat org-log-repeat)
12256 (org-todo-log-states org-todo-log-states)
12257 (org-inhibit-logging
12258 (if (equal arg 0)
12259 (progn (setq arg nil) 'note) org-inhibit-logging))
12260 (this (match-string 1))
12261 (hl-pos (match-beginning 0))
12262 (head (org-get-todo-sequence-head this))
12263 (ass (assoc head org-todo-kwd-alist))
12264 (interpret (nth 1 ass))
12265 (done-word (nth 3 ass))
12266 (final-done-word (nth 4 ass))
12267 (org-last-state (or this ""))
12268 (completion-ignore-case t)
12269 (member (member this org-todo-keywords-1))
12270 (tail (cdr member))
12271 (org-state (cond
12272 ((and org-todo-key-trigger
12273 (or (and (equal arg '(4))
12274 (eq org-use-fast-todo-selection 'prefix))
12275 (and (not arg) org-use-fast-todo-selection
12276 (not (eq org-use-fast-todo-selection
12277 'prefix)))))
12278 ;; Use fast selection
12279 (org-fast-todo-selection))
12280 ((and (equal arg '(4))
12281 (or (not org-use-fast-todo-selection)
12282 (not org-todo-key-trigger)))
12283 ;; Read a state with completion
12284 (org-icompleting-read
12285 "State: " (mapcar 'list org-todo-keywords-1)
12286 nil t))
12287 ((eq arg 'right)
12288 (if this
12289 (if tail (car tail) nil)
12290 (car org-todo-keywords-1)))
12291 ((eq arg 'left)
12292 (if (equal member org-todo-keywords-1)
12294 (if this
12295 (nth (- (length org-todo-keywords-1)
12296 (length tail) 2)
12297 org-todo-keywords-1)
12298 (org-last org-todo-keywords-1))))
12299 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12300 (setq arg nil))) ; hack to fall back to cycling
12301 (arg
12302 ;; user or caller requests a specific state
12303 (cond
12304 ((equal arg "") nil)
12305 ((eq arg 'none) nil)
12306 ((eq arg 'done) (or done-word (car org-done-keywords)))
12307 ((eq arg 'nextset)
12308 (or (car (cdr (member head org-todo-heads)))
12309 (car org-todo-heads)))
12310 ((eq arg 'previousset)
12311 (let ((org-todo-heads (reverse org-todo-heads)))
12312 (or (car (cdr (member head org-todo-heads)))
12313 (car org-todo-heads))))
12314 ((car (member arg org-todo-keywords-1)))
12315 ((stringp arg)
12316 (user-error "State `%s' not valid in this file" arg))
12317 ((nth (1- (prefix-numeric-value arg))
12318 org-todo-keywords-1))))
12319 ((null member) (or head (car org-todo-keywords-1)))
12320 ((equal this final-done-word) nil) ;; -> make empty
12321 ((null tail) nil) ;; -> first entry
12322 ((memq interpret '(type priority))
12323 (if (eq this-command last-command)
12324 (car tail)
12325 (if (> (length tail) 0)
12326 (or done-word (car org-done-keywords))
12327 nil)))
12329 (car tail))))
12330 (org-state (or
12331 (run-hook-with-args-until-success
12332 'org-todo-get-default-hook org-state org-last-state)
12333 org-state))
12334 (next (if org-state (concat " " org-state " ") " "))
12335 (change-plist (list :type 'todo-state-change :from this :to org-state
12336 :position startpos))
12337 dolog now-done-p)
12338 (when org-blocker-hook
12339 (setq org-last-todo-state-is-todo
12340 (not (member this org-done-keywords)))
12341 (unless (save-excursion
12342 (save-match-data
12343 (org-with-wide-buffer
12344 (run-hook-with-args-until-failure
12345 'org-blocker-hook change-plist))))
12346 (if (org-called-interactively-p 'interactive)
12347 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12348 this org-state org-block-entry-blocking)
12349 ;; fail silently
12350 (message "TODO state change from %s to %s blocked (by \"%s\")"
12351 this org-state org-block-entry-blocking)
12352 (throw 'exit nil))))
12353 (store-match-data match-data)
12354 (replace-match next t t)
12355 (unless (pos-visible-in-window-p hl-pos)
12356 (message "TODO state changed to %s" (org-trim next)))
12357 (unless head
12358 (setq head (org-get-todo-sequence-head org-state)
12359 ass (assoc head org-todo-kwd-alist)
12360 interpret (nth 1 ass)
12361 done-word (nth 3 ass)
12362 final-done-word (nth 4 ass)))
12363 (when (memq arg '(nextset previousset))
12364 (message "Keyword-Set %d/%d: %s"
12365 (- (length org-todo-sets) -1
12366 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12367 (length org-todo-sets)
12368 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12369 (setq org-last-todo-state-is-todo
12370 (not (member org-state org-done-keywords)))
12371 (setq now-done-p (and (member org-state org-done-keywords)
12372 (not (member this org-done-keywords))))
12373 (and logging (org-local-logging logging))
12374 (when (and (or org-todo-log-states org-log-done)
12375 (not (eq org-inhibit-logging t))
12376 (not (memq arg '(nextset previousset))))
12377 ;; we need to look at recording a time and note
12378 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12379 (nth 2 (assoc this org-todo-log-states))))
12380 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12381 (setq dolog 'time))
12382 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12383 (and org-state
12384 (member org-state org-not-done-keywords)
12385 (not (member this org-not-done-keywords))))
12386 ;; This is now a todo state and was not one before
12387 ;; If there was a CLOSED time stamp, get rid of it.
12388 (org-add-planning-info nil nil 'closed))
12389 (when (and now-done-p org-log-done)
12390 ;; It is now done, and it was not done before
12391 (org-add-planning-info 'closed (org-current-effective-time))
12392 (if (and (not dolog) (eq 'note org-log-done))
12393 (org-add-log-setup 'done org-state this 'findpos 'note)))
12394 (when (and org-state dolog)
12395 ;; This is a non-nil state, and we need to log it
12396 (org-add-log-setup 'state org-state this 'findpos dolog)))
12397 ;; Fixup tag positioning
12398 (org-todo-trigger-tag-changes org-state)
12399 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12400 (when org-provide-todo-statistics
12401 (org-update-parent-todo-statistics))
12402 (run-hooks 'org-after-todo-state-change-hook)
12403 (if (and arg (not (member org-state org-done-keywords)))
12404 (setq head (org-get-todo-sequence-head org-state)))
12405 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12406 ;; Do we need to trigger a repeat?
12407 (when now-done-p
12408 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12409 ;; This is for the agenda, take a snapshot of the headline.
12410 (save-match-data
12411 (setq org-agenda-headline-snapshot-before-repeat
12412 (org-get-heading))))
12413 (org-auto-repeat-maybe org-state))
12414 ;; Fixup cursor location if close to the keyword
12415 (if (and (outline-on-heading-p)
12416 (not (bolp))
12417 (save-excursion (beginning-of-line 1)
12418 (looking-at org-todo-line-regexp))
12419 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12420 (progn
12421 (goto-char (or (match-end 2) (match-end 1)))
12422 (and (looking-at " ") (just-one-space))))
12423 (when org-trigger-hook
12424 (save-excursion
12425 (run-hook-with-args 'org-trigger-hook change-plist)))
12426 (when commentp (org-toggle-comment))))))))
12428 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12429 "Block turning an entry into a TODO, using the hierarchy.
12430 This checks whether the current task should be blocked from state
12431 changes. Such blocking occurs when:
12433 1. The task has children which are not all in a completed state.
12435 2. A task has a parent with the property :ORDERED:, and there
12436 are siblings prior to the current task with incomplete
12437 status.
12439 3. The parent of the task is blocked because it has siblings that should
12440 be done first, or is child of a block grandparent TODO entry."
12442 (if (not org-enforce-todo-dependencies)
12443 t ; if locally turned off don't block
12444 (catch 'dont-block
12445 ;; If this is not a todo state change, or if this entry is already DONE,
12446 ;; do not block
12447 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12448 (member (plist-get change-plist :from)
12449 (cons 'done org-done-keywords))
12450 (member (plist-get change-plist :to)
12451 (cons 'todo org-not-done-keywords))
12452 (not (plist-get change-plist :to)))
12453 (throw 'dont-block t))
12454 ;; If this task has children, and any are undone, it's blocked
12455 (save-excursion
12456 (org-back-to-heading t)
12457 (let ((this-level (funcall outline-level)))
12458 (outline-next-heading)
12459 (let ((child-level (funcall outline-level)))
12460 (while (and (not (eobp))
12461 (> child-level this-level))
12462 ;; this todo has children, check whether they are all
12463 ;; completed
12464 (if (and (not (org-entry-is-done-p))
12465 (org-entry-is-todo-p))
12466 (progn (setq org-block-entry-blocking (org-get-heading))
12467 (throw 'dont-block nil)))
12468 (outline-next-heading)
12469 (setq child-level (funcall outline-level))))))
12470 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12471 ;; any previous siblings are undone, it's blocked
12472 (save-excursion
12473 (org-back-to-heading t)
12474 (let* ((pos (point))
12475 (parent-pos (and (org-up-heading-safe) (point))))
12476 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12477 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12478 (forward-line 1)
12479 (re-search-forward org-not-done-heading-regexp pos t))
12480 (setq org-block-entry-blocking (match-string 0))
12481 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12482 ;; Search further up the hierarchy, to see if an ancestor is blocked
12483 (while t
12484 (goto-char parent-pos)
12485 (if (not (looking-at org-not-done-heading-regexp))
12486 (throw 'dont-block t)) ; do not block, parent is not a TODO
12487 (setq pos (point))
12488 (setq parent-pos (and (org-up-heading-safe) (point)))
12489 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12490 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12491 (forward-line 1)
12492 (re-search-forward org-not-done-heading-regexp pos t)
12493 (setq org-block-entry-blocking (org-get-heading)))
12494 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12496 (defcustom org-track-ordered-property-with-tag nil
12497 "Should the ORDERED property also be shown as a tag?
12498 The ORDERED property decides if an entry should require subtasks to be
12499 completed in sequence. Since a property is not very visible, setting
12500 this option means that toggling the ORDERED property with the command
12501 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12502 not relevant for the behavior, but it makes things more visible.
12504 Note that toggling the tag with tags commands will not change the property
12505 and therefore not influence behavior!
12507 This can be t, meaning the tag ORDERED should be used, It can also be a
12508 string to select a different tag for this task."
12509 :group 'org-todo
12510 :type '(choice
12511 (const :tag "No tracking" nil)
12512 (const :tag "Track with ORDERED tag" t)
12513 (string :tag "Use other tag")))
12515 (defun org-toggle-ordered-property ()
12516 "Toggle the ORDERED property of the current entry.
12517 For better visibility, you can track the value of this property with a tag.
12518 See variable `org-track-ordered-property-with-tag'."
12519 (interactive)
12520 (let* ((t1 org-track-ordered-property-with-tag)
12521 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12522 (save-excursion
12523 (org-back-to-heading)
12524 (if (org-entry-get nil "ORDERED")
12525 (progn
12526 (org-delete-property "ORDERED" "PROPERTIES")
12527 (and tag (org-toggle-tag tag 'off))
12528 (message "Subtasks can be completed in arbitrary order"))
12529 (org-entry-put nil "ORDERED" "t")
12530 (and tag (org-toggle-tag tag 'on))
12531 (message "Subtasks must be completed in sequence")))))
12533 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12534 (defun org-block-todo-from-checkboxes (change-plist)
12535 "Block turning an entry into a TODO, using checkboxes.
12536 This checks whether the current task should be blocked from state
12537 changes because there are unchecked boxes in this entry."
12538 (if (not org-enforce-todo-checkbox-dependencies)
12539 t ; if locally turned off don't block
12540 (catch 'dont-block
12541 ;; If this is not a todo state change, or if this entry is already DONE,
12542 ;; do not block
12543 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12544 (member (plist-get change-plist :from)
12545 (cons 'done org-done-keywords))
12546 (member (plist-get change-plist :to)
12547 (cons 'todo org-not-done-keywords))
12548 (not (plist-get change-plist :to)))
12549 (throw 'dont-block t))
12550 ;; If this task has checkboxes that are not checked, it's blocked
12551 (save-excursion
12552 (org-back-to-heading t)
12553 (let ((beg (point)) end)
12554 (outline-next-heading)
12555 (setq end (point))
12556 (goto-char beg)
12557 (if (org-list-search-forward
12558 (concat (org-item-beginning-re)
12559 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12560 "\\[[- ]\\]")
12561 end t)
12562 (progn
12563 (if (boundp 'org-blocked-by-checkboxes)
12564 (setq org-blocked-by-checkboxes t))
12565 (throw 'dont-block nil)))))
12566 t))) ; do not block
12568 (defun org-entry-blocked-p ()
12569 "Is the current entry blocked?"
12570 (org-with-silent-modifications
12571 (if (org-entry-get nil "NOBLOCKING")
12572 nil ;; Never block this entry
12573 (not (run-hook-with-args-until-failure
12574 'org-blocker-hook
12575 (list :type 'todo-state-change
12576 :position (point)
12577 :from 'todo
12578 :to 'done))))))
12580 (defun org-update-statistics-cookies (all)
12581 "Update the statistics cookie, either from TODO or from checkboxes.
12582 This should be called with the cursor in a line with a statistics cookie."
12583 (interactive "P")
12584 (if all
12585 (progn
12586 (org-update-checkbox-count 'all)
12587 (org-map-entries 'org-update-parent-todo-statistics))
12588 (if (not (org-at-heading-p))
12589 (org-update-checkbox-count)
12590 (let ((pos (point-marker))
12591 end l1 l2)
12592 (ignore-errors (org-back-to-heading t))
12593 (if (not (org-at-heading-p))
12594 (org-update-checkbox-count)
12595 (setq l1 (org-outline-level))
12596 (setq end (save-excursion
12597 (outline-next-heading)
12598 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12599 (point)))
12600 (if (and (save-excursion
12601 (re-search-forward
12602 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12603 (not (save-excursion (re-search-forward
12604 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12605 (org-update-checkbox-count)
12606 (if (and l2 (> l2 l1))
12607 (progn
12608 (goto-char end)
12609 (org-update-parent-todo-statistics))
12610 (goto-char pos)
12611 (beginning-of-line 1)
12612 (while (re-search-forward
12613 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12614 (point-at-eol) t)
12615 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12616 (goto-char pos)
12617 (move-marker pos nil)))))
12619 (defvar org-entry-property-inherited-from) ;; defined below
12620 (defun org-update-parent-todo-statistics ()
12621 "Update any statistics cookie in the parent of the current headline.
12622 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12623 the entire subtree and this will travel up the hierarchy and update
12624 statistics everywhere."
12625 (let* ((prop (save-excursion (org-up-heading-safe)
12626 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12627 (recursive (or (not org-hierarchical-todo-statistics)
12628 (and prop (string-match "\\<recursive\\>" prop))))
12629 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12631 (first t)
12632 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12633 level ltoggle l1 new ndel
12634 (cnt-all 0) (cnt-done 0) is-percent kwd
12635 checkbox-beg ov ovs ove cookie-present)
12636 (catch 'exit
12637 (save-excursion
12638 (beginning-of-line 1)
12639 (setq ltoggle (funcall outline-level))
12640 ;; Three situations are to consider:
12642 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12643 ;; to the top-level ancestor on the headline;
12645 ;; 2. If parent has "recursive" property, repeat up to the
12646 ;; headline setting that property, taking inheritance into
12647 ;; account;
12649 ;; 3. Else, move up to direct parent and proceed only once.
12650 (while (and (setq level (org-up-heading-safe))
12651 (or recursive first)
12652 (>= (point) lim))
12653 (setq first nil cookie-present nil)
12654 (unless (and level
12655 (not (string-match
12656 "\\<checkbox\\>"
12657 (downcase (or (org-entry-get nil "COOKIE_DATA")
12658 "")))))
12659 (throw 'exit nil))
12660 (while (re-search-forward box-re (point-at-eol) t)
12661 (setq cnt-all 0 cnt-done 0 cookie-present t)
12662 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12663 (save-match-data
12664 (unless (outline-next-heading) (throw 'exit nil))
12665 (while (and (looking-at org-complex-heading-regexp)
12666 (> (setq l1 (length (match-string 1))) level))
12667 (setq kwd (and (or recursive (= l1 ltoggle))
12668 (match-string 2)))
12669 (if (or (eq org-provide-todo-statistics 'all-headlines)
12670 (and (listp org-provide-todo-statistics)
12671 (or (member kwd org-provide-todo-statistics)
12672 (member kwd org-done-keywords))))
12673 (setq cnt-all (1+ cnt-all))
12674 (if (eq org-provide-todo-statistics t)
12675 (and kwd (setq cnt-all (1+ cnt-all)))))
12676 (and (member kwd org-done-keywords)
12677 (setq cnt-done (1+ cnt-done)))
12678 (outline-next-heading)))
12679 (setq new
12680 (if is-percent
12681 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12682 (format "[%d/%d]" cnt-done cnt-all))
12683 ndel (- (match-end 0) checkbox-beg))
12684 ;; handle overlays when updating cookie from column view
12685 (when (setq ov (car (overlays-at checkbox-beg)))
12686 (setq ovs (overlay-start ov) ove (overlay-end ov))
12687 (delete-overlay ov))
12688 (goto-char checkbox-beg)
12689 (insert new)
12690 (delete-region (point) (+ (point) ndel))
12691 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12692 (when ov (move-overlay ov ovs ove)))
12693 (when cookie-present
12694 (run-hook-with-args 'org-after-todo-statistics-hook
12695 cnt-done (- cnt-all cnt-done))))))
12696 (run-hooks 'org-todo-statistics-hook)))
12698 (defvar org-after-todo-statistics-hook nil
12699 "Hook that is called after a TODO statistics cookie has been updated.
12700 Each function is called with two arguments: the number of not-done entries
12701 and the number of done entries.
12703 For example, the following function, when added to this hook, will switch
12704 an entry to DONE when all children are done, and back to TODO when new
12705 entries are set to a TODO status. Note that this hook is only called
12706 when there is a statistics cookie in the headline!
12708 (defun org-summary-todo (n-done n-not-done)
12709 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12710 (let (org-log-done org-log-states) ; turn off logging
12711 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12714 (defvar org-todo-statistics-hook nil
12715 "Hook that is run whenever Org thinks TODO statistics should be updated.
12716 This hook runs even if there is no statistics cookie present, in which case
12717 `org-after-todo-statistics-hook' would not run.")
12719 (defun org-todo-trigger-tag-changes (state)
12720 "Apply the changes defined in `org-todo-state-tags-triggers'."
12721 (let ((l org-todo-state-tags-triggers)
12722 changes)
12723 (when (or (not state) (equal state ""))
12724 (setq changes (append changes (cdr (assoc "" l)))))
12725 (when (and (stringp state) (> (length state) 0))
12726 (setq changes (append changes (cdr (assoc state l)))))
12727 (when (member state org-not-done-keywords)
12728 (setq changes (append changes (cdr (assoc 'todo l)))))
12729 (when (member state org-done-keywords)
12730 (setq changes (append changes (cdr (assoc 'done l)))))
12731 (dolist (c changes)
12732 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12734 (defun org-local-logging (value)
12735 "Get logging settings from a property VALUE."
12736 (let* (words w a)
12737 ;; directly set the variables, they are already local.
12738 (setq org-log-done nil
12739 org-log-repeat nil
12740 org-todo-log-states nil)
12741 (setq words (org-split-string value))
12742 (while (setq w (pop words))
12743 (cond
12744 ((setq a (assoc w org-startup-options))
12745 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12746 (set (nth 1 a) (nth 2 a))))
12747 ((setq a (org-extract-log-state-settings w))
12748 (and (member (car a) org-todo-keywords-1)
12749 (push a org-todo-log-states)))))))
12751 (defun org-get-todo-sequence-head (kwd)
12752 "Return the head of the TODO sequence to which KWD belongs.
12753 If KWD is not set, check if there is a text property remembering the
12754 right sequence."
12755 (let (p)
12756 (cond
12757 ((not kwd)
12758 (or (get-text-property (point-at-bol) 'org-todo-head)
12759 (progn
12760 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12761 nil (point-at-eol)))
12762 (get-text-property p 'org-todo-head))))
12763 ((not (member kwd org-todo-keywords-1))
12764 (car org-todo-keywords-1))
12765 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12767 (defun org-fast-todo-selection ()
12768 "Fast TODO keyword selection with single keys.
12769 Returns the new TODO keyword, or nil if no state change should occur."
12770 (let* ((fulltable org-todo-key-alist)
12771 (done-keywords org-done-keywords) ;; needed for the faces.
12772 (maxlen (apply 'max (mapcar
12773 (lambda (x)
12774 (if (stringp (car x)) (string-width (car x)) 0))
12775 fulltable)))
12776 (expert nil)
12777 (fwidth (+ maxlen 3 1 3))
12778 (ncol (/ (- (window-width) 4) fwidth))
12779 tg cnt e c tbl
12780 groups ingroup)
12781 (save-excursion
12782 (save-window-excursion
12783 (if expert
12784 (set-buffer (get-buffer-create " *Org todo*"))
12785 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12786 (erase-buffer)
12787 (org-set-local 'org-done-keywords done-keywords)
12788 (setq tbl fulltable cnt 0)
12789 (while (setq e (pop tbl))
12790 (cond
12791 ((equal e '(:startgroup))
12792 (push '() groups) (setq ingroup t)
12793 (when (not (= cnt 0))
12794 (setq cnt 0)
12795 (insert "\n"))
12796 (insert "{ "))
12797 ((equal e '(:endgroup))
12798 (setq ingroup nil cnt 0)
12799 (insert "}\n"))
12800 ((equal e '(:newline))
12801 (when (not (= cnt 0))
12802 (setq cnt 0)
12803 (insert "\n")
12804 (setq e (car tbl))
12805 (while (equal (car tbl) '(:newline))
12806 (insert "\n")
12807 (setq tbl (cdr tbl)))))
12809 (setq tg (car e) c (cdr e))
12810 (if ingroup (push tg (car groups)))
12811 (setq tg (org-add-props tg nil 'face
12812 (org-get-todo-face tg)))
12813 (if (and (= cnt 0) (not ingroup)) (insert " "))
12814 (insert "[" c "] " tg (make-string
12815 (- fwidth 4 (length tg)) ?\ ))
12816 (when (= (setq cnt (1+ cnt)) ncol)
12817 (insert "\n")
12818 (if ingroup (insert " "))
12819 (setq cnt 0)))))
12820 (insert "\n")
12821 (goto-char (point-min))
12822 (if (not expert) (org-fit-window-to-buffer))
12823 (message "[a-z..]:Set [SPC]:clear")
12824 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12825 (cond
12826 ((or (= c ?\C-g)
12827 (and (= c ?q) (not (rassoc c fulltable))))
12828 (setq quit-flag t))
12829 ((= c ?\ ) nil)
12830 ((setq e (rassoc c fulltable) tg (car e))
12832 (t (setq quit-flag t)))))))
12834 (defun org-entry-is-todo-p ()
12835 (member (org-get-todo-state) org-not-done-keywords))
12837 (defun org-entry-is-done-p ()
12838 (member (org-get-todo-state) org-done-keywords))
12840 (defun org-get-todo-state ()
12841 "Return the TODO keyword of the current subtree."
12842 (save-excursion
12843 (org-back-to-heading t)
12844 (and (looking-at org-todo-line-regexp)
12845 (match-end 2)
12846 (match-string 2))))
12848 (defun org-at-date-range-p (&optional inactive-ok)
12849 "Is the cursor inside a date range?"
12850 (interactive)
12851 (save-excursion
12852 (catch 'exit
12853 (let ((pos (point)))
12854 (skip-chars-backward "^[<\r\n")
12855 (skip-chars-backward "<[")
12856 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12857 (>= (match-end 0) pos)
12858 (throw 'exit t))
12859 (skip-chars-backward "^<[\r\n")
12860 (skip-chars-backward "<[")
12861 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12862 (>= (match-end 0) pos)
12863 (throw 'exit t)))
12864 nil)))
12866 (defun org-get-repeat (&optional tagline)
12867 "Check if there is a deadline/schedule with repeater in this entry."
12868 (save-match-data
12869 (save-excursion
12870 (org-back-to-heading t)
12871 (and (re-search-forward (if tagline
12872 (concat tagline "\\s-*" org-repeat-re)
12873 org-repeat-re)
12874 (org-entry-end-position) t)
12875 (match-string-no-properties 1)))))
12877 (defvar org-last-changed-timestamp)
12878 (defvar org-last-inserted-timestamp)
12879 (defvar org-log-post-message)
12880 (defvar org-log-note-purpose)
12881 (defvar org-log-note-how)
12882 (defvar org-log-note-extra)
12883 (defun org-auto-repeat-maybe (done-word)
12884 "Check if the current headline contains a repeated deadline/schedule.
12885 If yes, set TODO state back to what it was and change the base date
12886 of repeating deadline/scheduled time stamps to new date.
12887 This function is run automatically after each state change to a DONE state."
12888 ;; last-state is dynamically scoped into this function
12889 (let* ((repeat (org-get-repeat))
12890 (aa (assoc org-last-state org-todo-kwd-alist))
12891 (interpret (nth 1 aa))
12892 (head (nth 2 aa))
12893 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12894 (msg "Entry repeats: ")
12895 (org-log-done nil)
12896 (org-todo-log-states nil)
12897 re type n what ts time to-state)
12898 (when repeat
12899 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12900 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12901 org-todo-repeat-to-state))
12902 (unless (and to-state (member to-state org-todo-keywords-1))
12903 (setq to-state (if (eq interpret 'type) org-last-state head)))
12904 (org-todo to-state)
12905 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12906 (org-entry-put nil "LAST_REPEAT" (format-time-string
12907 (org-time-stamp-format t t))))
12908 (when org-log-repeat
12909 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12910 (memq 'org-add-log-note post-command-hook))
12911 ;; OK, we are already setup for some record
12912 (if (eq org-log-repeat 'note)
12913 ;; make sure we take a note, not only a time stamp
12914 (setq org-log-note-how 'note))
12915 ;; Set up for taking a record
12916 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12917 org-last-state
12918 'findpos org-log-repeat)))
12919 (org-back-to-heading t)
12920 (org-add-planning-info nil nil 'closed)
12921 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12922 org-deadline-time-regexp "\\)\\|\\("
12923 org-ts-regexp "\\)"))
12924 (while (re-search-forward
12925 re (save-excursion (outline-next-heading) (point)) t)
12926 (setq type (if (match-end 1) org-scheduled-string
12927 (if (match-end 3) org-deadline-string "Plain:"))
12928 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12929 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12930 (setq n (string-to-number (match-string 2 ts))
12931 what (match-string 3 ts))
12932 (if (equal what "w") (setq n (* n 7) what "d"))
12933 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12934 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12935 ;; Preparation, see if we need to modify the start date for the change
12936 (when (match-end 1)
12937 (setq time (save-match-data (org-time-string-to-time ts)))
12938 (cond
12939 ((equal (match-string 1 ts) ".")
12940 ;; Shift starting date to today
12941 (org-timestamp-change
12942 (- (org-today) (time-to-days time))
12943 'day))
12944 ((equal (match-string 1 ts) "+")
12945 (let ((nshiftmax 10) (nshift 0))
12946 (while (or (= nshift 0)
12947 (<= (time-to-days time)
12948 (time-to-days (current-time))))
12949 (when (= (incf nshift) nshiftmax)
12950 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12951 (error "Abort")))
12952 (org-timestamp-change n (cdr (assoc what whata)))
12953 (org-at-timestamp-p t)
12954 (setq ts (match-string 1))
12955 (setq time (save-match-data (org-time-string-to-time ts)))))
12956 (org-timestamp-change (- n) (cdr (assoc what whata)))
12957 ;; rematch, so that we have everything in place for the real shift
12958 (org-at-timestamp-p t)
12959 (setq ts (match-string 1))
12960 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
12961 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12962 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12963 (setq org-log-post-message msg)
12964 (message "%s" msg))))
12966 (defun org-show-todo-tree (arg)
12967 "Make a compact tree which shows all headlines marked with TODO.
12968 The tree will show the lines where the regexp matches, and all higher
12969 headlines above the match.
12970 With a \\[universal-argument] prefix, prompt for a regexp to match.
12971 With a numeric prefix N, construct a sparse tree for the Nth element
12972 of `org-todo-keywords-1'."
12973 (interactive "P")
12974 (let ((case-fold-search nil)
12975 (kwd-re
12976 (cond ((null arg) org-not-done-regexp)
12977 ((equal arg '(4))
12978 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12979 (mapcar 'list org-todo-keywords-1))))
12980 (concat "\\("
12981 (mapconcat 'identity (org-split-string kwd "|") "\\|")
12982 "\\)\\>")))
12983 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12984 (regexp-quote (nth (1- (prefix-numeric-value arg))
12985 org-todo-keywords-1)))
12986 (t (user-error "Invalid prefix argument: %s" arg)))))
12987 (message "%d TODO entries found"
12988 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12990 (defun org-deadline (arg &optional time)
12991 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
12992 With one universal prefix argument, remove any deadline from the item.
12993 With two universal prefix arguments, prompt for a warning delay.
12994 With argument TIME, set the deadline at the corresponding date. TIME
12995 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
12996 (interactive "P")
12997 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12998 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12999 'region-start-level 'region))
13000 org-loop-over-headlines-in-active-region)
13001 (org-map-entries
13002 `(org-deadline ',arg ,time)
13003 org-loop-over-headlines-in-active-region
13004 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13005 (let* ((old-date (org-entry-get nil "DEADLINE"))
13006 (old-date-time (if old-date (org-time-string-to-time old-date)))
13007 (repeater (and old-date
13008 (string-match
13009 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13010 old-date)
13011 (match-string 1 old-date))))
13012 (cond
13013 ((equal arg '(4))
13014 (when (and old-date org-log-redeadline)
13015 (org-add-log-setup 'deldeadline nil old-date 'findpos
13016 org-log-redeadline))
13017 (org-remove-timestamp-with-keyword org-deadline-string)
13018 (message "Item no longer has a deadline."))
13019 ((equal arg '(16))
13020 (save-excursion
13021 (org-back-to-heading t)
13022 (if (re-search-forward
13023 org-deadline-time-regexp
13024 (save-excursion (outline-next-heading) (point)) t)
13025 (let* ((rpl0 (match-string 1))
13026 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13027 (replace-match
13028 (concat org-deadline-string
13029 " <" rpl
13030 (format " -%dd"
13031 (abs
13032 (- (time-to-days
13033 (save-match-data
13034 (org-read-date nil t nil "Warn starting from" old-date-time)))
13035 (time-to-days old-date-time))))
13036 ">") t t))
13037 (user-error "No deadline information to update"))))
13039 (org-add-planning-info 'deadline time 'closed)
13040 (when (and old-date org-log-redeadline
13041 (not (equal old-date
13042 (substring org-last-inserted-timestamp 1 -1))))
13043 (org-add-log-setup 'redeadline nil old-date 'findpos
13044 org-log-redeadline))
13045 (when repeater
13046 (save-excursion
13047 (org-back-to-heading t)
13048 (when (re-search-forward (concat org-deadline-string " "
13049 org-last-inserted-timestamp)
13050 (save-excursion
13051 (outline-next-heading) (point)) t)
13052 (goto-char (1- (match-end 0)))
13053 (insert " " repeater)
13054 (setq org-last-inserted-timestamp
13055 (concat (substring org-last-inserted-timestamp 0 -1)
13056 " " repeater
13057 (substring org-last-inserted-timestamp -1))))))
13058 (message "Deadline on %s" org-last-inserted-timestamp))))))
13060 (defun org-schedule (arg &optional time)
13061 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13062 With one universal prefix argument, remove any scheduling date from the item.
13063 With two universal prefix arguments, prompt for a delay cookie.
13064 With argument TIME, scheduled at the corresponding date. TIME can
13065 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13066 (interactive "P")
13067 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13068 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13069 'region-start-level 'region))
13070 org-loop-over-headlines-in-active-region)
13071 (org-map-entries
13072 `(org-schedule ',arg ,time)
13073 org-loop-over-headlines-in-active-region
13074 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13075 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13076 (old-date-time (if old-date (org-time-string-to-time old-date)))
13077 (repeater (and old-date
13078 (string-match
13079 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13080 old-date)
13081 (match-string 1 old-date))))
13082 (cond
13083 ((equal arg '(4))
13084 (progn
13085 (when (and old-date org-log-reschedule)
13086 (org-add-log-setup 'delschedule nil old-date 'findpos
13087 org-log-reschedule))
13088 (org-remove-timestamp-with-keyword org-scheduled-string)
13089 (message "Item is no longer scheduled.")))
13090 ((equal arg '(16))
13091 (save-excursion
13092 (org-back-to-heading t)
13093 (if (re-search-forward
13094 org-scheduled-time-regexp
13095 (save-excursion (outline-next-heading) (point)) t)
13096 (let* ((rpl0 (match-string 1))
13097 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13098 (replace-match
13099 (concat org-scheduled-string
13100 " <" rpl
13101 (format " -%dd"
13102 (abs
13103 (- (time-to-days
13104 (save-match-data
13105 (org-read-date nil t nil "Delay until" old-date-time)))
13106 (time-to-days old-date-time))))
13107 ">") t t))
13108 (user-error "No scheduled information to update"))))
13110 (org-add-planning-info 'scheduled time 'closed)
13111 (when (and old-date org-log-reschedule
13112 (not (equal old-date
13113 (substring org-last-inserted-timestamp 1 -1))))
13114 (org-add-log-setup 'reschedule nil old-date 'findpos
13115 org-log-reschedule))
13116 (when repeater
13117 (save-excursion
13118 (org-back-to-heading t)
13119 (when (re-search-forward (concat org-scheduled-string " "
13120 org-last-inserted-timestamp)
13121 (save-excursion
13122 (outline-next-heading) (point)) t)
13123 (goto-char (1- (match-end 0)))
13124 (insert " " repeater)
13125 (setq org-last-inserted-timestamp
13126 (concat (substring org-last-inserted-timestamp 0 -1)
13127 " " repeater
13128 (substring org-last-inserted-timestamp -1))))))
13129 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13131 (defun org-get-scheduled-time (pom &optional inherit)
13132 "Get the scheduled time as a time tuple, of a format suitable
13133 for calling org-schedule with, or if there is no scheduling,
13134 returns nil."
13135 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13136 (when time
13137 (apply 'encode-time (org-parse-time-string time)))))
13139 (defun org-get-deadline-time (pom &optional inherit)
13140 "Get the deadline as a time tuple, of a format suitable for
13141 calling org-deadline with, or if there is no scheduling, returns
13142 nil."
13143 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13144 (when time
13145 (apply 'encode-time (org-parse-time-string time)))))
13147 (defun org-remove-timestamp-with-keyword (keyword)
13148 "Remove all time stamps with KEYWORD in the current entry."
13149 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13150 beg)
13151 (save-excursion
13152 (org-back-to-heading t)
13153 (setq beg (point))
13154 (outline-next-heading)
13155 (while (re-search-backward re beg t)
13156 (replace-match "")
13157 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13158 (equal (char-before) ?\ ))
13159 (backward-delete-char 1)
13160 (if (string-match "^[ \t]*$" (buffer-substring
13161 (point-at-bol) (point-at-eol)))
13162 (delete-region (point-at-bol)
13163 (min (point-max) (1+ (point-at-eol))))))))))
13165 (defvar org-time-was-given) ; dynamically scoped parameter
13166 (defvar org-end-time-was-given) ; dynamically scoped parameter
13168 (defun org-add-planning-info (what &optional time &rest remove)
13169 "Insert new timestamp with keyword in the line directly after the headline.
13170 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13171 If non is given, the user is prompted for a date.
13172 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13173 be removed."
13174 (interactive)
13175 (let (org-time-was-given org-end-time-was-given ts
13176 end default-time default-input)
13178 (catch 'exit
13179 (when (and (memq what '(scheduled deadline))
13180 (or (not time)
13181 (and (stringp time)
13182 (string-match "^[-+]+[0-9]" time))))
13183 ;; Try to get a default date/time from existing timestamp
13184 (save-excursion
13185 (org-back-to-heading t)
13186 (setq end (save-excursion (outline-next-heading) (point)))
13187 (when (re-search-forward (if (eq what 'scheduled)
13188 org-scheduled-time-regexp
13189 org-deadline-time-regexp)
13190 end t)
13191 (setq ts (match-string 1)
13192 default-time
13193 (apply 'encode-time (org-parse-time-string ts))
13194 default-input (and ts (org-get-compact-tod ts))))))
13195 (when what
13196 (setq time
13197 (if (stringp time)
13198 ;; This is a string (relative or absolute), set proper date
13199 (apply 'encode-time
13200 (org-read-date-analyze
13201 time default-time (decode-time default-time)))
13202 ;; If necessary, get the time from the user
13203 (or time (org-read-date nil 'to-time nil nil
13204 default-time default-input)))))
13206 (when (and org-insert-labeled-timestamps-at-point
13207 (member what '(scheduled deadline)))
13208 (insert
13209 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13210 (org-insert-time-stamp time org-time-was-given
13211 nil nil nil (list org-end-time-was-given))
13212 (setq what nil))
13213 (save-excursion
13214 (save-restriction
13215 (let (col list elt ts buffer-invisibility-spec)
13216 (org-back-to-heading t)
13217 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13218 (goto-char (match-end 1))
13219 (setq col (current-column))
13220 (goto-char (match-end 0))
13221 (if (eobp) (insert "\n") (forward-char 1))
13222 (when (and (not what)
13223 (not (looking-at
13224 (concat "[ \t]*"
13225 org-keyword-time-not-clock-regexp))))
13226 ;; Nothing to add, nothing to remove...... :-)
13227 (throw 'exit nil))
13228 (if (and (not (looking-at org-outline-regexp))
13229 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13230 "[^\r\n]*"))
13231 (not (equal (match-string 1) org-clock-string)))
13232 (narrow-to-region (match-beginning 0) (match-end 0))
13233 (insert-before-markers "\n")
13234 (backward-char 1)
13235 (narrow-to-region (point) (point))
13236 (and org-adapt-indentation (org-indent-to-column col)))
13237 ;; Check if we have to remove something.
13238 (setq list (cons what remove))
13239 (while list
13240 (setq elt (pop list))
13241 (when (or (and (eq elt 'scheduled)
13242 (re-search-forward org-scheduled-time-regexp nil t))
13243 (and (eq elt 'deadline)
13244 (re-search-forward org-deadline-time-regexp nil t))
13245 (and (eq elt 'closed)
13246 (re-search-forward org-closed-time-regexp nil t)))
13247 (replace-match "")
13248 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13249 (and (looking-at "[ \t]+") (replace-match ""))
13250 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13251 (when what
13252 (insert
13253 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13254 (cond ((eq what 'scheduled) org-scheduled-string)
13255 ((eq what 'deadline) org-deadline-string)
13256 ((eq what 'closed) org-closed-string))
13257 " ")
13258 (setq ts (org-insert-time-stamp
13259 time
13260 (or org-time-was-given
13261 (and (eq what 'closed) org-log-done-with-time))
13262 (eq what 'closed)
13263 nil nil (list org-end-time-was-given)))
13264 (insert
13265 (if (not (or (bolp) (eq (char-before) ?\ )
13266 (memq (char-after) '(32 10))
13267 (eobp))) " " ""))
13268 (end-of-line 1))
13269 (goto-char (point-min))
13270 (widen)
13271 (if (and (looking-at "[ \t]*\n")
13272 (equal (char-before) ?\n))
13273 (delete-region (1- (point)) (point-at-eol)))
13274 ts))))))
13276 (defvar org-log-note-marker (make-marker))
13277 (defvar org-log-note-purpose nil)
13278 (defvar org-log-note-state nil)
13279 (defvar org-log-note-previous-state nil)
13280 (defvar org-log-note-how nil)
13281 (defvar org-log-note-extra nil)
13282 (defvar org-log-note-window-configuration nil)
13283 (defvar org-log-note-return-to (make-marker))
13284 (defvar org-log-note-effective-time nil
13285 "Remembered current time so that dynamically scoped
13286 `org-extend-today-until' affects tha timestamps in state change
13287 log")
13289 (defvar org-log-post-message nil
13290 "Message to be displayed after a log note has been stored.
13291 The auto-repeater uses this.")
13293 (defun org-add-note ()
13294 "Add a note to the current entry.
13295 This is done in the same way as adding a state change note."
13296 (interactive)
13297 (org-add-log-setup 'note nil nil 'findpos nil))
13299 (defvar org-property-end-re)
13300 (defun org-add-log-setup (&optional purpose state prev-state
13301 findpos how extra)
13302 "Set up the post command hook to take a note.
13303 If this is about to TODO state change, the new state is expected in STATE.
13304 When FINDPOS is non-nil, find the correct position for the note in
13305 the current entry. If not, assume that it can be inserted at point.
13306 HOW is an indicator what kind of note should be created.
13307 EXTRA is additional text that will be inserted into the notes buffer."
13308 (let* ((org-log-into-drawer (org-log-into-drawer))
13309 (drawer (cond ((stringp org-log-into-drawer)
13310 org-log-into-drawer)
13311 (org-log-into-drawer "LOGBOOK"))))
13312 (save-restriction
13313 (save-excursion
13314 (when findpos
13315 (org-back-to-heading t)
13316 (narrow-to-region (point) (save-excursion
13317 (outline-next-heading) (point)))
13318 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13319 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13320 "[^\r\n]*\\)?"))
13321 (goto-char (match-end 0))
13322 (cond
13323 (drawer
13324 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13325 nil t)
13326 (progn
13327 (goto-char (match-end 0))
13328 (or org-log-states-order-reversed
13329 (and (re-search-forward org-property-end-re nil t)
13330 (goto-char (1- (match-beginning 0))))))
13331 (insert "\n:" drawer ":\n:END:")
13332 (beginning-of-line 0)
13333 (org-indent-line)
13334 (beginning-of-line 2)
13335 (org-indent-line)
13336 (end-of-line 0)))
13337 ((and org-log-state-notes-insert-after-drawers
13338 (save-excursion
13339 (forward-line) (looking-at org-drawer-regexp)))
13340 (forward-line)
13341 (while (looking-at org-drawer-regexp)
13342 (goto-char (match-end 0))
13343 (re-search-forward org-property-end-re (point-max) t)
13344 (forward-line))
13345 (forward-line -1)))
13346 (unless org-log-states-order-reversed
13347 (and (= (char-after) ?\n) (forward-char 1))
13348 (org-skip-over-state-notes)
13349 (skip-chars-backward " \t\n\r")))
13350 (move-marker org-log-note-marker (point))
13351 (setq org-log-note-purpose purpose
13352 org-log-note-state state
13353 org-log-note-previous-state prev-state
13354 org-log-note-how how
13355 org-log-note-extra extra
13356 org-log-note-effective-time (org-current-effective-time))
13357 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13359 (defun org-skip-over-state-notes ()
13360 "Skip past the list of State notes in an entry."
13361 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13362 (when (ignore-errors (goto-char (org-in-item-p)))
13363 (let* ((struct (org-list-struct))
13364 (prevs (org-list-prevs-alist struct)))
13365 (while (looking-at "[ \t]*- State")
13366 (goto-char (or (org-list-get-next-item (point) struct prevs)
13367 (org-list-get-item-end (point) struct)))))))
13369 (defun org-add-log-note (&optional purpose)
13370 "Pop up a window for taking a note, and add this note later at point."
13371 (remove-hook 'post-command-hook 'org-add-log-note)
13372 (setq org-log-note-window-configuration (current-window-configuration))
13373 (delete-other-windows)
13374 (move-marker org-log-note-return-to (point))
13375 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13376 (goto-char org-log-note-marker)
13377 (org-switch-to-buffer-other-window "*Org Note*")
13378 (erase-buffer)
13379 (if (memq org-log-note-how '(time state))
13380 (let (current-prefix-arg) (org-store-log-note))
13381 (let ((org-inhibit-startup t)) (org-mode))
13382 (insert (format "# Insert note for %s.
13383 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13384 (cond
13385 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13386 ((eq org-log-note-purpose 'done) "closed todo item")
13387 ((eq org-log-note-purpose 'state)
13388 (format "state change from \"%s\" to \"%s\""
13389 (or org-log-note-previous-state "")
13390 (or org-log-note-state "")))
13391 ((eq org-log-note-purpose 'reschedule)
13392 "rescheduling")
13393 ((eq org-log-note-purpose 'delschedule)
13394 "no longer scheduled")
13395 ((eq org-log-note-purpose 'redeadline)
13396 "changing deadline")
13397 ((eq org-log-note-purpose 'deldeadline)
13398 "removing deadline")
13399 ((eq org-log-note-purpose 'refile)
13400 "refiling")
13401 ((eq org-log-note-purpose 'note)
13402 "this entry")
13403 (t (error "This should not happen")))))
13404 (if org-log-note-extra (insert org-log-note-extra))
13405 (org-set-local 'org-finish-function 'org-store-log-note)
13406 (run-hooks 'org-log-buffer-setup-hook)))
13408 (defvar org-note-abort nil) ; dynamically scoped
13409 (defun org-store-log-note ()
13410 "Finish taking a log note, and insert it to where it belongs."
13411 (let ((txt (buffer-string)))
13412 (kill-buffer (current-buffer))
13413 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13414 lines ind bul)
13415 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13416 (setq txt (replace-match "" t t txt)))
13417 (if (string-match "\\s-+\\'" txt)
13418 (setq txt (replace-match "" t t txt)))
13419 (setq lines (org-split-string txt "\n"))
13420 (when (and note (string-match "\\S-" note))
13421 (setq note
13422 (org-replace-escapes
13423 note
13424 (list (cons "%u" (user-login-name))
13425 (cons "%U" user-full-name)
13426 (cons "%t" (format-time-string
13427 (org-time-stamp-format 'long 'inactive)
13428 org-log-note-effective-time))
13429 (cons "%T" (format-time-string
13430 (org-time-stamp-format 'long nil)
13431 org-log-note-effective-time))
13432 (cons "%d" (format-time-string
13433 (org-time-stamp-format nil 'inactive)
13434 org-log-note-effective-time))
13435 (cons "%D" (format-time-string
13436 (org-time-stamp-format nil nil)
13437 org-log-note-effective-time))
13438 (cons "%s" (if org-log-note-state
13439 (concat "\"" org-log-note-state "\"")
13440 ""))
13441 (cons "%S" (if org-log-note-previous-state
13442 (concat "\"" org-log-note-previous-state "\"")
13443 "\"\"")))))
13444 (if lines (setq note (concat note " \\\\")))
13445 (push note lines))
13446 (when (or current-prefix-arg org-note-abort)
13447 (when org-log-into-drawer
13448 (org-remove-empty-drawer-at
13449 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13450 org-log-note-marker))
13451 (setq lines nil))
13452 (when lines
13453 (with-current-buffer (marker-buffer org-log-note-marker)
13454 (save-excursion
13455 (goto-char org-log-note-marker)
13456 (move-marker org-log-note-marker nil)
13457 (end-of-line 1)
13458 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13459 (setq ind (save-excursion
13460 (if (ignore-errors (goto-char (org-in-item-p)))
13461 (let ((struct (org-list-struct)))
13462 (org-list-get-ind
13463 (org-list-get-top-point struct) struct))
13464 (skip-chars-backward " \r\t\n")
13465 (cond
13466 ((and (org-at-heading-p)
13467 org-adapt-indentation)
13468 (1+ (org-current-level)))
13469 ((org-at-heading-p) 0)
13470 (t (org-get-indentation))))))
13471 (setq bul (org-list-bullet-string "-"))
13472 (org-indent-line-to ind)
13473 (insert bul (pop lines))
13474 (let ((ind-body (+ (length bul) ind)))
13475 (while lines
13476 (insert "\n")
13477 (org-indent-line-to ind-body)
13478 (insert (pop lines))))
13479 (message "Note stored")
13480 (org-back-to-heading t)
13481 (org-cycle-hide-drawers 'children))
13482 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13483 ;; from within `org-add-log-note' because `buffer-undo-list'
13484 ;; is then modified outside of `org-with-remote-undo'.
13485 (when (eq this-command 'org-agenda-todo)
13486 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13487 ;; Don't add undo information when called from `org-agenda-todo'
13488 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13489 (set-window-configuration org-log-note-window-configuration)
13490 (with-current-buffer (marker-buffer org-log-note-return-to)
13491 (goto-char org-log-note-return-to))
13492 (move-marker org-log-note-return-to nil)
13493 (and org-log-post-message (message "%s" org-log-post-message))))
13495 (defun org-remove-empty-drawer-at (drawer pos)
13496 "Remove an empty drawer DRAWER at position POS.
13497 POS may also be a marker."
13498 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13499 (save-excursion
13500 (save-restriction
13501 (widen)
13502 (goto-char pos)
13503 (if (org-in-regexp
13504 (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
13505 (replace-match ""))))))
13507 (defvar org-ts-type nil)
13508 (defun org-sparse-tree (&optional arg type)
13509 "Create a sparse tree, prompt for the details.
13510 This command can create sparse trees. You first need to select the type
13511 of match used to create the tree:
13513 t Show all TODO entries.
13514 T Show entries with a specific TODO keyword.
13515 m Show entries selected by a tags/property match.
13516 p Enter a property name and its value (both with completion on existing
13517 names/values) and show entries with that property.
13518 r Show entries matching a regular expression (`/' can be used as well).
13519 b Show deadlines and scheduled items before a date.
13520 a Show deadlines and scheduled items after a date.
13521 d Show deadlines due within `org-deadline-warning-days'.
13522 D Show deadlines and scheduled items between a date range."
13523 (interactive "P")
13524 (setq type (or type org-sparse-tree-default-date-type))
13525 (setq org-ts-type type)
13526 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13527 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13528 [c]ycle through date types: %s"
13529 (case type
13530 (all "all timestamps")
13531 (scheduled "only scheduled")
13532 (deadline "only deadline")
13533 (active "only active timestamps")
13534 (inactive "only inactive timestamps")
13535 (scheduled-or-deadline "scheduled/deadline")
13536 (closed "with a closed time-stamp")
13537 (otherwise "scheduled/deadline")))
13538 (let ((answer (read-char-exclusive)))
13539 (case answer
13541 (org-sparse-tree
13543 (cadr (memq type '(scheduled-or-deadline all scheduled deadline active
13544 inactive closed)))))
13545 (?d (call-interactively #'org-check-deadlines))
13546 (?b (call-interactively #'org-check-before-date))
13547 (?a (call-interactively #'org-check-after-date))
13548 (?D (call-interactively #'org-check-dates-range))
13549 (?t (call-interactively #'org-show-todo-tree))
13550 (?T (org-show-todo-tree '(4)))
13551 (?m (call-interactively #'org-match-sparse-tree))
13552 ((?p ?P)
13553 (let* ((kwd (org-icompleting-read
13554 "Property: " (mapcar #'list (org-buffer-property-keys))))
13555 (value (org-icompleting-read
13556 "Value: " (mapcar #'list (org-property-values kwd)))))
13557 (unless (string-match "\\`{.*}\\'" value)
13558 (setq value (concat "\"" value "\"")))
13559 (org-match-sparse-tree arg (concat kwd "=" value))))
13560 ((?r ?R ?/) (call-interactively #'org-occur))
13561 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13563 (defvar org-occur-highlights nil
13564 "List of overlays used for occur matches.")
13565 (make-variable-buffer-local 'org-occur-highlights)
13566 (defvar org-occur-parameters nil
13567 "Parameters of the active org-occur calls.
13568 This is a list, each call to org-occur pushes as cons cell,
13569 containing the regular expression and the callback, onto the list.
13570 The list can contain several entries if `org-occur' has been called
13571 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13572 will only contain one set of parameters. When the highlights are
13573 removed (for example with `C-c C-c', or with the next edit (depending
13574 on `org-remove-highlights-with-change'), this variable is emptied
13575 as well.")
13576 (make-variable-buffer-local 'org-occur-parameters)
13578 (defun org-occur (regexp &optional keep-previous callback)
13579 "Make a compact tree which shows all matches of REGEXP.
13580 The tree will show the lines where the regexp matches, and all higher
13581 headlines above the match. It will also show the heading after the match,
13582 to make sure editing the matching entry is easy.
13583 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13584 call to `org-occur' will be kept, to allow stacking of calls to this
13585 command.
13586 If CALLBACK is non-nil, it is a function which is called to confirm
13587 that the match should indeed be shown."
13588 (interactive "sRegexp: \nP")
13589 (when (equal regexp "")
13590 (user-error "Regexp cannot be empty"))
13591 (unless keep-previous
13592 (org-remove-occur-highlights nil nil t))
13593 (push (cons regexp callback) org-occur-parameters)
13594 (let ((cnt 0))
13595 (save-excursion
13596 (goto-char (point-min))
13597 (if (or (not keep-previous) ; do not want to keep
13598 (not org-occur-highlights)) ; no previous matches
13599 ;; hide everything
13600 (org-overview))
13601 (while (re-search-forward regexp nil t)
13602 (when (or (not callback)
13603 (save-match-data (funcall callback)))
13604 (setq cnt (1+ cnt))
13605 (when org-highlight-sparse-tree-matches
13606 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13607 (org-show-context 'occur-tree))))
13608 (when org-remove-highlights-with-change
13609 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13610 nil 'local))
13611 (unless org-sparse-tree-open-archived-trees
13612 (org-hide-archived-subtrees (point-min) (point-max)))
13613 (run-hooks 'org-occur-hook)
13614 (if (org-called-interactively-p 'interactive)
13615 (message "%d match(es) for regexp %s" cnt regexp))
13616 cnt))
13618 (defun org-occur-next-match (&optional n reset)
13619 "Function for `next-error-function' to find sparse tree matches.
13620 N is the number of matches to move, when negative move backwards.
13621 RESET is entirely ignored - this function always goes back to the
13622 starting point when no match is found."
13623 (let* ((limit (if (< n 0) (point-min) (point-max)))
13624 (search-func (if (< n 0)
13625 'previous-single-char-property-change
13626 'next-single-char-property-change))
13627 (n (abs n))
13628 (pos (point))
13630 (catch 'exit
13631 (while (setq p1 (funcall search-func (point) 'org-type))
13632 (when (equal p1 limit)
13633 (goto-char pos)
13634 (error "No more matches"))
13635 (when (equal (get-char-property p1 'org-type) 'org-occur)
13636 (setq n (1- n))
13637 (when (= n 0)
13638 (goto-char p1)
13639 (throw 'exit (point))))
13640 (goto-char p1))
13641 (goto-char p1)
13642 (error "No more matches"))))
13644 (defun org-show-context (&optional key)
13645 "Make sure point and context are visible.
13646 How much context is shown depends upon the variables
13647 `org-show-hierarchy-above', `org-show-following-heading',
13648 `org-show-entry-below' and `org-show-siblings'."
13649 (let ((heading-p (org-at-heading-p t))
13650 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13651 (following-p (org-get-alist-option org-show-following-heading key))
13652 (entry-p (org-get-alist-option org-show-entry-below key))
13653 (siblings-p (org-get-alist-option org-show-siblings key)))
13654 ;; Show heading or entry text
13655 (if (and heading-p (not entry-p))
13656 (org-flag-heading nil) ; only show the heading
13657 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13658 (org-show-hidden-entry))) ; show entire entry
13659 (when following-p
13660 ;; Show next sibling, or heading below text
13661 (save-excursion
13662 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13663 (org-flag-heading nil))))
13664 (when siblings-p (org-show-siblings))
13665 (when hierarchy-p
13666 ;; show all higher headings, possibly with siblings
13667 (save-excursion
13668 (while (and (condition-case nil
13669 (progn (org-up-heading-all 1) t)
13670 (error nil))
13671 (not (bobp)))
13672 (org-flag-heading nil)
13673 (when siblings-p (org-show-siblings)))))))
13675 (defvar org-reveal-start-hook nil
13676 "Hook run before revealing a location.")
13678 (defun org-reveal (&optional siblings)
13679 "Show current entry, hierarchy above it, and the following headline.
13680 This can be used to show a consistent set of context around locations
13681 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13682 not t for the search context.
13684 With optional argument SIBLINGS, on each level of the hierarchy all
13685 siblings are shown. This repairs the tree structure to what it would
13686 look like when opened with hierarchical calls to `org-cycle'.
13687 With double optional argument \\[universal-argument] \\[universal-argument], \
13688 go to the parent and show the
13689 entire tree."
13690 (interactive "P")
13691 (run-hooks 'org-reveal-start-hook)
13692 (let ((org-show-hierarchy-above t)
13693 (org-show-following-heading t)
13694 (org-show-siblings (if siblings t org-show-siblings)))
13695 (org-show-context nil))
13696 (when (equal siblings '(16))
13697 (save-excursion
13698 (when (org-up-heading-safe)
13699 (org-show-subtree)
13700 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13702 (defun org-highlight-new-match (beg end)
13703 "Highlight from BEG to END and mark the highlight is an occur headline."
13704 (let ((ov (make-overlay beg end)))
13705 (overlay-put ov 'face 'secondary-selection)
13706 (overlay-put ov 'org-type 'org-occur)
13707 (push ov org-occur-highlights)))
13709 (defun org-remove-occur-highlights (&optional beg end noremove)
13710 "Remove the occur highlights from the buffer.
13711 BEG and END are ignored. If NOREMOVE is nil, remove this function
13712 from the `before-change-functions' in the current buffer."
13713 (interactive)
13714 (unless org-inhibit-highlight-removal
13715 (mapc 'delete-overlay org-occur-highlights)
13716 (setq org-occur-highlights nil)
13717 (setq org-occur-parameters nil)
13718 (unless noremove
13719 (remove-hook 'before-change-functions
13720 'org-remove-occur-highlights 'local))))
13722 ;;;; Priorities
13724 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13725 "Regular expression matching the priority indicator.")
13727 (defvar org-remove-priority-next-time nil)
13729 (defun org-priority-up ()
13730 "Increase the priority of the current item."
13731 (interactive)
13732 (org-priority 'up))
13734 (defun org-priority-down ()
13735 "Decrease the priority of the current item."
13736 (interactive)
13737 (org-priority 'down))
13739 (defun org-priority (&optional action show)
13740 "Change the priority of an item.
13741 ACTION can be `set', `up', `down', or a character."
13742 (interactive "P")
13743 (if (equal action '(4))
13744 (org-show-priority)
13745 (unless org-enable-priority-commands
13746 (user-error "Priority commands are disabled"))
13747 (setq action (or action 'set))
13748 (let (current new news have remove)
13749 (save-excursion
13750 (org-back-to-heading t)
13751 (if (looking-at org-priority-regexp)
13752 (setq current (string-to-char (match-string 2))
13753 have t))
13754 (cond
13755 ((eq action 'remove)
13756 (setq remove t new ?\ ))
13757 ((or (eq action 'set)
13758 (if (featurep 'xemacs) (characterp action) (integerp action)))
13759 (if (not (eq action 'set))
13760 (setq new action)
13761 (message "Priority %c-%c, SPC to remove: "
13762 org-highest-priority org-lowest-priority)
13763 (save-match-data
13764 (setq new (read-char-exclusive))))
13765 (if (and (= (upcase org-highest-priority) org-highest-priority)
13766 (= (upcase org-lowest-priority) org-lowest-priority))
13767 (setq new (upcase new)))
13768 (cond ((equal new ?\ ) (setq remove t))
13769 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13770 (user-error "Priority must be between `%c' and `%c'"
13771 org-highest-priority org-lowest-priority))))
13772 ((eq action 'up)
13773 (setq new (if have
13774 (1- current) ; normal cycling
13775 ;; last priority was empty
13776 (if (eq last-command this-command)
13777 org-lowest-priority ; wrap around empty to lowest
13778 ;; default
13779 (if org-priority-start-cycle-with-default
13780 org-default-priority
13781 (1- org-default-priority))))))
13782 ((eq action 'down)
13783 (setq new (if have
13784 (1+ current) ; normal cycling
13785 ;; last priority was empty
13786 (if (eq last-command this-command)
13787 org-highest-priority ; wrap around empty to highest
13788 ;; default
13789 (if org-priority-start-cycle-with-default
13790 org-default-priority
13791 (1+ org-default-priority))))))
13792 (t (user-error "Invalid action")))
13793 (if (or (< (upcase new) org-highest-priority)
13794 (> (upcase new) org-lowest-priority))
13795 (if (and (memq action '(up down))
13796 (not have) (not (eq last-command this-command)))
13797 ;; `new' is from default priority
13798 (error
13799 "The default can not be set, see `org-default-priority' why")
13800 ;; normal cycling: `new' is beyond highest/lowest priority
13801 ;; and is wrapped around to the empty priority
13802 (setq remove t)))
13803 (setq news (format "%c" new))
13804 (if have
13805 (if remove
13806 (replace-match "" t t nil 1)
13807 (replace-match news t t nil 2))
13808 (if remove
13809 (user-error "No priority cookie found in line")
13810 (let ((case-fold-search nil))
13811 (looking-at org-todo-line-regexp))
13812 (if (match-end 2)
13813 (progn
13814 (goto-char (match-end 2))
13815 (insert " [#" news "]"))
13816 (goto-char (match-beginning 3))
13817 (insert "[#" news "] "))))
13818 (org-preserve-lc (org-set-tags nil 'align)))
13819 (if remove
13820 (message "Priority removed")
13821 (message "Priority of current item set to %s" news)))))
13823 (defun org-show-priority ()
13824 "Show the priority of the current item.
13825 This priority is composed of the main priority given with the [#A] cookies,
13826 and by additional input from the age of a schedules or deadline entry."
13827 (interactive)
13828 (let ((pri (if (eq major-mode 'org-agenda-mode)
13829 (org-get-at-bol 'priority)
13830 (save-excursion
13831 (save-match-data
13832 (beginning-of-line)
13833 (and (looking-at org-heading-regexp)
13834 (org-get-priority (match-string 0))))))))
13835 (message "Priority is %d" (if pri pri -1000))))
13837 (defun org-get-priority (s)
13838 "Find priority cookie and return priority."
13839 (save-match-data
13840 (if (functionp org-get-priority-function)
13841 (funcall org-get-priority-function)
13842 (if (not (string-match org-priority-regexp s))
13843 (* 1000 (- org-lowest-priority org-default-priority))
13844 (* 1000 (- org-lowest-priority
13845 (string-to-char (match-string 2 s))))))))
13847 ;;;; Tags
13849 (defvar org-agenda-archives-mode)
13850 (defvar org-map-continue-from nil
13851 "Position from where mapping should continue.
13852 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13854 (defvar org-scanner-tags nil
13855 "The current tag list while the tags scanner is running.")
13856 (defvar org-trust-scanner-tags nil
13857 "Should `org-get-tags-at' use the tags for the scanner.
13858 This is for internal dynamical scoping only.
13859 When this is non-nil, the function `org-get-tags-at' will return the value
13860 of `org-scanner-tags' instead of building the list by itself. This
13861 can lead to large speed-ups when the tags scanner is used in a file with
13862 many entries, and when the list of tags is retrieved, for example to
13863 obtain a list of properties. Building the tags list for each entry in such
13864 a file becomes an N^2 operation - but with this variable set, it scales
13865 as N.")
13867 (defun org-scan-tags (action matcher todo-only &optional start-level)
13868 "Scan headline tags with inheritance and produce output ACTION.
13870 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13871 or `agenda' to produce an entry list for an agenda view. It can also be
13872 a Lisp form or a function that should be called at each matched headline, in
13873 this case the return value is a list of all return values from these calls.
13875 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13876 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13877 only lines with a not-done TODO keyword are included in the output.
13878 This should be the same variable that was scoped into
13879 and set by `org-make-tags-matcher' when it constructed MATCHER.
13881 START-LEVEL can be a string with asterisks, reducing the scope to
13882 headlines matching this string."
13883 (require 'org-agenda)
13884 (let* ((re (concat "^"
13885 (if start-level
13886 ;; Get the correct level to match
13887 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13888 org-outline-regexp)
13889 " *\\(\\<\\("
13890 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13891 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13892 (props (list 'face 'default
13893 'done-face 'org-agenda-done
13894 'undone-face 'default
13895 'mouse-face 'highlight
13896 'org-not-done-regexp org-not-done-regexp
13897 'org-todo-regexp org-todo-regexp
13898 'org-complex-heading-regexp org-complex-heading-regexp
13899 'help-echo
13900 (format "mouse-2 or RET jump to org file %s"
13901 (abbreviate-file-name
13902 (or (buffer-file-name (buffer-base-buffer))
13903 (buffer-name (buffer-base-buffer)))))))
13904 (org-map-continue-from nil)
13905 lspos tags tags-list
13906 (tags-alist (list (cons 0 org-file-tags)))
13907 (llast 0) rtn rtn1 level category i txt
13908 todo marker entry priority)
13909 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13910 (setq action (list 'lambda nil action)))
13911 (save-excursion
13912 (goto-char (point-min))
13913 (when (eq action 'sparse-tree)
13914 (org-overview)
13915 (org-remove-occur-highlights))
13916 (while (let (case-fold-search)
13917 (re-search-forward re nil t))
13918 (setq org-map-continue-from nil)
13919 (catch :skip
13920 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13921 tags (if (match-end 4) (org-match-string-no-properties 4)))
13922 (goto-char (setq lspos (match-beginning 0)))
13923 (setq level (org-reduced-level (org-outline-level))
13924 category (org-get-category))
13925 (setq i llast llast level)
13926 ;; remove tag lists from same and sublevels
13927 (while (>= i level)
13928 (when (setq entry (assoc i tags-alist))
13929 (setq tags-alist (delete entry tags-alist)))
13930 (setq i (1- i)))
13931 ;; add the next tags
13932 (when tags
13933 (setq tags (org-split-string tags ":")
13934 tags-alist
13935 (cons (cons level tags) tags-alist)))
13936 ;; compile tags for current headline
13937 (setq tags-list
13938 (if org-use-tag-inheritance
13939 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13940 tags)
13941 org-scanner-tags tags-list)
13942 (when org-use-tag-inheritance
13943 (setcdr (car tags-alist)
13944 (mapcar (lambda (x)
13945 (setq x (copy-sequence x))
13946 (org-add-prop-inherited x))
13947 (cdar tags-alist))))
13948 (when (and tags org-use-tag-inheritance
13949 (or (not (eq t org-use-tag-inheritance))
13950 org-tags-exclude-from-inheritance))
13951 ;; selective inheritance, remove uninherited ones
13952 (setcdr (car tags-alist)
13953 (org-remove-uninherited-tags (cdar tags-alist))))
13954 (when (and
13956 ;; eval matcher only when the todo condition is OK
13957 (and (or (not todo-only) (member todo org-not-done-keywords))
13958 (let ((case-fold-search t) (org-trust-scanner-tags t))
13959 (eval matcher)))
13961 ;; Call the skipper, but return t if it does not skip,
13962 ;; so that the `and' form continues evaluating
13963 (progn
13964 (unless (eq action 'sparse-tree) (org-agenda-skip))
13967 ;; Check if timestamps are deselecting this entry
13968 (or (not todo-only)
13969 (and (member todo org-not-done-keywords)
13970 (or (not org-agenda-tags-todo-honor-ignore-options)
13971 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13973 ;; select this headline
13974 (cond
13975 ((eq action 'sparse-tree)
13976 (and org-highlight-sparse-tree-matches
13977 (org-get-heading) (match-end 0)
13978 (org-highlight-new-match
13979 (match-beginning 1) (match-end 1)))
13980 (org-show-context 'tags-tree))
13981 ((eq action 'agenda)
13982 (setq txt (org-agenda-format-item
13984 (concat
13985 (if (eq org-tags-match-list-sublevels 'indented)
13986 (make-string (1- level) ?.) "")
13987 (org-get-heading))
13988 level category
13989 tags-list)
13990 priority (org-get-priority txt))
13991 (goto-char lspos)
13992 (setq marker (org-agenda-new-marker))
13993 (org-add-props txt props
13994 'org-marker marker 'org-hd-marker marker 'org-category category
13995 'todo-state todo
13996 'priority priority 'type "tagsmatch")
13997 (push txt rtn))
13998 ((functionp action)
13999 (setq org-map-continue-from nil)
14000 (save-excursion
14001 (setq rtn1 (funcall action))
14002 (push rtn1 rtn)))
14003 (t (user-error "Invalid action")))
14005 ;; if we are to skip sublevels, jump to end of subtree
14006 (unless org-tags-match-list-sublevels
14007 (org-end-of-subtree t)
14008 (backward-char 1))))
14009 ;; Get the correct position from where to continue
14010 (if org-map-continue-from
14011 (goto-char org-map-continue-from)
14012 (and (= (point) lspos) (end-of-line 1)))))
14013 (when (and (eq action 'sparse-tree)
14014 (not org-sparse-tree-open-archived-trees))
14015 (org-hide-archived-subtrees (point-min) (point-max)))
14016 (nreverse rtn)))
14018 (defun org-remove-uninherited-tags (tags)
14019 "Remove all tags that are not inherited from the list TAGS."
14020 (cond
14021 ((eq org-use-tag-inheritance t)
14022 (if org-tags-exclude-from-inheritance
14023 (org-delete-all org-tags-exclude-from-inheritance tags)
14024 tags))
14025 ((not org-use-tag-inheritance) nil)
14026 ((stringp org-use-tag-inheritance)
14027 (delq nil (mapcar
14028 (lambda (x)
14029 (if (and (string-match org-use-tag-inheritance x)
14030 (not (member x org-tags-exclude-from-inheritance)))
14031 x nil))
14032 tags)))
14033 ((listp org-use-tag-inheritance)
14034 (delq nil (mapcar
14035 (lambda (x)
14036 (if (member x org-use-tag-inheritance) x nil))
14037 tags)))))
14039 (defun org-match-sparse-tree (&optional todo-only match)
14040 "Create a sparse tree according to tags string MATCH.
14041 MATCH can contain positive and negative selection of tags, like
14042 \"+WORK+URGENT-WITHBOSS\".
14043 If optional argument TODO-ONLY is non-nil, only select lines that are
14044 also TODO lines."
14045 (interactive "P")
14046 (org-agenda-prepare-buffers (list (current-buffer)))
14047 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14049 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14051 (defvar org-cached-props nil)
14052 (defun org-cached-entry-get (pom property)
14053 (if (or (eq t org-use-property-inheritance)
14054 (and (stringp org-use-property-inheritance)
14055 (string-match org-use-property-inheritance property))
14056 (and (listp org-use-property-inheritance)
14057 (member property org-use-property-inheritance)))
14058 ;; Caching is not possible, check it directly
14059 (org-entry-get pom property 'inherit)
14060 ;; Get all properties, so that we can do complicated checks easily
14061 (cdr (assoc property (or org-cached-props
14062 (setq org-cached-props
14063 (org-entry-properties pom)))))))
14065 (defun org-global-tags-completion-table (&optional files)
14066 "Return the list of all tags in all agenda buffer/files.
14067 Optional FILES argument is a list of files which can be used
14068 instead of the agenda files."
14069 (save-excursion
14070 (org-uniquify
14071 (delq nil
14072 (apply 'append
14073 (mapcar
14074 (lambda (file)
14075 (set-buffer (find-file-noselect file))
14076 (append (org-get-buffer-tags)
14077 (mapcar (lambda (x) (if (stringp (car-safe x))
14078 (list (car-safe x)) nil))
14079 org-tag-alist)))
14080 (if (and files (car files))
14081 files
14082 (org-agenda-files))))))))
14084 (defun org-make-tags-matcher (match)
14085 "Create the TAGS/TODO matcher form for the selection string MATCH.
14087 The variable `todo-only' is scoped dynamically into this function.
14088 It will be set to t if the matcher restricts matching to TODO entries,
14089 otherwise will not be touched.
14091 Returns a cons of the selection string MATCH and the constructed
14092 lisp form implementing the matcher. The matcher is to be evaluated
14093 at an Org entry, with point on the headline, and returns t if the
14094 entry matches the selection string MATCH. The returned lisp form
14095 references two variables with information about the entry, which
14096 must be bound around the form's evaluation: todo, the TODO keyword
14097 at the entry (or nil of none); and tags-list, the list of all tags
14098 at the entry including inherited ones. Additionally, the category
14099 of the entry (if any) must be specified as the text property
14100 'org-category on the headline.
14102 See also `org-scan-tags'.
14104 (declare (special todo-only))
14105 (unless (boundp 'todo-only)
14106 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14107 (unless match
14108 ;; Get a new match request, with completion against the global
14109 ;; tags table and the local tags in current buffer
14110 (let ((org-last-tags-completion-table
14111 (org-uniquify
14112 (delq nil (append (org-get-buffer-tags)
14113 (org-global-tags-completion-table))))))
14114 (setq match (org-completing-read-no-i
14115 "Match: " 'org-tags-completion-function nil nil nil
14116 'org-tags-history))))
14118 ;; Parse the string and create a lisp form
14119 (let ((match0 match)
14120 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14121 minus tag mm
14122 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14123 orterms term orlist re-p str-p level-p level-op time-p
14124 prop-p pn pv po gv rest (start 0) (ss 0))
14125 ;; Expand group tags
14126 (setq match (org-tags-expand match))
14128 ;; Check if there is a TODO part of this match, which would be the
14129 ;; part after a "/". TO make sure that this slash is not part of
14130 ;; a property value to be matched against, we also check that there
14131 ;; is no " after that slash.
14132 ;; First, find the last slash
14133 (while (string-match "/+" match ss)
14134 (setq start (match-beginning 0) ss (match-end 0)))
14135 (if (and (string-match "/+" match start)
14136 (not (save-match-data (string-match "\"" match start))))
14137 ;; match contains also a todo-matching request
14138 (progn
14139 (setq tagsmatch (substring match 0 (match-beginning 0))
14140 todomatch (substring match (match-end 0)))
14141 (if (string-match "^!" todomatch)
14142 (setq todo-only t todomatch (substring todomatch 1)))
14143 (if (string-match "^\\s-*$" todomatch)
14144 (setq todomatch nil)))
14145 ;; only matching tags
14146 (setq tagsmatch match todomatch nil))
14148 ;; Make the tags matcher
14149 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14150 (setq tagsmatcher t)
14151 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14152 (while (setq term (pop orterms))
14153 (while (and (equal (substring term -1) "\\") orterms)
14154 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14155 (while (string-match re term)
14156 (setq rest (substring term (match-end 0))
14157 minus (and (match-end 1)
14158 (equal (match-string 1 term) "-"))
14159 tag (save-match-data (replace-regexp-in-string
14160 "\\\\-" "-"
14161 (match-string 2 term)))
14162 re-p (equal (string-to-char tag) ?{)
14163 level-p (match-end 4)
14164 prop-p (match-end 5)
14165 mm (cond
14166 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14167 (level-p
14168 (setq level-op (org-op-to-function (match-string 3 term)))
14169 `(,level-op level ,(string-to-number
14170 (match-string 4 term))))
14171 (prop-p
14172 (setq pn (match-string 5 term)
14173 po (match-string 6 term)
14174 pv (match-string 7 term)
14175 re-p (equal (string-to-char pv) ?{)
14176 str-p (equal (string-to-char pv) ?\")
14177 time-p (save-match-data
14178 (string-match "^\"[[<].*[]>]\"$" pv))
14179 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14180 (if time-p (setq pv (org-matcher-time pv)))
14181 (setq po (org-op-to-function po (if time-p 'time str-p)))
14182 (cond
14183 ((equal pn "CATEGORY")
14184 (setq gv '(get-text-property (point) 'org-category)))
14185 ((equal pn "TODO")
14186 (setq gv 'todo))
14188 (setq gv `(org-cached-entry-get nil ,pn))))
14189 (if re-p
14190 (if (eq po 'org<>)
14191 `(not (string-match ,pv (or ,gv "")))
14192 `(string-match ,pv (or ,gv "")))
14193 (if str-p
14194 `(,po (or ,gv "") ,pv)
14195 `(,po (string-to-number (or ,gv ""))
14196 ,(string-to-number pv) ))))
14197 (t `(member ,tag tags-list)))
14198 mm (if minus (list 'not mm) mm)
14199 term rest)
14200 (push mm tagsmatcher))
14201 (push (if (> (length tagsmatcher) 1)
14202 (cons 'and tagsmatcher)
14203 (car tagsmatcher))
14204 orlist)
14205 (setq tagsmatcher nil))
14206 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14207 (setq tagsmatcher
14208 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14209 ;; Make the todo matcher
14210 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14211 (setq todomatcher t)
14212 (setq orterms (org-split-string todomatch "|") orlist nil)
14213 (while (setq term (pop orterms))
14214 (while (string-match re term)
14215 (setq minus (and (match-end 1)
14216 (equal (match-string 1 term) "-"))
14217 kwd (match-string 2 term)
14218 re-p (equal (string-to-char kwd) ?{)
14219 term (substring term (match-end 0))
14220 mm (if re-p
14221 `(string-match ,(substring kwd 1 -1) todo)
14222 (list 'equal 'todo kwd))
14223 mm (if minus (list 'not mm) mm))
14224 (push mm todomatcher))
14225 (push (if (> (length todomatcher) 1)
14226 (cons 'and todomatcher)
14227 (car todomatcher))
14228 orlist)
14229 (setq todomatcher nil))
14230 (setq todomatcher (if (> (length orlist) 1)
14231 (cons 'or orlist) (car orlist))))
14233 ;; Return the string and lisp forms of the matcher
14234 (setq matcher (if todomatcher
14235 (list 'and tagsmatcher todomatcher)
14236 tagsmatcher))
14237 (when todo-only
14238 (setq matcher (list 'and '(member todo org-not-done-keywords)
14239 matcher)))
14240 (cons match0 matcher)))
14242 (defun org-tags-expand (match &optional single-as-list downcased)
14243 "Expand group tags in MATCH.
14245 This replaces every group tag in MATCH with a regexp tag search.
14246 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14247 will be replaced like this:
14249 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14250 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14251 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14253 Replacing by a regexp preserves the structure of the match.
14254 E.g., this expansion
14256 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14258 will match anything tagged with \"Lab\" and \"Home\", or tagged
14259 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14261 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14262 assumed to be a single group tag, and the function will return
14263 the list of tags in this group.
14265 When DOWNCASE is non-nil, expand downcased TAGS."
14266 (if org-group-tags
14267 (let* ((case-fold-search t)
14268 (stable org-mode-syntax-table)
14269 (tal (or org-tag-groups-alist-for-agenda
14270 org-tag-groups-alist))
14271 (tal (if downcased
14272 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14273 (tml (mapcar 'car tal))
14274 (rtnmatch match) rpl)
14275 ;; @ and _ are allowed as word-components in tags
14276 (modify-syntax-entry ?@ "w" stable)
14277 (modify-syntax-entry ?_ "w" stable)
14278 (while (and tml
14279 (with-syntax-table stable
14280 (string-match
14281 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14282 (regexp-opt tml) "\\>\\)") rtnmatch)))
14283 (let* ((dir (match-string 1 rtnmatch))
14284 (tag (match-string 2 rtnmatch))
14285 (tag (if downcased (downcase tag) tag)))
14286 (setq tml (delete tag tml))
14287 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14288 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14289 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14290 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14291 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14292 (if single-as-list
14293 (or (reverse rpl) (list rtnmatch))
14294 rtnmatch))
14295 (if single-as-list (list (if downcased (downcase match) match))
14296 match)))
14298 (defun org-op-to-function (op &optional stringp)
14299 "Turn an operator into the appropriate function."
14300 (setq op
14301 (cond
14302 ((equal op "<" ) '(< string< org-time<))
14303 ((equal op ">" ) '(> org-string> org-time>))
14304 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14305 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14306 ((member op '("=" "==")) '(= string= org-time=))
14307 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14308 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14310 (defun org<> (a b) (not (= a b)))
14311 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14312 (defun org-string>= (a b) (not (string< a b)))
14313 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14314 (defun org-string<> (a b) (not (string= a b)))
14315 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14316 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14317 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14318 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14319 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14320 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14321 (defun org-2ft (s)
14322 "Convert S to a floating point time.
14323 If S is already a number, just return it. If it is a string, parse
14324 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14325 (cond
14326 ((numberp s) s)
14327 ((stringp s)
14328 (condition-case nil
14329 (float-time (apply 'encode-time (org-parse-time-string s)))
14330 (error 0.)))
14331 (t 0.)))
14333 (defun org-time-today ()
14334 "Time in seconds today at 0:00.
14335 Returns the float number of seconds since the beginning of the
14336 epoch to the beginning of today (00:00)."
14337 (float-time (apply 'encode-time
14338 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14340 (defun org-matcher-time (s)
14341 "Interpret a time comparison value."
14342 (save-match-data
14343 (cond
14344 ((string= s "<now>") (float-time))
14345 ((string= s "<today>") (org-time-today))
14346 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14347 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14348 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14349 (+ (org-time-today)
14350 (* (string-to-number (match-string 1 s))
14351 (cdr (assoc (match-string 2 s)
14352 '(("d" . 86400.0) ("w" . 604800.0)
14353 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14354 (t (org-2ft s)))))
14356 (defun org-match-any-p (re list)
14357 "Does re match any element of list?"
14358 (setq list (mapcar (lambda (x) (string-match re x)) list))
14359 (delq nil list))
14361 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14362 (defvar org-tags-overlay (make-overlay 1 1))
14363 (org-detach-overlay org-tags-overlay)
14365 (defun org-get-local-tags-at (&optional pos)
14366 "Get a list of tags defined in the current headline."
14367 (org-get-tags-at pos 'local))
14369 (defun org-get-local-tags ()
14370 "Get a list of tags defined in the current headline."
14371 (org-get-tags-at nil 'local))
14373 (defun org-get-tags-at (&optional pos local)
14374 "Get a list of all headline tags applicable at POS.
14375 POS defaults to point. If tags are inherited, the list contains
14376 the targets in the same sequence as the headlines appear, i.e.
14377 the tags of the current headline come last.
14378 When LOCAL is non-nil, only return tags from the current headline,
14379 ignore inherited ones."
14380 (interactive)
14381 (if (and org-trust-scanner-tags
14382 (or (not pos) (equal pos (point)))
14383 (not local))
14384 org-scanner-tags
14385 (let (tags ltags lastpos parent)
14386 (save-excursion
14387 (save-restriction
14388 (widen)
14389 (goto-char (or pos (point)))
14390 (save-match-data
14391 (catch 'done
14392 (condition-case nil
14393 (progn
14394 (org-back-to-heading t)
14395 (while (not (equal lastpos (point)))
14396 (setq lastpos (point))
14397 (when (looking-at
14398 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14399 (setq ltags (org-split-string
14400 (org-match-string-no-properties 1) ":"))
14401 (when parent
14402 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14403 (setq tags (append
14404 (if parent
14405 (org-remove-uninherited-tags ltags)
14406 ltags)
14407 tags)))
14408 (or org-use-tag-inheritance (throw 'done t))
14409 (if local (throw 'done t))
14410 (or (org-up-heading-safe) (error nil))
14411 (setq parent t)))
14412 (error nil)))))
14413 (if local
14414 tags
14415 (reverse (delete-dups
14416 (reverse (append
14417 (org-remove-uninherited-tags
14418 org-file-tags) tags)))))))))
14420 (defun org-add-prop-inherited (s)
14421 (add-text-properties 0 (length s) '(inherited t) s)
14424 (defun org-toggle-tag (tag &optional onoff)
14425 "Toggle the tag TAG for the current line.
14426 If ONOFF is `on' or `off', don't toggle but set to this state."
14427 (let (res current)
14428 (save-excursion
14429 (org-back-to-heading t)
14430 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14431 (point-at-eol) t)
14432 (progn
14433 (setq current (match-string 1))
14434 (replace-match ""))
14435 (setq current ""))
14436 (setq current (nreverse (org-split-string current ":")))
14437 (cond
14438 ((eq onoff 'on)
14439 (setq res t)
14440 (or (member tag current) (push tag current)))
14441 ((eq onoff 'off)
14442 (or (not (member tag current)) (setq current (delete tag current))))
14443 (t (if (member tag current)
14444 (setq current (delete tag current))
14445 (setq res t)
14446 (push tag current))))
14447 (end-of-line 1)
14448 (if current
14449 (progn
14450 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14451 (org-set-tags nil t))
14452 (delete-horizontal-space))
14453 (run-hooks 'org-after-tags-change-hook))
14454 res))
14456 (defun org-align-tags-here (to-col)
14457 ;; Assumes that this is a headline
14458 "Align tags on the current headline to TO-COL."
14459 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14460 (beginning-of-line 1)
14461 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14462 (< pos (match-beginning 2)))
14463 (progn
14464 (setq tags-l (- (match-end 2) (match-beginning 2)))
14465 (goto-char (match-beginning 1))
14466 (insert " ")
14467 (delete-region (point) (1+ (match-beginning 2)))
14468 (setq ncol (max (current-column)
14469 (1+ col)
14470 (if (> to-col 0)
14471 to-col
14472 (- (abs to-col) tags-l))))
14473 (setq p (point))
14474 (insert (make-string (- ncol (current-column)) ?\ ))
14475 (setq ncol (current-column))
14476 (when indent-tabs-mode (tabify p (point-at-eol)))
14477 (org-move-to-column (min ncol col)))
14478 (goto-char pos))))
14480 (defun org-set-tags-command (&optional arg just-align)
14481 "Call the set-tags command for the current entry."
14482 (interactive "P")
14483 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14484 (org-set-tags arg just-align)
14485 (save-excursion
14486 (unless (and (org-region-active-p)
14487 org-loop-over-headlines-in-active-region)
14488 (org-back-to-heading t))
14489 (org-set-tags arg just-align))))
14491 (defun org-set-tags-to (data)
14492 "Set the tags of the current entry to DATA, replacing the current tags.
14493 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14494 If DATA is nil or the empty string, any tags will be removed."
14495 (interactive "sTags: ")
14496 (setq data
14497 (cond
14498 ((eq data nil) "")
14499 ((equal data "") "")
14500 ((stringp data)
14501 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14502 ":"))
14503 ((listp data)
14504 (concat ":" (mapconcat 'identity data ":") ":"))))
14505 (when data
14506 (save-excursion
14507 (org-back-to-heading t)
14508 (when (looking-at org-complex-heading-regexp)
14509 (if (match-end 5)
14510 (progn
14511 (goto-char (match-beginning 5))
14512 (insert data)
14513 (delete-region (point) (point-at-eol))
14514 (org-set-tags nil 'align))
14515 (goto-char (point-at-eol))
14516 (insert " " data)
14517 (org-set-tags nil 'align)))
14518 (beginning-of-line 1)
14519 (if (looking-at ".*?\\([ \t]+\\)$")
14520 (delete-region (match-beginning 1) (match-end 1))))))
14522 (defun org-align-all-tags ()
14523 "Align the tags i all headings."
14524 (interactive)
14525 (save-excursion
14526 (or (ignore-errors (org-back-to-heading t))
14527 (outline-next-heading))
14528 (if (org-at-heading-p)
14529 (org-set-tags t)
14530 (message "No headings"))))
14532 (defvar org-indent-indentation-per-level)
14533 (defun org-set-tags (&optional arg just-align)
14534 "Set the tags for the current headline.
14535 With prefix ARG, realign all tags in headings in the current buffer.
14536 When JUST-ALIGN is non-nil, only align tags."
14537 (interactive "P")
14538 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14539 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14540 'region-start-level 'region))
14541 org-loop-over-headlines-in-active-region)
14542 (org-map-entries
14543 ;; We don't use ARG and JUST-ALIGN here because these args
14544 ;; are not useful when looping over headlines.
14545 `(org-set-tags)
14546 org-loop-over-headlines-in-active-region
14547 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14548 (let* ((re org-outline-regexp-bol)
14549 (current (unless arg (org-get-tags-string)))
14550 (col (current-column))
14551 (org-setting-tags t)
14552 table current-tags inherited-tags ; computed below when needed
14553 tags p0 c0 c1 rpl di tc level)
14554 (if arg
14555 (save-excursion
14556 (goto-char (point-min))
14557 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14558 (while (re-search-forward re nil t)
14559 (org-set-tags nil t)
14560 (end-of-line 1)))
14561 (message "All tags realigned to column %d" org-tags-column))
14562 (if just-align
14563 (setq tags current)
14564 ;; Get a new set of tags from the user
14565 (save-excursion
14566 (setq table (append org-tag-persistent-alist
14567 (or org-tag-alist (org-get-buffer-tags))
14568 (and
14569 org-complete-tags-always-offer-all-agenda-tags
14570 (org-global-tags-completion-table
14571 (org-agenda-files))))
14572 org-last-tags-completion-table table
14573 current-tags (org-split-string current ":")
14574 inherited-tags (nreverse
14575 (nthcdr (length current-tags)
14576 (nreverse (org-get-tags-at))))
14577 tags
14578 (if (or (eq t org-use-fast-tag-selection)
14579 (and org-use-fast-tag-selection
14580 (delq nil (mapcar 'cdr table))))
14581 (org-fast-tag-selection
14582 current-tags inherited-tags table
14583 (if org-fast-tag-selection-include-todo
14584 org-todo-key-alist))
14585 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14586 (org-trim
14587 (org-icompleting-read "Tags: "
14588 'org-tags-completion-function
14589 nil nil current 'org-tags-history))))))
14590 (while (string-match "[-+&]+" tags)
14591 ;; No boolean logic, just a list
14592 (setq tags (replace-match ":" t t tags))))
14594 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14596 (if org-tags-sort-function
14597 (setq tags (mapconcat 'identity
14598 (sort (org-split-string
14599 tags (org-re "[^[:alnum:]_@#%]+"))
14600 org-tags-sort-function) ":")))
14602 (if (string-match "\\`[\t ]*\\'" tags)
14603 (setq tags "")
14604 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14605 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14607 ;; Insert new tags at the correct column
14608 (beginning-of-line 1)
14609 (setq level (or (and (looking-at org-outline-regexp)
14610 (- (match-end 0) (point) 1))
14612 (cond
14613 ((and (equal current "") (equal tags "")))
14614 ((re-search-forward
14615 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14616 (point-at-eol) t)
14617 (if (equal tags "")
14618 (setq rpl "")
14619 (goto-char (match-beginning 0))
14620 (setq c0 (current-column)
14621 ;; compute offset for the case of org-indent-mode active
14622 di (if (org-bound-and-true-p org-indent-mode)
14623 (* (1- org-indent-indentation-per-level) (1- level))
14625 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14626 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14627 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14628 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14629 (replace-match rpl t t)
14630 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14631 tags)
14632 (t (error "Tags alignment failed")))
14633 (org-move-to-column col)
14634 (unless just-align
14635 (run-hooks 'org-after-tags-change-hook))))))
14637 (defun org-change-tag-in-region (beg end tag off)
14638 "Add or remove TAG for each entry in the region.
14639 This works in the agenda, and also in an org-mode buffer."
14640 (interactive
14641 (list (region-beginning) (region-end)
14642 (let ((org-last-tags-completion-table
14643 (if (derived-mode-p 'org-mode)
14644 (org-uniquify
14645 (delq nil (append (org-get-buffer-tags)
14646 (org-global-tags-completion-table))))
14647 (org-global-tags-completion-table))))
14648 (org-icompleting-read
14649 "Tag: " 'org-tags-completion-function nil nil nil
14650 'org-tags-history))
14651 (progn
14652 (message "[s]et or [r]emove? ")
14653 (equal (read-char-exclusive) ?r))))
14654 (if (fboundp 'deactivate-mark) (deactivate-mark))
14655 (let ((agendap (equal major-mode 'org-agenda-mode))
14656 l1 l2 m buf pos newhead (cnt 0))
14657 (goto-char end)
14658 (setq l2 (1- (org-current-line)))
14659 (goto-char beg)
14660 (setq l1 (org-current-line))
14661 (loop for l from l1 to l2 do
14662 (org-goto-line l)
14663 (setq m (get-text-property (point) 'org-hd-marker))
14664 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14665 (and agendap m))
14666 (setq buf (if agendap (marker-buffer m) (current-buffer))
14667 pos (if agendap m (point)))
14668 (with-current-buffer buf
14669 (save-excursion
14670 (save-restriction
14671 (goto-char pos)
14672 (setq cnt (1+ cnt))
14673 (org-toggle-tag tag (if off 'off 'on))
14674 (setq newhead (org-get-heading)))))
14675 (and agendap (org-agenda-change-all-lines newhead m))))
14676 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14678 (defun org-tags-completion-function (string predicate &optional flag)
14679 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14680 (confirm (lambda (x) (stringp (car x)))))
14681 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14682 (setq s1 (match-string 1 string)
14683 s2 (match-string 2 string))
14684 (setq s1 "" s2 string))
14685 (cond
14686 ((eq flag nil)
14687 ;; try completion
14688 (setq rtn (try-completion s2 ctable confirm))
14689 (if (stringp rtn)
14690 (setq rtn
14691 (concat s1 s2 (substring rtn (length s2))
14692 (if (and org-add-colon-after-tag-completion
14693 (assoc rtn ctable))
14694 ":" ""))))
14695 rtn)
14696 ((eq flag t)
14697 ;; all-completions
14698 (all-completions s2 ctable confirm))
14699 ((eq flag 'lambda)
14700 ;; exact match?
14701 (assoc s2 ctable)))))
14703 (defun org-fast-tag-insert (kwd tags face &optional end)
14704 "Insert KDW, and the TAGS, the latter with face FACE.
14705 Also insert END."
14706 (insert (format "%-12s" (concat kwd ":"))
14707 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14708 (or end "")))
14710 (defun org-fast-tag-show-exit (flag)
14711 (save-excursion
14712 (org-goto-line 3)
14713 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14714 (replace-match ""))
14715 (when flag
14716 (end-of-line 1)
14717 (org-move-to-column (- (window-width) 19) t)
14718 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14720 (defun org-set-current-tags-overlay (current prefix)
14721 "Add an overlay to CURRENT tag with PREFIX."
14722 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14723 (if (featurep 'xemacs)
14724 (org-overlay-display org-tags-overlay (concat prefix s)
14725 'secondary-selection)
14726 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14727 (org-overlay-display org-tags-overlay (concat prefix s)))))
14729 (defvar org-last-tag-selection-key nil)
14730 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14731 "Fast tag selection with single keys.
14732 CURRENT is the current list of tags in the headline, INHERITED is the
14733 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14734 possibly with grouping information. TODO-TABLE is a similar table with
14735 TODO keywords, should these have keys assigned to them.
14736 If the keys are nil, a-z are automatically assigned.
14737 Returns the new tags string, or nil to not change the current settings."
14738 (let* ((fulltable (append table todo-table))
14739 (maxlen (apply 'max (mapcar
14740 (lambda (x)
14741 (if (stringp (car x)) (string-width (car x)) 0))
14742 fulltable)))
14743 (buf (current-buffer))
14744 (expert (eq org-fast-tag-selection-single-key 'expert))
14745 (buffer-tags nil)
14746 (fwidth (+ maxlen 3 1 3))
14747 (ncol (/ (- (window-width) 4) fwidth))
14748 (i-face 'org-done)
14749 (c-face 'org-todo)
14750 tg cnt e c char c1 c2 ntable tbl rtn
14751 ov-start ov-end ov-prefix
14752 (exit-after-next org-fast-tag-selection-single-key)
14753 (done-keywords org-done-keywords)
14754 groups ingroup)
14755 (save-excursion
14756 (beginning-of-line 1)
14757 (if (looking-at
14758 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14759 (setq ov-start (match-beginning 1)
14760 ov-end (match-end 1)
14761 ov-prefix "")
14762 (setq ov-start (1- (point-at-eol))
14763 ov-end (1+ ov-start))
14764 (skip-chars-forward "^\n\r")
14765 (setq ov-prefix
14766 (concat
14767 (buffer-substring (1- (point)) (point))
14768 (if (> (current-column) org-tags-column)
14770 (make-string (- org-tags-column (current-column)) ?\ ))))))
14771 (move-overlay org-tags-overlay ov-start ov-end)
14772 (save-window-excursion
14773 (if expert
14774 (set-buffer (get-buffer-create " *Org tags*"))
14775 (delete-other-windows)
14776 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
14777 (org-switch-to-buffer-other-window " *Org tags*"))
14778 (erase-buffer)
14779 (org-set-local 'org-done-keywords done-keywords)
14780 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14781 (org-fast-tag-insert "Current" current c-face "\n\n")
14782 (org-fast-tag-show-exit exit-after-next)
14783 (org-set-current-tags-overlay current ov-prefix)
14784 (setq tbl fulltable char ?a cnt 0)
14785 (while (setq e (pop tbl))
14786 (cond
14787 ((equal (car e) :startgroup)
14788 (push '() groups) (setq ingroup t)
14789 (when (not (= cnt 0))
14790 (setq cnt 0)
14791 (insert "\n"))
14792 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14793 ((equal (car e) :endgroup)
14794 (setq ingroup nil cnt 0)
14795 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14796 ((equal e '(:newline))
14797 (when (not (= cnt 0))
14798 (setq cnt 0)
14799 (insert "\n")
14800 (setq e (car tbl))
14801 (while (equal (car tbl) '(:newline))
14802 (insert "\n")
14803 (setq tbl (cdr tbl)))))
14804 ((equal e '(:grouptags)) nil)
14806 (setq tg (copy-sequence (car e)) c2 nil)
14807 (if (cdr e)
14808 (setq c (cdr e))
14809 ;; automatically assign a character.
14810 (setq c1 (string-to-char
14811 (downcase (substring
14812 tg (if (= (string-to-char tg) ?@) 1 0)))))
14813 (if (or (rassoc c1 ntable) (rassoc c1 table))
14814 (while (or (rassoc char ntable) (rassoc char table))
14815 (setq char (1+ char)))
14816 (setq c2 c1))
14817 (setq c (or c2 char)))
14818 (if ingroup (push tg (car groups)))
14819 (setq tg (org-add-props tg nil 'face
14820 (cond
14821 ((not (assoc tg table))
14822 (org-get-todo-face tg))
14823 ((member tg current) c-face)
14824 ((member tg inherited) i-face))))
14825 (if (equal (caar tbl) :grouptags)
14826 (org-add-props tg nil 'face 'org-tag-group))
14827 (if (and (= cnt 0) (not ingroup)) (insert " "))
14828 (insert "[" c "] " tg (make-string
14829 (- fwidth 4 (length tg)) ?\ ))
14830 (push (cons tg c) ntable)
14831 (when (= (setq cnt (1+ cnt)) ncol)
14832 (insert "\n")
14833 (if ingroup (insert " "))
14834 (setq cnt 0)))))
14835 (setq ntable (nreverse ntable))
14836 (insert "\n")
14837 (goto-char (point-min))
14838 (if (not expert) (org-fit-window-to-buffer))
14839 (setq rtn
14840 (catch 'exit
14841 (while t
14842 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14843 (if (not groups) "no " "")
14844 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14845 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14846 (setq org-last-tag-selection-key c)
14847 (cond
14848 ((= c ?\r) (throw 'exit t))
14849 ((= c ?!)
14850 (setq groups (not groups))
14851 (goto-char (point-min))
14852 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14853 ((= c ?\C-c)
14854 (if (not expert)
14855 (org-fast-tag-show-exit
14856 (setq exit-after-next (not exit-after-next)))
14857 (setq expert nil)
14858 (delete-other-windows)
14859 (set-window-buffer (split-window-vertically) " *Org tags*")
14860 (org-switch-to-buffer-other-window " *Org tags*")
14861 (org-fit-window-to-buffer)))
14862 ((or (= c ?\C-g)
14863 (and (= c ?q) (not (rassoc c ntable))))
14864 (org-detach-overlay org-tags-overlay)
14865 (setq quit-flag t))
14866 ((= c ?\ )
14867 (setq current nil)
14868 (if exit-after-next (setq exit-after-next 'now)))
14869 ((= c ?\t)
14870 (condition-case nil
14871 (setq tg (org-icompleting-read
14872 "Tag: "
14873 (or buffer-tags
14874 (with-current-buffer buf
14875 (org-get-buffer-tags)))))
14876 (quit (setq tg "")))
14877 (when (string-match "\\S-" tg)
14878 (add-to-list 'buffer-tags (list tg))
14879 (if (member tg current)
14880 (setq current (delete tg current))
14881 (push tg current)))
14882 (if exit-after-next (setq exit-after-next 'now)))
14883 ((setq e (rassoc c todo-table) tg (car e))
14884 (with-current-buffer buf
14885 (save-excursion (org-todo tg)))
14886 (if exit-after-next (setq exit-after-next 'now)))
14887 ((setq e (rassoc c ntable) tg (car e))
14888 (if (member tg current)
14889 (setq current (delete tg current))
14890 (loop for g in groups do
14891 (if (member tg g)
14892 (mapc (lambda (x)
14893 (setq current (delete x current)))
14894 g)))
14895 (push tg current))
14896 (if exit-after-next (setq exit-after-next 'now))))
14898 ;; Create a sorted list
14899 (setq current
14900 (sort current
14901 (lambda (a b)
14902 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14903 (if (eq exit-after-next 'now) (throw 'exit t))
14904 (goto-char (point-min))
14905 (beginning-of-line 2)
14906 (delete-region (point) (point-at-eol))
14907 (org-fast-tag-insert "Current" current c-face)
14908 (org-set-current-tags-overlay current ov-prefix)
14909 (while (re-search-forward
14910 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14911 (setq tg (match-string 1))
14912 (add-text-properties
14913 (match-beginning 1) (match-end 1)
14914 (list 'face
14915 (cond
14916 ((member tg current) c-face)
14917 ((member tg inherited) i-face)
14918 (t (get-text-property (match-beginning 1) 'face))))))
14919 (goto-char (point-min)))))
14920 (org-detach-overlay org-tags-overlay)
14921 (if rtn
14922 (mapconcat 'identity current ":")
14923 nil))))
14925 (defun org-get-tags-string ()
14926 "Get the TAGS string in the current headline."
14927 (unless (org-at-heading-p t)
14928 (user-error "Not on a heading"))
14929 (save-excursion
14930 (beginning-of-line 1)
14931 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14932 (org-match-string-no-properties 1)
14933 "")))
14935 (defun org-get-tags ()
14936 "Get the list of tags specified in the current headline."
14937 (org-split-string (org-get-tags-string) ":"))
14939 (defun org-get-buffer-tags ()
14940 "Get a table of all tags used in the buffer, for completion."
14941 (let (tags)
14942 (save-excursion
14943 (goto-char (point-min))
14944 (while (re-search-forward
14945 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
14946 (when (equal (char-after (point-at-bol 0)) ?*)
14947 (mapc (lambda (x) (add-to-list 'tags x))
14948 (org-split-string (org-match-string-no-properties 1) ":")))))
14949 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14950 (mapcar 'list tags)))
14952 ;;;; The mapping API
14954 (defun org-map-entries (func &optional match scope &rest skip)
14955 "Call FUNC at each headline selected by MATCH in SCOPE.
14957 FUNC is a function or a lisp form. The function will be called without
14958 arguments, with the cursor positioned at the beginning of the headline.
14959 The return values of all calls to the function will be collected and
14960 returned as a list.
14962 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14963 does not need to preserve point. After evaluation, the cursor will be
14964 moved to the end of the line (presumably of the headline of the
14965 processed entry) and search continues from there. Under some
14966 circumstances, this may not produce the wanted results. For example,
14967 if you have removed (e.g. archived) the current (sub)tree it could
14968 mean that the next entry will be skipped entirely. In such cases, you
14969 can specify the position from where search should continue by making
14970 FUNC set the variable `org-map-continue-from' to the desired buffer
14971 position.
14973 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14974 Only headlines that are matched by this query will be considered during
14975 the iteration. When MATCH is nil or t, all headlines will be
14976 visited by the iteration.
14978 SCOPE determines the scope of this command. It can be any of:
14980 nil The current buffer, respecting the restriction if any
14981 tree The subtree started with the entry at point
14982 region The entries within the active region, if any
14983 region-start-level
14984 The entries within the active region, but only those at
14985 the same level than the first one.
14986 file The current buffer, without restriction
14987 file-with-archives
14988 The current buffer, and any archives associated with it
14989 agenda All agenda files
14990 agenda-with-archives
14991 All agenda files with any archive files associated with them
14992 \(file1 file2 ...)
14993 If this is a list, all files in the list will be scanned
14995 The remaining args are treated as settings for the skipping facilities of
14996 the scanner. The following items can be given here:
14998 archive skip trees with the archive tag
14999 comment skip trees with the COMMENT keyword
15000 function or Emacs Lisp form:
15001 will be used as value for `org-agenda-skip-function', so
15002 whenever the function returns a position, FUNC will not be
15003 called for that entry and search will continue from the
15004 position returned
15006 If your function needs to retrieve the tags including inherited tags
15007 at the *current* entry, you can use the value of the variable
15008 `org-scanner-tags' which will be much faster than getting the value
15009 with `org-get-tags-at'. If your function gets properties with
15010 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15011 to t around the call to `org-entry-properties' to get the same speedup.
15012 Note that if your function moves around to retrieve tags and properties at
15013 a *different* entry, you cannot use these techniques."
15014 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15015 (not (org-region-active-p)))
15016 (let* ((org-agenda-archives-mode nil) ; just to make sure
15017 (org-agenda-skip-archived-trees (memq 'archive skip))
15018 (org-agenda-skip-comment-trees (memq 'comment skip))
15019 (org-agenda-skip-function
15020 (car (org-delete-all '(comment archive) skip)))
15021 (org-tags-match-list-sublevels t)
15022 (start-level (eq scope 'region-start-level))
15023 matcher file res
15024 org-todo-keywords-for-agenda
15025 org-done-keywords-for-agenda
15026 org-todo-keyword-alist-for-agenda
15027 org-drawers-for-agenda
15028 org-tag-alist-for-agenda
15029 todo-only)
15031 (cond
15032 ((eq match t) (setq matcher t))
15033 ((eq match nil) (setq matcher t))
15034 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15036 (save-excursion
15037 (save-restriction
15038 (cond ((eq scope 'tree)
15039 (org-back-to-heading t)
15040 (org-narrow-to-subtree)
15041 (setq scope nil))
15042 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15043 (org-region-active-p))
15044 ;; If needed, set start-level to a string like "2"
15045 (when start-level
15046 (save-excursion
15047 (goto-char (region-beginning))
15048 (unless (org-at-heading-p) (outline-next-heading))
15049 (setq start-level (org-current-level))))
15050 (narrow-to-region (region-beginning)
15051 (save-excursion
15052 (goto-char (region-end))
15053 (unless (and (bolp) (org-at-heading-p))
15054 (outline-next-heading))
15055 (point)))
15056 (setq scope nil)))
15058 (if (not scope)
15059 (progn
15060 (org-agenda-prepare-buffers
15061 (list (buffer-file-name (current-buffer))))
15062 (setq res (org-scan-tags func matcher todo-only start-level)))
15063 ;; Get the right scope
15064 (cond
15065 ((and scope (listp scope) (symbolp (car scope)))
15066 (setq scope (eval scope)))
15067 ((eq scope 'agenda)
15068 (setq scope (org-agenda-files t)))
15069 ((eq scope 'agenda-with-archives)
15070 (setq scope (org-agenda-files t))
15071 (setq scope (org-add-archive-files scope)))
15072 ((eq scope 'file)
15073 (setq scope (list (buffer-file-name))))
15074 ((eq scope 'file-with-archives)
15075 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15076 (org-agenda-prepare-buffers scope)
15077 (while (setq file (pop scope))
15078 (with-current-buffer (org-find-base-buffer-visiting file)
15079 (save-excursion
15080 (save-restriction
15081 (widen)
15082 (goto-char (point-min))
15083 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15084 res)))
15086 ;;;; Properties
15088 ;;; Setting and retrieving properties
15090 (defconst org-special-properties
15091 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15092 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15093 "The special properties valid in Org-mode.
15095 These are properties that are not defined in the property drawer,
15096 but in some other way.")
15098 (defconst org-default-properties
15099 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15100 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15101 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15102 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15103 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15104 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15105 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15106 "Some properties that are used by Org-mode for various purposes.
15107 Being in this list makes sure that they are offered for completion.")
15109 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
15110 "Regular expression matching the first line of a property drawer.")
15112 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
15113 "Regular expression matching the last line of a property drawer.")
15115 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
15116 "Regular expression matching the first line of a property drawer.")
15118 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
15119 "Regular expression matching the first line of a property drawer.")
15121 (defconst org-property-drawer-re
15122 (concat "\\(" org-property-start-re "\\)[^\000]*\\("
15123 org-property-end-re "\\)\n?")
15124 "Matches an entire property drawer.")
15126 (defconst org-clock-drawer-re
15127 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
15128 org-property-end-re "\\)\n?")
15129 "Matches an entire clock drawer.")
15131 (defun org-property-action ()
15132 "Do an action on properties."
15133 (interactive)
15134 (let (c)
15135 (org-at-property-p)
15136 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15137 (setq c (read-char-exclusive))
15138 (cond
15139 ((equal c ?s)
15140 (call-interactively 'org-set-property))
15141 ((equal c ?d)
15142 (call-interactively 'org-delete-property))
15143 ((equal c ?D)
15144 (call-interactively 'org-delete-property-globally))
15145 ((equal c ?c)
15146 (call-interactively 'org-compute-property-at-point))
15147 (t (user-error "No such property action %c" c)))))
15149 (defun org-inc-effort ()
15150 "Increment the value of the effort property in the current entry."
15151 (interactive)
15152 (org-set-effort nil t))
15154 (defvar org-clock-effort) ;; Defined in org-clock.el
15155 (defvar org-clock-current-task) ;; Defined in org-clock.el
15156 (defun org-set-effort (&optional value increment)
15157 "Set the effort property of the current entry.
15158 With numerical prefix arg, use the nth allowed value, 0 stands for the
15159 10th allowed value.
15161 When INCREMENT is non-nil, set the property to the next allowed value."
15162 (interactive "P")
15163 (if (equal value 0) (setq value 10))
15164 (let* ((completion-ignore-case t)
15165 (prop org-effort-property)
15166 (cur (org-entry-get nil prop))
15167 (allowed (org-property-get-allowed-values nil prop 'table))
15168 (existing (mapcar 'list (org-property-values prop)))
15169 (heading (nth 4 (org-heading-components)))
15171 (val (cond
15172 ((stringp value) value)
15173 ((and allowed (integerp value))
15174 (or (car (nth (1- value) allowed))
15175 (car (org-last allowed))))
15176 ((and allowed increment)
15177 (or (caadr (member (list cur) allowed))
15178 (user-error "Allowed effort values are not set")))
15179 (allowed
15180 (message "Select 1-9,0, [RET%s]: %s"
15181 (if cur (concat "=" cur) "")
15182 (mapconcat 'car allowed " "))
15183 (setq rpl (read-char-exclusive))
15184 (if (equal rpl ?\r)
15186 (setq rpl (- rpl ?0))
15187 (if (equal rpl 0) (setq rpl 10))
15188 (if (and (> rpl 0) (<= rpl (length allowed)))
15189 (car (nth (1- rpl) allowed))
15190 (org-completing-read "Effort: " allowed nil))))
15192 (let (org-completion-use-ido org-completion-use-iswitchb)
15193 (org-completing-read
15194 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15195 (concat "[" cur "]") "")
15196 ": ")
15197 existing nil nil "" nil cur))))))
15198 (unless (equal (org-entry-get nil prop) val)
15199 (org-entry-put nil prop val))
15200 (save-excursion
15201 (org-back-to-heading t)
15202 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15203 (when (string= heading org-clock-current-task)
15204 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15205 (org-clock-update-mode-line))
15206 (message "%s is now %s" prop val)))
15208 (defun org-at-property-p ()
15209 "Is cursor inside a property drawer?"
15210 (save-excursion
15211 (when (equal 'node-property (car (org-element-at-point)))
15212 (beginning-of-line 1)
15213 (looking-at org-property-re))))
15215 (defun org-get-property-block (&optional beg end force)
15216 "Return the (beg . end) range of the body of the property drawer.
15217 BEG and END are the beginning and end of the current subtree, or of
15218 the part before the first headline. If they are not given, they will
15219 be found. If the drawer does not exist and FORCE is non-nil, create
15220 the drawer."
15221 (catch 'exit
15222 (save-excursion
15223 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15224 (progn (org-back-to-heading t) (point))))
15225 (end (or end (and (not (outline-next-heading)) (point-max))
15226 (point))))
15227 (goto-char beg)
15228 (if (re-search-forward org-property-start-re end t)
15229 (setq beg (1+ (match-end 0)))
15230 (if force
15231 (save-excursion
15232 (org-insert-property-drawer)
15233 (setq end (progn (outline-next-heading) (point))))
15234 (throw 'exit nil))
15235 (goto-char beg)
15236 (if (re-search-forward org-property-start-re end t)
15237 (setq beg (1+ (match-end 0)))))
15238 (if (re-search-forward org-property-end-re end t)
15239 (setq end (match-beginning 0))
15240 (or force (throw 'exit nil))
15241 (goto-char beg)
15242 (setq end beg)
15243 (org-indent-line)
15244 (insert ":END:\n"))
15245 (cons beg end)))))
15247 (defun org-entry-properties (&optional pom which specific)
15248 "Get all properties of the entry at point-or-marker POM.
15249 This includes the TODO keyword, the tags, time strings for deadline,
15250 scheduled, and clocking, and any additional properties defined in the
15251 entry. The return value is an alist, keys may occur multiple times
15252 if the property key was used several times.
15253 POM may also be nil, in which case the current entry is used.
15254 If WHICH is nil or `all', get all properties. If WHICH is
15255 `special' or `standard', only get that subclass. If WHICH
15256 is a string only get exactly this property. SPECIFIC can be a string, the
15257 specific property we are interested in. Specifying it can speed
15258 things up because then unnecessary parsing is avoided."
15259 (setq which (or which 'all))
15260 (org-with-wide-buffer
15261 (org-with-point-at pom
15262 (let ((clockstr (substring org-clock-string 0 -1))
15263 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15264 (case-fold-search nil)
15265 beg end range props sum-props key key1 value string clocksum clocksumt)
15266 (when (and (derived-mode-p 'org-mode)
15267 (ignore-errors (org-back-to-heading t)))
15268 (setq beg (point))
15269 (setq sum-props (get-text-property (point) 'org-summaries))
15270 (setq clocksum (get-text-property (point) :org-clock-minutes)
15271 clocksumt (get-text-property (point) :org-clock-minutes-today))
15272 (outline-next-heading)
15273 (setq end (point))
15274 (when (memq which '(all special))
15275 ;; Get the special properties, like TODO and tags
15276 (goto-char beg)
15277 (when (and (or (not specific) (string= specific "TODO"))
15278 (looking-at org-todo-line-regexp) (match-end 2))
15279 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15280 (when (and (or (not specific) (string= specific "PRIORITY"))
15281 (looking-at org-priority-regexp))
15282 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15283 (when (or (not specific) (string= specific "FILE"))
15284 (push (cons "FILE" buffer-file-name) props))
15285 (when (and (or (not specific) (string= specific "TAGS"))
15286 (setq value (org-get-tags-string))
15287 (string-match "\\S-" value))
15288 (push (cons "TAGS" value) props))
15289 (when (and (or (not specific) (string= specific "ALLTAGS"))
15290 (setq value (org-get-tags-at)))
15291 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15292 ":"))
15293 props))
15294 (when (or (not specific) (string= specific "BLOCKED"))
15295 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15296 (when (or (not specific)
15297 (member specific
15298 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15299 "TIMESTAMP" "TIMESTAMP_IA")))
15300 (catch 'match
15301 (while (and (re-search-forward org-maybe-keyword-time-regexp end t)
15302 (not (text-property-any 0 (length (match-string 0))
15303 'face 'font-lock-comment-face
15304 (match-string 0))))
15305 (setq key (if (match-end 1)
15306 (substring (org-match-string-no-properties 1)
15307 0 -1))
15308 string (if (equal key clockstr)
15309 (org-trim
15310 (buffer-substring-no-properties
15311 (match-beginning 3) (goto-char
15312 (point-at-eol))))
15313 (substring (org-match-string-no-properties 3)
15314 1 -1)))
15315 ;; Get the correct property name from the key. This is
15316 ;; necessary if the user has configured time keywords.
15317 (setq key1 (concat key ":"))
15318 (cond
15319 ((not key)
15320 (setq key
15321 (if (= (char-after (match-beginning 3)) ?\[)
15322 "TIMESTAMP_IA" "TIMESTAMP")))
15323 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15324 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15325 ((equal key1 org-closed-string) (setq key "CLOSED"))
15326 ((equal key1 org-clock-string) (setq key "CLOCK")))
15327 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15328 (progn
15329 (push (cons key string) props)
15330 ;; no need to search further if match is found
15331 (throw 'match t))
15332 (when (or (equal key "CLOCK") (not (assoc key props)))
15333 (push (cons key string) props)))))))
15335 (when (memq which '(all standard))
15336 ;; Get the standard properties, like :PROP: ...
15337 (setq range (org-get-property-block beg end))
15338 (when range
15339 (goto-char (car range))
15340 (while (re-search-forward org-property-re
15341 (cdr range) t)
15342 (setq key (org-match-string-no-properties 2)
15343 value (org-trim (or (org-match-string-no-properties 3) "")))
15344 (unless (member key excluded)
15345 (push (cons key (or value "")) props)))))
15346 (if clocksum
15347 (push (cons "CLOCKSUM"
15348 (org-columns-number-to-string (/ (float clocksum) 60.)
15349 'add_times))
15350 props))
15351 (if clocksumt
15352 (push (cons "CLOCKSUM_T"
15353 (org-columns-number-to-string (/ (float clocksumt) 60.)
15354 'add_times))
15355 props))
15356 (unless (assoc "CATEGORY" props)
15357 (push (cons "CATEGORY" (org-get-category)) props))
15358 (append sum-props (nreverse props)))))))
15360 (defun org-entry-get (pom property &optional inherit literal-nil)
15361 "Get value of PROPERTY for entry or content at point-or-marker POM.
15362 If INHERIT is non-nil and the entry does not have the property,
15363 then also check higher levels of the hierarchy.
15364 If INHERIT is the symbol `selective', use inheritance only if the setting
15365 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15366 If the property is present but empty, the return value is the empty string.
15367 If the property is not present at all, nil is returned.
15369 Return the value as a string.
15371 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15372 do not interpret it as the list atom nil. This is used for inheritance
15373 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15374 (org-with-point-at pom
15375 (if (and inherit (if (eq inherit 'selective)
15376 (org-property-inherit-p property)
15378 (org-entry-get-with-inheritance property literal-nil)
15379 (if (member property org-special-properties)
15380 ;; We need a special property. Use `org-entry-properties'
15381 ;; to retrieve it, but specify the wanted property
15382 (cdr (assoc property (org-entry-properties nil 'special property)))
15383 (org-with-wide-buffer
15384 (let ((range (org-get-property-block)))
15385 (when (and range (not (eq (car range) (cdr range)))
15386 (save-excursion
15387 (goto-char (car range))
15388 (re-search-forward
15389 (concat (org-re-property property) "\\|"
15390 (org-re-property (concat property "+")))
15391 (cdr range) t)))
15392 (let* ((props
15393 (list (or (assoc property org-file-properties)
15394 (assoc property org-global-properties)
15395 (assoc property org-global-properties-fixed))))
15396 (ap (lambda (key)
15397 (when (re-search-forward
15398 (org-re-property key) (cdr range) t)
15399 (setq props
15400 (org-update-property-plist
15402 (if (match-end 3)
15403 (org-match-string-no-properties 3) "")
15404 props)))))
15405 val)
15406 (goto-char (car range))
15407 (funcall ap property)
15408 (goto-char (car range))
15409 (while (funcall ap (concat property "+")))
15410 (setq val (cdr (assoc property props)))
15411 (when val (if literal-nil val (org-not-nil val)))))))))))
15413 (defun org-property-or-variable-value (var &optional inherit)
15414 "Check if there is a property fixing the value of VAR.
15415 If yes, return this value. If not, return the current value of the variable."
15416 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15417 (if (and prop (stringp prop) (string-match "\\S-" prop))
15418 (read prop)
15419 (symbol-value var))))
15421 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15422 "Delete the property PROPERTY from entry at point-or-marker POM.
15423 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15424 an empty drawer to delete."
15425 (org-with-point-at pom
15426 (if (member property org-special-properties)
15427 nil ; cannot delete these properties.
15428 (let ((range (org-get-property-block)))
15429 (if (and range
15430 (goto-char (car range))
15431 (re-search-forward
15432 (org-re-property property nil t)
15433 (cdr range) t))
15434 (progn
15435 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15436 (and delete-empty-drawer
15437 (org-remove-empty-drawer-at
15438 delete-empty-drawer (car range)))
15440 nil)))))
15442 ;; Multi-values properties are properties that contain multiple values
15443 ;; These values are assumed to be single words, separated by whitespace.
15444 (defun org-entry-add-to-multivalued-property (pom property value)
15445 "Add VALUE to the 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 (unless (member value values)
15450 (setq values (append values (list value)))
15451 (org-entry-put pom property
15452 (mapconcat 'identity values " ")))))
15454 (defun org-entry-remove-from-multivalued-property (pom property value)
15455 "Remove VALUE from 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 (when (member value values)
15460 (setq values (delete value values))
15461 (org-entry-put pom property
15462 (mapconcat 'identity values " ")))))
15464 (defun org-entry-member-in-multivalued-property (pom property value)
15465 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15466 (let* ((old (org-entry-get pom property))
15467 (values (and old (org-split-string old "[ \t]"))))
15468 (setq value (org-entry-protect-space value))
15469 (member value values)))
15471 (defun org-entry-get-multivalued-property (pom property)
15472 "Return a list of values in a multivalued property."
15473 (let* ((value (org-entry-get pom property))
15474 (values (and value (org-split-string value "[ \t]"))))
15475 (mapcar 'org-entry-restore-space values)))
15477 (defun org-entry-put-multivalued-property (pom property &rest values)
15478 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15479 VALUES should be a list of strings. Spaces will be protected."
15480 (org-entry-put pom property
15481 (mapconcat 'org-entry-protect-space values " "))
15482 (let* ((value (org-entry-get pom property))
15483 (values (and value (org-split-string value "[ \t]"))))
15484 (mapcar 'org-entry-restore-space values)))
15486 (defun org-entry-protect-space (s)
15487 "Protect spaces and newline in string S."
15488 (while (string-match " " s)
15489 (setq s (replace-match "%20" t t s)))
15490 (while (string-match "\n" s)
15491 (setq s (replace-match "%0A" t t s)))
15494 (defun org-entry-restore-space (s)
15495 "Restore spaces and newline in string S."
15496 (while (string-match "%20" s)
15497 (setq s (replace-match " " t t s)))
15498 (while (string-match "%0A" s)
15499 (setq s (replace-match "\n" t t s)))
15502 (defvar org-entry-property-inherited-from (make-marker)
15503 "Marker pointing to the entry from where a property was inherited.
15504 Each call to `org-entry-get-with-inheritance' will set this marker to the
15505 location of the entry where the inheritance search matched. If there was
15506 no match, the marker will point nowhere.
15507 Note that also `org-entry-get' calls this function, if the INHERIT flag
15508 is set.")
15510 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15511 "Get PROPERTY of entry or content at point, search higher levels if needed.
15512 The search will stop at the first ancestor which has the property defined.
15513 If the value found is \"nil\", return nil to show that the property
15514 should be considered as undefined (this is the meaning of nil here).
15515 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15516 (move-marker org-entry-property-inherited-from nil)
15517 (let (tmp)
15518 (save-excursion
15519 (save-restriction
15520 (widen)
15521 (catch 'ex
15522 (while t
15523 (when (setq tmp (org-entry-get nil property nil literal-nil))
15524 (or (ignore-errors (org-back-to-heading t))
15525 (goto-char (point-min)))
15526 (move-marker org-entry-property-inherited-from (point))
15527 (throw 'ex tmp))
15528 (or (ignore-errors (org-up-heading-safe))
15529 (throw 'ex nil))))))
15530 (setq tmp (or tmp
15531 (cdr (assoc property org-file-properties))
15532 (cdr (assoc property org-global-properties))
15533 (cdr (assoc property org-global-properties-fixed))))
15534 (if literal-nil tmp (org-not-nil tmp))))
15536 (defvar org-property-changed-functions nil
15537 "Hook called when the value of a property has changed.
15538 Each hook function should accept two arguments, the name of the property
15539 and the new value.")
15541 (defun org-entry-put (pom property value)
15542 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15543 If the value is `nil', it is converted to the empty string.
15544 If it is not a string, an error is raised."
15545 (cond ((null value) (setq value ""))
15546 ((not (stringp value))
15547 (error "Properties values should be strings.")))
15548 (org-with-point-at pom
15549 (org-back-to-heading t)
15550 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15551 range)
15552 (cond
15553 ((equal property "TODO")
15554 (when (and (string-match "\\S-" value)
15555 (not (member value org-todo-keywords-1)))
15556 (user-error "\"%s\" is not a valid TODO state" value))
15557 (if (or (not value)
15558 (not (string-match "\\S-" value)))
15559 (setq value 'none))
15560 (org-todo value)
15561 (org-set-tags nil 'align))
15562 ((equal property "PRIORITY")
15563 (org-priority (if (and value (string-match "\\S-" value))
15564 (string-to-char value) ?\ ))
15565 (org-set-tags nil 'align))
15566 ((equal property "CLOCKSUM")
15567 (if (not (re-search-forward
15568 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15569 (error "Cannot find a clock log")
15570 (goto-char (- (match-end 1) 2))
15571 (cond
15572 ((eq value 'earlier) (org-timestamp-down))
15573 ((eq value 'later) (org-timestamp-up)))
15574 (org-clock-sum-current-item)))
15575 ((equal property "SCHEDULED")
15576 (if (re-search-forward org-scheduled-time-regexp end t)
15577 (cond
15578 ((eq value 'earlier) (org-timestamp-change -1 'day))
15579 ((eq value 'later) (org-timestamp-change 1 'day))
15580 (t (call-interactively 'org-schedule)))
15581 (call-interactively 'org-schedule)))
15582 ((equal property "DEADLINE")
15583 (if (re-search-forward org-deadline-time-regexp end t)
15584 (cond
15585 ((eq value 'earlier) (org-timestamp-change -1 'day))
15586 ((eq value 'later) (org-timestamp-change 1 'day))
15587 (t (call-interactively 'org-deadline)))
15588 (call-interactively 'org-deadline)))
15589 ((member property org-special-properties)
15590 (error "The %s property can not yet be set with `org-entry-put'"
15591 property))
15592 (t ; a non-special property
15593 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15594 (setq range (org-get-property-block beg end 'force))
15595 (goto-char (car range))
15596 (if (re-search-forward
15597 (org-re-property property nil t) (cdr range) t)
15598 (progn
15599 (delete-region (match-beginning 0) (match-end 0))
15600 (goto-char (match-beginning 0)))
15601 (goto-char (cdr range))
15602 (insert "\n")
15603 (backward-char 1)
15604 (org-indent-line))
15605 (insert ":" property ":")
15606 (and value (insert " " value))
15607 (org-indent-line)))))
15608 (run-hook-with-args 'org-property-changed-functions property value)))
15610 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15611 "Get all property keys in the current buffer.
15612 With INCLUDE-SPECIALS, also list the special properties that reflect things
15613 like tags and TODO state.
15614 With INCLUDE-DEFAULTS, also include properties that has special meaning
15615 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15616 and others.
15617 With INCLUDE-COLUMNS, also include property names given in COLUMN
15618 formats in the current buffer."
15619 (let (rtn range cfmt s p)
15620 (save-excursion
15621 (save-restriction
15622 (widen)
15623 (goto-char (point-min))
15624 (while (re-search-forward org-property-start-re nil t)
15625 (setq range (org-get-property-block))
15626 (goto-char (car range))
15627 (while (re-search-forward org-property-re
15628 (cdr range) t)
15629 (add-to-list 'rtn (org-match-string-no-properties 2)))
15630 (outline-next-heading))))
15632 (when include-specials
15633 (setq rtn (append org-special-properties rtn)))
15635 (when include-defaults
15636 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15637 (add-to-list 'rtn org-effort-property))
15639 (when include-columns
15640 (save-excursion
15641 (save-restriction
15642 (widen)
15643 (goto-char (point-min))
15644 (while (re-search-forward
15645 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15646 nil t)
15647 (setq cfmt (match-string 2) s 0)
15648 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15649 cfmt s)
15650 (setq s (match-end 0)
15651 p (match-string 1 cfmt))
15652 (unless (or (equal p "ITEM")
15653 (member p org-special-properties))
15654 (add-to-list 'rtn (match-string 1 cfmt))))))))
15656 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15658 (defun org-property-values (key)
15659 "Return a list of all values of property KEY in the current buffer."
15660 (save-excursion
15661 (save-restriction
15662 (widen)
15663 (goto-char (point-min))
15664 (let ((re (org-re-property key))
15665 values)
15666 (while (re-search-forward re nil t)
15667 (add-to-list 'values (org-trim (match-string 3))))
15668 (delete "" values)))))
15670 (defun org-insert-property-drawer ()
15671 "Insert a property drawer into the current entry."
15672 (org-back-to-heading t)
15673 (looking-at org-outline-regexp)
15674 (let ((indent (if org-adapt-indentation
15675 (- (match-end 0) (match-beginning 0))
15677 (beg (point))
15678 (re (concat "^[ \t]*" org-keyword-time-regexp))
15679 end hiddenp)
15680 (outline-next-heading)
15681 (setq end (point))
15682 (goto-char beg)
15683 (while (re-search-forward re end t))
15684 (setq hiddenp (outline-invisible-p))
15685 (end-of-line 1)
15686 (and (equal (char-after) ?\n) (forward-char 1))
15687 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15688 (if (member (match-string 1) '("CLOCK:" ":END:"))
15689 ;; just skip this line
15690 (beginning-of-line 2)
15691 ;; Drawer start, find the end
15692 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15693 (beginning-of-line 1)))
15694 (org-skip-over-state-notes)
15695 (skip-chars-backward " \t\n\r")
15696 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15697 (forward-char 1))
15698 (goto-char (point-at-eol))
15699 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15700 (beginning-of-line 0)
15701 (org-indent-to-column indent)
15702 (beginning-of-line 2)
15703 (org-indent-to-column indent)
15704 (beginning-of-line 0)
15705 (if hiddenp
15706 (save-excursion
15707 (org-back-to-heading t)
15708 (hide-entry))
15709 (org-flag-drawer t))))
15711 (defun org-insert-drawer (&optional arg drawer)
15712 "Insert a drawer at point.
15714 Optional argument DRAWER, when non-nil, is a string representing
15715 drawer's name. Otherwise, the user is prompted for a name.
15717 If a region is active, insert the drawer around that region
15718 instead.
15720 Point is left between drawer's boundaries."
15721 (interactive "P")
15722 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15723 "LOGBOOK"))
15724 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15725 ;; internally by Org. They are meant to be inserted
15726 ;; automatically.
15727 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15728 ;; Remove system drawers from list. Note: For some reason,
15729 ;; `org-completing-read' ignores the predicate while
15730 ;; `completing-read' handles it fine.
15731 (drawer (if arg "PROPERTIES"
15732 (or drawer
15733 (completing-read
15734 "Drawer: " org-drawers
15735 (lambda (d) (not (member d system-drawers))))))))
15736 (cond
15737 ;; With C-u, fall back on `org-insert-property-drawer'
15738 (arg (org-insert-property-drawer))
15739 ;; With an active region, insert a drawer at point.
15740 ((not (org-region-active-p))
15741 (progn
15742 (unless (bolp) (insert "\n"))
15743 (insert (format ":%s:\n\n:END:\n" drawer))
15744 (forward-line -2)))
15745 ;; Otherwise, insert the drawer at point
15747 (let ((rbeg (region-beginning))
15748 (rend (copy-marker (region-end))))
15749 (unwind-protect
15750 (progn
15751 (goto-char rbeg)
15752 (beginning-of-line)
15753 (when (save-excursion
15754 (re-search-forward org-outline-regexp-bol rend t))
15755 (user-error "Drawers cannot contain headlines"))
15756 ;; Position point at the beginning of the first
15757 ;; non-blank line in region. Insert drawer's opening
15758 ;; there, then indent it.
15759 (org-skip-whitespace)
15760 (beginning-of-line)
15761 (insert ":" drawer ":\n")
15762 (forward-line -1)
15763 (indent-for-tab-command)
15764 ;; Move point to the beginning of the first blank line
15765 ;; after the last non-blank line in region. Insert
15766 ;; drawer's closing, then indent it.
15767 (goto-char rend)
15768 (skip-chars-backward " \r\t\n")
15769 (insert "\n:END:")
15770 (deactivate-mark t)
15771 (indent-for-tab-command)
15772 (unless (eolp) (insert "\n")))
15773 ;; Clear marker, whatever the outcome of insertion is.
15774 (set-marker rend nil)))))))
15776 (defvar org-property-set-functions-alist nil
15777 "Property set function alist.
15778 Each entry should have the following format:
15780 (PROPERTY . READ-FUNCTION)
15782 The read function will be called with the same argument as
15783 `org-completing-read'.")
15785 (defun org-set-property-function (property)
15786 "Get the function that should be used to set PROPERTY.
15787 This is computed according to `org-property-set-functions-alist'."
15788 (or (cdr (assoc property org-property-set-functions-alist))
15789 'org-completing-read))
15791 (defun org-read-property-value (property)
15792 "Read PROPERTY value from user."
15793 (let* ((completion-ignore-case t)
15794 (allowed (org-property-get-allowed-values nil property 'table))
15795 (cur (org-entry-get nil property))
15796 (prompt (concat property " value"
15797 (if (and cur (string-match "\\S-" cur))
15798 (concat " [" cur "]") "") ": "))
15799 (set-function (org-set-property-function property))
15800 (val (if allowed
15801 (funcall set-function prompt allowed nil
15802 (not (get-text-property 0 'org-unrestricted
15803 (caar allowed))))
15804 (let (org-completion-use-ido org-completion-use-iswitchb)
15805 (funcall set-function prompt
15806 (mapcar 'list (org-property-values property))
15807 nil nil "" nil cur)))))
15808 (org-trim val)))
15810 (defvar org-last-set-property nil)
15811 (defvar org-last-set-property-value nil)
15812 (defun org-read-property-name ()
15813 "Read a property name."
15814 (let* ((completion-ignore-case t)
15815 (keys (org-buffer-property-keys nil t t))
15816 (default-prop (or (save-excursion
15817 (save-match-data
15818 (beginning-of-line)
15819 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15820 (null (string= (match-string 1) "END"))
15821 (match-string 1))))
15822 org-last-set-property))
15823 (property (org-icompleting-read
15824 (concat "Property"
15825 (if default-prop (concat " [" default-prop "]") "")
15826 ": ")
15827 (mapcar 'list keys)
15828 nil nil nil nil
15829 default-prop)))
15830 (if (member property keys)
15831 property
15832 (or (cdr (assoc (downcase property)
15833 (mapcar (lambda (x) (cons (downcase x) x))
15834 keys)))
15835 property))))
15837 (defun org-set-property-and-value (use-last)
15838 "Allow to set [PROPERTY]: [value] direction from prompt.
15839 When use-default, don't even ask, just use the last
15840 \"[PROPERTY]: [value]\" string from the history."
15841 (interactive "P")
15842 (let* ((completion-ignore-case t)
15843 (pv (or (and use-last org-last-set-property-value)
15844 (org-completing-read
15845 "Enter a \"[Property]: [value]\" pair: "
15846 nil nil nil nil nil
15847 org-last-set-property-value)))
15848 prop val)
15849 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15850 (setq prop (match-string 1 pv)
15851 val (match-string 2 pv))
15852 (org-set-property prop val))))
15854 (defun org-set-property (property value)
15855 "In the current entry, set PROPERTY to VALUE.
15856 When called interactively, this will prompt for a property name, offering
15857 completion on existing and default properties. And then it will prompt
15858 for a value, offering completion either on allowed values (via an inherited
15859 xxx_ALL property) or on existing values in other instances of this property
15860 in the current file."
15861 (interactive (list nil nil))
15862 (let* ((property (or property (org-read-property-name)))
15863 (value (or value (org-read-property-value property)))
15864 (fn (cdr (assoc property org-properties-postprocess-alist))))
15865 (setq org-last-set-property property)
15866 (setq org-last-set-property-value (concat property ": " value))
15867 ;; Possibly postprocess the inserted value:
15868 (when fn (setq value (funcall fn value)))
15869 (unless (equal (org-entry-get nil property) value)
15870 (org-entry-put nil property value))))
15872 (defun org-delete-property (property &optional delete-empty-drawer)
15873 "In the current entry, delete PROPERTY.
15874 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15875 an empty drawer to delete."
15876 (interactive
15877 (let* ((completion-ignore-case t)
15878 (cat (org-entry-get (point) "CATEGORY"))
15879 (props0 (org-entry-properties nil 'standard))
15880 (props (if cat props0
15881 (delete `("CATEGORY" . ,(org-get-category)) props0)))
15882 (prop (if (< 1 (length props))
15883 (org-icompleting-read "Property: " props nil t)
15884 (caar props))))
15885 (list prop)))
15886 (if (not property)
15887 (message "No property to delete in this entry")
15888 (org-entry-delete nil property delete-empty-drawer)
15889 (message "Property \"%s\" deleted" property)))
15891 (defun org-delete-property-globally (property)
15892 "Remove PROPERTY globally, from all entries."
15893 (interactive
15894 (let* ((completion-ignore-case t)
15895 (prop (org-icompleting-read
15896 "Globally remove property: "
15897 (mapcar 'list (org-buffer-property-keys)))))
15898 (list prop)))
15899 (save-excursion
15900 (save-restriction
15901 (widen)
15902 (goto-char (point-min))
15903 (let ((cnt 0))
15904 (while (re-search-forward
15905 (org-re-property property)
15906 nil t)
15907 (setq cnt (1+ cnt))
15908 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15909 (message "Property \"%s\" removed from %d entries" property cnt)))))
15911 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15913 (defun org-compute-property-at-point ()
15914 "Compute the property at point.
15915 This looks for an enclosing column format, extracts the operator and
15916 then applies it to the property in the column format's scope."
15917 (interactive)
15918 (unless (org-at-property-p)
15919 (user-error "Not at a property"))
15920 (let ((prop (org-match-string-no-properties 2)))
15921 (org-columns-get-format-and-top-level)
15922 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15923 (user-error "No operator defined for property %s" prop))
15924 (org-columns-compute prop)))
15926 (defvar org-property-allowed-value-functions nil
15927 "Hook for functions supplying allowed values for a specific property.
15928 The functions must take a single argument, the name of the property, and
15929 return a flat list of allowed values. If \":ETC\" is one of
15930 the values, this means that these values are intended as defaults for
15931 completion, but that other values should be allowed too.
15932 The functions must return nil if they are not responsible for this
15933 property.")
15935 (defun org-property-get-allowed-values (pom property &optional table)
15936 "Get allowed values for the property PROPERTY.
15937 When TABLE is non-nil, return an alist that can directly be used for
15938 completion."
15939 (let (vals)
15940 (cond
15941 ((equal property "TODO")
15942 (setq vals (org-with-point-at pom
15943 (append org-todo-keywords-1 '("")))))
15944 ((equal property "PRIORITY")
15945 (let ((n org-lowest-priority))
15946 (while (>= n org-highest-priority)
15947 (push (char-to-string n) vals)
15948 (setq n (1- n)))))
15949 ((member property org-special-properties))
15950 ((setq vals (run-hook-with-args-until-success
15951 'org-property-allowed-value-functions property)))
15953 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15954 (when (and vals (string-match "\\S-" vals))
15955 (setq vals (car (read-from-string (concat "(" vals ")"))))
15956 (setq vals (mapcar (lambda (x)
15957 (cond ((stringp x) x)
15958 ((numberp x) (number-to-string x))
15959 ((symbolp x) (symbol-name x))
15960 (t "???")))
15961 vals)))))
15962 (when (member ":ETC" vals)
15963 (setq vals (remove ":ETC" vals))
15964 (org-add-props (car vals) '(org-unrestricted t)))
15965 (if table (mapcar 'list vals) vals)))
15967 (defun org-property-previous-allowed-value (&optional previous)
15968 "Switch to the next allowed value for this property."
15969 (interactive)
15970 (org-property-next-allowed-value t))
15972 (defun org-property-next-allowed-value (&optional previous)
15973 "Switch to the next allowed value for this property."
15974 (interactive)
15975 (unless (org-at-property-p)
15976 (user-error "Not at a property"))
15977 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15978 (key (match-string 2))
15979 (value (match-string 3))
15980 (allowed (or (org-property-get-allowed-values (point) key)
15981 (and (member value '("[ ]" "[-]" "[X]"))
15982 '("[ ]" "[X]"))))
15983 (heading (save-match-data (nth 4 (org-heading-components))))
15984 nval)
15985 (unless allowed
15986 (user-error "Allowed values for this property have not been defined"))
15987 (if previous (setq allowed (reverse allowed)))
15988 (if (member value allowed)
15989 (setq nval (car (cdr (member value allowed)))))
15990 (setq nval (or nval (car allowed)))
15991 (if (equal nval value)
15992 (user-error "Only one allowed value for this property"))
15993 (org-at-property-p)
15994 (replace-match (concat " :" key ": " nval) t t)
15995 (org-indent-line)
15996 (beginning-of-line 1)
15997 (skip-chars-forward " \t")
15998 (when (equal prop org-effort-property)
15999 (save-excursion
16000 (org-back-to-heading t)
16001 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
16002 (when (string= org-clock-current-task heading)
16003 (setq org-clock-effort nval)
16004 (org-clock-update-mode-line)))
16005 (run-hook-with-args 'org-property-changed-functions key nval)))
16007 (defun org-find-olp (path &optional this-buffer)
16008 "Return a marker pointing to the entry at outline path OLP.
16009 If anything goes wrong, throw an error.
16010 You can wrap this call to catch the error like this:
16012 (condition-case msg
16013 (org-mobile-locate-entry (match-string 4))
16014 (error (nth 1 msg)))
16016 The return value will then be either a string with the error message,
16017 or a marker if everything is OK.
16019 If THIS-BUFFER is set, the outline path does not contain a file,
16020 only headings."
16021 (let* ((file (if this-buffer buffer-file-name (pop path)))
16022 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16023 (level 1)
16024 (lmin 1)
16025 (lmax 1)
16026 limit re end found pos heading cnt flevel)
16027 (unless buffer (error "File not found :%s" file))
16028 (with-current-buffer buffer
16029 (save-excursion
16030 (save-restriction
16031 (widen)
16032 (setq limit (point-max))
16033 (goto-char (point-min))
16034 (while (setq heading (pop path))
16035 (setq re (format org-complex-heading-regexp-format
16036 (regexp-quote heading)))
16037 (setq cnt 0 pos (point))
16038 (while (re-search-forward re end t)
16039 (setq level (- (match-end 1) (match-beginning 1)))
16040 (if (and (>= level lmin) (<= level lmax))
16041 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16042 (when (= cnt 0) (error "Heading not found on level %d: %s"
16043 lmax heading))
16044 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16045 lmax heading))
16046 (goto-char found)
16047 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16048 (setq end (save-excursion (org-end-of-subtree t t))))
16049 (when (org-at-heading-p)
16050 (point-marker)))))))
16052 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16053 "Find node HEADING in BUFFER.
16054 Return a marker to the heading if it was found, or nil if not.
16055 If POS-ONLY is set, return just the position instead of a marker.
16057 The heading text must match exact, but it may have a TODO keyword,
16058 a priority cookie and tags in the standard locations."
16059 (with-current-buffer (or buffer (current-buffer))
16060 (save-excursion
16061 (save-restriction
16062 (widen)
16063 (goto-char (point-min))
16064 (let (case-fold-search)
16065 (if (re-search-forward
16066 (format org-complex-heading-regexp-format
16067 (regexp-quote heading)) nil t)
16068 (if pos-only
16069 (match-beginning 0)
16070 (move-marker (make-marker) (match-beginning 0)))))))))
16072 (defun org-find-exact-heading-in-directory (heading &optional dir)
16073 "Find Org node headline HEADING in all .org files in directory DIR.
16074 When the target headline is found, return a marker to this location."
16075 (let ((files (directory-files (or dir default-directory)
16076 nil "\\`[^.#].*\\.org\\'"))
16077 file visiting m buffer)
16078 (catch 'found
16079 (while (setq file (pop files))
16080 (message "trying %s" file)
16081 (setq visiting (org-find-base-buffer-visiting file))
16082 (setq buffer (or visiting (find-file-noselect file)))
16083 (setq m (org-find-exact-headline-in-buffer
16084 heading buffer))
16085 (when (and (not m) (not visiting)) (kill-buffer buffer))
16086 (and m (throw 'found m))))))
16088 (defun org-find-entry-with-id (ident)
16089 "Locate the entry that contains the ID property with exact value IDENT.
16090 IDENT can be a string, a symbol or a number, this function will search for
16091 the string representation of it.
16092 Return the position where this entry starts, or nil if there is no such entry."
16093 (interactive "sID: ")
16094 (let ((id (cond
16095 ((stringp ident) ident)
16096 ((symbol-name ident) (symbol-name ident))
16097 ((numberp ident) (number-to-string ident))
16098 (t (error "IDENT %s must be a string, symbol or number" ident))))
16099 (case-fold-search nil))
16100 (save-excursion
16101 (save-restriction
16102 (widen)
16103 (goto-char (point-min))
16104 (when (re-search-forward
16105 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16106 nil t)
16107 (org-back-to-heading t)
16108 (point))))))
16110 ;;;; Timestamps
16112 (defvar org-last-changed-timestamp nil)
16113 (defvar org-last-inserted-timestamp nil
16114 "The last time stamp inserted with `org-insert-time-stamp'.")
16115 (defvar org-ts-what) ; dynamically scoped parameter
16117 (defun org-time-stamp (arg &optional inactive)
16118 "Prompt for a date/time and insert a time stamp.
16119 If the user specifies a time like HH:MM or if this command is
16120 called with at least one prefix argument, the time stamp contains
16121 the date and the time. Otherwise, only the date is be included.
16123 All parts of a date not specified by the user is filled in from
16124 the current date/time. So if you just press return without
16125 typing anything, the time stamp will represent the current
16126 date/time.
16128 If there is already a timestamp at the cursor, it will be
16129 modified.
16131 With two universal prefix arguments, insert an active timestamp
16132 with the current time without prompting the user.
16134 When called from lisp, the timestamp is inactive if INACTIVE is
16135 non-nil."
16136 (interactive "P")
16137 (let* ((ts nil)
16138 (default-time
16139 ;; Default time is either today, or, when entering a range,
16140 ;; the range start.
16141 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16142 (save-excursion
16143 (re-search-backward
16144 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16145 (- (point) 20) t)))
16146 (apply 'encode-time (org-parse-time-string (match-string 1)))
16147 (current-time)))
16148 (default-input (and ts (org-get-compact-tod ts)))
16149 (repeater (save-excursion
16150 (save-match-data
16151 (beginning-of-line)
16152 (when (re-search-forward
16153 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16154 (save-excursion (progn (end-of-line) (point))) t)
16155 (match-string 0)))))
16156 org-time-was-given org-end-time-was-given time)
16157 (cond
16158 ((and (org-at-timestamp-p t)
16159 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16160 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16161 (insert "--")
16162 (setq time (let ((this-command this-command))
16163 (org-read-date arg 'totime nil nil
16164 default-time default-input inactive)))
16165 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16166 ((org-at-timestamp-p t)
16167 (setq time (let ((this-command this-command))
16168 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16169 (when (org-at-timestamp-p t) ; just to get the match data
16170 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16171 (replace-match "")
16172 (setq org-last-changed-timestamp
16173 (org-insert-time-stamp
16174 time (or org-time-was-given arg)
16175 inactive nil nil (list org-end-time-was-given)))
16176 (when repeater (goto-char (1- (point))) (insert " " repeater)
16177 (setq org-last-changed-timestamp
16178 (concat (substring org-last-inserted-timestamp 0 -1)
16179 " " repeater ">"))))
16180 (message "Timestamp updated"))
16181 ((equal arg '(16))
16182 (org-insert-time-stamp (current-time) t inactive))
16184 (setq time (let ((this-command this-command))
16185 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16186 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16187 nil nil (list org-end-time-was-given))))))
16189 ;; FIXME: can we use this for something else, like computing time differences?
16190 (defun org-get-compact-tod (s)
16191 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16192 (let* ((t1 (match-string 1 s))
16193 (h1 (string-to-number (match-string 2 s)))
16194 (m1 (string-to-number (match-string 3 s)))
16195 (t2 (and (match-end 4) (match-string 5 s)))
16196 (h2 (and t2 (string-to-number (match-string 6 s))))
16197 (m2 (and t2 (string-to-number (match-string 7 s))))
16198 dh dm)
16199 (if (not t2)
16201 (setq dh (- h2 h1) dm (- m2 m1))
16202 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16203 (concat t1 "+" (number-to-string dh)
16204 (and (/= 0 dm) (format ":%02d" dm)))))))
16206 (defun org-time-stamp-inactive (&optional arg)
16207 "Insert an inactive time stamp.
16208 An inactive time stamp is enclosed in square brackets instead of angle
16209 brackets. It is inactive in the sense that it does not trigger agenda entries,
16210 does not link to the calendar and cannot be changed with the S-cursor keys.
16211 So these are more for recording a certain time/date."
16212 (interactive "P")
16213 (org-time-stamp arg 'inactive))
16215 (defvar org-date-ovl (make-overlay 1 1))
16216 (overlay-put org-date-ovl 'face 'org-date-selected)
16217 (org-detach-overlay org-date-ovl)
16219 (defvar org-ans1) ; dynamically scoped parameter
16220 (defvar org-ans2) ; dynamically scoped parameter
16222 (defvar org-plain-time-of-day-regexp) ; defined below
16224 (defvar org-overriding-default-time nil) ; dynamically scoped
16225 (defvar org-read-date-overlay nil)
16226 (defvar org-dcst nil) ; dynamically scoped
16227 (defvar org-read-date-history nil)
16228 (defvar org-read-date-final-answer nil)
16229 (defvar org-read-date-analyze-futurep nil)
16230 (defvar org-read-date-analyze-forced-year nil)
16231 (defvar org-read-date-inactive)
16233 (defvar org-read-date-minibuffer-local-map
16234 (let* ((org-replace-disputed-keys nil)
16235 (map (make-sparse-keymap)))
16236 (set-keymap-parent map minibuffer-local-map)
16237 (org-defkey map (kbd ".")
16238 (lambda () (interactive)
16239 ;; Are we at the beginning of the prompt?
16240 (if (looking-back "^[^:]+: ")
16241 (org-eval-in-calendar '(calendar-goto-today))
16242 (insert "."))))
16243 (org-defkey map (kbd "C-.")
16244 (lambda () (interactive)
16245 (org-eval-in-calendar '(calendar-goto-today))))
16246 (org-defkey map [(meta shift left)]
16247 (lambda () (interactive)
16248 (org-eval-in-calendar '(calendar-backward-month 1))))
16249 (org-defkey map [(meta shift right)]
16250 (lambda () (interactive)
16251 (org-eval-in-calendar '(calendar-forward-month 1))))
16252 (org-defkey map [(meta shift up)]
16253 (lambda () (interactive)
16254 (org-eval-in-calendar '(calendar-backward-year 1))))
16255 (org-defkey map [(meta shift down)]
16256 (lambda () (interactive)
16257 (org-eval-in-calendar '(calendar-forward-year 1))))
16258 (org-defkey map [?\e (shift left)]
16259 (lambda () (interactive)
16260 (org-eval-in-calendar '(calendar-backward-month 1))))
16261 (org-defkey map [?\e (shift right)]
16262 (lambda () (interactive)
16263 (org-eval-in-calendar '(calendar-forward-month 1))))
16264 (org-defkey map [?\e (shift up)]
16265 (lambda () (interactive)
16266 (org-eval-in-calendar '(calendar-backward-year 1))))
16267 (org-defkey map [?\e (shift down)]
16268 (lambda () (interactive)
16269 (org-eval-in-calendar '(calendar-forward-year 1))))
16270 (org-defkey map [(shift up)]
16271 (lambda () (interactive)
16272 (org-eval-in-calendar '(calendar-backward-week 1))))
16273 (org-defkey map [(shift down)]
16274 (lambda () (interactive)
16275 (org-eval-in-calendar '(calendar-forward-week 1))))
16276 (org-defkey map [(shift left)]
16277 (lambda () (interactive)
16278 (org-eval-in-calendar '(calendar-backward-day 1))))
16279 (org-defkey map [(shift right)]
16280 (lambda () (interactive)
16281 (org-eval-in-calendar '(calendar-forward-day 1))))
16282 (org-defkey map "!"
16283 (lambda () (interactive)
16284 (org-eval-in-calendar '(diary-view-entries))
16285 (message "")))
16286 (org-defkey map ">"
16287 (lambda () (interactive)
16288 (org-eval-in-calendar '(calendar-scroll-left 1))))
16289 (org-defkey map "<"
16290 (lambda () (interactive)
16291 (org-eval-in-calendar '(calendar-scroll-right 1))))
16292 (org-defkey map "\C-v"
16293 (lambda () (interactive)
16294 (org-eval-in-calendar
16295 '(calendar-scroll-left-three-months 1))))
16296 (org-defkey map "\M-v"
16297 (lambda () (interactive)
16298 (org-eval-in-calendar
16299 '(calendar-scroll-right-three-months 1))))
16300 map)
16301 "Keymap for minibuffer commands when using `org-read-date'.")
16303 (defvar org-def)
16304 (defvar org-defdecode)
16305 (defvar org-with-time)
16307 (defun org-read-date (&optional org-with-time to-time from-string prompt
16308 default-time default-input inactive)
16309 "Read a date, possibly a time, and make things smooth for the user.
16310 The prompt will suggest to enter an ISO date, but you can also enter anything
16311 which will at least partially be understood by `parse-time-string'.
16312 Unrecognized parts of the date will default to the current day, month, year,
16313 hour and minute. If this command is called to replace a timestamp at point,
16314 or to enter the second timestamp of a range, the default time is taken
16315 from the existing stamp. Furthermore, the command prefers the future,
16316 so if you are giving a date where the year is not given, and the day-month
16317 combination is already past in the current year, it will assume you
16318 mean next year. For details, see the manual. A few examples:
16320 3-2-5 --> 2003-02-05
16321 feb 15 --> currentyear-02-15
16322 2/15 --> currentyear-02-15
16323 sep 12 9 --> 2009-09-12
16324 12:45 --> today 12:45
16325 22 sept 0:34 --> currentyear-09-22 0:34
16326 12 --> currentyear-currentmonth-12
16327 Fri --> nearest Friday after today
16328 -Tue --> last Tuesday
16329 etc.
16331 Furthermore you can specify a relative date by giving, as the *first* thing
16332 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16333 change in days weeks, months, years.
16334 With a single plus or minus, the date is relative to today. With a double
16335 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16336 +4d --> four days from today
16337 +4 --> same as above
16338 +2w --> two weeks from today
16339 ++5 --> five days from default date
16341 The function understands only English month and weekday abbreviations.
16343 While prompting, a calendar is popped up - you can also select the
16344 date with the mouse (button 1). The calendar shows a period of three
16345 months. To scroll it to other months, use the keys `>' and `<'.
16346 If you don't like the calendar, turn it off with
16347 \(setq org-read-date-popup-calendar nil)
16349 With optional argument TO-TIME, the date will immediately be converted
16350 to an internal time.
16351 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16352 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16353 still enter a time, and this function will inform the calling routine
16354 about this change. The calling routine may then choose to change the
16355 format used to insert the time stamp into the buffer to include the time.
16356 With optional argument FROM-STRING, read from this string instead from
16357 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16358 the time/date that is used for everything that is not specified by the
16359 user."
16360 (require 'parse-time)
16361 (let* ((org-time-stamp-rounding-minutes
16362 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16363 (org-dcst org-display-custom-times)
16364 (ct (org-current-time))
16365 (org-def (or org-overriding-default-time default-time ct))
16366 (org-defdecode (decode-time org-def))
16367 (dummy (progn
16368 (when (< (nth 2 org-defdecode) org-extend-today-until)
16369 (setcar (nthcdr 2 org-defdecode) -1)
16370 (setcar (nthcdr 1 org-defdecode) 59)
16371 (setq org-def (apply 'encode-time org-defdecode)
16372 org-defdecode (decode-time org-def)))))
16373 (mouse-autoselect-window nil) ; Don't let the mouse jump
16374 (calendar-frame-setup nil)
16375 (calendar-setup nil)
16376 (calendar-move-hook nil)
16377 (calendar-view-diary-initially-flag nil)
16378 (calendar-view-holidays-initially-flag nil)
16379 (timestr (format-time-string
16380 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16381 (prompt (concat (if prompt (concat prompt " ") "")
16382 (format "Date+time [%s]: " timestr)))
16383 ans (org-ans0 "") org-ans1 org-ans2 final)
16385 (cond
16386 (from-string (setq ans from-string))
16387 (org-read-date-popup-calendar
16388 (save-excursion
16389 (save-window-excursion
16390 (calendar)
16391 (org-eval-in-calendar '(setq cursor-type nil) t)
16392 (unwind-protect
16393 (progn
16394 (calendar-forward-day (- (time-to-days org-def)
16395 (calendar-absolute-from-gregorian
16396 (calendar-current-date))))
16397 (org-eval-in-calendar nil t)
16398 (let* ((old-map (current-local-map))
16399 (map (copy-keymap calendar-mode-map))
16400 (minibuffer-local-map
16401 (copy-keymap org-read-date-minibuffer-local-map)))
16402 (org-defkey map (kbd "RET") 'org-calendar-select)
16403 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16404 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16405 (unwind-protect
16406 (progn
16407 (use-local-map map)
16408 (setq org-read-date-inactive inactive)
16409 (add-hook 'post-command-hook 'org-read-date-display)
16410 (setq org-ans0 (read-string prompt default-input
16411 'org-read-date-history nil))
16412 ;; org-ans0: from prompt
16413 ;; org-ans1: from mouse click
16414 ;; org-ans2: from calendar motion
16415 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16416 (remove-hook 'post-command-hook 'org-read-date-display)
16417 (use-local-map old-map)
16418 (when org-read-date-overlay
16419 (delete-overlay org-read-date-overlay)
16420 (setq org-read-date-overlay nil)))))
16421 (bury-buffer "*Calendar*")))))
16423 (t ; Naked prompt only
16424 (unwind-protect
16425 (setq ans (read-string prompt default-input
16426 'org-read-date-history timestr))
16427 (when org-read-date-overlay
16428 (delete-overlay org-read-date-overlay)
16429 (setq org-read-date-overlay nil)))))
16431 (setq final (org-read-date-analyze ans org-def org-defdecode))
16433 (when org-read-date-analyze-forced-year
16434 (message "Year was forced into %s"
16435 (if org-read-date-force-compatible-dates
16436 "compatible range (1970-2037)"
16437 "range representable on this machine"))
16438 (ding))
16440 ;; One round trip to get rid of 34th of August and stuff like that....
16441 (setq final (decode-time (apply 'encode-time final)))
16443 (setq org-read-date-final-answer ans)
16445 (if to-time
16446 (apply 'encode-time final)
16447 (if (and (boundp 'org-time-was-given) org-time-was-given)
16448 (format "%04d-%02d-%02d %02d:%02d"
16449 (nth 5 final) (nth 4 final) (nth 3 final)
16450 (nth 2 final) (nth 1 final))
16451 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16453 (defun org-read-date-display ()
16454 "Display the current date prompt interpretation in the minibuffer."
16455 (when org-read-date-display-live
16456 (when org-read-date-overlay
16457 (delete-overlay org-read-date-overlay))
16458 (when (minibufferp (current-buffer))
16459 (save-excursion
16460 (end-of-line 1)
16461 (while (not (equal (buffer-substring
16462 (max (point-min) (- (point) 4)) (point))
16463 " "))
16464 (insert " ")))
16465 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16466 " " (or org-ans1 org-ans2)))
16467 (org-end-time-was-given nil)
16468 (f (org-read-date-analyze ans org-def org-defdecode))
16469 (fmts (if org-dcst
16470 org-time-stamp-custom-formats
16471 org-time-stamp-formats))
16472 (fmt (if (or org-with-time
16473 (and (boundp 'org-time-was-given) org-time-was-given))
16474 (cdr fmts)
16475 (car fmts)))
16476 (txt (format-time-string fmt (apply 'encode-time f)))
16477 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16478 (txt (concat "=> " txt)))
16479 (when (and org-end-time-was-given
16480 (string-match org-plain-time-of-day-regexp txt))
16481 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16482 org-end-time-was-given
16483 (substring txt (match-end 0)))))
16484 (when org-read-date-analyze-futurep
16485 (setq txt (concat txt " (=>F)")))
16486 (setq org-read-date-overlay
16487 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16488 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16490 (defun org-read-date-analyze (ans org-def org-defdecode)
16491 "Analyze the combined answer of the date prompt."
16492 ;; FIXME: cleanup and comment
16493 (let ((nowdecode (decode-time (current-time)))
16494 delta deltan deltaw deltadef year month day
16495 hour minute second wday pm h2 m2 tl wday1
16496 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16497 (setq org-read-date-analyze-futurep nil
16498 org-read-date-analyze-forced-year nil)
16499 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16500 (setq ans "+0"))
16502 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16503 (setq ans (replace-match "" t t ans)
16504 deltan (car delta)
16505 deltaw (nth 1 delta)
16506 deltadef (nth 2 delta)))
16508 ;; Check if there is an iso week date in there. If yes, store the
16509 ;; info and postpone interpreting it until the rest of the parsing
16510 ;; is done.
16511 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16512 (setq iso-year (if (match-end 1)
16513 (org-small-year-to-year
16514 (string-to-number (match-string 1 ans))))
16515 iso-weekday (if (match-end 3)
16516 (string-to-number (match-string 3 ans)))
16517 iso-week (string-to-number (match-string 2 ans)))
16518 (setq ans (replace-match "" t t ans)))
16520 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16521 (when (string-match
16522 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16523 (setq year (if (match-end 2)
16524 (string-to-number (match-string 2 ans))
16525 (progn (setq kill-year t)
16526 (string-to-number (format-time-string "%Y"))))
16527 month (string-to-number (match-string 3 ans))
16528 day (string-to-number (match-string 4 ans)))
16529 (if (< year 100) (setq year (+ 2000 year)))
16530 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16531 t nil ans)))
16533 ;; Help matching dotted european dates
16534 (when (string-match
16535 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16536 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16537 (setq kill-year t)
16538 (string-to-number (format-time-string "%Y")))
16539 day (string-to-number (match-string 1 ans))
16540 month (string-to-number (match-string 2 ans))
16541 ans (replace-match (format "%04d-%02d-%02d" year month day)
16542 t nil ans)))
16544 ;; Help matching american dates, like 5/30 or 5/30/7
16545 (when (string-match
16546 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16547 (setq year (if (match-end 4)
16548 (string-to-number (match-string 4 ans))
16549 (progn (setq kill-year t)
16550 (string-to-number (format-time-string "%Y"))))
16551 month (string-to-number (match-string 1 ans))
16552 day (string-to-number (match-string 2 ans)))
16553 (if (< year 100) (setq year (+ 2000 year)))
16554 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16555 t nil ans)))
16556 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16557 ;; If there is a time with am/pm, and *no* time without it, we convert
16558 ;; so that matching will be successful.
16559 (loop for i from 1 to 2 do ; twice, for end time as well
16560 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16561 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16562 (setq hour (string-to-number (match-string 1 ans))
16563 minute (if (match-end 3)
16564 (string-to-number (match-string 3 ans))
16566 pm (equal ?p
16567 (string-to-char (downcase (match-string 4 ans)))))
16568 (if (and (= hour 12) (not pm))
16569 (setq hour 0)
16570 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16571 (setq ans (replace-match (format "%02d:%02d" hour minute)
16572 t t ans))))
16574 ;; Check if a time range is given as a duration
16575 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16576 (setq hour (string-to-number (match-string 1 ans))
16577 h2 (+ hour (string-to-number (match-string 3 ans)))
16578 minute (string-to-number (match-string 2 ans))
16579 m2 (+ minute (if (match-end 5) (string-to-number
16580 (match-string 5 ans))0)))
16581 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16582 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16583 t t ans)))
16585 ;; Check if there is a time range
16586 (when (boundp 'org-end-time-was-given)
16587 (setq org-time-was-given nil)
16588 (when (and (string-match org-plain-time-of-day-regexp ans)
16589 (match-end 8))
16590 (setq org-end-time-was-given (match-string 8 ans))
16591 (setq ans (concat (substring ans 0 (match-beginning 7))
16592 (substring ans (match-end 7))))))
16594 (setq tl (parse-time-string ans)
16595 day (or (nth 3 tl) (nth 3 org-defdecode))
16596 month (or (nth 4 tl)
16597 (if (and org-read-date-prefer-future
16598 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16599 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16600 (nth 4 org-defdecode)))
16601 year (or (and (not kill-year) (nth 5 tl))
16602 (if (and org-read-date-prefer-future
16603 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16604 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16605 (nth 5 org-defdecode)))
16606 hour (or (nth 2 tl) (nth 2 org-defdecode))
16607 minute (or (nth 1 tl) (nth 1 org-defdecode))
16608 second (or (nth 0 tl) 0)
16609 wday (nth 6 tl))
16611 (when (and (eq org-read-date-prefer-future 'time)
16612 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16613 (equal day (nth 3 nowdecode))
16614 (equal month (nth 4 nowdecode))
16615 (equal year (nth 5 nowdecode))
16616 (nth 2 tl)
16617 (or (< (nth 2 tl) (nth 2 nowdecode))
16618 (and (= (nth 2 tl) (nth 2 nowdecode))
16619 (nth 1 tl)
16620 (< (nth 1 tl) (nth 1 nowdecode)))))
16621 (setq day (1+ day)
16622 futurep t))
16624 ;; Special date definitions below
16625 (cond
16626 (iso-week
16627 ;; There was an iso week
16628 (require 'cal-iso)
16629 (setq futurep nil)
16630 (setq year (or iso-year year)
16631 day (or iso-weekday wday 1)
16632 wday nil ; to make sure that the trigger below does not match
16633 iso-date (calendar-gregorian-from-absolute
16634 (calendar-absolute-from-iso
16635 (list iso-week day year))))
16636 ; FIXME: Should we also push ISO weeks into the future?
16637 ; (when (and org-read-date-prefer-future
16638 ; (not iso-year)
16639 ; (< (calendar-absolute-from-gregorian iso-date)
16640 ; (time-to-days (current-time))))
16641 ; (setq year (1+ year)
16642 ; iso-date (calendar-gregorian-from-absolute
16643 ; (calendar-absolute-from-iso
16644 ; (list iso-week day year)))))
16645 (setq month (car iso-date)
16646 year (nth 2 iso-date)
16647 day (nth 1 iso-date)))
16648 (deltan
16649 (setq futurep nil)
16650 (unless deltadef
16651 (let ((now (decode-time (current-time))))
16652 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16653 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16654 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16655 ((equal deltaw "m") (setq month (+ month deltan)))
16656 ((equal deltaw "y") (setq year (+ year deltan)))))
16657 ((and wday (not (nth 3 tl)))
16658 ;; Weekday was given, but no day, so pick that day in the week
16659 ;; on or after the derived date.
16660 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16661 (unless (equal wday wday1)
16662 (setq day (+ day (% (- wday wday1 -7) 7))))))
16663 (if (and (boundp 'org-time-was-given)
16664 (nth 2 tl))
16665 (setq org-time-was-given t))
16666 (if (< year 100) (setq year (+ 2000 year)))
16667 ;; Check of the date is representable
16668 (if org-read-date-force-compatible-dates
16669 (progn
16670 (if (< year 1970)
16671 (setq year 1970 org-read-date-analyze-forced-year t))
16672 (if (> year 2037)
16673 (setq year 2037 org-read-date-analyze-forced-year t)))
16674 (condition-case nil
16675 (ignore (encode-time second minute hour day month year))
16676 (error
16677 (setq year (nth 5 org-defdecode))
16678 (setq org-read-date-analyze-forced-year t))))
16679 (setq org-read-date-analyze-futurep futurep)
16680 (list second minute hour day month year)))
16682 (defvar parse-time-weekdays)
16683 (defun org-read-date-get-relative (s today default)
16684 "Check string S for special relative date string.
16685 TODAY and DEFAULT are internal times, for today and for a default.
16686 Return shift list (N what def-flag)
16687 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16688 N is the number of WHATs to shift.
16689 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16690 the DEFAULT date rather than TODAY."
16691 (require 'parse-time)
16692 (when (and
16693 (string-match
16694 (concat
16695 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16696 "\\([0-9]+\\)?"
16697 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16698 "\\([ \t]\\|$\\)") s)
16699 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16700 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16701 (string-to-char (substring (match-string 1 s) -1))
16702 ?+))
16703 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16704 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16705 (what (if (match-end 3) (match-string 3 s) "d"))
16706 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16707 (date (if rel default today))
16708 (wday (nth 6 (decode-time date)))
16709 delta)
16710 (if wday1
16711 (progn
16712 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16713 (if (= delta 0) (setq delta 7))
16714 (if (= dir ?-)
16715 (progn
16716 (setq delta (- delta 7))
16717 (if (= delta 0) (setq delta -7))))
16718 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16719 (list delta "d" rel))
16720 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16722 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16723 "Turn a user-specified date into the internal representation.
16724 The internal representation needed by the calendar is (month day year).
16725 This is a wrapper to handle the brain-dead convention in calendar that
16726 user function argument order change dependent on argument order."
16727 (if (boundp 'calendar-date-style)
16728 (cond
16729 ((eq calendar-date-style 'american)
16730 (list arg1 arg2 arg3))
16731 ((eq calendar-date-style 'european)
16732 (list arg2 arg1 arg3))
16733 ((eq calendar-date-style 'iso)
16734 (list arg2 arg3 arg1)))
16735 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16736 (if (org-bound-and-true-p european-calendar-style)
16737 (list arg2 arg1 arg3)
16738 (list arg1 arg2 arg3)))))
16740 (defun org-eval-in-calendar (form &optional keepdate)
16741 "Eval FORM in the calendar window and return to current window.
16742 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16743 otherwise stick to the current value of `org-ans2'."
16744 (let ((sf (selected-frame))
16745 (sw (selected-window)))
16746 (select-window (get-buffer-window "*Calendar*" t))
16747 (eval form)
16748 (when (and (not keepdate) (calendar-cursor-to-date))
16749 (let* ((date (calendar-cursor-to-date))
16750 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16751 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16752 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16753 (select-window sw)
16754 (org-select-frame-set-input-focus sf)))
16756 (defun org-calendar-select ()
16757 "Return to `org-read-date' with the date currently selected.
16758 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16759 (interactive)
16760 (when (calendar-cursor-to-date)
16761 (let* ((date (calendar-cursor-to-date))
16762 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16763 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16764 (if (active-minibuffer-window) (exit-minibuffer))))
16766 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16767 "Insert a date stamp for the date given by the internal TIME.
16768 WITH-HM means use the stamp format that includes the time of the day.
16769 INACTIVE means use square brackets instead of angular ones, so that the
16770 stamp will not contribute to the agenda.
16771 PRE and POST are optional strings to be inserted before and after the
16772 stamp.
16773 The command returns the inserted time stamp."
16774 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16775 stamp)
16776 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16777 (insert-before-markers (or pre ""))
16778 (when (listp extra)
16779 (setq extra (car extra))
16780 (if (and (stringp extra)
16781 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16782 (setq extra (format "-%02d:%02d"
16783 (string-to-number (match-string 1 extra))
16784 (string-to-number (match-string 2 extra))))
16785 (setq extra nil)))
16786 (when extra
16787 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16788 (insert-before-markers (setq stamp (format-time-string fmt time)))
16789 (insert-before-markers (or post ""))
16790 (setq org-last-inserted-timestamp stamp)))
16792 (defun org-toggle-time-stamp-overlays ()
16793 "Toggle the use of custom time stamp formats."
16794 (interactive)
16795 (setq org-display-custom-times (not org-display-custom-times))
16796 (unless org-display-custom-times
16797 (let ((p (point-min)) (bmp (buffer-modified-p)))
16798 (while (setq p (next-single-property-change p 'display))
16799 (if (and (get-text-property p 'display)
16800 (eq (get-text-property p 'face) 'org-date))
16801 (remove-text-properties
16802 p (setq p (next-single-property-change p 'display))
16803 '(display t))))
16804 (set-buffer-modified-p bmp)))
16805 (if (featurep 'xemacs)
16806 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16807 (org-restart-font-lock)
16808 (setq org-table-may-need-update t)
16809 (if org-display-custom-times
16810 (message "Time stamps are overlaid with custom format")
16811 (message "Time stamp overlays removed")))
16813 (defun org-display-custom-time (beg end)
16814 "Overlay modified time stamp format over timestamp between BEG and END."
16815 (let* ((ts (buffer-substring beg end))
16816 t1 w1 with-hm tf time str w2 (off 0))
16817 (save-match-data
16818 (setq t1 (org-parse-time-string ts t))
16819 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16820 (setq off (- (match-end 0) (match-beginning 0)))))
16821 (setq end (- end off))
16822 (setq w1 (- end beg)
16823 with-hm (and (nth 1 t1) (nth 2 t1))
16824 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16825 time (org-fix-decoded-time t1)
16826 str (org-add-props
16827 (format-time-string
16828 (substring tf 1 -1) (apply 'encode-time time))
16829 nil 'mouse-face 'highlight)
16830 w2 (length str))
16831 (if (not (= w2 w1))
16832 (add-text-properties (1+ beg) (+ 2 beg)
16833 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16834 (if (featurep 'xemacs)
16835 (progn
16836 (put-text-property beg end 'invisible t)
16837 (put-text-property beg end 'end-glyph (make-glyph str)))
16838 (put-text-property beg end 'display str))))
16840 (defun org-translate-time (string)
16841 "Translate all timestamps in STRING to custom format.
16842 But do this only if the variable `org-display-custom-times' is set."
16843 (when org-display-custom-times
16844 (save-match-data
16845 (let* ((start 0)
16846 (re org-ts-regexp-both)
16847 t1 with-hm inactive tf time str beg end)
16848 (while (setq start (string-match re string start))
16849 (setq beg (match-beginning 0)
16850 end (match-end 0)
16851 t1 (save-match-data
16852 (org-parse-time-string (substring string beg end) t))
16853 with-hm (and (nth 1 t1) (nth 2 t1))
16854 inactive (equal (substring string beg (1+ beg)) "[")
16855 tf (funcall (if with-hm 'cdr 'car)
16856 org-time-stamp-custom-formats)
16857 time (org-fix-decoded-time t1)
16858 str (format-time-string
16859 (concat
16860 (if inactive "[" "<") (substring tf 1 -1)
16861 (if inactive "]" ">"))
16862 (apply 'encode-time time))
16863 string (replace-match str t t string)
16864 start (+ start (length str)))))))
16865 string)
16867 (defun org-fix-decoded-time (time)
16868 "Set 0 instead of nil for the first 6 elements of time.
16869 Don't touch the rest."
16870 (let ((n 0))
16871 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16873 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16875 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16876 "Difference between TIMESTAMP-STRING and now in days.
16877 If SECONDS is non-nil, return the difference in seconds."
16878 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16879 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16880 (funcall fdiff (current-time)))))
16882 (defun org-deadline-close (timestamp-string &optional ndays)
16883 "Is the time in TIMESTAMP-STRING close to the current date?"
16884 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16885 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16886 (not (org-entry-is-done-p))))
16888 (defun org-get-wdays (ts &optional delay zero-delay)
16889 "Get the deadline lead time appropriate for timestring TS.
16890 When DELAY is non-nil, get the delay time for scheduled items
16891 instead of the deadline lead time. When ZERO-DELAY is non-nil
16892 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16893 don't try to find the delay cookie in the scheduled timestamp."
16894 (let ((tv (if delay org-scheduled-delay-days
16895 org-deadline-warning-days)))
16896 (cond
16897 ((or (and delay (< tv 0))
16898 (and delay zero-delay (<= tv 0))
16899 (and (not delay) (<= tv 0)))
16900 ;; Enforce this value no matter what
16901 (- tv))
16902 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16903 ;; lead time is specified.
16904 (floor (* (string-to-number (match-string 1 ts))
16905 (cdr (assoc (match-string 2 ts)
16906 '(("d" . 1) ("w" . 7)
16907 ("m" . 30.4) ("y" . 365.25)
16908 ("h" . 0.041667)))))))
16909 ;; go for the default.
16910 (t tv))))
16912 (defun org-calendar-select-mouse (ev)
16913 "Return to `org-read-date' with the date currently selected.
16914 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16915 (interactive "e")
16916 (mouse-set-point ev)
16917 (when (calendar-cursor-to-date)
16918 (let* ((date (calendar-cursor-to-date))
16919 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16920 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16921 (if (active-minibuffer-window) (exit-minibuffer))))
16923 (defun org-check-deadlines (ndays)
16924 "Check if there are any deadlines due or past due.
16925 A deadline is considered due if it happens within `org-deadline-warning-days'
16926 days from today's date. If the deadline appears in an entry marked DONE,
16927 it is not shown. The prefix arg NDAYS can be used to test that many
16928 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16929 (interactive "P")
16930 (let* ((org-warn-days
16931 (cond
16932 ((equal ndays '(4)) 100000)
16933 (ndays (prefix-numeric-value ndays))
16934 (t (abs org-deadline-warning-days))))
16935 (case-fold-search nil)
16936 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16937 (callback
16938 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16940 (message "%d deadlines past-due or due within %d days"
16941 (org-occur regexp nil callback)
16942 org-warn-days)))
16944 (defsubst org-re-timestamp (type)
16945 "Return a regexp for timestamp TYPE.
16946 Allowed values for TYPE are:
16948 all: all timestamps
16949 active: only active timestamps (<...>)
16950 inactive: only inactive timestamps ([...])
16951 scheduled: only scheduled timestamps
16952 deadline: only deadline timestamps
16953 closed: only closed time-stamps
16955 When TYPE is nil, fall back on returning a regexp that matches
16956 both scheduled and deadline timestamps."
16957 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16958 ((eq type 'active) org-ts-regexp)
16959 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16960 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16961 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16962 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16963 ((eq type 'scheduled-or-deadline)
16964 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16966 (defun org-check-before-date (date)
16967 "Check if there are deadlines or scheduled entries before DATE."
16968 (interactive (list (org-read-date)))
16969 (let ((case-fold-search nil)
16970 (regexp (org-re-timestamp org-ts-type))
16971 (callback
16972 (lambda () (time-less-p
16973 (org-time-string-to-time (match-string 1))
16974 (org-time-string-to-time date)))))
16975 (message "%d entries before %s"
16976 (org-occur regexp nil callback) date)))
16978 (defun org-check-after-date (date)
16979 "Check if there are deadlines or scheduled entries after DATE."
16980 (interactive (list (org-read-date)))
16981 (let ((case-fold-search nil)
16982 (regexp (org-re-timestamp org-ts-type))
16983 (callback
16984 (lambda () (not
16985 (time-less-p
16986 (org-time-string-to-time (match-string 1))
16987 (org-time-string-to-time date))))))
16988 (message "%d entries after %s"
16989 (org-occur regexp nil callback) date)))
16991 (defun org-check-dates-range (start-date end-date)
16992 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16993 (interactive (list (org-read-date nil nil nil "Range starts")
16994 (org-read-date nil nil nil "Range end")))
16995 (let ((case-fold-search nil)
16996 (regexp (org-re-timestamp org-ts-type))
16997 (callback
16998 (lambda ()
16999 (let ((match (match-string 1)))
17000 (and
17001 (not (time-less-p
17002 (org-time-string-to-time match)
17003 (org-time-string-to-time start-date)))
17004 (time-less-p
17005 (org-time-string-to-time match)
17006 (org-time-string-to-time end-date)))))))
17007 (message "%d entries between %s and %s"
17008 (org-occur regexp nil callback) start-date end-date)))
17010 (defun org-evaluate-time-range (&optional to-buffer)
17011 "Evaluate a time range by computing the difference between start and end.
17012 Normally the result is just printed in the echo area, but with prefix arg
17013 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17014 If the time range is actually in a table, the result is inserted into the
17015 next column.
17016 For time difference computation, a year is assumed to be exactly 365
17017 days in order to avoid rounding problems."
17018 (interactive "P")
17020 (org-clock-update-time-maybe)
17021 (save-excursion
17022 (unless (org-at-date-range-p t)
17023 (goto-char (point-at-bol))
17024 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17025 (if (not (org-at-date-range-p t))
17026 (user-error "Not at a time-stamp range, and none found in current line")))
17027 (let* ((ts1 (match-string 1))
17028 (ts2 (match-string 2))
17029 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17030 (match-end (match-end 0))
17031 (time1 (org-time-string-to-time ts1))
17032 (time2 (org-time-string-to-time ts2))
17033 (t1 (org-float-time time1))
17034 (t2 (org-float-time time2))
17035 (diff (abs (- t2 t1)))
17036 (negative (< (- t2 t1) 0))
17037 ;; (ys (floor (* 365 24 60 60)))
17038 (ds (* 24 60 60))
17039 (hs (* 60 60))
17040 (fy "%dy %dd %02d:%02d")
17041 (fy1 "%dy %dd")
17042 (fd "%dd %02d:%02d")
17043 (fd1 "%dd")
17044 (fh "%02d:%02d")
17045 y d h m align)
17046 (if havetime
17047 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17049 d (floor (/ diff ds)) diff (mod diff ds)
17050 h (floor (/ diff hs)) diff (mod diff hs)
17051 m (floor (/ diff 60)))
17052 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17054 d (floor (+ (/ diff ds) 0.5))
17055 h 0 m 0))
17056 (if (not to-buffer)
17057 (message "%s" (org-make-tdiff-string y d h m))
17058 (if (org-at-table-p)
17059 (progn
17060 (goto-char match-end)
17061 (setq align t)
17062 (and (looking-at " *|") (goto-char (match-end 0))))
17063 (goto-char match-end))
17064 (if (looking-at
17065 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17066 (replace-match ""))
17067 (if negative (insert " -"))
17068 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17069 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17070 (insert " " (format fh h m))))
17071 (if align (org-table-align))
17072 (message "Time difference inserted")))))
17074 (defun org-make-tdiff-string (y d h m)
17075 (let ((fmt "")
17076 (l nil))
17077 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17078 l (push y l)))
17079 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17080 l (push d l)))
17081 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17082 l (push h l)))
17083 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17084 l (push m l)))
17085 (apply 'format fmt (nreverse l))))
17087 (defun org-time-string-to-time (s &optional buffer pos)
17088 "Convert a timestamp string into internal time."
17089 (condition-case errdata
17090 (apply 'encode-time (org-parse-time-string s))
17091 (error (error "Bad timestamp `%s'%s\nError was: %s"
17092 s (if (not (and buffer pos))
17094 (format " at %d in buffer `%s'" pos buffer))
17095 (cdr errdata)))))
17097 (defun org-time-string-to-seconds (s)
17098 "Convert a timestamp string to a number of seconds."
17099 (org-float-time (org-time-string-to-time s)))
17101 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17102 "Convert a time stamp to an absolute day number.
17103 If there is a specifier for a cyclic time stamp, get the closest
17104 date to DAYNR.
17105 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17106 The variable `date' is bound by the calendar when this is called."
17107 (cond
17108 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17109 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17110 daynr
17111 (+ daynr 1000)))
17112 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17113 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17114 (time-to-days (current-time))) (match-string 0 s)
17115 prefer show-all))
17116 (t (time-to-days
17117 (condition-case errdata
17118 (apply 'encode-time (org-parse-time-string s))
17119 (error (error "Bad timestamp `%s'%s\nError was: %s"
17120 s (if (not (and buffer pos))
17122 (format " at %d in buffer `%s'" pos buffer))
17123 (cdr errdata))))))))
17125 (defun org-days-to-iso-week (days)
17126 "Return the iso week number."
17127 (require 'cal-iso)
17128 (car (calendar-iso-from-absolute days)))
17130 (defun org-small-year-to-year (year)
17131 "Convert 2-digit years into 4-digit years.
17132 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17133 The year 2000 cannot be abbreviated. Any year larger than 99
17134 is returned unchanged."
17135 (if (< year 38)
17136 (setq year (+ 2000 year))
17137 (if (< year 100)
17138 (setq year (+ 1900 year))))
17139 year)
17141 (defun org-time-from-absolute (d)
17142 "Return the time corresponding to date D.
17143 D may be an absolute day number, or a calendar-type list (month day year)."
17144 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17145 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17147 (defun org-calendar-holiday ()
17148 "List of holidays, for Diary display in Org-mode."
17149 (require 'holidays)
17150 (let ((hl (funcall
17151 (if (fboundp 'calendar-check-holidays)
17152 'calendar-check-holidays 'check-calendar-holidays) date)))
17153 (if hl (mapconcat 'identity hl "; "))))
17155 (defun org-diary-sexp-entry (sexp entry date)
17156 "Process a SEXP diary ENTRY for DATE."
17157 (require 'diary-lib)
17158 (let ((result (if calendar-debug-sexp
17159 (let ((stack-trace-on-error t))
17160 (eval (car (read-from-string sexp))))
17161 (condition-case nil
17162 (eval (car (read-from-string sexp)))
17163 (error
17164 (beep)
17165 (message "Bad sexp at line %d in %s: %s"
17166 (org-current-line)
17167 (buffer-file-name) sexp)
17168 (sleep-for 2))))))
17169 (cond ((stringp result) (split-string result "; "))
17170 ((and (consp result)
17171 (not (consp (cdr result)))
17172 (stringp (cdr result))) (cdr result))
17173 ((and (consp result)
17174 (stringp (car result))) result)
17175 (result entry))))
17177 (defun org-diary-to-ical-string (frombuf)
17178 "Get iCalendar entries from diary entries in buffer FROMBUF.
17179 This uses the icalendar.el library."
17180 (let* ((tmpdir (if (featurep 'xemacs)
17181 (temp-directory)
17182 temporary-file-directory))
17183 (tmpfile (make-temp-name
17184 (expand-file-name "orgics" tmpdir)))
17185 buf rtn b e)
17186 (with-current-buffer frombuf
17187 (icalendar-export-region (point-min) (point-max) tmpfile)
17188 (setq buf (find-buffer-visiting tmpfile))
17189 (set-buffer buf)
17190 (goto-char (point-min))
17191 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17192 (setq b (match-beginning 0)))
17193 (goto-char (point-max))
17194 (if (re-search-backward "^END:VEVENT" nil t)
17195 (setq e (match-end 0)))
17196 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17197 (kill-buffer buf)
17198 (delete-file tmpfile)
17199 rtn))
17201 (defun org-closest-date (start current change prefer show-all)
17202 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17203 When PREFER is `past', return a date that is either CURRENT or past.
17204 When PREFER is `future', return a date that is either CURRENT or future.
17205 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17206 ;; Make the proper lists from the dates
17207 (catch 'exit
17208 (let ((a1 '(("h" . hour)
17209 ("d" . day)
17210 ("w" . week)
17211 ("m" . month)
17212 ("y" . year)))
17213 (shour (nth 2 (org-parse-time-string start)))
17214 dn dw sday cday n1 n2 n0
17215 d m y y1 y2 date1 date2 nmonths nm ny m2)
17217 (setq start (org-date-to-gregorian start)
17218 current (org-date-to-gregorian
17219 (if show-all
17220 current
17221 (time-to-days (current-time))))
17222 sday (calendar-absolute-from-gregorian start)
17223 cday (calendar-absolute-from-gregorian current))
17225 (if (<= cday sday) (throw 'exit sday))
17227 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17228 (setq dn (string-to-number (match-string 1 change))
17229 dw (cdr (assoc (match-string 2 change) a1)))
17230 (user-error "Invalid change specifier: %s" change))
17231 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17232 (cond
17233 ((eq dw 'hour)
17234 (let ((missing-hours
17235 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17236 dn)))
17237 (setq n1 (if (zerop missing-hours) cday
17238 (- cday (1+ (floor (/ missing-hours 24)))))
17239 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17240 ((eq dw 'day)
17241 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17242 n2 (+ n1 dn)))
17243 ((eq dw 'year)
17244 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17245 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17246 (setq date1 (list m d y1)
17247 n1 (calendar-absolute-from-gregorian date1)
17248 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17249 n2 (calendar-absolute-from-gregorian date2)))
17250 ((eq dw 'month)
17251 ;; approx number of month between the two dates
17252 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17253 ;; How often does dn fit in there?
17254 (setq d (nth 1 start) m (car start) y (nth 2 start)
17255 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17256 m (+ m nm)
17257 ny (floor (/ m 12))
17258 y (+ y ny)
17259 m (- m (* ny 12)))
17260 (while (> m 12) (setq m (- m 12) y (1+ y)))
17261 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17262 (setq m2 (+ m dn) y2 y)
17263 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17264 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17265 (while (<= n2 cday)
17266 (setq n1 n2 m m2 y y2)
17267 (setq m2 (+ m dn) y2 y)
17268 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17269 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17270 ;; Make sure n1 is the earlier date
17271 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17272 (if show-all
17273 (cond
17274 ((eq prefer 'past) (if (= cday n2) n2 n1))
17275 ((eq prefer 'future) (if (= cday n1) n1 n2))
17276 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17277 (cond
17278 ((eq prefer 'past) (if (= cday n2) n2 n1))
17279 ((eq prefer 'future) (if (= cday n1) n1 n2))
17280 (t (if (= cday n1) n1 n2)))))))
17282 (defun org-date-to-gregorian (date)
17283 "Turn any specification of DATE into a Gregorian date for the calendar."
17284 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17285 ((and (listp date) (= (length date) 3)) date)
17286 ((stringp date)
17287 (setq date (org-parse-time-string date))
17288 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17289 ((listp date)
17290 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17292 (defun org-parse-time-string (s &optional nodefault)
17293 "Parse the standard Org-mode time string.
17294 This should be a lot faster than the normal `parse-time-string'.
17295 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17296 hour and minute fields will be nil if not given."
17297 (cond ((string-match org-ts-regexp0 s)
17298 (list 0
17299 (if (or (match-beginning 8) (not nodefault))
17300 (string-to-number (or (match-string 8 s) "0")))
17301 (if (or (match-beginning 7) (not nodefault))
17302 (string-to-number (or (match-string 7 s) "0")))
17303 (string-to-number (match-string 4 s))
17304 (string-to-number (match-string 3 s))
17305 (string-to-number (match-string 2 s))
17306 nil nil nil))
17307 ((string-match "^<[^>]+>$" s)
17308 (decode-time (seconds-to-time (org-matcher-time s))))
17309 (t (error "Not a standard Org-mode time string: %s" s))))
17311 (defun org-timestamp-up (&optional arg)
17312 "Increase the date item at the cursor by one.
17313 If the cursor is on the year, change the year. If it is on the month,
17314 the day or the time, change that.
17315 With prefix ARG, change by that many units."
17316 (interactive "p")
17317 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17319 (defun org-timestamp-down (&optional arg)
17320 "Decrease the date item at the cursor by one.
17321 If the cursor is on the year, change the year. If it is on the month,
17322 the day or the time, change that.
17323 With prefix ARG, change by that many units."
17324 (interactive "p")
17325 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17327 (defun org-timestamp-up-day (&optional arg)
17328 "Increase the date in the time stamp by one day.
17329 With prefix ARG, change that many days."
17330 (interactive "p")
17331 (if (and (not (org-at-timestamp-p t))
17332 (org-at-heading-p))
17333 (org-todo 'up)
17334 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17336 (defun org-timestamp-down-day (&optional arg)
17337 "Decrease the date in the time stamp by one day.
17338 With prefix ARG, change that many days."
17339 (interactive "p")
17340 (if (and (not (org-at-timestamp-p t))
17341 (org-at-heading-p))
17342 (org-todo 'down)
17343 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17345 (defun org-at-timestamp-p (&optional inactive-ok)
17346 "Determine if the cursor is in or at a timestamp."
17347 (interactive)
17348 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17349 (pos (point))
17350 (ans (or (looking-at tsr)
17351 (save-excursion
17352 (skip-chars-backward "^[<\n\r\t")
17353 (if (> (point) (point-min)) (backward-char 1))
17354 (and (looking-at tsr)
17355 (> (- (match-end 0) pos) -1))))))
17356 (and ans
17357 (boundp 'org-ts-what)
17358 (setq org-ts-what
17359 (cond
17360 ((= pos (match-beginning 0)) 'bracket)
17361 ;; Point is considered to be "on the bracket" whether
17362 ;; it's really on it or right after it.
17363 ((= pos (1- (match-end 0))) 'bracket)
17364 ((= pos (match-end 0)) 'after)
17365 ((org-pos-in-match-range pos 2) 'year)
17366 ((org-pos-in-match-range pos 3) 'month)
17367 ((org-pos-in-match-range pos 7) 'hour)
17368 ((org-pos-in-match-range pos 8) 'minute)
17369 ((or (org-pos-in-match-range pos 4)
17370 (org-pos-in-match-range pos 5)) 'day)
17371 ((and (> pos (or (match-end 8) (match-end 5)))
17372 (< pos (match-end 0)))
17373 (- pos (or (match-end 8) (match-end 5))))
17374 (t 'day))))
17375 ans))
17377 (defun org-toggle-timestamp-type ()
17378 "Toggle the type (<active> or [inactive]) of a time stamp."
17379 (interactive)
17380 (when (org-at-timestamp-p t)
17381 (let ((beg (match-beginning 0)) (end (match-end 0))
17382 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17383 (save-excursion
17384 (goto-char beg)
17385 (while (re-search-forward "[][<>]" end t)
17386 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17387 t t)))
17388 (message "Timestamp is now %sactive"
17389 (if (equal (char-after beg) ?<) "" "in")))))
17391 (defun org-at-clock-log-p nil
17392 "Is the cursor on the clock log line?"
17393 (save-excursion
17394 (move-beginning-of-line 1)
17395 (looking-at "^[ \t]*CLOCK:")))
17397 (defvar org-clock-history) ; defined in org-clock.el
17398 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17399 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17400 "Change the date in the time stamp at point.
17401 The date will be changed by N times WHAT. WHAT can be `day', `month',
17402 `year', `minute', `second'. If WHAT is not given, the cursor position
17403 in the timestamp determines what will be changed.
17404 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17405 (let ((origin (point)) origin-cat
17406 with-hm inactive
17407 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17408 org-ts-what
17409 extra rem
17410 ts time time0 fixnext clrgx)
17411 (if (not (org-at-timestamp-p t))
17412 (user-error "Not at a timestamp"))
17413 (if (and (not what) (eq org-ts-what 'bracket))
17414 (org-toggle-timestamp-type)
17415 ;; Point isn't on brackets. Remember the part of the time-stamp
17416 ;; the point was in. Indeed, size of time-stamps may change,
17417 ;; but point must be kept in the same category nonetheless.
17418 (setq origin-cat org-ts-what)
17419 (if (and (not what) (not (eq org-ts-what 'day))
17420 org-display-custom-times
17421 (get-text-property (point) 'display)
17422 (not (get-text-property (1- (point)) 'display)))
17423 (setq org-ts-what 'day))
17424 (setq org-ts-what (or what org-ts-what)
17425 inactive (= (char-after (match-beginning 0)) ?\[)
17426 ts (match-string 0))
17427 (replace-match "")
17428 (when (string-match
17429 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17431 (setq extra (match-string 1 ts))
17432 (if suppress-tmp-delay
17433 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17434 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17435 (setq with-hm t))
17436 (setq time0 (org-parse-time-string ts))
17437 (when (and updown
17438 (eq org-ts-what 'minute)
17439 (not current-prefix-arg))
17440 ;; This looks like s-up and s-down. Change by one rounding step.
17441 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17442 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17443 (setcar (cdr time0) (+ (nth 1 time0)
17444 (if (> n 0) (- rem) (- dm rem))))))
17445 (setq time
17446 (encode-time (or (car time0) 0)
17447 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17448 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17449 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17450 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17451 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17452 (nthcdr 6 time0)))
17453 (when (and (member org-ts-what '(hour minute))
17454 extra
17455 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17456 (setq extra (org-modify-ts-extra
17457 extra
17458 (if (eq org-ts-what 'hour) 2 5)
17459 n dm)))
17460 (when (integerp org-ts-what)
17461 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17462 (if (eq what 'calendar)
17463 (let ((cal-date (org-get-date-from-calendar)))
17464 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17465 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17466 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17467 (setcar time0 (or (car time0) 0))
17468 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17469 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17470 (setq time (apply 'encode-time time0))))
17471 ;; Insert the new time-stamp, and ensure point stays in the same
17472 ;; category as before (i.e. not after the last position in that
17473 ;; category).
17474 (let ((pos (point)))
17475 ;; Stay before inserted string. `save-excursion' is of no use.
17476 (setq org-last-changed-timestamp
17477 (org-insert-time-stamp time with-hm inactive nil nil extra))
17478 (goto-char pos))
17479 (save-match-data
17480 (looking-at org-ts-regexp3)
17481 (goto-char (cond
17482 ;; `day' category ends before `hour' if any, or at
17483 ;; the end of the day name.
17484 ((eq origin-cat 'day)
17485 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17486 ((eq origin-cat 'hour) (min (match-end 7) origin))
17487 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17488 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17489 ;; `year' and `month' have both fixed size: point
17490 ;; couldn't have moved into another part.
17491 (t origin))))
17492 ;; Update clock if on a CLOCK line.
17493 (org-clock-update-time-maybe)
17494 ;; Maybe adjust the closest clock in `org-clock-history'
17495 (when org-clock-adjust-closest
17496 (if (not (and (org-at-clock-log-p)
17497 (< 1 (length (delq nil (mapcar 'marker-position
17498 org-clock-history))))))
17499 (message "No clock to adjust")
17500 (cond ((save-excursion ; fix previous clock?
17501 (re-search-backward org-ts-regexp0 nil t)
17502 (org-looking-back (concat org-clock-string " \\[")))
17503 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17504 ((save-excursion ; fix next clock?
17505 (re-search-backward org-ts-regexp0 nil t)
17506 (looking-at (concat org-ts-regexp0 "\\] =>")))
17507 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17508 (save-window-excursion
17509 ;; Find closest clock to point, adjust the previous/next one in history
17510 (let* ((p (save-excursion (org-back-to-heading t)))
17511 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17512 (clfixnth
17513 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17514 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17515 (if (not clfixpos)
17516 (message "No clock to adjust")
17517 (save-excursion
17518 (org-goto-marker-or-bmk clfixpos)
17519 (org-show-subtree)
17520 (when (re-search-forward clrgx nil t)
17521 (goto-char (match-beginning 1))
17522 (let (org-clock-adjust-closest)
17523 (org-timestamp-change n org-ts-what updown))
17524 (message "Clock adjusted in %s for heading: %s"
17525 (file-name-nondirectory (buffer-file-name))
17526 (org-get-heading t t)))))))))
17527 ;; Try to recenter the calendar window, if any.
17528 (if (and org-calendar-follow-timestamp-change
17529 (get-buffer-window "*Calendar*" t)
17530 (memq org-ts-what '(day month year)))
17531 (org-recenter-calendar (time-to-days time))))))
17533 (defun org-modify-ts-extra (s pos n dm)
17534 "Change the different parts of the lead-time and repeat fields in timestamp."
17535 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17536 ng h m new rem)
17537 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17538 (cond
17539 ((or (org-pos-in-match-range pos 2)
17540 (org-pos-in-match-range pos 3))
17541 (setq m (string-to-number (match-string 3 s))
17542 h (string-to-number (match-string 2 s)))
17543 (if (org-pos-in-match-range pos 2)
17544 (setq h (+ h n))
17545 (setq n (* dm (org-no-warnings (signum n))))
17546 (when (not (= 0 (setq rem (% m dm))))
17547 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17548 (setq m (+ m n)))
17549 (if (< m 0) (setq m (+ m 60) h (1- h)))
17550 (if (> m 59) (setq m (- m 60) h (1+ h)))
17551 (setq h (min 24 (max 0 h)))
17552 (setq ng 1 new (format "-%02d:%02d" h m)))
17553 ((org-pos-in-match-range pos 6)
17554 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17555 ((org-pos-in-match-range pos 5)
17556 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17558 ((org-pos-in-match-range pos 9)
17559 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17560 ((org-pos-in-match-range pos 8)
17561 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17563 (when ng
17564 (setq s (concat
17565 (substring s 0 (match-beginning ng))
17567 (substring s (match-end ng))))))
17570 (defun org-recenter-calendar (date)
17571 "If the calendar is visible, recenter it to DATE."
17572 (let ((cwin (get-buffer-window "*Calendar*" t)))
17573 (when cwin
17574 (let ((calendar-move-hook nil))
17575 (with-selected-window cwin
17576 (calendar-goto-date (if (listp date) date
17577 (calendar-gregorian-from-absolute date))))))))
17579 (defun org-goto-calendar (&optional arg)
17580 "Go to the Emacs calendar at the current date.
17581 If there is a time stamp in the current line, go to that date.
17582 A prefix ARG can be used to force the current date."
17583 (interactive "P")
17584 (let ((tsr org-ts-regexp) diff
17585 (calendar-move-hook nil)
17586 (calendar-view-holidays-initially-flag nil)
17587 (calendar-view-diary-initially-flag nil))
17588 (if (or (org-at-timestamp-p)
17589 (save-excursion
17590 (beginning-of-line 1)
17591 (looking-at (concat ".*" tsr))))
17592 (let ((d1 (time-to-days (current-time)))
17593 (d2 (time-to-days
17594 (org-time-string-to-time (match-string 1)))))
17595 (setq diff (- d2 d1))))
17596 (calendar)
17597 (calendar-goto-today)
17598 (if (and diff (not arg)) (calendar-forward-day diff))))
17600 (defun org-get-date-from-calendar ()
17601 "Return a list (month day year) of date at point in calendar."
17602 (with-current-buffer "*Calendar*"
17603 (save-match-data
17604 (calendar-cursor-to-date))))
17606 (defun org-date-from-calendar ()
17607 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17608 If there is already a time stamp at the cursor position, update it."
17609 (interactive)
17610 (if (org-at-timestamp-p t)
17611 (org-timestamp-change 0 'calendar)
17612 (let ((cal-date (org-get-date-from-calendar)))
17613 (org-insert-time-stamp
17614 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17616 (defcustom org-effort-durations
17617 `(("h" . 60)
17618 ("d" . ,(* 60 8))
17619 ("w" . ,(* 60 8 5))
17620 ("m" . ,(* 60 8 5 4))
17621 ("y" . ,(* 60 8 5 40)))
17622 "Conversion factor to minutes for an effort modifier.
17624 Each entry has the form (MODIFIER . MINUTES).
17626 In an effort string, a number followed by MODIFIER is multiplied
17627 by the specified number of MINUTES to obtain an effort in
17628 minutes.
17630 For example, if the value of this variable is ((\"hours\" . 60)), then an
17631 effort string \"2hours\" is equivalent to 120 minutes."
17632 :group 'org-agenda
17633 :version "24.1"
17634 :type '(alist :key-type (string :tag "Modifier")
17635 :value-type (number :tag "Minutes")))
17637 (defun org-minutes-to-clocksum-string (m)
17638 "Format number of minutes as a clocksum string.
17639 The format is determined by `org-time-clocksum-format',
17640 `org-time-clocksum-use-fractional' and
17641 `org-time-clocksum-fractional-format' and
17642 `org-time-clocksum-use-effort-durations'."
17643 (let ((clocksum "")
17644 (m (round m)) ; Don't allow fractions of minutes
17645 h d w mo y fmt n)
17646 (setq h (if org-time-clocksum-use-effort-durations
17647 (cdr (assoc "h" org-effort-durations)) 60)
17648 d (if org-time-clocksum-use-effort-durations
17649 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17650 w (if org-time-clocksum-use-effort-durations
17651 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17652 mo (if org-time-clocksum-use-effort-durations
17653 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17654 y (if org-time-clocksum-use-effort-durations
17655 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17656 ;; fractional format
17657 (if org-time-clocksum-use-fractional
17658 (cond
17659 ;; single format string
17660 ((stringp org-time-clocksum-fractional-format)
17661 (format org-time-clocksum-fractional-format (/ m (float h))))
17662 ;; choice of fractional formats for different time units
17663 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17664 (> (/ (truncate m) (* y d h)) 0))
17665 (format fmt (/ m (* y d (float h)))))
17666 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17667 (> (/ (truncate m) (* mo d h)) 0))
17668 (format fmt (/ m (* mo d (float h)))))
17669 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17670 (> (/ (truncate m) (* w d h)) 0))
17671 (format fmt (/ m (* w d (float h)))))
17672 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17673 (> (/ (truncate m) (* d h)) 0))
17674 (format fmt (/ m (* d (float h)))))
17675 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17676 (> (/ (truncate m) h) 0))
17677 (format fmt (/ m (float h))))
17678 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17679 (format fmt m))
17680 ;; fall back to smallest time unit with a format
17681 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17682 (format fmt (/ m (float h))))
17683 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17684 (format fmt (/ m (* d (float h)))))
17685 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17686 (format fmt (/ m (* w d (float h)))))
17687 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17688 (format fmt (/ m (* mo d (float h)))))
17689 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17690 (format fmt (/ m (* y d (float h))))))
17691 ;; standard (non-fractional) format, with single format string
17692 (if (stringp org-time-clocksum-format)
17693 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17694 ;; separate formats components
17695 (and (setq fmt (plist-get org-time-clocksum-format :years))
17696 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17697 (plist-get org-time-clocksum-format :require-years))
17698 (setq clocksum (concat clocksum (format fmt n))
17699 m (- m (* n y d h))))
17700 (and (setq fmt (plist-get org-time-clocksum-format :months))
17701 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17702 (plist-get org-time-clocksum-format :require-months))
17703 (setq clocksum (concat clocksum (format fmt n))
17704 m (- m (* n mo d h))))
17705 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17706 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17707 (plist-get org-time-clocksum-format :require-weeks))
17708 (setq clocksum (concat clocksum (format fmt n))
17709 m (- m (* n w d h))))
17710 (and (setq fmt (plist-get org-time-clocksum-format :days))
17711 (or (> (setq n (/ (truncate m) (* d h))) 0)
17712 (plist-get org-time-clocksum-format :require-days))
17713 (setq clocksum (concat clocksum (format fmt n))
17714 m (- m (* n d h))))
17715 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17716 (or (> (setq n (/ (truncate m) h)) 0)
17717 (plist-get org-time-clocksum-format :require-hours))
17718 (setq clocksum (concat clocksum (format fmt n))
17719 m (- m (* n h))))
17720 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17721 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17722 (setq clocksum (concat clocksum (format fmt m))))
17723 ;; return formatted time duration
17724 clocksum))))
17726 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17727 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17728 "Org mode version 8.0")
17730 (defun org-hours-to-clocksum-string (n)
17731 (org-minutes-to-clocksum-string (* n 60)))
17733 (defun org-hh:mm-string-to-minutes (s)
17734 "Convert a string H:MM to a number of minutes.
17735 If the string is just a number, interpret it as minutes.
17736 In fact, the first hh:mm or number in the string will be taken,
17737 there can be extra stuff in the string.
17738 If no number is found, the return value is 0."
17739 (cond
17740 ((integerp s) s)
17741 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17742 (+ (* (string-to-number (match-string 1 s)) 60)
17743 (string-to-number (match-string 2 s))))
17744 ((string-match "\\([0-9]+\\)" s)
17745 (string-to-number (match-string 1 s)))
17746 (t 0)))
17748 (defcustom org-image-actual-width t
17749 "Should we use the actual width of images when inlining them?
17751 When set to `t', always use the image width.
17753 When set to a number, use imagemagick (when available) to set
17754 the image's width to this value.
17756 When set to a number in a list, try to get the width from any
17757 #+ATTR.* keyword if it matches a width specification like
17759 #+ATTR_HTML: :width 300px
17761 and fall back on that number if none is found.
17763 When set to nil, try to get the width from an #+ATTR.* keyword
17764 and fall back on the original width if none is found.
17766 This requires Emacs >= 24.1, build with imagemagick support."
17767 :group 'org-appearance
17768 :version "24.4"
17769 :package-version '(Org . "8.0")
17770 :type '(choice
17771 (const :tag "Use the image width" t)
17772 (integer :tag "Use a number of pixels")
17773 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17774 (const :tag "Use #+ATTR* or don't resize" nil)))
17776 (defcustom org-agenda-inhibit-startup nil
17777 "Inhibit startup when preparing agenda buffers.
17778 When this variable is `t', the initialization of the Org agenda
17779 buffers is inhibited: e.g. the visibility state is not set, the
17780 tables are not re-aligned, etc."
17781 :type 'boolean
17782 :version "24.3"
17783 :group 'org-agenda)
17785 (defcustom org-agenda-ignore-drawer-properties nil
17786 "Avoid updating text properties when building the agenda.
17787 Properties are used to prepare buffers for effort estimates, appointments,
17788 and subtree-local categories.
17789 If you don't use these in the agenda, you can add them to this list and
17790 agenda building will be a bit faster.
17791 The value is a list, with zero or more of the symbols `effort', `appt',
17792 or `category'."
17793 :type '(set :greedy t
17794 (const effort)
17795 (const appt)
17796 (const category))
17797 :version "24.3"
17798 :group 'org-agenda)
17800 (defun org-duration-string-to-minutes (s &optional output-to-string)
17801 "Convert a duration string S to minutes.
17803 A bare number is interpreted as minutes, modifiers can be set by
17804 customizing `org-effort-durations' (which see).
17806 Entries containing a colon are interpreted as H:MM by
17807 `org-hh:mm-string-to-minutes'."
17808 (let ((result 0)
17809 (re (concat "\\([0-9.]+\\) *\\("
17810 (regexp-opt (mapcar 'car org-effort-durations))
17811 "\\)")))
17812 (while (string-match re s)
17813 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17814 (string-to-number (match-string 1 s))))
17815 (setq s (replace-match "" nil t s)))
17816 (setq result (floor result))
17817 (incf result (org-hh:mm-string-to-minutes s))
17818 (if output-to-string (number-to-string result) result)))
17820 ;;;; Files
17822 (defun org-save-all-org-buffers ()
17823 "Save all Org-mode buffers without user confirmation."
17824 (interactive)
17825 (message "Saving all Org-mode buffers...")
17826 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17827 (when (featurep 'org-id) (org-id-locations-save))
17828 (message "Saving all Org-mode buffers... done"))
17830 (defun org-revert-all-org-buffers ()
17831 "Revert all Org-mode buffers.
17832 Prompt for confirmation when there are unsaved changes.
17833 Be sure you know what you are doing before letting this function
17834 overwrite your changes.
17836 This function is useful in a setup where one tracks org files
17837 with a version control system, to revert on one machine after pulling
17838 changes from another. I believe the procedure must be like this:
17840 1. M-x org-save-all-org-buffers
17841 2. Pull changes from the other machine, resolve conflicts
17842 3. M-x org-revert-all-org-buffers"
17843 (interactive)
17844 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17845 (user-error "Abort"))
17846 (save-excursion
17847 (save-window-excursion
17848 (mapc
17849 (lambda (b)
17850 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17851 (with-current-buffer b buffer-file-name))
17852 (org-pop-to-buffer-same-window b)
17853 (revert-buffer t 'no-confirm)))
17854 (buffer-list))
17855 (when (and (featurep 'org-id) org-id-track-globally)
17856 (org-id-locations-load)))))
17858 ;;;; Agenda files
17860 ;;;###autoload
17861 (defun org-switchb (&optional arg)
17862 "Switch between Org buffers.
17863 With one prefix argument, restrict available buffers to files.
17864 With two prefix arguments, restrict available buffers to agenda files.
17866 Defaults to `iswitchb' for buffer name completion.
17867 Set `org-completion-use-ido' to make it use ido instead."
17868 (interactive "P")
17869 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17870 ((equal arg '(16)) (org-buffer-list 'agenda))
17871 (t (org-buffer-list))))
17872 (org-completion-use-iswitchb org-completion-use-iswitchb)
17873 (org-completion-use-ido org-completion-use-ido))
17874 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17875 (setq org-completion-use-iswitchb t))
17876 (org-pop-to-buffer-same-window
17877 (org-icompleting-read "Org buffer: "
17878 (mapcar 'list (mapcar 'buffer-name blist))
17879 nil t))))
17881 ;;; Define some older names previously used for this functionality
17882 ;;;###autoload
17883 (defalias 'org-ido-switchb 'org-switchb)
17884 ;;;###autoload
17885 (defalias 'org-iswitchb 'org-switchb)
17887 (defun org-buffer-list (&optional predicate exclude-tmp)
17888 "Return a list of Org buffers.
17889 PREDICATE can be `export', `files' or `agenda'.
17891 export restrict the list to Export buffers.
17892 files restrict the list to buffers visiting Org files.
17893 agenda restrict the list to buffers visiting agenda files.
17895 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17896 (let* ((bfn nil)
17897 (agenda-files (and (eq predicate 'agenda)
17898 (mapcar 'file-truename (org-agenda-files t))))
17899 (filter
17900 (cond
17901 ((eq predicate 'files)
17902 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17903 ((eq predicate 'export)
17904 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17905 ((eq predicate 'agenda)
17906 (lambda (b)
17907 (with-current-buffer b
17908 (and (derived-mode-p 'org-mode)
17909 (setq bfn (buffer-file-name b))
17910 (member (file-truename bfn) agenda-files)))))
17911 (t (lambda (b) (with-current-buffer b
17912 (or (derived-mode-p 'org-mode)
17913 (string-match "\*Org .*Export"
17914 (buffer-name b)))))))))
17915 (delq nil
17916 (mapcar
17917 (lambda(b)
17918 (if (and (funcall filter b)
17919 (or (not exclude-tmp)
17920 (not (string-match "tmp" (buffer-name b)))))
17922 nil))
17923 (buffer-list)))))
17925 (defun org-agenda-files (&optional unrestricted archives)
17926 "Get the list of agenda files.
17927 Optional UNRESTRICTED means return the full list even if a restriction
17928 is currently in place.
17929 When ARCHIVES is t, include all archive files that are really being
17930 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17931 `org-agenda-archives-mode' is t."
17932 (let ((files
17933 (cond
17934 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17935 ((stringp org-agenda-files) (org-read-agenda-file-list))
17936 ((listp org-agenda-files) org-agenda-files)
17937 (t (error "Invalid value of `org-agenda-files'")))))
17938 (setq files (apply 'append
17939 (mapcar (lambda (f)
17940 (if (file-directory-p f)
17941 (directory-files
17942 f t org-agenda-file-regexp)
17943 (list f)))
17944 files)))
17945 (when org-agenda-skip-unavailable-files
17946 (setq files (delq nil
17947 (mapcar (function
17948 (lambda (file)
17949 (and (file-readable-p file) file)))
17950 files))))
17951 (when (or (eq archives t)
17952 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17953 (setq files (org-add-archive-files files)))
17954 files))
17956 (defun org-agenda-file-p (&optional file)
17957 "Return non-nil, if FILE is an agenda file.
17958 If FILE is omitted, use the file associated with the current
17959 buffer."
17960 (member (or file (buffer-file-name))
17961 (org-agenda-files t)))
17963 (defun org-edit-agenda-file-list ()
17964 "Edit the list of agenda files.
17965 Depending on setup, this either uses customize to edit the variable
17966 `org-agenda-files', or it visits the file that is holding the list. In the
17967 latter case, the buffer is set up in a way that saving it automatically kills
17968 the buffer and restores the previous window configuration."
17969 (interactive)
17970 (if (stringp org-agenda-files)
17971 (let ((cw (current-window-configuration)))
17972 (find-file org-agenda-files)
17973 (org-set-local 'org-window-configuration cw)
17974 (org-add-hook 'after-save-hook
17975 (lambda ()
17976 (set-window-configuration
17977 (prog1 org-window-configuration
17978 (kill-buffer (current-buffer))))
17979 (org-install-agenda-files-menu)
17980 (message "New agenda file list installed"))
17981 nil 'local)
17982 (message "%s" (substitute-command-keys
17983 "Edit list and finish with \\[save-buffer]")))
17984 (customize-variable 'org-agenda-files)))
17986 (defun org-store-new-agenda-file-list (list)
17987 "Set new value for the agenda file list and save it correctly."
17988 (if (stringp org-agenda-files)
17989 (let ((fe (org-read-agenda-file-list t)) b u)
17990 (while (setq b (find-buffer-visiting org-agenda-files))
17991 (kill-buffer b))
17992 (with-temp-file org-agenda-files
17993 (insert
17994 (mapconcat
17995 (lambda (f) ;; Keep un-expanded entries.
17996 (if (setq u (assoc f fe))
17997 (cdr u)
17999 list "\n")
18000 "\n")))
18001 (let ((org-mode-hook nil) (org-inhibit-startup t)
18002 (org-insert-mode-line-in-empty-file nil))
18003 (setq org-agenda-files list)
18004 (customize-save-variable 'org-agenda-files org-agenda-files))))
18006 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18007 "Read the list of agenda files from a file.
18008 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18009 filenames, used by `org-store-new-agenda-file-list' to write back
18010 un-expanded file names."
18011 (when (file-directory-p org-agenda-files)
18012 (error "`org-agenda-files' cannot be a single directory"))
18013 (when (stringp org-agenda-files)
18014 (with-temp-buffer
18015 (insert-file-contents org-agenda-files)
18016 (mapcar
18017 (lambda (f)
18018 (let ((e (expand-file-name (substitute-in-file-name f)
18019 org-directory)))
18020 (if pair-with-expansion
18021 (cons e f)
18022 e)))
18023 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18025 ;;;###autoload
18026 (defun org-cycle-agenda-files ()
18027 "Cycle through the files in `org-agenda-files'.
18028 If the current buffer visits an agenda file, find the next one in the list.
18029 If the current buffer does not, find the first agenda file."
18030 (interactive)
18031 (let* ((fs (org-agenda-files t))
18032 (files (append fs (list (car fs))))
18033 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18034 file)
18035 (unless files (user-error "No agenda files"))
18036 (catch 'exit
18037 (while (setq file (pop files))
18038 (if (equal (file-truename file) tcf)
18039 (when (car files)
18040 (find-file (car files))
18041 (throw 'exit t))))
18042 (find-file (car fs)))
18043 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18045 (defun org-agenda-file-to-front (&optional to-end)
18046 "Move/add the current file to the top of the agenda file list.
18047 If the file is not present in the list, it is added to the front. If it is
18048 present, it is moved there. With optional argument TO-END, add/move to the
18049 end of the list."
18050 (interactive "P")
18051 (let ((org-agenda-skip-unavailable-files nil)
18052 (file-alist (mapcar (lambda (x)
18053 (cons (file-truename x) x))
18054 (org-agenda-files t)))
18055 (ctf (file-truename
18056 (or buffer-file-name
18057 (user-error "Please save the current buffer to a file"))))
18058 x had)
18059 (setq x (assoc ctf file-alist) had x)
18061 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18062 (if to-end
18063 (setq file-alist (append (delq x file-alist) (list x)))
18064 (setq file-alist (cons x (delq x file-alist))))
18065 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18066 (org-install-agenda-files-menu)
18067 (message "File %s to %s of agenda file list"
18068 (if had "moved" "added") (if to-end "end" "front"))))
18070 (defun org-remove-file (&optional file)
18071 "Remove current file from the list of files in variable `org-agenda-files'.
18072 These are the files which are being checked for agenda entries.
18073 Optional argument FILE means use this file instead of the current."
18074 (interactive)
18075 (let* ((org-agenda-skip-unavailable-files nil)
18076 (file (or file buffer-file-name
18077 (user-error "Current buffer does not visit a file")))
18078 (true-file (file-truename file))
18079 (afile (abbreviate-file-name file))
18080 (files (delq nil (mapcar
18081 (lambda (x)
18082 (if (equal true-file
18083 (file-truename x))
18084 nil x))
18085 (org-agenda-files t)))))
18086 (if (not (= (length files) (length (org-agenda-files t))))
18087 (progn
18088 (org-store-new-agenda-file-list files)
18089 (org-install-agenda-files-menu)
18090 (message "Removed file: %s" afile))
18091 (message "File was not in list: %s (not removed)" afile))))
18093 (defun org-file-menu-entry (file)
18094 (vector file (list 'find-file file) t))
18096 (defun org-check-agenda-file (file)
18097 "Make sure FILE exists. If not, ask user what to do."
18098 (when (not (file-exists-p file))
18099 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18100 (abbreviate-file-name file))
18101 (let ((r (downcase (read-char-exclusive))))
18102 (cond
18103 ((equal r ?r)
18104 (org-remove-file file)
18105 (throw 'nextfile t))
18106 (t (error "Abort"))))))
18108 (defun org-get-agenda-file-buffer (file)
18109 "Get a buffer visiting FILE. If the buffer needs to be created, add
18110 it to the list of buffers which might be released later."
18111 (let ((buf (org-find-base-buffer-visiting file)))
18112 (if buf
18113 buf ; just return it
18114 ;; Make a new buffer and remember it
18115 (setq buf (find-file-noselect file))
18116 (if buf (push buf org-agenda-new-buffers))
18117 buf)))
18119 (defun org-release-buffers (blist)
18120 "Release all buffers in list, asking the user for confirmation when needed.
18121 When a buffer is unmodified, it is just killed. When modified, it is saved
18122 \(if the user agrees) and then killed."
18123 (let (buf file)
18124 (while (setq buf (pop blist))
18125 (setq file (buffer-file-name buf))
18126 (when (and (buffer-modified-p buf)
18127 file
18128 (y-or-n-p (format "Save file %s? " file)))
18129 (with-current-buffer buf (save-buffer)))
18130 (kill-buffer buf))))
18132 (defun org-agenda-prepare-buffers (files)
18133 "Create buffers for all agenda files, protect archived trees and comments."
18134 (interactive)
18135 (let ((pa '(:org-archived t))
18136 (pc '(:org-comment t))
18137 (pall '(:org-archived t :org-comment t))
18138 (inhibit-read-only t)
18139 (org-inhibit-startup org-agenda-inhibit-startup)
18140 (rea (concat ":" org-archive-tag ":"))
18141 file re pos)
18142 (setq org-tag-alist-for-agenda nil
18143 org-tag-groups-alist-for-agenda nil)
18144 (save-excursion
18145 (save-restriction
18146 (while (setq file (pop files))
18147 (catch 'nextfile
18148 (if (bufferp file)
18149 (set-buffer file)
18150 (org-check-agenda-file file)
18151 (set-buffer (org-get-agenda-file-buffer file)))
18152 (widen)
18153 (org-set-regexps-and-options-for-tags)
18154 (setq pos (point))
18155 (goto-char (point-min))
18156 (let ((case-fold-search t))
18157 (when (search-forward "#+setupfile" nil t)
18158 ;; Don't set all regexps and options systematically as
18159 ;; this is only run for setting agenda tags from setup
18160 ;; file
18161 (org-set-regexps-and-options)))
18162 (or (memq 'category org-agenda-ignore-drawer-properties)
18163 (org-refresh-category-properties))
18164 (or (memq 'effort org-agenda-ignore-drawer-properties)
18165 (org-refresh-properties org-effort-property 'org-effort))
18166 (or (memq 'appt org-agenda-ignore-drawer-properties)
18167 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18168 (setq org-todo-keywords-for-agenda
18169 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18170 (setq org-done-keywords-for-agenda
18171 (append org-done-keywords-for-agenda org-done-keywords))
18172 (setq org-todo-keyword-alist-for-agenda
18173 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18174 (setq org-drawers-for-agenda
18175 (append org-drawers-for-agenda org-drawers))
18176 (setq org-tag-alist-for-agenda
18177 (org-uniquify
18178 (append org-tag-alist-for-agenda
18179 org-tag-alist
18180 org-tag-persistent-alist)))
18181 (if org-group-tags
18182 (setq org-tag-groups-alist-for-agenda
18183 (org-uniquify-alist
18184 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18185 (org-with-silent-modifications
18186 (save-excursion
18187 (remove-text-properties (point-min) (point-max) pall)
18188 (when org-agenda-skip-archived-trees
18189 (goto-char (point-min))
18190 (while (re-search-forward rea nil t)
18191 (if (org-at-heading-p t)
18192 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18193 (goto-char (point-min))
18194 (setq re (format org-heading-keyword-regexp-format
18195 org-comment-string))
18196 (while (re-search-forward re nil t)
18197 (add-text-properties
18198 (match-beginning 0) (org-end-of-subtree t) pc))))
18199 (goto-char pos)))))
18200 (setq org-todo-keywords-for-agenda
18201 (org-uniquify org-todo-keywords-for-agenda))
18202 (setq org-todo-keyword-alist-for-agenda
18203 (org-uniquify org-todo-keyword-alist-for-agenda))))
18206 ;;;; CDLaTeX minor mode
18208 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18209 "Keymap for the minor `org-cdlatex-mode'.")
18211 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18212 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18213 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18214 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18215 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18217 (defvar org-cdlatex-texmathp-advice-is-done nil
18218 "Flag remembering if we have applied the advice to texmathp already.")
18220 (define-minor-mode org-cdlatex-mode
18221 "Toggle the minor `org-cdlatex-mode'.
18222 This mode supports entering LaTeX environment and math in LaTeX fragments
18223 in Org-mode.
18224 \\{org-cdlatex-mode-map}"
18225 nil " OCDL" nil
18226 (when org-cdlatex-mode
18227 (require 'cdlatex)
18228 (run-hooks 'cdlatex-mode-hook)
18229 (cdlatex-compute-tables))
18230 (unless org-cdlatex-texmathp-advice-is-done
18231 (setq org-cdlatex-texmathp-advice-is-done t)
18232 (defadvice texmathp (around org-math-always-on activate)
18233 "Always return t in org-mode buffers.
18234 This is because we want to insert math symbols without dollars even outside
18235 the LaTeX math segments. If Orgmode thinks that point is actually inside
18236 an embedded LaTeX fragment, let texmathp do its job.
18237 \\[org-cdlatex-mode-map]"
18238 (interactive)
18239 (let (p)
18240 (cond
18241 ((not (derived-mode-p 'org-mode)) ad-do-it)
18242 ((eq this-command 'cdlatex-math-symbol)
18243 (setq ad-return-value t
18244 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18246 (let ((p (org-inside-LaTeX-fragment-p)))
18247 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18248 (setq ad-return-value t
18249 texmathp-why '("Org-mode embedded math" . 0))
18250 (if p ad-do-it)))))))))
18252 (defun turn-on-org-cdlatex ()
18253 "Unconditionally turn on `org-cdlatex-mode'."
18254 (org-cdlatex-mode 1))
18256 (defun org-try-cdlatex-tab ()
18257 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18258 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18259 - inside a LaTeX fragment, or
18260 - after the first word in a line, where an abbreviation expansion could
18261 insert a LaTeX environment."
18262 (when org-cdlatex-mode
18263 (cond
18264 ;; Before any word on the line: No expansion possible.
18265 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18266 ;; Just after first word on the line: Expand it. Make sure it
18267 ;; cannot happen on headlines, though.
18268 ((save-excursion
18269 (skip-chars-backward "a-zA-Z0-9*")
18270 (skip-chars-backward " \t")
18271 (and (bolp) (not (org-at-heading-p))))
18272 (cdlatex-tab) t)
18273 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18275 (defun org-cdlatex-underscore-caret (&optional arg)
18276 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18277 Revert to the normal definition outside of these fragments."
18278 (interactive "P")
18279 (if (org-inside-LaTeX-fragment-p)
18280 (call-interactively 'cdlatex-sub-superscript)
18281 (let (org-cdlatex-mode)
18282 (call-interactively (key-binding (vector last-input-event))))))
18284 (defun org-cdlatex-math-modify (&optional arg)
18285 "Execute `cdlatex-math-modify' in LaTeX fragments.
18286 Revert to the normal definition outside of these fragments."
18287 (interactive "P")
18288 (if (org-inside-LaTeX-fragment-p)
18289 (call-interactively 'cdlatex-math-modify)
18290 (let (org-cdlatex-mode)
18291 (call-interactively (key-binding (vector last-input-event))))))
18295 ;;;; LaTeX fragments
18297 (defvar org-latex-regexps
18298 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
18299 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18300 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
18301 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18302 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18303 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
18304 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
18305 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
18306 "Regular expressions for matching embedded LaTeX.")
18308 (defun org-inside-LaTeX-fragment-p ()
18309 "Test if point is inside a LaTeX fragment.
18310 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18311 sequence appearing also before point.
18312 Even though the matchers for math are configurable, this function assumes
18313 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18314 delimiters are skipped when they have been removed by customization.
18315 The return value is nil, or a cons cell with the delimiter and the
18316 position of this delimiter.
18318 This function does a reasonably good job, but can locally be fooled by
18319 for example currency specifications. For example it will assume being in
18320 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18321 fragments that are properly closed, but during editing, we have to live
18322 with the uncertainty caused by missing closing delimiters. This function
18323 looks only before point, not after."
18324 (catch 'exit
18325 (let ((pos (point))
18326 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18327 (lim (progn
18328 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18329 (point)))
18330 dd-on str (start 0) m re)
18331 (goto-char pos)
18332 (when dodollar
18333 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18334 re (nth 1 (assoc "$" org-latex-regexps)))
18335 (while (string-match re str start)
18336 (cond
18337 ((= (match-end 0) (length str))
18338 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18339 ((= (match-end 0) (- (length str) 5))
18340 (throw 'exit nil))
18341 (t (setq start (match-end 0))))))
18342 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18343 (goto-char pos)
18344 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18345 (and (match-beginning 2) (throw 'exit nil))
18346 ;; count $$
18347 (while (re-search-backward "\\$\\$" lim t)
18348 (setq dd-on (not dd-on)))
18349 (goto-char pos)
18350 (if dd-on (cons "$$" m))))))
18352 (defun org-inside-latex-macro-p ()
18353 "Is point inside a LaTeX macro or its arguments?"
18354 (save-match-data
18355 (org-in-regexp
18356 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18358 (defvar org-latex-fragment-image-overlays nil
18359 "List of overlays carrying the images of latex fragments.")
18360 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18362 (defun org-remove-latex-fragment-image-overlays ()
18363 "Remove all overlays with LaTeX fragment images in current buffer."
18364 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18365 (setq org-latex-fragment-image-overlays nil))
18367 (defun org-preview-latex-fragment (&optional subtree)
18368 "Preview the LaTeX fragment at point, or all locally or globally.
18369 If the cursor is in a LaTeX fragment, create the image and overlay
18370 it over the source code. If there is no fragment at point, display
18371 all fragments in the current text, from one headline to the next. With
18372 prefix SUBTREE, display all fragments in the current subtree. With a
18373 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18374 the cursor is before the first headline,
18375 display all fragments in the buffer.
18376 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18377 (interactive "P")
18378 (unless buffer-file-name
18379 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18380 (when (display-graphic-p)
18381 (org-remove-latex-fragment-image-overlays)
18382 (save-excursion
18383 (save-restriction
18384 (let (beg end at msg)
18385 (cond
18386 ((or (equal subtree '(16))
18387 (not (save-excursion
18388 (re-search-backward org-outline-regexp-bol nil t))))
18389 (setq beg (point-min) end (point-max)
18390 msg "Creating images for buffer...%s"))
18391 ((equal subtree '(4))
18392 (org-back-to-heading)
18393 (setq beg (point) end (org-end-of-subtree t)
18394 msg "Creating images for subtree...%s"))
18396 (if (setq at (org-inside-LaTeX-fragment-p))
18397 (goto-char (max (point-min) (- (cdr at) 2)))
18398 (org-back-to-heading))
18399 (setq beg (point) end (progn (outline-next-heading) (point))
18400 msg (if at "Creating image...%s"
18401 "Creating images for entry...%s"))))
18402 (message msg "")
18403 (narrow-to-region beg end)
18404 (goto-char beg)
18405 (org-format-latex
18406 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18407 (file-name-nondirectory
18408 buffer-file-name)))
18409 default-directory 'overlays msg at 'forbuffer
18410 org-latex-create-formula-image-program)
18411 (message msg "done. Use `C-c C-c' to remove images."))))))
18413 (defun org-format-latex (prefix &optional dir overlays msg at
18414 forbuffer processing-type)
18415 "Replace LaTeX fragments with links to an image, and produce images.
18416 Some of the options can be changed using the variable
18417 `org-format-latex-options'."
18418 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18419 (let* ((prefixnodir (file-name-nondirectory prefix))
18420 (absprefix (expand-file-name prefix dir))
18421 (todir (file-name-directory absprefix))
18422 (opt org-format-latex-options)
18423 (optnew org-format-latex-options)
18424 (matchers (plist-get opt :matchers))
18425 (re-list org-latex-regexps)
18426 (cnt 0) txt hash link beg end re e checkdir
18427 string
18428 m n block-type block linkfile movefile ov)
18429 ;; Check the different regular expressions
18430 (while (setq e (pop re-list))
18431 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18432 block (if block-type "\n\n" ""))
18433 (when (member m matchers)
18434 (goto-char (point-min))
18435 (while (re-search-forward re nil t)
18436 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18437 (or (not overlays)
18438 (not (eq (get-char-property (match-beginning n)
18439 'org-overlay-type)
18440 'org-latex-overlay))))
18441 (cond
18442 ((eq processing-type 'verbatim))
18443 ((eq processing-type 'mathjax)
18444 ;; Prepare for MathJax processing.
18445 (setq string (match-string n))
18446 (when (member m '("$" "$1"))
18447 (save-excursion
18448 (delete-region (match-beginning n) (match-end n))
18449 (goto-char (match-beginning n))
18450 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18451 ((or (eq processing-type 'dvipng)
18452 (eq processing-type 'imagemagick))
18453 ;; Process to an image.
18454 (setq txt (match-string n)
18455 beg (match-beginning n) end (match-end n)
18456 cnt (1+ cnt))
18457 (let ((face (face-at-point))
18458 (fg (plist-get opt :foreground))
18459 (bg (plist-get opt :background))
18460 ;; Ensure full list is printed.
18461 print-length print-level)
18462 (when forbuffer
18463 ;; Get the colors from the face at point.
18464 (goto-char beg)
18465 (when (eq fg 'auto)
18466 (setq fg (face-attribute face :foreground nil 'default)))
18467 (when (eq bg 'auto)
18468 (setq bg (face-attribute face :background nil 'default)))
18469 (setq optnew (copy-sequence opt))
18470 (plist-put optnew :foreground fg)
18471 (plist-put optnew :background bg))
18472 (setq hash (sha1 (prin1-to-string
18473 (list org-format-latex-header
18474 org-latex-default-packages-alist
18475 org-latex-packages-alist
18476 org-format-latex-options
18477 forbuffer txt fg bg)))
18478 linkfile (format "%s_%s.png" prefix hash)
18479 movefile (format "%s_%s.png" absprefix hash)))
18480 (setq link (concat block "[[file:" linkfile "]]" block))
18481 (if msg (message msg cnt))
18482 (goto-char beg)
18483 (unless checkdir ; Ensure the directory exists.
18484 (setq checkdir t)
18485 (or (file-directory-p todir) (make-directory todir t)))
18486 (unless (file-exists-p movefile)
18487 (org-create-formula-image
18488 txt movefile optnew forbuffer processing-type))
18489 (if overlays
18490 (progn
18491 (mapc (lambda (o)
18492 (if (eq (overlay-get o 'org-overlay-type)
18493 'org-latex-overlay)
18494 (delete-overlay o)))
18495 (overlays-in beg end))
18496 (setq ov (make-overlay beg end))
18497 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18498 (if (featurep 'xemacs)
18499 (progn
18500 (overlay-put ov 'invisible t)
18501 (overlay-put
18502 ov 'end-glyph
18503 (make-glyph (vector 'png :file movefile))))
18504 (overlay-put
18505 ov 'display
18506 (list 'image :type 'png :file movefile :ascent 'center)))
18507 (push ov org-latex-fragment-image-overlays)
18508 (goto-char end))
18509 (delete-region beg end)
18510 (insert (org-add-props link
18511 (list 'org-latex-src
18512 (replace-regexp-in-string
18513 "\"" "" txt)
18514 'org-latex-src-embed-type
18515 (if block-type 'paragraph 'character))))))
18516 ((eq processing-type 'mathml)
18517 ;; Process to MathML
18518 (unless (save-match-data (org-format-latex-mathml-available-p))
18519 (user-error "LaTeX to MathML converter not configured"))
18520 (setq txt (match-string n)
18521 beg (match-beginning n) end (match-end n)
18522 cnt (1+ cnt))
18523 (if msg (message msg cnt))
18524 (goto-char beg)
18525 (delete-region beg end)
18526 (insert (org-format-latex-as-mathml
18527 txt block-type prefix dir)))
18529 (error "Unknown conversion type %s for LaTeX fragments"
18530 processing-type)))))))))
18532 (defun org-create-math-formula (latex-frag &optional mathml-file)
18533 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18534 Use `org-latex-to-mathml-convert-command'. If the conversion is
18535 sucessful, return the portion between \"<math...> </math>\"
18536 elements otherwise return nil. When MATHML-FILE is specified,
18537 write the results in to that file. When invoked as an
18538 interactive command, prompt for LATEX-FRAG, with initial value
18539 set to the current active region and echo the results for user
18540 inspection."
18541 (interactive (list (let ((frag (when (org-region-active-p)
18542 (buffer-substring-no-properties
18543 (region-beginning) (region-end)))))
18544 (read-string "LaTeX Fragment: " frag nil frag))))
18545 (unless latex-frag (error "Invalid LaTeX fragment"))
18546 (let* ((tmp-in-file (file-relative-name
18547 (make-temp-name (expand-file-name "ltxmathml-in"))))
18548 (ignore (write-region latex-frag nil tmp-in-file))
18549 (tmp-out-file (file-relative-name
18550 (make-temp-name (expand-file-name "ltxmathml-out"))))
18551 (cmd (format-spec
18552 org-latex-to-mathml-convert-command
18553 `((?j . ,(shell-quote-argument
18554 (expand-file-name org-latex-to-mathml-jar-file)))
18555 (?I . ,(shell-quote-argument tmp-in-file))
18556 (?o . ,(shell-quote-argument tmp-out-file)))))
18557 mathml shell-command-output)
18558 (when (org-called-interactively-p 'any)
18559 (unless (org-format-latex-mathml-available-p)
18560 (user-error "LaTeX to MathML converter not configured")))
18561 (message "Running %s" cmd)
18562 (setq shell-command-output (shell-command-to-string cmd))
18563 (setq mathml
18564 (when (file-readable-p tmp-out-file)
18565 (with-current-buffer (find-file-noselect tmp-out-file t)
18566 (goto-char (point-min))
18567 (when (re-search-forward
18568 (concat
18569 (regexp-quote
18570 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18571 "\\(.\\|\n\\)*"
18572 (regexp-quote "</math>")) nil t)
18573 (prog1 (match-string 0) (kill-buffer))))))
18574 (cond
18575 (mathml
18576 (setq mathml
18577 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18578 (when mathml-file
18579 (write-region mathml nil mathml-file))
18580 (when (org-called-interactively-p 'any)
18581 (message mathml)))
18582 ((message "LaTeX to MathML conversion failed")
18583 (message shell-command-output)))
18584 (delete-file tmp-in-file)
18585 (when (file-exists-p tmp-out-file)
18586 (delete-file tmp-out-file))
18587 mathml))
18589 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18590 prefix &optional dir)
18591 "Use `org-create-math-formula' but check local cache first."
18592 (let* ((absprefix (expand-file-name prefix dir))
18593 (print-length nil) (print-level nil)
18594 (formula-id (concat
18595 "formula-"
18596 (sha1
18597 (prin1-to-string
18598 (list latex-frag
18599 org-latex-to-mathml-convert-command)))))
18600 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18601 (formula-cache-dir (file-name-directory formula-cache)))
18603 (unless (file-directory-p formula-cache-dir)
18604 (make-directory formula-cache-dir t))
18606 (unless (file-exists-p formula-cache)
18607 (org-create-math-formula latex-frag formula-cache))
18609 (if (file-exists-p formula-cache)
18610 ;; Successful conversion. Return the link to MathML file.
18611 (org-add-props
18612 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18613 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18614 'org-latex-src-embed-type (if latex-frag-type
18615 'paragraph 'character)))
18616 ;; Failed conversion. Return the LaTeX fragment verbatim
18617 latex-frag)))
18619 (defun org-create-formula-image (string tofile options buffer &optional type)
18620 "Create an image from LaTeX source using dvipng or convert.
18621 This function calls either `org-create-formula-image-with-dvipng'
18622 or `org-create-formula-image-with-imagemagick' depending on the
18623 value of `org-latex-create-formula-image-program' or on the value
18624 of the optional TYPE variable.
18626 Note: ultimately these two function should be combined as they
18627 share a good deal of logic."
18628 (org-check-external-command
18629 "latex" "needed to convert LaTeX fragments to images")
18630 (funcall
18631 (case (or type org-latex-create-formula-image-program)
18632 ('dvipng
18633 (org-check-external-command
18634 "dvipng" "needed to convert LaTeX fragments to images")
18635 #'org-create-formula-image-with-dvipng)
18636 ('imagemagick
18637 (org-check-external-command
18638 "convert" "you need to install imagemagick")
18639 #'org-create-formula-image-with-imagemagick)
18640 (t (error
18641 "Invalid value of `org-latex-create-formula-image-program'")))
18642 string tofile options buffer))
18644 (declare-function org-export-get-backend "ox" (name))
18645 (declare-function org-export--get-global-options "ox" (&optional backend))
18646 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18647 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18648 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18649 (defun org-create-formula--latex-header ()
18650 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18651 (let ((info (org-combine-plists (org-export--get-global-options
18652 (org-export-get-backend 'latex))
18653 (org-export--get-inbuffer-options
18654 (org-export-get-backend 'latex)))))
18655 (org-latex-guess-babel-language
18656 (org-latex-guess-inputenc
18657 (org-splice-latex-header
18658 org-format-latex-header
18659 org-latex-default-packages-alist
18660 org-latex-packages-alist t
18661 (plist-get info :latex-header)))
18662 info)))
18664 ;; This function borrows from Ganesh Swami's latex2png.el
18665 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18666 "This calls dvipng."
18667 (require 'ox-latex)
18668 (let* ((tmpdir (if (featurep 'xemacs)
18669 (temp-directory)
18670 temporary-file-directory))
18671 (texfilebase (make-temp-name
18672 (expand-file-name "orgtex" tmpdir)))
18673 (texfile (concat texfilebase ".tex"))
18674 (dvifile (concat texfilebase ".dvi"))
18675 (pngfile (concat texfilebase ".png"))
18676 (fnh (if (featurep 'xemacs)
18677 (font-height (face-font 'default))
18678 (face-attribute 'default :height nil)))
18679 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18680 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18681 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18682 "Black"))
18683 (bg (or (plist-get options (if buffer :background :html-background))
18684 "Transparent")))
18685 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18686 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18687 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18688 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18689 (let ((latex-header (org-create-formula--latex-header)))
18690 (with-temp-file texfile
18691 (insert latex-header)
18692 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18693 (let ((dir default-directory))
18694 (condition-case nil
18695 (progn
18696 (cd tmpdir)
18697 (call-process "latex" nil nil nil texfile))
18698 (error nil))
18699 (cd dir))
18700 (if (not (file-exists-p dvifile))
18701 (progn (message "Failed to create dvi file from %s" texfile) nil)
18702 (condition-case nil
18703 (if (featurep 'xemacs)
18704 (call-process "dvipng" nil nil nil
18705 "-fg" fg "-bg" bg
18706 "-T" "tight"
18707 "-o" pngfile
18708 dvifile)
18709 (call-process "dvipng" nil nil nil
18710 "-fg" fg "-bg" bg
18711 "-D" dpi
18712 ;;"-x" scale "-y" scale
18713 "-T" "tight"
18714 "-o" pngfile
18715 dvifile))
18716 (error nil))
18717 (if (not (file-exists-p pngfile))
18718 (if org-format-latex-signal-error
18719 (error "Failed to create png file from %s" texfile)
18720 (message "Failed to create png file from %s" texfile)
18721 nil)
18722 ;; Use the requested file name and clean up
18723 (copy-file pngfile tofile 'replace)
18724 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18725 (if (file-exists-p (concat texfilebase e))
18726 (delete-file (concat texfilebase e))))
18727 pngfile))))
18729 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18730 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18731 "This calls convert, which is included into imagemagick."
18732 (require 'ox-latex)
18733 (let* ((tmpdir (if (featurep 'xemacs)
18734 (temp-directory)
18735 temporary-file-directory))
18736 (texfilebase (make-temp-name
18737 (expand-file-name "orgtex" tmpdir)))
18738 (texfile (concat texfilebase ".tex"))
18739 (pdffile (concat texfilebase ".pdf"))
18740 (pngfile (concat texfilebase ".png"))
18741 (fnh (if (featurep 'xemacs)
18742 (font-height (face-font 'default))
18743 (face-attribute 'default :height nil)))
18744 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18745 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18746 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18747 "black"))
18748 (bg (or (plist-get options (if buffer :background :html-background))
18749 "white")))
18750 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18751 (setq fg (org-latex-color-format fg)))
18752 (if (eq bg 'default) (setq bg (org-latex-color :background))
18753 (setq bg (org-latex-color-format
18754 (if (string= bg "Transparent") "white" bg))))
18755 (let ((latex-header (org-create-formula--latex-header)))
18756 (with-temp-file texfile
18757 (insert latex-header)
18758 (insert "\n\\begin{document}\n"
18759 "\\definecolor{fg}{rgb}{" fg "}\n"
18760 "\\definecolor{bg}{rgb}{" bg "}\n"
18761 "\n\\pagecolor{bg}\n"
18762 "\n{\\color{fg}\n"
18763 string
18764 "\n}\n"
18765 "\n\\end{document}\n")))
18766 (org-latex-compile texfile t)
18767 (if (not (file-exists-p pdffile))
18768 (progn (message "Failed to create pdf file from %s" texfile) nil)
18769 (condition-case nil
18770 (if (featurep 'xemacs)
18771 (call-process "convert" nil nil nil
18772 "-density" "96"
18773 "-trim"
18774 "-antialias"
18775 pdffile
18776 "-quality" "100"
18777 ;; "-sharpen" "0x1.0"
18778 pngfile)
18779 (call-process "convert" nil nil nil
18780 "-density" dpi
18781 "-trim"
18782 "-antialias"
18783 pdffile
18784 "-quality" "100"
18785 ;; "-sharpen" "0x1.0"
18786 pngfile))
18787 (error nil))
18788 (if (not (file-exists-p pngfile))
18789 (if org-format-latex-signal-error
18790 (error "Failed to create png file from %s" texfile)
18791 (message "Failed to create png file from %s" texfile)
18792 nil)
18793 ;; Use the requested file name and clean up
18794 (copy-file pngfile tofile 'replace)
18795 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18796 (if (file-exists-p (concat texfilebase e))
18797 (delete-file (concat texfilebase e))))
18798 pngfile))))
18800 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18801 "Fill a LaTeX header template TPL.
18802 In the template, the following place holders will be recognized:
18804 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18805 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18806 [PACKAGES] \\usepackage statements for PKG
18807 [NO-PACKAGES] do not include PKG
18808 [EXTRA] the string EXTRA
18809 [NO-EXTRA] do not include EXTRA
18811 For backward compatibility, if both the positive and the negative place
18812 holder is missing, the positive one (without the \"NO-\") will be
18813 assumed to be present at the end of the template.
18814 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18815 EXTRA is a string.
18816 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18817 (let (rpl (end ""))
18818 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18819 (setq rpl (if (or (match-end 1) (not def-pkg))
18820 "" (org-latex-packages-to-string def-pkg snippets-p t))
18821 tpl (replace-match rpl t t tpl))
18822 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18824 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18825 (setq rpl (if (or (match-end 1) (not pkg))
18826 "" (org-latex-packages-to-string pkg snippets-p t))
18827 tpl (replace-match rpl t t tpl))
18828 (if pkg (setq end
18829 (concat end "\n"
18830 (org-latex-packages-to-string pkg snippets-p)))))
18832 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18833 (setq rpl (if (or (match-end 1) (not extra))
18834 "" (concat extra "\n"))
18835 tpl (replace-match rpl t t tpl))
18836 (if (and extra (string-match "\\S-" extra))
18837 (setq end (concat end "\n" extra))))
18839 (if (string-match "\\S-" end)
18840 (concat tpl "\n" end)
18841 tpl)))
18843 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18844 "Turn an alist of packages into a string with the \\usepackage macros."
18845 (setq pkg (mapconcat (lambda(p)
18846 (cond
18847 ((stringp p) p)
18848 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18849 (format "%% Package %s omitted" (cadr p)))
18850 ((equal "" (car p))
18851 (format "\\usepackage{%s}" (cadr p)))
18853 (format "\\usepackage[%s]{%s}"
18854 (car p) (cadr p)))))
18856 "\n"))
18857 (if newline (concat pkg "\n") pkg))
18859 (defun org-dvipng-color (attr)
18860 "Return a RGB color specification for dvipng."
18861 (apply 'format "rgb %s %s %s"
18862 (mapcar 'org-normalize-color
18863 (if (featurep 'xemacs)
18864 (color-rgb-components
18865 (face-property 'default
18866 (cond ((eq attr :foreground) 'foreground)
18867 ((eq attr :background) 'background))))
18868 (color-values (face-attribute 'default attr nil))))))
18870 (defun org-dvipng-color-format (color-name)
18871 "Convert COLOR-NAME to a RGB color value for dvipng."
18872 (apply 'format "rgb %s %s %s"
18873 (mapcar 'org-normalize-color
18874 (color-values color-name))))
18876 (defun org-latex-color (attr)
18877 "Return a RGB color for the LaTeX color package."
18878 (apply 'format "%s,%s,%s"
18879 (mapcar 'org-normalize-color
18880 (if (featurep 'xemacs)
18881 (color-rgb-components
18882 (face-property 'default
18883 (cond ((eq attr :foreground) 'foreground)
18884 ((eq attr :background) 'background))))
18885 (color-values (face-attribute 'default attr nil))))))
18887 (defun org-latex-color-format (color-name)
18888 "Convert COLOR-NAME to a RGB color value."
18889 (apply 'format "%s,%s,%s"
18890 (mapcar 'org-normalize-color
18891 (color-values color-name))))
18893 (defun org-normalize-color (value)
18894 "Return string to be used as color value for an RGB component."
18895 (format "%g" (/ value 65535.0)))
18899 ;; Image display
18901 (defvar org-inline-image-overlays nil)
18902 (make-variable-buffer-local 'org-inline-image-overlays)
18904 (defun org-toggle-inline-images (&optional include-linked)
18905 "Toggle the display of inline images.
18906 INCLUDE-LINKED is passed to `org-display-inline-images'."
18907 (interactive "P")
18908 (if org-inline-image-overlays
18909 (progn
18910 (org-remove-inline-images)
18911 (message "Inline image display turned off"))
18912 (org-display-inline-images include-linked)
18913 (if (and (org-called-interactively-p)
18914 org-inline-image-overlays)
18915 (message "%d images displayed inline"
18916 (length org-inline-image-overlays))
18917 (message "No images to display inline"))))
18919 (defun org-redisplay-inline-images ()
18920 "Refresh the display of inline images."
18921 (interactive)
18922 (if (not org-inline-image-overlays)
18923 (org-toggle-inline-images)
18924 (org-toggle-inline-images)
18925 (org-toggle-inline-images)))
18927 (defun org-display-inline-images (&optional include-linked refresh beg end)
18928 "Display inline images.
18929 Normally only links without a description part are inlined, because this
18930 is how it will work for export. When INCLUDE-LINKED is set, also links
18931 with a description part will be inlined. This can be nice for a quick
18932 look at those images, but it does not reflect what exported files will look
18933 like.
18934 When REFRESH is set, refresh existing images between BEG and END.
18935 This will create new image displays only if necessary.
18936 BEG and END default to the buffer boundaries."
18937 (interactive "P")
18938 (when (display-graphic-p)
18939 (unless refresh
18940 (org-remove-inline-images)
18941 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18942 (save-excursion
18943 (save-restriction
18944 (widen)
18945 (setq beg (or beg (point-min)) end (or end (point-max)))
18946 (goto-char beg)
18947 (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
18948 (substring (org-image-file-name-regexp) 0 -2)
18949 "\\)\\]" (if include-linked "" "\\]")))
18950 (case-fold-search t)
18951 old file ov img type attrwidth width)
18952 (while (re-search-forward re end t)
18953 (setq old (get-char-property-and-overlay (match-beginning 1)
18954 'org-image-overlay)
18955 file (expand-file-name
18956 (concat (or (match-string 3) "") (match-string 4))))
18957 (when (image-type-available-p 'imagemagick)
18958 (setq attrwidth (if (or (listp org-image-actual-width)
18959 (null org-image-actual-width))
18960 (save-excursion
18961 (save-match-data
18962 (when (re-search-backward
18963 "#\\+attr.*:width[ \t]+\\([^ ]+\\)"
18964 (save-excursion
18965 (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
18966 (string-to-number (match-string 1))))))
18967 width (cond ((eq org-image-actual-width t) nil)
18968 ((null org-image-actual-width) attrwidth)
18969 ((numberp org-image-actual-width)
18970 org-image-actual-width)
18971 ((listp org-image-actual-width)
18972 (or attrwidth (car org-image-actual-width))))
18973 type (if width 'imagemagick)))
18974 (when (file-exists-p file)
18975 (if (and (car-safe old) refresh)
18976 (image-refresh (overlay-get (cdr old) 'display))
18977 (setq img (save-match-data (create-image file type nil :width width)))
18978 (when img
18979 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18980 (overlay-put ov 'display img)
18981 (overlay-put ov 'face 'default)
18982 (overlay-put ov 'org-image-overlay t)
18983 (overlay-put ov 'modification-hooks
18984 (list 'org-display-inline-remove-overlay))
18985 (push ov org-inline-image-overlays))))))))))
18987 (define-obsolete-function-alias
18988 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18990 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18991 "Remove inline-display overlay if a corresponding region is modified."
18992 (let ((inhibit-modification-hooks t))
18993 (when (and ov after)
18994 (delete ov org-inline-image-overlays)
18995 (delete-overlay ov))))
18997 (defun org-remove-inline-images ()
18998 "Remove inline display of images."
18999 (interactive)
19000 (mapc 'delete-overlay org-inline-image-overlays)
19001 (setq org-inline-image-overlays nil))
19003 ;;;; Key bindings
19005 ;; Outline functions from `outline-mode-prefix-map'
19006 ;; that can be remapped in Org:
19007 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19008 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19009 (define-key org-mode-map [remap outline-forward-same-level]
19010 'org-forward-heading-same-level)
19011 (define-key org-mode-map [remap outline-backward-same-level]
19012 'org-backward-heading-same-level)
19013 (define-key org-mode-map [remap show-branches]
19014 'org-kill-note-or-show-branches)
19015 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19016 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19017 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19019 ;; Outline functions from `outline-mode-prefix-map' that can not
19020 ;; be remapped in Org:
19022 ;; - the column "key binding" shows whether the Outline function is still
19023 ;; available in Org mode on the same key that it has been bound to in
19024 ;; Outline mode:
19025 ;; - "overridden": key used for a different functionality in Org mode
19026 ;; - else: key still bound to the same Outline function in Org mode
19028 ;; | Outline function | key binding | Org replacement |
19029 ;; |------------------------------------+-------------+-----------------------|
19030 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19031 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19032 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19033 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19034 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19035 ;; | `show-entry' | overridden | no replacement |
19036 ;; | `show-children' | `C-c C-i' | visibility cycling |
19037 ;; | `show-branches' | `C-c C-k' | still same function |
19038 ;; | `show-subtree' | overridden | visibility cycling |
19039 ;; | `show-all' | overridden | no replacement |
19040 ;; | `hide-subtree' | overridden | visibility cycling |
19041 ;; | `hide-body' | overridden | no replacement |
19042 ;; | `hide-entry' | overridden | visibility cycling |
19043 ;; | `hide-leaves' | overridden | no replacement |
19044 ;; | `hide-sublevels' | overridden | no replacement |
19045 ;; | `hide-other' | overridden | no replacement |
19047 ;; Make `C-c C-x' a prefix key
19048 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19050 ;; TAB key with modifiers
19051 (org-defkey org-mode-map "\C-i" 'org-cycle)
19052 (org-defkey org-mode-map [(tab)] 'org-cycle)
19053 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19054 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19055 ;; The following line is necessary under Suse GNU/Linux
19056 (unless (featurep 'xemacs)
19057 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19058 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19059 (define-key org-mode-map [backtab] 'org-shifttab)
19061 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19062 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19063 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19065 ;; Cursor keys with modifiers
19066 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19067 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19068 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19069 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19071 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19072 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19073 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19074 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19076 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19077 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19078 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19079 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19081 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19082 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19083 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19084 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19086 ;; Babel keys
19087 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19088 (mapc (lambda (pair)
19089 (define-key org-babel-map (car pair) (cdr pair)))
19090 org-babel-key-bindings)
19092 ;;; Extra keys for tty access.
19093 ;; We only set them when really needed because otherwise the
19094 ;; menus don't show the simple keys
19096 (when (or org-use-extra-keys
19097 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19098 (not window-system))
19099 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19100 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19101 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19102 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19103 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19104 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19105 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19106 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19107 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19108 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19109 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19110 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19111 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19112 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19113 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19114 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19115 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19116 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19117 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19118 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19119 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19120 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19121 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19122 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19123 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19124 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19125 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19126 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19128 ;; All the other keys
19130 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19131 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19132 (if (boundp 'narrow-map)
19133 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19134 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19135 (if (boundp 'narrow-map)
19136 (org-defkey narrow-map "b" 'org-narrow-to-block)
19137 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19138 (if (boundp 'narrow-map)
19139 (org-defkey narrow-map "e" 'org-narrow-to-element)
19140 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19141 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19142 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19143 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19144 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19145 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19146 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19147 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19148 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19149 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19150 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19151 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19152 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19153 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19154 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19155 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19156 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19157 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19158 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19159 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19160 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19161 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19162 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19163 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19164 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19165 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19166 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19167 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19168 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19169 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19170 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19171 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19172 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19173 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19174 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19175 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19176 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19177 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19178 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19179 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19180 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19181 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19182 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19183 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19184 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19185 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19186 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19187 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19188 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19189 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19190 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19191 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19192 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19193 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19194 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19195 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19196 (org-defkey org-mode-map "\C-c^" 'org-sort)
19197 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19198 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19199 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19200 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19201 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19202 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19203 (org-defkey org-mode-map "\C-m" 'org-return)
19204 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19205 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19206 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19207 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19208 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19209 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19210 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19211 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19212 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19213 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19214 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19215 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19216 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19217 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19218 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19219 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19220 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19221 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19222 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19223 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19224 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19225 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19226 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19228 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19229 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19230 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19232 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19233 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19234 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19235 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19236 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19237 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19238 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19239 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19240 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19241 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19242 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19243 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19244 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19245 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19246 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19247 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19248 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19249 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19250 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19251 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19252 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19253 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19254 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19256 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19257 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19258 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19259 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19260 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19262 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19264 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19266 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19267 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19269 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19272 (when (featurep 'xemacs)
19273 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19276 (defconst org-speed-commands-default
19278 ("Outline Navigation")
19279 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19280 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19281 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19282 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19283 ("F" . org-next-block)
19284 ("B" . org-previous-block)
19285 ("u" . (org-speed-move-safe 'outline-up-heading))
19286 ("j" . org-goto)
19287 ("g" . (org-refile t))
19288 ("Outline Visibility")
19289 ("c" . org-cycle)
19290 ("C" . org-shifttab)
19291 (" " . org-display-outline-path)
19292 ("s" . org-narrow-to-subtree)
19293 ("=" . org-columns)
19294 ("Outline Structure Editing")
19295 ("U" . org-shiftmetaup)
19296 ("D" . org-shiftmetadown)
19297 ("r" . org-metaright)
19298 ("l" . org-metaleft)
19299 ("R" . org-shiftmetaright)
19300 ("L" . org-shiftmetaleft)
19301 ("i" . (progn (forward-char 1) (call-interactively
19302 'org-insert-heading-respect-content)))
19303 ("^" . org-sort)
19304 ("w" . org-refile)
19305 ("a" . org-archive-subtree-default-with-confirmation)
19306 ("@" . org-mark-subtree)
19307 ("#" . org-toggle-comment)
19308 ("Clock Commands")
19309 ("I" . org-clock-in)
19310 ("O" . org-clock-out)
19311 ("Meta Data Editing")
19312 ("t" . org-todo)
19313 ("," . (org-priority))
19314 ("0" . (org-priority ?\ ))
19315 ("1" . (org-priority ?A))
19316 ("2" . (org-priority ?B))
19317 ("3" . (org-priority ?C))
19318 (":" . org-set-tags-command)
19319 ("e" . org-set-effort)
19320 ("E" . org-inc-effort)
19321 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19322 (org-entry-put (point) "APPT_WARNTIME" m)))
19323 ("Agenda Views etc")
19324 ("v" . org-agenda)
19325 ("/" . org-sparse-tree)
19326 ("Misc")
19327 ("o" . org-open-at-point)
19328 ("?" . org-speed-command-help)
19329 ("<" . (org-agenda-set-restriction-lock 'subtree))
19330 (">" . (org-agenda-remove-restriction-lock))
19332 "The default speed commands.")
19334 (defun org-print-speed-command (e)
19335 (if (> (length (car e)) 1)
19336 (progn
19337 (princ "\n")
19338 (princ (car e))
19339 (princ "\n")
19340 (princ (make-string (length (car e)) ?-))
19341 (princ "\n"))
19342 (princ (car e))
19343 (princ " ")
19344 (if (symbolp (cdr e))
19345 (princ (symbol-name (cdr e)))
19346 (prin1 (cdr e)))
19347 (princ "\n")))
19349 (defun org-speed-command-help ()
19350 "Show the available speed commands."
19351 (interactive)
19352 (if (not org-use-speed-commands)
19353 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19354 (with-output-to-temp-buffer "*Help*"
19355 (princ "User-defined Speed commands\n===========================\n")
19356 (mapc 'org-print-speed-command org-speed-commands-user)
19357 (princ "\n")
19358 (princ "Built-in Speed commands\n=======================\n")
19359 (mapc 'org-print-speed-command org-speed-commands-default))
19360 (with-current-buffer "*Help*"
19361 (setq truncate-lines t))))
19363 (defun org-speed-move-safe (cmd)
19364 "Execute CMD, but make sure that the cursor always ends up in a headline.
19365 If not, return to the original position and throw an error."
19366 (interactive)
19367 (let ((pos (point)))
19368 (call-interactively cmd)
19369 (unless (and (bolp) (org-at-heading-p))
19370 (goto-char pos)
19371 (error "Boundary reached while executing %s" cmd))))
19373 (defvar org-self-insert-command-undo-counter 0)
19375 (defvar org-table-auto-blank-field) ; defined in org-table.el
19376 (defvar org-speed-command nil)
19378 (define-obsolete-function-alias
19379 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19381 (defun org-speed-command-activate (keys)
19382 "Hook for activating single-letter speed commands.
19383 `org-speed-commands-default' specifies a minimal command set.
19384 Use `org-speed-commands-user' for further customization."
19385 (when (or (and (bolp) (looking-at org-outline-regexp))
19386 (and (functionp org-use-speed-commands)
19387 (funcall org-use-speed-commands)))
19388 (cdr (assoc keys (append org-speed-commands-user
19389 org-speed-commands-default)))))
19391 (define-obsolete-function-alias
19392 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19394 (defun org-babel-speed-command-activate (keys)
19395 "Hook for activating single-letter code block commands."
19396 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19397 (cdr (assoc keys org-babel-key-bindings))))
19399 (defcustom org-speed-command-hook
19400 '(org-speed-command-default-hook org-babel-speed-command-hook)
19401 "Hook for activating speed commands at strategic locations.
19402 Hook functions are called in sequence until a valid handler is
19403 found.
19405 Each hook takes a single argument, a user-pressed command key
19406 which is also a `self-insert-command' from the global map.
19408 Within the hook, examine the cursor position and the command key
19409 and return nil or a valid handler as appropriate. Handler could
19410 be one of an interactive command, a function, or a form.
19412 Set `org-use-speed-commands' to non-nil value to enable this
19413 hook. The default setting is `org-speed-command-activate'."
19414 :group 'org-structure
19415 :version "24.1"
19416 :type 'hook)
19418 (defun org-self-insert-command (N)
19419 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19420 If the cursor is in a table looking at whitespace, the whitespace is
19421 overwritten, and the table is not marked as requiring realignment."
19422 (interactive "p")
19423 (org-check-before-invisible-edit 'insert)
19424 (cond
19425 ((and org-use-speed-commands
19426 (setq org-speed-command
19427 (run-hook-with-args-until-success
19428 'org-speed-command-hook (this-command-keys))))
19429 (cond
19430 ((commandp org-speed-command)
19431 (setq this-command org-speed-command)
19432 (call-interactively org-speed-command))
19433 ((functionp org-speed-command)
19434 (funcall org-speed-command))
19435 ((and org-speed-command (listp org-speed-command))
19436 (eval org-speed-command))
19437 (t (let (org-use-speed-commands)
19438 (call-interactively 'org-self-insert-command)))))
19439 ((and
19440 (org-table-p)
19441 (progn
19442 ;; check if we blank the field, and if that triggers align
19443 (and (featurep 'org-table) org-table-auto-blank-field
19444 (member last-command
19445 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19446 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19447 ;; got extra space, this field does not determine column width
19448 (let (org-table-may-need-update) (org-table-blank-field))
19449 ;; no extra space, this field may determine column width
19450 (org-table-blank-field)))
19452 (eq N 1)
19453 (looking-at "[^|\n]* |"))
19454 (let (org-table-may-need-update)
19455 (goto-char (1- (match-end 0)))
19456 (backward-delete-char 1)
19457 (goto-char (match-beginning 0))
19458 (self-insert-command N)))
19460 (setq org-table-may-need-update t)
19461 (self-insert-command N)
19462 (org-fix-tags-on-the-fly)
19463 (if org-self-insert-cluster-for-undo
19464 (if (not (eq last-command 'org-self-insert-command))
19465 (setq org-self-insert-command-undo-counter 1)
19466 (if (>= org-self-insert-command-undo-counter 20)
19467 (setq org-self-insert-command-undo-counter 1)
19468 (and (> org-self-insert-command-undo-counter 0)
19469 buffer-undo-list (listp buffer-undo-list)
19470 (not (cadr buffer-undo-list)) ; remove nil entry
19471 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19472 (setq org-self-insert-command-undo-counter
19473 (1+ org-self-insert-command-undo-counter))))))))
19475 (defun org-check-before-invisible-edit (kind)
19476 "Check is editing if kind KIND would be dangerous with invisible text around.
19477 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19478 ;; First, try to get out of here as quickly as possible, to reduce overhead
19479 (if (and org-catch-invisible-edits
19480 (or (not (boundp 'visible-mode)) (not visible-mode))
19481 (or (get-char-property (point) 'invisible)
19482 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19483 ;; OK, we need to take a closer look
19484 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19485 (invisible-before-point (if (bobp) nil (get-char-property
19486 (1- (point)) 'invisible)))
19487 (border-and-ok-direction
19489 ;; Check if we are acting predictably before invisible text
19490 (and invisible-at-point (not invisible-before-point)
19491 (memq kind '(insert delete-backward)))
19492 ;; Check if we are acting predictably after invisible text
19493 ;; This works not well, and I have turned it off. It seems
19494 ;; better to always show and stop after invisible text.
19495 ;; (and (not invisible-at-point) invisible-before-point
19496 ;; (memq kind '(insert delete)))
19498 (when (or (memq invisible-at-point '(outline org-hide-block t))
19499 (memq invisible-before-point '(outline org-hide-block t)))
19500 (if (eq org-catch-invisible-edits 'error)
19501 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19502 (if (and org-custom-properties-overlays
19503 (y-or-n-p "Display invisible properties in this buffer? "))
19504 (org-toggle-custom-properties-visibility)
19505 ;; Make the area visible
19506 (save-excursion
19507 (if invisible-before-point
19508 (goto-char (previous-single-char-property-change
19509 (point) 'invisible)))
19510 (show-subtree))
19511 (cond
19512 ((eq org-catch-invisible-edits 'show)
19513 ;; That's it, we do the edit after showing
19514 (message
19515 "Unfolding invisible region around point before editing")
19516 (sit-for 1))
19517 ((and (eq org-catch-invisible-edits 'smart)
19518 border-and-ok-direction)
19519 (message "Unfolding invisible region around point before editing"))
19521 ;; Don't do the edit, make the user repeat it in full visibility
19522 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19524 (defun org-fix-tags-on-the-fly ()
19525 (when (and (equal (char-after (point-at-bol)) ?*)
19526 (org-at-heading-p))
19527 (org-align-tags-here org-tags-column)))
19529 (defun org-delete-backward-char (N)
19530 "Like `delete-backward-char', insert whitespace at field end in tables.
19531 When deleting backwards, in tables this function will insert whitespace in
19532 front of the next \"|\" separator, to keep the table aligned. The table will
19533 still be marked for re-alignment if the field did fill the entire column,
19534 because, in this case the deletion might narrow the column."
19535 (interactive "p")
19536 (save-match-data
19537 (org-check-before-invisible-edit 'delete-backward)
19538 (if (and (org-table-p)
19539 (eq N 1)
19540 (string-match "|" (buffer-substring (point-at-bol) (point)))
19541 (looking-at ".*?|"))
19542 (let ((pos (point))
19543 (noalign (looking-at "[^|\n\r]* |"))
19544 (c org-table-may-need-update))
19545 (backward-delete-char N)
19546 (if (not overwrite-mode)
19547 (progn
19548 (skip-chars-forward "^|")
19549 (insert " ")
19550 (goto-char (1- pos))))
19551 ;; noalign: if there were two spaces at the end, this field
19552 ;; does not determine the width of the column.
19553 (if noalign (setq org-table-may-need-update c)))
19554 (backward-delete-char N)
19555 (org-fix-tags-on-the-fly))))
19557 (defun org-delete-char (N)
19558 "Like `delete-char', but insert whitespace at field end in tables.
19559 When deleting characters, in tables this function will insert whitespace in
19560 front of the next \"|\" separator, to keep the table aligned. The table will
19561 still be marked for re-alignment if the field did fill the entire column,
19562 because, in this case the deletion might narrow the column."
19563 (interactive "p")
19564 (save-match-data
19565 (org-check-before-invisible-edit 'delete)
19566 (if (and (org-table-p)
19567 (not (bolp))
19568 (not (= (char-after) ?|))
19569 (eq N 1))
19570 (if (looking-at ".*?|")
19571 (let ((pos (point))
19572 (noalign (looking-at "[^|\n\r]* |"))
19573 (c org-table-may-need-update))
19574 (replace-match
19575 (concat (substring (match-string 0) 1 -1) " |") nil t)
19576 (goto-char pos)
19577 ;; noalign: if there were two spaces at the end, this field
19578 ;; does not determine the width of the column.
19579 (if noalign (setq org-table-may-need-update c)))
19580 (delete-char N))
19581 (delete-char N)
19582 (org-fix-tags-on-the-fly))))
19584 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19585 (put 'org-self-insert-command 'delete-selection
19586 (lambda ()
19587 (not (run-hook-with-args-until-success
19588 'self-insert-uses-region-functions))))
19589 (put 'orgtbl-self-insert-command 'delete-selection
19590 (lambda ()
19591 (not (run-hook-with-args-until-success
19592 'self-insert-uses-region-functions))))
19593 (put 'org-delete-char 'delete-selection 'supersede)
19594 (put 'org-delete-backward-char 'delete-selection 'supersede)
19595 (put 'org-yank 'delete-selection 'yank)
19597 ;; Make `flyspell-mode' delay after some commands
19598 (put 'org-self-insert-command 'flyspell-delayed t)
19599 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19600 (put 'org-delete-char 'flyspell-delayed t)
19601 (put 'org-delete-backward-char 'flyspell-delayed t)
19603 ;; Make pabbrev-mode expand after org-mode commands
19604 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19605 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19607 (defun org-remap (map &rest commands)
19608 "In MAP, remap the functions given in COMMANDS.
19609 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19610 (let (new old)
19611 (while commands
19612 (setq old (pop commands) new (pop commands))
19613 (if (fboundp 'command-remapping)
19614 (org-defkey map (vector 'remap old) new)
19615 (substitute-key-definition old new map global-map)))))
19617 (defun org-transpose-words ()
19618 "Transpose words for Org.
19619 This uses the `org-mode-transpose-word-syntax-table' syntax
19620 table, which interprets characters in `org-emphasis-alist' as
19621 word constituents."
19622 (interactive)
19623 (with-syntax-table org-mode-transpose-word-syntax-table
19624 (call-interactively 'transpose-words)))
19625 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19627 (when (eq org-enable-table-editor 'optimized)
19628 ;; If the user wants maximum table support, we need to hijack
19629 ;; some standard editing functions
19630 (org-remap org-mode-map
19631 'self-insert-command 'org-self-insert-command
19632 'delete-char 'org-delete-char
19633 'delete-backward-char 'org-delete-backward-char)
19634 (org-defkey org-mode-map "|" 'org-force-self-insert))
19636 (defvar org-ctrl-c-ctrl-c-hook nil
19637 "Hook for functions attaching themselves to `C-c C-c'.
19639 This can be used to add additional functionality to the C-c C-c
19640 key which executes context-dependent commands. This hook is run
19641 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19642 run after the last test.
19644 Each function will be called with no arguments. The function
19645 must check if the context is appropriate for it to act. If yes,
19646 it should do its thing and then return a non-nil value. If the
19647 context is wrong, just do nothing and return nil.")
19649 (defvar org-ctrl-c-ctrl-c-final-hook nil
19650 "Hook for functions attaching themselves to `C-c C-c'.
19652 This can be used to add additional functionality to the C-c C-c
19653 key which executes context-dependent commands. This hook is run
19654 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19655 before the first test.
19657 Each function will be called with no arguments. The function
19658 must check if the context is appropriate for it to act. If yes,
19659 it should do its thing and then return a non-nil value. If the
19660 context is wrong, just do nothing and return nil.")
19662 (defvar org-tab-first-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 as the first action when TAB is pressed, even before
19666 `org-cycle' messes around with the `outline-regexp' to cater for
19667 inline tasks and plain list item folding.
19668 If any function in this hook returns t, any other actions that
19669 would have been caused by TAB (such as table field motion or visibility
19670 cycling) will not occur.")
19672 (defvar org-tab-after-check-for-table-hook nil
19673 "Hook for functions to attach themselves to TAB.
19674 See `org-ctrl-c-ctrl-c-hook' for more information.
19675 This hook runs after it has been established that the cursor is not in a
19676 table, but before checking if the cursor is in a headline or if global cycling
19677 should be done.
19678 If any function in this hook returns t, not other actions like visibility
19679 cycling will be done.")
19681 (defvar org-tab-after-check-for-cycling-hook nil
19682 "Hook for functions to attach themselves to TAB.
19683 See `org-ctrl-c-ctrl-c-hook' for more information.
19684 This hook runs after it has been established that not table field motion and
19685 not visibility should be done because of current context. This is probably
19686 the place where a package like yasnippets can hook in.")
19688 (defvar org-tab-before-tab-emulation-hook nil
19689 "Hook for functions to attach themselves to TAB.
19690 See `org-ctrl-c-ctrl-c-hook' for more information.
19691 This hook runs after every other options for TAB have been exhausted, but
19692 before indentation and \t insertion takes place.")
19694 (defvar org-metaleft-hook nil
19695 "Hook for functions attaching themselves to `M-left'.
19696 See `org-ctrl-c-ctrl-c-hook' for more information.")
19697 (defvar org-metaright-hook nil
19698 "Hook for functions attaching themselves to `M-right'.
19699 See `org-ctrl-c-ctrl-c-hook' for more information.")
19700 (defvar org-metaup-hook nil
19701 "Hook for functions attaching themselves to `M-up'.
19702 See `org-ctrl-c-ctrl-c-hook' for more information.")
19703 (defvar org-metadown-hook nil
19704 "Hook for functions attaching themselves to `M-down'.
19705 See `org-ctrl-c-ctrl-c-hook' for more information.")
19706 (defvar org-shiftmetaleft-hook nil
19707 "Hook for functions attaching themselves to `M-S-left'.
19708 See `org-ctrl-c-ctrl-c-hook' for more information.")
19709 (defvar org-shiftmetaright-hook nil
19710 "Hook for functions attaching themselves to `M-S-right'.
19711 See `org-ctrl-c-ctrl-c-hook' for more information.")
19712 (defvar org-shiftmetaup-hook nil
19713 "Hook for functions attaching themselves to `M-S-up'.
19714 See `org-ctrl-c-ctrl-c-hook' for more information.")
19715 (defvar org-shiftmetadown-hook nil
19716 "Hook for functions attaching themselves to `M-S-down'.
19717 See `org-ctrl-c-ctrl-c-hook' for more information.")
19718 (defvar org-metareturn-hook nil
19719 "Hook for functions attaching themselves to `M-RET'.
19720 See `org-ctrl-c-ctrl-c-hook' for more information.")
19721 (defvar org-shiftup-hook nil
19722 "Hook for functions attaching themselves to `S-up'.
19723 See `org-ctrl-c-ctrl-c-hook' for more information.")
19724 (defvar org-shiftup-final-hook nil
19725 "Hook for functions attaching themselves to `S-up'.
19726 This one runs after all other options except shift-select have been excluded.
19727 See `org-ctrl-c-ctrl-c-hook' for more information.")
19728 (defvar org-shiftdown-hook nil
19729 "Hook for functions attaching themselves to `S-down'.
19730 See `org-ctrl-c-ctrl-c-hook' for more information.")
19731 (defvar org-shiftdown-final-hook nil
19732 "Hook for functions attaching themselves to `S-down'.
19733 This one runs after all other options except shift-select have been excluded.
19734 See `org-ctrl-c-ctrl-c-hook' for more information.")
19735 (defvar org-shiftleft-hook nil
19736 "Hook for functions attaching themselves to `S-left'.
19737 See `org-ctrl-c-ctrl-c-hook' for more information.")
19738 (defvar org-shiftleft-final-hook nil
19739 "Hook for functions attaching themselves to `S-left'.
19740 This one runs after all other options except shift-select have been excluded.
19741 See `org-ctrl-c-ctrl-c-hook' for more information.")
19742 (defvar org-shiftright-hook nil
19743 "Hook for functions attaching themselves to `S-right'.
19744 See `org-ctrl-c-ctrl-c-hook' for more information.")
19745 (defvar org-shiftright-final-hook nil
19746 "Hook for functions attaching themselves to `S-right'.
19747 This one runs after all other options except shift-select have been excluded.
19748 See `org-ctrl-c-ctrl-c-hook' for more information.")
19750 (defun org-modifier-cursor-error ()
19751 "Throw an error, a modified cursor command was applied in wrong context."
19752 (user-error "This command is active in special context like tables, headlines or items"))
19754 (defun org-shiftselect-error ()
19755 "Throw an error because Shift-Cursor command was applied in wrong context."
19756 (if (and (boundp 'shift-select-mode) shift-select-mode)
19757 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19758 (user-error "This command works only in special context like headlines or timestamps")))
19760 (defun org-call-for-shift-select (cmd)
19761 (let ((this-command-keys-shift-translated t))
19762 (call-interactively cmd)))
19764 (defun org-shifttab (&optional arg)
19765 "Global visibility cycling or move to previous table field.
19766 Call `org-table-previous-field' within a table.
19767 When ARG is nil, cycle globally through visibility states.
19768 When ARG is a numeric prefix, show contents of this level."
19769 (interactive "P")
19770 (cond
19771 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19772 ((integerp arg)
19773 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19774 (message "Content view to level: %d" arg)
19775 (org-content (prefix-numeric-value arg2))
19776 (org-cycle-show-empty-lines t)
19777 (setq org-cycle-global-status 'overview)))
19778 (t (call-interactively 'org-global-cycle))))
19780 (defun org-shiftmetaleft ()
19781 "Promote subtree or delete table column.
19782 Calls `org-promote-subtree', `org-outdent-item-tree', or
19783 `org-table-delete-column', depending on context. See the
19784 individual commands for more information."
19785 (interactive)
19786 (cond
19787 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19788 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19789 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19790 ((if (not (org-region-active-p)) (org-at-item-p)
19791 (save-excursion (goto-char (region-beginning))
19792 (org-at-item-p)))
19793 (call-interactively 'org-outdent-item-tree))
19794 (t (org-modifier-cursor-error))))
19796 (defun org-shiftmetaright ()
19797 "Demote subtree or insert table column.
19798 Calls `org-demote-subtree', `org-indent-item-tree', or
19799 `org-table-insert-column', depending on context. See the
19800 individual commands for more information."
19801 (interactive)
19802 (cond
19803 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19804 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19805 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19806 ((if (not (org-region-active-p)) (org-at-item-p)
19807 (save-excursion (goto-char (region-beginning))
19808 (org-at-item-p)))
19809 (call-interactively 'org-indent-item-tree))
19810 (t (org-modifier-cursor-error))))
19812 (defun org-shiftmetaup (&optional arg)
19813 "Move subtree up or kill table row.
19814 Calls `org-move-subtree-up' or `org-table-kill-row' or
19815 `org-move-item-up' or `org-timestamp-up', depending on context.
19816 See the individual commands for more information."
19817 (interactive "P")
19818 (cond
19819 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19820 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19821 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19822 ((org-at-item-p) (call-interactively 'org-move-item-up))
19823 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19824 (call-interactively 'org-timestamp-up)))
19825 (t (call-interactively 'org-drag-line-backward))))
19827 (defun org-shiftmetadown (&optional arg)
19828 "Move subtree down or insert table row.
19829 Calls `org-move-subtree-down' or `org-table-insert-row' or
19830 `org-move-item-down' or `org-timestamp-up', depending on context.
19831 See the individual commands for more information."
19832 (interactive "P")
19833 (cond
19834 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19835 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19836 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19837 ((org-at-item-p) (call-interactively 'org-move-item-down))
19838 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19839 (call-interactively 'org-timestamp-down)))
19840 (t (call-interactively 'org-drag-line-forward))))
19842 (defsubst org-hidden-tree-error ()
19843 (user-error
19844 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19846 (defun org-metaleft (&optional arg)
19847 "Promote heading or move table column to left.
19848 Calls `org-do-promote' or `org-table-move-column', depending on context.
19849 With no specific context, calls the Emacs default `backward-word'.
19850 See the individual commands for more information."
19851 (interactive "P")
19852 (cond
19853 ((run-hook-with-args-until-success 'org-metaleft-hook))
19854 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19855 ((org-with-limited-levels
19856 (or (org-at-heading-p)
19857 (and (org-region-active-p)
19858 (save-excursion
19859 (goto-char (region-beginning))
19860 (org-at-heading-p)))))
19861 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19862 (call-interactively 'org-do-promote))
19863 ;; At an inline task.
19864 ((org-at-heading-p)
19865 (call-interactively 'org-inlinetask-promote))
19866 ((or (org-at-item-p)
19867 (and (org-region-active-p)
19868 (save-excursion
19869 (goto-char (region-beginning))
19870 (org-at-item-p))))
19871 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19872 (call-interactively 'org-outdent-item))
19873 (t (call-interactively 'backward-word))))
19875 (defun org-metaright (&optional arg)
19876 "Demote a subtree, a list item or move table column to right.
19877 In front of a drawer or a block keyword, indent it correctly.
19878 With no specific context, calls the Emacs default `forward-word'.
19879 See the individual commands for more information."
19880 (interactive "P")
19881 (cond
19882 ((run-hook-with-args-until-success 'org-metaright-hook))
19883 ((org-at-table-p) (call-interactively 'org-table-move-column))
19884 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19885 ((org-at-block-p) (call-interactively 'org-indent-block))
19886 ((org-with-limited-levels
19887 (or (org-at-heading-p)
19888 (and (org-region-active-p)
19889 (save-excursion
19890 (goto-char (region-beginning))
19891 (org-at-heading-p)))))
19892 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19893 (call-interactively 'org-do-demote))
19894 ;; At an inline task.
19895 ((org-at-heading-p)
19896 (call-interactively 'org-inlinetask-demote))
19897 ((or (org-at-item-p)
19898 (and (org-region-active-p)
19899 (save-excursion
19900 (goto-char (region-beginning))
19901 (org-at-item-p))))
19902 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19903 (call-interactively 'org-indent-item))
19904 (t (call-interactively 'forward-word))))
19906 (defun org-check-for-hidden (what)
19907 "Check if there are hidden headlines/items in the current visual line.
19908 WHAT can be either `headlines' or `items'. If the current line is
19909 an outline or item heading and it has a folded subtree below it,
19910 this function returns t, nil otherwise."
19911 (let ((re (cond
19912 ((eq what 'headlines) org-outline-regexp-bol)
19913 ((eq what 'items) (org-item-beginning-re))
19914 (t (error "This should not happen"))))
19915 beg end)
19916 (save-excursion
19917 (catch 'exit
19918 (unless (org-region-active-p)
19919 (setq beg (point-at-bol))
19920 (beginning-of-line 2)
19921 (while (and (not (eobp)) ;; this is like `next-line'
19922 (get-char-property (1- (point)) 'invisible))
19923 (beginning-of-line 2))
19924 (setq end (point))
19925 (goto-char beg)
19926 (goto-char (point-at-eol))
19927 (setq end (max end (point)))
19928 (while (re-search-forward re end t)
19929 (if (get-char-property (match-beginning 0) 'invisible)
19930 (throw 'exit t))))
19931 nil))))
19933 (defun org-metaup (&optional arg)
19934 "Move subtree up or move table row up.
19935 Calls `org-move-subtree-up' or `org-table-move-row' or
19936 `org-move-item-up', depending on context. See the individual commands
19937 for more information."
19938 (interactive "P")
19939 (cond
19940 ((run-hook-with-args-until-success 'org-metaup-hook))
19941 ((org-region-active-p)
19942 (let* ((a (min (region-beginning) (region-end)))
19943 (b (1- (max (region-beginning) (region-end))))
19944 (c (save-excursion (goto-char a)
19945 (move-beginning-of-line 0)))
19946 (d (save-excursion (goto-char a)
19947 (move-end-of-line 0) (point))))
19948 (transpose-regions a b c d)
19949 (goto-char c)))
19950 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19951 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19952 ((org-at-item-p) (call-interactively 'org-move-item-up))
19953 (t (org-drag-element-backward))))
19955 (defun org-metadown (&optional arg)
19956 "Move subtree down or move table row down.
19957 Calls `org-move-subtree-down' or `org-table-move-row' or
19958 `org-move-item-down', depending on context. See the individual
19959 commands for more information."
19960 (interactive "P")
19961 (cond
19962 ((run-hook-with-args-until-success 'org-metadown-hook))
19963 ((org-region-active-p)
19964 (let* ((a (min (region-beginning) (region-end)))
19965 (b (max (region-beginning) (region-end)))
19966 (c (save-excursion (goto-char b)
19967 (move-beginning-of-line 1)))
19968 (d (save-excursion (goto-char b)
19969 (move-end-of-line 1) (1+ (point)))))
19970 (transpose-regions a b c d)
19971 (goto-char d)))
19972 ((org-at-table-p) (call-interactively 'org-table-move-row))
19973 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19974 ((org-at-item-p) (call-interactively 'org-move-item-down))
19975 (t (org-drag-element-forward))))
19977 (defun org-shiftup (&optional arg)
19978 "Increase item in timestamp or increase priority of current headline.
19979 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19980 depending on context. See the individual commands for more information."
19981 (interactive "P")
19982 (cond
19983 ((run-hook-with-args-until-success 'org-shiftup-hook))
19984 ((and org-support-shift-select (org-region-active-p))
19985 (org-call-for-shift-select 'previous-line))
19986 ((org-at-timestamp-p t)
19987 (call-interactively (if org-edit-timestamp-down-means-later
19988 'org-timestamp-down 'org-timestamp-up)))
19989 ((and (not (eq org-support-shift-select 'always))
19990 org-enable-priority-commands
19991 (org-at-heading-p))
19992 (call-interactively 'org-priority-up))
19993 ((and (not org-support-shift-select) (org-at-item-p))
19994 (call-interactively 'org-previous-item))
19995 ((org-clocktable-try-shift 'up arg))
19996 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19997 (org-support-shift-select
19998 (org-call-for-shift-select 'previous-line))
19999 (t (org-shiftselect-error))))
20001 (defun org-shiftdown (&optional arg)
20002 "Decrease item in timestamp or decrease priority of current headline.
20003 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20004 depending on context. See the individual commands for more information."
20005 (interactive "P")
20006 (cond
20007 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20008 ((and org-support-shift-select (org-region-active-p))
20009 (org-call-for-shift-select 'next-line))
20010 ((org-at-timestamp-p t)
20011 (call-interactively (if org-edit-timestamp-down-means-later
20012 'org-timestamp-up 'org-timestamp-down)))
20013 ((and (not (eq org-support-shift-select 'always))
20014 org-enable-priority-commands
20015 (org-at-heading-p))
20016 (call-interactively 'org-priority-down))
20017 ((and (not org-support-shift-select) (org-at-item-p))
20018 (call-interactively 'org-next-item))
20019 ((org-clocktable-try-shift 'down arg))
20020 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20021 (org-support-shift-select
20022 (org-call-for-shift-select 'next-line))
20023 (t (org-shiftselect-error))))
20025 (defun org-shiftright (&optional arg)
20026 "Cycle the thing at point or in the current line, depending on context.
20027 Depending on context, this does one of the following:
20029 - switch a timestamp at point one day into the future
20030 - on a headline, switch to the next TODO keyword.
20031 - on an item, switch entire list to the next bullet type
20032 - on a property line, switch to the next allowed value
20033 - on a clocktable definition line, move time block into the future"
20034 (interactive "P")
20035 (cond
20036 ((run-hook-with-args-until-success 'org-shiftright-hook))
20037 ((and org-support-shift-select (org-region-active-p))
20038 (org-call-for-shift-select 'forward-char))
20039 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20040 ((and (not (eq org-support-shift-select 'always))
20041 (org-at-heading-p))
20042 (let ((org-inhibit-logging
20043 (not org-treat-S-cursor-todo-selection-as-state-change))
20044 (org-inhibit-blocking
20045 (not org-treat-S-cursor-todo-selection-as-state-change)))
20046 (org-call-with-arg 'org-todo 'right)))
20047 ((or (and org-support-shift-select
20048 (not (eq org-support-shift-select 'always))
20049 (org-at-item-bullet-p))
20050 (and (not org-support-shift-select) (org-at-item-p)))
20051 (org-call-with-arg 'org-cycle-list-bullet nil))
20052 ((and (not (eq org-support-shift-select 'always))
20053 (org-at-property-p))
20054 (call-interactively 'org-property-next-allowed-value))
20055 ((org-clocktable-try-shift 'right arg))
20056 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20057 (org-support-shift-select
20058 (org-call-for-shift-select 'forward-char))
20059 (t (org-shiftselect-error))))
20061 (defun org-shiftleft (&optional arg)
20062 "Cycle the thing at point or in the current line, depending on context.
20063 Depending on context, this does one of the following:
20065 - switch a timestamp at point one day into the past
20066 - on a headline, switch to the previous TODO keyword.
20067 - on an item, switch entire list to the previous bullet type
20068 - on a property line, switch to the previous allowed value
20069 - on a clocktable definition line, move time block into the past"
20070 (interactive "P")
20071 (cond
20072 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20073 ((and org-support-shift-select (org-region-active-p))
20074 (org-call-for-shift-select 'backward-char))
20075 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20076 ((and (not (eq org-support-shift-select 'always))
20077 (org-at-heading-p))
20078 (let ((org-inhibit-logging
20079 (not org-treat-S-cursor-todo-selection-as-state-change))
20080 (org-inhibit-blocking
20081 (not org-treat-S-cursor-todo-selection-as-state-change)))
20082 (org-call-with-arg 'org-todo 'left)))
20083 ((or (and org-support-shift-select
20084 (not (eq org-support-shift-select 'always))
20085 (org-at-item-bullet-p))
20086 (and (not org-support-shift-select) (org-at-item-p)))
20087 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20088 ((and (not (eq org-support-shift-select 'always))
20089 (org-at-property-p))
20090 (call-interactively 'org-property-previous-allowed-value))
20091 ((org-clocktable-try-shift 'left arg))
20092 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20093 (org-support-shift-select
20094 (org-call-for-shift-select 'backward-char))
20095 (t (org-shiftselect-error))))
20097 (defun org-shiftcontrolright ()
20098 "Switch to next TODO set."
20099 (interactive)
20100 (cond
20101 ((and org-support-shift-select (org-region-active-p))
20102 (org-call-for-shift-select 'forward-word))
20103 ((and (not (eq org-support-shift-select 'always))
20104 (org-at-heading-p))
20105 (org-call-with-arg 'org-todo 'nextset))
20106 (org-support-shift-select
20107 (org-call-for-shift-select 'forward-word))
20108 (t (org-shiftselect-error))))
20110 (defun org-shiftcontrolleft ()
20111 "Switch to previous TODO set."
20112 (interactive)
20113 (cond
20114 ((and org-support-shift-select (org-region-active-p))
20115 (org-call-for-shift-select 'backward-word))
20116 ((and (not (eq org-support-shift-select 'always))
20117 (org-at-heading-p))
20118 (org-call-with-arg 'org-todo 'previousset))
20119 (org-support-shift-select
20120 (org-call-for-shift-select 'backward-word))
20121 (t (org-shiftselect-error))))
20123 (defun org-shiftcontrolup (&optional n)
20124 "Change timestamps synchronously up in CLOCK log lines.
20125 Optional argument N tells to change by that many units."
20126 (interactive "P")
20127 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20128 (let (org-support-shift-select)
20129 (org-clock-timestamps-up n))
20130 (user-error "Not at a clock log")))
20132 (defun org-shiftcontroldown (&optional n)
20133 "Change timestamps synchronously down in CLOCK log lines.
20134 Optional argument N tells to change by that many units."
20135 (interactive "P")
20136 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20137 (let (org-support-shift-select)
20138 (org-clock-timestamps-down n))
20139 (user-error "Not at a clock log")))
20141 (defun org-ctrl-c-ret ()
20142 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20143 (interactive)
20144 (cond
20145 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20146 (t (call-interactively 'org-insert-heading))))
20148 (defun org-find-visible ()
20149 (let ((s (point)))
20150 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20151 (get-char-property s 'invisible)))
20153 (defun org-find-invisible ()
20154 (let ((s (point)))
20155 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20156 (not (get-char-property s 'invisible))))
20159 (defun org-copy-visible (beg end)
20160 "Copy the visible parts of the region."
20161 (interactive "r")
20162 (let (snippets s)
20163 (save-excursion
20164 (save-restriction
20165 (narrow-to-region beg end)
20166 (setq s (goto-char (point-min)))
20167 (while (not (= (point) (point-max)))
20168 (goto-char (org-find-invisible))
20169 (push (buffer-substring s (point)) snippets)
20170 (setq s (goto-char (org-find-visible))))))
20171 (kill-new (apply 'concat (nreverse snippets)))))
20173 (defun org-copy-special ()
20174 "Copy region in table or copy current subtree.
20175 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20176 See the individual commands for more information."
20177 (interactive)
20178 (call-interactively
20179 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20181 (defun org-cut-special ()
20182 "Cut region in table or cut current subtree.
20183 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20184 See the individual commands for more information."
20185 (interactive)
20186 (call-interactively
20187 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20189 (defun org-paste-special (arg)
20190 "Paste rectangular region into table, or past subtree relative to level.
20191 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20192 See the individual commands for more information."
20193 (interactive "P")
20194 (if (org-at-table-p)
20195 (org-table-paste-rectangle)
20196 (org-paste-subtree arg)))
20198 (defsubst org-in-fixed-width-region-p ()
20199 "Is point in a fixed-width region?"
20200 (save-match-data
20201 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20203 (defun org-edit-special (&optional arg)
20204 "Call a special editor for the element at point.
20205 When at a table, call the formula editor with `org-table-edit-formulas'.
20206 When in a source code block, call `org-edit-src-code'.
20207 When in a fixed-width region, call `org-edit-fixed-width-region'.
20208 When at an #+INCLUDE keyword, visit the included file.
20209 On a link, call `ffap' to visit the link at point.
20210 Otherwise, return a user error."
20211 (interactive "P")
20212 (let ((element (org-element-at-point)))
20213 (assert (not buffer-read-only) nil
20214 "Buffer is read-only: %s" (buffer-name))
20215 (case (org-element-type element)
20216 (src-block
20217 (if (not arg) (org-edit-src-code)
20218 (let* ((info (org-babel-get-src-block-info))
20219 (lang (nth 0 info))
20220 (params (nth 2 info))
20221 (session (cdr (assq :session params))))
20222 (if (not session) (org-edit-src-code)
20223 ;; At a src-block with a session and function called with
20224 ;; an ARG: switch to the buffer related to the inferior
20225 ;; process.
20226 (switch-to-buffer
20227 (funcall (intern (concat "org-babel-prep-session:" lang))
20228 session params))))))
20229 (keyword
20230 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20231 (find-file
20232 (org-remove-double-quotes
20233 (car (org-split-string (org-element-property :value element)))))
20234 (user-error "No special environment to edit here")))
20235 (table
20236 (if (eq (org-element-property :type element) 'table.el)
20237 (org-edit-src-code)
20238 (call-interactively 'org-table-edit-formulas)))
20239 ;; Only Org tables contain `table-row' type elements.
20240 (table-row (call-interactively 'org-table-edit-formulas))
20241 ((example-block export-block) (org-edit-src-code))
20242 (fixed-width (org-edit-fixed-width-region))
20243 (otherwise
20244 ;; No notable element at point. Though, we may be at a link,
20245 ;; which is an object. Thus, scan deeper.
20246 (if (eq (org-element-type (org-element-context element)) 'link)
20247 (call-interactively 'ffap)
20248 (user-error "No special environment to edit here"))))))
20250 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20251 (defun org-ctrl-c-ctrl-c (&optional arg)
20252 "Set tags in headline, or update according to changed information at point.
20254 This command does many different things, depending on context:
20256 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20257 this is what we do.
20259 - If the cursor is on a statistics cookie, update it.
20261 - If the cursor is in a headline, prompt for tags and insert them
20262 into the current line, aligned to `org-tags-column'. When called
20263 with prefix arg, realign all tags in the current buffer.
20265 - If the cursor is in one of the special #+KEYWORD lines, this
20266 triggers scanning the buffer for these lines and updating the
20267 information.
20269 - If the cursor is inside a table, realign the table. This command
20270 works even if the automatic table editor has been turned off.
20272 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20273 the entire table.
20275 - If the cursor is at a footnote reference or definition, jump to
20276 the corresponding definition or references, respectively.
20278 - If the cursor is a the beginning of a dynamic block, update it.
20280 - If the current buffer is a capture buffer, close note and file it.
20282 - If the cursor is on a <<<target>>>, update radio targets and
20283 corresponding links in this buffer.
20285 - If the cursor is on a numbered item in a plain list, renumber the
20286 ordered list.
20288 - If the cursor is on a checkbox, toggle it.
20290 - If the cursor is on a code block, evaluate it. The variable
20291 `org-confirm-babel-evaluate' can be used to control prompting
20292 before code block evaluation, by default every code block
20293 evaluation requires confirmation. Code block evaluation can be
20294 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20295 (interactive "P")
20296 (cond
20297 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20298 org-occur-highlights
20299 org-latex-fragment-image-overlays)
20300 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20301 (org-remove-occur-highlights)
20302 (org-remove-latex-fragment-image-overlays)
20303 (message "Temporary highlights/overlays removed from current buffer"))
20304 ((and (local-variable-p 'org-finish-function (current-buffer))
20305 (fboundp org-finish-function))
20306 (funcall org-finish-function))
20307 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20309 (let* ((context (org-element-context)) (type (org-element-type context)))
20310 ;; Test if point is within a blank line.
20311 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20312 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20313 (user-error "C-c C-c can do nothing useful at this location"))
20314 (case type
20315 ;; When at a link, act according to the parent instead.
20316 (link (setq context (org-element-property :parent context))
20317 (setq type (org-element-type context)))
20318 ;; Unsupported object types: refer to the first supported
20319 ;; element or object containing it.
20320 ((bold code entity export-snippet inline-babel-call inline-src-block
20321 italic latex-fragment line-break macro strike-through subscript
20322 superscript underline verbatim)
20323 (while (and (setq context (org-element-property :parent context))
20324 (not (memq (setq type (org-element-type context))
20325 '(radio-target paragraph verse-block
20326 table-cell)))))))
20327 ;; For convenience: at the first line of a paragraph on the
20328 ;; same line as an item, apply function on that item instead.
20329 (when (eq type 'paragraph)
20330 (let ((parent (org-element-property :parent context)))
20331 (when (and (eq (org-element-type parent) 'item)
20332 (= (point-at-bol) (org-element-property :begin parent)))
20333 (setq context parent type 'item))))
20334 ;; Act according to type of element or object at point.
20335 (case type
20336 (clock (org-clock-update-time-maybe))
20337 (dynamic-block
20338 (save-excursion
20339 (goto-char (org-element-property :post-affiliated context))
20340 (org-update-dblock)))
20341 (footnote-definition
20342 (goto-char (org-element-property :post-affiliated context))
20343 (call-interactively 'org-footnote-action))
20344 (footnote-reference (call-interactively 'org-footnote-action))
20345 ((headline inlinetask)
20346 (save-excursion (goto-char (org-element-property :begin context))
20347 (call-interactively 'org-set-tags)))
20348 (item
20349 ;; At an item: a double C-u set checkbox to "[-]"
20350 ;; unconditionally, whereas a single one will toggle its
20351 ;; presence. Without an universal argument, if the item
20352 ;; has a checkbox, toggle it. Otherwise repair the list.
20353 (let* ((box (org-element-property :checkbox context))
20354 (struct (org-element-property :structure context))
20355 (old-struct (copy-tree struct))
20356 (parents (org-list-parents-alist struct))
20357 (prevs (org-list-prevs-alist struct))
20358 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20359 (org-list-set-checkbox
20360 (org-element-property :begin context) struct
20361 (cond ((equal arg '(16)) "[-]")
20362 ((and (not box) (equal arg '(4))) "[ ]")
20363 ((or (not box) (equal arg '(4))) nil)
20364 ((eq box 'on) "[ ]")
20365 (t "[X]")))
20366 ;; Mimic `org-list-write-struct' but with grabbing
20367 ;; a return value from `org-list-struct-fix-box'.
20368 (org-list-struct-fix-ind struct parents 2)
20369 (org-list-struct-fix-item-end struct)
20370 (org-list-struct-fix-bul struct prevs)
20371 (org-list-struct-fix-ind struct parents)
20372 (let ((block-item
20373 (org-list-struct-fix-box struct parents prevs orderedp)))
20374 (if (and box (equal struct old-struct))
20375 (if (equal arg '(16))
20376 (message "Checkboxes already reset")
20377 (user-error "Cannot toggle this checkbox: %s"
20378 (if (eq box 'on)
20379 "all subitems checked"
20380 "unchecked subitems")))
20381 (org-list-struct-apply-struct struct old-struct)
20382 (org-update-checkbox-count-maybe))
20383 (when block-item
20384 (message "Checkboxes were removed due to empty box at line %d"
20385 (org-current-line block-item))))))
20386 (keyword
20387 (let ((org-inhibit-startup-visibility-stuff t)
20388 (org-startup-align-all-tables nil))
20389 (when (boundp 'org-table-coordinate-overlays)
20390 (mapc 'delete-overlay org-table-coordinate-overlays)
20391 (setq org-table-coordinate-overlays nil))
20392 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20393 (message "Local setup has been refreshed"))
20394 (plain-list
20395 ;; At a plain list, with a double C-u argument, set
20396 ;; checkboxes of each item to "[-]", whereas a single one
20397 ;; will toggle their presence according to the state of the
20398 ;; first item in the list. Without an argument, repair the
20399 ;; list.
20400 (let* ((begin (org-element-property :contents-begin context))
20401 (beginm (move-marker (make-marker) begin))
20402 (struct (org-element-property :structure context))
20403 (old-struct (copy-tree struct))
20404 (first-box (save-excursion
20405 (goto-char begin)
20406 (looking-at org-list-full-item-re)
20407 (match-string-no-properties 3)))
20408 (new-box (cond ((equal arg '(16)) "[-]")
20409 ((equal arg '(4)) (unless first-box "[ ]"))
20410 ((equal first-box "[X]") "[ ]")
20411 (t "[X]"))))
20412 (cond
20413 (arg
20414 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20415 (org-list-get-all-items
20416 begin struct (org-list-prevs-alist struct))))
20417 ((and first-box (eq (point) begin))
20418 ;; For convenience, when point is at bol on the first
20419 ;; item of the list and no argument is provided, simply
20420 ;; toggle checkbox of that item, if any.
20421 (org-list-set-checkbox begin struct new-box)))
20422 (org-list-write-struct
20423 struct (org-list-parents-alist struct) old-struct)
20424 (org-update-checkbox-count-maybe)
20425 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20426 ((property-drawer node-property)
20427 (call-interactively 'org-property-action))
20428 ((radio-target target)
20429 (call-interactively 'org-update-radio-target-regexp))
20430 (statistics-cookie
20431 (call-interactively 'org-update-statistics-cookies))
20432 ((table table-cell table-row)
20433 ;; At a table, recalculate every field and align it. Also
20434 ;; send the table if necessary. If the table has
20435 ;; a `table.el' type, just give up. At a table row or
20436 ;; cell, maybe recalculate line but always align table.
20437 (if (eq (org-element-property :type context) 'table.el)
20438 (message "Use C-c ' to edit table.el tables")
20439 (let ((org-enable-table-editor t))
20440 (if (or (eq type 'table)
20441 ;; Check if point is at a TBLFM line.
20442 (and (eq type 'table-row)
20443 (= (point) (org-element-property :end context))))
20444 (save-excursion
20445 (if (org-at-TBLFM-p)
20446 (progn (require 'org-table)
20447 (org-table-calc-current-TBLFM))
20448 (goto-char (org-element-property :contents-begin context))
20449 (org-call-with-arg 'org-table-recalculate (or arg t))
20450 (orgtbl-send-table 'maybe)))
20451 (org-table-maybe-eval-formula)
20452 (cond (arg (call-interactively 'org-table-recalculate))
20453 ((org-table-maybe-recalculate-line))
20454 (t (org-table-align)))))))
20455 (timestamp (org-timestamp-change 0 'day))
20456 (otherwise
20457 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20458 (user-error
20459 "C-c C-c can do nothing useful at this location")))))))))
20461 (defun org-mode-restart ()
20462 (interactive)
20463 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20464 (funcall major-mode)
20465 (hack-local-variables)
20466 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20467 (org-indent-mode -1)))
20468 (message "%s restarted" major-mode))
20470 (defun org-kill-note-or-show-branches ()
20471 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20472 (interactive)
20473 (if (not org-finish-function)
20474 (progn
20475 (hide-subtree)
20476 (call-interactively 'show-branches))
20477 (let ((org-note-abort t))
20478 (funcall org-finish-function))))
20480 (defun org-open-line (n)
20481 "Insert a new row in tables, call `open-line' elsewhere.
20482 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20483 (interactive "*p")
20484 (cond
20485 ((not org-special-ctrl-o)
20486 (open-line n))
20487 ((org-at-table-p)
20488 (org-table-insert-row))
20490 (open-line n))))
20492 (defun org-return (&optional indent)
20493 "Goto next table row or insert a newline.
20494 Calls `org-table-next-row' or `newline', depending on context.
20495 See the individual commands for more information."
20496 (interactive)
20497 (let (org-ts-what)
20498 (cond
20499 ((or (bobp) (org-in-src-block-p))
20500 (if indent (newline-and-indent) (newline)))
20501 ((org-at-table-p)
20502 (org-table-justify-field-maybe)
20503 (call-interactively 'org-table-next-row))
20504 ;; when `newline-and-indent' is called within a list, make sure
20505 ;; text moved stays inside the item.
20506 ((and (org-in-item-p) indent)
20507 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20508 (progn
20509 (save-match-data (newline))
20510 (org-indent-line-to (length (match-string 0))))
20511 (let ((ind (org-get-indentation)))
20512 (newline)
20513 (if (org-looking-back org-list-end-re)
20514 (org-indent-line)
20515 (org-indent-line-to ind)))))
20516 ((and org-return-follows-link
20517 (org-at-timestamp-p t)
20518 (not (eq org-ts-what 'after)))
20519 (org-follow-timestamp-link))
20520 ((and org-return-follows-link
20521 (let ((tprop (get-text-property (point) 'face)))
20522 (or (eq tprop 'org-link)
20523 (and (listp tprop) (memq 'org-link tprop)))))
20524 (call-interactively 'org-open-at-point))
20525 ((and (org-at-heading-p)
20526 (looking-at
20527 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20528 (org-show-entry)
20529 (end-of-line 1)
20530 (newline))
20531 (t (if indent (newline-and-indent) (newline))))))
20533 (defun org-return-indent ()
20534 "Goto next table row or insert a newline and indent.
20535 Calls `org-table-next-row' or `newline-and-indent', depending on
20536 context. See the individual commands for more information."
20537 (interactive)
20538 (org-return t))
20540 (defun org-ctrl-c-star ()
20541 "Compute table, or change heading status of lines.
20542 Calls `org-table-recalculate' or `org-toggle-heading',
20543 depending on context."
20544 (interactive)
20545 (cond
20546 ((org-at-table-p)
20547 (call-interactively 'org-table-recalculate))
20549 ;; Convert all lines in region to list items
20550 (call-interactively 'org-toggle-heading))))
20552 (defun org-ctrl-c-minus ()
20553 "Insert separator line in table or modify bullet status of line.
20554 Also turns a plain line or a region of lines into list items.
20555 Calls `org-table-insert-hline', `org-toggle-item', or
20556 `org-cycle-list-bullet', depending on context."
20557 (interactive)
20558 (cond
20559 ((org-at-table-p)
20560 (call-interactively 'org-table-insert-hline))
20561 ((org-region-active-p)
20562 (call-interactively 'org-toggle-item))
20563 ((org-in-item-p)
20564 (call-interactively 'org-cycle-list-bullet))
20566 (call-interactively 'org-toggle-item))))
20568 (defun org-toggle-item (arg)
20569 "Convert headings or normal lines to items, items to normal lines.
20570 If there is no active region, only the current line is considered.
20572 If the first non blank line in the region is a headline, convert
20573 all headlines to items, shifting text accordingly.
20575 If it is an item, convert all items to normal lines.
20577 If it is normal text, change region into a list of items.
20578 With a prefix argument ARG, change the region in a single item."
20579 (interactive "P")
20580 (let ((shift-text
20581 (function
20582 ;; Shift text in current section to IND, from point to END.
20583 ;; The function leaves point to END line.
20584 (lambda (ind end)
20585 (let ((min-i 1000) (end (copy-marker end)))
20586 ;; First determine the minimum indentation (MIN-I) of
20587 ;; the text.
20588 (save-excursion
20589 (catch 'exit
20590 (while (< (point) end)
20591 (let ((i (org-get-indentation)))
20592 (cond
20593 ;; Skip blank lines and inline tasks.
20594 ((looking-at "^[ \t]*$"))
20595 ((looking-at org-outline-regexp-bol))
20596 ;; We can't find less than 0 indentation.
20597 ((zerop i) (throw 'exit (setq min-i 0)))
20598 ((< i min-i) (setq min-i i))))
20599 (forward-line))))
20600 ;; Then indent each line so that a line indented to
20601 ;; MIN-I becomes indented to IND. Ignore blank lines
20602 ;; and inline tasks in the process.
20603 (let ((delta (- ind min-i)))
20604 (while (< (point) end)
20605 (unless (or (looking-at "^[ \t]*$")
20606 (looking-at org-outline-regexp-bol))
20607 (org-indent-line-to (+ (org-get-indentation) delta)))
20608 (forward-line)))))))
20609 (skip-blanks
20610 (function
20611 ;; Return beginning of first non-blank line, starting from
20612 ;; line at POS.
20613 (lambda (pos)
20614 (save-excursion
20615 (goto-char pos)
20616 (skip-chars-forward " \r\t\n")
20617 (point-at-bol)))))
20618 beg end)
20619 ;; Determine boundaries of changes.
20620 (if (org-region-active-p)
20621 (setq beg (funcall skip-blanks (region-beginning))
20622 end (copy-marker (region-end)))
20623 (setq beg (funcall skip-blanks (point-at-bol))
20624 end (copy-marker (point-at-eol))))
20625 ;; Depending on the starting line, choose an action on the text
20626 ;; between BEG and END.
20627 (org-with-limited-levels
20628 (save-excursion
20629 (goto-char beg)
20630 (cond
20631 ;; Case 1. Start at an item: de-itemize. Note that it only
20632 ;; happens when a region is active: `org-ctrl-c-minus'
20633 ;; would call `org-cycle-list-bullet' otherwise.
20634 ((org-at-item-p)
20635 (while (< (point) end)
20636 (when (org-at-item-p)
20637 (skip-chars-forward " \t")
20638 (delete-region (point) (match-end 0)))
20639 (forward-line)))
20640 ;; Case 2. Start at an heading: convert to items.
20641 ((org-at-heading-p)
20642 (let* ((bul (org-list-bullet-string "-"))
20643 (bul-len (length bul))
20644 ;; Indentation of the first heading. It should be
20645 ;; relative to the indentation of its parent, if any.
20646 (start-ind (save-excursion
20647 (cond
20648 ((not org-adapt-indentation) 0)
20649 ((not (outline-previous-heading)) 0)
20650 (t (length (match-string 0))))))
20651 ;; Level of first heading. Further headings will be
20652 ;; compared to it to determine hierarchy in the list.
20653 (ref-level (org-reduced-level (org-outline-level))))
20654 (while (< (point) end)
20655 (let* ((level (org-reduced-level (org-outline-level)))
20656 (delta (max 0 (- level ref-level))))
20657 ;; If current headline is less indented than the first
20658 ;; one, set it as reference, in order to preserve
20659 ;; subtrees.
20660 (when (< level ref-level) (setq ref-level level))
20661 (replace-match bul t t)
20662 (org-indent-line-to (+ start-ind (* delta bul-len)))
20663 ;; Ensure all text down to END (or SECTION-END) belongs
20664 ;; to the newly created item.
20665 (let ((section-end (save-excursion
20666 (or (outline-next-heading) (point)))))
20667 (forward-line)
20668 (funcall shift-text
20669 (+ start-ind (* (1+ delta) bul-len))
20670 (min end section-end)))))))
20671 ;; Case 3. Normal line with ARG: make the first line of region
20672 ;; an item, and shift indentation of others lines to
20673 ;; set them as item's body.
20674 (arg (let* ((bul (org-list-bullet-string "-"))
20675 (bul-len (length bul))
20676 (ref-ind (org-get-indentation)))
20677 (skip-chars-forward " \t")
20678 (insert bul)
20679 (forward-line)
20680 (while (< (point) end)
20681 ;; Ensure that lines less indented than first one
20682 ;; still get included in item body.
20683 (funcall shift-text
20684 (+ ref-ind bul-len)
20685 (min end (save-excursion (or (outline-next-heading)
20686 (point)))))
20687 (forward-line))))
20688 ;; Case 4. Normal line without ARG: turn each non-item line
20689 ;; into an item.
20691 (while (< (point) end)
20692 (unless (or (org-at-heading-p) (org-at-item-p))
20693 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20694 (replace-match
20695 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20696 (forward-line))))))))
20698 (defun org-toggle-heading (&optional nstars)
20699 "Convert headings to normal text, or items or text to headings.
20700 If there is no active region, only convert the current line.
20702 With a \\[universal-argument] prefix, convert the whole list at
20703 point into heading.
20705 In a region:
20707 - If the first non blank line is a headline, remove the stars
20708 from all headlines in the region.
20710 - If it is a normal line, turn each and every normal line (i.e.,
20711 not an heading or an item) in the region into headings. If you
20712 want to convert only the first line of this region, use one
20713 universal prefix argument.
20715 - If it is a plain list item, turn all plain list items into headings.
20717 When converting a line into a heading, the number of stars is chosen
20718 such that the lines become children of the current entry. However,
20719 when a numeric prefix argument is given, its value determines the
20720 number of stars to add."
20721 (interactive "P")
20722 (let ((skip-blanks
20723 (function
20724 ;; Return beginning of first non-blank line, starting from
20725 ;; line at POS.
20726 (lambda (pos)
20727 (save-excursion
20728 (goto-char pos)
20729 (while (org-at-comment-p) (forward-line))
20730 (skip-chars-forward " \r\t\n")
20731 (point-at-bol)))))
20732 beg end toggled)
20733 ;; Determine boundaries of changes. If a universal prefix has
20734 ;; been given, put the list in a region. If region ends at a bol,
20735 ;; do not consider the last line to be in the region.
20737 (when (and current-prefix-arg (org-at-item-p))
20738 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20739 (org-mark-element))
20741 (if (org-region-active-p)
20742 (setq beg (funcall skip-blanks (region-beginning))
20743 end (copy-marker (save-excursion
20744 (goto-char (region-end))
20745 (if (bolp) (point) (point-at-eol)))))
20746 (setq beg (funcall skip-blanks (point-at-bol))
20747 end (copy-marker (point-at-eol))))
20748 ;; Ensure inline tasks don't count as headings.
20749 (org-with-limited-levels
20750 (save-excursion
20751 (goto-char beg)
20752 (cond
20753 ;; Case 1. Started at an heading: de-star headings.
20754 ((org-at-heading-p)
20755 (while (< (point) end)
20756 (when (org-at-heading-p t)
20757 (looking-at org-outline-regexp) (replace-match "")
20758 (setq toggled t))
20759 (forward-line)))
20760 ;; Case 2. Started at an item: change items into headlines.
20761 ;; One star will be added by `org-list-to-subtree'.
20762 ((org-at-item-p)
20763 (let* ((stars (make-string
20764 ;; subtract the star that will be added again by
20765 ;; `org-list-to-subtree'
20766 (if (numberp nstars) (1- nstars)
20767 (or (org-current-level) 0))
20768 ?*))
20769 (add-stars
20770 (cond (nstars "") ; stars from prefix only
20771 ((equal stars "") "") ; before first heading
20772 (org-odd-levels-only "*") ; inside heading, odd
20773 (t "")))) ; inside heading, oddeven
20774 (while (< (point) end)
20775 (when (org-at-item-p)
20776 ;; Pay attention to cases when region ends before list.
20777 (let* ((struct (org-list-struct))
20778 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20779 (save-restriction
20780 (narrow-to-region (point) list-end)
20781 (insert
20782 (org-list-to-subtree
20783 (org-list-parse-list t)
20784 '(:istart (concat stars add-stars (funcall get-stars depth))
20785 :icount (concat stars add-stars (funcall get-stars depth)))))))
20786 (setq toggled t))
20787 (forward-line))))
20788 ;; Case 3. Started at normal text: make every line an heading,
20789 ;; skipping headlines and items.
20790 (t (let* ((stars
20791 (make-string
20792 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20793 (add-stars
20794 (cond (nstars "") ; stars from prefix only
20795 ((equal stars "") "*") ; before first heading
20796 (org-odd-levels-only "**") ; inside heading, odd
20797 (t "*"))) ; inside heading, oddeven
20798 (rpl (concat stars add-stars " "))
20799 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20800 (while (< (point) (if (equal nstars '(4)) lend end))
20801 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20802 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20803 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20804 (forward-line)))))))
20805 (unless toggled (message "Cannot toggle heading from here"))))
20807 (defun org-meta-return (&optional arg)
20808 "Insert a new heading or wrap a region in a table.
20809 Calls `org-insert-heading' or `org-table-wrap-region', depending
20810 on context. See the individual commands for more information."
20811 (interactive "P")
20812 (org-check-before-invisible-edit 'insert)
20813 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20814 (let* ((element (org-element-at-point))
20815 (type (org-element-type element)))
20816 (when (eq type 'table-row)
20817 (setq element (org-element-property :parent element))
20818 (setq type 'table))
20819 (if (and (eq type 'table)
20820 (eq (org-element-property :type element) 'org)
20821 (>= (point) (org-element-property :contents-begin element))
20822 (< (point) (org-element-property :contents-end element)))
20823 (call-interactively 'org-table-wrap-region)
20824 (call-interactively 'org-insert-heading)))))
20826 ;;; Menu entries
20828 (defsubst org-in-subtree-not-table-p ()
20829 "Are we in a subtree and not in a table?"
20830 (and (not (org-before-first-heading-p))
20831 (not (org-at-table-p))))
20833 ;; Define the Org-mode menus
20834 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20835 '("Tbl"
20836 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20837 ["Next Field" org-cycle (org-at-table-p)]
20838 ["Previous Field" org-shifttab (org-at-table-p)]
20839 ["Next Row" org-return (org-at-table-p)]
20840 "--"
20841 ["Blank Field" org-table-blank-field (org-at-table-p)]
20842 ["Edit Field" org-table-edit-field (org-at-table-p)]
20843 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20844 "--"
20845 ("Column"
20846 ["Move Column Left" org-metaleft (org-at-table-p)]
20847 ["Move Column Right" org-metaright (org-at-table-p)]
20848 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20849 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20850 ("Row"
20851 ["Move Row Up" org-metaup (org-at-table-p)]
20852 ["Move Row Down" org-metadown (org-at-table-p)]
20853 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20854 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20855 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20856 "--"
20857 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20858 ("Rectangle"
20859 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20860 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20861 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20862 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20863 "--"
20864 ("Calculate"
20865 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20866 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20867 ["Edit Formulas" org-edit-special (org-at-table-p)]
20868 "--"
20869 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20870 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20871 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20872 "--"
20873 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20874 "--"
20875 ["Sum Column/Rectangle" org-table-sum
20876 (or (org-at-table-p) (org-region-active-p))]
20877 ["Which Column?" org-table-current-column (org-at-table-p)])
20878 ["Debug Formulas"
20879 org-table-toggle-formula-debugger
20880 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20881 ["Show Col/Row Numbers"
20882 org-table-toggle-coordinate-overlays
20883 :style toggle
20884 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20885 "--"
20886 ["Create" org-table-create (and (not (org-at-table-p))
20887 org-enable-table-editor)]
20888 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20889 ["Import from File" org-table-import (not (org-at-table-p))]
20890 ["Export to File" org-table-export (org-at-table-p)]
20891 "--"
20892 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20894 (easy-menu-define org-org-menu org-mode-map "Org menu"
20895 '("Org"
20896 ("Show/Hide"
20897 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20898 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20899 ["Sparse Tree..." org-sparse-tree t]
20900 ["Reveal Context" org-reveal t]
20901 ["Show All" show-all t]
20902 "--"
20903 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20904 "--"
20905 ["New Heading" org-insert-heading t]
20906 ("Navigate Headings"
20907 ["Up" outline-up-heading t]
20908 ["Next" outline-next-visible-heading t]
20909 ["Previous" outline-previous-visible-heading t]
20910 ["Next Same Level" outline-forward-same-level t]
20911 ["Previous Same Level" outline-backward-same-level t]
20912 "--"
20913 ["Jump" org-goto t])
20914 ("Edit Structure"
20915 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20916 "--"
20917 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20918 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20919 "--"
20920 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20921 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20922 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20923 "--"
20924 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20925 "--"
20926 ["Copy visible text" org-copy-visible t]
20927 "--"
20928 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20929 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20930 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20931 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20932 "--"
20933 ["Sort Region/Children" org-sort t]
20934 "--"
20935 ["Convert to odd levels" org-convert-to-odd-levels t]
20936 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20937 ("Editing"
20938 ["Emphasis..." org-emphasize t]
20939 ["Edit Source Example" org-edit-special t]
20940 "--"
20941 ["Footnote new/jump" org-footnote-action t]
20942 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20943 ("Archive"
20944 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20945 "--"
20946 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20947 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20948 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20950 "--"
20951 ("Hyperlinks"
20952 ["Store Link (Global)" org-store-link t]
20953 ["Find existing link to here" org-occur-link-in-agenda-files t]
20954 ["Insert Link" org-insert-link t]
20955 ["Follow Link" org-open-at-point t]
20956 "--"
20957 ["Next link" org-next-link t]
20958 ["Previous link" org-previous-link t]
20959 "--"
20960 ["Descriptive Links"
20961 org-toggle-link-display
20962 :style radio
20963 :selected org-descriptive-links
20965 ["Literal Links"
20966 org-toggle-link-display
20967 :style radio
20968 :selected (not org-descriptive-links)])
20969 "--"
20970 ("TODO Lists"
20971 ["TODO/DONE/-" org-todo t]
20972 ("Select keyword"
20973 ["Next keyword" org-shiftright (org-at-heading-p)]
20974 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20975 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20976 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20977 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20978 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20979 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20980 "--"
20981 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20982 :selected org-enforce-todo-dependencies :style toggle :active t]
20983 "Settings for tree at point"
20984 ["Do Children sequentially" org-toggle-ordered-property :style radio
20985 :selected (org-entry-get nil "ORDERED")
20986 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20987 ["Do Children parallel" org-toggle-ordered-property :style radio
20988 :selected (not (org-entry-get nil "ORDERED"))
20989 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20990 "--"
20991 ["Set Priority" org-priority t]
20992 ["Priority Up" org-shiftup t]
20993 ["Priority Down" org-shiftdown t]
20994 "--"
20995 ["Get news from all feeds" org-feed-update-all t]
20996 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20997 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20998 ("TAGS and Properties"
20999 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21000 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21001 "--"
21002 ["Set property" org-set-property (not (org-before-first-heading-p))]
21003 ["Column view of properties" org-columns t]
21004 ["Insert Column View DBlock" org-insert-columns-dblock t])
21005 ("Dates and Scheduling"
21006 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21007 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21008 ("Change Date"
21009 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21010 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21011 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21012 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21013 ["Compute Time Range" org-evaluate-time-range t]
21014 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21015 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21016 "--"
21017 ["Custom time format" org-toggle-time-stamp-overlays
21018 :style radio :selected org-display-custom-times]
21019 "--"
21020 ["Goto Calendar" org-goto-calendar t]
21021 ["Date from Calendar" org-date-from-calendar t]
21022 "--"
21023 ["Start/Restart Timer" org-timer-start t]
21024 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21025 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21026 ["Insert Timer String" org-timer t]
21027 ["Insert Timer Item" org-timer-item t])
21028 ("Logging work"
21029 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21030 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21031 ["Clock out" org-clock-out t]
21032 ["Clock cancel" org-clock-cancel t]
21033 "--"
21034 ["Mark as default task" org-clock-mark-default-task t]
21035 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21036 ["Goto running clock" org-clock-goto t]
21037 "--"
21038 ["Display times" org-clock-display t]
21039 ["Create clock table" org-clock-report t]
21040 "--"
21041 ["Record DONE time"
21042 (progn (setq org-log-done (not org-log-done))
21043 (message "Switching to %s will %s record a timestamp"
21044 (car org-done-keywords)
21045 (if org-log-done "automatically" "not")))
21046 :style toggle :selected org-log-done])
21047 "--"
21048 ["Agenda Command..." org-agenda t]
21049 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21050 ("File List for Agenda")
21051 ("Special views current file"
21052 ["TODO Tree" org-show-todo-tree t]
21053 ["Check Deadlines" org-check-deadlines t]
21054 ["Timeline" org-timeline t]
21055 ["Tags/Property tree" org-match-sparse-tree t])
21056 "--"
21057 ["Export/Publish..." org-export-dispatch t]
21058 ("LaTeX"
21059 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21060 :selected org-cdlatex-mode]
21061 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21062 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21063 ["Modify math symbol" org-cdlatex-math-modify
21064 (org-inside-LaTeX-fragment-p)]
21065 ["Insert citation" org-reftex-citation t]
21066 "--"
21067 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21068 "--"
21069 ("MobileOrg"
21070 ["Push Files and Views" org-mobile-push t]
21071 ["Get Captured and Flagged" org-mobile-pull t]
21072 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21073 "--"
21074 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21075 "--"
21076 ("Documentation"
21077 ["Show Version" org-version t]
21078 ["Info Documentation" org-info t])
21079 ("Customize"
21080 ["Browse Org Group" org-customize t]
21081 "--"
21082 ["Expand This Menu" org-create-customize-menu
21083 (fboundp 'customize-menu-create)])
21084 ["Send bug report" org-submit-bug-report t]
21085 "--"
21086 ("Refresh/Reload"
21087 ["Refresh setup current buffer" org-mode-restart t]
21088 ["Reload Org (after update)" org-reload t]
21089 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21092 (defun org-info (&optional node)
21093 "Read documentation for Org-mode in the info system.
21094 With optional NODE, go directly to that node."
21095 (interactive)
21096 (info (format "(org)%s" (or node ""))))
21098 ;;;###autoload
21099 (defun org-submit-bug-report ()
21100 "Submit a bug report on Org-mode via mail.
21102 Don't hesitate to report any problems or inaccurate documentation.
21104 If you don't have setup sending mail from (X)Emacs, please copy the
21105 output buffer into your mail program, as it gives us important
21106 information about your Org-mode version and configuration."
21107 (interactive)
21108 (require 'reporter)
21109 (org-load-modules-maybe)
21110 (org-require-autoloaded-modules)
21111 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21112 (reporter-submit-bug-report
21113 "emacs-orgmode@gnu.org"
21114 (org-version nil 'full)
21115 (let (list)
21116 (save-window-excursion
21117 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21118 (delete-other-windows)
21119 (erase-buffer)
21120 (insert "You are about to submit a bug report to the Org-mode mailing list.
21122 We would like to add your full Org-mode and Outline configuration to the
21123 bug report. This greatly simplifies the work of the maintainer and
21124 other experts on the mailing list.
21126 HOWEVER, some variables you have customized may contain private
21127 information. The names of customers, colleagues, or friends, might
21128 appear in the form of file names, tags, todo states, or search strings.
21129 If you answer yes to the prompt, you might want to check and remove
21130 such private information before sending the email.")
21131 (add-text-properties (point-min) (point-max) '(face org-warning))
21132 (when (yes-or-no-p "Include your Org-mode configuration ")
21133 (mapatoms
21134 (lambda (v)
21135 (and (boundp v)
21136 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21137 (or (and (symbol-value v)
21138 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21139 (and
21140 (get v 'custom-type) (get v 'standard-value)
21141 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21142 (push v list)))))
21143 (kill-buffer (get-buffer "*Warn about privacy*"))
21144 list))
21145 nil nil
21146 "Remember to cover the basics, that is, what you expected to happen and
21147 what in fact did happen. You don't know how to make a good report? See
21149 http://orgmode.org/manual/Feedback.html#Feedback
21151 Your bug report will be posted to the Org-mode mailing list.
21152 ------------------------------------------------------------------------")
21153 (save-excursion
21154 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21155 (replace-match "\\1Bug: \\3 [\\2]")))))
21158 (defun org-install-agenda-files-menu ()
21159 (let ((bl (buffer-list)))
21160 (save-excursion
21161 (while bl
21162 (set-buffer (pop bl))
21163 (if (derived-mode-p 'org-mode) (setq bl nil)))
21164 (when (derived-mode-p 'org-mode)
21165 (easy-menu-change
21166 '("Org") "File List for Agenda"
21167 (append
21168 (list
21169 ["Edit File List" (org-edit-agenda-file-list) t]
21170 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21171 ["Remove Current File from List" org-remove-file t]
21172 ["Cycle through agenda files" org-cycle-agenda-files t]
21173 ["Occur in all agenda files" org-occur-in-agenda-files t]
21174 "--")
21175 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21177 ;;;; Documentation
21179 (defun org-require-autoloaded-modules ()
21180 (interactive)
21181 (mapc 'require
21182 '(org-agenda org-archive org-attach org-clock org-colview org-id
21183 org-table org-timer)))
21185 ;;;###autoload
21186 (defun org-reload (&optional uncompiled)
21187 "Reload all org lisp files.
21188 With prefix arg UNCOMPILED, load the uncompiled versions."
21189 (interactive "P")
21190 (require 'loadhist)
21191 (let* ((org-dir (org-find-library-dir "org"))
21192 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21193 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21194 (remove-re (mapconcat 'identity
21195 (mapcar (lambda (f) (concat "^" f "$"))
21196 (list (if (featurep 'xemacs)
21197 "org-colview"
21198 "org-colview-xemacs")
21199 "org" "org-loaddefs" "org-version"))
21200 "\\|"))
21201 (feats (delete-dups
21202 (mapcar 'file-name-sans-extension
21203 (mapcar 'file-name-nondirectory
21204 (delq nil
21205 (mapcar 'feature-file
21206 features))))))
21207 (lfeat (append
21208 (sort
21209 (setq feats
21210 (delq nil (mapcar
21211 (lambda (f)
21212 (if (and (string-match feature-re f)
21213 (not (string-match remove-re f)))
21214 f nil))
21215 feats)))
21216 'string-lessp)
21217 (list "org-version" "org")))
21218 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21219 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21220 load-uncore load-misses)
21221 (setq load-misses
21222 (delq 't
21223 (mapcar (lambda (f)
21224 (or (org-load-noerror-mustsuffix (concat org-dir f))
21225 (and (string= org-dir contrib-dir)
21226 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21227 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21228 (add-to-list 'load-uncore f 'append)
21231 lfeat)))
21232 (if load-uncore
21233 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21234 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21235 (if load-misses
21236 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21237 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21238 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21240 ;;;###autoload
21241 (defun org-customize ()
21242 "Call the customize function with org as argument."
21243 (interactive)
21244 (org-load-modules-maybe)
21245 (org-require-autoloaded-modules)
21246 (customize-browse 'org))
21248 (defun org-create-customize-menu ()
21249 "Create a full customization menu for Org-mode, insert it into the menu."
21250 (interactive)
21251 (org-load-modules-maybe)
21252 (org-require-autoloaded-modules)
21253 (if (fboundp 'customize-menu-create)
21254 (progn
21255 (easy-menu-change
21256 '("Org") "Customize"
21257 `(["Browse Org group" org-customize t]
21258 "--"
21259 ,(customize-menu-create 'org)
21260 ["Set" Custom-set t]
21261 ["Save" Custom-save t]
21262 ["Reset to Current" Custom-reset-current t]
21263 ["Reset to Saved" Custom-reset-saved t]
21264 ["Reset to Standard Settings" Custom-reset-standard t]))
21265 (message "\"Org\"-menu now contains full customization menu"))
21266 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21268 ;;;; Miscellaneous stuff
21270 ;;; Generally useful functions
21272 (defun org-get-at-bol (property)
21273 "Get text property PROPERTY at beginning of line."
21274 (get-text-property (point-at-bol) property))
21276 (defun org-find-text-property-in-string (prop s)
21277 "Return the first non-nil value of property PROP in string S."
21278 (or (get-text-property 0 prop s)
21279 (get-text-property (or (next-single-property-change 0 prop s) 0)
21280 prop s)))
21282 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21283 "Display the given MESSAGE as a warning."
21284 (if (fboundp 'display-warning)
21285 (display-warning 'org message
21286 (if (featurep 'xemacs) 'warning :warning))
21287 (let ((buf (get-buffer-create "*Org warnings*")))
21288 (with-current-buffer buf
21289 (goto-char (point-max))
21290 (insert "Warning (Org): " message)
21291 (unless (bolp)
21292 (newline)))
21293 (display-buffer buf)
21294 (sit-for 0))))
21296 (defun org-eval (form)
21297 "Eval FORM and return result."
21298 (condition-case error
21299 (eval form)
21300 (error (format "%%![Error: %s]" error))))
21302 (defun org-in-clocktable-p ()
21303 "Check if the cursor is in a clocktable."
21304 (let ((pos (point)) start)
21305 (save-excursion
21306 (end-of-line 1)
21307 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21308 (setq start (match-beginning 0))
21309 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21310 (>= (match-end 0) pos)
21311 start))))
21313 (defun org-in-commented-line ()
21314 "Is point in a line starting with `#'?"
21315 (equal (char-after (point-at-bol)) ?#))
21317 (defun org-in-indented-comment-line ()
21318 "Is point in a line starting with `#' after some white space?"
21319 (save-excursion
21320 (save-match-data
21321 (goto-char (point-at-bol))
21322 (looking-at "[ \t]*#"))))
21324 (defun org-in-verbatim-emphasis ()
21325 (save-match-data
21326 (and (org-in-regexp org-emph-re 2)
21327 (>= (point) (match-beginning 3))
21328 (<= (point) (match-end 4))
21329 (member (match-string 3) '("=" "~")))))
21331 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21332 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21333 (if (and marker (marker-buffer marker)
21334 (buffer-live-p (marker-buffer marker)))
21335 (progn
21336 (org-pop-to-buffer-same-window (marker-buffer marker))
21337 (if (or (> marker (point-max)) (< marker (point-min)))
21338 (widen))
21339 (goto-char marker)
21340 (org-show-context 'org-goto))
21341 (if bookmark
21342 (bookmark-jump bookmark)
21343 (error "Cannot find location"))))
21345 (defun org-quote-csv-field (s)
21346 "Quote field for inclusion in CSV material."
21347 (if (string-match "[\",]" s)
21348 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21351 (defun org-force-self-insert (N)
21352 "Needed to enforce self-insert under remapping."
21353 (interactive "p")
21354 (self-insert-command N))
21356 (defun org-string-width (s)
21357 "Compute width of string, ignoring invisible characters.
21358 This ignores character with invisibility property `org-link', and also
21359 characters with property `org-cwidth', because these will become invisible
21360 upon the next fontification round."
21361 (let (b l)
21362 (when (or (eq t buffer-invisibility-spec)
21363 (assq 'org-link buffer-invisibility-spec))
21364 (while (setq b (text-property-any 0 (length s)
21365 'invisible 'org-link s))
21366 (setq s (concat (substring s 0 b)
21367 (substring s (or (next-single-property-change
21368 b 'invisible s) (length s)))))))
21369 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21370 (setq s (concat (substring s 0 b)
21371 (substring s (or (next-single-property-change
21372 b 'org-cwidth s) (length s))))))
21373 (setq l (string-width s) b -1)
21374 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21375 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21378 (defun org-shorten-string (s maxlength)
21379 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21380 If the string is shorter or has length MAXLENGTH, just return the
21381 original string. If it is longer, the functions finds a space in the
21382 string, breaks this string off at that locations and adds three dots
21383 as ellipsis. Including the ellipsis, the string will not be longer
21384 than MAXLENGTH. If finding a good breaking point in the string does
21385 not work, the string is just chopped off in the middle of a word
21386 if necessary."
21387 (if (<= (length s) maxlength)
21389 (let* ((n (max (- maxlength 4) 1))
21390 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21391 (if (string-match re s)
21392 (concat (match-string 1 s) "...")
21393 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21395 (defun org-get-indentation (&optional line)
21396 "Get the indentation of the current line, interpreting tabs.
21397 When LINE is given, assume it represents a line and compute its indentation."
21398 (if line
21399 (if (string-match "^ *" (org-remove-tabs line))
21400 (match-end 0))
21401 (save-excursion
21402 (beginning-of-line 1)
21403 (skip-chars-forward " \t")
21404 (current-column))))
21406 (defun org-get-string-indentation (s)
21407 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21408 (let ((n -1) (i 0) (w tab-width) c)
21409 (catch 'exit
21410 (while (< (setq n (1+ n)) (length s))
21411 (setq c (aref s n))
21412 (cond ((= c ?\ ) (setq i (1+ i)))
21413 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21414 (t (throw 'exit t)))))
21417 (defun org-remove-tabs (s &optional width)
21418 "Replace tabulators in S with spaces.
21419 Assumes that s is a single line, starting in column 0."
21420 (setq width (or width tab-width))
21421 (while (string-match "\t" s)
21422 (setq s (replace-match
21423 (make-string
21424 (- (* width (/ (+ (match-beginning 0) width) width))
21425 (match-beginning 0)) ?\ )
21426 t t s)))
21429 (defun org-fix-indentation (line ind)
21430 "Fix indentation in LINE.
21431 IND is a cons cell with target and minimum indentation.
21432 If the current indentation in LINE is smaller than the minimum,
21433 leave it alone. If it is larger than ind, set it to the target."
21434 (let* ((l (org-remove-tabs line))
21435 (i (org-get-indentation l))
21436 (i1 (car ind)) (i2 (cdr ind)))
21437 (if (>= i i2) (setq l (substring line i2)))
21438 (if (> i1 0)
21439 (concat (make-string i1 ?\ ) l)
21440 l)))
21442 (defun org-remove-indentation (code &optional n)
21443 "Remove the maximum common indentation from the lines in CODE.
21444 N may optionally be the number of spaces to remove."
21445 (with-temp-buffer
21446 (insert code)
21447 (org-do-remove-indentation n)
21448 (buffer-string)))
21450 (defun org-do-remove-indentation (&optional n)
21451 "Remove the maximum common indentation from the buffer."
21452 (untabify (point-min) (point-max))
21453 (let ((min 10000) re)
21454 (if n
21455 (setq min n)
21456 (goto-char (point-min))
21457 (while (re-search-forward "^ *[^ \n]" nil t)
21458 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21459 (unless (or (= min 0) (= min 10000))
21460 (setq re (format "^ \\{%d\\}" min))
21461 (goto-char (point-min))
21462 (while (re-search-forward re nil t)
21463 (replace-match "")
21464 (end-of-line 1))
21465 min)))
21467 (defun org-fill-template (template alist)
21468 "Find each %key of ALIST in TEMPLATE and replace it."
21469 (let ((case-fold-search nil)
21470 entry key value)
21471 (setq alist (sort (copy-sequence alist)
21472 (lambda (a b) (< (length (car a)) (length (car b))))))
21473 (while (setq entry (pop alist))
21474 (setq template
21475 (replace-regexp-in-string
21476 (concat "%" (regexp-quote (car entry)))
21477 (or (cdr entry) "") template t t)))
21478 template))
21480 (defun org-base-buffer (buffer)
21481 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21482 (if (not buffer)
21483 buffer
21484 (or (buffer-base-buffer buffer)
21485 buffer)))
21487 (defun org-trim (s)
21488 "Remove whitespace at beginning and end of string."
21489 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21490 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21493 (defun org-wrap (string &optional width lines)
21494 "Wrap string to either a number of lines, or a width in characters.
21495 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21496 that costs. If there is a word longer than WIDTH, the text is actually
21497 wrapped to the length of that word.
21498 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21499 many lines, whatever width that takes.
21500 The return value is a list of lines, without newlines at the end."
21501 (let* ((words (org-split-string string "[ \t\n]+"))
21502 (maxword (apply 'max (mapcar 'org-string-width words)))
21503 w ll)
21504 (cond (width
21505 (org-do-wrap words (max maxword width)))
21506 (lines
21507 (setq w maxword)
21508 (setq ll (org-do-wrap words maxword))
21509 (if (<= (length ll) lines)
21511 (setq ll words)
21512 (while (> (length ll) lines)
21513 (setq w (1+ w))
21514 (setq ll (org-do-wrap words w)))
21515 ll))
21516 (t (error "Cannot wrap this")))))
21518 (defun org-do-wrap (words width)
21519 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21520 (let (lines line)
21521 (while words
21522 (setq line (pop words))
21523 (while (and words (< (+ (length line) (length (car words))) width))
21524 (setq line (concat line " " (pop words))))
21525 (setq lines (push line lines)))
21526 (nreverse lines)))
21528 (defun org-split-string (string &optional separators)
21529 "Splits STRING into substrings at SEPARATORS.
21530 No empty strings are returned if there are matches at the beginning
21531 and end of string."
21532 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21533 (start 0)
21534 notfirst
21535 (list nil))
21536 (while (and (string-match rexp string
21537 (if (and notfirst
21538 (= start (match-beginning 0))
21539 (< start (length string)))
21540 (1+ start) start))
21541 (< (match-beginning 0) (length string)))
21542 (setq notfirst t)
21543 (or (eq (match-beginning 0) 0)
21544 (and (eq (match-beginning 0) (match-end 0))
21545 (eq (match-beginning 0) start))
21546 (setq list
21547 (cons (substring string start (match-beginning 0))
21548 list)))
21549 (setq start (match-end 0)))
21550 (or (eq start (length string))
21551 (setq list
21552 (cons (substring string start)
21553 list)))
21554 (nreverse list)))
21556 (defun org-quote-vert (s)
21557 "Replace \"|\" with \"\\vert\"."
21558 (while (string-match "|" s)
21559 (setq s (replace-match "\\vert" t t s)))
21562 (defun org-uuidgen-p (s)
21563 "Is S an ID created by UUIDGEN?"
21564 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21566 (defun org-in-src-block-p (&optional inside)
21567 "Whether point is in a code source block.
21568 When INSIDE is non-nil, don't consider we are within a src block
21569 when point is at #+BEGIN_SRC or #+END_SRC."
21570 (let ((case-fold-search t) ov)
21571 (or (and (setq ov (overlays-at (point)))
21572 (memq 'org-block-background
21573 (overlay-properties (car ov))))
21574 (and (not inside)
21575 (save-match-data
21576 (save-excursion
21577 (beginning-of-line)
21578 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21580 (defun org-context ()
21581 "Return a list of contexts of the current cursor position.
21582 If several contexts apply, all are returned.
21583 Each context entry is a list with a symbol naming the context, and
21584 two positions indicating start and end of the context. Possible
21585 contexts are:
21587 :headline anywhere in a headline
21588 :headline-stars on the leading stars in a headline
21589 :todo-keyword on a TODO keyword (including DONE) in a headline
21590 :tags on the TAGS in a headline
21591 :priority on the priority cookie in a headline
21592 :item on the first line of a plain list item
21593 :item-bullet on the bullet/number of a plain list item
21594 :checkbox on the checkbox in a plain list item
21595 :table in an org-mode table
21596 :table-special on a special filed in a table
21597 :table-table in a table.el table
21598 :clocktable in a clocktable
21599 :src-block in a source block
21600 :link on a hyperlink
21601 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21602 :target on a <<target>>
21603 :radio-target on a <<<radio-target>>>
21604 :latex-fragment on a LaTeX fragment
21605 :latex-preview on a LaTeX fragment with overlaid preview image
21607 This function expects the position to be visible because it uses font-lock
21608 faces as a help to recognize the following contexts: :table-special, :link,
21609 and :keyword."
21610 (let* ((f (get-text-property (point) 'face))
21611 (faces (if (listp f) f (list f)))
21612 (case-fold-search t)
21613 (p (point)) clist o)
21614 ;; First the large context
21615 (cond
21616 ((org-at-heading-p t)
21617 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21618 (when (progn
21619 (beginning-of-line 1)
21620 (looking-at org-todo-line-tags-regexp))
21621 (push (org-point-in-group p 1 :headline-stars) clist)
21622 (push (org-point-in-group p 2 :todo-keyword) clist)
21623 (push (org-point-in-group p 4 :tags) clist))
21624 (goto-char p)
21625 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21626 (if (looking-at "\\[#[A-Z0-9]\\]")
21627 (push (org-point-in-group p 0 :priority) clist)))
21629 ((org-at-item-p)
21630 (push (org-point-in-group p 2 :item-bullet) clist)
21631 (push (list :item (point-at-bol)
21632 (save-excursion (org-end-of-item) (point)))
21633 clist)
21634 (and (org-at-item-checkbox-p)
21635 (push (org-point-in-group p 0 :checkbox) clist)))
21637 ((org-at-table-p)
21638 (push (list :table (org-table-begin) (org-table-end)) clist)
21639 (if (memq 'org-formula faces)
21640 (push (list :table-special
21641 (previous-single-property-change p 'face)
21642 (next-single-property-change p 'face)) clist)))
21643 ((org-at-table-p 'any)
21644 (push (list :table-table) clist)))
21645 (goto-char p)
21647 (let ((case-fold-search t))
21648 ;; New the "medium" contexts: clocktables, source blocks
21649 (cond ((org-in-clocktable-p)
21650 (push (list :clocktable
21651 (and (or (looking-at "#\\+BEGIN: clocktable")
21652 (search-backward "#+BEGIN: clocktable" nil t))
21653 (match-beginning 0))
21654 (and (re-search-forward "#\\+END:?" nil t)
21655 (match-end 0))) clist))
21656 ((org-in-src-block-p)
21657 (push (list :src-block
21658 (and (or (looking-at "#\\+BEGIN_SRC")
21659 (search-backward "#+BEGIN_SRC" nil t))
21660 (match-beginning 0))
21661 (and (search-forward "#+END_SRC" nil t)
21662 (match-beginning 0))) clist))))
21663 (goto-char p)
21665 ;; Now the small context
21666 (cond
21667 ((org-at-timestamp-p)
21668 (push (org-point-in-group p 0 :timestamp) clist))
21669 ((memq 'org-link faces)
21670 (push (list :link
21671 (previous-single-property-change p 'face)
21672 (next-single-property-change p 'face)) clist))
21673 ((memq 'org-special-keyword faces)
21674 (push (list :keyword
21675 (previous-single-property-change p 'face)
21676 (next-single-property-change p 'face)) clist))
21677 ((org-at-target-p)
21678 (push (org-point-in-group p 0 :target) clist)
21679 (goto-char (1- (match-beginning 0)))
21680 (if (looking-at org-radio-target-regexp)
21681 (push (org-point-in-group p 0 :radio-target) clist))
21682 (goto-char p))
21683 ((setq o (car (delq nil
21684 (mapcar
21685 (lambda (x)
21686 (if (memq x org-latex-fragment-image-overlays) x))
21687 (overlays-at (point))))))
21688 (push (list :latex-fragment
21689 (overlay-start o) (overlay-end o)) clist)
21690 (push (list :latex-preview
21691 (overlay-start o) (overlay-end o)) clist))
21692 ((org-inside-LaTeX-fragment-p)
21693 ;; FIXME: positions wrong.
21694 (push (list :latex-fragment (point) (point)) clist)))
21696 (setq clist (nreverse (delq nil clist)))
21697 clist))
21699 ;; FIXME: Compare with at-regexp-p Do we need both?
21700 (defun org-in-regexp (re &optional nlines visually)
21701 "Check if point is inside a match of regexp.
21702 Normally only the current line is checked, but you can include NLINES extra
21703 lines both before and after point into the search.
21704 If VISUALLY is set, require that the cursor is not after the match but
21705 really on, so that the block visually is on the match."
21706 (catch 'exit
21707 (let ((pos (point))
21708 (eol (point-at-eol (+ 1 (or nlines 0))))
21709 (inc (if visually 1 0)))
21710 (save-excursion
21711 (beginning-of-line (- 1 (or nlines 0)))
21712 (while (re-search-forward re eol t)
21713 (if (and (<= (match-beginning 0) pos)
21714 (>= (+ inc (match-end 0)) pos))
21715 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21717 (defun org-at-regexp-p (regexp)
21718 "Is point inside a match of REGEXP in the current line?"
21719 (catch 'exit
21720 (save-excursion
21721 (let ((pos (point)) (end (point-at-eol)))
21722 (beginning-of-line 1)
21723 (while (re-search-forward regexp end t)
21724 (if (and (<= (match-beginning 0) pos)
21725 (>= (match-end 0) pos))
21726 (throw 'exit t)))
21727 nil))))
21729 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21730 "Non-nil when point is between matches of START-RE and END-RE.
21732 Also return a non-nil value when point is on one of the matches.
21734 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21735 buffer positions. Default values are the positions of headlines
21736 surrounding the point.
21738 The functions returns a cons cell whose car (resp. cdr) is the
21739 position before START-RE (resp. after END-RE)."
21740 (save-match-data
21741 (let ((pos (point))
21742 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21743 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21744 beg end)
21745 (save-excursion
21746 ;; Point is on a block when on START-RE or if START-RE can be
21747 ;; found before it...
21748 (and (or (org-at-regexp-p start-re)
21749 (re-search-backward start-re limit-up t))
21750 (setq beg (match-beginning 0))
21751 ;; ... and END-RE after it...
21752 (goto-char (match-end 0))
21753 (re-search-forward end-re limit-down t)
21754 (> (setq end (match-end 0)) pos)
21755 ;; ... without another START-RE in-between.
21756 (goto-char (match-beginning 0))
21757 (not (re-search-backward start-re (1+ beg) t))
21758 ;; Return value.
21759 (cons beg end))))))
21761 (defun org-in-block-p (names)
21762 "Non-nil when point belongs to a block whose name belongs to NAMES.
21764 NAMES is a list of strings containing names of blocks.
21766 Return first block name matched, or nil. Beware that in case of
21767 nested blocks, the returned name may not belong to the closest
21768 block from point."
21769 (save-match-data
21770 (catch 'exit
21771 (let ((case-fold-search t)
21772 (lim-up (save-excursion (outline-previous-heading)))
21773 (lim-down (save-excursion (outline-next-heading))))
21774 (mapc (lambda (name)
21775 (let ((n (regexp-quote name)))
21776 (when (org-between-regexps-p
21777 (concat "^[ \t]*#\\+begin_" n)
21778 (concat "^[ \t]*#\\+end_" n)
21779 lim-up lim-down)
21780 (throw 'exit n))))
21781 names))
21782 nil)))
21784 (defun org-in-drawer-p ()
21785 "Is point within a drawer?"
21786 (save-match-data
21787 (let ((case-fold-search t)
21788 (lim-up (save-excursion (outline-previous-heading)))
21789 (lim-down (save-excursion (outline-next-heading))))
21790 (org-between-regexps-p
21791 (concat "^[ \t]*:" (regexp-opt org-drawers) ":")
21792 "^[ \t]*:end:.*$"
21793 lim-up lim-down))))
21795 (defun org-occur-in-agenda-files (regexp &optional nlines)
21796 "Call `multi-occur' with buffers for all agenda files."
21797 (interactive "sOrg-files matching: \np")
21798 (let* ((files (org-agenda-files))
21799 (tnames (mapcar 'file-truename files))
21800 (extra org-agenda-text-search-extra-files)
21802 (when (eq (car extra) 'agenda-archives)
21803 (setq extra (cdr extra))
21804 (setq files (org-add-archive-files files)))
21805 (while (setq f (pop extra))
21806 (unless (member (file-truename f) tnames)
21807 (add-to-list 'files f 'append)
21808 (add-to-list 'tnames (file-truename f) 'append)))
21809 (multi-occur
21810 (mapcar (lambda (x)
21811 (with-current-buffer
21812 (or (get-file-buffer x) (find-file-noselect x))
21813 (widen)
21814 (current-buffer)))
21815 files)
21816 regexp)))
21818 (if (boundp 'occur-mode-find-occurrence-hook)
21819 ;; Emacs 23
21820 (add-hook 'occur-mode-find-occurrence-hook
21821 (lambda ()
21822 (when (derived-mode-p 'org-mode)
21823 (org-reveal))))
21824 ;; Emacs 22
21825 (defadvice occur-mode-goto-occurrence
21826 (after org-occur-reveal activate)
21827 (and (derived-mode-p 'org-mode) (org-reveal)))
21828 (defadvice occur-mode-goto-occurrence-other-window
21829 (after org-occur-reveal activate)
21830 (and (derived-mode-p 'org-mode) (org-reveal)))
21831 (defadvice occur-mode-display-occurrence
21832 (after org-occur-reveal activate)
21833 (when (derived-mode-p 'org-mode)
21834 (let ((pos (occur-mode-find-occurrence)))
21835 (with-current-buffer (marker-buffer pos)
21836 (save-excursion
21837 (goto-char pos)
21838 (org-reveal)))))))
21840 (defun org-occur-link-in-agenda-files ()
21841 "Create a link and search for it in the agendas.
21842 The link is not stored in `org-stored-links', it is just created
21843 for the search purpose."
21844 (interactive)
21845 (let ((link (condition-case nil
21846 (org-store-link nil)
21847 (error "Unable to create a link to here"))))
21848 (org-occur-in-agenda-files (regexp-quote link))))
21850 (defun org-reverse-string (string)
21851 "Return the reverse of STRING."
21852 (apply 'string (reverse (string-to-list string))))
21854 ;; defsubst org-uniquify must be defined before first use
21856 (defun org-uniquify-alist (alist)
21857 "Merge elements of ALIST with the same key.
21859 For example, in this alist:
21861 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21862 => '((a 1 3) (b 2))
21864 merge (a 1) and (a 3) into (a 1 3).
21866 The function returns the new ALIST."
21867 (let (rtn)
21868 (mapc
21869 (lambda (e)
21870 (let (n)
21871 (if (not (assoc (car e) rtn))
21872 (push e rtn)
21873 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21874 (setq rtn (assq-delete-all (car e) rtn))
21875 (push n rtn))))
21876 alist)
21877 rtn))
21879 (defun org-delete-all (elts list)
21880 "Remove all elements in ELTS from LIST."
21881 (while elts
21882 (setq list (delete (pop elts) list)))
21883 list)
21885 (defun org-count (cl-item cl-seq)
21886 "Count the number of occurrences of ITEM in SEQ.
21887 Taken from `count' in cl-seq.el with all keyword arguments removed."
21888 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21889 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21890 (while (< cl-start cl-end)
21891 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21892 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21893 (setq cl-start (1+ cl-start)))
21894 cl-count))
21896 (defun org-remove-if (predicate seq)
21897 "Remove everything from SEQ that fulfills PREDICATE."
21898 (let (res e)
21899 (while seq
21900 (setq e (pop seq))
21901 (if (not (funcall predicate e)) (push e res)))
21902 (nreverse res)))
21904 (defun org-remove-if-not (predicate seq)
21905 "Remove everything from SEQ that does not fulfill PREDICATE."
21906 (let (res e)
21907 (while seq
21908 (setq e (pop seq))
21909 (if (funcall predicate e) (push e res)))
21910 (nreverse res)))
21912 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21913 "Reduce two-argument FUNCTION across SEQ.
21914 Taken from `reduce' in cl-seq.el with all keyword arguments but
21915 \":initial-value\" removed."
21916 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21917 (cadr (memq :initial-value cl-keys)))
21918 (cl-seq (pop cl-seq))
21919 (t (funcall cl-func)))))
21920 (while cl-seq
21921 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21922 cl-accum))
21924 (defun org-every (pred seq)
21925 "Return true if PREDICATE is true of every element of SEQ.
21926 Adapted from `every' in cl.el."
21927 (catch 'org-every
21928 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21931 (defun org-some (pred seq)
21932 "Return true if PREDICATE is true of any element of SEQ.
21933 Adapted from `some' in cl.el."
21934 (catch 'org-some
21935 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21936 nil))
21938 (defun org-back-over-empty-lines ()
21939 "Move backwards over whitespace, to the beginning of the first empty line.
21940 Returns the number of empty lines passed."
21941 (let ((pos (point)))
21942 (if (cdr (assoc 'heading org-blank-before-new-entry))
21943 (skip-chars-backward " \t\n\r")
21944 (unless (eobp)
21945 (forward-line -1)))
21946 (beginning-of-line 2)
21947 (goto-char (min (point) pos))
21948 (count-lines (point) pos)))
21950 (defun org-skip-whitespace ()
21951 (skip-chars-forward " \t\n\r"))
21953 (defun org-point-in-group (point group &optional context)
21954 "Check if POINT is in match-group GROUP.
21955 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21956 match. If the match group does not exist or point is not inside it,
21957 return nil."
21958 (and (match-beginning group)
21959 (>= point (match-beginning group))
21960 (<= point (match-end group))
21961 (if context
21962 (list context (match-beginning group) (match-end group))
21963 t)))
21965 (defun org-switch-to-buffer-other-window (&rest args)
21966 "Switch to buffer in a second window on the current frame.
21967 In particular, do not allow pop-up frames.
21968 Returns the newly created buffer."
21969 (org-no-popups
21970 (apply 'switch-to-buffer-other-window args)))
21972 (defun org-combine-plists (&rest plists)
21973 "Create a single property list from all plists in PLISTS.
21974 The process starts by copying the first list, and then setting properties
21975 from the other lists. Settings in the last list are the most significant
21976 ones and overrule settings in the other lists."
21977 (let ((rtn (copy-sequence (pop plists)))
21978 p v ls)
21979 (while plists
21980 (setq ls (pop plists))
21981 (while ls
21982 (setq p (pop ls) v (pop ls))
21983 (setq rtn (plist-put rtn p v))))
21984 rtn))
21986 (defun org-replace-escapes (string table)
21987 "Replace %-escapes in STRING with values in TABLE.
21988 TABLE is an association list with keys like \"%a\" and string values.
21989 The sequences in STRING may contain normal field width and padding information,
21990 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
21991 so values can contain further %-escapes if they are define later in TABLE."
21992 (let ((tbl (copy-alist table))
21993 (case-fold-search nil)
21994 (pchg 0)
21995 e re rpl)
21996 (while (setq e (pop tbl))
21997 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21998 (when (and (cdr e) (string-match re (cdr e)))
21999 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22000 (safe "SREF"))
22001 (add-text-properties 0 3 (list 'sref sref) safe)
22002 (setcdr e (replace-match safe t t (cdr e)))))
22003 (while (string-match re string)
22004 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22005 (cdr e)))
22006 (setq string (replace-match rpl t t string))))
22007 (while (setq pchg (next-property-change pchg string))
22008 (let ((sref (get-text-property pchg 'sref string)))
22009 (when (and sref (string-match "SREF" string pchg))
22010 (setq string (replace-match sref t t string)))))
22011 string))
22013 (defun org-sublist (list start end)
22014 "Return a section of LIST, from START to END.
22015 Counting starts at 1."
22016 (let (rtn (c start))
22017 (setq list (nthcdr (1- start) list))
22018 (while (and list (<= c end))
22019 (push (pop list) rtn)
22020 (setq c (1+ c)))
22021 (nreverse rtn)))
22023 (defun org-find-base-buffer-visiting (file)
22024 "Like `find-buffer-visiting' but always return the base buffer and
22025 not an indirect buffer."
22026 (let ((buf (or (get-file-buffer file)
22027 (find-buffer-visiting file))))
22028 (if buf
22029 (or (buffer-base-buffer buf) buf)
22030 nil)))
22032 (defun org-image-file-name-regexp (&optional extensions)
22033 "Return regexp matching the file names of images.
22034 If EXTENSIONS is given, only match these."
22035 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22036 (image-file-name-regexp)
22037 (let ((image-file-name-extensions
22038 (or extensions
22039 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22040 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22041 (concat "\\."
22042 (regexp-opt (nconc (mapcar 'upcase
22043 image-file-name-extensions)
22044 image-file-name-extensions)
22046 "\\'"))))
22048 (defun org-file-image-p (file &optional extensions)
22049 "Return non-nil if FILE is an image."
22050 (save-match-data
22051 (string-match (org-image-file-name-regexp extensions) file)))
22053 (defun org-get-cursor-date (&optional with-time)
22054 "Return the date at cursor in as a time.
22055 This works in the calendar and in the agenda, anywhere else it just
22056 returns the current time.
22057 If WITH-TIME is non-nil, returns the time of the event at point (in
22058 the agenda) or the current time of the day."
22059 (let (date day defd tp tm hod mod)
22060 (when with-time
22061 (setq tp (get-text-property (point) 'time))
22062 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22063 (setq hod (string-to-number (match-string 1 tp))
22064 mod (string-to-number (match-string 2 tp))))
22065 (or tp (setq hod (nth 2 (decode-time (current-time)))
22066 mod (nth 1 (decode-time (current-time))))))
22067 (cond
22068 ((eq major-mode 'calendar-mode)
22069 (setq date (calendar-cursor-to-date)
22070 defd (encode-time 0 (or mod 0) (or hod 0)
22071 (nth 1 date) (nth 0 date) (nth 2 date))))
22072 ((eq major-mode 'org-agenda-mode)
22073 (setq day (get-text-property (point) 'day))
22074 (if day
22075 (setq date (calendar-gregorian-from-absolute day)
22076 defd (encode-time 0 (or mod 0) (or hod 0)
22077 (nth 1 date) (nth 0 date) (nth 2 date))))))
22078 (or defd (current-time))))
22080 (defun org-mark-subtree (&optional up)
22081 "Mark the current subtree.
22082 This puts point at the start of the current subtree, and mark at
22083 the end. If a numeric prefix UP is given, move up into the
22084 hierarchy of headlines by UP levels before marking the subtree."
22085 (interactive "P")
22086 (org-with-limited-levels
22087 (cond ((org-at-heading-p) (beginning-of-line))
22088 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22089 (t (outline-previous-visible-heading 1))))
22090 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22091 (if (org-called-interactively-p 'any)
22092 (call-interactively 'org-mark-element)
22093 (org-mark-element)))
22096 ;;; Indentation
22098 (defun org-indent-line ()
22099 "Indent line depending on context."
22100 (interactive)
22101 (let* ((pos (point))
22102 (itemp (org-at-item-p))
22103 (case-fold-search t)
22104 (org-drawer-regexp (or org-drawer-regexp "\000"))
22105 (inline-task-p (and (featurep 'org-inlinetask)
22106 (org-inlinetask-in-task-p)))
22107 (inline-re (and inline-task-p
22108 (org-inlinetask-outline-regexp)))
22109 column)
22110 (if (and orgstruct-is-++ (eq pos (point)))
22111 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22112 (indent-according-to-mode))
22113 (beginning-of-line 1)
22114 (cond
22115 ;; Headings
22116 ((looking-at org-outline-regexp) (setq column 0))
22117 ;; Footnote definition
22118 ((looking-at org-footnote-definition-re) (setq column 0))
22119 ;; Literal examples
22120 ((looking-at "[ \t]*:\\( \\|$\\)")
22121 (setq column (org-get-indentation))) ; do nothing
22122 ;; Lists
22123 ((ignore-errors (goto-char (org-in-item-p)))
22124 (setq column (if itemp
22125 (org-get-indentation)
22126 (org-list-item-body-column (point))))
22127 (goto-char pos))
22128 ;; Drawers
22129 ((and (looking-at "[ \t]*:END:")
22130 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22131 (save-excursion
22132 (goto-char (1- (match-beginning 1)))
22133 (setq column (current-column))))
22134 ;; Special blocks
22135 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22136 (save-excursion
22137 (re-search-backward
22138 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22139 (setq column (org-get-indentation (match-string 0))))
22140 ((and (not (looking-at "[ \t]*#\\+begin_"))
22141 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22142 (save-excursion
22143 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22144 (setq column
22145 (cond ((equal (downcase (match-string 1)) "src")
22146 ;; src blocks: let `org-edit-src-exit' handle them
22147 (org-get-indentation))
22148 ((equal (downcase (match-string 1)) "example")
22149 (max (org-get-indentation)
22150 (org-get-indentation (match-string 0))))
22152 (org-get-indentation (match-string 0))))))
22153 ;; This line has nothing special, look at the previous relevant
22154 ;; line to compute indentation
22156 (beginning-of-line 0)
22157 (while (and (not (bobp))
22158 (not (looking-at org-table-line-regexp))
22159 (not (looking-at org-drawer-regexp))
22160 ;; When point started in an inline task, do not move
22161 ;; above task starting line.
22162 (not (and inline-task-p (looking-at inline-re)))
22163 ;; Skip drawers, blocks, empty lines, verbatim,
22164 ;; comments, tables, footnotes definitions, lists,
22165 ;; inline tasks.
22166 (or (and (looking-at "[ \t]*:END:")
22167 (re-search-backward org-drawer-regexp nil t))
22168 (and (looking-at "[ \t]*#\\+end_")
22169 (re-search-backward "[ \t]*#\\+begin_"nil t))
22170 (looking-at "[ \t]*[\n:#|]")
22171 (looking-at org-footnote-definition-re)
22172 (and (not inline-task-p)
22173 (featurep 'org-inlinetask)
22174 (org-inlinetask-in-task-p)
22175 (or (org-inlinetask-goto-beginning) t))))
22176 (beginning-of-line 0))
22177 (cond
22178 ;; There was a list item above.
22179 ((ignore-errors (goto-char (org-in-item-p)))
22180 (goto-char (org-list-get-top-point (org-list-struct)))
22181 (setq column (org-get-indentation)))
22182 ;; There was an heading above.
22183 ((looking-at "\\*+[ \t]+")
22184 (if (not org-adapt-indentation)
22185 (setq column 0)
22186 (goto-char (match-end 0))
22187 (setq column (current-column))))
22188 ;; A drawer had started and is unfinished
22189 ((looking-at org-drawer-regexp)
22190 (goto-char (1- (match-beginning 1)))
22191 (setq column (current-column)))
22192 ;; Else, nothing noticeable found: get indentation and go on.
22193 (t (setq column (org-get-indentation))))))
22194 ;; Now apply indentation and move cursor accordingly
22195 (goto-char pos)
22196 (if (<= (current-column) (current-indentation))
22197 (org-indent-line-to column)
22198 (save-excursion (org-indent-line-to column)))
22199 ;; Special polishing for properties, see `org-property-format'
22200 (setq column (current-column))
22201 (beginning-of-line 1)
22202 (if (looking-at org-property-re)
22203 (replace-match (concat (match-string 4)
22204 (format org-property-format
22205 (match-string 1) (match-string 3)))
22206 t t))
22207 (org-move-to-column column))))
22209 (defun org-indent-drawer ()
22210 "Indent the drawer at point."
22211 (interactive)
22212 (let ((p (point))
22213 (e (and (save-excursion (re-search-forward ":END:" nil t))
22214 (match-end 0)))
22215 (folded
22216 (save-excursion
22217 (end-of-line)
22218 (when (overlays-at (point))
22219 (member 'invisible (overlay-properties
22220 (car (overlays-at (point)))))))))
22221 (when folded (org-cycle))
22222 (indent-for-tab-command)
22223 (while (and (move-beginning-of-line 2) (< (point) e))
22224 (indent-for-tab-command))
22225 (goto-char p)
22226 (when folded (org-cycle)))
22227 (message "Drawer at point indented"))
22229 (defun org-indent-block ()
22230 "Indent the block at point."
22231 (interactive)
22232 (let ((p (point))
22233 (case-fold-search t)
22234 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22235 (match-end 0)))
22236 (folded
22237 (save-excursion
22238 (end-of-line)
22239 (when (overlays-at (point))
22240 (member 'invisible (overlay-properties
22241 (car (overlays-at (point)))))))))
22242 (when folded (org-cycle))
22243 (indent-for-tab-command)
22244 (while (and (move-beginning-of-line 2) (< (point) e))
22245 (indent-for-tab-command))
22246 (goto-char p)
22247 (when folded (org-cycle)))
22248 (message "Block at point indented"))
22250 (defun org-indent-region (start end)
22251 "Indent region."
22252 (interactive "r")
22253 (save-excursion
22254 (let ((line-end (org-current-line end)))
22255 (goto-char start)
22256 (while (< (org-current-line) line-end)
22257 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22258 (t (call-interactively 'org-indent-line)))
22259 (move-beginning-of-line 2)))))
22262 ;;; Filling
22264 ;; We use our own fill-paragraph and auto-fill functions.
22266 ;; `org-fill-paragraph' relies on adaptive filling and context
22267 ;; checking. Appropriate `fill-prefix' is computed with
22268 ;; `org-adaptive-fill-function'.
22270 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22271 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22272 ;; `org-adaptive-fill-function' value. Internally,
22273 ;; `org-comment-line-break-function' breaks the line.
22275 ;; `org-setup-filling' installs filling and auto-filling related
22276 ;; variables during `org-mode' initialization.
22278 (defvar org-element-paragraph-separate) ; org-element.el
22279 (defun org-setup-filling ()
22280 (require 'org-element)
22281 ;; Prevent auto-fill from inserting unwanted new items.
22282 (when (boundp 'fill-nobreak-predicate)
22283 (org-set-local
22284 'fill-nobreak-predicate
22285 (org-uniquify
22286 (append fill-nobreak-predicate
22287 '(org-fill-line-break-nobreak-p
22288 org-fill-paragraph-with-timestamp-nobreak-p)))))
22289 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22290 (org-set-local 'paragraph-start paragraph-ending)
22291 (org-set-local 'paragraph-separate paragraph-ending))
22292 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22293 (org-set-local 'auto-fill-inhibit-regexp nil)
22294 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22295 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22296 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22298 (defun org-fill-line-break-nobreak-p ()
22299 "Non-nil when a new line at point would create an Org line break."
22300 (save-excursion
22301 (skip-chars-backward "[ \t]")
22302 (skip-chars-backward "\\\\")
22303 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22305 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22306 "Non-nil when a new line at point would split a timestamp."
22307 (and (org-at-timestamp-p t)
22308 (not (looking-at org-ts-regexp-both))))
22310 (declare-function message-in-body-p "message" ())
22311 (defvar orgtbl-line-start-regexp) ; From org-table.el
22312 (defun org-adaptive-fill-function ()
22313 "Compute a fill prefix for the current line.
22314 Return fill prefix, as a string, or nil if current line isn't
22315 meant to be filled. For convenience, if `adaptive-fill-regexp'
22316 matches in paragraphs or comments, use it."
22317 (catch 'exit
22318 (when (derived-mode-p 'message-mode)
22319 (save-excursion
22320 (beginning-of-line)
22321 (cond ((or (not (message-in-body-p))
22322 (looking-at orgtbl-line-start-regexp))
22323 (throw 'exit nil))
22324 ((looking-at message-cite-prefix-regexp)
22325 (throw 'exit (match-string-no-properties 0)))
22326 ((looking-at org-outline-regexp)
22327 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22328 (org-with-wide-buffer
22329 (let* ((p (line-beginning-position))
22330 (element (save-excursion
22331 (beginning-of-line)
22332 (or (ignore-errors (org-element-at-point))
22333 (user-error "An element cannot be parsed line %d"
22334 (line-number-at-pos (point))))))
22335 (type (org-element-type element))
22336 (post-affiliated (org-element-property :post-affiliated element)))
22337 (unless (and post-affiliated (< p post-affiliated))
22338 (case type
22339 (comment
22340 (save-excursion
22341 (beginning-of-line)
22342 (looking-at "[ \t]*")
22343 (concat (match-string 0) "# ")))
22344 (footnote-definition "")
22345 ((item plain-list)
22346 (make-string (org-list-item-body-column
22347 (or post-affiliated
22348 (org-element-property :begin element)))
22349 ? ))
22350 (paragraph
22351 ;; Fill prefix is usually the same as the current line,
22352 ;; unless the paragraph is at the beginning of an item.
22353 (let ((parent (org-element-property :parent element)))
22354 (save-excursion
22355 (beginning-of-line)
22356 (cond ((eq (org-element-type parent) 'item)
22357 (make-string (org-list-item-body-column
22358 (org-element-property :begin parent))
22359 ? ))
22360 ((and adaptive-fill-regexp
22361 ;; Locally disable
22362 ;; `adaptive-fill-function' to let
22363 ;; `fill-context-prefix' handle
22364 ;; `adaptive-fill-regexp' variable.
22365 (let (adaptive-fill-function)
22366 (fill-context-prefix
22367 post-affiliated
22368 (org-element-property :end element)))))
22369 ((looking-at "[ \t]+") (match-string 0))
22370 (t "")))))
22371 (comment-block
22372 ;; Only fill contents if P is within block boundaries.
22373 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22374 (forward-line)
22375 (point)))
22376 (cend (save-excursion
22377 (goto-char (org-element-property :end element))
22378 (skip-chars-backward " \r\t\n")
22379 (line-beginning-position))))
22380 (when (and (>= p cbeg) (< p cend))
22381 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22382 (match-string 0)
22383 ""))))))))))
22385 (declare-function message-goto-body "message" ())
22386 (defvar message-cite-prefix-regexp) ; From message.el
22387 (defun org-fill-paragraph (&optional justify)
22388 "Fill element at point, when applicable.
22390 This function only applies to comment blocks, comments, example
22391 blocks and paragraphs. Also, as a special case, re-align table
22392 when point is at one.
22394 If JUSTIFY is non-nil (interactively, with prefix argument),
22395 justify as well. If `sentence-end-double-space' is non-nil, then
22396 period followed by one space does not end a sentence, so don't
22397 break a line there. The variable `fill-column' controls the
22398 width for filling.
22400 For convenience, when point is at a plain list, an item or
22401 a footnote definition, try to fill the first paragraph within."
22402 (interactive)
22403 (if (and (derived-mode-p 'message-mode)
22404 (or (not (message-in-body-p))
22405 (save-excursion (move-beginning-of-line 1)
22406 (looking-at message-cite-prefix-regexp))))
22407 ;; First ensure filling is correct in message-mode.
22408 (let ((fill-paragraph-function
22409 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22410 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22411 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22412 (paragraph-separate
22413 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22414 (fill-paragraph nil))
22415 (with-syntax-table org-mode-transpose-word-syntax-table
22416 ;; Move to end of line in order to get the first paragraph
22417 ;; within a plain list or a footnote definition.
22418 (let ((element (save-excursion
22419 (end-of-line)
22420 (or (ignore-errors (org-element-at-point))
22421 (user-error "An element cannot be parsed line %d"
22422 (line-number-at-pos (point)))))))
22423 ;; First check if point is in a blank line at the beginning of
22424 ;; the buffer. In that case, ignore filling.
22425 (case (org-element-type element)
22426 ;; Use major mode filling function is src blocks.
22427 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22428 ;; Align Org tables, leave table.el tables as-is.
22429 (table-row (org-table-align) t)
22430 (table
22431 (when (eq (org-element-property :type element) 'org)
22432 (save-excursion
22433 (goto-char (org-element-property :post-affiliated element))
22434 (org-table-align)))
22436 (paragraph
22437 ;; Paragraphs may contain `line-break' type objects.
22438 (let ((beg (max (point-min)
22439 (org-element-property :contents-begin element)))
22440 (end (min (point-max)
22441 (org-element-property :contents-end element))))
22442 ;; Do nothing if point is at an affiliated keyword.
22443 (if (< (line-end-position) beg) t
22444 (when (derived-mode-p 'message-mode)
22445 ;; In `message-mode', do not fill following citation
22446 ;; in current paragraph nor text before message body.
22447 (let ((body-start (save-excursion (message-goto-body))))
22448 (when body-start (setq beg (max body-start beg))))
22449 (when (save-excursion
22450 (re-search-forward
22451 (concat "^" message-cite-prefix-regexp) end t))
22452 (setq end (match-beginning 0))))
22453 ;; Fill paragraph, taking line breaks into account.
22454 ;; For that, slice the paragraph using line breaks as
22455 ;; separators, and fill the parts in reverse order to
22456 ;; avoid messing with markers.
22457 (save-excursion
22458 (goto-char end)
22459 (mapc
22460 (lambda (pos)
22461 (fill-region-as-paragraph pos (point) justify)
22462 (goto-char pos))
22463 ;; Find the list of ending positions for line breaks
22464 ;; in the current paragraph. Add paragraph
22465 ;; beginning to include first slice.
22466 (nreverse
22467 (cons beg
22468 (org-element-map
22469 (org-element--parse-objects
22470 beg end nil (org-element-restriction 'paragraph))
22471 'line-break
22472 (lambda (lb) (org-element-property :end lb)))))))
22473 t)))
22474 ;; Contents of `comment-block' type elements should be
22475 ;; filled as plain text, but only if point is within block
22476 ;; markers.
22477 (comment-block
22478 (let* ((case-fold-search t)
22479 (beg (save-excursion
22480 (goto-char (org-element-property :begin element))
22481 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22482 (forward-line)
22483 (point)))
22484 (end (save-excursion
22485 (goto-char (org-element-property :end element))
22486 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22487 (line-beginning-position))))
22488 (if (or (< (point) beg) (> (point) end)) t
22489 (fill-region-as-paragraph
22490 (save-excursion (end-of-line)
22491 (re-search-backward "^[ \t]*$" beg 'move)
22492 (line-beginning-position))
22493 (save-excursion (beginning-of-line)
22494 (re-search-forward "^[ \t]*$" end 'move)
22495 (line-beginning-position))
22496 justify))))
22497 ;; Fill comments.
22498 (comment
22499 (let ((begin (org-element-property :post-affiliated element))
22500 (end (org-element-property :end element)))
22501 (when (and (>= (point) begin) (<= (point) end))
22502 (let ((begin (save-excursion
22503 (end-of-line)
22504 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22505 (progn (forward-line) (point))
22506 begin)))
22507 (end (save-excursion
22508 (end-of-line)
22509 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22510 (1- (line-beginning-position))
22511 (skip-chars-backward " \r\t\n")
22512 (line-end-position)))))
22513 ;; Do not fill comments when at a blank line.
22514 (when (> end begin)
22515 (let ((fill-prefix
22516 (save-excursion
22517 (beginning-of-line)
22518 (looking-at "[ \t]*#")
22519 (let ((comment-prefix (match-string 0)))
22520 (goto-char (match-end 0))
22521 (if (looking-at adaptive-fill-regexp)
22522 (concat comment-prefix (match-string 0))
22523 (concat comment-prefix " "))))))
22524 (save-excursion
22525 (fill-region-as-paragraph begin end justify))))))
22527 ;; Ignore every other element.
22528 (otherwise t))))))
22530 (defun org-auto-fill-function ()
22531 "Auto-fill function."
22532 ;; Check if auto-filling is meaningful.
22533 (let ((fc (current-fill-column)))
22534 (when (and fc (> (current-column) fc))
22535 (let* ((fill-prefix (org-adaptive-fill-function))
22536 ;; Enforce empty fill prefix, if required. Otherwise, it
22537 ;; will be computed again.
22538 (adaptive-fill-mode (not (equal fill-prefix ""))))
22539 (when fill-prefix (do-auto-fill))))))
22541 (defun org-comment-line-break-function (&optional soft)
22542 "Break line at point and indent, continuing comment if within one.
22543 The inserted newline is marked hard if variable
22544 `use-hard-newlines' is true, unless optional argument SOFT is
22545 non-nil."
22546 (if soft (insert-and-inherit ?\n) (newline 1))
22547 (save-excursion (forward-char -1) (delete-horizontal-space))
22548 (delete-horizontal-space)
22549 (indent-to-left-margin)
22550 (insert-before-markers-and-inherit fill-prefix))
22553 ;;; Comments
22555 ;; Org comments syntax is quite complex. It requires the entire line
22556 ;; to be just a comment. Also, even with the right syntax at the
22557 ;; beginning of line, some some elements (i.e. verse-block or
22558 ;; example-block) don't accept comments. Usual Emacs comment commands
22559 ;; cannot cope with those requirements. Therefore, Org replaces them.
22561 ;; Org still relies on `comment-dwim', but cannot trust
22562 ;; `comment-only-p'. So, `comment-region-function' and
22563 ;; `uncomment-region-function' both point
22564 ;; to`org-comment-or-uncomment-region'. Eventually,
22565 ;; `org-insert-comment' takes care of insertion of comments at the
22566 ;; beginning of line.
22568 ;; `org-setup-comments-handling' install comments related variables
22569 ;; during `org-mode' initialization.
22571 (defun org-setup-comments-handling ()
22572 (interactive)
22573 (org-set-local 'comment-use-syntax nil)
22574 (org-set-local 'comment-start "# ")
22575 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22576 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22577 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22578 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22580 (defun org-insert-comment ()
22581 "Insert an empty comment above current line.
22582 If the line is empty, insert comment at its beginning."
22583 (beginning-of-line)
22584 (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
22585 (org-indent-line)
22586 (insert "# "))
22588 (defvar comment-empty-lines) ; From newcomment.el.
22589 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22590 "Comment or uncomment each non-blank line in the region.
22591 Uncomment each non-blank line between BEG and END if it only
22592 contains commented lines. Otherwise, comment them."
22593 (save-restriction
22594 ;; Restrict region
22595 (narrow-to-region (save-excursion (goto-char beg)
22596 (skip-chars-forward " \r\t\n" end)
22597 (line-beginning-position))
22598 (save-excursion (goto-char end)
22599 (skip-chars-backward " \r\t\n" beg)
22600 (line-end-position)))
22601 (let ((uncommentp
22602 ;; UNCOMMENTP is non-nil when every non blank line between
22603 ;; BEG and END is a comment.
22604 (save-excursion
22605 (goto-char (point-min))
22606 (while (and (not (eobp))
22607 (let ((element (org-element-at-point)))
22608 (and (eq (org-element-type element) 'comment)
22609 (goto-char (min (point-max)
22610 (org-element-property
22611 :end element)))))))
22612 (eobp))))
22613 (if uncommentp
22614 ;; Only blank lines and comments in region: uncomment it.
22615 (save-excursion
22616 (goto-char (point-min))
22617 (while (not (eobp))
22618 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22619 (replace-match "" nil nil nil 1))
22620 (forward-line)))
22621 ;; Comment each line in region.
22622 (let ((min-indent (point-max)))
22623 ;; First find the minimum indentation across all lines.
22624 (save-excursion
22625 (goto-char (point-min))
22626 (while (and (not (eobp)) (not (zerop min-indent)))
22627 (unless (looking-at "[ \t]*$")
22628 (setq min-indent (min min-indent (current-indentation))))
22629 (forward-line)))
22630 ;; Then loop over all lines.
22631 (save-excursion
22632 (goto-char (point-min))
22633 (while (not (eobp))
22634 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22635 ;; Don't get fooled by invisible text (e.g. link path)
22636 ;; when moving to column MIN-INDENT.
22637 (let ((buffer-invisibility-spec nil))
22638 (org-move-to-column min-indent t))
22639 (insert comment-start))
22640 (forward-line))))))))
22643 ;;; Planning
22645 ;; This section contains tools to operate on timestamp objects, as
22646 ;; returned by, e.g. `org-element-context'.
22648 (defun org-timestamp-has-time-p (timestamp)
22649 "Non-nil when TIMESTAMP has a time specified."
22650 (org-element-property :hour-start timestamp))
22652 (defun org-timestamp-format (timestamp format &optional end utc)
22653 "Format a TIMESTAMP element into a string.
22655 FORMAT is a format specifier to be passed to
22656 `format-time-string'.
22658 When optional argument END is non-nil, use end of date-range or
22659 time-range, if possible.
22661 When optional argument UTC is non-nil, time will be expressed as
22662 Universal Time."
22663 (format-time-string
22664 format
22665 (apply 'encode-time
22666 (cons 0
22667 (mapcar
22668 (lambda (prop) (or (org-element-property prop timestamp) 0))
22669 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22670 '(:minute-start :hour-start :day-start :month-start
22671 :year-start)))))
22672 utc))
22674 (defun org-timestamp-split-range (timestamp &optional end)
22675 "Extract a timestamp object from a date or time range.
22677 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22678 the end of the range. Otherwise, extract its start.
22680 Return a new timestamp object sharing the same parent as
22681 TIMESTAMP."
22682 (let ((type (org-element-property :type timestamp)))
22683 (if (memq type '(active inactive diary)) timestamp
22684 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22685 ;; Set new type.
22686 (org-element-put-property
22687 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22688 ;; Copy start properties over end properties if END is
22689 ;; non-nil. Otherwise, copy end properties over `start' ones.
22690 (let ((p-alist '((:minute-start . :minute-end)
22691 (:hour-start . :hour-end)
22692 (:day-start . :day-end)
22693 (:month-start . :month-end)
22694 (:year-start . :year-end))))
22695 (dolist (p-cell p-alist)
22696 (org-element-put-property
22697 split-ts
22698 (funcall (if end 'car 'cdr) p-cell)
22699 (org-element-property
22700 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22701 ;; Eventually refresh `:raw-value'.
22702 (org-element-put-property split-ts :raw-value nil)
22703 (org-element-put-property
22704 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22706 (defun org-timestamp-translate (timestamp &optional boundary)
22707 "Apply `org-translate-time' on a TIMESTAMP object.
22708 When optional argument BOUNDARY is non-nil, it is either the
22709 symbol `start' or `end'. In this case, only translate the
22710 starting or ending part of TIMESTAMP if it is a date or time
22711 range. Otherwise, translate both parts."
22712 (if (and (not boundary)
22713 (memq (org-element-property :type timestamp)
22714 '(active-range inactive-range)))
22715 (concat
22716 (org-translate-time
22717 (org-element-property :raw-value
22718 (org-timestamp-split-range timestamp)))
22719 "--"
22720 (org-translate-time
22721 (org-element-property :raw-value
22722 (org-timestamp-split-range timestamp t))))
22723 (org-translate-time
22724 (org-element-property
22725 :raw-value
22726 (if (not boundary) timestamp
22727 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22731 ;;; Other stuff.
22733 (defun org-toggle-fixed-width-section (arg)
22734 "Toggle the fixed-width export.
22735 If there is no active region, the QUOTE keyword at the current headline is
22736 inserted or removed. When present, it causes the text between this headline
22737 and the next to be exported as fixed-width text, and unmodified.
22738 If there is an active region, this command adds or removes a colon as the
22739 first character of this line. If the first character of a line is a colon,
22740 this line is also exported in fixed-width font."
22741 (interactive "P")
22742 (let* ((cc 0)
22743 (regionp (org-region-active-p))
22744 (beg (if regionp (region-beginning) (point)))
22745 (end (if regionp (region-end)))
22746 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22747 (case-fold-search nil)
22748 (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
22749 off)
22750 (if regionp
22751 (save-excursion
22752 (goto-char beg)
22753 (setq cc (current-column))
22754 (beginning-of-line 1)
22755 (setq off (looking-at re))
22756 (while (> nlines 0)
22757 (setq nlines (1- nlines))
22758 (beginning-of-line 1)
22759 (cond
22760 (arg
22761 (org-move-to-column cc t)
22762 (insert ": \n")
22763 (forward-line -1))
22764 ((and off (looking-at re))
22765 (replace-match "" t t nil 1))
22766 ((not off) (org-move-to-column cc t) (insert ": ")))
22767 (forward-line 1)))
22768 (save-excursion
22769 (org-back-to-heading)
22770 (cond
22771 ((looking-at (format org-heading-keyword-regexp-format
22772 org-quote-string))
22773 (goto-char (match-end 1))
22774 (looking-at (concat " +" org-quote-string))
22775 (replace-match "" t t)
22776 (when (eolp) (insert " ")))
22777 ((looking-at org-outline-regexp)
22778 (goto-char (match-end 0))
22779 (insert org-quote-string " ")))))))
22781 (defun org-reftex-citation ()
22782 "Use reftex-citation to insert a citation into the buffer.
22783 This looks for a line like
22785 #+BIBLIOGRAPHY: foo plain option:-d
22787 and derives from it that foo.bib is the bibliography file relevant
22788 for this document. It then installs the necessary environment for RefTeX
22789 to work in this buffer and calls `reftex-citation' to insert a citation
22790 into the buffer.
22792 Export of such citations to both LaTeX and HTML is handled by the contributed
22793 package ox-bibtex by Taru Karttunen."
22794 (interactive)
22795 (let ((reftex-docstruct-symbol 'rds)
22796 (reftex-cite-format "\\cite{%l}")
22797 rds bib)
22798 (save-excursion
22799 (save-restriction
22800 (widen)
22801 (let ((case-fold-search t)
22802 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22803 (if (not (save-excursion
22804 (or (re-search-forward re nil t)
22805 (re-search-backward re nil t))))
22806 (error "No bibliography defined in file")
22807 (setq bib (concat (match-string 1) ".bib")
22808 rds (list (list 'bib bib)))))))
22809 (call-interactively 'reftex-citation)))
22811 ;;;; Functions extending outline functionality
22813 (defun org-beginning-of-line (&optional arg)
22814 "Go to the beginning of the current line. If that is invisible, continue
22815 to a visible line beginning. This makes the function of C-a more intuitive.
22816 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22817 first attempt, and only move to after the tags when the cursor is already
22818 beyond the end of the headline."
22819 (interactive "P")
22820 (let ((pos (point))
22821 (special (if (consp org-special-ctrl-a/e)
22822 (car org-special-ctrl-a/e)
22823 org-special-ctrl-a/e))
22824 deactivate-mark refpos)
22825 (if (org-bound-and-true-p visual-line-mode)
22826 (beginning-of-visual-line 1)
22827 (beginning-of-line 1))
22828 (if (and arg (fboundp 'move-beginning-of-line))
22829 (call-interactively 'move-beginning-of-line)
22830 (if (bobp)
22832 (backward-char 1)
22833 (if (org-truely-invisible-p)
22834 (while (and (not (bobp)) (org-truely-invisible-p))
22835 (backward-char 1)
22836 (beginning-of-line 1))
22837 (forward-char 1))))
22838 (when special
22839 (cond
22840 ((and (looking-at org-complex-heading-regexp)
22841 (= (char-after (match-end 1)) ?\ ))
22842 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22843 (point-at-eol)))
22844 (goto-char
22845 (if (eq special t)
22846 (cond ((> pos refpos) refpos)
22847 ((= pos (point)) refpos)
22848 (t (point)))
22849 (cond ((> pos (point)) (point))
22850 ((not (eq last-command this-command)) (point))
22851 (t refpos)))))
22852 ((org-at-item-p)
22853 ;; Being at an item and not looking at an the item means point
22854 ;; was previously moved to beginning of a visual line, which
22855 ;; doesn't contain the item. Therefore, do nothing special,
22856 ;; just stay here.
22857 (when (looking-at org-list-full-item-re)
22858 ;; Set special position at first white space character after
22859 ;; bullet, and check-box, if any.
22860 (let ((after-bullet
22861 (let ((box (match-end 3)))
22862 (if (not box) (match-end 1)
22863 (let ((after (char-after box)))
22864 (if (and after (= after ? )) (1+ box) box))))))
22865 ;; Special case: Move point to special position when
22866 ;; currently after it or at beginning of line.
22867 (if (eq special t)
22868 (when (or (> pos after-bullet) (= (point) pos))
22869 (goto-char after-bullet))
22870 ;; Reversed case: Move point to special position when
22871 ;; point was already at beginning of line and command is
22872 ;; repeated.
22873 (when (and (= (point) pos) (eq last-command this-command))
22874 (goto-char after-bullet))))))))
22875 (org-no-warnings
22876 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22877 (setq disable-point-adjustment
22878 (or (not (invisible-p (point)))
22879 (not (invisible-p (max (point-min) (1- (point))))))))
22881 (defun org-end-of-line (&optional arg)
22882 "Go to the end of the line.
22883 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22884 tags on the first attempt, and only move to after the tags when
22885 the cursor is already beyond the end of the headline."
22886 (interactive "P")
22887 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22888 org-special-ctrl-a/e))
22889 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22890 'end-of-visual-line)
22891 ((fboundp 'move-end-of-line) 'move-end-of-line)
22892 (t 'end-of-line)))
22893 deactivate-mark)
22894 (if (or (not special) arg) (call-interactively move-fun)
22895 (let* ((element (save-excursion (beginning-of-line)
22896 (org-element-at-point)))
22897 (type (org-element-type element)))
22898 (cond
22899 ((memq type '(headline inlinetask))
22900 (let ((pos (point)))
22901 (beginning-of-line 1)
22902 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
22903 (if (eq special t)
22904 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22905 (goto-char (match-beginning 1))
22906 (goto-char (match-end 0)))
22907 (if (or (< pos (match-end 0))
22908 (not (eq this-command last-command)))
22909 (goto-char (match-end 0))
22910 (goto-char (match-beginning 1))))
22911 (call-interactively move-fun))))
22912 ((org-element-property :hiddenp element)
22913 ;; If element is hidden, `move-end-of-line' would put point
22914 ;; after it. Use `end-of-line' to stay on current line.
22915 (call-interactively 'end-of-line))
22916 (t (call-interactively move-fun)))))
22917 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22918 (setq disable-point-adjustment
22919 (or (not (invisible-p (point)))
22920 (not (invisible-p (max (point-min) (1- (point))))))))
22922 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22923 (define-key org-mode-map "\C-e" 'org-end-of-line)
22925 (defun org-backward-sentence (&optional arg)
22926 "Go to beginning of sentence, or beginning of table field.
22927 This will call `backward-sentence' or `org-table-beginning-of-field',
22928 depending on context."
22929 (interactive "P")
22930 (cond
22931 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22932 (t (call-interactively 'backward-sentence))))
22934 (defun org-forward-sentence (&optional arg)
22935 "Go to end of sentence, or end of table field.
22936 This will call `forward-sentence' or `org-table-end-of-field',
22937 depending on context."
22938 (interactive "P")
22939 (cond
22940 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22941 (t (call-interactively 'forward-sentence))))
22943 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22944 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22946 (defun org-kill-line (&optional arg)
22947 "Kill line, to tags or end of line."
22948 (interactive "P")
22949 (cond
22950 ((or (not org-special-ctrl-k)
22951 (bolp)
22952 (not (org-at-heading-p)))
22953 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22954 org-ctrl-k-protect-subtree)
22955 (if (or (eq org-ctrl-k-protect-subtree 'error)
22956 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22957 (user-error "C-k aborted as it would kill a hidden subtree")))
22958 (call-interactively
22959 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22960 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
22961 (kill-region (point) (match-beginning 1))
22962 (org-set-tags nil t))
22963 (t (kill-region (point) (point-at-eol)))))
22965 (define-key org-mode-map "\C-k" 'org-kill-line)
22967 (defun org-yank (&optional arg)
22968 "Yank. If the kill is a subtree, treat it specially.
22969 This command will look at the current kill and check if is a single
22970 subtree, or a series of subtrees[1]. If it passes the test, and if the
22971 cursor is at the beginning of a line or after the stars of a currently
22972 empty headline, then the yank is handled specially. How exactly depends
22973 on the value of the following variables, both set by default.
22975 org-yank-folded-subtrees
22976 When set, the subtree(s) will be folded after insertion, but only
22977 if doing so would now swallow text after the yanked text.
22979 org-yank-adjusted-subtrees
22980 When set, the subtree will be promoted or demoted in order to
22981 fit into the local outline tree structure, which means that the level
22982 will be adjusted so that it becomes the smaller one of the two
22983 *visible* surrounding headings.
22985 Any prefix to this command will cause `yank' to be called directly with
22986 no special treatment. In particular, a simple \\[universal-argument] prefix \
22987 will just
22988 plainly yank the text as it is.
22990 \[1] The test checks if the first non-white line is a heading
22991 and if there are no other headings with fewer stars."
22992 (interactive "P")
22993 (org-yank-generic 'yank arg))
22995 (defun org-yank-generic (command arg)
22996 "Perform some yank-like command.
22998 This function implements the behavior described in the `org-yank'
22999 documentation. However, it has been generalized to work for any
23000 interactive command with similar behavior."
23002 ;; pretend to be command COMMAND
23003 (setq this-command command)
23005 (if arg
23006 (call-interactively command)
23008 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23009 (and (org-kill-is-subtree-p)
23010 (or (bolp)
23011 (and (looking-at "[ \t]*$")
23012 (string-match
23013 "\\`\\*+\\'"
23014 (buffer-substring (point-at-bol) (point)))))))
23015 swallowp)
23016 (cond
23017 ((and subtreep org-yank-folded-subtrees)
23018 (let ((beg (point))
23019 end)
23020 (if (and subtreep org-yank-adjusted-subtrees)
23021 (org-paste-subtree nil nil 'for-yank)
23022 (call-interactively command))
23024 (setq end (point))
23025 (goto-char beg)
23026 (when (and (bolp) subtreep
23027 (not (setq swallowp
23028 (org-yank-folding-would-swallow-text beg end))))
23029 (org-with-limited-levels
23030 (or (looking-at org-outline-regexp)
23031 (re-search-forward org-outline-regexp-bol end t))
23032 (while (and (< (point) end) (looking-at org-outline-regexp))
23033 (hide-subtree)
23034 (org-cycle-show-empty-lines 'folded)
23035 (condition-case nil
23036 (outline-forward-same-level 1)
23037 (error (goto-char end))))))
23038 (when swallowp
23039 (message
23040 "Inserted text not folded because that would swallow text"))
23042 (goto-char end)
23043 (skip-chars-forward " \t\n\r")
23044 (beginning-of-line 1)
23045 (push-mark beg 'nomsg)))
23046 ((and subtreep org-yank-adjusted-subtrees)
23047 (let ((beg (point-at-bol)))
23048 (org-paste-subtree nil nil 'for-yank)
23049 (push-mark beg 'nomsg)))
23051 (call-interactively command))))))
23053 (defun org-yank-folding-would-swallow-text (beg end)
23054 "Would hide-subtree at BEG swallow any text after END?"
23055 (let (level)
23056 (org-with-limited-levels
23057 (save-excursion
23058 (goto-char beg)
23059 (when (or (looking-at org-outline-regexp)
23060 (re-search-forward org-outline-regexp-bol end t))
23061 (setq level (org-outline-level)))
23062 (goto-char end)
23063 (skip-chars-forward " \t\r\n\v\f")
23064 (if (or (eobp)
23065 (and (bolp) (looking-at org-outline-regexp)
23066 (<= (org-outline-level) level)))
23067 nil ; Nothing would be swallowed
23068 t))))) ; something would swallow
23070 (define-key org-mode-map "\C-y" 'org-yank)
23072 (defun org-truely-invisible-p ()
23073 "Check if point is at a character currently not visible.
23074 This version does not only check the character property, but also
23075 `visible-mode'."
23076 ;; Early versions of noutline don't have `outline-invisible-p'.
23077 (if (org-bound-and-true-p visible-mode)
23079 (outline-invisible-p)))
23081 (defun org-invisible-p2 ()
23082 "Check if point is at a character currently not visible."
23083 (save-excursion
23084 (if (and (eolp) (not (bobp))) (backward-char 1))
23085 ;; Early versions of noutline don't have `outline-invisible-p'.
23086 (outline-invisible-p)))
23088 (defun org-back-to-heading (&optional invisible-ok)
23089 "Call `outline-back-to-heading', but provide a better error message."
23090 (condition-case nil
23091 (outline-back-to-heading invisible-ok)
23092 (error (error "Before first headline at position %d in buffer %s"
23093 (point) (current-buffer)))))
23095 (defun org-before-first-heading-p ()
23096 "Before first heading?"
23097 (save-excursion
23098 (end-of-line)
23099 (null (re-search-backward org-outline-regexp-bol nil t))))
23101 (defun org-at-heading-p (&optional ignored)
23102 (outline-on-heading-p t))
23103 ;; Compatibility alias with Org versions < 7.8.03
23104 (defalias 'org-on-heading-p 'org-at-heading-p)
23106 (defun org-at-comment-p nil
23107 "Is cursor in a line starting with a # character?"
23108 (save-excursion
23109 (beginning-of-line)
23110 (looking-at "^#")))
23112 (defun org-at-drawer-p nil
23113 "Is cursor at a drawer keyword?"
23114 (save-excursion
23115 (move-beginning-of-line 1)
23116 (looking-at org-drawer-regexp)))
23118 (defun org-at-block-p nil
23119 "Is cursor at a block keyword?"
23120 (save-excursion
23121 (move-beginning-of-line 1)
23122 (looking-at org-block-regexp)))
23124 (defun org-point-at-end-of-empty-headline ()
23125 "If point is at the end of an empty headline, return t, else nil.
23126 If the heading only contains a TODO keyword, it is still still considered
23127 empty."
23128 (and (looking-at "[ \t]*$")
23129 (when org-todo-line-regexp
23130 (save-excursion
23131 (beginning-of-line 1)
23132 (let ((case-fold-search nil))
23133 (looking-at org-todo-line-regexp)
23134 (string= (match-string 3) ""))))))
23136 (defun org-at-heading-or-item-p ()
23137 (or (org-at-heading-p) (org-at-item-p)))
23139 (defun org-at-target-p ()
23140 (or (org-in-regexp org-radio-target-regexp)
23141 (org-in-regexp org-target-regexp)))
23142 ;; Compatibility alias with Org versions < 7.8.03
23143 (defalias 'org-on-target-p 'org-at-target-p)
23145 (defun org-up-heading-all (arg)
23146 "Move to the heading line of which the present line is a subheading.
23147 This function considers both visible and invisible heading lines.
23148 With argument, move up ARG levels."
23149 (if (fboundp 'outline-up-heading-all)
23150 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23151 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23153 (defun org-up-heading-safe ()
23154 "Move to the heading line of which the present line is a subheading.
23155 This version will not throw an error. It will return the level of the
23156 headline found, or nil if no higher level is found.
23158 Also, this function will be a lot faster than `outline-up-heading',
23159 because it relies on stars being the outline starters. This can really
23160 make a significant difference in outlines with very many siblings."
23161 (let (start-level re)
23162 (org-back-to-heading t)
23163 (setq start-level (funcall outline-level))
23164 (if (equal start-level 1)
23166 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23167 (if (re-search-backward re nil t)
23168 (funcall outline-level)))))
23170 (defun org-first-sibling-p ()
23171 "Is this heading the first child of its parents?"
23172 (interactive)
23173 (let ((re org-outline-regexp-bol)
23174 level l)
23175 (unless (org-at-heading-p t)
23176 (user-error "Not at a heading"))
23177 (setq level (funcall outline-level))
23178 (save-excursion
23179 (if (not (re-search-backward re nil t))
23181 (setq l (funcall outline-level))
23182 (< l level)))))
23184 (defun org-goto-sibling (&optional previous)
23185 "Goto the next sibling, even if it is invisible.
23186 When PREVIOUS is set, go to the previous sibling instead. Returns t
23187 when a sibling was found. When none is found, return nil and don't
23188 move point."
23189 (let ((fun (if previous 're-search-backward 're-search-forward))
23190 (pos (point))
23191 (re org-outline-regexp-bol)
23192 level l)
23193 (when (condition-case nil (org-back-to-heading t) (error nil))
23194 (setq level (funcall outline-level))
23195 (catch 'exit
23196 (or previous (forward-char 1))
23197 (while (funcall fun re nil t)
23198 (setq l (funcall outline-level))
23199 (when (< l level) (goto-char pos) (throw 'exit nil))
23200 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23201 (goto-char pos)
23202 nil))))
23204 (defun org-show-siblings ()
23205 "Show all siblings of the current headline."
23206 (save-excursion
23207 (while (org-goto-sibling) (org-flag-heading nil)))
23208 (save-excursion
23209 (while (org-goto-sibling 'previous)
23210 (org-flag-heading nil))))
23212 (defun org-goto-first-child ()
23213 "Goto the first child, even if it is invisible.
23214 Return t when a child was found. Otherwise don't move point and
23215 return nil."
23216 (let (level (pos (point)) (re org-outline-regexp-bol))
23217 (when (condition-case nil (org-back-to-heading t) (error nil))
23218 (setq level (outline-level))
23219 (forward-char 1)
23220 (if (and (re-search-forward re nil t) (> (outline-level) level))
23221 (progn (goto-char (match-beginning 0)) t)
23222 (goto-char pos) nil))))
23224 (defun org-show-hidden-entry ()
23225 "Show an entry where even the heading is hidden."
23226 (save-excursion
23227 (org-show-entry)))
23229 (defun org-flag-heading (flag &optional entry)
23230 "Flag the current heading. FLAG non-nil means make invisible.
23231 When ENTRY is non-nil, show the entire entry."
23232 (save-excursion
23233 (org-back-to-heading t)
23234 ;; Check if we should show the entire entry
23235 (if entry
23236 (progn
23237 (org-show-entry)
23238 (save-excursion
23239 (and (outline-next-heading)
23240 (org-flag-heading nil))))
23241 (outline-flag-region (max (point-min) (1- (point)))
23242 (save-excursion (outline-end-of-heading) (point))
23243 flag))))
23245 (defun org-get-next-sibling ()
23246 "Move to next heading of the same level, and return point.
23247 If there is no such heading, return nil.
23248 This is like outline-next-sibling, but invisible headings are ok."
23249 (let ((level (funcall outline-level)))
23250 (outline-next-heading)
23251 (while (and (not (eobp)) (> (funcall outline-level) level))
23252 (outline-next-heading))
23253 (if (or (eobp) (< (funcall outline-level) level))
23255 (point))))
23257 (defun org-get-last-sibling ()
23258 "Move to previous heading of the same level, and return point.
23259 If there is no such heading, return nil."
23260 (let ((opoint (point))
23261 (level (funcall outline-level)))
23262 (outline-previous-heading)
23263 (when (and (/= (point) opoint) (outline-on-heading-p t))
23264 (while (and (> (funcall outline-level) level)
23265 (not (bobp)))
23266 (outline-previous-heading))
23267 (if (< (funcall outline-level) level)
23269 (point)))))
23271 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23272 "Goto to the end of a subtree."
23273 ;; This contains an exact copy of the original function, but it uses
23274 ;; `org-back-to-heading', to make it work also in invisible
23275 ;; trees. And is uses an invisible-ok argument.
23276 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23277 ;; Furthermore, when used inside Org, finding the end of a large subtree
23278 ;; with many children and grandchildren etc, this can be much faster
23279 ;; than the outline version.
23280 (org-back-to-heading invisible-ok)
23281 (let ((first t)
23282 (level (funcall outline-level)))
23283 (if (and (derived-mode-p 'org-mode) (< level 1000))
23284 ;; A true heading (not a plain list item), in Org-mode
23285 ;; This means we can easily find the end by looking
23286 ;; only for the right number of stars. Using a regexp to do
23287 ;; this is so much faster than using a Lisp loop.
23288 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23289 (forward-char 1)
23290 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23291 ;; something else, do it the slow way
23292 (while (and (not (eobp))
23293 (or first (> (funcall outline-level) level)))
23294 (setq first nil)
23295 (outline-next-heading)))
23296 (unless to-heading
23297 (if (memq (preceding-char) '(?\n ?\^M))
23298 (progn
23299 ;; Go to end of line before heading
23300 (forward-char -1)
23301 (if (memq (preceding-char) '(?\n ?\^M))
23302 ;; leave blank line before heading
23303 (forward-char -1))))))
23304 (point))
23306 (defun org-end-of-meta-data-and-drawers ()
23307 "Jump to the first text after meta data and drawers in the current entry.
23308 This will move over empty lines, lines with planning time stamps,
23309 clocking lines, and drawers."
23310 (org-back-to-heading t)
23311 (let ((end (save-excursion (outline-next-heading) (point)))
23312 (re (concat "\\(" org-drawer-regexp "\\)"
23313 "\\|" "[ \t]*" org-keyword-time-regexp)))
23314 (forward-line 1)
23315 (while (re-search-forward re end t)
23316 (if (not (match-end 1))
23317 ;; empty or planning line
23318 (forward-line 1)
23319 ;; a drawer, find the end
23320 (re-search-forward "^[ \t]*:END:" end 'move)
23321 (forward-line 1)))
23322 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23323 (point)))
23325 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23326 "Move forward to the ARG'th subheading at same level as this one.
23327 Stop at the first and last subheadings of a superior heading.
23328 Normally this only looks at visible headings, but when INVISIBLE-OK is
23329 non-nil it will also look at invisible ones."
23330 (interactive "p")
23331 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23332 (if (and arg (< arg 0))
23333 (goto-char (point-min))
23334 (outline-next-heading))
23335 (org-at-heading-p)
23336 (let ((level (- (match-end 0) (match-beginning 0) 1))
23337 (f (if (and arg (< arg 0))
23338 're-search-backward
23339 're-search-forward))
23340 (count (if arg (abs arg) 1))
23341 (result (point)))
23342 (while (and (prog1 (> count 0)
23343 (forward-char (if (and arg (< arg 0)) -1 1)))
23344 (funcall f org-outline-regexp-bol nil 'move))
23345 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23346 (cond ((< l level) (setq count 0))
23347 ((and (= l level)
23348 (or invisible-ok
23349 (progn
23350 (goto-char (line-beginning-position))
23351 (not (outline-invisible-p)))))
23352 (setq count (1- count))
23353 (when (eq l level)
23354 (setq result (point)))))))
23355 (goto-char result))
23356 (beginning-of-line 1)))
23358 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23359 "Move backward to the ARG'th subheading at same level as this one.
23360 Stop at the first and last subheadings of a superior heading."
23361 (interactive "p")
23362 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23364 (defun org-next-block (arg &optional backward block-regexp)
23365 "Jump to the next block.
23366 With a prefix argument ARG, jump forward ARG many source blocks.
23367 When BACKWARD is non-nil, jump to the previous block.
23368 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23369 (interactive "p")
23370 (let ((re (or block-regexp org-block-regexp))
23371 (re-search-fn (or (and backward 're-search-backward)
23372 're-search-forward)))
23373 (if (looking-at re) (forward-char 1))
23374 (condition-case nil
23375 (funcall re-search-fn re nil nil arg)
23376 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23377 (goto-char (match-beginning 0)) (org-show-context)))
23379 (defun org-previous-block (arg &optional block-regexp)
23380 "Jump to the previous block.
23381 With a prefix argument ARG, jump backward ARG many source blocks.
23382 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23383 (interactive "p")
23384 (org-next-block arg t block-regexp))
23386 (defun org-forward-paragraph ()
23387 "Move forward to beginning of next paragraph or equivalent.
23389 The function moves point to the beginning of the next visible
23390 structural element, which can be a paragraph, a table, a list
23391 item, etc. It also provides some special moves for convenience:
23393 - On an affiliated keyword, jump to the beginning of the
23394 relative element.
23395 - On an item or a footnote definition, move to the second
23396 element inside, if any.
23397 - On a table or a property drawer, jump after it.
23398 - On a verse or source block, stop after blank lines."
23399 (interactive)
23400 (when (eobp) (user-error "Cannot move further down"))
23401 (let* ((deactivate-mark nil)
23402 (element (org-element-at-point))
23403 (type (org-element-type element))
23404 (post-affiliated (org-element-property :post-affiliated element))
23405 (contents-begin (org-element-property :contents-begin element))
23406 (contents-end (org-element-property :contents-end element))
23407 (end (let ((end (org-element-property :end element)) (parent element))
23408 (while (and (setq parent (org-element-property :parent parent))
23409 (= (org-element-property :contents-end parent) end))
23410 (setq end (org-element-property :end parent)))
23411 end)))
23412 (cond ((not element)
23413 (skip-chars-forward " \r\t\n")
23414 (or (eobp) (beginning-of-line)))
23415 ;; On affiliated keywords, move to element's beginning.
23416 ((and post-affiliated (< (point) post-affiliated))
23417 (goto-char post-affiliated))
23418 ;; At a table row, move to the end of the table. Similarly,
23419 ;; at a node property, move to the end of the property
23420 ;; drawer.
23421 ((memq type '(node-property table-row))
23422 (goto-char (org-element-property
23423 :end (org-element-property :parent element))))
23424 ((memq type '(property-drawer table)) (goto-char end))
23425 ;; Consider blank lines as separators in verse and source
23426 ;; blocks to ease editing.
23427 ((memq type '(src-block verse-block))
23428 (when (eq type 'src-block)
23429 (setq contents-end
23430 (save-excursion (goto-char end)
23431 (skip-chars-backward " \r\t\n")
23432 (line-beginning-position))))
23433 (beginning-of-line)
23434 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23435 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23436 (goto-char end)
23437 (skip-chars-forward " \r\t\n")
23438 (if (= (point) contents-end) (goto-char end)
23439 (beginning-of-line))))
23440 ;; With no contents, just skip element.
23441 ((not contents-begin) (goto-char end))
23442 ;; If contents are invisible, skip the element altogether.
23443 ((outline-invisible-p (line-end-position))
23444 (case type
23445 (headline
23446 (org-with-limited-levels (outline-next-visible-heading 1)))
23447 ;; At a plain list, make sure we move to the next item
23448 ;; instead of skipping the whole list.
23449 (plain-list (forward-char)
23450 (org-forward-paragraph))
23451 (otherwise (goto-char end))))
23452 ((>= (point) contents-end) (goto-char end))
23453 ((>= (point) contents-begin)
23454 ;; This can only happen on paragraphs and plain lists.
23455 (case type
23456 (paragraph (goto-char end))
23457 ;; At a plain list, try to move to second element in
23458 ;; first item, if possible.
23459 (plain-list (end-of-line)
23460 (org-forward-paragraph))))
23461 ;; When contents start on the middle of a line (e.g. in
23462 ;; items and footnote definitions), try to reach first
23463 ;; element starting after current line.
23464 ((> (line-end-position) contents-begin)
23465 (end-of-line)
23466 (org-forward-paragraph))
23467 (t (goto-char contents-begin)))))
23469 (defun org-backward-paragraph ()
23470 "Move backward to start of previous paragraph or equivalent.
23472 The function moves point to the beginning of the current
23473 structural element, which can be a paragraph, a table, a list
23474 item, etc., or to the beginning of the previous visible one if
23475 point is already there. It also provides some special moves for
23476 convenience:
23478 - On an affiliated keyword, jump to the first one.
23479 - On a table or a property drawer, move to its beginning.
23480 - On a verse or source block, stop before blank lines."
23481 (interactive)
23482 (when (bobp) (user-error "Cannot move further up"))
23483 (let* ((deactivate-mark nil)
23484 (element (org-element-at-point))
23485 (type (org-element-type element))
23486 (contents-begin (org-element-property :contents-begin element))
23487 (contents-end (org-element-property :contents-end element))
23488 (post-affiliated (org-element-property :post-affiliated element))
23489 (begin (org-element-property :begin element)))
23490 (cond
23491 ((not element) (goto-char (point-min)))
23492 ((= (point) begin)
23493 (backward-char)
23494 (org-backward-paragraph))
23495 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23496 ((memq type '(node-property table-row))
23497 (goto-char (org-element-property
23498 :post-affiliated (org-element-property :parent element))))
23499 ((memq type '(property-drawer table)) (goto-char begin))
23500 ((memq type '(src-block verse-block))
23501 (when (eq type 'src-block)
23502 (setq contents-begin
23503 (save-excursion (goto-char begin) (forward-line) (point))))
23504 (if (= (point) contents-begin) (goto-char post-affiliated)
23505 ;; Inside a verse block, see blank lines as paragraph
23506 ;; separators.
23507 (let ((origin (point)))
23508 (skip-chars-backward " \r\t\n" contents-begin)
23509 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23510 (skip-chars-forward " \r\t\n" origin)
23511 (if (= (point) origin) (goto-char contents-begin)
23512 (beginning-of-line))))))
23513 ((not contents-begin) (goto-char (or post-affiliated begin)))
23514 ((eq type 'paragraph)
23515 (goto-char contents-begin)
23516 ;; When at first paragraph in an item or a footnote definition,
23517 ;; move directly to beginning of line.
23518 (let ((parent-contents
23519 (org-element-property
23520 :contents-begin (org-element-property :parent element))))
23521 (when (and parent-contents (= parent-contents contents-begin))
23522 (beginning-of-line))))
23523 ;; At the end of a greater element, move to the beginning of the
23524 ;; last element within.
23525 ((>= (point) contents-end)
23526 (goto-char (1- contents-end))
23527 (org-backward-paragraph))
23528 (t (goto-char (or post-affiliated begin))))
23529 ;; Ensure we never leave point invisible.
23530 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23532 (defun org-forward-element ()
23533 "Move forward by one element.
23534 Move to the next element at the same level, when possible."
23535 (interactive)
23536 (cond ((eobp) (user-error "Cannot move further down"))
23537 ((org-with-limited-levels (org-at-heading-p))
23538 (let ((origin (point)))
23539 (goto-char (org-end-of-subtree nil t))
23540 (unless (org-with-limited-levels (org-at-heading-p))
23541 (goto-char origin)
23542 (user-error "Cannot move further down"))))
23544 (let* ((elem (org-element-at-point))
23545 (end (org-element-property :end elem))
23546 (parent (org-element-property :parent elem)))
23547 (cond ((and parent (= (org-element-property :contents-end parent) end))
23548 (goto-char (org-element-property :end parent)))
23549 ((integer-or-marker-p end) (goto-char end))
23550 (t (message "No element at point")))))))
23552 (defun org-backward-element ()
23553 "Move backward by one element.
23554 Move to the previous element at the same level, when possible."
23555 (interactive)
23556 (cond ((bobp) (user-error "Cannot move further up"))
23557 ((org-with-limited-levels (org-at-heading-p))
23558 ;; At a headline, move to the previous one, if any, or stay
23559 ;; here.
23560 (let ((origin (point)))
23561 (org-with-limited-levels (org-backward-heading-same-level 1))
23562 ;; When current headline has no sibling above, move to its
23563 ;; parent.
23564 (when (= (point) origin)
23565 (or (org-with-limited-levels (org-up-heading-safe))
23566 (progn (goto-char origin)
23567 (user-error "Cannot move further up"))))))
23569 (let* ((trail (org-element-at-point 'keep-trail))
23570 (elem (car trail))
23571 (prev-elem (nth 1 trail))
23572 (beg (org-element-property :begin elem)))
23573 (cond
23574 ;; Move to beginning of current element if point isn't
23575 ;; there already.
23576 ((null beg) (message "No element at point"))
23577 ((/= (point) beg) (goto-char beg))
23578 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23579 ((org-before-first-heading-p) (goto-char (point-min)))
23580 (t (org-back-to-heading)))))))
23582 (defun org-up-element ()
23583 "Move to upper element."
23584 (interactive)
23585 (if (org-with-limited-levels (org-at-heading-p))
23586 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23587 (let* ((elem (org-element-at-point))
23588 (parent (org-element-property :parent elem)))
23589 (if parent (goto-char (org-element-property :begin parent))
23590 (if (org-with-limited-levels (org-before-first-heading-p))
23591 (user-error "No surrounding element")
23592 (org-with-limited-levels (org-back-to-heading)))))))
23594 (defvar org-element-greater-elements)
23595 (defun org-down-element ()
23596 "Move to inner element."
23597 (interactive)
23598 (let ((element (org-element-at-point)))
23599 (cond
23600 ((memq (org-element-type element) '(plain-list table))
23601 (goto-char (org-element-property :contents-begin element))
23602 (forward-char))
23603 ((memq (org-element-type element) org-element-greater-elements)
23604 ;; If contents are hidden, first disclose them.
23605 (when (org-element-property :hiddenp element) (org-cycle))
23606 (goto-char (or (org-element-property :contents-begin element)
23607 (user-error "No content for this element"))))
23608 (t (user-error "No inner element")))))
23610 (defun org-drag-element-backward ()
23611 "Move backward element at point."
23612 (interactive)
23613 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23614 (let* ((trail (org-element-at-point 'keep-trail))
23615 (elem (car trail))
23616 (prev-elem (nth 1 trail)))
23617 ;; Error out if no previous element or previous element is
23618 ;; a parent of the current one.
23619 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23620 (user-error "Cannot drag element backward")
23621 (let ((pos (point)))
23622 (org-element-swap-A-B prev-elem elem)
23623 (goto-char (+ (org-element-property :begin prev-elem)
23624 (- pos (org-element-property :begin elem)))))))))
23626 (defun org-drag-element-forward ()
23627 "Move forward element at point."
23628 (interactive)
23629 (let* ((pos (point))
23630 (elem (org-element-at-point)))
23631 (when (= (point-max) (org-element-property :end elem))
23632 (user-error "Cannot drag element forward"))
23633 (goto-char (org-element-property :end elem))
23634 (let ((next-elem (org-element-at-point)))
23635 (when (or (org-element-nested-p elem next-elem)
23636 (and (eq (org-element-type next-elem) 'headline)
23637 (not (eq (org-element-type elem) 'headline))))
23638 (goto-char pos)
23639 (user-error "Cannot drag element forward"))
23640 ;; Compute new position of point: it's shifted by NEXT-ELEM
23641 ;; body's length (without final blanks) and by the length of
23642 ;; blanks between ELEM and NEXT-ELEM.
23643 (let ((size-next (- (save-excursion
23644 (goto-char (org-element-property :end next-elem))
23645 (skip-chars-backward " \r\t\n")
23646 (forward-line)
23647 ;; Small correction if buffer doesn't end
23648 ;; with a newline character.
23649 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23650 (org-element-property :begin next-elem)))
23651 (size-blank (- (org-element-property :end elem)
23652 (save-excursion
23653 (goto-char (org-element-property :end elem))
23654 (skip-chars-backward " \r\t\n")
23655 (forward-line)
23656 (point)))))
23657 (org-element-swap-A-B elem next-elem)
23658 (goto-char (+ pos size-next size-blank))))))
23660 (defun org-drag-line-forward (arg)
23661 "Drag the line at point ARG lines forward."
23662 (interactive "p")
23663 (dotimes (n (abs arg))
23664 (let ((c (current-column)))
23665 (if (< 0 arg)
23666 (progn
23667 (beginning-of-line 2)
23668 (transpose-lines 1)
23669 (beginning-of-line 0))
23670 (transpose-lines 1)
23671 (beginning-of-line -1))
23672 (org-move-to-column c))))
23674 (defun org-drag-line-backward (arg)
23675 "Drag the line at point ARG lines backward."
23676 (interactive "p")
23677 (org-drag-line-forward (- arg)))
23679 (defun org-mark-element ()
23680 "Put point at beginning of this element, mark at end.
23682 Interactively, if this command is repeated or (in Transient Mark
23683 mode) if the mark is active, it marks the next element after the
23684 ones already marked."
23685 (interactive)
23686 (let (deactivate-mark)
23687 (if (and (org-called-interactively-p 'any)
23688 (or (and (eq last-command this-command) (mark t))
23689 (and transient-mark-mode mark-active)))
23690 (set-mark
23691 (save-excursion
23692 (goto-char (mark))
23693 (goto-char (org-element-property :end (org-element-at-point)))))
23694 (let ((element (org-element-at-point)))
23695 (end-of-line)
23696 (push-mark (org-element-property :end element) t t)
23697 (goto-char (org-element-property :begin element))))))
23699 (defun org-narrow-to-element ()
23700 "Narrow buffer to current element."
23701 (interactive)
23702 (let ((elem (org-element-at-point)))
23703 (cond
23704 ((eq (car elem) 'headline)
23705 (narrow-to-region
23706 (org-element-property :begin elem)
23707 (org-element-property :end elem)))
23708 ((memq (car elem) org-element-greater-elements)
23709 (narrow-to-region
23710 (org-element-property :contents-begin elem)
23711 (org-element-property :contents-end elem)))
23713 (narrow-to-region
23714 (org-element-property :begin elem)
23715 (org-element-property :end elem))))))
23717 (defun org-transpose-element ()
23718 "Transpose current and previous elements, keeping blank lines between.
23719 Point is moved after both elements."
23720 (interactive)
23721 (org-skip-whitespace)
23722 (let ((end (org-element-property :end (org-element-at-point))))
23723 (org-drag-element-backward)
23724 (goto-char end)))
23726 (defun org-unindent-buffer ()
23727 "Un-indent the visible part of the buffer.
23728 Relative indentation (between items, inside blocks, etc.) isn't
23729 modified."
23730 (interactive)
23731 (unless (eq major-mode 'org-mode)
23732 (user-error "Cannot un-indent a buffer not in Org mode"))
23733 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23734 unindent-tree ; For byte-compiler.
23735 (unindent-tree
23736 (function
23737 (lambda (contents)
23738 (mapc
23739 (lambda (element)
23740 (if (memq (org-element-type element) '(headline section))
23741 (funcall unindent-tree (org-element-contents element))
23742 (save-excursion
23743 (save-restriction
23744 (narrow-to-region
23745 (org-element-property :begin element)
23746 (org-element-property :end element))
23747 (org-do-remove-indentation)))))
23748 (reverse contents))))))
23749 (funcall unindent-tree (org-element-contents parse-tree))))
23751 (defun org-show-subtree ()
23752 "Show everything after this heading at deeper levels."
23753 (interactive)
23754 (outline-flag-region
23755 (point)
23756 (save-excursion
23757 (org-end-of-subtree t t))
23758 nil))
23760 (defun org-show-entry ()
23761 "Show the body directly following this heading.
23762 Show the heading too, if it is currently invisible."
23763 (interactive)
23764 (save-excursion
23765 (condition-case nil
23766 (progn
23767 (org-back-to-heading t)
23768 (outline-flag-region
23769 (max (point-min) (1- (point)))
23770 (save-excursion
23771 (if (re-search-forward
23772 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23773 (match-beginning 1)
23774 (point-max)))
23775 nil)
23776 (org-cycle-hide-drawers 'children))
23777 (error nil))))
23779 (defun org-make-options-regexp (kwds &optional extra)
23780 "Make a regular expression for keyword lines."
23781 (concat
23782 "^#\\+\\("
23783 (mapconcat 'regexp-quote kwds "\\|")
23784 (if extra (concat "\\|" extra))
23785 "\\):[ \t]*\\(.*\\)"))
23787 ;; Make isearch reveal the necessary context
23788 (defun org-isearch-end ()
23789 "Reveal context after isearch exits."
23790 (when isearch-success ; only if search was successful
23791 (if (featurep 'xemacs)
23792 ;; Under XEmacs, the hook is run in the correct place,
23793 ;; we directly show the context.
23794 (org-show-context 'isearch)
23795 ;; In Emacs the hook runs *before* restoring the overlays.
23796 ;; So we have to use a one-time post-command-hook to do this.
23797 ;; (Emacs 22 has a special variable, see function `org-mode')
23798 (unless (and (boundp 'isearch-mode-end-hook-quit)
23799 isearch-mode-end-hook-quit)
23800 ;; Only when the isearch was not quitted.
23801 (org-add-hook 'post-command-hook 'org-isearch-post-command
23802 'append 'local)))))
23804 (defun org-isearch-post-command ()
23805 "Remove self from hook, and show context."
23806 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23807 (org-show-context 'isearch))
23810 ;;;; Integration with and fixes for other packages
23812 ;;; Imenu support
23814 (defvar org-imenu-markers nil
23815 "All markers currently used by Imenu.")
23816 (make-variable-buffer-local 'org-imenu-markers)
23818 (defun org-imenu-new-marker (&optional pos)
23819 "Return a new marker for use by Imenu, and remember the marker."
23820 (let ((m (make-marker)))
23821 (move-marker m (or pos (point)))
23822 (push m org-imenu-markers)
23825 (defun org-imenu-get-tree ()
23826 "Produce the index for Imenu."
23827 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23828 (setq org-imenu-markers nil)
23829 (let* ((n org-imenu-depth)
23830 (re (concat "^" (org-get-limited-outline-regexp)))
23831 (subs (make-vector (1+ n) nil))
23832 (last-level 0)
23833 m level head0 head)
23834 (save-excursion
23835 (save-restriction
23836 (widen)
23837 (goto-char (point-max))
23838 (while (re-search-backward re nil t)
23839 (setq level (org-reduced-level (funcall outline-level)))
23840 (when (and (<= level n)
23841 (looking-at org-complex-heading-regexp)
23842 (setq head0 (org-match-string-no-properties 4)))
23843 (setq head (org-link-display-format head0)
23844 m (org-imenu-new-marker))
23845 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23846 (if (>= level last-level)
23847 (push (cons head m) (aref subs level))
23848 (push (cons head (aref subs (1+ level))) (aref subs level))
23849 (loop for i from (1+ level) to n do (aset subs i nil)))
23850 (setq last-level level)))))
23851 (aref subs 1)))
23853 (eval-after-load "imenu"
23854 '(progn
23855 (add-hook 'imenu-after-jump-hook
23856 (lambda ()
23857 (if (derived-mode-p 'org-mode)
23858 (org-show-context 'org-goto))))))
23860 (defun org-link-display-format (link)
23861 "Replace a link with its the description.
23862 If there is no description, use the link target."
23863 (save-match-data
23864 (if (string-match org-bracket-link-analytic-regexp link)
23865 (replace-match (if (match-end 5)
23866 (match-string 5 link)
23867 (concat (match-string 1 link)
23868 (match-string 3 link)))
23869 nil t link)
23870 link)))
23872 (defun org-toggle-link-display ()
23873 "Toggle the literal or descriptive display of links."
23874 (interactive)
23875 (if org-descriptive-links
23876 (progn (org-remove-from-invisibility-spec '(org-link))
23877 (org-restart-font-lock)
23878 (setq org-descriptive-links nil))
23879 (progn (add-to-invisibility-spec '(org-link))
23880 (org-restart-font-lock)
23881 (setq org-descriptive-links t))))
23883 ;; Speedbar support
23885 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23886 "Overlay marking the agenda restriction line in speedbar.")
23887 (overlay-put org-speedbar-restriction-lock-overlay
23888 'face 'org-agenda-restriction-lock)
23889 (overlay-put org-speedbar-restriction-lock-overlay
23890 'help-echo "Agendas are currently limited to this item.")
23891 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23893 (defun org-speedbar-set-agenda-restriction ()
23894 "Restrict future agenda commands to the location at point in speedbar.
23895 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
23896 (interactive)
23897 (require 'org-agenda)
23898 (let (p m tp np dir txt)
23899 (cond
23900 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23901 'org-imenu t))
23902 (setq m (get-text-property p 'org-imenu-marker))
23903 (with-current-buffer (marker-buffer m)
23904 (goto-char m)
23905 (org-agenda-set-restriction-lock 'subtree)))
23906 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23907 'speedbar-function 'speedbar-find-file))
23908 (setq tp (previous-single-property-change
23909 (1+ p) 'speedbar-function)
23910 np (next-single-property-change
23911 tp 'speedbar-function)
23912 dir (speedbar-line-directory)
23913 txt (buffer-substring-no-properties (or tp (point-min))
23914 (or np (point-max))))
23915 (with-current-buffer (find-file-noselect
23916 (let ((default-directory dir))
23917 (expand-file-name txt)))
23918 (unless (derived-mode-p 'org-mode)
23919 (user-error "Cannot restrict to non-Org-mode file"))
23920 (org-agenda-set-restriction-lock 'file)))
23921 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23922 (move-overlay org-speedbar-restriction-lock-overlay
23923 (point-at-bol) (point-at-eol))
23924 (setq current-prefix-arg nil)
23925 (org-agenda-maybe-redo)))
23927 (defvar speedbar-file-key-map)
23928 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23929 (eval-after-load "speedbar"
23930 '(progn
23931 (speedbar-add-supported-extension ".org")
23932 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23933 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23934 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23935 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23936 (add-hook 'speedbar-visiting-tag-hook
23937 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23939 ;;; Fixes and Hacks for problems with other packages
23941 ;; Make flyspell not check words in links, to not mess up our keymap
23942 (defvar org-element-affiliated-keywords) ; From org-element.el
23943 (defvar org-element-block-name-alist) ; From org-element.el
23944 (defun org-mode-flyspell-verify ()
23945 "Don't let flyspell put overlays at active buttons, or on
23946 {todo,all-time,additional-option-like}-keywords."
23947 (require 'org-element) ; For `org-element-affiliated-keywords'
23948 (let ((pos (max (1- (point)) (point-min)))
23949 (word (thing-at-point 'word)))
23950 (and (not (get-text-property pos 'keymap))
23951 (not (get-text-property pos 'org-no-flyspell))
23952 (not (member word org-todo-keywords-1))
23953 (not (member word org-all-time-keywords))
23954 (not (member word org-options-keywords))
23955 (not (member word (mapcar 'car org-startup-options)))
23956 (not (member-ignore-case word org-element-affiliated-keywords))
23957 (not (member-ignore-case word (org-get-export-keywords)))
23958 (not (member-ignore-case
23959 word (mapcar 'car org-element-block-name-alist)))
23960 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23961 (not (org-in-src-block-p)))))
23963 (defun org-remove-flyspell-overlays-in (beg end)
23964 "Remove flyspell overlays in region."
23965 (and (org-bound-and-true-p flyspell-mode)
23966 (fboundp 'flyspell-delete-region-overlays)
23967 (flyspell-delete-region-overlays beg end))
23968 (add-text-properties beg end '(org-no-flyspell t)))
23970 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23971 (eval-after-load "bookmark"
23972 '(if (boundp 'bookmark-after-jump-hook)
23973 ;; We can use the hook
23974 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23975 ;; Hook not available, use advice
23976 (defadvice bookmark-jump (after org-make-visible activate)
23977 "Make the position visible."
23978 (org-bookmark-jump-unhide))))
23980 ;; Make sure saveplace shows the location if it was hidden
23981 (eval-after-load "saveplace"
23982 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23983 "Make the position visible."
23984 (org-bookmark-jump-unhide)))
23986 ;; Make sure ecb shows the location if it was hidden
23987 (eval-after-load "ecb"
23988 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23989 "Make hierarchy visible when jumping into location from ECB tree buffer."
23990 (if (derived-mode-p 'org-mode)
23991 (org-show-context))))
23993 (defun org-bookmark-jump-unhide ()
23994 "Unhide the current position, to show the bookmark location."
23995 (and (derived-mode-p 'org-mode)
23996 (or (outline-invisible-p)
23997 (save-excursion (goto-char (max (point-min) (1- (point))))
23998 (outline-invisible-p)))
23999 (org-show-context 'bookmark-jump)))
24001 ;; Make session.el ignore our circular variable
24002 (defvar session-globals-exclude)
24003 (eval-after-load "session"
24004 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24006 ;;;; Finish up
24008 (provide 'org)
24010 (run-hooks 'org-load-hook)
24012 ;;; org.el ends here